LXR linux/include/net/nfc/nci.h

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