[deliverable/linux.git] / include / net / nfc / nci_core.h

/*
 *  The NFC Controller Interface is the communication protocol between an
 *  NFC Controller (NFCC) and a Device Host (DH).
 *
 *  Copyright (C) 2011 Texas Instruments, Inc.
 *
 *  Written by Ilan Elias <ilane@ti.com>
 *
 *  Acknowledgements:
 *  This file is based on hci_core.h, which was written
 *  by Maxim Krasnyansky.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef __NCI_CORE_H
#define __NCI_CORE_H

#include <linux/interrupt.h>
#include <linux/skbuff.h>

#include <net/nfc/nfc.h>
#include <net/nfc/nci.h>

/* NCI device state */
enum {
	NCI_INIT,
	NCI_UP,
	NCI_DISCOVERY,
	NCI_POLL_ACTIVE,
	NCI_DATA_EXCHANGE,
};

/* NCI timeouts */
#define NCI_RESET_TIMEOUT			5000
#define NCI_INIT_TIMEOUT			5000
#define NCI_RF_DISC_TIMEOUT			5000
#define NCI_RF_DEACTIVATE_TIMEOUT		5000
#define NCI_CMD_TIMEOUT				5000

struct nci_dev;

struct nci_ops {
	int (*open)(struct nci_dev *ndev);
	int (*close)(struct nci_dev *ndev);
	int (*send)(struct sk_buff *skb);
};

#define NCI_MAX_SUPPORTED_RF_INTERFACES		4

/* NCI Core structures */
struct nci_dev {
	struct nfc_dev		*nfc_dev;
	struct nci_ops		*ops;

	int			tx_headroom;
	int			tx_tailroom;

	unsigned long		flags;

	atomic_t		cmd_cnt;
	atomic_t		credits_cnt;

	struct timer_list	cmd_timer;

	struct workqueue_struct	*cmd_wq;
	struct work_struct	cmd_work;

	struct workqueue_struct	*rx_wq;
	struct work_struct	rx_work;

	struct workqueue_struct	*tx_wq;
	struct work_struct	tx_work;

	struct sk_buff_head	cmd_q;
	struct sk_buff_head	rx_q;
	struct sk_buff_head	tx_q;

	struct mutex		req_lock;
	struct completion	req_completion;
	__u32			req_status;
	__u32			req_result;

	void			*driver_data;

	__u32			poll_prots;
	__u32			target_available_prots;
	__u32			target_active_prot;

	/* received during NCI_OP_CORE_RESET_RSP */
	__u8			nci_ver;

	/* received during NCI_OP_CORE_INIT_RSP */
	__u32			nfcc_features;
	__u8			num_supported_rf_interfaces;
	__u8			supported_rf_interfaces
				[NCI_MAX_SUPPORTED_RF_INTERFACES];
	__u8			max_logical_connections;
	__u16			max_routing_table_size;
	__u8			max_control_packet_payload_length;
	__u16			rf_sending_buffer_size;
	__u16			rf_receiving_buffer_size;
	__u16			manufacturer_id;

	/* received during NCI_OP_CORE_CONN_CREATE_RSP for static conn 0 */
	__u8			max_pkt_payload_size;
	__u8			initial_num_credits;
	__u8			conn_id;

	/* stored during nci_data_exchange */
	data_exchange_cb_t	data_exchange_cb;
	void			*data_exchange_cb_context;
	struct sk_buff		*rx_data_reassembly;
};

/* ----- NCI Devices ----- */
struct nci_dev *nci_allocate_device(struct nci_ops *ops,
				__u32 supported_protocols,
				int tx_headroom,
				int tx_tailroom);
void nci_free_device(struct nci_dev *ndev);
int nci_register_device(struct nci_dev *ndev);
void nci_unregister_device(struct nci_dev *ndev);
int nci_recv_frame(struct sk_buff *skb);

static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
						unsigned int len,
						gfp_t how)
{
	struct sk_buff *skb;

	skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
	if (skb)
		skb_reserve(skb, ndev->tx_headroom);

	return skb;
}

static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
{
	nfc_set_parent_dev(ndev->nfc_dev, dev);
}

static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
{
	ndev->driver_data = data;
}

static inline void *nci_get_drvdata(struct nci_dev *ndev)
{
	return ndev->driver_data;
}

void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
				int err);

/* ----- NCI requests ----- */
#define NCI_REQ_DONE		0
#define NCI_REQ_PEND		1
#define NCI_REQ_CANCELED	2

void nci_req_complete(struct nci_dev *ndev, int result);

/* ----- NCI status code ----- */
int nci_to_errno(__u8 code);

