2 * The NFC Controller Interface is the communication protocol between an
3 * NFC Controller (NFCC) and a Device Host (DH).
5 * Copyright (C) 2011 Texas Instruments, Inc.
6 * Copyright (C) 2013 Intel Corporation. All rights reserved.
7 * Copyright (C) 2014 Marvell International Ltd.
9 * Written by Ilan Elias <ilane@ti.com>
12 * This file is based on hci_core.h, which was written
13 * by Maxim Krasnyansky.
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
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.
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/>.
32 #include <linux/interrupt.h>
33 #include <linux/skbuff.h>
34 #include <linux/tty.h>
36 #include <net/nfc/nfc.h>
37 #include <net/nfc/nci.h>
39 /* NCI device flags */
47 /* NCI device states */
51 NCI_W4_ALL_DISCOVERIES,
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
70 struct nci_driver_ops {
72 int (*rsp)(struct nci_dev *dev, struct sk_buff *skb);
73 int (*ntf)(struct nci_dev *dev, struct sk_buff *skb);
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,
94 void (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd,
97 struct nci_driver_ops *prop_ops;
100 struct nci_driver_ops *core_ops;
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
110 struct nci_conn_info {
111 struct list_head list;
112 __u8 id; /* can be an RF Discovery ID or an NFCEE ID */
114 __u8 max_pkt_payload_len;
116 atomic_t credits_cnt;
117 __u8 initial_num_credits;
119 data_exchange_cb_t data_exchange_cb;
120 void *data_exchange_cb_context;
122 struct sk_buff *rx_skb;
125 #define NCI_INVALID_CONN_ID 0x80
127 #define NCI_HCI_ANY_OPEN_PIPE 0x03
130 #define NCI_HCI_ADMIN_GATE 0x00
131 #define NCI_HCI_LOOPBACK_GATE 0x04
132 #define NCI_HCI_IDENTITY_MGMT_GATE 0x05
133 #define NCI_HCI_LINK_MGMT_GATE 0x06
136 #define NCI_HCI_LINK_MGMT_PIPE 0x00
137 #define NCI_HCI_ADMIN_PIPE 0x01
139 /* Generic responses */
140 #define NCI_HCI_ANY_OK 0x00
141 #define NCI_HCI_ANY_E_NOT_CONNECTED 0x01
142 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN 0x02
143 #define NCI_HCI_ANY_E_NOK 0x03
144 #define NCI_HCI_ANY_E_PIPES_FULL 0x04
145 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN 0x05
146 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED 0x06
147 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED 0x07
148 #define NCI_HCI_ANY_E_INHIBITED 0x08
149 #define NCI_HCI_ANY_E_TIMEOUT 0x09
150 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED 0x0a
151 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED 0x0b
153 #define NCI_HCI_DO_NOT_OPEN_PIPE 0x81
154 #define NCI_HCI_INVALID_PIPE 0x80
155 #define NCI_HCI_INVALID_GATE 0xFF
156 #define NCI_HCI_INVALID_HOST 0x80
158 #define NCI_HCI_MAX_CUSTOM_GATES 50
160 * According to specification 102 622 chapter 4.4 Pipes,
161 * the pipe identifier is 7 bits long.
163 #define NCI_HCI_MAX_PIPES 127
165 struct nci_hci_gate {
171 struct nci_hci_pipe {
176 struct nci_hci_init_data {
178 struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
182 #define NCI_HCI_MAX_GATES 256
186 struct nci_dev *ndev;
187 struct nci_conn_info *conn_info;
189 struct nci_hci_init_data init_data;
190 struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
191 u8 gate2pipe[NCI_HCI_MAX_GATES];
195 struct sk_buff_head rx_hcp_frags;
196 struct work_struct msg_rx_work;
197 struct sk_buff_head msg_rx_queue;
200 /* NCI Core structures */
202 struct nfc_dev *nfc_dev;
204 struct nci_hci_dev *hci_dev;
215 struct list_head conn_info_list;
216 struct nci_conn_info *rf_conn_info;
218 struct timer_list cmd_timer;
219 struct timer_list data_timer;
221 struct workqueue_struct *cmd_wq;
222 struct work_struct cmd_work;
224 struct workqueue_struct *rx_wq;
225 struct work_struct rx_work;
227 struct workqueue_struct *tx_wq;
228 struct work_struct tx_work;
230 struct sk_buff_head cmd_q;
231 struct sk_buff_head rx_q;
232 struct sk_buff_head tx_q;
234 struct mutex req_lock;
235 struct completion req_completion;
242 __u32 target_active_prot;
244 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS];
247 /* received during NCI_OP_CORE_RESET_RSP */
250 /* received during NCI_OP_CORE_INIT_RSP */
252 __u8 num_supported_rf_interfaces;
253 __u8 supported_rf_interfaces
254 [NCI_MAX_SUPPORTED_RF_INTERFACES];
255 __u8 max_logical_connections;
256 __u16 max_routing_table_size;
257 __u8 max_ctrl_pkt_payload_len;
258 __u16 max_size_for_large_params;
260 __u32 manufact_specific_info;
262 /* Save RF Discovery ID or NFCEE ID under conn_create */
265 /* stored during nci_data_exchange */
266 struct sk_buff *rx_data_reassembly;
268 /* stored during intf_activated_ntf */
269 __u8 remote_gb[NFC_MAX_GT_LEN];
273 /* ----- NCI Devices ----- */
274 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
275 __u32 supported_protocols,
278 void nci_free_device(struct nci_dev *ndev);
279 int nci_register_device(struct nci_dev *ndev);
280 void nci_unregister_device(struct nci_dev *ndev);
281 int nci_request(struct nci_dev *ndev,
282 void (*req)(struct nci_dev *ndev,
284 unsigned long opt, __u32 timeout);
285 int nci_prop_cmd(struct nci_dev *ndev, __u8 oid, size_t len, __u8 *payload);
286 int nci_core_cmd(struct nci_dev *ndev, __u16 opcode, size_t len, __u8 *payload);
287 int nci_core_reset(struct nci_dev *ndev);
288 int nci_core_init(struct nci_dev *ndev);
290 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
291 int nci_send_frame(struct nci_dev *ndev, struct sk_buff *skb);
292 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
294 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
295 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
296 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
297 u8 number_destination_params,
299 struct core_conn_create_dest_spec_params *params);
300 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
302 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
303 void nci_hci_deallocate(struct nci_dev *ndev);
304 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
305 const u8 *param, size_t param_len);
306 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
307 u8 cmd, const u8 *param, size_t param_len,
308 struct sk_buff **skb);
309 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
310 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
311 u8 dest_gate, u8 pipe);
312 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
313 const u8 *param, size_t param_len);
314 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
315 struct sk_buff **skb);
316 int nci_hci_clear_all_pipes(struct nci_dev *ndev);
317 int nci_hci_dev_session_init(struct nci_dev *ndev);
319 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
325 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
327 skb_reserve(skb, ndev->tx_headroom);
332 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
334 nfc_set_parent_dev(ndev->nfc_dev, dev);
337 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
339 ndev->driver_data = data;
342 static inline void *nci_get_drvdata(struct nci_dev *ndev)
344 return ndev->driver_data;
347 static inline int nci_set_vendor_cmds(struct nci_dev *ndev,
348 struct nfc_vendor_cmd *cmds,
351 return nfc_set_vendor_cmds(ndev->nfc_dev, cmds, n_cmds);
354 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
355 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
356 int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode,
357 struct sk_buff *skb);
358 int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode,
359 struct sk_buff *skb);
360 int nci_core_rsp_packet(struct nci_dev *ndev, __u16 opcode,
361 struct sk_buff *skb);
362 int nci_core_ntf_packet(struct nci_dev *ndev, __u16 opcode,
363 struct sk_buff *skb);
364 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
365 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
366 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
367 int nci_conn_max_data_pkt_payload_size(struct nci_dev *ndev, __u8 conn_id);
368 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
369 __u8 conn_id, int err);
370 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
372 void nci_clear_target_list(struct nci_dev *ndev);
374 /* ----- NCI requests ----- */
375 #define NCI_REQ_DONE 0
376 #define NCI_REQ_PEND 1
377 #define NCI_REQ_CANCELED 2
379 void nci_req_complete(struct nci_dev *ndev, int result);
380 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
382 int nci_get_conn_info_by_id(struct nci_dev *ndev, u8 id);
384 /* ----- NCI status code ----- */
385 int nci_to_errno(__u8 code);
387 /* ----- NCI over SPI acknowledge modes ----- */
388 #define NCI_SPI_CRC_DISABLED 0x00
389 #define NCI_SPI_CRC_ENABLED 0x01
391 /* ----- NCI SPI structures ----- */
393 struct nci_dev *ndev;
394 struct spi_device *spi;
396 unsigned int xfer_udelay; /* microseconds delay between
399 unsigned int xfer_speed_hz; /*
400 * SPI clock frequency
406 struct completion req_completion;
410 /* ----- NCI SPI ----- */
411 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
412 u8 acknowledge_mode, unsigned int delay,
413 struct nci_dev *ndev);
414 int nci_spi_send(struct nci_spi *nspi,
415 struct completion *write_handshake_completion,
416 struct sk_buff *skb);
417 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
419 /* ----- NCI UART ---- */
422 #define NCIUARTSETDRIVER _IOW('U', 0, char *)
424 enum nci_uart_driver {
425 NCI_UART_DRIVER_MARVELL = 0,
431 struct nci_uart_ops {
432 int (*open)(struct nci_uart *nci_uart);
433 void (*close)(struct nci_uart *nci_uart);
434 int (*recv)(struct nci_uart *nci_uart, struct sk_buff *skb);
435 int (*recv_buf)(struct nci_uart *nci_uart, const u8 *data, char *flags,
437 int (*send)(struct nci_uart *nci_uart, struct sk_buff *skb);
438 void (*tx_start)(struct nci_uart *nci_uart);
439 void (*tx_done)(struct nci_uart *nci_uart);
443 struct module *owner;
444 struct nci_uart_ops ops;
446 enum nci_uart_driver driver;
449 struct nci_dev *ndev;
451 struct work_struct write_work;
452 struct tty_struct *tty;
453 unsigned long tx_state;
454 struct sk_buff_head tx_q;
455 struct sk_buff *tx_skb;
456 struct sk_buff *rx_skb;
461 int nci_uart_register(struct nci_uart *nu);
462 void nci_uart_unregister(struct nci_uart *nu);
463 void nci_uart_set_config(struct nci_uart *nu, int baudrate, int flow_ctrl);
465 #endif /* __NCI_CORE_H */