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 * Permission to use, copy, modify, and/or distribute this software for any 9 * purpose with or without fee is hereby granted, provided that the above 10 * copyright notice and this permission notice appear in all copies. 11 * 12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 15 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 16 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 17 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 18 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 19 */ 20 21#ifndef __LINUX_NFC_H 22#define __LINUX_NFC_H 23 24#include <linux/types.h> 25#include <linux/socket.h> 26 27#define NFC_GENL_NAME "nfc" 28#define NFC_GENL_VERSION 1 29 30#define NFC_GENL_MCAST_EVENT_NAME "events" 31 32/** 33 * enum nfc_commands - supported nfc commands 34 * 35 * @NFC_CMD_UNSPEC: unspecified command 36 * 37 * @NFC_CMD_GET_DEVICE: request information about a device (requires 38 * %NFC_ATTR_DEVICE_INDEX) or dump request to get a list of all nfc devices 39 * @NFC_CMD_DEV_UP: turn on the nfc device 40 * (requires %NFC_ATTR_DEVICE_INDEX) 41 * @NFC_CMD_DEV_DOWN: turn off the nfc device 42 * (requires %NFC_ATTR_DEVICE_INDEX) 43 * @NFC_CMD_START_POLL: start polling for targets using the given protocols 44 * (requires %NFC_ATTR_DEVICE_INDEX and %NFC_ATTR_PROTOCOLS) 45 * @NFC_CMD_STOP_POLL: stop polling for targets (requires 46 * %NFC_ATTR_DEVICE_INDEX) 47 * @NFC_CMD_GET_TARGET: dump all targets found by the previous poll (requires 48 * %NFC_ATTR_DEVICE_INDEX) 49 * @NFC_EVENT_TARGETS_FOUND: event emitted when a new target is found 50 * (it sends %NFC_ATTR_DEVICE_INDEX) 51 * @NFC_EVENT_DEVICE_ADDED: event emitted when a new device is registred 52 * (it sends %NFC_ATTR_DEVICE_NAME, %NFC_ATTR_DEVICE_INDEX and 53 * %NFC_ATTR_PROTOCOLS) 54 * @NFC_EVENT_DEVICE_REMOVED: event emitted when a device is removed 55 * (it sends %NFC_ATTR_DEVICE_INDEX) 56 * @NFC_EVENT_TM_ACTIVATED: event emitted when the adapter is activated in 57 * target mode. 58 * @NFC_EVENT_DEVICE_DEACTIVATED: event emitted when the adapter is deactivated 59 * from target mode. 60 * @NFC_CMD_LLC_GET_PARAMS: request LTO, RW, and MIUX parameters for a device 61 * @NFC_CMD_LLC_SET_PARAMS: set one or more of LTO, RW, and MIUX parameters for 62 * a device. LTO must be set before the link is up otherwise -EINPROGRESS 63 * is returned. RW and MIUX can be set at anytime and will be passed in 64 * subsequent CONNECT and CC messages. 65 * If one of the passed parameters is wrong none is set and -EINVAL is 66 * returned. 67 * @NFC_CMD_ENABLE_SE: Enable the physical link to a specific secure element. 68 * Once enabled a secure element will handle card emulation mode, i.e. 69 * starting a poll from a device which has a secure element enabled means 70 * we want to do SE based card emulation. 71 * @NFC_CMD_DISABLE_SE: Disable the physical link to a specific secure element. 72 * @NFC_CMD_FW_DOWNLOAD: Request to Load/flash firmware, or event to inform 73 * that some firmware was loaded 74 * @NFC_EVENT_SE_ADDED: Event emitted when a new secure element is discovered. 75 * This typically will be sent whenever a new NFC controller with either 76 * an embedded SE or an UICC one connected to it through SWP. 77 * @NFC_EVENT_SE_REMOVED: Event emitted when a secure element is removed from 78 * the system, as a consequence of e.g. an NFC controller being unplugged. 79 * @NFC_EVENT_SE_CONNECTIVITY: This event is emitted whenever a secure element 80 * is requesting connectivity access. For example a UICC SE may need to 81 * talk with a sleeping modem and will notify this need by sending this 82 * event. It is then up to userspace to decide if it will wake the modem 83 * up or not. 84 * @NFC_EVENT_SE_TRANSACTION: This event is sent when an application running on 85 * a specific SE notifies us about the end of a transaction. The parameter 86 * for this event is the application ID (AID). 87 * @NFC_CMD_GET_SE: Dump all discovered secure elements from an NFC controller. 88 * @NFC_CMD_SE_IO: Send/Receive APDUs to/from the selected secure element. 89 */ 90enum nfc_commands { 91 NFC_CMD_UNSPEC, 92 NFC_CMD_GET_DEVICE, 93 NFC_CMD_DEV_UP, 94 NFC_CMD_DEV_DOWN, 95 NFC_CMD_DEP_LINK_UP, 96 NFC_CMD_DEP_LINK_DOWN, 97 NFC_CMD_START_POLL, 98 NFC_CMD_STOP_POLL, 99 NFC_CMD_GET_TARGET, 100 NFC_EVENT_TARGETS_FOUND, 101 NFC_EVENT_DEVICE_ADDED, 102 NFC_EVENT_DEVICE_REMOVED, 103 NFC_EVENT_TARGET_LOST, 104 NFC_EVENT_TM_ACTIVATED, 105 NFC_EVENT_TM_DEACTIVATED, 106 NFC_CMD_LLC_GET_PARAMS, 107 NFC_CMD_LLC_SET_PARAMS, 108 NFC_CMD_ENABLE_SE, 109 NFC_CMD_DISABLE_SE, 110 NFC_CMD_LLC_SDREQ, 111 NFC_EVENT_LLC_SDRES, 112 NFC_CMD_FW_DOWNLOAD, 113 NFC_EVENT_SE_ADDED, 114 NFC_EVENT_SE_REMOVED, 115 NFC_EVENT_SE_CONNECTIVITY, 116 NFC_EVENT_SE_TRANSACTION, 117 NFC_CMD_GET_SE, 118 NFC_CMD_SE_IO, 119/* private: internal use only */ 120 __NFC_CMD_AFTER_LAST 121}; 122#define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1) 123 124/** 125 * enum nfc_attrs - supported nfc attributes 126 * 127 * @NFC_ATTR_UNSPEC: unspecified attribute 128 * 129 * @NFC_ATTR_DEVICE_INDEX: index of nfc device 130 * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars 131 * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from 132 * NFC_PROTO_*_MASK constants 133 * @NFC_ATTR_TARGET_INDEX: index of the nfc target 134 * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID 135 * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the 136 * target is not NFC-Forum compliant) 137 * @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes 138 * @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes 139 * @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes 140 * @NFC_ATTR_COMM_MODE: Passive or active mode 141 * @NFC_ATTR_RF_MODE: Initiator or target 142 * @NFC_ATTR_IM_PROTOCOLS: Initiator mode protocols to poll for 143 * @NFC_ATTR_TM_PROTOCOLS: Target mode protocols to listen for 144 * @NFC_ATTR_LLC_PARAM_LTO: Link TimeOut parameter 145 * @NFC_ATTR_LLC_PARAM_RW: Receive Window size parameter 146 * @NFC_ATTR_LLC_PARAM_MIUX: MIU eXtension parameter 147 * @NFC_ATTR_SE: Available Secure Elements 148 * @NFC_ATTR_FIRMWARE_NAME: Free format firmware version 149 * @NFC_ATTR_SE_INDEX: Secure element index 150 * @NFC_ATTR_SE_TYPE: Secure element type (UICC or EMBEDDED) 151 * @NFC_ATTR_FIRMWARE_DOWNLOAD_STATUS: Firmware download operation status 152 * @NFC_ATTR_APDU: Secure element APDU 153 * @NFC_ATTR_TARGET_ISO15693_DSFID: ISO 15693 Data Storage Format Identifier 154 * @NFC_ATTR_TARGET_ISO15693_UID: ISO 15693 Unique Identifier 155 */ 156enum nfc_attrs { 157 NFC_ATTR_UNSPEC, 158 NFC_ATTR_DEVICE_INDEX, 159 NFC_ATTR_DEVICE_NAME, 160 NFC_ATTR_PROTOCOLS, 161 NFC_ATTR_TARGET_INDEX, 162 NFC_ATTR_TARGET_SENS_RES, 163 NFC_ATTR_TARGET_SEL_RES, 164 NFC_ATTR_TARGET_NFCID1, 165 NFC_ATTR_TARGET_SENSB_RES, 166 NFC_ATTR_TARGET_SENSF_RES, 167 NFC_ATTR_COMM_MODE, 168 NFC_ATTR_RF_MODE, 169 NFC_ATTR_DEVICE_POWERED, 170 NFC_ATTR_IM_PROTOCOLS, 171 NFC_ATTR_TM_PROTOCOLS, 172 NFC_ATTR_LLC_PARAM_LTO, 173 NFC_ATTR_LLC_PARAM_RW, 174 NFC_ATTR_LLC_PARAM_MIUX, 175 NFC_ATTR_SE, 176 NFC_ATTR_LLC_SDP, 177 NFC_ATTR_FIRMWARE_NAME, 178 NFC_ATTR_SE_INDEX, 179 NFC_ATTR_SE_TYPE, 180 NFC_ATTR_SE_AID, 181 NFC_ATTR_FIRMWARE_DOWNLOAD_STATUS, 182 NFC_ATTR_SE_APDU, 183 NFC_ATTR_TARGET_ISO15693_DSFID, 184 NFC_ATTR_TARGET_ISO15693_UID, 185/* private: internal use only */ 186 __NFC_ATTR_AFTER_LAST 187}; 188#define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1) 189 190enum nfc_sdp_attr { 191 NFC_SDP_ATTR_UNSPEC, 192 NFC_SDP_ATTR_URI, 193 NFC_SDP_ATTR_SAP, 194/* private: internal use only */ 195 __NFC_SDP_ATTR_AFTER_LAST 196}; 197#define NFC_SDP_ATTR_MAX (__NFC_SDP_ATTR_AFTER_LAST - 1) 198 199#define NFC_DEVICE_NAME_MAXSIZE 8 200#define NFC_NFCID1_MAXSIZE 10 201#define NFC_NFCID2_MAXSIZE 8 202#define NFC_NFCID3_MAXSIZE 10 203#define NFC_SENSB_RES_MAXSIZE 12 204#define NFC_SENSF_RES_MAXSIZE 18 205#define NFC_GB_MAXSIZE 48 206#define NFC_FIRMWARE_NAME_MAXSIZE 32 207#define NFC_ISO15693_UID_MAXSIZE 8 208 209/* NFC protocols */ 210#define NFC_PROTO_JEWEL 1 211#define NFC_PROTO_MIFARE 2 212#define NFC_PROTO_FELICA 3 213#define NFC_PROTO_ISO14443 4 214#define NFC_PROTO_NFC_DEP 5 215#define NFC_PROTO_ISO14443_B 6 216#define NFC_PROTO_ISO15693 7 217 218#define NFC_PROTO_MAX 8 219 220/* NFC communication modes */ 221#define NFC_COMM_ACTIVE 0 222#define NFC_COMM_PASSIVE 1 223 224/* NFC RF modes */ 225#define NFC_RF_INITIATOR 0 226#define NFC_RF_TARGET 1 227#define NFC_RF_NONE 2 228 229/* NFC protocols masks used in bitsets */ 230#define NFC_PROTO_JEWEL_MASK (1 << NFC_PROTO_JEWEL) 231#define NFC_PROTO_MIFARE_MASK (1 << NFC_PROTO_MIFARE) 232#define NFC_PROTO_FELICA_MASK (1 << NFC_PROTO_FELICA) 233#define NFC_PROTO_ISO14443_MASK (1 << NFC_PROTO_ISO14443) 234#define NFC_PROTO_NFC_DEP_MASK (1 << NFC_PROTO_NFC_DEP) 235#define NFC_PROTO_ISO14443_B_MASK (1 << NFC_PROTO_ISO14443_B) 236#define NFC_PROTO_ISO15693_MASK (1 << NFC_PROTO_ISO15693) 237 238/* NFC Secure Elements */ 239#define NFC_SE_UICC 0x1 240#define NFC_SE_EMBEDDED 0x2 241 242#define NFC_SE_DISABLED 0x0 243#define NFC_SE_ENABLED 0x1 244 245struct sockaddr_nfc { 246 sa_family_t sa_family; 247 __u32 dev_idx; 248 __u32 target_idx; 249 __u32 nfc_protocol; 250}; 251 252#define NFC_LLCP_MAX_SERVICE_NAME 63 253struct sockaddr_nfc_llcp { 254 sa_family_t sa_family; 255 __u32 dev_idx; 256 __u32 target_idx; 257 __u32 nfc_protocol; 258 __u8 dsap; /* Destination SAP, if known */ 259 __u8 ssap; /* Source SAP to be bound to */ 260 char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */; 261 size_t service_name_len; 262}; 263 264/* NFC socket protocols */ 265#define NFC_SOCKPROTO_RAW 0 266#define NFC_SOCKPROTO_LLCP 1 267#define NFC_SOCKPROTO_MAX 2 268 269#define NFC_HEADER_SIZE 1 270 271/** 272 * Pseudo-header info for raw socket packets 273 * First byte is the adapter index 274 * Second byte contains flags 275 * - 0x01 - Direction (0=RX, 1=TX) 276 * - 0x02-0x04 - Payload type (000=LLCP, 001=NCI, 010=HCI, 011=Digital, 277 * 100=Proprietary) 278 * - 0x05-0x80 - Reserved 279 **/ 280#define NFC_RAW_HEADER_SIZE 2 281#define NFC_DIRECTION_RX 0x00 282#define NFC_DIRECTION_TX 0x01 283 284#define RAW_PAYLOAD_LLCP 0 285#define RAW_PAYLOAD_NCI 1 286#define RAW_PAYLOAD_HCI 2 287#define RAW_PAYLOAD_DIGITAL 3 288#define RAW_PAYLOAD_PROPRIETARY 4 289 290/* socket option names */ 291#define NFC_LLCP_RW 0 292#define NFC_LLCP_MIUX 1 293#define NFC_LLCP_REMOTE_MIU 2 294#define NFC_LLCP_REMOTE_LTO 3 295#define NFC_LLCP_REMOTE_RW 4 296 297#endif /*__LINUX_NFC_H */ 298