[mirror_ubuntu-bionic-kernel.git] / include / net / nfc / hci.h

/*
 * Copyright (C) 2011  Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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 __NET_HCI_H
#define __NET_HCI_H

#include <linux/skbuff.h>

#include <net/nfc/nfc.h>

struct nfc_phy_ops {
	int (*write)(void *dev_id, struct sk_buff *skb);
	int (*enable)(void *dev_id);
	void (*disable)(void *dev_id);
};

struct nfc_hci_dev;

struct nfc_hci_ops {
	int (*open) (struct nfc_hci_dev *hdev);
	void (*close) (struct nfc_hci_dev *hdev);
	int (*hci_ready) (struct nfc_hci_dev *hdev);
	/*
	 * xmit must always send the complete buffer before
	 * returning. Returned result must be 0 for success
	 * or negative for failure.
	 */
	int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb);
	int (*start_poll) (struct nfc_hci_dev *hdev,
			   u32 im_protocols, u32 tm_protocols);
	int (*dep_link_up)(struct nfc_hci_dev *hdev, struct nfc_target *target,
			   u8 comm_mode, u8 *gb, size_t gb_len);
	int (*dep_link_down)(struct nfc_hci_dev *hdev);
	int (*target_from_gate) (struct nfc_hci_dev *hdev, u8 gate,
				 struct nfc_target *target);
	int (*complete_target_discovered) (struct nfc_hci_dev *hdev, u8 gate,
					   struct nfc_target *target);
	int (*im_transceive) (struct nfc_hci_dev *hdev,
			      struct nfc_target *target, struct sk_buff *skb,
			      data_exchange_cb_t cb, void *cb_context);
	int (*tm_send)(struct nfc_hci_dev *hdev, struct sk_buff *skb);
	int (*check_presence)(struct nfc_hci_dev *hdev,
			      struct nfc_target *target);
	int (*event_received)(struct nfc_hci_dev *hdev, u8 gate, u8 event,
			      struct sk_buff *skb);
	int (*enable_se)(struct nfc_dev *dev, u32 secure_element);
	int (*disable_se)(struct nfc_dev *dev, u32 secure_element);
};

/* Pipes */
#define NFC_HCI_INVALID_PIPE	0x80
#define NFC_HCI_LINK_MGMT_PIPE	0x00
#define NFC_HCI_ADMIN_PIPE	0x01

struct nfc_hci_gate {
	u8 gate;
	u8 pipe;
};

#define NFC_HCI_MAX_CUSTOM_GATES	50
struct nfc_hci_init_data {
	u8 gate_count;
	struct nfc_hci_gate gates[NFC_HCI_MAX_CUSTOM_GATES];
	char session_id[9];
};

typedef int (*xmit) (struct sk_buff *skb, void *cb_data);

#define NFC_HCI_MAX_GATES		256

/*
 * These values can be specified by a driver to indicate it requires some
 * adaptation of the HCI standard.
 *
 * NFC_HCI_QUIRK_SHORT_CLEAR - send HCI_ADM_CLEAR_ALL_PIPE cmd with no params
 */
enum {
	NFC_HCI_QUIRK_SHORT_CLEAR	= 0,
};

struct nfc_hci_dev {
	struct nfc_dev *ndev;

	u32 max_data_link_payload;

	bool shutting_down;

	struct mutex msg_tx_mutex;

	struct list_head msg_tx_queue;

	struct work_struct msg_tx_work;

	struct timer_list cmd_timer;
	struct hci_msg *cmd_pending_msg;

	struct sk_buff_head rx_hcp_frags;

	struct work_struct msg_rx_work;

	struct sk_buff_head msg_rx_queue;

	struct nfc_hci_ops *ops;

	struct nfc_llc *llc;

	struct nfc_hci_init_data init_data;

	void *clientdata;

	u8 gate2pipe[NFC_HCI_MAX_GATES];

	u8 sw_romlib;
	u8 sw_patch;
	u8 sw_flashlib_major;
	u8 sw_flashlib_minor;

	u8 hw_derivative;
	u8 hw_version;
	u8 hw_mpw;
	u8 hw_software;
	u8 hw_bsid;

	int async_cb_type;
	data_exchange_cb_t async_cb;
	void *async_cb_context;

