Commit | Line | Data |
---|---|---|
4d12b8b1 LRV |
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 | * | |
d3710e74 LRV |
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. | |
4d12b8b1 | 11 | * |
d3710e74 LRV |
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. | |
4d12b8b1 LRV |
19 | */ |
20 | ||
21 | #ifndef __LINUX_NFC_H | |
22 | #define __LINUX_NFC_H | |
23 | ||
23b7869c LRV |
24 | #include <linux/types.h> |
25 | #include <linux/socket.h> | |
26 | ||
4d12b8b1 LRV |
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 | |
8b3fe7b5 IE |
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) | |
4d12b8b1 LRV |
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) | |
fc40a8c1 SO |
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. | |
52feb444 TE |
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. | |
390a1bd8 SO |
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. | |
9ea7187c SO |
72 | * @NFC_CMD_FW_DOWNLOAD: Request to Load/flash firmware, or event to inform |
73 | * that some firmware was loaded | |
1972b5b3 SO |
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. | |
91a32269 SO |
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). | |
ac22ac46 | 87 | * @NFC_CMD_GET_SE: Dump all discovered secure elements from an NFC controller. |
72b70b6e | 88 | * @NFC_CMD_SE_IO: Send/Receive APDUs to/from the selected secure element. |
4d12b8b1 LRV |
89 | */ |
90 | enum nfc_commands { | |
91 | NFC_CMD_UNSPEC, | |
92 | NFC_CMD_GET_DEVICE, | |
8b3fe7b5 IE |
93 | NFC_CMD_DEV_UP, |
94 | NFC_CMD_DEV_DOWN, | |
1ed28f61 SO |
95 | NFC_CMD_DEP_LINK_UP, |
96 | NFC_CMD_DEP_LINK_DOWN, | |
4d12b8b1 LRV |
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, | |
8112a5c9 | 103 | NFC_EVENT_TARGET_LOST, |
fc40a8c1 SO |
104 | NFC_EVENT_TM_ACTIVATED, |
105 | NFC_EVENT_TM_DEACTIVATED, | |
52feb444 TE |
106 | NFC_CMD_LLC_GET_PARAMS, |
107 | NFC_CMD_LLC_SET_PARAMS, | |
390a1bd8 SO |
108 | NFC_CMD_ENABLE_SE, |
109 | NFC_CMD_DISABLE_SE, | |
d9b8d8e1 TE |
110 | NFC_CMD_LLC_SDREQ, |
111 | NFC_EVENT_LLC_SDRES, | |
9ea7187c | 112 | NFC_CMD_FW_DOWNLOAD, |
2757c372 SO |
113 | NFC_EVENT_SE_ADDED, |
114 | NFC_EVENT_SE_REMOVED, | |
91a32269 SO |
115 | NFC_EVENT_SE_CONNECTIVITY, |
116 | NFC_EVENT_SE_TRANSACTION, | |
ac22ac46 | 117 | NFC_CMD_GET_SE, |
72b70b6e | 118 | NFC_CMD_SE_IO, |
3682f49f | 119 | NFC_CMD_ACTIVATE_TARGET, |
4d12b8b1 LRV |
120 | /* private: internal use only */ |
121 | __NFC_CMD_AFTER_LAST | |
122 | }; | |
123 | #define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1) | |
124 | ||
125 | /** | |
126 | * enum nfc_attrs - supported nfc attributes | |
127 | * | |
128 | * @NFC_ATTR_UNSPEC: unspecified attribute | |
129 | * | |
130 | * @NFC_ATTR_DEVICE_INDEX: index of nfc device | |
131 | * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars | |
132 | * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from | |
133 | * NFC_PROTO_*_MASK constants | |
134 | * @NFC_ATTR_TARGET_INDEX: index of the nfc target | |
135 | * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID | |
136 | * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the | |
137 | * target is not NFC-Forum compliant) | |
288e0713 | 138 | * @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes |
d5a2ca60 IE |
139 | * @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes |
140 | * @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes | |
1ed28f61 SO |
141 | * @NFC_ATTR_COMM_MODE: Passive or active mode |
142 | * @NFC_ATTR_RF_MODE: Initiator or target | |
fe7c5800 SO |
143 | * @NFC_ATTR_IM_PROTOCOLS: Initiator mode protocols to poll for |
144 | * @NFC_ATTR_TM_PROTOCOLS: Target mode protocols to listen for | |
52feb444 TE |
145 | * @NFC_ATTR_LLC_PARAM_LTO: Link TimeOut parameter |
146 | * @NFC_ATTR_LLC_PARAM_RW: Receive Window size parameter | |
147 | * @NFC_ATTR_LLC_PARAM_MIUX: MIU eXtension parameter | |
390a1bd8 | 148 | * @NFC_ATTR_SE: Available Secure Elements |
9674da87 | 149 | * @NFC_ATTR_FIRMWARE_NAME: Free format firmware version |
2757c372 SO |
150 | * @NFC_ATTR_SE_INDEX: Secure element index |
151 | * @NFC_ATTR_SE_TYPE: Secure element type (UICC or EMBEDDED) | |
352a5f5f | 152 | * @NFC_ATTR_FIRMWARE_DOWNLOAD_STATUS: Firmware download operation status |
72b70b6e | 153 | * @NFC_ATTR_APDU: Secure element APDU |
e487e4dc MG |
154 | * @NFC_ATTR_TARGET_ISO15693_DSFID: ISO 15693 Data Storage Format Identifier |
155 | * @NFC_ATTR_TARGET_ISO15693_UID: ISO 15693 Unique Identifier | |
4d12b8b1 LRV |
156 | */ |
157 | enum nfc_attrs { | |
158 | NFC_ATTR_UNSPEC, | |
159 | NFC_ATTR_DEVICE_INDEX, | |
160 | NFC_ATTR_DEVICE_NAME, | |
161 | NFC_ATTR_PROTOCOLS, | |
162 | NFC_ATTR_TARGET_INDEX, | |
163 | NFC_ATTR_TARGET_SENS_RES, | |
164 | NFC_ATTR_TARGET_SEL_RES, | |
288e0713 | 165 | NFC_ATTR_TARGET_NFCID1, |
d5a2ca60 IE |
166 | NFC_ATTR_TARGET_SENSB_RES, |
167 | NFC_ATTR_TARGET_SENSF_RES, | |
1ed28f61 SO |
168 | NFC_ATTR_COMM_MODE, |
169 | NFC_ATTR_RF_MODE, | |
c970a1ac | 170 | NFC_ATTR_DEVICE_POWERED, |
fe7c5800 SO |
171 | NFC_ATTR_IM_PROTOCOLS, |
172 | NFC_ATTR_TM_PROTOCOLS, | |
52feb444 TE |
173 | NFC_ATTR_LLC_PARAM_LTO, |
174 | NFC_ATTR_LLC_PARAM_RW, | |
175 | NFC_ATTR_LLC_PARAM_MIUX, | |
390a1bd8 | 176 | NFC_ATTR_SE, |
d9b8d8e1 | 177 | NFC_ATTR_LLC_SDP, |
9674da87 | 178 | NFC_ATTR_FIRMWARE_NAME, |
2757c372 SO |
179 | NFC_ATTR_SE_INDEX, |
180 | NFC_ATTR_SE_TYPE, | |
91a32269 | 181 | NFC_ATTR_SE_AID, |
352a5f5f | 182 | NFC_ATTR_FIRMWARE_DOWNLOAD_STATUS, |
72b70b6e | 183 | NFC_ATTR_SE_APDU, |
e487e4dc MG |
184 | NFC_ATTR_TARGET_ISO15693_DSFID, |
185 | NFC_ATTR_TARGET_ISO15693_UID, | |
447b27c4 | 186 | NFC_ATTR_SE_PARAMS, |
4d12b8b1 LRV |
187 | /* private: internal use only */ |
188 | __NFC_ATTR_AFTER_LAST | |
189 | }; | |
190 | #define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1) | |
d9b8d8e1 TE |
191 | |
192 | enum nfc_sdp_attr { | |
193 | NFC_SDP_ATTR_UNSPEC, | |
194 | NFC_SDP_ATTR_URI, | |
195 | NFC_SDP_ATTR_SAP, | |
196 | /* private: internal use only */ | |
197 | __NFC_SDP_ATTR_AFTER_LAST | |
198 | }; | |
199 | #define NFC_SDP_ATTR_MAX (__NFC_SDP_ATTR_AFTER_LAST - 1) | |
4d12b8b1 | 200 | |
a99903ec JL |
201 | #define NFC_DEVICE_NAME_MAXSIZE 8 |
202 | #define NFC_NFCID1_MAXSIZE 10 | |
203 | #define NFC_NFCID2_MAXSIZE 8 | |
204 | #define NFC_NFCID3_MAXSIZE 10 | |
205 | #define NFC_SENSB_RES_MAXSIZE 12 | |
206 | #define NFC_SENSF_RES_MAXSIZE 18 | |
207 | #define NFC_ATR_REQ_MAXSIZE 64 | |
208 | #define NFC_ATR_RES_MAXSIZE 64 | |
e479ce47 JL |
209 | #define NFC_ATR_REQ_GB_MAXSIZE 48 |
210 | #define NFC_ATR_RES_GB_MAXSIZE 47 | |
a99903ec JL |
211 | #define NFC_GB_MAXSIZE 48 |
212 | #define NFC_FIRMWARE_NAME_MAXSIZE 32 | |
213 | #define NFC_ISO15693_UID_MAXSIZE 8 | |
4d12b8b1 LRV |
214 | |
215 | /* NFC protocols */ | |
216 | #define NFC_PROTO_JEWEL 1 | |
217 | #define NFC_PROTO_MIFARE 2 | |
218 | #define NFC_PROTO_FELICA 3 | |
219 | #define NFC_PROTO_ISO14443 4 | |
220 | #define NFC_PROTO_NFC_DEP 5 | |
01d719a2 | 221 | #define NFC_PROTO_ISO14443_B 6 |
e487e4dc | 222 | #define NFC_PROTO_ISO15693 7 |
4d12b8b1 | 223 | |
e487e4dc | 224 | #define NFC_PROTO_MAX 8 |
4d12b8b1 | 225 | |
1ed28f61 SO |
226 | /* NFC communication modes */ |
227 | #define NFC_COMM_ACTIVE 0 | |
228 | #define NFC_COMM_PASSIVE 1 | |
229 | ||
230 | /* NFC RF modes */ | |
231 | #define NFC_RF_INITIATOR 0 | |
232 | #define NFC_RF_TARGET 1 | |
f212ad5e | 233 | #define NFC_RF_NONE 2 |
1ed28f61 | 234 | |
4d12b8b1 | 235 | /* NFC protocols masks used in bitsets */ |
01d719a2 SO |
236 | #define NFC_PROTO_JEWEL_MASK (1 << NFC_PROTO_JEWEL) |
237 | #define NFC_PROTO_MIFARE_MASK (1 << NFC_PROTO_MIFARE) | |
238 | #define NFC_PROTO_FELICA_MASK (1 << NFC_PROTO_FELICA) | |
239 | #define NFC_PROTO_ISO14443_MASK (1 << NFC_PROTO_ISO14443) | |
240 | #define NFC_PROTO_NFC_DEP_MASK (1 << NFC_PROTO_NFC_DEP) | |
241 | #define NFC_PROTO_ISO14443_B_MASK (1 << NFC_PROTO_ISO14443_B) | |
e487e4dc | 242 | #define NFC_PROTO_ISO15693_MASK (1 << NFC_PROTO_ISO15693) |
4d12b8b1 | 243 | |
390a1bd8 | 244 | /* NFC Secure Elements */ |
390a1bd8 SO |
245 | #define NFC_SE_UICC 0x1 |
246 | #define NFC_SE_EMBEDDED 0x2 | |
247 | ||
fed7c25e SO |
248 | #define NFC_SE_DISABLED 0x0 |
249 | #define NFC_SE_ENABLED 0x1 | |
250 | ||
23b7869c LRV |
251 | struct sockaddr_nfc { |
252 | sa_family_t sa_family; | |
253 | __u32 dev_idx; | |
254 | __u32 target_idx; | |
255 | __u32 nfc_protocol; | |
256 | }; | |
257 | ||
d646960f SO |
258 | #define NFC_LLCP_MAX_SERVICE_NAME 63 |
259 | struct sockaddr_nfc_llcp { | |
260 | sa_family_t sa_family; | |
261 | __u32 dev_idx; | |
262 | __u32 target_idx; | |
263 | __u32 nfc_protocol; | |
264 | __u8 dsap; /* Destination SAP, if known */ | |
265 | __u8 ssap; /* Source SAP to be bound to */ | |
266 | char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */; | |
267 | size_t service_name_len; | |
268 | }; | |
269 | ||
c7fe3b52 | 270 | /* NFC socket protocols */ |
23b7869c | 271 | #define NFC_SOCKPROTO_RAW 0 |
d646960f SO |
272 | #define NFC_SOCKPROTO_LLCP 1 |
273 | #define NFC_SOCKPROTO_MAX 2 | |
c7fe3b52 | 274 | |
e8753043 SO |
275 | #define NFC_HEADER_SIZE 1 |
276 | ||
4463523b TE |
277 | /** |
278 | * Pseudo-header info for raw socket packets | |
279 | * First byte is the adapter index | |
280 | * Second byte contains flags | |
281 | * - 0x01 - Direction (0=RX, 1=TX) | |
57be1f3f HT |
282 | * - 0x02-0x04 - Payload type (000=LLCP, 001=NCI, 010=HCI, 011=Digital, |
283 | * 100=Proprietary) | |
284 | * - 0x05-0x80 - Reserved | |
4463523b | 285 | **/ |
57be1f3f HT |
286 | #define NFC_RAW_HEADER_SIZE 2 |
287 | #define NFC_DIRECTION_RX 0x00 | |
288 | #define NFC_DIRECTION_TX 0x01 | |
289 | ||
290 | #define RAW_PAYLOAD_LLCP 0 | |
291 | #define RAW_PAYLOAD_NCI 1 | |
292 | #define RAW_PAYLOAD_HCI 2 | |
293 | #define RAW_PAYLOAD_DIGITAL 3 | |
294 | #define RAW_PAYLOAD_PROPRIETARY 4 | |
4463523b | 295 | |
26fd76ca | 296 | /* socket option names */ |
064f370c TE |
297 | #define NFC_LLCP_RW 0 |
298 | #define NFC_LLCP_MIUX 1 | |
299 | #define NFC_LLCP_REMOTE_MIU 2 | |
300 | #define NFC_LLCP_REMOTE_LTO 3 | |
301 | #define NFC_LLCP_REMOTE_RW 4 | |
26fd76ca | 302 | |
4d12b8b1 | 303 | #endif /*__LINUX_NFC_H */ |