NFC: add the NFC socket raw protocol
[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_START_POLL: start polling for targets using the given protocols
43  *      (requires %NFC_ATTR_DEVICE_INDEX and %NFC_ATTR_PROTOCOLS)
44  * @NFC_CMD_STOP_POLL: stop polling for targets (requires
45  *      %NFC_ATTR_DEVICE_INDEX)
46  * @NFC_CMD_GET_TARGET: dump all targets found by the previous poll (requires
47  *      %NFC_ATTR_DEVICE_INDEX)
48  * @NFC_EVENT_TARGETS_FOUND: event emitted when a new target is found
49  *      (it sends %NFC_ATTR_DEVICE_INDEX)
50  * @NFC_EVENT_DEVICE_ADDED: event emitted when a new device is registred
51  *      (it sends %NFC_ATTR_DEVICE_NAME, %NFC_ATTR_DEVICE_INDEX and
52  *      %NFC_ATTR_PROTOCOLS)
53  * @NFC_EVENT_DEVICE_REMOVED: event emitted when a device is removed
54  *      (it sends %NFC_ATTR_DEVICE_INDEX)
55  */
56 enum nfc_commands {
57         NFC_CMD_UNSPEC,
58         NFC_CMD_GET_DEVICE,
59         NFC_CMD_START_POLL,
60         NFC_CMD_STOP_POLL,
61         NFC_CMD_GET_TARGET,
62         NFC_EVENT_TARGETS_FOUND,
63         NFC_EVENT_DEVICE_ADDED,
64         NFC_EVENT_DEVICE_REMOVED,
65 /* private: internal use only */
66         __NFC_CMD_AFTER_LAST
67 };
68 #define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1)
69
70 /**
71  * enum nfc_attrs - supported nfc attributes
72  *
73  * @NFC_ATTR_UNSPEC: unspecified attribute
74  *
75  * @NFC_ATTR_DEVICE_INDEX: index of nfc device
76  * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars
77  * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from
78  *      NFC_PROTO_*_MASK constants
79  * @NFC_ATTR_TARGET_INDEX: index of the nfc target
80  * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID
81  * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the
82  *      target is not NFC-Forum compliant)
83  */
84 enum nfc_attrs {
85         NFC_ATTR_UNSPEC,
86         NFC_ATTR_DEVICE_INDEX,
87         NFC_ATTR_DEVICE_NAME,
88         NFC_ATTR_PROTOCOLS,
89         NFC_ATTR_TARGET_INDEX,
90         NFC_ATTR_TARGET_SENS_RES,
91         NFC_ATTR_TARGET_SEL_RES,
92 /* private: internal use only */
93         __NFC_ATTR_AFTER_LAST
94 };
95 #define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1)
96
97 #define NFC_DEVICE_NAME_MAXSIZE 8
98
99 /* NFC protocols */
100 #define NFC_PROTO_JEWEL         1
101 #define NFC_PROTO_MIFARE        2
102 #define NFC_PROTO_FELICA        3
103 #define NFC_PROTO_ISO14443      4
104 #define NFC_PROTO_NFC_DEP       5
105
106 #define NFC_PROTO_MAX           6
107
108 /* NFC protocols masks used in bitsets */
109 #define NFC_PROTO_JEWEL_MASK    (1 << NFC_PROTO_JEWEL)
110 #define NFC_PROTO_MIFARE_MASK   (1 << NFC_PROTO_MIFARE)
111 #define NFC_PROTO_FELICA_MASK   (1 << NFC_PROTO_FELICA)
112 #define NFC_PROTO_ISO14443_MASK (1 << NFC_PROTO_ISO14443)
113 #define NFC_PROTO_NFC_DEP_MASK  (1 << NFC_PROTO_NFC_DEP)
114
115 struct sockaddr_nfc {
116         sa_family_t sa_family;
117         __u32 dev_idx;
118         __u32 target_idx;
119         __u32 nfc_protocol;
120 };
121
122 /* NFC socket protocols */
123 #define NFC_SOCKPROTO_RAW       0
124 #define NFC_SOCKPROTO_MAX       1
125
126 #endif /*__LINUX_NFC_H */