blob: 0ebf842b5946c7d9439d2fbaa5d7861d96d3bd97 [file] [log] [blame]
Ilan Elias6a2968a2011-09-18 11:19:35 +03001/*
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
Ilan Eliase8c0dac2011-11-09 12:09:14 +020039#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
Ilan Elias6a2968a2011-09-18 11:19:35 +030048/* Discovery Specific Status Codes */
49#define NCI_STATUS_DISCOVERY_ALREADY_STARTED 0xa0
50#define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED 0xa1
Ilan Eliase8c0dac2011-11-09 12:09:14 +020051#define NCI_STATUS_DISCOVERY_TEAR_DOWN 0xa2
Ilan Elias6a2968a2011-09-18 11:19:35 +030052/* 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
Ilan Elias6a2968a2011-09-18 11:19:35 +030056/* NFCEE Interface Specific Status Codes */
57#define NCI_STATUS_MAX_ACTIVE_NFCEE_INTERFACES_REACHED 0xc0
58#define NCI_STATUS_NFCEE_INTERFACE_ACTIVATION_FAILED 0xc1
59#define NCI_STATUS_NFCEE_TRANSMISSION_ERROR 0xc2
60#define NCI_STATUS_NFCEE_PROTOCOL_ERROR 0xc3
61#define NCI_STATUS_NFCEE_TIMEOUT_ERROR 0xc4
62
63/* NCI RF Technology and Mode */
64#define NCI_NFC_A_PASSIVE_POLL_MODE 0x00
65#define NCI_NFC_B_PASSIVE_POLL_MODE 0x01
66#define NCI_NFC_F_PASSIVE_POLL_MODE 0x02
67#define NCI_NFC_A_ACTIVE_POLL_MODE 0x03
68#define NCI_NFC_F_ACTIVE_POLL_MODE 0x05
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
Ilan Eliase8c0dac2011-11-09 12:09:14 +020075/* NCI RF Technologies */
76#define NCI_NFC_RF_TECHNOLOGY_A 0x00
77#define NCI_NFC_RF_TECHNOLOGY_B 0x01
78#define NCI_NFC_RF_TECHNOLOGY_F 0x02
79#define NCI_NFC_RF_TECHNOLOGY_15693 0x03
80
81/* NCI Bit Rates */
82#define NCI_NFC_BIT_RATE_106 0x00
83#define NCI_NFC_BIT_RATE_212 0x01
84#define NCI_NFC_BIT_RATE_424 0x02
85#define NCI_NFC_BIT_RATE_848 0x03
86#define NCI_NFC_BIT_RATE_1696 0x04
87#define NCI_NFC_BIT_RATE_3392 0x05
88#define NCI_NFC_BIT_RATE_6784 0x06
89
Ilan Elias6a2968a2011-09-18 11:19:35 +030090/* NCI RF Protocols */
91#define NCI_RF_PROTOCOL_UNKNOWN 0x00
92#define NCI_RF_PROTOCOL_T1T 0x01
93#define NCI_RF_PROTOCOL_T2T 0x02
94#define NCI_RF_PROTOCOL_T3T 0x03
95#define NCI_RF_PROTOCOL_ISO_DEP 0x04
96#define NCI_RF_PROTOCOL_NFC_DEP 0x05
97
98/* NCI RF Interfaces */
Ilan Eliase8c0dac2011-11-09 12:09:14 +020099#define NCI_RF_INTERFACE_NFCEE_DIRECT 0x00
Ilan Elias6a2968a2011-09-18 11:19:35 +0300100#define NCI_RF_INTERFACE_FRAME 0x01
101#define NCI_RF_INTERFACE_ISO_DEP 0x02
102#define NCI_RF_INTERFACE_NFC_DEP 0x03
103
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200104/* NCI Reset types */
105#define NCI_RESET_TYPE_KEEP_CONFIG 0x00
106#define NCI_RESET_TYPE_RESET_CONFIG 0x01
107
108/* NCI Static RF connection ID */
109#define NCI_STATIC_RF_CONN_ID 0x00
110
Ilan Elias6a2968a2011-09-18 11:19:35 +0300111/* NCI RF_DISCOVER_MAP_CMD modes */
112#define NCI_DISC_MAP_MODE_POLL 0x01
113#define NCI_DISC_MAP_MODE_LISTEN 0x02
114#define NCI_DISC_MAP_MODE_BOTH 0x03
115
116/* NCI Discovery Types */
117#define NCI_DISCOVERY_TYPE_POLL_A_PASSIVE 0x00
118#define NCI_DISCOVERY_TYPE_POLL_B_PASSIVE 0x01
119#define NCI_DISCOVERY_TYPE_POLL_F_PASSIVE 0x02
120#define NCI_DISCOVERY_TYPE_POLL_A_ACTIVE 0x03
121#define NCI_DISCOVERY_TYPE_POLL_F_ACTIVE 0x05
Ilan Elias6a2968a2011-09-18 11:19:35 +0300122#define NCI_DISCOVERY_TYPE_WAKEUP_A_ACTIVE 0x09
123#define NCI_DISCOVERY_TYPE_LISTEN_A_PASSIVE 0x80
124#define NCI_DISCOVERY_TYPE_LISTEN_B_PASSIVE 0x81
125#define NCI_DISCOVERY_TYPE_LISTEN_F_PASSIVE 0x82
126#define NCI_DISCOVERY_TYPE_LISTEN_A_ACTIVE 0x83
127#define NCI_DISCOVERY_TYPE_LISTEN_F_ACTIVE 0x85
128
129/* NCI Deactivation Type */
130#define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00
131#define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01
132#define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200133#define NCI_DEACTIVATE_TYPE_DISCOVERY 0x03
Ilan Elias6a2968a2011-09-18 11:19:35 +0300134
135/* Message Type (MT) */
136#define NCI_MT_DATA_PKT 0x00
137#define NCI_MT_CMD_PKT 0x01
138#define NCI_MT_RSP_PKT 0x02
139#define NCI_MT_NTF_PKT 0x03
140
141#define nci_mt(hdr) (((hdr)[0]>>5)&0x07)
142#define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5))
143
144/* Packet Boundary Flag (PBF) */
145#define NCI_PBF_LAST 0x00
146#define NCI_PBF_CONT 0x01
147
148#define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01)
149#define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4))
150
151/* Control Opcode manipulation */
152#define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)|\
153 ((__u16)((oid)&0x3f)))
154#define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1])
155#define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8)
156#define nci_opcode_oid(op) (__u8)((op)&0x003f)
157
158/* Payload Length */
159#define nci_plen(hdr) (__u8)((hdr)[2])
160
161/* Connection ID */
162#define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f)
163
164/* GID values */
165#define NCI_GID_CORE 0x0
166#define NCI_GID_RF_MGMT 0x1
167#define NCI_GID_NFCEE_MGMT 0x2
168#define NCI_GID_PROPRIETARY 0xf
169
170/* ---- NCI Packet structures ---- */
171#define NCI_CTRL_HDR_SIZE 3
172#define NCI_DATA_HDR_SIZE 3
173
174struct nci_ctrl_hdr {
175 __u8 gid; /* MT & PBF & GID */
176 __u8 oid;
177 __u8 plen;
178} __packed;
179
180struct nci_data_hdr {
181 __u8 conn_id; /* MT & PBF & ConnID */
182 __u8 rfu;
183 __u8 plen;
184} __packed;
185
186/* ------------------------ */
187/* ----- NCI Commands ---- */
188/* ------------------------ */
189#define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00)
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200190struct nci_core_reset_cmd {
191 __u8 reset_type;
192} __packed;
Ilan Elias6a2968a2011-09-18 11:19:35 +0300193
194#define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01)
195
196#define NCI_OP_CORE_SET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x02)
197
198#define NCI_OP_CORE_CONN_CREATE_CMD nci_opcode_pack(NCI_GID_CORE, 0x04)
199struct nci_core_conn_create_cmd {
200 __u8 target_handle;
201 __u8 num_target_specific_params;
202} __packed;
203
204#define NCI_OP_CORE_CONN_CLOSE_CMD nci_opcode_pack(NCI_GID_CORE, 0x06)
205
206#define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
207struct disc_map_config {
208 __u8 rf_protocol;
209 __u8 mode;
210 __u8 rf_interface_type;
211} __packed;
212
213struct nci_rf_disc_map_cmd {
214 __u8 num_mapping_configs;
215 struct disc_map_config mapping_configs
216 [NCI_MAX_NUM_MAPPING_CONFIGS];
217} __packed;
218
219#define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
220struct disc_config {
221 __u8 type;
222 __u8 frequency;
223} __packed;
224
225struct nci_rf_disc_cmd {
226 __u8 num_disc_configs;
227 struct disc_config disc_configs[NCI_MAX_NUM_RF_CONFIGS];
228} __packed;
229
230#define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
231struct nci_rf_deactivate_cmd {
232 __u8 type;
233} __packed;
234
235/* ----------------------- */
236/* ---- NCI Responses ---- */
237/* ----------------------- */
238#define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00)
239struct nci_core_reset_rsp {
240 __u8 status;
241 __u8 nci_ver;
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200242 __u8 config_status;
Ilan Elias6a2968a2011-09-18 11:19:35 +0300243} __packed;
244
245#define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01)
246struct nci_core_init_rsp_1 {
247 __u8 status;
248 __le32 nfcc_features;
249 __u8 num_supported_rf_interfaces;
250 __u8 supported_rf_interfaces[0]; /* variable size array */
251 /* continuted in nci_core_init_rsp_2 */
252} __packed;
253
254struct nci_core_init_rsp_2 {
255 __u8 max_logical_connections;
256 __le16 max_routing_table_size;
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200257 __u8 max_ctrl_pkt_payload_len;
258 __le16 max_size_for_large_params;
259 __u8 max_data_pkt_payload_size;
260 __u8 initial_num_credits;
261 __u8 manufact_id;
262 __le32 manufact_specific_info;
Ilan Elias6a2968a2011-09-18 11:19:35 +0300263} __packed;
264
265#define NCI_OP_CORE_SET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x02)
266
267#define NCI_OP_CORE_CONN_CREATE_RSP nci_opcode_pack(NCI_GID_CORE, 0x04)
268struct nci_core_conn_create_rsp {
269 __u8 status;
270 __u8 max_pkt_payload_size;
271 __u8 initial_num_credits;
272 __u8 conn_id;
273} __packed;
274
275#define NCI_OP_CORE_CONN_CLOSE_RSP nci_opcode_pack(NCI_GID_CORE, 0x06)
276
277#define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
278
279#define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
280
281#define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
282
283/* --------------------------- */
284/* ---- NCI Notifications ---- */
285/* --------------------------- */
286#define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x07)
287struct conn_credit_entry {
288 __u8 conn_id;
289 __u8 credits;
290} __packed;
291
292struct nci_core_conn_credit_ntf {
293 __u8 num_entries;
294 struct conn_credit_entry conn_entries[NCI_MAX_NUM_CONN];
295} __packed;
296
297#define NCI_OP_RF_FIELD_INFO_NTF nci_opcode_pack(NCI_GID_CORE, 0x08)
298struct nci_rf_field_info_ntf {
299 __u8 rf_field_status;
300} __packed;
301
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200302#define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05)
Ilan Elias6a2968a2011-09-18 11:19:35 +0300303struct rf_tech_specific_params_nfca_poll {
304 __u16 sens_res;
305 __u8 nfcid1_len; /* 0, 4, 7, or 10 Bytes */
306 __u8 nfcid1[10];
307 __u8 sel_res_len; /* 0 or 1 Bytes */
308 __u8 sel_res;
309} __packed;
310
311struct activation_params_nfca_poll_iso_dep {
312 __u8 rats_res_len;
313 __u8 rats_res[20];
314};
315
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200316struct nci_rf_intf_activated_ntf {
317 __u8 rf_discovery_id;
318 __u8 rf_interface_type;
Ilan Elias6a2968a2011-09-18 11:19:35 +0300319 __u8 rf_protocol;
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200320 __u8 activation_rf_tech_and_mode;
Ilan Elias6a2968a2011-09-18 11:19:35 +0300321 __u8 rf_tech_specific_params_len;
322
323 union {
324 struct rf_tech_specific_params_nfca_poll nfca_poll;
325 } rf_tech_specific_params;
326
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200327 __u8 data_exch_rf_tech_and_mode;
328 __u8 data_exch_tx_bit_rate;
329 __u8 data_exch_rx_bit_rate;
Ilan Elias6a2968a2011-09-18 11:19:35 +0300330 __u8 activation_params_len;
331
332 union {
333 struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep;
334 } activation_params;
335
336} __packed;
337
338#define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
Ilan Eliase8c0dac2011-11-09 12:09:14 +0200339struct nci_rf_deactivate_ntf {
340 __u8 type;
341 __u8 reason;
342} __packed;
Ilan Elias6a2968a2011-09-18 11:19:35 +0300343
344#endif /* __NCI_H */