	u8 *gb;
	size_t gb_len;

	unsigned long quirks;
};

/* hci device allocation */
struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops,
					    struct nfc_hci_init_data *init_data,
					    unsigned long quirks,
					    u32 protocols,
					    u32 supported_se,
					    const char *llc_name,
					    int tx_headroom,
					    int tx_tailroom,
					    int max_link_payload);
void nfc_hci_free_device(struct nfc_hci_dev *hdev);

int nfc_hci_register_device(struct nfc_hci_dev *hdev);
void nfc_hci_unregister_device(struct nfc_hci_dev *hdev);

void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata);
void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev);

void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err);

int nfc_hci_result_to_errno(u8 result);

/* Host IDs */
#define NFC_HCI_HOST_CONTROLLER_ID	0x00
#define NFC_HCI_TERMINAL_HOST_ID	0x01
#define NFC_HCI_UICC_HOST_ID		0x02

/* Host Controller Gates and registry indexes */
#define NFC_HCI_ADMIN_GATE 0x00
#define NFC_HCI_ADMIN_SESSION_IDENTITY	0x01
#define NFC_HCI_ADMIN_MAX_PIPE		0x02
#define NFC_HCI_ADMIN_WHITELIST		0x03
#define NFC_HCI_ADMIN_HOST_LIST		0x04

#define NFC_HCI_LOOPBACK_GATE		0x04

#define NFC_HCI_ID_MGMT_GATE		0x05
#define NFC_HCI_ID_MGMT_VERSION_SW	0x01
#define NFC_HCI_ID_MGMT_VERSION_HW	0x03
#define NFC_HCI_ID_MGMT_VENDOR_NAME	0x04
#define NFC_HCI_ID_MGMT_MODEL_ID	0x05
#define NFC_HCI_ID_MGMT_HCI_VERSION	0x02
#define NFC_HCI_ID_MGMT_GATES_LIST	0x06

#define NFC_HCI_LINK_MGMT_GATE		0x06
#define NFC_HCI_LINK_MGMT_REC_ERROR	0x01

#define NFC_HCI_RF_READER_B_GATE			0x11
#define NFC_HCI_RF_READER_B_PUPI			0x03
#define NFC_HCI_RF_READER_B_APPLICATION_DATA		0x04
#define NFC_HCI_RF_READER_B_AFI				0x02
#define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE	0x01
#define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA		0x05

#define NFC_HCI_RF_READER_A_GATE		0x13
#define NFC_HCI_RF_READER_A_UID			0x02
#define NFC_HCI_RF_READER_A_ATQA		0x04
#define NFC_HCI_RF_READER_A_APPLICATION_DATA	0x05
#define NFC_HCI_RF_READER_A_SAK			0x03
#define NFC_HCI_RF_READER_A_FWI_SFGT		0x06
#define NFC_HCI_RF_READER_A_DATARATE_MAX	0x01

#define NFC_HCI_TYPE_A_SEL_PROT(x)		(((x) & 0x60) >> 5)
#define NFC_HCI_TYPE_A_SEL_PROT_MIFARE		0
#define NFC_HCI_TYPE_A_SEL_PROT_ISO14443	1
#define NFC_HCI_TYPE_A_SEL_PROT_DEP		2
#define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP	3

/* Generic events */
#define NFC_HCI_EVT_HCI_END_OF_OPERATION	0x01
#define NFC_HCI_EVT_POST_DATA			0x02
#define NFC_HCI_EVT_HOT_PLUG			0x03

/* Reader RF gates events */
#define NFC_HCI_EVT_READER_REQUESTED	0x10
#define NFC_HCI_EVT_END_OPERATION	0x11

/* Reader Application gate events */
#define NFC_HCI_EVT_TARGET_DISCOVERED	0x10

/* receiving messages from lower layer */
void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result,
			   struct sk_buff *skb);
void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd,
			  struct sk_buff *skb);
void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
			    struct sk_buff *skb);
void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb);

/* connecting to gates and sending hci instructions */
int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate,
			 u8 pipe);
int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate);
int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev);
int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
		      struct sk_buff **skb);
int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
		      const u8 *param, size_t param_len);