#endif /* __NCI_CORE_H */
Commit	Line	Data
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.
	6	*
	7	* Written by Ilan Elias <ilane@ti.com>
	8	*
	9	* Acknowledgements:
	10	* This file is based on hci_core.h, which was written
	11	* by Maxim Krasnyansky.
	12	*
	13	* This program is free software; you can redistribute it and/or modify
	14	* it under the terms of the GNU General Public License version 2
	15	* as published by the Free Software Foundation
	16	*
	17	* This program is distributed in the hope that it will be useful,
	18	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	* GNU General Public License for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License
	23	* along with this program; if not, write to the Free Software
	24	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	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 state */
	38	enum {
	39	NCI_INIT,
	40	NCI_UP,
	41	NCI_DISCOVERY,
	42	NCI_POLL_ACTIVE,
38f04c6b	43	NCI_DATA_EXCHANGE,
6a2968aa IE	44	};
	45
	46	/* NCI timeouts */
	47	#define NCI_RESET_TIMEOUT 5000
	48	#define NCI_INIT_TIMEOUT 5000
	49	#define NCI_RF_DISC_TIMEOUT 5000
	50	#define NCI_RF_DEACTIVATE_TIMEOUT 5000
	51	#define NCI_CMD_TIMEOUT 5000
	52
	53	struct nci_dev;
	54
	55	struct nci_ops {
	56	int (open)(struct nci_dev ndev);
	57	int (close)(struct nci_dev ndev);
	58	int (send)(struct sk_buff skb);
	59	};
	60
	61	#define NCI_MAX_SUPPORTED_RF_INTERFACES 4
	62
	63	/* NCI Core structures */
	64	struct nci_dev {
	65	struct nfc_dev *nfc_dev;
	66	struct nci_ops *ops;
	67
	68	int tx_headroom;
	69	int tx_tailroom;
	70
	71	unsigned long flags;
	72
	73	atomic_t cmd_cnt;
	74	atomic_t credits_cnt;
	75
	76	struct timer_list cmd_timer;
	77
	78	struct workqueue_struct *cmd_wq;
	79	struct work_struct cmd_work;
	80
	81	struct workqueue_struct *rx_wq;
	82	struct work_struct rx_work;
	83
	84	struct workqueue_struct *tx_wq;
	85	struct work_struct tx_work;
	86
	87	struct sk_buff_head cmd_q;
	88	struct sk_buff_head rx_q;
	89	struct sk_buff_head tx_q;
	90
	91	struct mutex req_lock;
	92	struct completion req_completion;
	93	__u32 req_status;
	94	__u32 req_result;
	95
	96	void *driver_data;
	97
	98	__u32 poll_prots;
	99	__u32 target_available_prots;
	100	__u32 target_active_prot;
	101
	102	/* received during NCI_OP_CORE_RESET_RSP */
	103	__u8 nci_ver;
	104
	105	/* received during NCI_OP_CORE_INIT_RSP */
	106	__u32 nfcc_features;
	107	__u8 num_supported_rf_interfaces;
108	__u8 supported_rf_interfaces
109	[NCI_MAX_SUPPORTED_RF_INTERFACES];
110	__u8 max_logical_connections;
111	__u16 max_routing_table_size;
112	__u8 max_control_packet_payload_length;
113	__u16 rf_sending_buffer_size;
114	__u16 rf_receiving_buffer_size;
115	__u16 manufacturer_id;
116
117	/* received during NCI_OP_CORE_CONN_CREATE_RSP for static conn 0 */
118	__u8 max_pkt_payload_size;
119	__u8 initial_num_credits;
120	__u8 conn_id;
121
122	/* stored during nci_data_exchange */
123	data_exchange_cb_t data_exchange_cb;
124	void *data_exchange_cb_context;
125	struct sk_buff *rx_data_reassembly;
126	};
127
128	/* ----- NCI Devices ----- */
129	struct nci_dev nci_allocate_device(struct nci_ops ops,
130	__u32 supported_protocols,
131	int tx_headroom,
132	int tx_tailroom);
133	void nci_free_device(struct nci_dev *ndev);
134	int nci_register_device(struct nci_dev *ndev);
135	void nci_unregister_device(struct nci_dev *ndev);
136	int nci_recv_frame(struct sk_buff *skb);
137
138	static inline struct sk_buff nci_skb_alloc(struct nci_dev ndev,
139	unsigned int len,
140	gfp_t how)
141	{
142	struct sk_buff *skb;
143
144	skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
145	if (skb)
146	skb_reserve(skb, ndev->tx_headroom);
147
148	return skb;
149	}
150
151	static inline void nci_set_parent_dev(struct nci_dev ndev, struct device dev)
152	{
153	nfc_set_parent_dev(ndev->nfc_dev, dev);
154	}
155
156	static inline void nci_set_drvdata(struct nci_dev ndev, void data)
157	{
158	ndev->driver_data = data;
159	}
160
161	static inline void nci_get_drvdata(struct nci_dev ndev)
162	{
163	return ndev->driver_data;
164	}
165
166	void nci_rsp_packet(struct nci_dev ndev, struct sk_buff skb);
167	void nci_ntf_packet(struct nci_dev ndev, struct sk_buff skb);
168	void nci_rx_data_packet(struct nci_dev ndev, struct sk_buff skb);
169	int nci_send_cmd(struct nci_dev ndev, __u16 opcode, __u8 plen, void payload);
170	int nci_send_data(struct nci_dev ndev, __u8 conn_id, struct sk_buff skb);
171	void nci_data_exchange_complete(struct nci_dev ndev, struct sk_buff skb,
172	int err);
173
174	/* ----- NCI requests ----- */
175	#define NCI_REQ_DONE 0
176	#define NCI_REQ_PEND 1
177	#define NCI_REQ_CANCELED 2
178
179	void nci_req_complete(struct nci_dev *ndev, int result);
180
181	/* ----- NCI status code ----- */
182	int nci_to_errno(__u8 code);
183
184	#endif /* __NCI_CORE_H */