89fee4ab1904784e7c748a1cbcb95fb053c9e36b
[linux-2.6.git] / include / linux / nfc.h
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  * 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  */
60 enum nfc_commands {
61         NFC_CMD_UNSPEC,
62         NFC_CMD_GET_DEVICE,
63         NFC_CMD_DEV_UP,
64         NFC_CMD_DEV_DOWN,
65         NFC_CMD_DEP_LINK_UP,
66         NFC_CMD_DEP_LINK_DOWN,
67         NFC_CMD_START_POLL,
68         NFC_CMD_STOP_POLL,
69         NFC_CMD_GET_TARGET,
70         NFC_EVENT_TARGETS_FOUND,
71         NFC_EVENT_DEVICE_ADDED,
72         NFC_EVENT_DEVICE_REMOVED,
73 /* private: internal use only */
74         __NFC_CMD_AFTER_LAST
75 };
76 #define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1)
77
78 /**
79  * enum nfc_attrs - supported nfc attributes
80  *
81  * @NFC_ATTR_UNSPEC: unspecified attribute
82  *
83  * @NFC_ATTR_DEVICE_INDEX: index of nfc device
84  * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars
85  * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from
86  *      NFC_PROTO_*_MASK constants
87  * @NFC_ATTR_TARGET_INDEX: index of the nfc target
88  * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID
89  * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the
90  *      target is not NFC-Forum compliant)
91  * @NFC_ATTR_COMM_MODE: Passive or active mode
92  * @NFC_ATTR_RF_MODE: Initiator or target
93  */
94 enum nfc_attrs {
95         NFC_ATTR_UNSPEC,
96         NFC_ATTR_DEVICE_INDEX,
97         NFC_ATTR_DEVICE_NAME,
98         NFC_ATTR_PROTOCOLS,
99         NFC_ATTR_TARGET_INDEX,
100         NFC_ATTR_TARGET_SENS_RES,
101         NFC_ATTR_TARGET_SEL_RES,
102         NFC_ATTR_COMM_MODE,
103         NFC_ATTR_RF_MODE,
104 /* private: internal use only */
105         __NFC_ATTR_AFTER_LAST
106 };
107 #define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1)
108
109 #define NFC_DEVICE_NAME_MAXSIZE 8
110
111 /* NFC protocols */
112 #define NFC_PROTO_JEWEL         1
113 #define NFC_PROTO_MIFARE        2
114 #define NFC_PROTO_FELICA        3
115 #define NFC_PROTO_ISO14443      4
116 #define NFC_PROTO_NFC_DEP       5
117
118 #define NFC_PROTO_MAX           6
119
120 /* NFC communication modes */
121 #define NFC_COMM_ACTIVE  0
122 #define NFC_COMM_PASSIVE 1
123
124 /* NFC RF modes */
125 #define NFC_RF_INITIATOR 0
126 #define NFC_RF_TARGET    1
127
128 /* NFC protocols masks used in bitsets */
129 #define NFC_PROTO_JEWEL_MASK    (1 << NFC_PROTO_JEWEL)
130 #define NFC_PROTO_MIFARE_MASK   (1 << NFC_PROTO_MIFARE)
131 #define NFC_PROTO_FELICA_MASK   (1 << NFC_PROTO_FELICA)
132 #define NFC_PROTO_ISO14443_MASK (1 << NFC_PROTO_ISO14443)
133 #define NFC_PROTO_NFC_DEP_MASK  (1 << NFC_PROTO_NFC_DEP)
134
135 struct sockaddr_nfc {
136         sa_family_t sa_family;
137         __u32 dev_idx;
138         __u32 target_idx;
139         __u32 nfc_protocol;
140 };
141
142 #define NFC_LLCP_MAX_SERVICE_NAME 63
143 struct sockaddr_nfc_llcp {
144         sa_family_t sa_family;
145         __u32 dev_idx;
146         __u32 target_idx;
147         __u32 nfc_protocol;
148         __u8 dsap; /* Destination SAP, if known */
149         __u8 ssap; /* Source SAP to be bound to */
150         char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */;
151         size_t service_name_len;
152 };
153
154 /* NFC socket protocols */
155 #define NFC_SOCKPROTO_RAW       0
156 #define NFC_SOCKPROTO_LLCP      1
157 #define NFC_SOCKPROTO_MAX       2
158
159 #define NFC_HEADER_SIZE 1
160
161 #endif /*__LINUX_NFC_H */