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