1 /* 2 * The NFC Controller Interface is the communication protocol between an 3 * NFC Controller (NFCC) and a Device Host (DH). 4 * 5 * Copyright (C) 2011 Texas Instruments, Inc. 6 * Copyright (C) 2013 Intel Corporation. All rights reserved. 7 * Copyright (C) 2014 Marvell International Ltd. 8 * 9 * Written by Ilan Elias <ilane@ti.com> 10 * 11 * Acknowledgements: 12 * This file is based on hci_core.h, which was written 13 * by Maxim Krasnyansky. 14 * 15 * This program is free software; you can redistribute it and/or modify 16 * it under the terms of the GNU General Public License version 2 17 * as published by the Free Software Foundation 18 * 19 * This program is distributed in the hope that it will be useful, 20 * but WITHOUT ANY WARRANTY; without even the implied warranty of 21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 * GNU General Public License for more details. 23 * 24 * You should have received a copy of the GNU General Public License 25 * along with this program; if not, see <http://www.gnu.org/licenses/>. 26 * 27 */ 28 29 #ifndef __NCI_CORE_H 30 #define __NCI_CORE_H 31 32 #include <linux/interrupt.h> 33 #include <linux/skbuff.h> 34 35 #include <net/nfc/nfc.h> 36 #include <net/nfc/nci.h> 37 38 /* NCI device flags */ 39 enum nci_flag { 40 NCI_INIT, 41 NCI_UP, 42 NCI_DATA_EXCHANGE, 43 NCI_DATA_EXCHANGE_TO, 44 }; 45 46 /* NCI device states */ 47 enum nci_state { 48 NCI_IDLE, 49 NCI_DISCOVERY, 50 NCI_W4_ALL_DISCOVERIES, 51 NCI_W4_HOST_SELECT, 52 NCI_POLL_ACTIVE, 53 NCI_LISTEN_ACTIVE, 54 NCI_LISTEN_SLEEP, 55 }; 56 57 /* NCI timeouts */ 58 #define NCI_RESET_TIMEOUT 5000 59 #define NCI_INIT_TIMEOUT 5000 60 #define NCI_SET_CONFIG_TIMEOUT 5000 61 #define NCI_RF_DISC_TIMEOUT 5000 62 #define NCI_RF_DISC_SELECT_TIMEOUT 5000 63 #define NCI_RF_DEACTIVATE_TIMEOUT 30000 64 #define NCI_CMD_TIMEOUT 5000 65 #define NCI_DATA_TIMEOUT 700 66 67 struct nci_dev; 68 69 struct nci_ops { 70 int (*open)(struct nci_dev *ndev); 71 int (*close)(struct nci_dev *ndev); 72 int (*send)(struct nci_dev *ndev, struct sk_buff *skb); 73 int (*setup)(struct nci_dev *ndev); 74 __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol); 75 int (*discover_se)(struct nci_dev *ndev); 76 int (*disable_se)(struct nci_dev *ndev, u32 se_idx); 77 int (*enable_se)(struct nci_dev *ndev, u32 se_idx); 78 int (*se_io)(struct nci_dev *ndev, u32 se_idx, 79 u8 *apdu, size_t apdu_length, 80 se_io_cb_t cb, void *cb_context); 81 int (*hci_load_session)(struct nci_dev *ndev); 82 void (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event, 83 struct sk_buff *skb); 84 void (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd, 85 struct sk_buff *skb); 86 }; 87 88 #define NCI_MAX_SUPPORTED_RF_INTERFACES 4 89 #define NCI_MAX_DISCOVERED_TARGETS 10 90 #define NCI_MAX_NUM_NFCEE 255 91 #define NCI_MAX_CONN_ID 7 92 93 struct nci_conn_info { 94 struct list_head list; 95 __u8 id; /* can be an RF Discovery ID or an NFCEE ID */ 96 __u8 conn_id; 97 __u8 max_pkt_payload_len; 98 99 atomic_t credits_cnt; 100 __u8 initial_num_credits; 101 102 data_exchange_cb_t data_exchange_cb; 103 void *data_exchange_cb_context; 104 105 struct sk_buff *rx_skb; 106 }; 107 108 #define NCI_INVALID_CONN_ID 0x80 109 110 #define NCI_HCI_ANY_OPEN_PIPE 0x03 111 112 /* Gates */ 113 #define NCI_HCI_ADMIN_GATE 0x00 114 #define NCI_HCI_LINK_MGMT_GATE 0x06 115 116 /* Pipes */ 117 #define NCI_HCI_LINK_MGMT_PIPE 0x00 118 #define NCI_HCI_ADMIN_PIPE 0x01 119 120 /* Generic responses */ 121 #define NCI_HCI_ANY_OK 0x00 122 #define NCI_HCI_ANY_E_NOT_CONNECTED 0x01 123 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN 0x02 124 #define NCI_HCI_ANY_E_NOK 0x03 125 #define NCI_HCI_ANY_E_PIPES_FULL 0x04 126 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN 0x05 127 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED 0x06 128 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED 0x07 129 #define NCI_HCI_ANY_E_INHIBITED 0x08 130 #define NCI_HCI_ANY_E_TIMEOUT 0x09 131 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED 0x0a 132 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED 0x0b 133 134 #define NCI_HCI_DO_NOT_OPEN_PIPE 0x81 135 #define NCI_HCI_INVALID_PIPE 0x80 136 #define NCI_HCI_INVALID_GATE 0xFF 137 #define NCI_HCI_INVALID_HOST 0x80 138 139 #define NCI_HCI_MAX_CUSTOM_GATES 50 140 #define NCI_HCI_MAX_PIPES 127 141 142 struct nci_hci_gate { 143 u8 gate; 144 u8 pipe; 145 u8 dest_host; 146 } __packed; 147 148 struct nci_hci_pipe { 149 u8 gate; 150 u8 host; 151 } __packed; 152 153 struct nci_hci_init_data { 154 u8 gate_count; 155 struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES]; 156 char session_id[9]; 157 }; 158 159 #define NCI_HCI_MAX_GATES 256 160 161 struct nci_hci_dev { 162 u8 nfcee_id; 163 struct nci_dev *ndev; 164 struct nci_conn_info *conn_info; 165 166 struct nci_hci_init_data init_data; 167 struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES]; 168 u8 gate2pipe[NCI_HCI_MAX_GATES]; 169 int expected_pipes; 170 int count_pipes; 171 172 struct sk_buff_head rx_hcp_frags; 173 struct work_struct msg_rx_work; 174 struct sk_buff_head msg_rx_queue; 175 }; 176 177 /* NCI Core structures */ 178 struct nci_dev { 179 struct nfc_dev *nfc_dev; 180 struct nci_ops *ops; 181 struct nci_hci_dev *hci_dev; 182 183 int tx_headroom; 184 int tx_tailroom; 185 186 atomic_t state; 187 unsigned long flags; 188 189 atomic_t cmd_cnt; 190 __u8 cur_conn_id; 191 192 struct list_head conn_info_list; 193 struct nci_conn_info *rf_conn_info; 194 195 struct timer_list cmd_timer; 196 struct timer_list data_timer; 197 198 struct workqueue_struct *cmd_wq; 199 struct work_struct cmd_work; 200 201 struct workqueue_struct *rx_wq; 202 struct work_struct rx_work; 203 204 struct workqueue_struct *tx_wq; 205 struct work_struct tx_work; 206 207 struct sk_buff_head cmd_q; 208 struct sk_buff_head rx_q; 209 struct sk_buff_head tx_q; 210 211 struct mutex req_lock; 212 struct completion req_completion; 213 __u32 req_status; 214 __u32 req_result; 215 216 void *driver_data; 217 218 __u32 poll_prots; 219 __u32 target_active_prot; 220 221 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS]; 222 int n_targets; 223 224 /* received during NCI_OP_CORE_RESET_RSP */ 225 __u8 nci_ver; 226 227 /* received during NCI_OP_CORE_INIT_RSP */ 228 __u32 nfcc_features; 229 __u8 num_supported_rf_interfaces; 230 __u8 supported_rf_interfaces 231 [NCI_MAX_SUPPORTED_RF_INTERFACES]; 232 __u8 max_logical_connections; 233 __u16 max_routing_table_size; 234 __u8 max_ctrl_pkt_payload_len; 235 __u16 max_size_for_large_params; 236 __u8 manufact_id; 237 __u32 manufact_specific_info; 238 239 /* Save RF Discovery ID or NFCEE ID under conn_create */ 240 __u8 cur_id; 241 242 /* stored during nci_data_exchange */ 243 struct sk_buff *rx_data_reassembly; 244 245 /* stored during intf_activated_ntf */ 246 __u8 remote_gb[NFC_MAX_GT_LEN]; 247 __u8 remote_gb_len; 248 }; 249 250 /* ----- NCI Devices ----- */ 251 struct nci_dev *nci_allocate_device(struct nci_ops *ops, 252 __u32 supported_protocols, 253 int tx_headroom, 254 int tx_tailroom); 255 void nci_free_device(struct nci_dev *ndev); 256 int nci_register_device(struct nci_dev *ndev); 257 void nci_unregister_device(struct nci_dev *ndev); 258 int nci_request(struct nci_dev *ndev, 259 void (*req)(struct nci_dev *ndev, 260 unsigned long opt), 261 unsigned long opt, __u32 timeout); 262 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb); 263 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val); 264 265 int nci_nfcee_discover(struct nci_dev *ndev, u8 action); 266 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode); 267 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type, 268 u8 number_destination_params, 269 size_t params_len, 270 struct core_conn_create_dest_spec_params *params); 271 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id); 272 273 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev); 274 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event, 275 const u8 *param, size_t param_len); 276 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate, 277 u8 cmd, const u8 *param, size_t param_len, 278 struct sk_buff **skb); 279 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe); 280 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host, 281 u8 dest_gate, u8 pipe); 282 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx, 283 const u8 *param, size_t param_len); 284 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx, 285 struct sk_buff **skb); 286 int nci_hci_dev_session_init(struct nci_dev *ndev); 287 288 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev, 289 unsigned int len, 290 gfp_t how) 291 { 292 struct sk_buff *skb; 293 294 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how); 295 if (skb) 296 skb_reserve(skb, ndev->tx_headroom); 297 298 return skb; 299 } 300 301 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev) 302 { 303 nfc_set_parent_dev(ndev->nfc_dev, dev); 304 } 305 306 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data) 307 { 308 ndev->driver_data = data; 309 } 310 311 static inline void *nci_get_drvdata(struct nci_dev *ndev) 312 { 313 return ndev->driver_data; 314 } 315 316 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb); 317 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb); 318 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb); 319 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload); 320 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb); 321 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb, 322 __u8 conn_id, int err); 323 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err); 324 325 void nci_clear_target_list(struct nci_dev *ndev); 326 327 /* ----- NCI requests ----- */ 328 #define NCI_REQ_DONE 0 329 #define NCI_REQ_PEND 1 330 #define NCI_REQ_CANCELED 2 331 332 void nci_req_complete(struct nci_dev *ndev, int result); 333 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev, 334 int conn_id); 335 336 /* ----- NCI status code ----- */ 337 int nci_to_errno(__u8 code); 338 339 /* ----- NCI over SPI acknowledge modes ----- */ 340 #define NCI_SPI_CRC_DISABLED 0x00 341 #define NCI_SPI_CRC_ENABLED 0x01 342 343 /* ----- NCI SPI structures ----- */ 344 struct nci_spi { 345 struct nci_dev *ndev; 346 struct spi_device *spi; 347 348 unsigned int xfer_udelay; /* microseconds delay between 349 transactions */ 350 u8 acknowledge_mode; 351 352 struct completion req_completion; 353 u8 req_result; 354 }; 355 356 /* ----- NCI SPI ----- */ 357 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi, 358 u8 acknowledge_mode, unsigned int delay, 359 struct nci_dev *ndev); 360 int nci_spi_send(struct nci_spi *nspi, 361 struct completion *write_handshake_completion, 362 struct sk_buff *skb); 363 struct sk_buff *nci_spi_read(struct nci_spi *nspi); 364 365 #endif /* __NCI_CORE_H */ 366