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. | |
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 | |
e8c0dacd IE |
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 | |
6a2968aa IE |
48 | /* Discovery Specific Status Codes */ |
49 | #define NCI_STATUS_DISCOVERY_ALREADY_STARTED 0xa0 | |
50 | #define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED 0xa1 | |
e8c0dacd | 51 | #define NCI_STATUS_DISCOVERY_TEAR_DOWN 0xa2 |
6a2968aa IE |
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 | |
6a2968aa IE |
56 | /* 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 | ||
e8c0dacd IE |
75 | /* 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 | ||
6a2968aa IE |
90 | /* 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 */ | |
e8c0dacd | 99 | #define NCI_RF_INTERFACE_NFCEE_DIRECT 0x00 |
6a2968aa IE |
100 | #define NCI_RF_INTERFACE_FRAME 0x01 |
101 | #define NCI_RF_INTERFACE_ISO_DEP 0x02 | |
102 | #define NCI_RF_INTERFACE_NFC_DEP 0x03 | |
103 | ||
e8c0dacd IE |
104 | /* 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 | ||
db98c829 IE |
111 | /* NCI Data Flow Control */ |
112 | #define NCI_DATA_FLOW_CONTROL_NOT_USED 0xff | |
113 | ||
6a2968aa IE |
114 | /* NCI RF_DISCOVER_MAP_CMD modes */ |
115 | #define NCI_DISC_MAP_MODE_POLL 0x01 | |
116 | #define NCI_DISC_MAP_MODE_LISTEN 0x02 | |
117 | #define NCI_DISC_MAP_MODE_BOTH 0x03 | |
118 | ||
119 | /* NCI Discovery Types */ | |
120 | #define NCI_DISCOVERY_TYPE_POLL_A_PASSIVE 0x00 | |
121 | #define NCI_DISCOVERY_TYPE_POLL_B_PASSIVE 0x01 | |
122 | #define NCI_DISCOVERY_TYPE_POLL_F_PASSIVE 0x02 | |
123 | #define NCI_DISCOVERY_TYPE_POLL_A_ACTIVE 0x03 | |
124 | #define NCI_DISCOVERY_TYPE_POLL_F_ACTIVE 0x05 | |
6a2968aa IE |
125 | #define NCI_DISCOVERY_TYPE_WAKEUP_A_ACTIVE 0x09 |
126 | #define NCI_DISCOVERY_TYPE_LISTEN_A_PASSIVE 0x80 | |
127 | #define NCI_DISCOVERY_TYPE_LISTEN_B_PASSIVE 0x81 | |
128 | #define NCI_DISCOVERY_TYPE_LISTEN_F_PASSIVE 0x82 | |
129 | #define NCI_DISCOVERY_TYPE_LISTEN_A_ACTIVE 0x83 | |
130 | #define NCI_DISCOVERY_TYPE_LISTEN_F_ACTIVE 0x85 | |
131 | ||
132 | /* NCI Deactivation Type */ | |
133 | #define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00 | |
134 | #define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01 | |
135 | #define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02 | |
e8c0dacd | 136 | #define NCI_DEACTIVATE_TYPE_DISCOVERY 0x03 |
6a2968aa IE |
137 | |
138 | /* Message Type (MT) */ | |
139 | #define NCI_MT_DATA_PKT 0x00 | |
140 | #define NCI_MT_CMD_PKT 0x01 | |
141 | #define NCI_MT_RSP_PKT 0x02 | |
142 | #define NCI_MT_NTF_PKT 0x03 | |
143 | ||
144 | #define nci_mt(hdr) (((hdr)[0]>>5)&0x07) | |
145 | #define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5)) | |
146 | ||
147 | /* Packet Boundary Flag (PBF) */ | |
148 | #define NCI_PBF_LAST 0x00 | |
149 | #define NCI_PBF_CONT 0x01 | |
150 | ||
151 | #define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01) | |
152 | #define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4)) | |
153 | ||
154 | /* Control Opcode manipulation */ | |
155 | #define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)|\ | |
156 | ((__u16)((oid)&0x3f))) | |
157 | #define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1]) | |
158 | #define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8) | |
159 | #define nci_opcode_oid(op) (__u8)((op)&0x003f) | |
160 | ||
161 | /* Payload Length */ | |
162 | #define nci_plen(hdr) (__u8)((hdr)[2]) | |
163 | ||
164 | /* Connection ID */ | |
165 | #define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f) | |
166 | ||
167 | /* GID values */ | |
168 | #define NCI_GID_CORE 0x0 | |
169 | #define NCI_GID_RF_MGMT 0x1 | |
170 | #define NCI_GID_NFCEE_MGMT 0x2 | |
171 | #define NCI_GID_PROPRIETARY 0xf | |
172 | ||
173 | /* ---- NCI Packet structures ---- */ | |
174 | #define NCI_CTRL_HDR_SIZE 3 | |
175 | #define NCI_DATA_HDR_SIZE 3 | |
176 | ||
177 | struct nci_ctrl_hdr { | |
178 | __u8 gid; /* MT & PBF & GID */ | |
179 | __u8 oid; | |
180 | __u8 plen; | |
181 | } __packed; | |
182 | ||
183 | struct nci_data_hdr { | |
184 | __u8 conn_id; /* MT & PBF & ConnID */ | |
185 | __u8 rfu; | |
186 | __u8 plen; | |
187 | } __packed; | |
188 | ||
189 | /* ------------------------ */ | |
190 | /* ----- NCI Commands ---- */ | |
191 | /* ------------------------ */ | |
192 | #define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00) | |
e8c0dacd IE |
193 | struct nci_core_reset_cmd { |
194 | __u8 reset_type; | |
195 | } __packed; | |
6a2968aa IE |
196 | |
197 | #define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01) | |
198 | ||
6a2968aa IE |
199 | #define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00) |
200 | struct disc_map_config { | |
201 | __u8 rf_protocol; | |
202 | __u8 mode; | |
203 | __u8 rf_interface_type; | |
204 | } __packed; | |
205 | ||
206 | struct nci_rf_disc_map_cmd { | |
207 | __u8 num_mapping_configs; | |
208 | struct disc_map_config mapping_configs | |
209 | [NCI_MAX_NUM_MAPPING_CONFIGS]; | |
210 | } __packed; | |
211 | ||
212 | #define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03) | |
213 | struct disc_config { | |
214 | __u8 type; | |
215 | __u8 frequency; | |
216 | } __packed; | |
217 | ||
218 | struct nci_rf_disc_cmd { | |
219 | __u8 num_disc_configs; | |
220 | struct disc_config disc_configs[NCI_MAX_NUM_RF_CONFIGS]; | |
221 | } __packed; | |
222 | ||
223 | #define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) | |
224 | struct nci_rf_deactivate_cmd { | |
225 | __u8 type; | |
226 | } __packed; | |
227 | ||
228 | /* ----------------------- */ | |
229 | /* ---- NCI Responses ---- */ | |
230 | /* ----------------------- */ | |
231 | #define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00) | |
232 | struct nci_core_reset_rsp { | |
233 | __u8 status; | |
234 | __u8 nci_ver; | |
e8c0dacd | 235 | __u8 config_status; |
6a2968aa IE |
236 | } __packed; |
237 | ||
238 | #define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01) | |
239 | struct nci_core_init_rsp_1 { | |
240 | __u8 status; | |
241 | __le32 nfcc_features; | |
242 | __u8 num_supported_rf_interfaces; | |
243 | __u8 supported_rf_interfaces[0]; /* variable size array */ | |
244 | /* continuted in nci_core_init_rsp_2 */ | |
245 | } __packed; | |
246 | ||
247 | struct nci_core_init_rsp_2 { | |
248 | __u8 max_logical_connections; | |
249 | __le16 max_routing_table_size; | |
e8c0dacd IE |
250 | __u8 max_ctrl_pkt_payload_len; |
251 | __le16 max_size_for_large_params; | |
252 | __u8 max_data_pkt_payload_size; | |
253 | __u8 initial_num_credits; | |
254 | __u8 manufact_id; | |
255 | __le32 manufact_specific_info; | |
6a2968aa IE |
256 | } __packed; |
257 | ||
6a2968aa IE |
258 | #define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00) |
259 | ||
260 | #define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03) | |
261 | ||
262 | #define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) | |
263 | ||
264 | /* --------------------------- */ | |
265 | /* ---- NCI Notifications ---- */ | |
266 | /* --------------------------- */ | |
267 | #define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x07) | |
268 | struct conn_credit_entry { | |
269 | __u8 conn_id; | |
270 | __u8 credits; | |
271 | } __packed; | |
272 | ||
273 | struct nci_core_conn_credit_ntf { | |
274 | __u8 num_entries; | |
275 | struct conn_credit_entry conn_entries[NCI_MAX_NUM_CONN]; | |
276 | } __packed; | |
6a2968aa | 277 | |
e8c0dacd | 278 | #define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05) |
6a2968aa IE |
279 | struct rf_tech_specific_params_nfca_poll { |
280 | __u16 sens_res; | |
281 | __u8 nfcid1_len; /* 0, 4, 7, or 10 Bytes */ | |
282 | __u8 nfcid1[10]; | |
283 | __u8 sel_res_len; /* 0 or 1 Bytes */ | |
284 | __u8 sel_res; | |
285 | } __packed; | |
286 | ||
287 | struct activation_params_nfca_poll_iso_dep { | |
288 | __u8 rats_res_len; | |
289 | __u8 rats_res[20]; | |
290 | }; | |
291 | ||
e8c0dacd IE |
292 | struct nci_rf_intf_activated_ntf { |
293 | __u8 rf_discovery_id; | |
294 | __u8 rf_interface_type; | |
6a2968aa | 295 | __u8 rf_protocol; |
e8c0dacd | 296 | __u8 activation_rf_tech_and_mode; |
6a2968aa IE |
297 | __u8 rf_tech_specific_params_len; |
298 | ||
299 | union { | |
300 | struct rf_tech_specific_params_nfca_poll nfca_poll; | |
301 | } rf_tech_specific_params; | |
302 | ||
e8c0dacd IE |
303 | __u8 data_exch_rf_tech_and_mode; |
304 | __u8 data_exch_tx_bit_rate; | |
305 | __u8 data_exch_rx_bit_rate; | |
6a2968aa IE |
306 | __u8 activation_params_len; |
307 | ||
308 | union { | |
309 | struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep; | |
310 | } activation_params; | |
311 | ||
312 | } __packed; | |
313 | ||
314 | #define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) | |
e8c0dacd IE |
315 | struct nci_rf_deactivate_ntf { |
316 | __u8 type; | |
317 | __u8 reason; | |
318 | } __packed; | |
6a2968aa IE |
319 | |
320 | #endif /* __NCI_H */ |