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