[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.
 *  Copyright (C) 2013 Intel Corporation. All rights reserved.
 *
 *  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 flags */
enum nci_flag {
	NCI_INIT,
	NCI_UP,
	NCI_DATA_EXCHANGE,
	NCI_DATA_EXCHANGE_TO,
};

/* NCI device states */
enum nci_state {
	NCI_IDLE,
	NCI_DISCOVERY,
	NCI_W4_ALL_DISCOVERIES,
	NCI_W4_HOST_SELECT,
	NCI_POLL_ACTIVE,
};

/* NCI timeouts */
#define NCI_RESET_TIMEOUT			5000
#define NCI_INIT_TIMEOUT			5000
#define NCI_SET_CONFIG_TIMEOUT			5000
#define NCI_RF_DISC_TIMEOUT			5000
#define NCI_RF_DISC_SELECT_TIMEOUT		5000
#define NCI_RF_DEACTIVATE_TIMEOUT		30000
#define NCI_CMD_TIMEOUT				5000
#define NCI_DATA_TIMEOUT			700

struct nci_dev;

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

#define NCI_MAX_SUPPORTED_RF_INTERFACES		4
#define NCI_MAX_DISCOVERED_TARGETS		10

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

	int			tx_headroom;
	int			tx_tailroom;

	atomic_t		state;
	unsigned long		flags;

	atomic_t		cmd_cnt;
	atomic_t		credits_cnt;

	struct timer_list	cmd_timer;
	struct timer_list	data_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_active_prot;

	struct nfc_target	targets[NCI_MAX_DISCOVERED_TARGETS];
	int			n_targets;

	/* 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_ctrl_pkt_payload_len;
	__u16			max_size_for_large_params;
	__u8			manufact_id;
	__u32			manufact_specific_info;

	/* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
	__u8			max_data_pkt_payload_size;
	__u8			initial_num_credits;

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

	/* stored during intf_activated_ntf */
	__u8 remote_gb[NFC_MAX_GT_LEN];
	__u8 remote_gb_len;
};

/* ----- 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 nci_dev *ndev, struct sk_buff *skb);
int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);

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);
void nci_clear_target_list(struct nci_dev *ndev);

/* ----- 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);

/* ----- NCI over SPI acknowledge modes ----- */
#define NCI_SPI_CRC_DISABLED	0x00
#define NCI_SPI_CRC_ENABLED	0x01

/* ----- NCI SPI structures ----- */
struct nci_spi {
	struct nci_dev		*ndev;
	struct spi_device	*spi;

	unsigned int		xfer_udelay;	/* microseconds delay between
						  transactions */
	u8			acknowledge_mode;

	struct completion	req_completion;
	u8			req_result;
};

/* ----- NCI SPI ----- */
struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
				     u8 acknowledge_mode, unsigned int delay,
				     struct nci_dev *ndev);
int nci_spi_send(struct nci_spi *nspi,
		 struct completion *write_handshake_completion,
		 struct sk_buff *skb);
struct sk_buff *nci_spi_read(struct nci_spi *nspi);

#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.
8a00a61b	6	* Copyright (C) 2013 Intel Corporation. All rights reserved.
6a2968aa IE	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, write to the Free Software
	25	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	26	*
	27	*/
	28
	29	#ifndef __NCI_CORE_H
	30	#define __NCI_CORE_H
	31
	32	#include <linux/interrupt.h>
	33	#include <linux/skbuff.h>
	34
	35	#include <net/nfc/nfc.h>
	36	#include <net/nfc/nci.h>
	37
8939e47f IE	38	/* NCI device flags */
8939e47f IE	39	enum nci_flag {
6a2968aa IE	40	NCI_INIT,
6a2968aa IE	41	NCI_UP,
38f04c6b	42	NCI_DATA_EXCHANGE,
c4bf98b2	43	NCI_DATA_EXCHANGE_TO,
6a2968aa IE	44	};
6a2968aa IE	45
8939e47f IE	46	/* NCI device states */
	47	enum nci_state {
	48	NCI_IDLE,
	49	NCI_DISCOVERY,
019c4fba IE	50	NCI_W4_ALL_DISCOVERIES,
019c4fba IE	51	NCI_W4_HOST_SELECT,
8939e47f IE	52	NCI_POLL_ACTIVE,
	53	};
	54
6a2968aa IE	55	/* NCI timeouts */
	56	#define NCI_RESET_TIMEOUT 5000
	57	#define NCI_INIT_TIMEOUT 5000
7e035230	58	#define NCI_SET_CONFIG_TIMEOUT 5000
6a2968aa	59	#define NCI_RF_DISC_TIMEOUT 5000
019c4fba	60	#define NCI_RF_DISC_SELECT_TIMEOUT 5000
11ee5158	61	#define NCI_RF_DEACTIVATE_TIMEOUT 30000
6a2968aa	62	#define NCI_CMD_TIMEOUT 5000
c4bf98b2	63	#define NCI_DATA_TIMEOUT 700
6a2968aa IE	64
	65	struct nci_dev;
	66
	67	struct nci_ops {
	68	int (open)(struct nci_dev ndev);
	69	int (close)(struct nci_dev ndev);
1095e69f	70	int (send)(struct nci_dev ndev, struct sk_buff *skb);
86e8586e	71	int (setup)(struct nci_dev ndev);
6a2968aa IE	72	};
	73
	74	#define NCI_MAX_SUPPORTED_RF_INTERFACES 4
