Loading...
Note: File does not exist in v3.1.
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.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_H
29#define __NCI_H
30
31/* NCI constants */
32#define NCI_MAX_NUM_MAPPING_CONFIGS 10
33#define NCI_MAX_NUM_RF_CONFIGS 10
34#define NCI_MAX_NUM_CONN 10
35
36/* NCI Status Codes */
37#define NCI_STATUS_OK 0x00
38#define NCI_STATUS_REJECTED 0x01
39#define NCI_STATUS_RF_FRAME_CORRUPTED 0x02
40#define NCI_STATUS_FAILED 0x03
41#define NCI_STATUS_NOT_INITIALIZED 0x04
42#define NCI_STATUS_SYNTAX_ERROR 0x05
43#define NCI_STATUS_SEMANTIC_ERROR 0x06
44#define NCI_STATUS_UNKNOWN_GID 0x07
45#define NCI_STATUS_UNKNOWN_OID 0x08
46#define NCI_STATUS_INVALID_PARAM 0x09
47#define NCI_STATUS_MESSAGE_SIZE_EXCEEDED 0x0a
48/* Discovery Specific Status Codes */
49#define NCI_STATUS_DISCOVERY_ALREADY_STARTED 0xa0
50#define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED 0xa1
51#define NCI_STATUS_DISCOVERY_TEAR_DOWN 0xa2
52/* RF Interface Specific Status Codes */
53#define NCI_STATUS_RF_TRANSMISSION_ERROR 0xb0
54#define NCI_STATUS_RF_PROTOCOL_ERROR 0xb1
55#define NCI_STATUS_RF_TIMEOUT_ERROR 0xb2
56/* NFCEE Interface Specific Status Codes */
57#define NCI_STATUS_NFCEE_INTERFACE_ACTIVATION_FAILED 0xc0
58#define NCI_STATUS_NFCEE_TRANSMISSION_ERROR 0xc1
59#define NCI_STATUS_NFCEE_PROTOCOL_ERROR 0xc2
60#define NCI_STATUS_NFCEE_TIMEOUT_ERROR 0xc3
61
62/* NCI RF Technology and Mode */
63#define NCI_NFC_A_PASSIVE_POLL_MODE 0x00
64#define NCI_NFC_B_PASSIVE_POLL_MODE 0x01
65#define NCI_NFC_F_PASSIVE_POLL_MODE 0x02
66#define NCI_NFC_A_ACTIVE_POLL_MODE 0x03
67#define NCI_NFC_F_ACTIVE_POLL_MODE 0x05
68#define NCI_NFC_15693_PASSIVE_POLL_MODE 0x06
69#define NCI_NFC_A_PASSIVE_LISTEN_MODE 0x80
70#define NCI_NFC_B_PASSIVE_LISTEN_MODE 0x81
71#define NCI_NFC_F_PASSIVE_LISTEN_MODE 0x82
72#define NCI_NFC_A_ACTIVE_LISTEN_MODE 0x83
73#define NCI_NFC_F_ACTIVE_LISTEN_MODE 0x85
74#define NCI_NFC_15693_PASSIVE_LISTEN_MODE 0x86
75
76/* NCI RF Technologies */
77#define NCI_NFC_RF_TECHNOLOGY_A 0x00
78#define NCI_NFC_RF_TECHNOLOGY_B 0x01
79#define NCI_NFC_RF_TECHNOLOGY_F 0x02
80#define NCI_NFC_RF_TECHNOLOGY_15693 0x03
81
82/* NCI Bit Rates */
83#define NCI_NFC_BIT_RATE_106 0x00
84#define NCI_NFC_BIT_RATE_212 0x01
85#define NCI_NFC_BIT_RATE_424 0x02
86#define NCI_NFC_BIT_RATE_848 0x03
87#define NCI_NFC_BIT_RATE_1695 0x04
88#define NCI_NFC_BIT_RATE_3390 0x05
89#define NCI_NFC_BIT_RATE_6780 0x06
90
91/* NCI RF Protocols */
92#define NCI_RF_PROTOCOL_UNKNOWN 0x00
93#define NCI_RF_PROTOCOL_T1T 0x01
94#define NCI_RF_PROTOCOL_T2T 0x02
95#define NCI_RF_PROTOCOL_T3T 0x03
96#define NCI_RF_PROTOCOL_ISO_DEP 0x04
97#define NCI_RF_PROTOCOL_NFC_DEP 0x05
98
99/* NCI RF Interfaces */
100#define NCI_RF_INTERFACE_NFCEE_DIRECT 0x00
101#define NCI_RF_INTERFACE_FRAME 0x01
102#define NCI_RF_INTERFACE_ISO_DEP 0x02
103#define NCI_RF_INTERFACE_NFC_DEP 0x03
104
105/* NCI Reset types */
106#define NCI_RESET_TYPE_KEEP_CONFIG 0x00
107#define NCI_RESET_TYPE_RESET_CONFIG 0x01
108
109/* NCI Static RF connection ID */
110#define NCI_STATIC_RF_CONN_ID 0x00
111
112/* NCI Data Flow Control */
113#define NCI_DATA_FLOW_CONTROL_NOT_USED 0xff
114
115/* NCI RF_DISCOVER_MAP_CMD modes */
116#define NCI_DISC_MAP_MODE_POLL 0x01
117#define NCI_DISC_MAP_MODE_LISTEN 0x02
118
119/* NCI Discover Notification Type */
120#define NCI_DISCOVER_NTF_TYPE_LAST 0x00
121#define NCI_DISCOVER_NTF_TYPE_LAST_NFCC 0x01
122#define NCI_DISCOVER_NTF_TYPE_MORE 0x02
123
124/* NCI Deactivation Type */
125#define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00
126#define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01
127#define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02
128#define NCI_DEACTIVATE_TYPE_DISCOVERY 0x03
129
130/* Message Type (MT) */
131#define NCI_MT_DATA_PKT 0x00
132#define NCI_MT_CMD_PKT 0x01
133#define NCI_MT_RSP_PKT 0x02
134#define NCI_MT_NTF_PKT 0x03
135
136#define nci_mt(hdr) (((hdr)[0]>>5)&0x07)
137#define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5))
138
139/* Packet Boundary Flag (PBF) */
140#define NCI_PBF_LAST 0x00
141#define NCI_PBF_CONT 0x01
142
143#define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01)
144#define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4))
145
146/* Control Opcode manipulation */
147#define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)|\
148 ((__u16)((oid)&0x3f)))
149#define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1])
150#define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8)
151#define nci_opcode_oid(op) (__u8)((op)&0x003f)
152
153/* Payload Length */
154#define nci_plen(hdr) (__u8)((hdr)[2])
155
156/* Connection ID */
157#define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f)
158
159/* GID values */
160#define NCI_GID_CORE 0x0
161#define NCI_GID_RF_MGMT 0x1
162#define NCI_GID_NFCEE_MGMT 0x2
163#define NCI_GID_PROPRIETARY 0xf
164
165/* ---- NCI Packet structures ---- */
166#define NCI_CTRL_HDR_SIZE 3
167#define NCI_DATA_HDR_SIZE 3
168
169struct nci_ctrl_hdr {
170 __u8 gid; /* MT & PBF & GID */
171 __u8 oid;
172 __u8 plen;
173} __packed;
174
175struct nci_data_hdr {
176 __u8 conn_id; /* MT & PBF & ConnID */
177 __u8 rfu;
178 __u8 plen;
179} __packed;
180
181/* ------------------------ */
182/* ----- NCI Commands ---- */
183/* ------------------------ */
184#define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00)
185struct nci_core_reset_cmd {
186 __u8 reset_type;
187} __packed;
188
189#define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01)
190
191#define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
192struct disc_map_config {
193 __u8 rf_protocol;
194 __u8 mode;
195 __u8 rf_interface;
196} __packed;
197
198struct nci_rf_disc_map_cmd {
199 __u8 num_mapping_configs;
200 struct disc_map_config mapping_configs
201 [NCI_MAX_NUM_MAPPING_CONFIGS];
202} __packed;
203
204#define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
205struct disc_config {
206 __u8 rf_tech_and_mode;
207 __u8 frequency;
208} __packed;
209
210struct nci_rf_disc_cmd {
211 __u8 num_disc_configs;
212 struct disc_config disc_configs[NCI_MAX_NUM_RF_CONFIGS];
213} __packed;
214
215#define NCI_OP_RF_DISCOVER_SELECT_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
216struct nci_rf_discover_select_cmd {
217 __u8 rf_discovery_id;
218 __u8 rf_protocol;
219 __u8 rf_interface;
220} __packed;
221
222#define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
223struct nci_rf_deactivate_cmd {
224 __u8 type;
225} __packed;
226
227/* ----------------------- */
228/* ---- NCI Responses ---- */
229/* ----------------------- */
230#define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00)
231struct nci_core_reset_rsp {
232 __u8 status;
233 __u8 nci_ver;
234 __u8 config_status;
235} __packed;
236
237#define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01)
238struct nci_core_init_rsp_1 {
239 __u8 status;
240 __le32 nfcc_features;
241 __u8 num_supported_rf_interfaces;
242 __u8 supported_rf_interfaces[0]; /* variable size array */
243 /* continuted in nci_core_init_rsp_2 */
244} __packed;
245
246struct nci_core_init_rsp_2 {
247 __u8 max_logical_connections;
248 __le16 max_routing_table_size;
249 __u8 max_ctrl_pkt_payload_len;
250 __le16 max_size_for_large_params;
251 __u8 manufact_id;
252 __le32 manufact_specific_info;
253} __packed;
254
255#define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
256
257#define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
258
259#define NCI_OP_RF_DISCOVER_SELECT_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
260
261#define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
262
263/* --------------------------- */
264/* ---- NCI Notifications ---- */
265/* --------------------------- */
266#define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x06)
267struct conn_credit_entry {
268 __u8 conn_id;
269 __u8 credits;
270} __packed;
271
272struct nci_core_conn_credit_ntf {
273 __u8 num_entries;
274 struct conn_credit_entry conn_entries[NCI_MAX_NUM_CONN];
275} __packed;
276
277#define NCI_OP_CORE_GENERIC_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x07)
278
279#define NCI_OP_CORE_INTF_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x08)
280struct nci_core_intf_error_ntf {
281 __u8 status;
282 __u8 conn_id;
283} __packed;
284
285#define NCI_OP_RF_DISCOVER_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
286struct rf_tech_specific_params_nfca_poll {
287 __u16 sens_res;
288 __u8 nfcid1_len; /* 0, 4, 7, or 10 Bytes */
289 __u8 nfcid1[10];
290 __u8 sel_res_len; /* 0 or 1 Bytes */
291 __u8 sel_res;
292} __packed;
293
294struct rf_tech_specific_params_nfcb_poll {
295 __u8 sensb_res_len;
296 __u8 sensb_res[12]; /* 11 or 12 Bytes */
297} __packed;
298
299struct rf_tech_specific_params_nfcf_poll {
300 __u8 bit_rate;
301 __u8 sensf_res_len;
302 __u8 sensf_res[18]; /* 16 or 18 Bytes */
303} __packed;
304
305struct nci_rf_discover_ntf {
306 __u8 rf_discovery_id;
307 __u8 rf_protocol;
308 __u8 rf_tech_and_mode;
309 __u8 rf_tech_specific_params_len;
310
311 union {
312 struct rf_tech_specific_params_nfca_poll nfca_poll;
313 struct rf_tech_specific_params_nfcb_poll nfcb_poll;
314 struct rf_tech_specific_params_nfcf_poll nfcf_poll;
315 } rf_tech_specific_params;
316
317 __u8 ntf_type;
318} __packed;
319
320#define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05)
321struct activation_params_nfca_poll_iso_dep {
322 __u8 rats_res_len;
323 __u8 rats_res[20];
324};
325
326struct activation_params_nfcb_poll_iso_dep {
327 __u8 attrib_res_len;
328 __u8 attrib_res[50];
329};
330
331struct nci_rf_intf_activated_ntf {
332 __u8 rf_discovery_id;
333 __u8 rf_interface;
334 __u8 rf_protocol;
335 __u8 activation_rf_tech_and_mode;
336 __u8 max_data_pkt_payload_size;
337 __u8 initial_num_credits;
338 __u8 rf_tech_specific_params_len;
339
340 union {
341 struct rf_tech_specific_params_nfca_poll nfca_poll;
342 struct rf_tech_specific_params_nfcb_poll nfcb_poll;
343 struct rf_tech_specific_params_nfcf_poll nfcf_poll;
344 } rf_tech_specific_params;
345
346 __u8 data_exch_rf_tech_and_mode;
347 __u8 data_exch_tx_bit_rate;
348 __u8 data_exch_rx_bit_rate;
349 __u8 activation_params_len;
350
351 union {
352 struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep;
353 struct activation_params_nfcb_poll_iso_dep nfcb_poll_iso_dep;
354 } activation_params;
355
356} __packed;
357
358#define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
359struct nci_rf_deactivate_ntf {
360 __u8 type;
361 __u8 reason;
362} __packed;
363
364#endif /* __NCI_H */