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 */ 75enum nfc_commands { 76 NFC_CMD_UNSPEC, 77 NFC_CMD_GET_DEVICE, 78 NFC_CMD_DEV_UP, 79 NFC_CMD_DEV_DOWN, 80 NFC_CMD_DEP_LINK_UP, 81 NFC_CMD_DEP_LINK_DOWN, 82 NFC_CMD_START_POLL, 83 NFC_CMD_STOP_POLL, 84 NFC_CMD_GET_TARGET, 85 NFC_EVENT_TARGETS_FOUND, 86 NFC_EVENT_DEVICE_ADDED, 87 NFC_EVENT_DEVICE_REMOVED, 88 NFC_EVENT_TARGET_LOST, 89 NFC_EVENT_TM_ACTIVATED, 90 NFC_EVENT_TM_DEACTIVATED, 91 NFC_CMD_LLC_GET_PARAMS, 92 NFC_CMD_LLC_SET_PARAMS, 93 NFC_CMD_ENABLE_SE, 94 NFC_CMD_DISABLE_SE, 95 NFC_CMD_LLC_SDREQ, 96 NFC_EVENT_LLC_SDRES, 97 NFC_CMD_FW_DOWNLOAD, 98 NFC_EVENT_SE_ADDED, 99 NFC_EVENT_SE_REMOVED, 100/* private: internal use only */ 101 __NFC_CMD_AFTER_LAST 102}; 103#define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1) 104 105/** 106 * enum nfc_attrs - supported nfc attributes 107 * 108 * @NFC_ATTR_UNSPEC: unspecified attribute 109 * 110 * @NFC_ATTR_DEVICE_INDEX: index of nfc device 111 * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars 112 * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from 113 * NFC_PROTO_*_MASK constants 114 * @NFC_ATTR_TARGET_INDEX: index of the nfc target 115 * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID 116 * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the 117 * target is not NFC-Forum compliant) 118 * @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes 119 * @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes 120 * @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes 121 * @NFC_ATTR_COMM_MODE: Passive or active mode 122 * @NFC_ATTR_RF_MODE: Initiator or target 123 * @NFC_ATTR_IM_PROTOCOLS: Initiator mode protocols to poll for 124 * @NFC_ATTR_TM_PROTOCOLS: Target mode protocols to listen for 125 * @NFC_ATTR_LLC_PARAM_LTO: Link TimeOut parameter 126 * @NFC_ATTR_LLC_PARAM_RW: Receive Window size parameter 127 * @NFC_ATTR_LLC_PARAM_MIUX: MIU eXtension parameter 128 * @NFC_ATTR_SE: Available Secure Elements 129 * @NFC_ATTR_FIRMWARE_NAME: Free format firmware version 130 * @NFC_ATTR_SE_INDEX: Secure element index 131 * @NFC_ATTR_SE_TYPE: Secure element type (UICC or EMBEDDED) 132 */ 133enum nfc_attrs { 134 NFC_ATTR_UNSPEC, 135 NFC_ATTR_DEVICE_INDEX, 136 NFC_ATTR_DEVICE_NAME, 137 NFC_ATTR_PROTOCOLS, 138 NFC_ATTR_TARGET_INDEX, 139 NFC_ATTR_TARGET_SENS_RES, 140 NFC_ATTR_TARGET_SEL_RES, 141 NFC_ATTR_TARGET_NFCID1, 142 NFC_ATTR_TARGET_SENSB_RES, 143 NFC_ATTR_TARGET_SENSF_RES, 144 NFC_ATTR_COMM_MODE, 145 NFC_ATTR_RF_MODE, 146 NFC_ATTR_DEVICE_POWERED, 147 NFC_ATTR_IM_PROTOCOLS, 148 NFC_ATTR_TM_PROTOCOLS, 149 NFC_ATTR_LLC_PARAM_LTO, 150 NFC_ATTR_LLC_PARAM_RW, 151 NFC_ATTR_LLC_PARAM_MIUX, 152 NFC_ATTR_SE, 153 NFC_ATTR_LLC_SDP, 154 NFC_ATTR_FIRMWARE_NAME, 155 NFC_ATTR_SE_INDEX, 156 NFC_ATTR_SE_TYPE, 157/* private: internal use only */ 158 __NFC_ATTR_AFTER_LAST 159}; 160#define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1) 161 162enum nfc_sdp_attr { 163 NFC_SDP_ATTR_UNSPEC, 164 NFC_SDP_ATTR_URI, 165 NFC_SDP_ATTR_SAP, 166/* private: internal use only */ 167 __NFC_SDP_ATTR_AFTER_LAST 168}; 169#define NFC_SDP_ATTR_MAX (__NFC_SDP_ATTR_AFTER_LAST - 1) 170 171#define NFC_DEVICE_NAME_MAXSIZE 8 172#define NFC_NFCID1_MAXSIZE 10 173#define NFC_NFCID2_MAXSIZE 8 174#define NFC_NFCID3_MAXSIZE 10 175#define NFC_SENSB_RES_MAXSIZE 12 176#define NFC_SENSF_RES_MAXSIZE 18 177#define NFC_GB_MAXSIZE 48 178#define NFC_FIRMWARE_NAME_MAXSIZE 32 179 180/* NFC protocols */ 181#define NFC_PROTO_JEWEL 1 182#define NFC_PROTO_MIFARE 2 183#define NFC_PROTO_FELICA 3 184#define NFC_PROTO_ISO14443 4 185#define NFC_PROTO_NFC_DEP 5 186#define NFC_PROTO_ISO14443_B 6 187 188#define NFC_PROTO_MAX 7 189 190/* NFC communication modes */ 191#define NFC_COMM_ACTIVE 0 192#define NFC_COMM_PASSIVE 1 193 194/* NFC RF modes */ 195#define NFC_RF_INITIATOR 0 196#define NFC_RF_TARGET 1 197#define NFC_RF_NONE 2 198 199/* NFC protocols masks used in bitsets */ 200#define NFC_PROTO_JEWEL_MASK (1 << NFC_PROTO_JEWEL) 201#define NFC_PROTO_MIFARE_MASK (1 << NFC_PROTO_MIFARE) 202#define NFC_PROTO_FELICA_MASK (1 << NFC_PROTO_FELICA) 203#define NFC_PROTO_ISO14443_MASK (1 << NFC_PROTO_ISO14443) 204#define NFC_PROTO_NFC_DEP_MASK (1 << NFC_PROTO_NFC_DEP) 205#define NFC_PROTO_ISO14443_B_MASK (1 << NFC_PROTO_ISO14443_B) 206 207/* NFC Secure Elements */ 208#define NFC_SE_UICC 0x1 209#define NFC_SE_EMBEDDED 0x2 210 211#define NFC_SE_DISABLED 0x0 212#define NFC_SE_ENABLED 0x1 213 214struct sockaddr_nfc { 215 sa_family_t sa_family; 216 __u32 dev_idx; 217 __u32 target_idx; 218 __u32 nfc_protocol; 219}; 220 221#define NFC_LLCP_MAX_SERVICE_NAME 63 222struct sockaddr_nfc_llcp { 223 sa_family_t sa_family; 224 __u32 dev_idx; 225 __u32 target_idx; 226 __u32 nfc_protocol; 227 __u8 dsap; /* Destination SAP, if known */ 228 __u8 ssap; /* Source SAP to be bound to */ 229 char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */; 230 size_t service_name_len; 231}; 232 233/* NFC socket protocols */ 234#define NFC_SOCKPROTO_RAW 0 235#define NFC_SOCKPROTO_LLCP 1 236#define NFC_SOCKPROTO_MAX 2 237 238#define NFC_HEADER_SIZE 1 239 240/** 241 * Pseudo-header info for raw socket packets 242 * First byte is the adapter index 243 * Second byte contains flags 244 * - 0x01 - Direction (0=RX, 1=TX) 245 * - 0x02-0x80 - Reserved 246 **/ 247#define NFC_LLCP_RAW_HEADER_SIZE 2 248#define NFC_LLCP_DIRECTION_RX 0x00 249#define NFC_LLCP_DIRECTION_TX 0x01 250 251/* socket option names */ 252#define NFC_LLCP_RW 0 253#define NFC_LLCP_MIUX 1 254#define NFC_LLCP_REMOTE_MIU 2 255#define NFC_LLCP_REMOTE_LTO 3 256#define NFC_LLCP_REMOTE_RW 4 257 258#endif /*__LINUX_NFC_H */ 259