Pileus Git - ~andy/linux/blob - include/uapi/linux/nfc.h

   1 /*
   2  * Copyright (C) 2011 Instituto Nokia de Tecnologia
   3  *
   4  * Authors:
   5  *    Lauro Ramos Venancio <lauro.venancio@openbossa.org>
   6  *    Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the
  20  * Free Software Foundation, Inc.,
  21  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __LINUX_NFC_H
  25 #define __LINUX_NFC_H
  26
  27 #include <linux/types.h>
  28 #include <linux/socket.h>
  29
  30 #define NFC_GENL_NAME "nfc"
  31 #define NFC_GENL_VERSION 1
  32
  33 #define NFC_GENL_MCAST_EVENT_NAME "events"
  34
  35 /**
  36  * enum nfc_commands - supported nfc commands
  37  *
  38  * @NFC_CMD_UNSPEC: unspecified command
  39  *
  40  * @NFC_CMD_GET_DEVICE: request information about a device (requires
  41  *      %NFC_ATTR_DEVICE_INDEX) or dump request to get a list of all nfc devices
  42  * @NFC_CMD_DEV_UP: turn on the nfc device
  43  *      (requires %NFC_ATTR_DEVICE_INDEX)
  44  * @NFC_CMD_DEV_DOWN: turn off the nfc device
  45  *      (requires %NFC_ATTR_DEVICE_INDEX)
  46  * @NFC_CMD_START_POLL: start polling for targets using the given protocols
  47  *      (requires %NFC_ATTR_DEVICE_INDEX and %NFC_ATTR_PROTOCOLS)
  48  * @NFC_CMD_STOP_POLL: stop polling for targets (requires
  49  *      %NFC_ATTR_DEVICE_INDEX)
  50  * @NFC_CMD_GET_TARGET: dump all targets found by the previous poll (requires
  51  *      %NFC_ATTR_DEVICE_INDEX)
  52  * @NFC_EVENT_TARGETS_FOUND: event emitted when a new target is found
  53  *      (it sends %NFC_ATTR_DEVICE_INDEX)
  54  * @NFC_EVENT_DEVICE_ADDED: event emitted when a new device is registred
  55  *      (it sends %NFC_ATTR_DEVICE_NAME, %NFC_ATTR_DEVICE_INDEX and
  56  *      %NFC_ATTR_PROTOCOLS)
  57  * @NFC_EVENT_DEVICE_REMOVED: event emitted when a device is removed
  58  *      (it sends %NFC_ATTR_DEVICE_INDEX)
  59  * @NFC_EVENT_TM_ACTIVATED: event emitted when the adapter is activated in
  60  *      target mode.
  61  * @NFC_EVENT_DEVICE_DEACTIVATED: event emitted when the adapter is deactivated
  62  *      from target mode.
  63  * @NFC_CMD_LLC_GET_PARAMS: request LTO, RW, and MIUX parameters for a device
  64  * @NFC_CMD_LLC_SET_PARAMS: set one or more of LTO, RW, and MIUX parameters for
  65  *      a device. LTO must be set before the link is up otherwise -EINPROGRESS
  66  *      is returned. RW and MIUX can be set at anytime and will be passed in
  67  *      subsequent CONNECT and CC messages.
  68  *      If one of the passed parameters is wrong none is set and -EINVAL is
  69  *      returned.
  70  */
  71 enum nfc_commands {
  72         NFC_CMD_UNSPEC,
  73         NFC_CMD_GET_DEVICE,
  74         NFC_CMD_DEV_UP,
  75         NFC_CMD_DEV_DOWN,
  76         NFC_CMD_DEP_LINK_UP,
  77         NFC_CMD_DEP_LINK_DOWN,
  78         NFC_CMD_START_POLL,
  79         NFC_CMD_STOP_POLL,
  80         NFC_CMD_GET_TARGET,
  81         NFC_EVENT_TARGETS_FOUND,
  82         NFC_EVENT_DEVICE_ADDED,
  83         NFC_EVENT_DEVICE_REMOVED,
  84         NFC_EVENT_TARGET_LOST,
  85         NFC_EVENT_TM_ACTIVATED,
  86         NFC_EVENT_TM_DEACTIVATED,
  87         NFC_CMD_LLC_GET_PARAMS,
  88         NFC_CMD_LLC_SET_PARAMS,
  89 /* private: internal use only */
  90         __NFC_CMD_AFTER_LAST
  91 };
  92 #define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1)
  93
  94 /**
  95  * enum nfc_attrs - supported nfc attributes
  96  *
  97  * @NFC_ATTR_UNSPEC: unspecified attribute
  98  *
  99  * @NFC_ATTR_DEVICE_INDEX: index of nfc device
 100  * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars
 101  * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from
 102  *      NFC_PROTO_*_MASK constants
 103  * @NFC_ATTR_TARGET_INDEX: index of the nfc target
 104  * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID
 105  * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the
 106  *      target is not NFC-Forum compliant)
 107  * @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes
 108  * @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes
 109  * @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes
 110  * @NFC_ATTR_COMM_MODE: Passive or active mode
 111  * @NFC_ATTR_RF_MODE: Initiator or target
 112  * @NFC_ATTR_IM_PROTOCOLS: Initiator mode protocols to poll for
 113  * @NFC_ATTR_TM_PROTOCOLS: Target mode protocols to listen for
 114  * @NFC_ATTR_LLC_PARAM_LTO: Link TimeOut parameter
 115  * @NFC_ATTR_LLC_PARAM_RW: Receive Window size parameter
 116  * @NFC_ATTR_LLC_PARAM_MIUX: MIU eXtension parameter
 117  */
 118 enum nfc_attrs {
 119         NFC_ATTR_UNSPEC,
 120         NFC_ATTR_DEVICE_INDEX,
 121         NFC_ATTR_DEVICE_NAME,
 122         NFC_ATTR_PROTOCOLS,
 123         NFC_ATTR_TARGET_INDEX,
 124         NFC_ATTR_TARGET_SENS_RES,
 125         NFC_ATTR_TARGET_SEL_RES,
 126         NFC_ATTR_TARGET_NFCID1,
 127         NFC_ATTR_TARGET_SENSB_RES,
 128         NFC_ATTR_TARGET_SENSF_RES,
 129         NFC_ATTR_COMM_MODE,
 130         NFC_ATTR_RF_MODE,
 131         NFC_ATTR_DEVICE_POWERED,
 132         NFC_ATTR_IM_PROTOCOLS,
 133         NFC_ATTR_TM_PROTOCOLS,
 134         NFC_ATTR_LLC_PARAM_LTO,
 135         NFC_ATTR_LLC_PARAM_RW,
 136         NFC_ATTR_LLC_PARAM_MIUX,
 137 /* private: internal use only */
 138         __NFC_ATTR_AFTER_LAST
 139 };
 140 #define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1)
 141
 142 #define NFC_DEVICE_NAME_MAXSIZE 8
 143 #define NFC_NFCID1_MAXSIZE 10
 144 #define NFC_SENSB_RES_MAXSIZE 12
 145 #define NFC_SENSF_RES_MAXSIZE 18
 146 #define NFC_GB_MAXSIZE        48
 147
 148 /* NFC protocols */
 149 #define NFC_PROTO_JEWEL         1
 150 #define NFC_PROTO_MIFARE        2
 151 #define NFC_PROTO_FELICA        3
 152 #define NFC_PROTO_ISO14443      4
 153 #define NFC_PROTO_NFC_DEP       5
 154 #define NFC_PROTO_ISO14443_B    6
 155
 156 #define NFC_PROTO_MAX           7
 157
 158 /* NFC communication modes */
 159 #define NFC_COMM_ACTIVE  0
 160 #define NFC_COMM_PASSIVE 1
 161
 162 /* NFC RF modes */
 163 #define NFC_RF_INITIATOR 0
 164 #define NFC_RF_TARGET    1
 165 #define NFC_RF_NONE      2
 166
 167 /* NFC protocols masks used in bitsets */
 168 #define NFC_PROTO_JEWEL_MASK      (1 << NFC_PROTO_JEWEL)
 169 #define NFC_PROTO_MIFARE_MASK     (1 << NFC_PROTO_MIFARE)
 170 #define NFC_PROTO_FELICA_MASK     (1 << NFC_PROTO_FELICA)
 171 #define NFC_PROTO_ISO14443_MASK   (1 << NFC_PROTO_ISO14443)
 172 #define NFC_PROTO_NFC_DEP_MASK    (1 << NFC_PROTO_NFC_DEP)
 173 #define NFC_PROTO_ISO14443_B_MASK (1 << NFC_PROTO_ISO14443_B)
 174
 175 struct sockaddr_nfc {
 176         sa_family_t sa_family;
 177         __u32 dev_idx;
 178         __u32 target_idx;
 179         __u32 nfc_protocol;
 180 };
 181
 182 #define NFC_LLCP_MAX_SERVICE_NAME 63
 183 struct sockaddr_nfc_llcp {
 184         sa_family_t sa_family;
 185         __u32 dev_idx;
 186         __u32 target_idx;
 187         __u32 nfc_protocol;
 188         __u8 dsap; /* Destination SAP, if known */
 189         __u8 ssap; /* Source SAP to be bound to */
 190         char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */;
 191         size_t service_name_len;
 192 };
 193
 194 /* NFC socket protocols */
 195 #define NFC_SOCKPROTO_RAW       0
 196 #define NFC_SOCKPROTO_LLCP      1
 197 #define NFC_SOCKPROTO_MAX       2
 198
 199 #define NFC_HEADER_SIZE 1
 200
 201 /**
 202  * Pseudo-header info for raw socket packets
 203  * First byte is the adapter index
 204  * Second byte contains flags
 205  *  - 0x01 - Direction (0=RX, 1=TX)
 206  *  - 0x02-0x80 - Reserved
 207  **/
 208 #define NFC_LLCP_RAW_HEADER_SIZE        2
 209 #define NFC_LLCP_DIRECTION_RX           0x00
 210 #define NFC_LLCP_DIRECTION_TX           0x01
 211
 212 #endif /*__LINUX_NFC_H */