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 #include <linux/tty.h> 35 36 #include <net/nfc/nfc.h> 37 #include <net/nfc/nci.h> 38 39 /* NCI device flags */ 40 enum nci_flag { 41 NCI_INIT, 42 NCI_UP, 43 NCI_DATA_EXCHANGE, 44 NCI_DATA_EXCHANGE_TO, 45 }; 46 47 /* NCI device states */ 48 enum nci_state { 49 NCI_IDLE, 50 NCI_DISCOVERY, 51 NCI_W4_ALL_DISCOVERIES, 52 NCI_W4_HOST_SELECT, 53 NCI_POLL_ACTIVE, 54 NCI_LISTEN_ACTIVE, 55 NCI_LISTEN_SLEEP, 56 }; 57 58 /* NCI timeouts */ 59 #define NCI_RESET_TIMEOUT 5000 60 #define NCI_INIT_TIMEOUT 5000 61 #define NCI_SET_CONFIG_TIMEOUT 5000 62 #define NCI_RF_DISC_TIMEOUT 5000 63 #define NCI_RF_DISC_SELECT_TIMEOUT 5000 64 #define NCI_RF_DEACTIVATE_TIMEOUT 30000 65 #define NCI_CMD_TIMEOUT 5000 66 #define NCI_DATA_TIMEOUT 700 67 68 struct nci_dev; 69 70 struct nci_driver_ops { 71 __u16 opcode; 72 int (*rsp)(struct nci_dev *dev, struct sk_buff *skb); 73 int (*ntf)(struct nci_dev *dev, struct sk_buff *skb); 74 }; 75 76 struct nci_ops { 77 int (*init)(struct nci_dev *ndev); 78 int (*open)(struct nci_dev *ndev); 79 int (*close)(struct nci_dev *ndev); 80 int (*send)(struct nci_dev *ndev, struct sk_buff *skb); 81 int (*setup)(struct nci_dev *ndev); 82 int (*post_setup)(struct nci_dev *ndev); 83 int (*fw_download)(struct nci_dev *ndev, const char *firmware_name); 84 __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol); 85 int (*discover_se)(struct nci_dev *ndev); 86 int (*disable_se)(struct nci_dev *ndev, u32 se_idx); 87 int (*enable_se)(struct nci_dev *ndev, u32 se_idx); 88 int (*se_io)(struct nci_dev *ndev, u32 se_idx, 89 u8 *apdu, size_t apdu_length, 90 se_io_cb_t cb, void *cb_context); 91 int (*hci_load_session)(struct nci_dev *ndev); 92 void (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event, 93 struct sk_buff *skb); 94 void (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd, 95 struct sk_buff *skb); 96 97 struct nci_driver_ops *prop_ops; 98 size_t n_prop_ops; 99 100 struct nci_driver_ops *core_ops; 101 size_t n_core_ops; 102 }; 103 104 #define NCI_MAX_SUPPORTED_RF_INTERFACES 4 105 #define NCI_MAX_DISCOVERED_TARGETS 10 106 #define NCI_MAX_NUM_NFCEE 255 107 #define NCI_MAX_CONN_ID 7 108 #define NCI_MAX_PROPRIETARY_CMD 64 109 110 struct nci_conn_info { 111 struct list_head list; 112 /* NCI specification 4.4.2 Connection Creation 113 * The combination of destination type and destination specific 114 * parameters shall uniquely identify a single destination for the 115 * Logical Connection 116 */ 117 struct dest_spec_params *dest_params; 118 __u8 dest_type; 119 __u8 conn_id; 120 __u8 max_pkt_payload_len; 121 122 atomic_t credits_cnt; 123 __u8 initial_num_credits; 124 125 data_exchange_cb_t data_exchange_cb; 126 void *data_exchange_cb_context; 127 128 struct sk_buff *rx_skb; 129 }; 130 131 #define NCI_INVALID_CONN_ID 0x80 132 133 #define NCI_HCI_ANY_OPEN_PIPE 0x03 134 135 /* Gates */ 136 #define NCI_HCI_ADMIN_GATE 0x00 137 #define NCI_HCI_LOOPBACK_GATE 0x04 138 #define NCI_HCI_IDENTITY_MGMT_GATE 0x05 139 #define NCI_HCI_LINK_MGMT_GATE 0x06 140 141 /* Pipes */ 142 #define NCI_HCI_LINK_MGMT_PIPE 0x00 143 #define NCI_HCI_ADMIN_PIPE 0x01 144 145 /* Generic responses */ 146 #define NCI_HCI_ANY_OK 0x00 147 #define NCI_HCI_ANY_E_NOT_CONNECTED 0x01 148 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN 0x02 149 #define NCI_HCI_ANY_E_NOK 0x03 150 #define NCI_HCI_ANY_E_PIPES_FULL 0x04 151 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN 0x05 152 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED 0x06 153 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED 0x07 154 #define NCI_HCI_ANY_E_INHIBITED 0x08 155 #define NCI_HCI_ANY_E_TIMEOUT 0x09 156 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED 0x0a 157 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED 0x0b 158 159 #define NCI_HCI_DO_NOT_OPEN_PIPE 0x81 160 #define NCI_HCI_INVALID_PIPE 0x80 161 #define NCI_HCI_INVALID_GATE 0xFF 162 #define NCI_HCI_INVALID_HOST 0x80 163 164 #define NCI_HCI_MAX_CUSTOM_GATES 50 165 /* 166 * According to specification 102 622 chapter 4.4 Pipes, 167 * the pipe identifier is 7 bits long. 168 */ 169 #define NCI_HCI_MAX_PIPES 127 170 171 struct nci_hci_gate { 172 u8 gate; 173 u8 pipe; 174 u8 dest_host; 175 } __packed; 176 177 struct nci_hci_pipe { 178 u8 gate; 179 u8 host; 180 } __packed; 181 182 struct nci_hci_init_data { 183 u8 gate_count; 184 struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES]; 185 char session_id[9]; 186 }; 187 188 #define NCI_HCI_MAX_GATES 256 189 190 struct nci_hci_dev { 191 u8 nfcee_id; 192 struct nci_dev *ndev; 193 struct nci_conn_info *conn_info; 194 195 struct nci_hci_init_data init_data; 196 struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES]; 197 u8 gate2pipe[NCI_HCI_MAX_GATES]; 198 int expected_pipes; 199 int count_pipes; 200 201 struct sk_buff_head rx_hcp_frags; 202 struct work_struct msg_rx_work; 203 struct sk_buff_head msg_rx_queue; 204 }; 205 206 /* NCI Core structures */ 207 struct nci_dev { 208 struct nfc_dev *nfc_dev; 209 struct nci_ops *ops; 210 struct nci_hci_dev *hci_dev; 211 212 int tx_headroom; 213 int tx_tailroom; 214 215 atomic_t state; 216 unsigned long flags; 217 218 atomic_t cmd_cnt; 219 __u8 cur_conn_id; 220 221 struct list_head conn_info_list; 222 struct nci_conn_info *rf_conn_info; 223 224 struct timer_list cmd_timer; 225 struct timer_list data_timer; 226 227 struct workqueue_struct *cmd_wq; 228 struct work_struct cmd_work; 229 230 struct workqueue_struct *rx_wq; 231 struct work_struct rx_work; 232 233 struct workqueue_struct *tx_wq; 234 struct work_struct tx_work; 235 236 struct sk_buff_head cmd_q; 237 struct sk_buff_head rx_q; 238 struct sk_buff_head tx_q; 239 240 struct mutex req_lock; 241 struct completion req_completion; 242 __u32 req_status; 243 __u32 req_result; 244 245 void *driver_data; 246 247 __u32 poll_prots; 248 __u32 target_active_prot; 249 250 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS]; 251 int n_targets; 252 253 /* received during NCI_OP_CORE_RESET_RSP */ 254 __u8 nci_ver; 255 256 /* received during NCI_OP_CORE_INIT_RSP */ 257 __u32 nfcc_features; 258 __u8 num_supported_rf_interfaces; 259 __u8 supported_rf_interfaces 260 [NCI_MAX_SUPPORTED_RF_INTERFACES]; 261 __u8 max_logical_connections; 262 __u16 max_routing_table_size; 263 __u8 max_ctrl_pkt_payload_len; 264 __u16 max_size_for_large_params; 265 __u8 manufact_id; 266 __u32 manufact_specific_info; 267 268 /* Save RF Discovery ID or NFCEE ID under conn_create */ 269 struct dest_spec_params cur_params; 270 /* Save destination type under conn_create */ 271 __u8 cur_dest_type; 272 273 /* stored during nci_data_exchange */ 274 struct sk_buff *rx_data_reassembly; 275 276 /* stored during intf_activated_ntf */ 277 __u8 remote_gb[NFC_MAX_GT_LEN]; 278 __u8 remote_gb_len; 279 }; 280 281 /* ----- NCI Devices ----- */ 282 struct nci_dev *nci_allocate_device(struct nci_ops *ops, 283 __u32 supported_protocols, 284 int tx_headroom, 285 int tx_tailroom); 286 void nci_free_device(struct nci_dev *ndev); 287 int nci_register_device(struct nci_dev *ndev); 288 void nci_unregister_device(struct nci_dev *ndev); 289 int nci_request(struct nci_dev *ndev, 290 void (*req)(struct nci_dev *ndev, 291 unsigned long opt), 292 unsigned long opt, __u32 timeout); 293 int nci_prop_cmd(struct nci_dev *ndev, __u8 oid, size_t len, __u8 *payload); 294 int nci_core_cmd(struct nci_dev *ndev, __u16 opcode, size_t len, __u8 *payload); 295 int nci_core_reset(struct nci_dev *ndev); 296 int nci_core_init(struct nci_dev *ndev); 297 298 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb); 299 int nci_send_frame(struct nci_dev *ndev, struct sk_buff *skb); 300 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val); 301 302 int nci_nfcee_discover(struct nci_dev *ndev, u8 action); 303 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode); 304 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type, 305 u8 number_destination_params, 306 size_t params_len, 307 struct core_conn_create_dest_spec_params *params); 308 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id); 309 int nci_nfcc_loopback(struct nci_dev *ndev, void *data, size_t data_len, 310 struct sk_buff **resp); 311 312 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev); 313 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event, 314 const u8 *param, size_t param_len); 315 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate, 316 u8 cmd, const u8 *param, size_t param_len, 317 struct sk_buff **skb); 318 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe); 319 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host, 320 u8 dest_gate, u8 pipe); 321 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx, 322 const u8 *param, size_t param_len); 323 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx, 324 struct sk_buff **skb); 325 int nci_hci_clear_all_pipes(struct nci_dev *ndev); 326 int nci_hci_dev_session_init(struct nci_dev *ndev); 327 328 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev, 329 unsigned int len, 330 gfp_t how) 331 { 332 struct sk_buff *skb; 333 334 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how); 335 if (skb) 336 skb_reserve(skb, ndev->tx_headroom); 337 338 return skb; 339 } 340 341 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev) 342 { 343 nfc_set_parent_dev(ndev->nfc_dev, dev); 344 } 345 346 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data) 347 { 348 ndev->driver_data = data; 349 } 350 351 static inline void *nci_get_drvdata(struct nci_dev *ndev) 352 { 353 return ndev->driver_data; 354 } 355 356 static inline int nci_set_vendor_cmds(struct nci_dev *ndev, 357 struct nfc_vendor_cmd *cmds, 358 int n_cmds) 359 { 360 return nfc_set_vendor_cmds(ndev->nfc_dev, cmds, n_cmds); 361 } 362 363 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb); 364 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb); 365 int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode, 366 struct sk_buff *skb); 367 int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode, 368 struct sk_buff *skb); 369 int nci_core_rsp_packet(struct nci_dev *ndev, __u16 opcode, 370 struct sk_buff *skb); 371 int nci_core_ntf_packet(struct nci_dev *ndev, __u16 opcode, 372 struct sk_buff *skb); 373 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb); 374 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload); 375 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb); 376 int nci_conn_max_data_pkt_payload_size(struct nci_dev *ndev, __u8 conn_id); 377 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb, 378 __u8 conn_id, int err); 379 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err); 380 381 void nci_clear_target_list(struct nci_dev *ndev); 382 383 /* ----- NCI requests ----- */ 384 #define NCI_REQ_DONE 0 385 #define NCI_REQ_PEND 1 386 #define NCI_REQ_CANCELED 2 387 388 void nci_req_complete(struct nci_dev *ndev, int result); 389 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev, 390 int conn_id); 391 int nci_get_conn_info_by_dest_type_params(struct nci_dev *ndev, u8 dest_type, 392 struct dest_spec_params *params); 393 394 /* ----- NCI status code ----- */ 395 int nci_to_errno(__u8 code); 396 397 /* ----- NCI over SPI acknowledge modes ----- */ 398 #define NCI_SPI_CRC_DISABLED 0x00 399 #define NCI_SPI_CRC_ENABLED 0x01 400 401 /* ----- NCI SPI structures ----- */ 402 struct nci_spi { 403 struct nci_dev *ndev; 404 struct spi_device *spi; 405 406 unsigned int xfer_udelay; /* microseconds delay between 407 transactions */ 408 409 unsigned int xfer_speed_hz; /* 410 * SPI clock frequency 411 * 0 => default clock 412 */ 413 414 u8 acknowledge_mode; 415 416 struct completion req_completion; 417 u8 req_result; 418 }; 419 420 /* ----- NCI SPI ----- */ 421 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi, 422 u8 acknowledge_mode, unsigned int delay, 423 struct nci_dev *ndev); 424 int nci_spi_send(struct nci_spi *nspi, 425 struct completion *write_handshake_completion, 426 struct sk_buff *skb); 427 struct sk_buff *nci_spi_read(struct nci_spi *nspi); 428 429 /* ----- NCI UART ---- */ 430 431 /* Ioctl */ 432 #define NCIUARTSETDRIVER _IOW('U', 0, char *) 433 434 enum nci_uart_driver { 435 NCI_UART_DRIVER_MARVELL = 0, 436 NCI_UART_DRIVER_MAX 437 }; 438 439 struct nci_uart; 440 441 struct nci_uart_ops { 442 int (*open)(struct nci_uart *nci_uart); 443 void (*close)(struct nci_uart *nci_uart); 444 int (*recv)(struct nci_uart *nci_uart, struct sk_buff *skb); 445 int (*recv_buf)(struct nci_uart *nci_uart, const u8 *data, char *flags, 446 int count); 447 int (*send)(struct nci_uart *nci_uart, struct sk_buff *skb); 448 void (*tx_start)(struct nci_uart *nci_uart); 449 void (*tx_done)(struct nci_uart *nci_uart); 450 }; 451 452 struct nci_uart { 453 struct module *owner; 454 struct nci_uart_ops ops; 455 const char *name; 456 enum nci_uart_driver driver; 457 458 /* Dynamic data */ 459 struct nci_dev *ndev; 460 spinlock_t rx_lock; 461 struct work_struct write_work; 462 struct tty_struct *tty; 463 unsigned long tx_state; 464 struct sk_buff_head tx_q; 465 struct sk_buff *tx_skb; 466 struct sk_buff *rx_skb; 467 int rx_packet_len; 468 void *drv_data; 469 }; 470 471 int nci_uart_register(struct nci_uart *nu); 472 void nci_uart_unregister(struct nci_uart *nu); 473 void nci_uart_set_config(struct nci_uart *nu, int baudrate, int flow_ctrl); 474 475 #endif /* __NCI_CORE_H */ 476