int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
		     const u8 *param, size_t param_len, struct sk_buff **skb);
int nfc_hci_send_cmd_async(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
			   const u8 *param, size_t param_len,
			   data_exchange_cb_t cb, void *cb_context);
int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response,
			  const u8 *param, size_t param_len);
int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event,
		       const u8 *param, size_t param_len);
int nfc_hci_target_discovered(struct nfc_hci_dev *hdev, u8 gate);
u32 nfc_hci_sak_to_protocol(u8 sak);

#endif /* __NET_HCI_H */
Commit	Line	Data
8b8d2e08 EL	1	/*
	2	* Copyright (C) 2011 Intel Corporation. All rights reserved.
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the
	16	* Free Software Foundation, Inc.,
	17	* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	18	*/
	19
	20	#ifndef __NET_HCI_H
	21	#define __NET_HCI_H
	22
	23	#include <linux/skbuff.h>
	24
	25	#include <net/nfc/nfc.h>
	26
97f18414 EL	27	struct nfc_phy_ops {
	28	int (write)(void dev_id, struct sk_buff *skb);
	29	int (enable)(void dev_id);
	30	void (disable)(void dev_id);
	31	};
	32
8b8d2e08 EL	33	struct nfc_hci_dev;
	34
	35	struct nfc_hci_ops {
	36	int (open) (struct nfc_hci_dev hdev);
	37	void (close) (struct nfc_hci_dev hdev);
	38	int (hci_ready) (struct nfc_hci_dev hdev);
96e32402 WR	39	/*
	40	* xmit must always send the complete buffer before
	41	* returning. Returned result must be 0 for success
	42	* or negative for failure.
	43	*/
8b8d2e08	44	int (xmit) (struct nfc_hci_dev hdev, struct sk_buff *skb);
fe7c5800 SO	45	int (start_poll) (struct nfc_hci_dev hdev,
fe7c5800 SO	46	u32 im_protocols, u32 tm_protocols);
c40d1740 AW	47	int (dep_link_up)(struct nfc_hci_dev hdev, struct nfc_target *target,
	48	u8 comm_mode, u8 *gb, size_t gb_len);
	49	int (dep_link_down)(struct nfc_hci_dev hdev);
8b8d2e08 EL	50	int (target_from_gate) (struct nfc_hci_dev hdev, u8 gate,
	51	struct nfc_target *target);
	52	int (complete_target_discovered) (struct nfc_hci_dev hdev, u8 gate,
	53	struct nfc_target *target);
e8107623	54	int (im_transceive) (struct nfc_hci_dev hdev,
f3e8fb55 EL	55	struct nfc_target target, struct sk_buff skb,
f3e8fb55 EL	56	data_exchange_cb_t cb, void *cb_context);
e8107623	57	int (tm_send)(struct nfc_hci_dev hdev, struct sk_buff *skb);
1676f751 EL	58	int (check_presence)(struct nfc_hci_dev hdev,
1676f751 EL	59	struct nfc_target *target);
27c31191 EL	60	int (event_received)(struct nfc_hci_dev hdev, u8 gate, u8 event,
27c31191 EL	61	struct sk_buff *skb);
390a1bd8 SO	62	int (enable_se)(struct nfc_dev dev, u32 secure_element);
390a1bd8 SO	63	int (disable_se)(struct nfc_dev dev, u32 secure_element);
8b8d2e08 EL	64	};
8b8d2e08 EL	65
a10d595b EL	66	/* Pipes */
	67	#define NFC_HCI_INVALID_PIPE 0x80
	68	#define NFC_HCI_LINK_MGMT_PIPE 0x00
	69	#define NFC_HCI_ADMIN_PIPE 0x01
	70
	71	struct nfc_hci_gate {
	72	u8 gate;
	73	u8 pipe;
	74	};
	75
	76	#define NFC_HCI_MAX_CUSTOM_GATES 50
8b8d2e08 EL	77	struct nfc_hci_init_data {
8b8d2e08 EL	78	u8 gate_count;
a10d595b	79	struct nfc_hci_gate gates[NFC_HCI_MAX_CUSTOM_GATES];
8b8d2e08 EL	80	char session_id[9];
	81	};
	82
	83	typedef int (xmit) (struct sk_buff skb, void *cb_data);
	84
	85	#define NFC_HCI_MAX_GATES 256
	86
