1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * Copyright (C) 2011 Instituto Nokia de Tecnologia 4 * Copyright (C) 2014 Marvell International Ltd. 5 * 6 * Authors: 7 * Lauro Ramos Venancio <lauro.venancio@openbossa.org> 8 * Aloisio Almeida Jr <aloisio.almeida@openbossa.org> 9 */ 10 11 #ifndef __NET_NFC_H 12 #define __NET_NFC_H 13 14 #include <linux/nfc.h> 15 #include <linux/device.h> 16 #include <linux/skbuff.h> 17 18 #define nfc_dbg(dev, fmt, ...) dev_dbg((dev), "NFC: " fmt, ##__VA_ARGS__) 19 #define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__) 20 #define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__) 21 22 struct nfc_phy_ops { 23 int (*write)(void *dev_id, struct sk_buff *skb); 24 int (*enable)(void *dev_id); 25 void (*disable)(void *dev_id); 26 }; 27 28 struct nfc_dev; 29 30 /** 31 * data_exchange_cb_t - Definition of nfc_data_exchange callback 32 * 33 * @context: nfc_data_exchange cb_context parameter 34 * @skb: response data 35 * @err: If an error has occurred during data exchange, it is the 36 * error number. Zero means no error. 37 * 38 * When a rx or tx package is lost or corrupted or the target gets out 39 * of the operating field, err is -EIO. 40 */ 41 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb, 42 int err); 43 44 typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err); 45 46 struct nfc_target; 47 48 struct nfc_ops { 49 int (*dev_up)(struct nfc_dev *dev); 50 int (*dev_down)(struct nfc_dev *dev); 51 int (*start_poll)(struct nfc_dev *dev, 52 u32 im_protocols, u32 tm_protocols); 53 void (*stop_poll)(struct nfc_dev *dev); 54 int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target, 55 u8 comm_mode, u8 *gb, size_t gb_len); 56 int (*dep_link_down)(struct nfc_dev *dev); 57 int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target, 58 u32 protocol); 59 void (*deactivate_target)(struct nfc_dev *dev, 60 struct nfc_target *target, u8 mode); 61 int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target, 62 struct sk_buff *skb, data_exchange_cb_t cb, 63 void *cb_context); 64 int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb); 65 int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target); 66 int (*fw_download)(struct nfc_dev *dev, const char *firmware_name); 67 68 /* Secure Element API */ 69 int (*discover_se)(struct nfc_dev *dev); 70 int (*enable_se)(struct nfc_dev *dev, u32 se_idx); 71 int (*disable_se)(struct nfc_dev *dev, u32 se_idx); 72 int (*se_io) (struct nfc_dev *dev, u32 se_idx, 73 u8 *apdu, size_t apdu_length, 74 se_io_cb_t cb, void *cb_context); 75 }; 76 77 #define NFC_TARGET_IDX_ANY -1 78 #define NFC_MAX_GT_LEN 48 79 #define NFC_ATR_RES_GT_OFFSET 15 80 #define NFC_ATR_REQ_GT_OFFSET 14 81 82 /** 83 * struct nfc_target - NFC target description 84 * 85 * @sens_res: 2 bytes describing the target SENS_RES response, if the target 86 * is a type A one. The %sens_res most significant byte must be byte 2 87 * as described by the NFC Forum digital specification (i.e. the platform 88 * configuration one) while %sens_res least significant byte is byte 1. 89 */ 90 struct nfc_target { 91 u32 idx; 92 u32 supported_protocols; 93 u16 sens_res; 94 u8 sel_res; 95 u8 nfcid1_len; 96 u8 nfcid1[NFC_NFCID1_MAXSIZE]; 97 u8 nfcid2_len; 98 u8 nfcid2[NFC_NFCID2_MAXSIZE]; 99 u8 sensb_res_len; 100 u8 sensb_res[NFC_SENSB_RES_MAXSIZE]; 101 u8 sensf_res_len; 102 u8 sensf_res[NFC_SENSF_RES_MAXSIZE]; 103 u8 hci_reader_gate; 104 u8 logical_idx; 105 u8 is_iso15693; 106 u8 iso15693_dsfid; 107 u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE]; 108 }; 109 110 /** 111 * nfc_se - A structure for NFC accessible secure elements. 112 * 113 * @idx: The secure element index. User space will enable or 114 * disable a secure element by its index. 115 * @type: The secure element type. It can be SE_UICC or 116 * SE_EMBEDDED. 117 * @state: The secure element state, either enabled or disabled. 118 * 119 */ 120 struct nfc_se { 121 struct list_head list; 122 u32 idx; 123 u16 type; 124 u16 state; 125 }; 126 127 /** 128 * nfc_evt_transaction - A struct for NFC secure element event transaction. 129 * 130 * @aid: The application identifier triggering the event 131 * 132 * @aid_len: The application identifier length [5:16] 133 * 134 * @params: The application parameters transmitted during the transaction 135 * 136 * @params_len: The applications parameters length [0:255] 137 * 138 */ 139 #define NFC_MIN_AID_LENGTH 5 140 #define NFC_MAX_AID_LENGTH 16 141 #define NFC_MAX_PARAMS_LENGTH 255 142 143 #define NFC_EVT_TRANSACTION_AID_TAG 0x81 144 #define NFC_EVT_TRANSACTION_PARAMS_TAG 0x82 145 struct nfc_evt_transaction { 146 u32 aid_len; 147 u8 aid[NFC_MAX_AID_LENGTH]; 148 u8 params_len; 149 u8 params[]; 150 } __packed; 151 152 struct nfc_genl_data { 153 u32 poll_req_portid; 154 struct mutex genl_data_mutex; 155 }; 156 157 struct nfc_vendor_cmd { 158 __u32 vendor_id; 159 __u32 subcmd; 160 int (*doit)(struct nfc_dev *dev, void *data, size_t data_len); 161 }; 162 163 struct nfc_dev { 164 int idx; 165 u32 target_next_idx; 166 struct nfc_target *targets; 167 int n_targets; 168 int targets_generation; 169 struct device dev; 170 bool dev_up; 171 bool fw_download_in_progress; 172 u8 rf_mode; 173 bool polling; 174 struct nfc_target *active_target; 175 bool dep_link_up; 176 struct nfc_genl_data genl_data; 177 u32 supported_protocols; 178 179 struct list_head secure_elements; 180 181 int tx_headroom; 182 int tx_tailroom; 183 184 struct timer_list check_pres_timer; 185 struct work_struct check_pres_work; 186 187 bool shutting_down; 188 189 struct rfkill *rfkill; 190 191 const struct nfc_vendor_cmd *vendor_cmds; 192 int n_vendor_cmds; 193 194 const struct nfc_ops *ops; 195 struct genl_info *cur_cmd_info; 196 }; 197 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev) 198 199 extern const struct class nfc_class; 200 201 struct nfc_dev *nfc_allocate_device(const struct nfc_ops *ops, 202 u32 supported_protocols, 203 int tx_headroom, 204 int tx_tailroom); 205 206 /** 207 * nfc_free_device - free nfc device 208 * 209 * @dev: The nfc device to free 210 */ nfc_free_device(struct nfc_dev * dev)211 static inline void nfc_free_device(struct nfc_dev *dev) 212 { 213 put_device(&dev->dev); 214 } 215 216 int nfc_register_device(struct nfc_dev *dev); 217 218 void nfc_unregister_device(struct nfc_dev *dev); 219 220 /** 221 * nfc_set_parent_dev - set the parent device 222 * 223 * @nfc_dev: The nfc device whose parent is being set 224 * @dev: The parent device 225 */ nfc_set_parent_dev(struct nfc_dev * nfc_dev,struct device * dev)226 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev, 227 struct device *dev) 228 { 229 nfc_dev->dev.parent = dev; 230 } 231 232 /** 233 * nfc_set_drvdata - set driver specific data 234 * 235 * @dev: The nfc device 236 * @data: Pointer to driver specific data 237 */ nfc_set_drvdata(struct nfc_dev * dev,void * data)238 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data) 239 { 240 dev_set_drvdata(&dev->dev, data); 241 } 242 243 /** 244 * nfc_get_drvdata - get driver specific data 245 * 246 * @dev: The nfc device 247 */ nfc_get_drvdata(const struct nfc_dev * dev)248 static inline void *nfc_get_drvdata(const struct nfc_dev *dev) 249 { 250 return dev_get_drvdata(&dev->dev); 251 } 252 253 /** 254 * nfc_device_name - get the nfc device name 255 * 256 * @dev: The nfc device whose name to return 257 */ nfc_device_name(const struct nfc_dev * dev)258 static inline const char *nfc_device_name(const struct nfc_dev *dev) 259 { 260 return dev_name(&dev->dev); 261 } 262 263 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk, 264 unsigned int flags, unsigned int size, 265 unsigned int *err); 266 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp); 267 268 int nfc_set_remote_general_bytes(struct nfc_dev *dev, 269 const u8 *gt, u8 gt_len); 270 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len); 271 272 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name, 273 u32 result); 274 275 int nfc_targets_found(struct nfc_dev *dev, 276 struct nfc_target *targets, int ntargets); 277 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx); 278 279 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx, 280 u8 comm_mode, u8 rf_mode); 281 282 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode, 283 const u8 *gb, size_t gb_len); 284 int nfc_tm_deactivated(struct nfc_dev *dev); 285 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb); 286 287 void nfc_driver_failure(struct nfc_dev *dev, int err); 288 289 int nfc_se_transaction(struct nfc_dev *dev, u8 se_idx, 290 struct nfc_evt_transaction *evt_transaction); 291 int nfc_se_connectivity(struct nfc_dev *dev, u8 se_idx); 292 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type); 293 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx); 294 struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx); 295 296 void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb, 297 u8 payload_type, u8 direction); 298 nfc_set_vendor_cmds(struct nfc_dev * dev,const struct nfc_vendor_cmd * cmds,int n_cmds)299 static inline int nfc_set_vendor_cmds(struct nfc_dev *dev, 300 const struct nfc_vendor_cmd *cmds, 301 int n_cmds) 302 { 303 if (dev->vendor_cmds || dev->n_vendor_cmds) 304 return -EINVAL; 305 306 dev->vendor_cmds = cmds; 307 dev->n_vendor_cmds = n_cmds; 308 309 return 0; 310 } 311 312 struct sk_buff *__nfc_alloc_vendor_cmd_reply_skb(struct nfc_dev *dev, 313 enum nfc_attrs attr, 314 u32 oui, u32 subcmd, 315 int approxlen); 316 int nfc_vendor_cmd_reply(struct sk_buff *skb); 317 318 /** 319 * nfc_vendor_cmd_alloc_reply_skb - allocate vendor command reply 320 * @dev: nfc device 321 * @oui: vendor oui 322 * @approxlen: an upper bound of the length of the data that will 323 * be put into the skb 324 * 325 * This function allocates and pre-fills an skb for a reply to 326 * a vendor command. Since it is intended for a reply, calling 327 * it outside of a vendor command's doit() operation is invalid. 328 * 329 * The returned skb is pre-filled with some identifying data in 330 * a way that any data that is put into the skb (with skb_put(), 331 * nla_put() or similar) will end up being within the 332 * %NFC_ATTR_VENDOR_DATA attribute, so all that needs to be done 333 * with the skb is adding data for the corresponding userspace tool 334 * which can then read that data out of the vendor data attribute. 335 * You must not modify the skb in any other way. 336 * 337 * When done, call nfc_vendor_cmd_reply() with the skb and return 338 * its error code as the result of the doit() operation. 339 * 340 * Return: An allocated and pre-filled skb. %NULL if any errors happen. 341 */ 342 static inline struct sk_buff * nfc_vendor_cmd_alloc_reply_skb(struct nfc_dev * dev,u32 oui,u32 subcmd,int approxlen)343 nfc_vendor_cmd_alloc_reply_skb(struct nfc_dev *dev, 344 u32 oui, u32 subcmd, int approxlen) 345 { 346 return __nfc_alloc_vendor_cmd_reply_skb(dev, 347 NFC_ATTR_VENDOR_DATA, 348 oui, 349 subcmd, approxlen); 350 } 351 352 #endif /* __NET_NFC_H */ 353