include/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  */
  60 enum nfc_commands {
  61         NFC_CMD_UNSPEC,
  62         NFC_CMD_GET_DEVICE,
  63         NFC_CMD_DEV_UP,
  64         NFC_CMD_DEV_DOWN,
  65         NFC_CMD_DEP_LINK_UP,
  66         NFC_CMD_DEP_LINK_DOWN,
  67         NFC_CMD_START_POLL,
  68         NFC_CMD_STOP_POLL,
  69         NFC_CMD_GET_TARGET,
  70         NFC_EVENT_TARGETS_FOUND,
  71         NFC_EVENT_DEVICE_ADDED,
  72         NFC_EVENT_DEVICE_REMOVED,
  73         NFC_EVENT_TARGET_LOST,
  74 /* private: internal use only */
  75         __NFC_CMD_AFTER_LAST
  76 };
  77 #define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1)
  78
  79 /**
  80  * enum nfc_attrs - supported nfc attributes
  81  *
  82  * @NFC_ATTR_UNSPEC: unspecified attribute
  83  *
  84  * @NFC_ATTR_DEVICE_INDEX: index of nfc device
  85  * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars
  86  * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from
  87  *      NFC_PROTO_*_MASK constants
  88  * @NFC_ATTR_TARGET_INDEX: index of the nfc target
  89  * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID
  90  * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the
  91  *      target is not NFC-Forum compliant)
  92  * @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes
  93  * @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes
  94  * @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes
  95  * @NFC_ATTR_COMM_MODE: Passive or active mode
  96  * @NFC_ATTR_RF_MODE: Initiator or target
  97  */
  98 enum nfc_attrs {
  99         NFC_ATTR_UNSPEC,
 100         NFC_ATTR_DEVICE_INDEX,
 101         NFC_ATTR_DEVICE_NAME,
 102         NFC_ATTR_PROTOCOLS,
 103         NFC_ATTR_TARGET_INDEX,
 104         NFC_ATTR_TARGET_SENS_RES,
 105         NFC_ATTR_TARGET_SEL_RES,
 106         NFC_ATTR_TARGET_NFCID1,
 107         NFC_ATTR_TARGET_SENSB_RES,
 108         NFC_ATTR_TARGET_SENSF_RES,
 109         NFC_ATTR_COMM_MODE,
 110         NFC_ATTR_RF_MODE,
 111         NFC_ATTR_DEVICE_POWERED,
 112 /* private: internal use only */
 113         __NFC_ATTR_AFTER_LAST
 114 };
 115 #define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1)
 116
 117 #define NFC_DEVICE_NAME_MAXSIZE 8
 118 #define NFC_NFCID1_MAXSIZE 10
 119 #define NFC_SENSB_RES_MAXSIZE 12
 120 #define NFC_SENSF_RES_MAXSIZE 18
 121
 122 /* NFC protocols */
 123 #define NFC_PROTO_JEWEL         1
 124 #define NFC_PROTO_MIFARE        2
 125 #define NFC_PROTO_FELICA        3
 126 #define NFC_PROTO_ISO14443      4
 127 #define NFC_PROTO_NFC_DEP       5
 128
 129 #define NFC_PROTO_MAX           6
 130
 131 /* NFC communication modes */
 132 #define NFC_COMM_ACTIVE  0
 133 #define NFC_COMM_PASSIVE 1
 134
 135 /* NFC RF modes */
 136 #define NFC_RF_INITIATOR 0
 137 #define NFC_RF_TARGET    1
 138
 139 /* NFC protocols masks used in bitsets */
 140 #define NFC_PROTO_JEWEL_MASK    (1 << NFC_PROTO_JEWEL)
 141 #define NFC_PROTO_MIFARE_MASK   (1 << NFC_PROTO_MIFARE)
 142 #define NFC_PROTO_FELICA_MASK   (1 << NFC_PROTO_FELICA)
 143 #define NFC_PROTO_ISO14443_MASK (1 << NFC_PROTO_ISO14443)
 144 #define NFC_PROTO_NFC_DEP_MASK  (1 << NFC_PROTO_NFC_DEP)
 145
 146 struct sockaddr_nfc {
 147         sa_family_t sa_family;
 148         __u32 dev_idx;
 149         __u32 target_idx;
 150         __u32 nfc_protocol;
 151 };
 152
 153 #define NFC_LLCP_MAX_SERVICE_NAME 63
 154 struct sockaddr_nfc_llcp {
 155         sa_family_t sa_family;
 156         __u32 dev_idx;
 157         __u32 target_idx;
 158         __u32 nfc_protocol;
 159         __u8 dsap; /* Destination SAP, if known */
 160         __u8 ssap; /* Source SAP to be bound to */
 161         char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */;
 162         size_t service_name_len;
 163 };
 164
 165 /* NFC socket protocols */
 166 #define NFC_SOCKPROTO_RAW       0
 167 #define NFC_SOCKPROTO_LLCP      1
 168 #define NFC_SOCKPROTO_MAX       2
 169
 170 #define NFC_HEADER_SIZE 1
 171
 172 #endif /*__LINUX_NFC_H */