blob: 0ae9b5857c83b0786a9f7ea92ffe51991c34a1b8 [file] [log] [blame]
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -03001/*
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
Lauro Ramos Venancio23b78692011-07-01 19:31:36 -030027#include <linux/types.h>
28#include <linux/socket.h>
29
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -030030#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
Ilan Elias8b3fe7b2011-09-18 11:19:33 +030042 * @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)
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -030046 * @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 */
60enum nfc_commands {
61 NFC_CMD_UNSPEC,
62 NFC_CMD_GET_DEVICE,
Ilan Elias8b3fe7b2011-09-18 11:19:33 +030063 NFC_CMD_DEV_UP,
64 NFC_CMD_DEV_DOWN,
Samuel Ortiz1ed28f62011-12-14 16:43:09 +010065 NFC_CMD_DEP_LINK_UP,
66 NFC_CMD_DEP_LINK_DOWN,
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -030067 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,
Samuel Ortiz8112a5c2012-04-10 19:43:04 +020073 NFC_EVENT_TARGET_LOST,
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -030074/* private: internal use only */
75 __NFC_CMD_AFTER_LAST
76};
77#define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1)
78
79/**
80 * enum nfc_attrs - supported nfc attributes
81 *
82 * @NFC_ATTR_UNSPEC: unspecified attribute
83 *
84 * @NFC_ATTR_DEVICE_INDEX: index of nfc device
85 * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars
86 * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from
87 * NFC_PROTO_*_MASK constants
88 * @NFC_ATTR_TARGET_INDEX: index of the nfc target
89 * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID
90 * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the
91 * target is not NFC-Forum compliant)
Ilan Elias288e0712011-12-22 11:51:54 +020092 * @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes
Ilan Eliasd5a2ca62012-01-17 11:06:43 +020093 * @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes
94 * @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes
Samuel Ortiz1ed28f62011-12-14 16:43:09 +010095 * @NFC_ATTR_COMM_MODE: Passive or active mode
96 * @NFC_ATTR_RF_MODE: Initiator or target
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -030097 */
98enum nfc_attrs {
99 NFC_ATTR_UNSPEC,
100 NFC_ATTR_DEVICE_INDEX,
101 NFC_ATTR_DEVICE_NAME,
102 NFC_ATTR_PROTOCOLS,
103 NFC_ATTR_TARGET_INDEX,
104 NFC_ATTR_TARGET_SENS_RES,
105 NFC_ATTR_TARGET_SEL_RES,
Ilan Elias288e0712011-12-22 11:51:54 +0200106 NFC_ATTR_TARGET_NFCID1,
Ilan Eliasd5a2ca62012-01-17 11:06:43 +0200107 NFC_ATTR_TARGET_SENSB_RES,
108 NFC_ATTR_TARGET_SENSF_RES,
Samuel Ortiz1ed28f62011-12-14 16:43:09 +0100109 NFC_ATTR_COMM_MODE,
110 NFC_ATTR_RF_MODE,
Samuel Ortizc970a1a2012-03-05 01:03:34 +0100111 NFC_ATTR_DEVICE_POWERED,
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300112/* private: internal use only */
113 __NFC_ATTR_AFTER_LAST
114};
115#define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1)
116
117#define NFC_DEVICE_NAME_MAXSIZE 8
Ilan Eliasd5a2ca62012-01-17 11:06:43 +0200118#define NFC_NFCID1_MAXSIZE 10
119#define NFC_SENSB_RES_MAXSIZE 12
120#define NFC_SENSF_RES_MAXSIZE 18
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300121
122/* NFC protocols */
123#define NFC_PROTO_JEWEL 1
124#define NFC_PROTO_MIFARE 2
125#define NFC_PROTO_FELICA 3
126#define NFC_PROTO_ISO14443 4
127#define NFC_PROTO_NFC_DEP 5
128
129#define NFC_PROTO_MAX 6
130
Samuel Ortiz1ed28f62011-12-14 16:43:09 +0100131/* NFC communication modes */
132#define NFC_COMM_ACTIVE 0
133#define NFC_COMM_PASSIVE 1
134
135/* NFC RF modes */
136#define NFC_RF_INITIATOR 0
137#define NFC_RF_TARGET 1
138
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300139/* NFC protocols masks used in bitsets */
140#define NFC_PROTO_JEWEL_MASK (1 << NFC_PROTO_JEWEL)
141#define NFC_PROTO_MIFARE_MASK (1 << NFC_PROTO_MIFARE)
142#define NFC_PROTO_FELICA_MASK (1 << NFC_PROTO_FELICA)
143#define NFC_PROTO_ISO14443_MASK (1 << NFC_PROTO_ISO14443)
144#define NFC_PROTO_NFC_DEP_MASK (1 << NFC_PROTO_NFC_DEP)
145
Lauro Ramos Venancio23b78692011-07-01 19:31:36 -0300146struct sockaddr_nfc {
147 sa_family_t sa_family;
148 __u32 dev_idx;
149 __u32 target_idx;
150 __u32 nfc_protocol;
151};
152
Samuel Ortizd6469602011-12-14 16:43:12 +0100153#define NFC_LLCP_MAX_SERVICE_NAME 63
154struct sockaddr_nfc_llcp {
155 sa_family_t sa_family;
156 __u32 dev_idx;
157 __u32 target_idx;
158 __u32 nfc_protocol;
159 __u8 dsap; /* Destination SAP, if known */
160 __u8 ssap; /* Source SAP to be bound to */
161 char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */;
162 size_t service_name_len;
163};
164
Aloisio Almeida Jrc7fe3b52011-07-01 19:31:35 -0300165/* NFC socket protocols */
Lauro Ramos Venancio23b78692011-07-01 19:31:36 -0300166#define NFC_SOCKPROTO_RAW 0
Samuel Ortizd6469602011-12-14 16:43:12 +0100167#define NFC_SOCKPROTO_LLCP 1
168#define NFC_SOCKPROTO_MAX 2
Aloisio Almeida Jrc7fe3b52011-07-01 19:31:35 -0300169
Samuel Ortize8753042011-08-19 15:47:11 +0200170#define NFC_HEADER_SIZE 1
171
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300172#endif /*__LINUX_NFC_H */