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_MESSAGE_CORRUPTED 0x02 40 #define NCI_STATUS_BUFFER_FULL 0x03 41 #define NCI_STATUS_FAILED 0x04 42 #define NCI_STATUS_NOT_INITIALIZED 0x05 43 #define NCI_STATUS_SYNTAX_ERROR 0x06 44 #define NCI_STATUS_SEMANTIC_ERROR 0x07 45 #define NCI_STATUS_UNKNOWN_GID 0x08 46 #define NCI_STATUS_UNKNOWN_OID 0x09 47 #define NCI_STATUS_INVALID_PARAM 0x0a 48 #define NCI_STATUS_MESSAGE_SIZE_EXCEEDED 0x0b 49 /* Discovery Specific Status Codes */ 50 #define NCI_STATUS_DISCOVERY_ALREADY_STARTED 0xa0 51 #define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED 0xa1 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 #define NCI_STATUS_RF_LINK_LOSS_ERROR 0xb3 57 /* NFCEE Interface Specific Status Codes */ 58 #define NCI_STATUS_MAX_ACTIVE_NFCEE_INTERFACES_REACHED 0xc0 59 #define NCI_STATUS_NFCEE_INTERFACE_ACTIVATION_FAILED 0xc1 60 #define NCI_STATUS_NFCEE_TRANSMISSION_ERROR 0xc2 61 #define NCI_STATUS_NFCEE_PROTOCOL_ERROR 0xc3 62 #define NCI_STATUS_NFCEE_TIMEOUT_ERROR 0xc4 63 64 /* NCI RF Technology and Mode */ 65 #define NCI_NFC_A_PASSIVE_POLL_MODE 0x00 66 #define NCI_NFC_B_PASSIVE_POLL_MODE 0x01 67 #define NCI_NFC_F_PASSIVE_POLL_MODE 0x02 68 #define NCI_NFC_A_ACTIVE_POLL_MODE 0x03 69 #define NCI_NFC_F_ACTIVE_POLL_MODE 0x05 70 #define NCI_NFC_A_PASSIVE_LISTEN_MODE 0x80 71 #define NCI_NFC_B_PASSIVE_LISTEN_MODE 0x81 72 #define NCI_NFC_F_PASSIVE_LISTEN_MODE 0x82 73 #define NCI_NFC_A_ACTIVE_LISTEN_MODE 0x83 74 #define NCI_NFC_F_ACTIVE_LISTEN_MODE 0x85 75 76 /* NCI RF Protocols */ 77 #define NCI_RF_PROTOCOL_UNKNOWN 0x00 78 #define NCI_RF_PROTOCOL_T1T 0x01 79 #define NCI_RF_PROTOCOL_T2T 0x02 80 #define NCI_RF_PROTOCOL_T3T 0x03 81 #define NCI_RF_PROTOCOL_ISO_DEP 0x04 82 #define NCI_RF_PROTOCOL_NFC_DEP 0x05 83 84 /* NCI RF Interfaces */ 85 #define NCI_RF_INTERFACE_RFU 0x00 86 #define NCI_RF_INTERFACE_FRAME 0x01 87 #define NCI_RF_INTERFACE_ISO_DEP 0x02 88 #define NCI_RF_INTERFACE_NFC_DEP 0x03 89 90 /* NCI RF_DISCOVER_MAP_CMD modes */ 91 #define NCI_DISC_MAP_MODE_POLL 0x01 92 #define NCI_DISC_MAP_MODE_LISTEN 0x02 93 #define NCI_DISC_MAP_MODE_BOTH 0x03 94 95 /* NCI Discovery Types */ 96 #define NCI_DISCOVERY_TYPE_POLL_A_PASSIVE 0x00 97 #define NCI_DISCOVERY_TYPE_POLL_B_PASSIVE 0x01 98 #define NCI_DISCOVERY_TYPE_POLL_F_PASSIVE 0x02 99 #define NCI_DISCOVERY_TYPE_POLL_A_ACTIVE 0x03 100 #define NCI_DISCOVERY_TYPE_POLL_F_ACTIVE 0x05 101 #define NCI_DISCOVERY_TYPE_WAKEUP_A_PASSIVE 0x06 102 #define NCI_DISCOVERY_TYPE_WAKEUP_B_PASSIVE 0x07 103 #define NCI_DISCOVERY_TYPE_WAKEUP_A_ACTIVE 0x09 104 #define NCI_DISCOVERY_TYPE_LISTEN_A_PASSIVE 0x80 105 #define NCI_DISCOVERY_TYPE_LISTEN_B_PASSIVE 0x81 106 #define NCI_DISCOVERY_TYPE_LISTEN_F_PASSIVE 0x82 107 #define NCI_DISCOVERY_TYPE_LISTEN_A_ACTIVE 0x83 108 #define NCI_DISCOVERY_TYPE_LISTEN_F_ACTIVE 0x85 109 110 /* NCI Deactivation Type */ 111 #define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00 112 #define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01 113 #define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02 114 #define NCI_DEACTIVATE_TYPE_RF_LINK_LOSS 0x03 115 #define NCI_DEACTIVATE_TYPE_DISCOVERY_ERROR 0x04 116 117 /* Message Type (MT) */ 118 #define NCI_MT_DATA_PKT 0x00 119 #define NCI_MT_CMD_PKT 0x01 120 #define NCI_MT_RSP_PKT 0x02 121 #define NCI_MT_NTF_PKT 0x03 122 123 #define nci_mt(hdr) (((hdr)[0]>>5)&0x07) 124 #define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5)) 125 126 /* Packet Boundary Flag (PBF) */ 127 #define NCI_PBF_LAST 0x00 128 #define NCI_PBF_CONT 0x01 129 130 #define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01) 131 #define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4)) 132 133 /* Control Opcode manipulation */ 134 #define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)|\ 135 ((__u16)((oid)&0x3f))) 136 #define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1]) 137 #define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8) 138 #define nci_opcode_oid(op) (__u8)((op)&0x003f) 139 140 /* Payload Length */ 141 #define nci_plen(hdr) (__u8)((hdr)[2]) 142 143 /* Connection ID */ 144 #define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f) 145 146 /* GID values */ 147 #define NCI_GID_CORE 0x0 148 #define NCI_GID_RF_MGMT 0x1 149 #define NCI_GID_NFCEE_MGMT 0x2 150 #define NCI_GID_PROPRIETARY 0xf 151 152 /* ---- NCI Packet structures ---- */ 153 #define NCI_CTRL_HDR_SIZE 3 154 #define NCI_DATA_HDR_SIZE 3 155 156 struct nci_ctrl_hdr { 157 __u8 gid; /* MT & PBF & GID */ 158 __u8 oid; 159 __u8 plen; 160 } __packed; 161 162 struct nci_data_hdr { 163 __u8 conn_id; /* MT & PBF & ConnID */ 164 __u8 rfu; 165 __u8 plen; 166 } __packed; 167 168 /* ------------------------ */ 169 /* ----- NCI Commands ---- */ 170 /* ------------------------ */ 171 #define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00) 172 173 #define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01) 174 175 #define NCI_OP_CORE_SET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x02) 176 177 #define NCI_OP_CORE_CONN_CREATE_CMD nci_opcode_pack(NCI_GID_CORE, 0x04) 178 struct nci_core_conn_create_cmd { 179 __u8 target_handle; 180 __u8 num_target_specific_params; 181 } __packed; 182 183 #define NCI_OP_CORE_CONN_CLOSE_CMD nci_opcode_pack(NCI_GID_CORE, 0x06) 184 185 #define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00) 186 struct disc_map_config { 187 __u8 rf_protocol; 188 __u8 mode; 189 __u8 rf_interface_type; 190 } __packed; 191 192 struct nci_rf_disc_map_cmd { 193 __u8 num_mapping_configs; 194 struct disc_map_config mapping_configs 195 [NCI_MAX_NUM_MAPPING_CONFIGS]; 196 } __packed; 197 198 #define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03) 199 struct disc_config { 200 __u8 type; 201 __u8 frequency; 202 } __packed; 203 204 struct nci_rf_disc_cmd { 205 __u8 num_disc_configs; 206 struct disc_config disc_configs[NCI_MAX_NUM_RF_CONFIGS]; 207 } __packed; 208 209 #define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) 210 struct nci_rf_deactivate_cmd { 211 __u8 type; 212 } __packed; 213 214 /* ----------------------- */ 215 /* ---- NCI Responses ---- */ 216 /* ----------------------- */ 217 #define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00) 218 struct nci_core_reset_rsp { 219 __u8 status; 220 __u8 nci_ver; 221 } __packed; 222 223 #define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01) 224 struct nci_core_init_rsp_1 { 225 __u8 status; 226 __le32 nfcc_features; 227 __u8 num_supported_rf_interfaces; 228 __u8 supported_rf_interfaces[0]; /* variable size array */ 229 /* continuted in nci_core_init_rsp_2 */ 230 } __packed; 231 232 struct nci_core_init_rsp_2 { 233 __u8 max_logical_connections; 234 __le16 max_routing_table_size; 235 __u8 max_control_packet_payload_length; 236 __le16 rf_sending_buffer_size; 237 __le16 rf_receiving_buffer_size; 238 __le16 manufacturer_id; 239 } __packed; 240 241 #define NCI_OP_CORE_SET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x02) 242 243 #define NCI_OP_CORE_CONN_CREATE_RSP nci_opcode_pack(NCI_GID_CORE, 0x04) 244 struct nci_core_conn_create_rsp { 245 __u8 status; 246 __u8 max_pkt_payload_size; 247 __u8 initial_num_credits; 248 __u8 conn_id; 249 } __packed; 250 251 #define NCI_OP_CORE_CONN_CLOSE_RSP nci_opcode_pack(NCI_GID_CORE, 0x06) 252 253 #define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00) 254 255 #define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03) 256 257 #define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) 258 259 /* --------------------------- */ 260 /* ---- NCI Notifications ---- */ 261 /* --------------------------- */ 262 #define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x07) 263 struct conn_credit_entry { 264 __u8 conn_id; 265 __u8 credits; 266 } __packed; 267 268 struct nci_core_conn_credit_ntf { 269 __u8 num_entries; 270 struct conn_credit_entry conn_entries[NCI_MAX_NUM_CONN]; 271 } __packed; 272 273 #define NCI_OP_RF_FIELD_INFO_NTF nci_opcode_pack(NCI_GID_CORE, 0x08) 274 struct nci_rf_field_info_ntf { 275 __u8 rf_field_status; 276 } __packed; 277 278 #define NCI_OP_RF_ACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05) 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 292 struct nci_rf_activate_ntf { 293 __u8 target_handle; 294 __u8 rf_protocol; 295 __u8 rf_tech_and_mode; 296 __u8 rf_tech_specific_params_len; 297 298 union { 299 struct rf_tech_specific_params_nfca_poll nfca_poll; 300 } rf_tech_specific_params; 301 302 __u8 rf_interface_type; 303 __u8 activation_params_len; 304 305 union { 306 struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep; 307 } activation_params; 308 309 } __packed; 310 311 #define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06) 312 313 #endif /* __NCI_H */ 314