projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
NFC: nci: Allow the driver to set handler for core nci ops
[deliverable/linux.git] / include / net / nfc / nci_core.h
CommitLineData
6a2968aa
IE		 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.
8a00a61b 6 * Copyright (C) 2013 Intel Corporation. All rights reserved.
a99903ec 7 * Copyright (C) 2014 Marvell International Ltd.
6a2968aa
IE		 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
a6227e26 25 * along with this program; if not, see <http://www.gnu.org/licenses/>.
6a2968aa
IE		 26 *
27 */
28
29#ifndef __NCI_CORE_H
30#define __NCI_CORE_H
31
32#include <linux/interrupt.h>
33#include <linux/skbuff.h>
9961127d 34#include <linux/tty.h>
6a2968aa
IE		 35
36#include <net/nfc/nfc.h>
37#include <net/nfc/nci.h>
38
8939e47f
IE		 39/* NCI device flags */
40enum nci_flag {
6a2968aa
IE		 41 NCI_INIT,
42 NCI_UP,
38f04c6b 43 NCI_DATA_EXCHANGE,
c4bf98b2 44 NCI_DATA_EXCHANGE_TO,
6a2968aa
IE		 45};
46
8939e47f
IE		 47/* NCI device states */
48enum nci_state {
49 NCI_IDLE,
50 NCI_DISCOVERY,
019c4fba
IE		 51 NCI_W4_ALL_DISCOVERIES,
52 NCI_W4_HOST_SELECT,
8939e47f 53 NCI_POLL_ACTIVE,
a99903ec
JL		 54 NCI_LISTEN_ACTIVE,
55 NCI_LISTEN_SLEEP,
8939e47f
IE		 56};
57
6a2968aa
IE		 58/* NCI timeouts */
59#define NCI_RESET_TIMEOUT 5000
60#define NCI_INIT_TIMEOUT 5000
7e035230 61#define NCI_SET_CONFIG_TIMEOUT 5000
6a2968aa 62#define NCI_RF_DISC_TIMEOUT 5000
019c4fba 63#define NCI_RF_DISC_SELECT_TIMEOUT 5000
11ee5158 64#define NCI_RF_DEACTIVATE_TIMEOUT 30000
6a2968aa 65#define NCI_CMD_TIMEOUT 5000
c4bf98b2 66#define NCI_DATA_TIMEOUT 700
6a2968aa
IE		 67
68struct nci_dev;
69
b6355e97
SO		 70struct 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
6a2968aa 76struct nci_ops {
c39daeee 77 int (*init)(struct nci_dev *ndev);
9e87f9a9
CR		 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);
fdf79bd4 82 int (*post_setup)(struct nci_dev *ndev);
25af01ed 83 int (*fw_download)(struct nci_dev *ndev, const char *firmware_name);
9e87f9a9 84 __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
ba4db551 85 int (*discover_se)(struct nci_dev *ndev);
e9ef9431 86 int (*disable_se)(struct nci_dev *ndev, u32 se_idx);
93bca2bf 87 int (*enable_se)(struct nci_dev *ndev, u32 se_idx);
a688bf55
CR		 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);
11f54f22
CR		 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);
b6355e97
SO		 96
97 struct nci_prop_ops *prop_ops;
98 size_t n_prop_ops;
0a97a3cb
RD		 99
100 struct nci_prop_ops *core_ops;
101 size_t n_core_ops;
6a2968aa
IE		 102};
103
104#define NCI_MAX_SUPPORTED_RF_INTERFACES 4
019c4fba 105#define NCI_MAX_DISCOVERED_TARGETS 10
4aeee687
CR		 106#define NCI_MAX_NUM_NFCEE 255
107#define NCI_MAX_CONN_ID 7
b6355e97 108#define NCI_MAX_PROPRIETARY_CMD 64
4aeee687
CR		 109
110struct nci_conn_info {
111 struct list_head list;
112 __u8 id; /* can be an RF Discovery ID or an NFCEE ID */
113 __u8 conn_id;
114 __u8 max_pkt_payload_len;
115
116 atomic_t credits_cnt;
117 __u8 initial_num_credits;
118
119 data_exchange_cb_t data_exchange_cb;
120 void *data_exchange_cb_context;
121
122 struct sk_buff *rx_skb;
123};
6a2968aa 124
af9c8aa6
CR		 125#define NCI_INVALID_CONN_ID 0x80
126
11f54f22
CR		 127#define NCI_HCI_ANY_OPEN_PIPE 0x03
128
129/* Gates */
130#define NCI_HCI_ADMIN_GATE 0x00
131#define NCI_HCI_LINK_MGMT_GATE 0x06
132
133/* Pipes */
134#define NCI_HCI_LINK_MGMT_PIPE 0x00
135#define NCI_HCI_ADMIN_PIPE 0x01
136
137/* Generic responses */
138#define NCI_HCI_ANY_OK 0x00
139#define NCI_HCI_ANY_E_NOT_CONNECTED 0x01
140#define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN 0x02
141#define NCI_HCI_ANY_E_NOK 0x03
142#define NCI_HCI_ANY_E_PIPES_FULL 0x04
143#define NCI_HCI_ANY_E_REG_PAR_UNKNOWN 0x05
144#define NCI_HCI_ANY_E_PIPE_NOT_OPENED 0x06
145#define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED 0x07
146#define NCI_HCI_ANY_E_INHIBITED 0x08
147#define NCI_HCI_ANY_E_TIMEOUT 0x09
148#define NCI_HCI_ANY_E_REG_ACCESS_DENIED 0x0a
149#define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED 0x0b
150
151#define NCI_HCI_DO_NOT_OPEN_PIPE 0x81
152#define NCI_HCI_INVALID_PIPE 0x80
153#define NCI_HCI_INVALID_GATE 0xFF
154#define NCI_HCI_INVALID_HOST 0x80
155
156#define NCI_HCI_MAX_CUSTOM_GATES 50
1f74f323
CR		 157/*
158 * According to specification 102 622 chapter 4.4 Pipes,
159 * the pipe identifier is 7 bits long.
160 */
11f54f22
CR		 161#define NCI_HCI_MAX_PIPES 127
162
163struct nci_hci_gate {
164 u8 gate;
165 u8 pipe;
166 u8 dest_host;
167} __packed;
168
169struct nci_hci_pipe {
170 u8 gate;
171 u8 host;
172} __packed;
173
174struct nci_hci_init_data {
175 u8 gate_count;
176 struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
177 char session_id[9];
178};
179
180#define NCI_HCI_MAX_GATES 256
181
182struct nci_hci_dev {
15d4a8da 183 u8 nfcee_id;
11f54f22
CR		 184 struct nci_dev *ndev;
185 struct nci_conn_info *conn_info;
186
187 struct nci_hci_init_data init_data;
188 struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
189 u8 gate2pipe[NCI_HCI_MAX_GATES];
190 int expected_pipes;
191 int count_pipes;
192
193 struct sk_buff_head rx_hcp_frags;
194 struct work_struct msg_rx_work;
195 struct sk_buff_head msg_rx_queue;
196};
197
6a2968aa
IE		 198/* NCI Core structures */
199struct nci_dev {
200 struct nfc_dev *nfc_dev;
201 struct nci_ops *ops;
11f54f22 202 struct nci_hci_dev *hci_dev;
6a2968aa
IE		 203
204 int tx_headroom;
205 int tx_tailroom;
206
8939e47f 207 atomic_t state;
6a2968aa
IE		 208 unsigned long flags;
209
210 atomic_t cmd_cnt;
4aeee687
CR		 211 __u8 cur_conn_id;
212
213 struct list_head conn_info_list;
12bdf27d 214 struct nci_conn_info *rf_conn_info;
6a2968aa
IE		 215
216 struct timer_list cmd_timer;
c4bf98b2 217 struct timer_list data_timer;
6a2968aa
IE		 218
219 struct workqueue_struct *cmd_wq;
220 struct work_struct cmd_work;
221
222 struct workqueue_struct *rx_wq;
223 struct work_struct rx_work;
224
225 struct workqueue_struct *tx_wq;
226 struct work_struct tx_work;
227
228 struct sk_buff_head cmd_q;
229 struct sk_buff_head rx_q;
230 struct sk_buff_head tx_q;
231
232 struct mutex req_lock;
233 struct completion req_completion;
234 __u32 req_status;
235 __u32 req_result;
236
237 void *driver_data;
238
239 __u32 poll_prots;
6a2968aa
IE		 240 __u32 target_active_prot;
241
019c4fba
IE		 242 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS];
243 int n_targets;
244
6a2968aa
IE		 245 /* received during NCI_OP_CORE_RESET_RSP */
246 __u8 nci_ver;
247
248 /* received during NCI_OP_CORE_INIT_RSP */
249 __u32 nfcc_features;
250 __u8 num_supported_rf_interfaces;
251 __u8 supported_rf_interfaces
252 [NCI_MAX_SUPPORTED_RF_INTERFACES];
253 __u8 max_logical_connections;
254 __u16 max_routing_table_size;
e8c0dacd
IE		 255 __u8 max_ctrl_pkt_payload_len;
256 __u16 max_size_for_large_params;
e8c0dacd
IE		 257 __u8 manufact_id;
258 __u32 manufact_specific_info;
6a2968aa 259
4aeee687
CR		 260 /* Save RF Discovery ID or NFCEE ID under conn_create */
261 __u8 cur_id;
637d85a7 262
6a2968aa 263 /* stored during nci_data_exchange */
6a2968aa 264 struct sk_buff *rx_data_reassembly;
767f19ae
IE		 265
266 /* stored during intf_activated_ntf */
267 __u8 remote_gb[NFC_MAX_GT_LEN];
268 __u8 remote_gb_len;
6a2968aa
IE		 269};
270
271/* ----- NCI Devices ----- */
272struct nci_dev *nci_allocate_device(struct nci_ops *ops,
eb9bc6e9
SO		 273 __u32 supported_protocols,
274 int tx_headroom,
275 int tx_tailroom);
6a2968aa
IE		 276void nci_free_device(struct nci_dev *ndev);
277int nci_register_device(struct nci_dev *ndev);
278void nci_unregister_device(struct nci_dev *ndev);
11f54f22
CR		 279int nci_request(struct nci_dev *ndev,
280 void (*req)(struct nci_dev *ndev,
281 unsigned long opt),
282 unsigned long opt, __u32 timeout);
759afb8d 283int nci_prop_cmd(struct nci_dev *ndev, __u8 oid, size_t len, __u8 *payload);
7bc4824e 284int nci_core_cmd(struct nci_dev *ndev, __u16 opcode, size_t len, __u8 *payload);
025a0cb8
RB		 285int nci_core_reset(struct nci_dev *ndev);
286int nci_core_init(struct nci_dev *ndev);
759afb8d 287
1095e69f 288int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
22c15bf3 289int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
6a2968aa 290
af9c8aa6 291int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
f7f793f3 292int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
b16ae716
CR		 293int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
294 u8 number_destination_params,
295 size_t params_len,
736bb957
CR		 296 struct core_conn_create_dest_spec_params *params);
297int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
af9c8aa6 298
11f54f22
CR		 299struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
300int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
301 const u8 *param, size_t param_len);
302int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
303 u8 cmd, const u8 *param, size_t param_len,
304 struct sk_buff **skb);
305int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
306int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
307 u8 dest_gate, u8 pipe);
308int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
309 const u8 *param, size_t param_len);
310int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
311 struct sk_buff **skb);
312int nci_hci_dev_session_init(struct nci_dev *ndev);
313
6a2968aa 314static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
eb9bc6e9
SO		 315 unsigned int len,
316 gfp_t how)
6a2968aa
IE		 317{
318 struct sk_buff *skb;
319
320 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
321 if (skb)
322 skb_reserve(skb, ndev->tx_headroom);
323
324 return skb;
325}
326
327static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
328{
329 nfc_set_parent_dev(ndev->nfc_dev, dev);
330}
331
332static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
333{
334 ndev->driver_data = data;
335}
336
337static inline void *nci_get_drvdata(struct nci_dev *ndev)
338{
339 return ndev->driver_data;
340}
341
8115dd59
SO		 342static inline int nci_set_vendor_cmds(struct nci_dev *ndev,
343 struct nfc_vendor_cmd *cmds,
344 int n_cmds)
345{
346 return nfc_set_vendor_cmds(ndev->nfc_dev, cmds, n_cmds);
347}
348
6a2968aa
IE		 349void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
350void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
0a97a3cb
RD		 351inline int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode,
352 struct sk_buff *skb);
353inline int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode,
354 struct sk_buff *skb);
355inline int nci_core_rsp_packet(struct nci_dev *ndev, __u16 opcode,
b6355e97 356 struct sk_buff *skb);
0a97a3cb 357inline int nci_core_ntf_packet(struct nci_dev *ndev, __u16 opcode,
b6355e97 358 struct sk_buff *skb);
6a2968aa
IE		 359void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
360int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
361int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
2663589c 362int nci_conn_max_data_pkt_payload_size(struct nci_dev *ndev, __u8 conn_id);
6a2968aa 363void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
4aeee687 364 __u8 conn_id, int err);
11f54f22
CR		 365void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
366
019c4fba 367void nci_clear_target_list(struct nci_dev *ndev);
6a2968aa
IE		 368
369/* ----- NCI requests ----- */
370#define NCI_REQ_DONE 0
371#define NCI_REQ_PEND 1
372#define NCI_REQ_CANCELED 2
373
374void nci_req_complete(struct nci_dev *ndev, int result);
4aeee687
CR		 375struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
376 int conn_id);
6a2968aa
IE		 377
378/* ----- NCI status code ----- */
379int nci_to_errno(__u8 code);
380
8a00a61b
FD		 381/* ----- NCI over SPI acknowledge modes ----- */
382#define NCI_SPI_CRC_DISABLED 0x00
383#define NCI_SPI_CRC_ENABLED 0x01
384
385/* ----- NCI SPI structures ----- */
fa544fff 386struct nci_spi {
d5937511 387 struct nci_dev *ndev;
8a00a61b 388 struct spi_device *spi;
8a00a61b
FD		 389
390 unsigned int xfer_udelay; /* microseconds delay between
391 transactions */
392 u8 acknowledge_mode;
393
ee9596d4
FD		 394 struct completion req_completion;
395 u8 req_result;
8a00a61b
FD		 396};
397
fa544fff
EL		 398/* ----- NCI SPI ----- */
399struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
fa544fff
EL		 400 u8 acknowledge_mode, unsigned int delay,
401 struct nci_dev *ndev);
2bed2785
EL		 402int nci_spi_send(struct nci_spi *nspi,
403 struct completion *write_handshake_completion,
404 struct sk_buff *skb);
22d4aae5 405struct sk_buff *nci_spi_read(struct nci_spi *nspi);
8a00a61b 406
9961127d
VC		 407/* ----- NCI UART ---- */
408
409/* Ioctl */
410#define NCIUARTSETDRIVER _IOW('U', 0, char *)
411
412enum nci_uart_driver {
413 NCI_UART_DRIVER_MARVELL = 0,
414 NCI_UART_DRIVER_MAX
415};
416
417struct nci_uart;
418
419struct nci_uart_ops {
420 int (*open)(struct nci_uart *nci_uart);
421 void (*close)(struct nci_uart *nci_uart);
422 int (*recv)(struct nci_uart *nci_uart, struct sk_buff *skb);
423 int (*recv_buf)(struct nci_uart *nci_uart, const u8 *data, char *flags,
424 int count);
425 int (*send)(struct nci_uart *nci_uart, struct sk_buff *skb);
426 void (*tx_start)(struct nci_uart *nci_uart);
427 void (*tx_done)(struct nci_uart *nci_uart);
428};
429
430struct nci_uart {
431 struct module *owner;
432 struct nci_uart_ops ops;
433 const char *name;
434 enum nci_uart_driver driver;
435
436 /* Dynamic data */
437 struct nci_dev *ndev;
438 spinlock_t rx_lock;
439 struct work_struct write_work;
440 struct tty_struct *tty;
441 unsigned long tx_state;
442 struct sk_buff_head tx_q;
443 struct sk_buff *tx_skb;
444 struct sk_buff *rx_skb;
445 int rx_packet_len;
446 void *drv_data;
447};
448
449int nci_uart_register(struct nci_uart *nu);
450void nci_uart_unregister(struct nci_uart *nu);
451void nci_uart_set_config(struct nci_uart *nu, int baudrate, int flow_ctrl);
452
6a2968aa 453#endif /* __NCI_CORE_H */
Linux kernel - Deliverables
This page took 0.218105 seconds and 5 git commands to generate.