xref: /linux/include/net/nfc/hci.h (revision 26b0d14106954ae46d2f4f7eec3481828a210f7d)
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 
27 struct nfc_hci_dev;
28 
29 struct nfc_hci_ops {
30 	int (*open) (struct nfc_hci_dev *hdev);
31 	void (*close) (struct nfc_hci_dev *hdev);
32 	int (*hci_ready) (struct nfc_hci_dev *hdev);
33 	int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb);
34 	int (*start_poll) (struct nfc_hci_dev *hdev, u32 protocols);
35 	int (*target_from_gate) (struct nfc_hci_dev *hdev, u8 gate,
36 				 struct nfc_target *target);
37 	int (*complete_target_discovered) (struct nfc_hci_dev *hdev, u8 gate,
38 					   struct nfc_target *target);
39 	int (*data_exchange) (struct nfc_hci_dev *hdev,
40 			      struct nfc_target *target,
41 			      struct sk_buff *skb, struct sk_buff **res_skb);
42 	int (*check_presence)(struct nfc_hci_dev *hdev,
43 			      struct nfc_target *target);
44 };
45 
46 #define NFC_HCI_MAX_CUSTOM_GATES	15
47 struct nfc_hci_init_data {
48 	u8 gate_count;
49 	u8 gates[NFC_HCI_MAX_CUSTOM_GATES];
50 	char session_id[9];
51 };
52 
53 typedef int (*xmit) (struct sk_buff *skb, void *cb_data);
54 
55 #define NFC_HCI_MAX_GATES		256
56 
57 struct nfc_hci_dev {
58 	struct nfc_dev *ndev;
59 
60 	u32 max_data_link_payload;
61 
62 	struct mutex msg_tx_mutex;
63 
64 	struct list_head msg_tx_queue;
65 
66 	struct workqueue_struct *msg_tx_wq;
67 	struct work_struct msg_tx_work;
68 
69 	struct timer_list cmd_timer;
70 	struct hci_msg *cmd_pending_msg;
71 
72 	struct sk_buff_head rx_hcp_frags;
73 
74 	struct workqueue_struct *msg_rx_wq;
75 	struct work_struct msg_rx_work;
76 
77 	struct sk_buff_head msg_rx_queue;
78 
79 	struct nfc_hci_ops *ops;
80 
81 	struct nfc_hci_init_data init_data;
82 
83 	void *clientdata;
84 
85 	u8 gate2pipe[NFC_HCI_MAX_GATES];
86 
87 	u8 sw_romlib;
88 	u8 sw_patch;
89 	u8 sw_flashlib_major;
90 	u8 sw_flashlib_minor;
91 
92 	u8 hw_derivative;
93 	u8 hw_version;
94 	u8 hw_mpw;
95 	u8 hw_software;
96 	u8 hw_bsid;
97 };
98 
99 /* hci device allocation */
100 struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops,
101 					    struct nfc_hci_init_data *init_data,
102 					    u32 protocols,
103 					    int tx_headroom,
104 					    int tx_tailroom,
105 					    int max_link_payload);
106 void nfc_hci_free_device(struct nfc_hci_dev *hdev);
107 
108 int nfc_hci_register_device(struct nfc_hci_dev *hdev);
109 void nfc_hci_unregister_device(struct nfc_hci_dev *hdev);
110 
111 void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata);
112 void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev);
113 
114 /* Host IDs */
115 #define NFC_HCI_HOST_CONTROLLER_ID	0x00
116 #define NFC_HCI_TERMINAL_HOST_ID	0x01
117 #define NFC_HCI_UICC_HOST_ID		0x02
118 
119 /* Host Controller Gates and registry indexes */
120 #define NFC_HCI_ADMIN_GATE 0x00
121 #define NFC_HCI_ADMIN_SESSION_IDENTITY	0x01
122 #define NFC_HCI_ADMIN_MAX_PIPE		0x02
123 #define NFC_HCI_ADMIN_WHITELIST		0x03
124 #define NFC_HCI_ADMIN_HOST_LIST		0x04
125 
126 #define NFC_HCI_LOOPBACK_GATE		0x04
127 
128 #define NFC_HCI_ID_MGMT_GATE		0x05
129 #define NFC_HCI_ID_MGMT_VERSION_SW	0x01
130 #define NFC_HCI_ID_MGMT_VERSION_HW	0x03
131 #define NFC_HCI_ID_MGMT_VENDOR_NAME	0x04
132 #define NFC_HCI_ID_MGMT_MODEL_ID	0x05
133 #define NFC_HCI_ID_MGMT_HCI_VERSION	0x02
134 #define NFC_HCI_ID_MGMT_GATES_LIST	0x06
135 
136 #define NFC_HCI_LINK_MGMT_GATE		0x06
137 #define NFC_HCI_LINK_MGMT_REC_ERROR	0x01
138 
139 #define NFC_HCI_RF_READER_B_GATE			0x11
140 #define NFC_HCI_RF_READER_B_PUPI			0x03
141 #define NFC_HCI_RF_READER_B_APPLICATION_DATA		0x04
142 #define NFC_HCI_RF_READER_B_AFI				0x02
143 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE	0x01
144 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA		0x05
145 
146 #define NFC_HCI_RF_READER_A_GATE		0x13
147 #define NFC_HCI_RF_READER_A_UID			0x02
148 #define NFC_HCI_RF_READER_A_ATQA		0x04
149 #define NFC_HCI_RF_READER_A_APPLICATION_DATA	0x05
150 #define NFC_HCI_RF_READER_A_SAK			0x03
151 #define NFC_HCI_RF_READER_A_FWI_SFGT		0x06
152 #define NFC_HCI_RF_READER_A_DATARATE_MAX	0x01
153 
154 #define NFC_HCI_TYPE_A_SEL_PROT(x)		(((x) & 0x60) >> 5)
155 #define NFC_HCI_TYPE_A_SEL_PROT_MIFARE		0
156 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443	1
157 #define NFC_HCI_TYPE_A_SEL_PROT_DEP		2
158 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP	3
159 
160 /* Generic events */
161 #define NFC_HCI_EVT_HCI_END_OF_OPERATION	0x01
162 #define NFC_HCI_EVT_POST_DATA			0x02
163 #define NFC_HCI_EVT_HOT_PLUG			0x03
164 
165 /* Reader RF gates events */
166 #define NFC_HCI_EVT_READER_REQUESTED	0x10
167 #define NFC_HCI_EVT_END_OPERATION	0x11
168 
169 /* Reader Application gate events */
170 #define NFC_HCI_EVT_TARGET_DISCOVERED	0x10
171 
172 /* receiving messages from lower layer */
173 void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result,
174 			   struct sk_buff *skb);
175 void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd,
176 			  struct sk_buff *skb);
177 void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
178 			    struct sk_buff *skb);
179 void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb);
180 
181 /* connecting to gates and sending hci instructions */
182 int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate);
183 int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate);
184 int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev);
185 int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
186 		      struct sk_buff **skb);
187 int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
188 		      const u8 *param, size_t param_len);
189 int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
190 		     const u8 *param, size_t param_len, struct sk_buff **skb);
191 int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response,
192 			  const u8 *param, size_t param_len);
193 int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event,
194 		       const u8 *param, size_t param_len);
195 
196 #endif /* __NET_HCI_H */
197