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.
  6 *  Copyright (C) 2013 Intel Corporation. All rights reserved.
  7 *
  8 *  Written by Ilan Elias <ilane@ti.com>
  9 *
 10 *  Acknowledgements:
 11 *  This file is based on hci_core.h, which was written
 12 *  by Maxim Krasnyansky.
 13 *
 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
 17 *
 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.
 22 *
 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/>.
 25 *
 26 */
 27
 28#ifndef __NCI_CORE_H
 29#define __NCI_CORE_H
 30
 31#include <linux/interrupt.h>
 32#include <linux/skbuff.h>
 33
 34#include <net/nfc/nfc.h>
 35#include <net/nfc/nci.h>
 36
 37/* NCI device flags */
 38enum nci_flag {
 39	NCI_INIT,
 40	NCI_UP,
 41	NCI_DATA_EXCHANGE,
 42	NCI_DATA_EXCHANGE_TO,
 43};
 44
 45/* NCI device states */
 46enum nci_state {
 47	NCI_IDLE,
 48	NCI_DISCOVERY,
 49	NCI_W4_ALL_DISCOVERIES,
 50	NCI_W4_HOST_SELECT,
 51	NCI_POLL_ACTIVE,
 52};
 53
 54/* NCI timeouts */
 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
 63
 64struct nci_dev;
 65
 66struct nci_ops {
 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};
 72
 73#define NCI_MAX_SUPPORTED_RF_INTERFACES		4
 74#define NCI_MAX_DISCOVERED_TARGETS		10
 75
 76/* NCI Core structures */
 77struct nci_dev {
 78	struct nfc_dev		*nfc_dev;
 79	struct nci_ops		*ops;
 80
 81	int			tx_headroom;
 82	int			tx_tailroom;
 83
 84	atomic_t		state;
 85	unsigned long		flags;
 86
 87	atomic_t		cmd_cnt;
 88	atomic_t		credits_cnt;
 89
 90	struct timer_list	cmd_timer;
 91	struct timer_list	data_timer;
 92
 93	struct workqueue_struct	*cmd_wq;
 94	struct work_struct	cmd_work;
 95
 96	struct workqueue_struct	*rx_wq;
 97	struct work_struct	rx_work;
 98
 99	struct workqueue_struct	*tx_wq;
100	struct work_struct	tx_work;
101
102	struct sk_buff_head	cmd_q;
103	struct sk_buff_head	rx_q;
104	struct sk_buff_head	tx_q;
105
106	struct mutex		req_lock;
107	struct completion	req_completion;
108	__u32			req_status;
109	__u32			req_result;
110
111	void			*driver_data;
112
113	__u32			poll_prots;
114	__u32			target_active_prot;
115
116	struct nfc_target	targets[NCI_MAX_DISCOVERED_TARGETS];
117	int			n_targets;
118
119	/* received during NCI_OP_CORE_RESET_RSP */
120	__u8			nci_ver;
121
122	/* received during NCI_OP_CORE_INIT_RSP */
123	__u32			nfcc_features;
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;
131	__u8			manufact_id;
132	__u32			manufact_specific_info;
133
134	/* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
135	__u8			max_data_pkt_payload_size;
136	__u8			initial_num_credits;
137
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;
142
143	/* stored during intf_activated_ntf */
144	__u8 remote_gb[NFC_MAX_GT_LEN];
145	__u8 remote_gb_len;
146};
147
148/* ----- NCI Devices ----- */
149struct nci_dev *nci_allocate_device(struct nci_ops *ops,
150				    __u32 supported_protocols,
151				    int tx_headroom,
152				    int tx_tailroom);
153void nci_free_device(struct nci_dev *ndev);
154int nci_register_device(struct nci_dev *ndev);
155void nci_unregister_device(struct nci_dev *ndev);
156int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
157int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
158
159static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
160					    unsigned int len,
161					    gfp_t how)
162{
163	struct sk_buff *skb;
164
165	skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
166	if (skb)
167		skb_reserve(skb, ndev->tx_headroom);
168
169	return skb;
170}
171
172static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
173{
174	nfc_set_parent_dev(ndev->nfc_dev, dev);
175}
176
177static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
178{
179	ndev->driver_data = data;
180}
181
182static inline void *nci_get_drvdata(struct nci_dev *ndev)
183{
184	return ndev->driver_data;
185}
186
187void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
188void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
189void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
190int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
191int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
192void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
193				int err);
194void nci_clear_target_list(struct nci_dev *ndev);
195
196/* ----- NCI requests ----- */
197#define NCI_REQ_DONE		0
198#define NCI_REQ_PEND		1
199#define NCI_REQ_CANCELED	2
200
201void nci_req_complete(struct nci_dev *ndev, int result);
202
203/* ----- NCI status code ----- */
204int nci_to_errno(__u8 code);
205
206/* ----- NCI over SPI acknowledge modes ----- */
207#define NCI_SPI_CRC_DISABLED	0x00
208#define NCI_SPI_CRC_ENABLED	0x01
209
210/* ----- NCI SPI structures ----- */
211struct nci_spi {
212	struct nci_dev		*ndev;
213	struct spi_device	*spi;
214
215	unsigned int		xfer_udelay;	/* microseconds delay between
216						  transactions */
217	u8			acknowledge_mode;
218
219	struct completion	req_completion;
220	u8			req_result;
221};
222
223/* ----- NCI SPI ----- */
224struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
225				     u8 acknowledge_mode, unsigned int delay,
226				     struct nci_dev *ndev);
227int nci_spi_send(struct nci_spi *nspi,
228		 struct completion *write_handshake_completion,
229		 struct sk_buff *skb);
230struct sk_buff *nci_spi_read(struct nci_spi *nspi);
231
232#endif /* __NCI_CORE_H */