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, see <http://www.gnu.org/licenses/>. 24 * 25 */ 26 27 #ifndef __NCI_H 28 #define __NCI_H 29 30 /* NCI constants */ 31 #define NCI_MAX_NUM_MAPPING_CONFIGS 10 32 #define NCI_MAX_NUM_RF_CONFIGS 10 33 #define NCI_MAX_NUM_CONN 10 34 #define NCI_MAX_PARAM_LEN 251 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 Configuration Parameter Tags */ 106 #define NCI_PN_ATR_REQ_GEN_BYTES 0x29 107 108 /* NCI Reset types */ 109 #define NCI_RESET_TYPE_KEEP_CONFIG 0x00 110 #define NCI_RESET_TYPE_RESET_CONFIG 0x01 111 112 /* NCI Static RF connection ID */ 113 #define NCI_STATIC_RF_CONN_ID 0x00 114 115 /* NCI Data Flow Control */ 116 #define NCI_DATA_FLOW_CONTROL_NOT_USED 0xff 117 118 /* NCI RF_DISCOVER_MAP_CMD modes */ 119 #define NCI_DISC_MAP_MODE_POLL 0x01 120 #define NCI_DISC_MAP_MODE_LISTEN 0x02 121 122 /* NCI Discover Notification Type */ 123 #define NCI_DISCOVER_NTF_TYPE_LAST 0x00 124 #define NCI_DISCOVER_NTF_TYPE_LAST_NFCC 0x01 125 #define NCI_DISCOVER_NTF_TYPE_MORE 0x02 126 127 /* NCI Deactivation Type */ 128 #define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00 129 #define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01 130 #define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02 131 #define NCI_DEACTIVATE_TYPE_DISCOVERY 0x03 132 133 /* Message Type (MT) */ 134 #define NCI_MT_DATA_PKT 0x00 135 #define NCI_MT_CMD_PKT 0x01 136 #define NCI_MT_RSP_PKT 0x02 137 #define NCI_MT_NTF_PKT 0x03 138 139 #define nci_mt(hdr) (((hdr)[0]>>5)&0x07) 140 #define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5)) 141 142 /* Packet Boundary Flag (PBF) */ 143 #define NCI_PBF_LAST 0x00 144 #define NCI_PBF_CONT 0x01 145 146 #define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01) 147 #define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4)) 148 149 /* Control Opcode manipulation */ 150 #define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)|\ 151 ((__u16)((oid)&0x3f))) 152 #define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1]) 153 #define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8) 154 #define nci_opcode_oid(op) (__u8)((op)&0x003f) 155 156 /* Payload Length */ 157 #define nci_plen(hdr) (__u8)((hdr)[2]) 158 159 /* Connection ID */ 160 #define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f) 161 162 /* GID values */ 163 #define NCI_GID_CORE 0x0 164 #define NCI_GID_RF_MGMT 0x1 165 #define NCI_GID_NFCEE_MGMT 0x2 166 #define NCI_GID_PROPRIETARY 0xf 167 168 /* ----- NCI over SPI head/crc(tail) room needed for outgoing frames ----- */ 169 #define NCI_SPI_HDR_LEN 4 170 #define NCI_SPI_CRC_LEN 2 171 172 /* ---- NCI Packet structures ---- */ 173 #define NCI_CTRL_HDR_SIZE 3 174 #define NCI_DATA_HDR_SIZE 3 175 176 struct nci_ctrl_hdr { 177 __u8 gid; /* MT & PBF & GID */ 178 __u8 oid; 179 __u8 plen; 180 } __packed; 181 182 struct nci_data_hdr { 183 __u8 conn_id; /* MT & PBF & ConnID */ 184 __u8 rfu; 185 __u8 plen; 186 } __packed; 187 188 /* ------------------------ */ 189 /* ----- NCI Commands ---- */ 190 /* ------------------------ */ 191 #define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00) 192 struct nci_core_reset_cmd { 193 __u8 reset_type; 194 } __packed; 195 196 #define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01) 197 198 #define NCI_OP_CORE_SET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x02) 199 struct set_config_param { 200 __u8 id; 201 __u8 len; 202 __u8 val[NCI_MAX_PARAM_LEN]; 203 } __packed; 204 205 struct nci_core_set_config_cmd { 206 __u8 num_params; 207 struct set_config_param param; /* support 1 param per cmd is enough */ 208 } __packed; 209 210 #define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00) 211 struct disc_map_config { 212 __u8 rf_protocol; 213 __u8 mode; 214 __u8 rf_interface; 215 } __packed; 216 217 struct nci_rf_disc_map_cmd { 218 __u8 num_mapping_configs; 219 struct disc_map_config mapping_configs 220 [NCI_MAX_NUM_MAPPING_CONFIGS]; 221 } __packed; 222 223 #define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03) 224 struct disc_config { 225 __u8 rf_tech_and_mode; 226 __u8 frequency; 227 } __packed; 228 229 struct nci_rf_disc_cmd { 230 __u8 num_disc_configs; 231 struct disc_config disc_configs[NCI_MAX_NUM_RF_CONFIGS]; 232 } __packed; 233 234 #define NCI_OP_RF_DISCOVER_SELECT_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x04) 235 struct nci_rf_discover_select_cmd { 236 __u8 rf_discovery_id; 237 __u8 rf_protocol; 238 __u8 rf_interface; 239 } __packed; 240 241 #define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) 242 struct nci_rf_deactivate_cmd { 243 __u8 type; 244 } __packed; 245 246 /* ----------------------- */ 247 /* ---- NCI Responses ---- */ 248 /* ----------------------- */ 249 #define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00) 250 struct nci_core_reset_rsp { 251 __u8 status; 252 __u8 nci_ver; 253 __u8 config_status; 254 } __packed; 255 256 #define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01) 257 struct nci_core_init_rsp_1 { 258 __u8 status; 259 __le32 nfcc_features; 260 __u8 num_supported_rf_interfaces; 261 __u8 supported_rf_interfaces[0]; /* variable size array */ 262 /* continuted in nci_core_init_rsp_2 */ 263 } __packed; 264 265 struct nci_core_init_rsp_2 { 266 __u8 max_logical_connections; 267 __le16 max_routing_table_size; 268 __u8 max_ctrl_pkt_payload_len; 269 __le16 max_size_for_large_params; 270 __u8 manufact_id; 271 __le32 manufact_specific_info; 272 } __packed; 273 274 #define NCI_OP_CORE_SET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x02) 275 struct nci_core_set_config_rsp { 276 __u8 status; 277 __u8 num_params; 278 __u8 params_id[0]; /* variable size array */ 279 } __packed; 280 281 #define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00) 282 283 #define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03) 284 285 #define NCI_OP_RF_DISCOVER_SELECT_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x04) 286 287 #define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) 288 289 /* --------------------------- */ 290 /* ---- NCI Notifications ---- */ 291 /* --------------------------- */ 292 #define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x06) 293 struct conn_credit_entry { 294 __u8 conn_id; 295 __u8 credits; 296 } __packed; 297 298 struct nci_core_conn_credit_ntf { 299 __u8 num_entries; 300 struct conn_credit_entry conn_entries[NCI_MAX_NUM_CONN]; 301 } __packed; 302 303 #define NCI_OP_CORE_GENERIC_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x07) 304 305 #define NCI_OP_CORE_INTF_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x08) 306 struct nci_core_intf_error_ntf { 307 __u8 status; 308 __u8 conn_id; 309 } __packed; 310 311 #define NCI_OP_RF_DISCOVER_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x03) 312 struct rf_tech_specific_params_nfca_poll { 313 __u16 sens_res; 314 __u8 nfcid1_len; /* 0, 4, 7, or 10 Bytes */ 315 __u8 nfcid1[10]; 316 __u8 sel_res_len; /* 0 or 1 Bytes */ 317 __u8 sel_res; 318 } __packed; 319 320 struct rf_tech_specific_params_nfcb_poll { 321 __u8 sensb_res_len; 322 __u8 sensb_res[12]; /* 11 or 12 Bytes */ 323 } __packed; 324 325 struct rf_tech_specific_params_nfcf_poll { 326 __u8 bit_rate; 327 __u8 sensf_res_len; 328 __u8 sensf_res[18]; /* 16 or 18 Bytes */ 329 } __packed; 330 331 struct nci_rf_discover_ntf { 332 __u8 rf_discovery_id; 333 __u8 rf_protocol; 334 __u8 rf_tech_and_mode; 335 __u8 rf_tech_specific_params_len; 336 337 union { 338 struct rf_tech_specific_params_nfca_poll nfca_poll; 339 struct rf_tech_specific_params_nfcb_poll nfcb_poll; 340 struct rf_tech_specific_params_nfcf_poll nfcf_poll; 341 } rf_tech_specific_params; 342 343 __u8 ntf_type; 344 } __packed; 345 346 #define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05) 347 struct activation_params_nfca_poll_iso_dep { 348 __u8 rats_res_len; 349 __u8 rats_res[20]; 350 }; 351 352 struct activation_params_nfcb_poll_iso_dep { 353 __u8 attrib_res_len; 354 __u8 attrib_res[50]; 355 }; 356 357 struct activation_params_poll_nfc_dep { 358 __u8 atr_res_len; 359 __u8 atr_res[63]; 360 }; 361 362 struct nci_rf_intf_activated_ntf { 363 __u8 rf_discovery_id; 364 __u8 rf_interface; 365 __u8 rf_protocol; 366 __u8 activation_rf_tech_and_mode; 367 __u8 max_data_pkt_payload_size; 368 __u8 initial_num_credits; 369 __u8 rf_tech_specific_params_len; 370 371 union { 372 struct rf_tech_specific_params_nfca_poll nfca_poll; 373 struct rf_tech_specific_params_nfcb_poll nfcb_poll; 374 struct rf_tech_specific_params_nfcf_poll nfcf_poll; 375 } rf_tech_specific_params; 376 377 __u8 data_exch_rf_tech_and_mode; 378 __u8 data_exch_tx_bit_rate; 379 __u8 data_exch_rx_bit_rate; 380 __u8 activation_params_len; 381 382 union { 383 struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep; 384 struct activation_params_nfcb_poll_iso_dep nfcb_poll_iso_dep; 385 struct activation_params_poll_nfc_dep poll_nfc_dep; 386 } activation_params; 387 388 } __packed; 389 390 #define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) 391 struct nci_rf_deactivate_ntf { 392 __u8 type; 393 __u8 reason; 394 } __packed; 395 396 #endif /* __NCI_H */ 397