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_prop_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_prop_ops *prop_ops; 98 size_t n_prop_ops; 99 }; 100 101 #define NCI_MAX_SUPPORTED_RF_INTERFACES 4 102 #define NCI_MAX_DISCOVERED_TARGETS 10 103 #define NCI_MAX_NUM_NFCEE 255 104 #define NCI_MAX_CONN_ID 7 105 #define NCI_MAX_PROPRIETARY_CMD 64 106 107 struct nci_conn_info { 108 struct list_head list; 109 __u8 id; /* can be an RF Discovery ID or an NFCEE ID */ 110 __u8 conn_id; 111 __u8 max_pkt_payload_len; 112 113 atomic_t credits_cnt; 114 __u8 initial_num_credits; 115 116 data_exchange_cb_t data_exchange_cb; 117 void *data_exchange_cb_context; 118 119 struct sk_buff *rx_skb; 120 }; 121 122 #define NCI_INVALID_CONN_ID 0x80 123 124 #define NCI_HCI_ANY_OPEN_PIPE 0x03 125 126 /* Gates */ 127 #define NCI_HCI_ADMIN_GATE 0x00 128 #define NCI_HCI_LINK_MGMT_GATE 0x06 129 130 /* Pipes */ 131 #define NCI_HCI_LINK_MGMT_PIPE 0x00 132 #define NCI_HCI_ADMIN_PIPE 0x01 133 134 /* Generic responses */ 135 #define NCI_HCI_ANY_OK 0x00 136 #define NCI_HCI_ANY_E_NOT_CONNECTED 0x01 137 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN 0x02 138 #define NCI_HCI_ANY_E_NOK 0x03 139 #define NCI_HCI_ANY_E_PIPES_FULL 0x04 140 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN 0x05 141 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED 0x06 142 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED 0x07 143 #define NCI_HCI_ANY_E_INHIBITED 0x08 144 #define NCI_HCI_ANY_E_TIMEOUT 0x09 145 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED 0x0a 146 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED 0x0b 147 148 #define NCI_HCI_DO_NOT_OPEN_PIPE 0x81 149 #define NCI_HCI_INVALID_PIPE 0x80 150 #define NCI_HCI_INVALID_GATE 0xFF 151 #define NCI_HCI_INVALID_HOST 0x80 152 153 #define NCI_HCI_MAX_CUSTOM_GATES 50 154 /* 155 * According to specification 102 622 chapter 4.4 Pipes, 156 * the pipe identifier is 7 bits long. 157 */ 158 #define NCI_HCI_MAX_PIPES 127 159 160 struct nci_hci_gate { 161 u8 gate; 162 u8 pipe; 163 u8 dest_host; 164 } __packed; 165 166 struct nci_hci_pipe { 167 u8 gate; 168 u8 host; 169 } __packed; 170 171 struct nci_hci_init_data { 172 u8 gate_count; 173 struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES]; 174 char session_id[9]; 175 }; 176 177 #define NCI_HCI_MAX_GATES 256 178 179 struct nci_hci_dev { 180 u8 nfcee_id; 181 struct nci_dev *ndev; 182 struct nci_conn_info *conn_info; 183 184 struct nci_hci_init_data init_data; 185 struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES]; 186 u8 gate2pipe[NCI_HCI_MAX_GATES]; 187 int expected_pipes; 188 int count_pipes; 189 190 struct sk_buff_head rx_hcp_frags; 191 struct work_struct msg_rx_work; 192 struct sk_buff_head msg_rx_queue; 193 }; 194 195 /* NCI Core structures */ 196 struct nci_dev { 197 struct nfc_dev *nfc_dev; 198 struct nci_ops *ops; 199 struct nci_hci_dev *hci_dev; 200 201 int tx_headroom; 202 int tx_tailroom; 203 204 atomic_t state; 205 unsigned long flags; 206 207 atomic_t cmd_cnt; 208 __u8 cur_conn_id; 209 210 struct list_head conn_info_list; 211 struct nci_conn_info *rf_conn_info; 212 213 struct timer_list cmd_timer; 214 struct timer_list data_timer; 215 216 struct workqueue_struct *cmd_wq; 217 struct work_struct cmd_work; 218 219 struct workqueue_struct *rx_wq; 220 struct work_struct rx_work; 221 222 struct workqueue_struct *tx_wq; 223 struct work_struct tx_work; 224 225 struct sk_buff_head cmd_q; 226 struct sk_buff_head rx_q; 227 struct sk_buff_head tx_q; 228 229 struct mutex req_lock; 230 struct completion req_completion; 231 __u32 req_status; 232 __u32 req_result; 233 234 void *driver_data; 235 236 __u32 poll_prots; 237 __u32 target_active_prot; 238 239 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS]; 240 int n_targets; 241 242 /* received during NCI_OP_CORE_RESET_RSP */ 243 __u8 nci_ver; 244 245 /* received during NCI_OP_CORE_INIT_RSP */ 246 __u32 nfcc_features; 247 __u8 num_supported_rf_interfaces; 248 __u8 supported_rf_interfaces 249 [NCI_MAX_SUPPORTED_RF_INTERFACES]; 250 __u8 max_logical_connections; 251 __u16 max_routing_table_size; 252 __u8 max_ctrl_pkt_payload_len; 253 __u16 max_size_for_large_params; 254 __u8 manufact_id; 255 __u32 manufact_specific_info; 256 257 /* Save RF Discovery ID or NFCEE ID under conn_create */ 258 __u8 cur_id; 259 260 /* stored during nci_data_exchange */ 261 struct sk_buff *rx_data_reassembly; 262 263 /* stored during intf_activated_ntf */ 264 __u8 remote_gb[NFC_MAX_GT_LEN]; 265 __u8 remote_gb_len; 266 }; 267 268 /* ----- NCI Devices ----- */ 269 struct nci_dev *nci_allocate_device(struct nci_ops *ops, 270 __u32 supported_protocols, 271 int tx_headroom, 272 int tx_tailroom); 273 void nci_free_device(struct nci_dev *ndev); 274 int nci_register_device(struct nci_dev *ndev); 275 void nci_unregister_device(struct nci_dev *ndev); 276 int nci_request(struct nci_dev *ndev, 277 void (*req)(struct nci_dev *ndev, 278 unsigned long opt), 279 unsigned long opt, __u32 timeout); 280 int nci_prop_cmd(struct nci_dev *ndev, __u8 oid, size_t len, __u8 *payload); 281 int nci_core_reset(struct nci_dev *ndev); 282 int nci_core_init(struct nci_dev *ndev); 283 284 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb); 285 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val); 286 287 int nci_nfcee_discover(struct nci_dev *ndev, u8 action); 288 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode); 289 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type, 290 u8 number_destination_params, 291 size_t params_len, 292 struct core_conn_create_dest_spec_params *params); 293 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id); 294 295 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev); 296 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event, 297 const u8 *param, size_t param_len); 298 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate, 299 u8 cmd, const u8 *param, size_t param_len, 300 struct sk_buff **skb); 301 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe); 302 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host, 303 u8 dest_gate, u8 pipe); 304 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx, 305 const u8 *param, size_t param_len); 306 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx, 307 struct sk_buff **skb); 308 int nci_hci_dev_session_init(struct nci_dev *ndev); 309 310 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev, 311 unsigned int len, 312 gfp_t how) 313 { 314 struct sk_buff *skb; 315 316 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how); 317 if (skb) 318 skb_reserve(skb, ndev->tx_headroom); 319 320 return skb; 321 } 322 323 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev) 324 { 325 nfc_set_parent_dev(ndev->nfc_dev, dev); 326 } 327 328 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data) 329 { 330 ndev->driver_data = data; 331 } 332 333 static inline void *nci_get_drvdata(struct nci_dev *ndev) 334 { 335 return ndev->driver_data; 336 } 337 338 static inline int nci_set_vendor_cmds(struct nci_dev *ndev, 339 struct nfc_vendor_cmd *cmds, 340 int n_cmds) 341 { 342 return nfc_set_vendor_cmds(ndev->nfc_dev, cmds, n_cmds); 343 } 344 345 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb); 346 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb); 347 int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode, 348 struct sk_buff *skb); 349 int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode, 350 struct sk_buff *skb); 351 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb); 352 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload); 353 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb); 354 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb, 355 __u8 conn_id, int err); 356 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err); 357 358 void nci_clear_target_list(struct nci_dev *ndev); 359 360 /* ----- NCI requests ----- */ 361 #define NCI_REQ_DONE 0 362 #define NCI_REQ_PEND 1 363 #define NCI_REQ_CANCELED 2 364 365 void nci_req_complete(struct nci_dev *ndev, int result); 366 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev, 367 int conn_id); 368 369 /* ----- NCI status code ----- */ 370 int nci_to_errno(__u8 code); 371 372 /* ----- NCI over SPI acknowledge modes ----- */ 373 #define NCI_SPI_CRC_DISABLED 0x00 374 #define NCI_SPI_CRC_ENABLED 0x01 375 376 /* ----- NCI SPI structures ----- */ 377 struct nci_spi { 378 struct nci_dev *ndev; 379 struct spi_device *spi; 380 381 unsigned int xfer_udelay; /* microseconds delay between 382 transactions */ 383 u8 acknowledge_mode; 384 385 struct completion req_completion; 386 u8 req_result; 387 }; 388 389 /* ----- NCI SPI ----- */ 390 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi, 391 u8 acknowledge_mode, unsigned int delay, 392 struct nci_dev *ndev); 393 int nci_spi_send(struct nci_spi *nspi, 394 struct completion *write_handshake_completion, 395 struct sk_buff *skb); 396 struct sk_buff *nci_spi_read(struct nci_spi *nspi); 397 398 /* ----- NCI UART ---- */ 399 400 /* Ioctl */ 401 #define NCIUARTSETDRIVER _IOW('U', 0, char *) 402 403 enum nci_uart_driver { 404 NCI_UART_DRIVER_MARVELL = 0, 405 NCI_UART_DRIVER_MAX 406 }; 407 408 struct nci_uart; 409 410 struct nci_uart_ops { 411 int (*open)(struct nci_uart *nci_uart); 412 void (*close)(struct nci_uart *nci_uart); 413 int (*recv)(struct nci_uart *nci_uart, struct sk_buff *skb); 414 int (*recv_buf)(struct nci_uart *nci_uart, const u8 *data, char *flags, 415 int count); 416 int (*send)(struct nci_uart *nci_uart, struct sk_buff *skb); 417 void (*tx_start)(struct nci_uart *nci_uart); 418 void (*tx_done)(struct nci_uart *nci_uart); 419 }; 420 421 struct nci_uart { 422 struct module *owner; 423 struct nci_uart_ops ops; 424 const char *name; 425 enum nci_uart_driver driver; 426 427 /* Dynamic data */ 428 struct nci_dev *ndev; 429 spinlock_t rx_lock; 430 struct work_struct write_work; 431 struct tty_struct *tty; 432 unsigned long tx_state; 433 struct sk_buff_head tx_q; 434 struct sk_buff *tx_skb; 435 struct sk_buff *rx_skb; 436 int rx_packet_len; 437 void *drv_data; 438 }; 439 440 int nci_uart_register(struct nci_uart *nu); 441 void nci_uart_unregister(struct nci_uart *nu); 442 void nci_uart_set_config(struct nci_uart *nu, int baudrate, int flow_ctrl); 443 444 #endif /* __NCI_CORE_H */ 445