11ccea77eSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */ 29815c7cfSMichael Thalmeier /* 39815c7cfSMichael Thalmeier * Driver for NXP PN533 NFC Chip 49815c7cfSMichael Thalmeier * 59815c7cfSMichael Thalmeier * Copyright (C) 2011 Instituto Nokia de Tecnologia 69815c7cfSMichael Thalmeier * Copyright (C) 2012-2013 Tieto Poland 79815c7cfSMichael Thalmeier */ 89815c7cfSMichael Thalmeier 99815c7cfSMichael Thalmeier #define PN533_DEVICE_STD 0x1 109815c7cfSMichael Thalmeier #define PN533_DEVICE_PASORI 0x2 119815c7cfSMichael Thalmeier #define PN533_DEVICE_ACR122U 0x3 12dd7bedcdSMichael Thalmeier #define PN533_DEVICE_PN532 0x4 13c64b875fSLars Poeschel #define PN533_DEVICE_PN532_AUTOPOLL 0x5 149815c7cfSMichael Thalmeier 159815c7cfSMichael Thalmeier #define PN533_ALL_PROTOCOLS (NFC_PROTO_JEWEL_MASK | NFC_PROTO_MIFARE_MASK |\ 169815c7cfSMichael Thalmeier NFC_PROTO_FELICA_MASK | NFC_PROTO_ISO14443_MASK |\ 179815c7cfSMichael Thalmeier NFC_PROTO_NFC_DEP_MASK |\ 189815c7cfSMichael Thalmeier NFC_PROTO_ISO14443_B_MASK) 199815c7cfSMichael Thalmeier 209815c7cfSMichael Thalmeier #define PN533_NO_TYPE_B_PROTOCOLS (NFC_PROTO_JEWEL_MASK | \ 219815c7cfSMichael Thalmeier NFC_PROTO_MIFARE_MASK | \ 229815c7cfSMichael Thalmeier NFC_PROTO_FELICA_MASK | \ 239815c7cfSMichael Thalmeier NFC_PROTO_ISO14443_MASK | \ 249815c7cfSMichael Thalmeier NFC_PROTO_NFC_DEP_MASK) 259815c7cfSMichael Thalmeier 269815c7cfSMichael Thalmeier /* Standard pn533 frame definitions (standard and extended)*/ 279815c7cfSMichael Thalmeier #define PN533_STD_FRAME_HEADER_LEN (sizeof(struct pn533_std_frame) \ 289815c7cfSMichael Thalmeier + 2) /* data[0] TFI, data[1] CC */ 299815c7cfSMichael Thalmeier #define PN533_STD_FRAME_TAIL_LEN 2 /* data[len] DCS, data[len + 1] postamble*/ 309815c7cfSMichael Thalmeier 319815c7cfSMichael Thalmeier #define PN533_EXT_FRAME_HEADER_LEN (sizeof(struct pn533_ext_frame) \ 329815c7cfSMichael Thalmeier + 2) /* data[0] TFI, data[1] CC */ 339815c7cfSMichael Thalmeier 349815c7cfSMichael Thalmeier #define PN533_CMD_DATAEXCH_HEAD_LEN 1 359815c7cfSMichael Thalmeier #define PN533_CMD_DATAEXCH_DATA_MAXLEN 262 369815c7cfSMichael Thalmeier #define PN533_CMD_DATAFRAME_MAXLEN 240 /* max data length (send) */ 379815c7cfSMichael Thalmeier 389815c7cfSMichael Thalmeier /* 399815c7cfSMichael Thalmeier * Max extended frame payload len, excluding TFI and CC 409815c7cfSMichael Thalmeier * which are already in PN533_FRAME_HEADER_LEN. 419815c7cfSMichael Thalmeier */ 429815c7cfSMichael Thalmeier #define PN533_STD_FRAME_MAX_PAYLOAD_LEN 263 439815c7cfSMichael Thalmeier 449815c7cfSMichael Thalmeier 459815c7cfSMichael Thalmeier /* Preamble (1), SoPC (2), ACK Code (2), Postamble (1) */ 469815c7cfSMichael Thalmeier #define PN533_STD_FRAME_ACK_SIZE 6 47c656aa4cSLars Poeschel /* 48c656aa4cSLars Poeschel * Preamble (1), SoPC (2), Packet Length (1), Packet Length Checksum (1), 49c656aa4cSLars Poeschel * Specific Application Level Error Code (1) , Postamble (1) 50c656aa4cSLars Poeschel */ 51c656aa4cSLars Poeschel #define PN533_STD_ERROR_FRAME_SIZE 8 529815c7cfSMichael Thalmeier #define PN533_STD_FRAME_CHECKSUM(f) (f->data[f->datalen]) 539815c7cfSMichael Thalmeier #define PN533_STD_FRAME_POSTAMBLE(f) (f->data[f->datalen + 1]) 549815c7cfSMichael Thalmeier /* Half start code (3), LEN (4) should be 0xffff for extended frame */ 559815c7cfSMichael Thalmeier #define PN533_STD_IS_EXTENDED(hdr) ((hdr)->datalen == 0xFF \ 569815c7cfSMichael Thalmeier && (hdr)->datalen_checksum == 0xFF) 579815c7cfSMichael Thalmeier #define PN533_EXT_FRAME_CHECKSUM(f) (f->data[be16_to_cpu(f->datalen)]) 589815c7cfSMichael Thalmeier 599815c7cfSMichael Thalmeier /* start of frame */ 609815c7cfSMichael Thalmeier #define PN533_STD_FRAME_SOF 0x00FF 619815c7cfSMichael Thalmeier 629815c7cfSMichael Thalmeier /* standard frame identifier: in/out/error */ 639815c7cfSMichael Thalmeier #define PN533_STD_FRAME_IDENTIFIER(f) (f->data[0]) /* TFI */ 649815c7cfSMichael Thalmeier #define PN533_STD_FRAME_DIR_OUT 0xD4 659815c7cfSMichael Thalmeier #define PN533_STD_FRAME_DIR_IN 0xD5 669815c7cfSMichael Thalmeier 679815c7cfSMichael Thalmeier /* PN533 Commands */ 689815c7cfSMichael Thalmeier #define PN533_FRAME_CMD(f) (f->data[1]) 699815c7cfSMichael Thalmeier 709815c7cfSMichael Thalmeier #define PN533_CMD_GET_FIRMWARE_VERSION 0x02 71dd7bedcdSMichael Thalmeier #define PN533_CMD_SAM_CONFIGURATION 0x14 729815c7cfSMichael Thalmeier #define PN533_CMD_RF_CONFIGURATION 0x32 739815c7cfSMichael Thalmeier #define PN533_CMD_IN_DATA_EXCHANGE 0x40 749815c7cfSMichael Thalmeier #define PN533_CMD_IN_COMM_THRU 0x42 759815c7cfSMichael Thalmeier #define PN533_CMD_IN_LIST_PASSIVE_TARGET 0x4A 769815c7cfSMichael Thalmeier #define PN533_CMD_IN_ATR 0x50 779815c7cfSMichael Thalmeier #define PN533_CMD_IN_RELEASE 0x52 789815c7cfSMichael Thalmeier #define PN533_CMD_IN_JUMP_FOR_DEP 0x56 79c64b875fSLars Poeschel #define PN533_CMD_IN_AUTOPOLL 0x60 809815c7cfSMichael Thalmeier 819815c7cfSMichael Thalmeier #define PN533_CMD_TG_INIT_AS_TARGET 0x8c 829815c7cfSMichael Thalmeier #define PN533_CMD_TG_GET_DATA 0x86 839815c7cfSMichael Thalmeier #define PN533_CMD_TG_SET_DATA 0x8e 849815c7cfSMichael Thalmeier #define PN533_CMD_TG_SET_META_DATA 0x94 859815c7cfSMichael Thalmeier #define PN533_CMD_UNDEF 0xff 869815c7cfSMichael Thalmeier 879815c7cfSMichael Thalmeier #define PN533_CMD_RESPONSE(cmd) (cmd + 1) 889815c7cfSMichael Thalmeier 899815c7cfSMichael Thalmeier /* PN533 Return codes */ 909815c7cfSMichael Thalmeier #define PN533_CMD_RET_MASK 0x3F 919815c7cfSMichael Thalmeier #define PN533_CMD_MI_MASK 0x40 929815c7cfSMichael Thalmeier #define PN533_CMD_RET_SUCCESS 0x00 939815c7cfSMichael Thalmeier 94c656aa4cSLars Poeschel #define PN533_FRAME_DATALEN_ACK 0x00 95c656aa4cSLars Poeschel #define PN533_FRAME_DATALEN_ERROR 0x01 96c656aa4cSLars Poeschel #define PN533_FRAME_DATALEN_EXTENDED 0xFF 979815c7cfSMichael Thalmeier 989815c7cfSMichael Thalmeier enum pn533_protocol_type { 999815c7cfSMichael Thalmeier PN533_PROTO_REQ_ACK_RESP = 0, 1009815c7cfSMichael Thalmeier PN533_PROTO_REQ_RESP 1019815c7cfSMichael Thalmeier }; 1029815c7cfSMichael Thalmeier 1039815c7cfSMichael Thalmeier /* Poll modulations */ 1049815c7cfSMichael Thalmeier enum { 1059815c7cfSMichael Thalmeier PN533_POLL_MOD_106KBPS_A, 1069815c7cfSMichael Thalmeier PN533_POLL_MOD_212KBPS_FELICA, 1079815c7cfSMichael Thalmeier PN533_POLL_MOD_424KBPS_FELICA, 1089815c7cfSMichael Thalmeier PN533_POLL_MOD_106KBPS_JEWEL, 1099815c7cfSMichael Thalmeier PN533_POLL_MOD_847KBPS_B, 1109815c7cfSMichael Thalmeier PN533_LISTEN_MOD, 1119815c7cfSMichael Thalmeier 1129815c7cfSMichael Thalmeier __PN533_POLL_MOD_AFTER_LAST, 1139815c7cfSMichael Thalmeier }; 1149815c7cfSMichael Thalmeier #define PN533_POLL_MOD_MAX (__PN533_POLL_MOD_AFTER_LAST - 1) 1159815c7cfSMichael Thalmeier 1169815c7cfSMichael Thalmeier struct pn533_std_frame { 1179815c7cfSMichael Thalmeier u8 preamble; 1189815c7cfSMichael Thalmeier __be16 start_frame; 1199815c7cfSMichael Thalmeier u8 datalen; 1209815c7cfSMichael Thalmeier u8 datalen_checksum; 1219815c7cfSMichael Thalmeier u8 data[]; 1229815c7cfSMichael Thalmeier } __packed; 1239815c7cfSMichael Thalmeier 1249815c7cfSMichael Thalmeier struct pn533_ext_frame { /* Extended Information frame */ 1259815c7cfSMichael Thalmeier u8 preamble; 1269815c7cfSMichael Thalmeier __be16 start_frame; 1279815c7cfSMichael Thalmeier __be16 eif_flag; /* fixed to 0xFFFF */ 1289815c7cfSMichael Thalmeier __be16 datalen; 1299815c7cfSMichael Thalmeier u8 datalen_checksum; 1309815c7cfSMichael Thalmeier u8 data[]; 1319815c7cfSMichael Thalmeier } __packed; 1329815c7cfSMichael Thalmeier 1339815c7cfSMichael Thalmeier struct pn533 { 1349815c7cfSMichael Thalmeier struct nfc_dev *nfc_dev; 1359815c7cfSMichael Thalmeier u32 device_type; 1369815c7cfSMichael Thalmeier enum pn533_protocol_type protocol_type; 1379815c7cfSMichael Thalmeier 1389815c7cfSMichael Thalmeier struct sk_buff_head resp_q; 1399815c7cfSMichael Thalmeier struct sk_buff_head fragment_skb; 1409815c7cfSMichael Thalmeier 1419815c7cfSMichael Thalmeier struct workqueue_struct *wq; 1429815c7cfSMichael Thalmeier struct work_struct cmd_work; 1439815c7cfSMichael Thalmeier struct work_struct cmd_complete_work; 1449815c7cfSMichael Thalmeier struct delayed_work poll_work; 1459815c7cfSMichael Thalmeier struct work_struct mi_rx_work; 1469815c7cfSMichael Thalmeier struct work_struct mi_tx_work; 1479815c7cfSMichael Thalmeier struct work_struct mi_tm_rx_work; 1489815c7cfSMichael Thalmeier struct work_struct mi_tm_tx_work; 1499815c7cfSMichael Thalmeier struct work_struct tg_work; 1509815c7cfSMichael Thalmeier struct work_struct rf_work; 1519815c7cfSMichael Thalmeier 1529815c7cfSMichael Thalmeier struct list_head cmd_queue; 1539815c7cfSMichael Thalmeier struct pn533_cmd *cmd; 1549815c7cfSMichael Thalmeier u8 cmd_pending; 1559815c7cfSMichael Thalmeier struct mutex cmd_lock; /* protects cmd queue */ 1569815c7cfSMichael Thalmeier 1579815c7cfSMichael Thalmeier void *cmd_complete_mi_arg; 1589815c7cfSMichael Thalmeier void *cmd_complete_dep_arg; 1599815c7cfSMichael Thalmeier 1609815c7cfSMichael Thalmeier struct pn533_poll_modulations *poll_mod_active[PN533_POLL_MOD_MAX + 1]; 1619815c7cfSMichael Thalmeier u8 poll_mod_count; 1629815c7cfSMichael Thalmeier u8 poll_mod_curr; 1639815c7cfSMichael Thalmeier u8 poll_dep; 1649815c7cfSMichael Thalmeier u32 poll_protocols; 1659815c7cfSMichael Thalmeier u32 listen_protocols; 1669815c7cfSMichael Thalmeier struct timer_list listen_timer; 1679815c7cfSMichael Thalmeier int cancel_listen; 1689815c7cfSMichael Thalmeier 1699815c7cfSMichael Thalmeier u8 *gb; 1709815c7cfSMichael Thalmeier size_t gb_len; 1719815c7cfSMichael Thalmeier 1729815c7cfSMichael Thalmeier u8 tgt_available_prots; 1739815c7cfSMichael Thalmeier u8 tgt_active_prot; 1749815c7cfSMichael Thalmeier u8 tgt_mode; 1759815c7cfSMichael Thalmeier 1769815c7cfSMichael Thalmeier struct pn533_frame_ops *ops; 1779815c7cfSMichael Thalmeier 1789815c7cfSMichael Thalmeier struct device *dev; 1799815c7cfSMichael Thalmeier void *phy; 180*bc642817SRikard Falkeborn const struct pn533_phy_ops *phy_ops; 1819815c7cfSMichael Thalmeier }; 1829815c7cfSMichael Thalmeier 1839815c7cfSMichael Thalmeier typedef int (*pn533_send_async_complete_t) (struct pn533 *dev, void *arg, 1849815c7cfSMichael Thalmeier struct sk_buff *resp); 1859815c7cfSMichael Thalmeier 1869815c7cfSMichael Thalmeier struct pn533_cmd { 1879815c7cfSMichael Thalmeier struct list_head queue; 1889815c7cfSMichael Thalmeier u8 code; 1899815c7cfSMichael Thalmeier int status; 1909815c7cfSMichael Thalmeier struct sk_buff *req; 1919815c7cfSMichael Thalmeier struct sk_buff *resp; 1929815c7cfSMichael Thalmeier pn533_send_async_complete_t complete_cb; 1939815c7cfSMichael Thalmeier void *complete_cb_context; 1949815c7cfSMichael Thalmeier }; 1959815c7cfSMichael Thalmeier 1969815c7cfSMichael Thalmeier 1979815c7cfSMichael Thalmeier struct pn533_frame_ops { 1989815c7cfSMichael Thalmeier void (*tx_frame_init)(void *frame, u8 cmd_code); 1999815c7cfSMichael Thalmeier void (*tx_frame_finish)(void *frame); 2009815c7cfSMichael Thalmeier void (*tx_update_payload_len)(void *frame, int len); 2019815c7cfSMichael Thalmeier int tx_header_len; 2029815c7cfSMichael Thalmeier int tx_tail_len; 2039815c7cfSMichael Thalmeier 2049815c7cfSMichael Thalmeier bool (*rx_is_frame_valid)(void *frame, struct pn533 *dev); 2059815c7cfSMichael Thalmeier bool (*rx_frame_is_ack)(void *frame); 2069815c7cfSMichael Thalmeier int (*rx_frame_size)(void *frame); 2079815c7cfSMichael Thalmeier int rx_header_len; 2089815c7cfSMichael Thalmeier int rx_tail_len; 2099815c7cfSMichael Thalmeier 2109815c7cfSMichael Thalmeier int max_payload_len; 2119815c7cfSMichael Thalmeier u8 (*get_cmd_code)(void *frame); 2129815c7cfSMichael Thalmeier }; 2139815c7cfSMichael Thalmeier 2149815c7cfSMichael Thalmeier 2159815c7cfSMichael Thalmeier struct pn533_phy_ops { 2169815c7cfSMichael Thalmeier int (*send_frame)(struct pn533 *priv, 2179815c7cfSMichael Thalmeier struct sk_buff *out); 2189815c7cfSMichael Thalmeier int (*send_ack)(struct pn533 *dev, gfp_t flags); 2199815c7cfSMichael Thalmeier void (*abort_cmd)(struct pn533 *priv, gfp_t flags); 2200bf2840cSLars Poeschel /* 2210bf2840cSLars Poeschel * dev_up and dev_down are optional. 2220bf2840cSLars Poeschel * They are used to inform the phy layer that the nfc chip 2230bf2840cSLars Poeschel * is going to be really used very soon. The phy layer can then 2240bf2840cSLars Poeschel * bring up it's interface to the chip and have it suspended for power 2250bf2840cSLars Poeschel * saving reasons otherwise. 2260bf2840cSLars Poeschel */ 2271e37be7dSLars Poeschel int (*dev_up)(struct pn533 *priv); 2281e37be7dSLars Poeschel int (*dev_down)(struct pn533 *priv); 2299815c7cfSMichael Thalmeier }; 2309815c7cfSMichael Thalmeier 2319815c7cfSMichael Thalmeier 232843cc92eSLars Poeschel struct pn533 *pn53x_common_init(u32 device_type, 2339815c7cfSMichael Thalmeier enum pn533_protocol_type protocol_type, 2349815c7cfSMichael Thalmeier void *phy, 235*bc642817SRikard Falkeborn const struct pn533_phy_ops *phy_ops, 2369815c7cfSMichael Thalmeier struct pn533_frame_ops *fops, 237843cc92eSLars Poeschel struct device *dev); 2389815c7cfSMichael Thalmeier 23932ecc75dSAndrey Rusalin int pn533_finalize_setup(struct pn533 *dev); 240843cc92eSLars Poeschel void pn53x_common_clean(struct pn533 *priv); 2419815c7cfSMichael Thalmeier void pn533_recv_frame(struct pn533 *dev, struct sk_buff *skb, int status); 242843cc92eSLars Poeschel int pn532_i2c_nfc_alloc(struct pn533 *priv, u32 protocols, 243843cc92eSLars Poeschel struct device *parent); 244843cc92eSLars Poeschel int pn53x_register_nfc(struct pn533 *priv, u32 protocols, 245843cc92eSLars Poeschel struct device *parent); 246843cc92eSLars Poeschel void pn53x_unregister_nfc(struct pn533 *priv); 2479815c7cfSMichael Thalmeier 2489815c7cfSMichael Thalmeier bool pn533_rx_frame_is_cmd_response(struct pn533 *dev, void *frame); 2499815c7cfSMichael Thalmeier bool pn533_rx_frame_is_ack(void *_frame); 250