bf71ab8b EL	87	/*
	88	* These values can be specified by a driver to indicate it requires some
	89	* adaptation of the HCI standard.
	90	*
	91	* NFC_HCI_QUIRK_SHORT_CLEAR - send HCI_ADM_CLEAR_ALL_PIPE cmd with no params
	92	*/
	93	enum {
	94	NFC_HCI_QUIRK_SHORT_CLEAR = 0,
	95	};
	96
8b8d2e08 EL	97	struct nfc_hci_dev {
	98	struct nfc_dev *ndev;
	99
	100	u32 max_data_link_payload;
	101
f0c91038 EL	102	bool shutting_down;
f0c91038 EL	103
8b8d2e08 EL	104	struct mutex msg_tx_mutex;
	105
	106	struct list_head msg_tx_queue;
	107
8b8d2e08 EL	108	struct work_struct msg_tx_work;
	109
	110	struct timer_list cmd_timer;
	111	struct hci_msg *cmd_pending_msg;
	112
	113	struct sk_buff_head rx_hcp_frags;
	114
8b8d2e08 EL	115	struct work_struct msg_rx_work;
	116
	117	struct sk_buff_head msg_rx_queue;
	118
	119	struct nfc_hci_ops *ops;
	120
412fda53 EL	121	struct nfc_llc *llc;
412fda53 EL	122
8b8d2e08 EL	123	struct nfc_hci_init_data init_data;
	124
	125	void *clientdata;
	126
	127	u8 gate2pipe[NFC_HCI_MAX_GATES];
	128
8b8d2e08 EL	129	u8 sw_romlib;
	130	u8 sw_patch;
	131	u8 sw_flashlib_major;
	132	u8 sw_flashlib_minor;
	133
	134	u8 hw_derivative;
	135	u8 hw_version;
	136	u8 hw_mpw;
	137	u8 hw_software;
	138	u8 hw_bsid;
f3e8fb55 EL	139
	140	int async_cb_type;
	141	data_exchange_cb_t async_cb;
	142	void *async_cb_context;
7e2afc9d AW	143
	144	u8 *gb;
	145	size_t gb_len;
bf71ab8b EL	146
bf71ab8b EL	147	unsigned long quirks;
8b8d2e08 EL	148	};
	149
	150	/* hci device allocation */
	151	struct nfc_hci_dev nfc_hci_allocate_device(struct nfc_hci_ops ops,
	152	struct nfc_hci_init_data *init_data,
bf71ab8b	153	unsigned long quirks,
8b8d2e08	154	u32 protocols,
390a1bd8	155	u32 supported_se,
412fda53	156	const char *llc_name,
8b8d2e08 EL	157	int tx_headroom,
	158	int tx_tailroom,
	159	int max_link_payload);
	160	void nfc_hci_free_device(struct nfc_hci_dev *hdev);
	161
	162	int nfc_hci_register_device(struct nfc_hci_dev *hdev);
	163	void nfc_hci_unregister_device(struct nfc_hci_dev *hdev);
	164
	165	void nfc_hci_set_clientdata(struct nfc_hci_dev hdev, void clientdata);
	166	void nfc_hci_get_clientdata(struct nfc_hci_dev hdev);
	167
