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, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #include <linux/interrupt.h>
33 #include <linux/skbuff.h>
35 #include <net/nfc/nfc.h>
36 #include <net/nfc/nci.h>
38 /* NCI device flags */
46 /* NCI device states */
50 NCI_W4_ALL_DISCOVERIES,
56 #define NCI_RESET_TIMEOUT 5000
57 #define NCI_INIT_TIMEOUT 5000
58 #define NCI_SET_CONFIG_TIMEOUT 5000
59 #define NCI_RF_DISC_TIMEOUT 5000
60 #define NCI_RF_DISC_SELECT_TIMEOUT 5000
61 #define NCI_RF_DEACTIVATE_TIMEOUT 30000
62 #define NCI_CMD_TIMEOUT 5000
63 #define NCI_DATA_TIMEOUT 700
68 int (*open)(struct nci_dev *ndev);
69 int (*close)(struct nci_dev *ndev);
70 int (*send)(struct nci_dev *ndev, struct sk_buff *skb);
73 #define NCI_MAX_SUPPORTED_RF_INTERFACES 4
74 #define NCI_MAX_DISCOVERED_TARGETS 10
76 /* NCI Core structures */
78 struct nfc_dev *nfc_dev;
90 struct timer_list cmd_timer;
91 struct timer_list data_timer;
93 struct workqueue_struct *cmd_wq;
94 struct work_struct cmd_work;
96 struct workqueue_struct *rx_wq;
97 struct work_struct rx_work;
99 struct workqueue_struct *tx_wq;
100 struct work_struct tx_work;
102 struct sk_buff_head cmd_q;
103 struct sk_buff_head rx_q;
104 struct sk_buff_head tx_q;
106 struct mutex req_lock;
107 struct completion req_completion;
114 __u32 target_active_prot;
116 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS];
119 /* received during NCI_OP_CORE_RESET_RSP */
122 /* received during NCI_OP_CORE_INIT_RSP */
124 __u8 num_supported_rf_interfaces;
125 __u8 supported_rf_interfaces
126 [NCI_MAX_SUPPORTED_RF_INTERFACES];
127 __u8 max_logical_connections;
128 __u16 max_routing_table_size;
129 __u8 max_ctrl_pkt_payload_len;
130 __u16 max_size_for_large_params;
132 __u32 manufact_specific_info;
134 /* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
135 __u8 max_data_pkt_payload_size;
136 __u8 initial_num_credits;
138 /* stored during nci_data_exchange */
139 data_exchange_cb_t data_exchange_cb;
140 void *data_exchange_cb_context;
141 struct sk_buff *rx_data_reassembly;
143 /* stored during intf_activated_ntf */
144 __u8 remote_gb[NFC_MAX_GT_LEN];
148 /* ----- NCI Devices ----- */
149 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
150 __u32 supported_protocols,
153 void nci_free_device(struct nci_dev *ndev);
154 int nci_register_device(struct nci_dev *ndev);
155 void nci_unregister_device(struct nci_dev *ndev);
156 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
158 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
164 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
166 skb_reserve(skb, ndev->tx_headroom);
171 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
173 nfc_set_parent_dev(ndev->nfc_dev, dev);
176 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
178 ndev->driver_data = data;
181 static inline void *nci_get_drvdata(struct nci_dev *ndev)
183 return ndev->driver_data;
186 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
187 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
188 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
189 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
190 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
191 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
193 void nci_clear_target_list(struct nci_dev *ndev);
195 /* ----- NCI requests ----- */
196 #define NCI_REQ_DONE 0
197 #define NCI_REQ_PEND 1
198 #define NCI_REQ_CANCELED 2
200 void nci_req_complete(struct nci_dev *ndev, int result);
202 /* ----- NCI status code ----- */
203 int nci_to_errno(__u8 code);
205 /* ----- NCI over SPI acknowledge modes ----- */
206 #define NCI_SPI_CRC_DISABLED 0x00
207 #define NCI_SPI_CRC_ENABLED 0x01
209 /* ----- NCI SPI structures ----- */
211 struct nci_dev *ndev;
212 struct spi_device *spi;
214 unsigned int xfer_udelay; /* microseconds delay between
218 struct completion req_completion;
222 /* ----- NCI SPI ----- */
223 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
224 u8 acknowledge_mode, unsigned int delay,
225 struct nci_dev *ndev);
226 int nci_spi_send(struct nci_spi *nspi,
227 struct completion *write_handshake_completion,
228 struct sk_buff *skb);
229 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
231 #endif /* __NCI_CORE_H */