nfc/s3fwrn5/firmware.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * NCI based driver for Samsung S3FWRN5 NFC chip
0004  *
0005  * Copyright (C) 2015 Samsung Electrnoics
0006  * Robert Baldyga <r.baldyga@samsung.com>
0007  */
0008
0009 #ifndef __LOCAL_S3FWRN5_FIRMWARE_H_
0010 #define __LOCAL_S3FWRN5_FIRMWARE_H_
0011
0012 /* FW Message Types */
0013 #define S3FWRN5_FW_MSG_CMD          0x00
0014 #define S3FWRN5_FW_MSG_RSP          0x01
0015 #define S3FWRN5_FW_MSG_DATA         0x02
0016
0017 /* FW Return Codes */
0018 #define S3FWRN5_FW_RET_SUCCESS          0x00
0019 #define S3FWRN5_FW_RET_MESSAGE_TYPE_INVALID 0x01
0020 #define S3FWRN5_FW_RET_COMMAND_INVALID      0x02
0021 #define S3FWRN5_FW_RET_PAGE_DATA_OVERFLOW   0x03
0022 #define S3FWRN5_FW_RET_SECT_DATA_OVERFLOW   0x04
0023 #define S3FWRN5_FW_RET_AUTHENTICATION_FAIL  0x05
0024 #define S3FWRN5_FW_RET_FLASH_OPERATION_FAIL 0x06
0025 #define S3FWRN5_FW_RET_ADDRESS_OUT_OF_RANGE 0x07
0026 #define S3FWRN5_FW_RET_PARAMETER_INVALID    0x08
0027
0028 /* ---- FW Packet structures ---- */
0029 #define S3FWRN5_FW_HDR_SIZE 4
0030
0031 struct s3fwrn5_fw_header {
0032     __u8 type;
0033     __u8 code;
0034     __u16 len;
0035 };
0036
0037 #define S3FWRN5_FW_CMD_RESET            0x00
0038
0039 #define S3FWRN5_FW_CMD_GET_BOOTINFO     0x01
0040
0041 struct s3fwrn5_fw_cmd_get_bootinfo_rsp {
0042     __u8 hw_version[4];
0043     __u16 sector_size;
0044     __u16 page_size;
0045     __u16 frame_max_size;
0046     __u16 hw_buffer_size;
0047 };
0048
0049 #define S3FWRN5_FW_CMD_ENTER_UPDATE_MODE    0x02
0050
0051 struct s3fwrn5_fw_cmd_enter_updatemode {
0052     __u16 hashcode_size;
0053     __u16 signature_size;
0054 };
0055
0056 #define S3FWRN5_FW_CMD_UPDATE_SECTOR        0x04
0057
0058 struct s3fwrn5_fw_cmd_update_sector {
0059     __u32 base_address;
0060 };
0061
0062 #define S3FWRN5_FW_CMD_COMPLETE_UPDATE_MODE 0x05
0063
0064 struct s3fwrn5_fw_image {
0065     const struct firmware *fw;
0066
0067     char date[13];
0068     u32 version;
0069     const void *sig;
0070     u32 sig_size;
0071     const void *image;
0072     u32 image_sectors;
0073     const void *custom_sig;
0074     u32 custom_sig_size;
0075 };
0076
0077 struct s3fwrn5_fw_info {
0078     struct nci_dev *ndev;
0079     struct s3fwrn5_fw_image fw;
0080     char fw_name[NFC_FIRMWARE_NAME_MAXSIZE + 1];
0081
0082     const void *sig;
0083     u32 sig_size;
0084     u32 sector_size;
0085     u32 base_addr;
0086
0087     struct completion completion;
0088     struct sk_buff *rsp;
0089     char parity;
0090 };
0091
0092 int s3fwrn5_fw_request_firmware(struct s3fwrn5_fw_info *fw_info);
0093 void s3fwrn5_fw_init(struct s3fwrn5_fw_info *fw_info, const char *fw_name);
0094 int s3fwrn5_fw_setup(struct s3fwrn5_fw_info *fw_info);
0095 bool s3fwrn5_fw_check_version(const struct s3fwrn5_fw_info *fw_info, u32 version);
0096 int s3fwrn5_fw_download(struct s3fwrn5_fw_info *fw_info);
0097 void s3fwrn5_fw_cleanup(struct s3fwrn5_fw_info *fw_info);
0098
0099 int s3fwrn5_fw_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
0100
0101 #endif /* __LOCAL_S3FWRN5_FIRMWARE_H_ */