a9a741a7 EL	168	void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err);
a9a741a7 EL	169
84d48190 EL	170	int nfc_hci_result_to_errno(u8 result);
84d48190 EL	171
8b8d2e08 EL	172	/* Host IDs */
	173	#define NFC_HCI_HOST_CONTROLLER_ID 0x00
	174	#define NFC_HCI_TERMINAL_HOST_ID 0x01
	175	#define NFC_HCI_UICC_HOST_ID 0x02
	176
	177	/* Host Controller Gates and registry indexes */
	178	#define NFC_HCI_ADMIN_GATE 0x00
	179	#define NFC_HCI_ADMIN_SESSION_IDENTITY 0x01
	180	#define NFC_HCI_ADMIN_MAX_PIPE 0x02
	181	#define NFC_HCI_ADMIN_WHITELIST 0x03
	182	#define NFC_HCI_ADMIN_HOST_LIST 0x04
	183
	184	#define NFC_HCI_LOOPBACK_GATE 0x04
	185
	186	#define NFC_HCI_ID_MGMT_GATE 0x05
	187	#define NFC_HCI_ID_MGMT_VERSION_SW 0x01
	188	#define NFC_HCI_ID_MGMT_VERSION_HW 0x03
	189	#define NFC_HCI_ID_MGMT_VENDOR_NAME 0x04
	190	#define NFC_HCI_ID_MGMT_MODEL_ID 0x05
	191	#define NFC_HCI_ID_MGMT_HCI_VERSION 0x02
	192	#define NFC_HCI_ID_MGMT_GATES_LIST 0x06
	193
	194	#define NFC_HCI_LINK_MGMT_GATE 0x06
	195	#define NFC_HCI_LINK_MGMT_REC_ERROR 0x01
	196
	197	#define NFC_HCI_RF_READER_B_GATE 0x11
	198	#define NFC_HCI_RF_READER_B_PUPI 0x03
	199	#define NFC_HCI_RF_READER_B_APPLICATION_DATA 0x04
	200	#define NFC_HCI_RF_READER_B_AFI 0x02
	201	#define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE 0x01
	202	#define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA 0x05
	203
	204	#define NFC_HCI_RF_READER_A_GATE 0x13
	205	#define NFC_HCI_RF_READER_A_UID 0x02
	206	#define NFC_HCI_RF_READER_A_ATQA 0x04
	207	#define NFC_HCI_RF_READER_A_APPLICATION_DATA 0x05
	208	#define NFC_HCI_RF_READER_A_SAK 0x03
	209	#define NFC_HCI_RF_READER_A_FWI_SFGT 0x06
	210	#define NFC_HCI_RF_READER_A_DATARATE_MAX 0x01
	211
	212	#define NFC_HCI_TYPE_A_SEL_PROT(x) (((x) & 0x60) >> 5)
	213	#define NFC_HCI_TYPE_A_SEL_PROT_MIFARE 0
	214	#define NFC_HCI_TYPE_A_SEL_PROT_ISO14443 1
	215	#define NFC_HCI_TYPE_A_SEL_PROT_DEP 2
	216	#define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP 3
	217
	218	/* Generic events */
	219	#define NFC_HCI_EVT_HCI_END_OF_OPERATION 0x01
	220	#define NFC_HCI_EVT_POST_DATA 0x02
	221	#define NFC_HCI_EVT_HOT_PLUG 0x03
	222
	223	/* Reader RF gates events */
	224	#define NFC_HCI_EVT_READER_REQUESTED 0x10
	225	#define NFC_HCI_EVT_END_OPERATION 0x11
	226
	227	/* Reader Application gate events */
	228	#define NFC_HCI_EVT_TARGET_DISCOVERED 0x10
	229
	230	/* receiving messages from lower layer */
	231	void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result,
	232	struct sk_buff *skb);
	233	void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd,
	234	struct sk_buff *skb);
	235	void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
236	struct sk_buff *skb);
237	void nfc_hci_recv_frame(struct nfc_hci_dev hdev, struct sk_buff skb);
238
239	/* connecting to gates and sending hci instructions */
a10d595b EL	240	int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate,
a10d595b EL	241	u8 pipe);
8b8d2e08 EL	242	int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate);
	243	int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev);
	244	int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
	245	struct sk_buff **skb);
	246	int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
	247	const u8 *param, size_t param_len);
	248	int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
	249	const u8 param, size_t param_len, struct sk_buff *skb);
e4c4789e EL	250	int nfc_hci_send_cmd_async(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
	251	const u8 *param, size_t param_len,
	252	data_exchange_cb_t cb, void *cb_context);
8b8d2e08 EL	253	int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response,
	254	const u8 *param, size_t param_len);
	255	int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event,
	256	const u8 *param, size_t param_len);
f7a5f6c5	257	int nfc_hci_target_discovered(struct nfc_hci_dev *hdev, u8 gate);
9c5121a0	258	u32 nfc_hci_sak_to_protocol(u8 sak);
8b8d2e08 EL	259
8b8d2e08 EL	260	#endif /* __NET_HCI_H */