1 /* 2 * Copyright (C) 2011 Instituto Nokia de Tecnologia 3 * Copyright (C) 2014 Marvell International Ltd. 4 * 5 * Authors: 6 * Lauro Ramos Venancio <lauro.venancio@openbossa.org> 7 * Aloisio Almeida Jr <aloisio.almeida@openbossa.org> 8 * 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of the GNU General Public License as published by 11 * the Free Software Foundation; either version 2 of the License, or 12 * (at your option) any later version. 13 * 14 * This program is distributed in the hope that it will be useful, 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 * GNU General Public License for more details. 18 * 19 * You should have received a copy of the GNU General Public License 20 * along with this program; if not, see <http://www.gnu.org/licenses/>. 21 */ 22 23 #ifndef __NET_NFC_H 24 #define __NET_NFC_H 25 26 #include <linux/nfc.h> 27 #include <linux/device.h> 28 #include <linux/skbuff.h> 29 30 #define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__) 31 #define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__) 32 33 struct nfc_phy_ops { 34 int (*write)(void *dev_id, struct sk_buff *skb); 35 int (*enable)(void *dev_id); 36 void (*disable)(void *dev_id); 37 }; 38 39 struct nfc_dev; 40 41 /** 42 * data_exchange_cb_t - Definition of nfc_data_exchange callback 43 * 44 * @context: nfc_data_exchange cb_context parameter 45 * @skb: response data 46 * @err: If an error has occurred during data exchange, it is the 47 * error number. Zero means no error. 48 * 49 * When a rx or tx package is lost or corrupted or the target gets out 50 * of the operating field, err is -EIO. 51 */ 52 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb, 53 int err); 54 55 typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err); 56 57 struct nfc_target; 58 59 struct nfc_ops { 60 int (*dev_up)(struct nfc_dev *dev); 61 int (*dev_down)(struct nfc_dev *dev); 62 int (*start_poll)(struct nfc_dev *dev, 63 u32 im_protocols, u32 tm_protocols); 64 void (*stop_poll)(struct nfc_dev *dev); 65 int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target, 66 u8 comm_mode, u8 *gb, size_t gb_len); 67 int (*dep_link_down)(struct nfc_dev *dev); 68 int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target, 69 u32 protocol); 70 void (*deactivate_target)(struct nfc_dev *dev, 71 struct nfc_target *target); 72 int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target, 73 struct sk_buff *skb, data_exchange_cb_t cb, 74 void *cb_context); 75 int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb); 76 int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target); 77 int (*fw_download)(struct nfc_dev *dev, const char *firmware_name); 78 79 /* Secure Element API */ 80 int (*discover_se)(struct nfc_dev *dev); 81 int (*enable_se)(struct nfc_dev *dev, u32 se_idx); 82 int (*disable_se)(struct nfc_dev *dev, u32 se_idx); 83 int (*se_io) (struct nfc_dev *dev, u32 se_idx, 84 u8 *apdu, size_t apdu_length, 85 se_io_cb_t cb, void *cb_context); 86 }; 87 88 #define NFC_TARGET_IDX_ANY -1 89 #define NFC_MAX_GT_LEN 48 90 #define NFC_ATR_RES_GT_OFFSET 15 91 #define NFC_ATR_REQ_GT_OFFSET 14 92 93 /** 94 * struct nfc_target - NFC target descriptiom 95 * 96 * @sens_res: 2 bytes describing the target SENS_RES response, if the target 97 * is a type A one. The %sens_res most significant byte must be byte 2 98 * as described by the NFC Forum digital specification (i.e. the platform 99 * configuration one) while %sens_res least significant byte is byte 1. 100 */ 101 struct nfc_target { 102 u32 idx; 103 u32 supported_protocols; 104 u16 sens_res; 105 u8 sel_res; 106 u8 nfcid1_len; 107 u8 nfcid1[NFC_NFCID1_MAXSIZE]; 108 u8 nfcid2_len; 109 u8 nfcid2[NFC_NFCID2_MAXSIZE]; 110 u8 sensb_res_len; 111 u8 sensb_res[NFC_SENSB_RES_MAXSIZE]; 112 u8 sensf_res_len; 113 u8 sensf_res[NFC_SENSF_RES_MAXSIZE]; 114 u8 hci_reader_gate; 115 u8 logical_idx; 116 u8 is_iso15693; 117 u8 iso15693_dsfid; 118 u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE]; 119 }; 120 121 /** 122 * nfc_se - A structure for NFC accessible secure elements. 123 * 124 * @idx: The secure element index. User space will enable or 125 * disable a secure element by its index. 126 * @type: The secure element type. It can be SE_UICC or 127 * SE_EMBEDDED. 128 * @state: The secure element state, either enabled or disabled. 129 * 130 */ 131 struct nfc_se { 132 struct list_head list; 133 u32 idx; 134 u16 type; 135 u16 state; 136 }; 137 138 struct nfc_genl_data { 139 u32 poll_req_portid; 140 struct mutex genl_data_mutex; 141 }; 142 143 struct nfc_dev { 144 int idx; 145 u32 target_next_idx; 146 struct nfc_target *targets; 147 int n_targets; 148 int targets_generation; 149 struct device dev; 150 bool dev_up; 151 bool fw_download_in_progress; 152 u8 rf_mode; 153 bool polling; 154 struct nfc_target *active_target; 155 bool dep_link_up; 156 struct nfc_genl_data genl_data; 157 u32 supported_protocols; 158 159 struct list_head secure_elements; 160 161 int tx_headroom; 162 int tx_tailroom; 163 164 struct timer_list check_pres_timer; 165 struct work_struct check_pres_work; 166 167 bool shutting_down; 168 169 struct rfkill *rfkill; 170 171 struct nfc_ops *ops; 172 }; 173 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev) 174 175 extern struct class nfc_class; 176 177 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops, 178 u32 supported_protocols, 179 int tx_headroom, 180 int tx_tailroom); 181 182 /** 183 * nfc_free_device - free nfc device 184 * 185 * @dev: The nfc device to free 186 */ 187 static inline void nfc_free_device(struct nfc_dev *dev) 188 { 189 put_device(&dev->dev); 190 } 191 192 int nfc_register_device(struct nfc_dev *dev); 193 194 void nfc_unregister_device(struct nfc_dev *dev); 195 196 /** 197 * nfc_set_parent_dev - set the parent device 198 * 199 * @nfc_dev: The nfc device whose parent is being set 200 * @dev: The parent device 201 */ 202 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev, 203 struct device *dev) 204 { 205 nfc_dev->dev.parent = dev; 206 } 207 208 /** 209 * nfc_set_drvdata - set driver specifc data 210 * 211 * @dev: The nfc device 212 * @data: Pointer to driver specifc data 213 */ 214 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data) 215 { 216 dev_set_drvdata(&dev->dev, data); 217 } 218 219 /** 220 * nfc_get_drvdata - get driver specifc data 221 * 222 * @dev: The nfc device 223 */ 224 static inline void *nfc_get_drvdata(struct nfc_dev *dev) 225 { 226 return dev_get_drvdata(&dev->dev); 227 } 228 229 /** 230 * nfc_device_name - get the nfc device name 231 * 232 * @dev: The nfc device whose name to return 233 */ 234 static inline const char *nfc_device_name(struct nfc_dev *dev) 235 { 236 return dev_name(&dev->dev); 237 } 238 239 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk, 240 unsigned int flags, unsigned int size, 241 unsigned int *err); 242 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp); 243 244 int nfc_set_remote_general_bytes(struct nfc_dev *dev, 245 u8 *gt, u8 gt_len); 246 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len); 247 248 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name, 249 u32 result); 250 251 int nfc_targets_found(struct nfc_dev *dev, 252 struct nfc_target *targets, int ntargets); 253 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx); 254 255 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx, 256 u8 comm_mode, u8 rf_mode); 257 258 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode, 259 u8 *gb, size_t gb_len); 260 int nfc_tm_deactivated(struct nfc_dev *dev); 261 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb); 262 263 void nfc_driver_failure(struct nfc_dev *dev, int err); 264 265 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type); 266 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx); 267 struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx); 268 269 void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb, 270 u8 payload_type, u8 direction); 271 272 #endif /* __NET_NFC_H */ 273