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