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 */
48 /* NCI device states */
52 NCI_W4_ALL_DISCOVERIES,
60 #define NCI_RESET_TIMEOUT 5000
61 #define NCI_INIT_TIMEOUT 5000
62 #define NCI_SET_CONFIG_TIMEOUT 5000
63 #define NCI_RF_DISC_TIMEOUT 5000
64 #define NCI_RF_DISC_SELECT_TIMEOUT 5000
65 #define NCI_RF_DEACTIVATE_TIMEOUT 30000
66 #define NCI_CMD_TIMEOUT 5000
67 #define NCI_DATA_TIMEOUT 700
71 struct nci_driver_ops {
73 int (*rsp)(struct nci_dev *dev, struct sk_buff *skb);
74 int (*ntf)(struct nci_dev *dev, struct sk_buff *skb);
78 int (*init)(struct nci_dev *ndev);
79 int (*open)(struct nci_dev *ndev);
80 int (*close)(struct nci_dev *ndev);
81 int (*send)(struct nci_dev *ndev, struct sk_buff *skb);
82 int (*setup)(struct nci_dev *ndev);
83 int (*post_setup)(struct nci_dev *ndev);
84 int (*fw_download)(struct nci_dev *ndev, const char *firmware_name);
85 __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
86 int (*discover_se)(struct nci_dev *ndev);
87 int (*disable_se)(struct nci_dev *ndev, u32 se_idx);
88 int (*enable_se)(struct nci_dev *ndev, u32 se_idx);
89 int (*se_io)(struct nci_dev *ndev, u32 se_idx,
90 u8 *apdu, size_t apdu_length,
91 se_io_cb_t cb, void *cb_context);
92 int (*hci_load_session)(struct nci_dev *ndev);
93 void (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event,
95 void (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd,
98 struct nci_driver_ops *prop_ops;
101 struct nci_driver_ops *core_ops;
105 #define NCI_MAX_SUPPORTED_RF_INTERFACES 4
106 #define NCI_MAX_DISCOVERED_TARGETS 10
107 #define NCI_MAX_NUM_NFCEE 255
108 #define NCI_MAX_CONN_ID 7
109 #define NCI_MAX_PROPRIETARY_CMD 64
111 struct nci_conn_info {
112 struct list_head list;
113 /* NCI specification 4.4.2 Connection Creation
114 * The combination of destination type and destination specific
115 * parameters shall uniquely identify a single destination for the
118 struct dest_spec_params *dest_params;
121 __u8 max_pkt_payload_len;
123 atomic_t credits_cnt;
124 __u8 initial_num_credits;
126 data_exchange_cb_t data_exchange_cb;
127 void *data_exchange_cb_context;
129 struct sk_buff *rx_skb;
132 #define NCI_INVALID_CONN_ID 0x80
134 #define NCI_HCI_ANY_OPEN_PIPE 0x03
137 #define NCI_HCI_ADMIN_GATE 0x00
138 #define NCI_HCI_LOOPBACK_GATE 0x04
139 #define NCI_HCI_IDENTITY_MGMT_GATE 0x05
140 #define NCI_HCI_LINK_MGMT_GATE 0x06
143 #define NCI_HCI_LINK_MGMT_PIPE 0x00
144 #define NCI_HCI_ADMIN_PIPE 0x01
146 /* Generic responses */
147 #define NCI_HCI_ANY_OK 0x00
148 #define NCI_HCI_ANY_E_NOT_CONNECTED 0x01
149 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN 0x02
150 #define NCI_HCI_ANY_E_NOK 0x03
151 #define NCI_HCI_ANY_E_PIPES_FULL 0x04
152 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN 0x05
153 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED 0x06
154 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED 0x07
155 #define NCI_HCI_ANY_E_INHIBITED 0x08
156 #define NCI_HCI_ANY_E_TIMEOUT 0x09
157 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED 0x0a
158 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED 0x0b
160 #define NCI_HCI_DO_NOT_OPEN_PIPE 0x81
161 #define NCI_HCI_INVALID_PIPE 0x80
162 #define NCI_HCI_INVALID_GATE 0xFF
163 #define NCI_HCI_INVALID_HOST 0x80
165 #define NCI_HCI_MAX_CUSTOM_GATES 50
167 * According to specification 102 622 chapter 4.4 Pipes,
168 * the pipe identifier is 7 bits long.
170 #define NCI_HCI_MAX_PIPES 127
172 struct nci_hci_gate {
178 struct nci_hci_pipe {
183 struct nci_hci_init_data {
185 struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
189 #define NCI_HCI_MAX_GATES 256
193 struct nci_dev *ndev;
194 struct nci_conn_info *conn_info;
196 struct nci_hci_init_data init_data;
197 struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
198 u8 gate2pipe[NCI_HCI_MAX_GATES];
202 struct sk_buff_head rx_hcp_frags;
203 struct work_struct msg_rx_work;
204 struct sk_buff_head msg_rx_queue;
207 /* NCI Core structures */
209 struct nfc_dev *nfc_dev;
211 struct nci_hci_dev *hci_dev;
222 struct list_head conn_info_list;
223 struct nci_conn_info *rf_conn_info;
225 struct timer_list cmd_timer;
226 struct timer_list data_timer;
228 struct workqueue_struct *cmd_wq;
229 struct work_struct cmd_work;
231 struct workqueue_struct *rx_wq;
232 struct work_struct rx_work;
234 struct workqueue_struct *tx_wq;
235 struct work_struct tx_work;
237 struct sk_buff_head cmd_q;
238 struct sk_buff_head rx_q;
239 struct sk_buff_head tx_q;
241 struct mutex req_lock;
242 struct completion req_completion;
249 __u32 target_active_prot;
251 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS];
254 /* received during NCI_OP_CORE_RESET_RSP */
257 /* received during NCI_OP_CORE_INIT_RSP */
259 __u8 num_supported_rf_interfaces;
260 __u8 supported_rf_interfaces
261 [NCI_MAX_SUPPORTED_RF_INTERFACES];
262 __u8 max_logical_connections;
263 __u16 max_routing_table_size;
264 __u8 max_ctrl_pkt_payload_len;
265 __u16 max_size_for_large_params;
267 __u32 manufact_specific_info;
269 /* Save RF Discovery ID or NFCEE ID under conn_create */
270 struct dest_spec_params cur_params;
271 /* Save destination type under conn_create */
274 /* stored during nci_data_exchange */
275 struct sk_buff *rx_data_reassembly;
277 /* stored during intf_activated_ntf */
278 __u8 remote_gb[NFC_MAX_GT_LEN];
282 /* ----- NCI Devices ----- */
283 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
284 __u32 supported_protocols,
287 void nci_free_device(struct nci_dev *ndev);
288 int nci_register_device(struct nci_dev *ndev);
289 void nci_unregister_device(struct nci_dev *ndev);
290 int nci_request(struct nci_dev *ndev,
291 void (*req)(struct nci_dev *ndev,
293 unsigned long opt, __u32 timeout);
294 int nci_prop_cmd(struct nci_dev *ndev, __u8 oid, size_t len, __u8 *payload);
295 int nci_core_cmd(struct nci_dev *ndev, __u16 opcode, size_t len, __u8 *payload);
296 int nci_core_reset(struct nci_dev *ndev);
297 int nci_core_init(struct nci_dev *ndev);
299 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
300 int nci_send_frame(struct nci_dev *ndev, struct sk_buff *skb);
301 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
303 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
304 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
305 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
306 u8 number_destination_params,
308 struct core_conn_create_dest_spec_params *params);
309 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
310 int nci_nfcc_loopback(struct nci_dev *ndev, void *data, size_t data_len,
311 struct sk_buff **resp);
313 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
314 void nci_hci_deallocate(struct nci_dev *ndev);
315 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
316 const u8 *param, size_t param_len);
317 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
318 u8 cmd, const u8 *param, size_t param_len,
319 struct sk_buff **skb);
320 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
321 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
322 u8 dest_gate, u8 pipe);
323 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
324 const u8 *param, size_t param_len);
325 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
326 struct sk_buff **skb);
327 int nci_hci_clear_all_pipes(struct nci_dev *ndev);
328 int nci_hci_dev_session_init(struct nci_dev *ndev);
330 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
336 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
338 skb_reserve(skb, ndev->tx_headroom);
343 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
345 nfc_set_parent_dev(ndev->nfc_dev, dev);
348 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
350 ndev->driver_data = data;
353 static inline void *nci_get_drvdata(struct nci_dev *ndev)
355 return ndev->driver_data;
358 static inline int nci_set_vendor_cmds(struct nci_dev *ndev,
359 struct nfc_vendor_cmd *cmds,
362 return nfc_set_vendor_cmds(ndev->nfc_dev, cmds, n_cmds);
365 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
366 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
367 int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode,
368 struct sk_buff *skb);
369 int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode,
370 struct sk_buff *skb);
371 int nci_core_rsp_packet(struct nci_dev *ndev, __u16 opcode,
372 struct sk_buff *skb);
373 int nci_core_ntf_packet(struct nci_dev *ndev, __u16 opcode,
374 struct sk_buff *skb);
375 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
376 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
377 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
378 int nci_conn_max_data_pkt_payload_size(struct nci_dev *ndev, __u8 conn_id);
379 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
380 __u8 conn_id, int err);
381 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
383 void nci_clear_target_list(struct nci_dev *ndev);
385 /* ----- NCI requests ----- */
386 #define NCI_REQ_DONE 0
387 #define NCI_REQ_PEND 1
388 #define NCI_REQ_CANCELED 2
390 void nci_req_complete(struct nci_dev *ndev, int result);
391 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
393 int nci_get_conn_info_by_dest_type_params(struct nci_dev *ndev, u8 dest_type,
394 struct dest_spec_params *params);
396 /* ----- NCI status code ----- */
397 int nci_to_errno(__u8 code);
399 /* ----- NCI over SPI acknowledge modes ----- */
400 #define NCI_SPI_CRC_DISABLED 0x00
401 #define NCI_SPI_CRC_ENABLED 0x01
403 /* ----- NCI SPI structures ----- */
405 struct nci_dev *ndev;
406 struct spi_device *spi;
408 unsigned int xfer_udelay; /* microseconds delay between
411 unsigned int xfer_speed_hz; /*
412 * SPI clock frequency
418 struct completion req_completion;
422 /* ----- NCI SPI ----- */
423 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
424 u8 acknowledge_mode, unsigned int delay,
425 struct nci_dev *ndev);
426 int nci_spi_send(struct nci_spi *nspi,
427 struct completion *write_handshake_completion,
428 struct sk_buff *skb);
429 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
431 /* ----- NCI UART ---- */
434 #define NCIUARTSETDRIVER _IOW('U', 0, char *)
436 enum nci_uart_driver {
437 NCI_UART_DRIVER_MARVELL = 0,
443 struct nci_uart_ops {
444 int (*open)(struct nci_uart *nci_uart);
445 void (*close)(struct nci_uart *nci_uart);
446 int (*recv)(struct nci_uart *nci_uart, struct sk_buff *skb);
447 int (*recv_buf)(struct nci_uart *nci_uart, const u8 *data, char *flags,
449 int (*send)(struct nci_uart *nci_uart, struct sk_buff *skb);
450 void (*tx_start)(struct nci_uart *nci_uart);
451 void (*tx_done)(struct nci_uart *nci_uart);
455 struct module *owner;
456 struct nci_uart_ops ops;
458 enum nci_uart_driver driver;
461 struct nci_dev *ndev;
463 struct work_struct write_work;
464 struct tty_struct *tty;
465 unsigned long tx_state;
466 struct sk_buff_head tx_q;
467 struct sk_buff *tx_skb;
468 struct sk_buff *rx_skb;
473 int nci_uart_register(struct nci_uart *nu);
474 void nci_uart_unregister(struct nci_uart *nu);
475 void nci_uart_set_config(struct nci_uart *nu, int baudrate, int flow_ctrl);
477 #endif /* __NCI_CORE_H */