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.
8 * Written by Ilan Elias <ilane@ti.com>
11 * This file is based on hci_core.h, which was written
12 * by Maxim Krasnyansky.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2
16 * as published by the Free Software Foundation
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, see <http://www.gnu.org/licenses/>.
31 #include <linux/interrupt.h>
32 #include <linux/skbuff.h>
34 #include <net/nfc/nfc.h>
35 #include <net/nfc/nci.h>
37 /* NCI device flags */
45 /* NCI device states */
49 NCI_W4_ALL_DISCOVERIES,
55 #define NCI_RESET_TIMEOUT 5000
56 #define NCI_INIT_TIMEOUT 5000
57 #define NCI_SET_CONFIG_TIMEOUT 5000
58 #define NCI_RF_DISC_TIMEOUT 5000
59 #define NCI_RF_DISC_SELECT_TIMEOUT 5000
60 #define NCI_RF_DEACTIVATE_TIMEOUT 30000
61 #define NCI_CMD_TIMEOUT 5000
62 #define NCI_DATA_TIMEOUT 700
67 int (*open)(struct nci_dev *ndev);
68 int (*close)(struct nci_dev *ndev);
69 int (*send)(struct nci_dev *ndev, struct sk_buff *skb);
70 int (*setup)(struct nci_dev *ndev);
71 __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
74 #define NCI_MAX_SUPPORTED_RF_INTERFACES 4
75 #define NCI_MAX_DISCOVERED_TARGETS 10
77 /* NCI Core structures */
79 struct nfc_dev *nfc_dev;
91 struct timer_list cmd_timer;
92 struct timer_list data_timer;
94 struct workqueue_struct *cmd_wq;
95 struct work_struct cmd_work;
97 struct workqueue_struct *rx_wq;
98 struct work_struct rx_work;
100 struct workqueue_struct *tx_wq;
101 struct work_struct tx_work;
103 struct sk_buff_head cmd_q;
104 struct sk_buff_head rx_q;
105 struct sk_buff_head tx_q;
107 struct mutex req_lock;
108 struct completion req_completion;
115 __u32 target_active_prot;
117 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS];
120 /* received during NCI_OP_CORE_RESET_RSP */
123 /* received during NCI_OP_CORE_INIT_RSP */
125 __u8 num_supported_rf_interfaces;
126 __u8 supported_rf_interfaces
127 [NCI_MAX_SUPPORTED_RF_INTERFACES];
128 __u8 max_logical_connections;
129 __u16 max_routing_table_size;
130 __u8 max_ctrl_pkt_payload_len;
131 __u16 max_size_for_large_params;
133 __u32 manufact_specific_info;
135 /* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
136 __u8 max_data_pkt_payload_size;
137 __u8 initial_num_credits;
139 /* stored during nci_data_exchange */
140 data_exchange_cb_t data_exchange_cb;
141 void *data_exchange_cb_context;
142 struct sk_buff *rx_data_reassembly;
144 /* stored during intf_activated_ntf */
145 __u8 remote_gb[NFC_MAX_GT_LEN];
149 /* ----- NCI Devices ----- */
150 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
151 __u32 supported_protocols,
154 void nci_free_device(struct nci_dev *ndev);
155 int nci_register_device(struct nci_dev *ndev);
156 void nci_unregister_device(struct nci_dev *ndev);
157 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
158 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
160 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
166 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
168 skb_reserve(skb, ndev->tx_headroom);
173 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
175 nfc_set_parent_dev(ndev->nfc_dev, dev);
178 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
180 ndev->driver_data = data;
183 static inline void *nci_get_drvdata(struct nci_dev *ndev)
185 return ndev->driver_data;
188 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
189 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
190 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
191 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
192 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
193 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
195 void nci_clear_target_list(struct nci_dev *ndev);
197 /* ----- NCI requests ----- */
198 #define NCI_REQ_DONE 0
199 #define NCI_REQ_PEND 1
200 #define NCI_REQ_CANCELED 2
202 void nci_req_complete(struct nci_dev *ndev, int result);
204 /* ----- NCI status code ----- */
205 int nci_to_errno(__u8 code);
207 /* ----- NCI over SPI acknowledge modes ----- */
208 #define NCI_SPI_CRC_DISABLED 0x00
209 #define NCI_SPI_CRC_ENABLED 0x01
211 /* ----- NCI SPI structures ----- */
213 struct nci_dev *ndev;
214 struct spi_device *spi;
216 unsigned int xfer_udelay; /* microseconds delay between
220 struct completion req_completion;
224 /* ----- NCI SPI ----- */
225 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
226 u8 acknowledge_mode, unsigned int delay,
227 struct nci_dev *ndev);
228 int nci_spi_send(struct nci_spi *nspi,
229 struct completion *write_handshake_completion,
230 struct sk_buff *skb);
231 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
233 #endif /* __NCI_CORE_H */