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