xref: /linux-6.15/include/uapi/linux/nfc.h (revision 6fa79bca)
1 /*
2  * Copyright (C) 2011 Instituto Nokia de Tecnologia
3  *
4  * Authors:
5  *    Lauro Ramos Venancio <[email protected]>
6  *    Aloisio Almeida Jr <[email protected]>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the
20  * Free Software Foundation, Inc.,
21  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22  */
23 
24 #ifndef __LINUX_NFC_H
25 #define __LINUX_NFC_H
26 
27 #include <linux/types.h>
28 #include <linux/socket.h>
29 
30 #define NFC_GENL_NAME "nfc"
31 #define NFC_GENL_VERSION 1
32 
33 #define NFC_GENL_MCAST_EVENT_NAME "events"
34 
35 /**
36  * enum nfc_commands - supported nfc commands
37  *
38  * @NFC_CMD_UNSPEC: unspecified command
39  *
40  * @NFC_CMD_GET_DEVICE: request information about a device (requires
41  *	%NFC_ATTR_DEVICE_INDEX) or dump request to get a list of all nfc devices
42  * @NFC_CMD_DEV_UP: turn on the nfc device
43  *	(requires %NFC_ATTR_DEVICE_INDEX)
44  * @NFC_CMD_DEV_DOWN: turn off the nfc device
45  *	(requires %NFC_ATTR_DEVICE_INDEX)
46  * @NFC_CMD_START_POLL: start polling for targets using the given protocols
47  *	(requires %NFC_ATTR_DEVICE_INDEX and %NFC_ATTR_PROTOCOLS)
48  * @NFC_CMD_STOP_POLL: stop polling for targets (requires
49  *	%NFC_ATTR_DEVICE_INDEX)
50  * @NFC_CMD_GET_TARGET: dump all targets found by the previous poll (requires
51  *	%NFC_ATTR_DEVICE_INDEX)
52  * @NFC_EVENT_TARGETS_FOUND: event emitted when a new target is found
53  *	(it sends %NFC_ATTR_DEVICE_INDEX)
54  * @NFC_EVENT_DEVICE_ADDED: event emitted when a new device is registred
55  *	(it sends %NFC_ATTR_DEVICE_NAME, %NFC_ATTR_DEVICE_INDEX and
56  *	%NFC_ATTR_PROTOCOLS)
57  * @NFC_EVENT_DEVICE_REMOVED: event emitted when a device is removed
58  *	(it sends %NFC_ATTR_DEVICE_INDEX)
59  * @NFC_EVENT_TM_ACTIVATED: event emitted when the adapter is activated in
60  *      target mode.
61  * @NFC_EVENT_DEVICE_DEACTIVATED: event emitted when the adapter is deactivated
62  *      from target mode.
63  */
64 enum nfc_commands {
65 	NFC_CMD_UNSPEC,
66 	NFC_CMD_GET_DEVICE,
67 	NFC_CMD_DEV_UP,
68 	NFC_CMD_DEV_DOWN,
69 	NFC_CMD_DEP_LINK_UP,
70 	NFC_CMD_DEP_LINK_DOWN,
71 	NFC_CMD_START_POLL,
72 	NFC_CMD_STOP_POLL,
73 	NFC_CMD_GET_TARGET,
74 	NFC_EVENT_TARGETS_FOUND,
75 	NFC_EVENT_DEVICE_ADDED,
76 	NFC_EVENT_DEVICE_REMOVED,
77 	NFC_EVENT_TARGET_LOST,
78 	NFC_EVENT_TM_ACTIVATED,
79 	NFC_EVENT_TM_DEACTIVATED,
80 /* private: internal use only */
81 	__NFC_CMD_AFTER_LAST
82 };
83 #define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1)
84 
85 /**
86  * enum nfc_attrs - supported nfc attributes
87  *
88  * @NFC_ATTR_UNSPEC: unspecified attribute
89  *
90  * @NFC_ATTR_DEVICE_INDEX: index of nfc device
91  * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars
92  * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from
93  *	NFC_PROTO_*_MASK constants
94  * @NFC_ATTR_TARGET_INDEX: index of the nfc target
95  * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID
96  * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the
97  *	target is not NFC-Forum compliant)
98  * @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes
99  * @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes
100  * @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes
101  * @NFC_ATTR_COMM_MODE: Passive or active mode
102  * @NFC_ATTR_RF_MODE: Initiator or target
103  * @NFC_ATTR_IM_PROTOCOLS: Initiator mode protocols to poll for
104  * @NFC_ATTR_TM_PROTOCOLS: Target mode protocols to listen for
105  */
106 enum nfc_attrs {
107 	NFC_ATTR_UNSPEC,
108 	NFC_ATTR_DEVICE_INDEX,
109 	NFC_ATTR_DEVICE_NAME,
110 	NFC_ATTR_PROTOCOLS,
111 	NFC_ATTR_TARGET_INDEX,
112 	NFC_ATTR_TARGET_SENS_RES,
113 	NFC_ATTR_TARGET_SEL_RES,
114 	NFC_ATTR_TARGET_NFCID1,
115 	NFC_ATTR_TARGET_SENSB_RES,
116 	NFC_ATTR_TARGET_SENSF_RES,
117 	NFC_ATTR_COMM_MODE,
118 	NFC_ATTR_RF_MODE,
119 	NFC_ATTR_DEVICE_POWERED,
120 	NFC_ATTR_IM_PROTOCOLS,
121 	NFC_ATTR_TM_PROTOCOLS,
122 /* private: internal use only */
123 	__NFC_ATTR_AFTER_LAST
124 };
125 #define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1)
126 
127 #define NFC_DEVICE_NAME_MAXSIZE 8
128 #define NFC_NFCID1_MAXSIZE 10
129 #define NFC_SENSB_RES_MAXSIZE 12
130 #define NFC_SENSF_RES_MAXSIZE 18
131 #define NFC_GB_MAXSIZE        48
132 
133 /* NFC protocols */
134 #define NFC_PROTO_JEWEL		1
135 #define NFC_PROTO_MIFARE	2
136 #define NFC_PROTO_FELICA	3
137 #define NFC_PROTO_ISO14443	4
138 #define NFC_PROTO_NFC_DEP	5
139 #define NFC_PROTO_ISO14443_B	6
140 
141 #define NFC_PROTO_MAX		7
142 
143 /* NFC communication modes */
144 #define NFC_COMM_ACTIVE  0
145 #define NFC_COMM_PASSIVE 1
146 
147 /* NFC RF modes */
148 #define NFC_RF_INITIATOR 0
149 #define NFC_RF_TARGET    1
150 #define NFC_RF_NONE      2
151 
152 /* NFC protocols masks used in bitsets */
153 #define NFC_PROTO_JEWEL_MASK      (1 << NFC_PROTO_JEWEL)
154 #define NFC_PROTO_MIFARE_MASK     (1 << NFC_PROTO_MIFARE)
155 #define NFC_PROTO_FELICA_MASK	  (1 << NFC_PROTO_FELICA)
156 #define NFC_PROTO_ISO14443_MASK	  (1 << NFC_PROTO_ISO14443)
157 #define NFC_PROTO_NFC_DEP_MASK	  (1 << NFC_PROTO_NFC_DEP)
158 #define NFC_PROTO_ISO14443_B_MASK (1 << NFC_PROTO_ISO14443_B)
159 
160 struct sockaddr_nfc {
161 	sa_family_t sa_family;
162 	__u32 dev_idx;
163 	__u32 target_idx;
164 	__u32 nfc_protocol;
165 };
166 
167 #define NFC_LLCP_MAX_SERVICE_NAME 63
168 struct sockaddr_nfc_llcp {
169 	sa_family_t sa_family;
170 	__u32 dev_idx;
171 	__u32 target_idx;
172 	__u32 nfc_protocol;
173 	__u8 dsap; /* Destination SAP, if known */
174 	__u8 ssap; /* Source SAP to be bound to */
175 	char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */;
176 	size_t service_name_len;
177 };
178 
179 /* NFC socket protocols */
180 #define NFC_SOCKPROTO_RAW	0
181 #define NFC_SOCKPROTO_LLCP	1
182 #define NFC_SOCKPROTO_MAX	2
183 
184 #define NFC_HEADER_SIZE 1
185 
186 /**
187  * Pseudo-header info for raw socket packets
188  * First byte is the adapter index
189  * Second byte contains flags
190  *  - 0x01 - Direction (0=RX, 1=TX)
191  *  - 0x02-0x80 - Reserved
192  **/
193 #define NFC_LLCP_RAW_HEADER_SIZE	2
194 #define NFC_LLCP_DIRECTION_RX		0x00
195 #define NFC_LLCP_DIRECTION_TX		0x01
196 
197 #endif /*__LINUX_NFC_H */
198