019c4fba	75	#define NCI_MAX_DISCOVERED_TARGETS 10
6a2968aa IE	76
	77	/* NCI Core structures */
	78	struct nci_dev {
	79	struct nfc_dev *nfc_dev;
	80	struct nci_ops *ops;
	81
	82	int tx_headroom;
	83	int tx_tailroom;
	84
8939e47f	85	atomic_t state;
6a2968aa IE	86	unsigned long flags;
	87
	88	atomic_t cmd_cnt;
	89	atomic_t credits_cnt;
	90
	91	struct timer_list cmd_timer;
c4bf98b2	92	struct timer_list data_timer;
6a2968aa IE	93
	94	struct workqueue_struct *cmd_wq;
	95	struct work_struct cmd_work;
	96
	97	struct workqueue_struct *rx_wq;
	98	struct work_struct rx_work;
	99
	100	struct workqueue_struct *tx_wq;
	101	struct work_struct tx_work;
	102
	103	struct sk_buff_head cmd_q;
	104	struct sk_buff_head rx_q;
	105	struct sk_buff_head tx_q;
	106
	107	struct mutex req_lock;
	108	struct completion req_completion;
	109	__u32 req_status;
	110	__u32 req_result;
	111
	112	void *driver_data;
	113
	114	__u32 poll_prots;
6a2968aa IE	115	__u32 target_active_prot;
6a2968aa IE	116
019c4fba IE	117	struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS];
	118	int n_targets;
	119
6a2968aa IE	120	/* received during NCI_OP_CORE_RESET_RSP */
	121	__u8 nci_ver;
	122
	123	/* received during NCI_OP_CORE_INIT_RSP */
	124	__u32 nfcc_features;
	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;
e8c0dacd IE	130	__u8 max_ctrl_pkt_payload_len;
e8c0dacd IE	131	__u16 max_size_for_large_params;
e8c0dacd IE	132	__u8 manufact_id;
e8c0dacd IE	133	__u32 manufact_specific_info;
6a2968aa	134
637d85a7 IE	135	/* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
	136	__u8 max_data_pkt_payload_size;
	137	__u8 initial_num_credits;
	138
6a2968aa IE	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;
767f19ae IE	143
	144	/* stored during intf_activated_ntf */
	145	__u8 remote_gb[NFC_MAX_GT_LEN];
	146	__u8 remote_gb_len;
6a2968aa IE	147	};
	148
	149	/* ----- NCI Devices ----- */
	150	struct nci_dev nci_allocate_device(struct nci_ops ops,
eb9bc6e9 SO	151	__u32 supported_protocols,
	152	int tx_headroom,
	153	int tx_tailroom);
6a2968aa IE	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);
1095e69f	157	int nci_recv_frame(struct nci_dev ndev, struct sk_buff skb);
22c15bf3	158	int nci_set_config(struct nci_dev ndev, __u8 id, size_t len, __u8 val);
6a2968aa IE	159
6a2968aa IE	160	static inline struct sk_buff nci_skb_alloc(struct nci_dev ndev,
eb9bc6e9 SO	161	unsigned int len,
eb9bc6e9 SO	162	gfp_t how)
6a2968aa IE	163	{
	164	struct sk_buff *skb;
	165
	166	skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
	167	if (skb)
	168	skb_reserve(skb, ndev->tx_headroom);
	169
	170	return skb;
	171	}
	172
	173	static inline void nci_set_parent_dev(struct nci_dev ndev, struct device dev)
	174	{
	175	nfc_set_parent_dev(ndev->nfc_dev, dev);
	176	}
	177
	178	static inline void nci_set_drvdata(struct nci_dev ndev, void data)
	179	{
	180	ndev->driver_data = data;
	181	}
	182
	183	static inline void nci_get_drvdata(struct nci_dev ndev)
	184	{
	185	return ndev->driver_data;
	186	}
	187
	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,
	194	int err);
019c4fba	195	void nci_clear_target_list(struct nci_dev *ndev);
6a2968aa IE	196
	197	/* ----- NCI requests ----- */
	198	#define NCI_REQ_DONE 0
	199	#define NCI_REQ_PEND 1
	200	#define NCI_REQ_CANCELED 2
	201
	202	void nci_req_complete(struct nci_dev *ndev, int result);
	203
	204	/* ----- NCI status code ----- */
	205	int nci_to_errno(__u8 code);
	206
8a00a61b FD	207	/* ----- NCI over SPI acknowledge modes ----- */
	208	#define NCI_SPI_CRC_DISABLED 0x00
	209	#define NCI_SPI_CRC_ENABLED 0x01
	210
	211	/* ----- NCI SPI structures ----- */
fa544fff	212	struct nci_spi {
d5937511	213	struct nci_dev *ndev;
8a00a61b	214	struct spi_device *spi;
8a00a61b FD	215
	216	unsigned int xfer_udelay; /* microseconds delay between
	217	transactions */
	218	u8 acknowledge_mode;
	219
ee9596d4 FD	220	struct completion req_completion;
ee9596d4 FD	221	u8 req_result;
8a00a61b FD	222	};
8a00a61b FD	223
fa544fff EL	224	/* ----- NCI SPI ----- */
fa544fff EL	225	struct nci_spi nci_spi_allocate_spi(struct spi_device spi,
fa544fff EL	226	u8 acknowledge_mode, unsigned int delay,
fa544fff EL	227	struct nci_dev *ndev);
2bed2785 EL	228	int nci_spi_send(struct nci_spi *nspi,
	229	struct completion *write_handshake_completion,
	230	struct sk_buff *skb);
22d4aae5	231	struct sk_buff nci_spi_read(struct nci_spi nspi);
8a00a61b	232
6a2968aa	233	#endif /* __NCI_CORE_H */