[mirror_ubuntu-bionic-kernel.git] / include / linux / nfc.h

/*
 * Copyright (C) 2011 Instituto Nokia de Tecnologia
 *
 * Authors:
 *    Lauro Ramos Venancio <lauro.venancio@openbossa.org>
 *    Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the
 * Free Software Foundation, Inc.,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __LINUX_NFC_H
#define __LINUX_NFC_H

#include <linux/types.h>
#include <linux/socket.h>

#define NFC_GENL_NAME "nfc"
#define NFC_GENL_VERSION 1

#define NFC_GENL_MCAST_EVENT_NAME "events"

/**
 * enum nfc_commands - supported nfc commands
 *
 * @NFC_CMD_UNSPEC: unspecified command
 *
 * @NFC_CMD_GET_DEVICE: request information about a device (requires
 *	%NFC_ATTR_DEVICE_INDEX) or dump request to get a list of all nfc devices
 * @NFC_CMD_DEV_UP: turn on the nfc device
 *	(requires %NFC_ATTR_DEVICE_INDEX)
 * @NFC_CMD_DEV_DOWN: turn off the nfc device
 *	(requires %NFC_ATTR_DEVICE_INDEX)
 * @NFC_CMD_START_POLL: start polling for targets using the given protocols
 *	(requires %NFC_ATTR_DEVICE_INDEX and %NFC_ATTR_PROTOCOLS)
 * @NFC_CMD_STOP_POLL: stop polling for targets (requires
 *	%NFC_ATTR_DEVICE_INDEX)
 * @NFC_CMD_GET_TARGET: dump all targets found by the previous poll (requires
 *	%NFC_ATTR_DEVICE_INDEX)
 * @NFC_EVENT_TARGETS_FOUND: event emitted when a new target is found
 *	(it sends %NFC_ATTR_DEVICE_INDEX)
 * @NFC_EVENT_DEVICE_ADDED: event emitted when a new device is registred
 *	(it sends %NFC_ATTR_DEVICE_NAME, %NFC_ATTR_DEVICE_INDEX and
 *	%NFC_ATTR_PROTOCOLS)
 * @NFC_EVENT_DEVICE_REMOVED: event emitted when a device is removed
 *	(it sends %NFC_ATTR_DEVICE_INDEX)
 * @NFC_EVENT_TM_ACTIVATED: event emitted when the adapter is activated in
 *      target mode.
 * @NFC_EVENT_DEVICE_DEACTIVATED: event emitted when the adapter is deactivated
 *      from target mode.
 */
enum nfc_commands {
	NFC_CMD_UNSPEC,
	NFC_CMD_GET_DEVICE,
	NFC_CMD_DEV_UP,
	NFC_CMD_DEV_DOWN,
	NFC_CMD_DEP_LINK_UP,
	NFC_CMD_DEP_LINK_DOWN,
	NFC_CMD_START_POLL,
	NFC_CMD_STOP_POLL,
	NFC_CMD_GET_TARGET,
	NFC_EVENT_TARGETS_FOUND,
	NFC_EVENT_DEVICE_ADDED,
	NFC_EVENT_DEVICE_REMOVED,
	NFC_EVENT_TARGET_LOST,
	NFC_EVENT_TM_ACTIVATED,
	NFC_EVENT_TM_DEACTIVATED,
/* private: internal use only */
	__NFC_CMD_AFTER_LAST
};
#define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1)

/**
 * enum nfc_attrs - supported nfc attributes
 *
 * @NFC_ATTR_UNSPEC: unspecified attribute
 *
 * @NFC_ATTR_DEVICE_INDEX: index of nfc device
 * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars
 * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from
 *	NFC_PROTO_*_MASK constants
 * @NFC_ATTR_TARGET_INDEX: index of the nfc target
 * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID
 * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the
 *	target is not NFC-Forum compliant)
 * @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes
 * @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes
 * @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes
 * @NFC_ATTR_COMM_MODE: Passive or active mode
 * @NFC_ATTR_RF_MODE: Initiator or target
 * @NFC_ATTR_IM_PROTOCOLS: Initiator mode protocols to poll for
 * @NFC_ATTR_TM_PROTOCOLS: Target mode protocols to listen for
 */
enum nfc_attrs {
	NFC_ATTR_UNSPEC,
	NFC_ATTR_DEVICE_INDEX,
	NFC_ATTR_DEVICE_NAME,
	NFC_ATTR_PROTOCOLS,
	NFC_ATTR_TARGET_INDEX,
	NFC_ATTR_TARGET_SENS_RES,
	NFC_ATTR_TARGET_SEL_RES,
	NFC_ATTR_TARGET_NFCID1,
	NFC_ATTR_TARGET_SENSB_RES,
	NFC_ATTR_TARGET_SENSF_RES,
	NFC_ATTR_COMM_MODE,
	NFC_ATTR_RF_MODE,
	NFC_ATTR_DEVICE_POWERED,
	NFC_ATTR_IM_PROTOCOLS,
	NFC_ATTR_TM_PROTOCOLS,
/* private: internal use only */
	__NFC_ATTR_AFTER_LAST
};
#define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1)

#define NFC_DEVICE_NAME_MAXSIZE 8
#define NFC_NFCID1_MAXSIZE 10
#define NFC_SENSB_RES_MAXSIZE 12
#define NFC_SENSF_RES_MAXSIZE 18
#define NFC_GB_MAXSIZE        48

/* NFC protocols */
#define NFC_PROTO_JEWEL		1
#define NFC_PROTO_MIFARE	2
#define NFC_PROTO_FELICA	3
#define NFC_PROTO_ISO14443	4
#define NFC_PROTO_NFC_DEP	5
#define NFC_PROTO_ISO14443_B	6

#define NFC_PROTO_MAX		7

/* NFC communication modes */
#define NFC_COMM_ACTIVE  0
#define NFC_COMM_PASSIVE 1

/* NFC RF modes */
#define NFC_RF_INITIATOR 0
#define NFC_RF_TARGET    1
#define NFC_RF_NONE      2

/* NFC protocols masks used in bitsets */
#define NFC_PROTO_JEWEL_MASK      (1 << NFC_PROTO_JEWEL)
#define NFC_PROTO_MIFARE_MASK     (1 << NFC_PROTO_MIFARE)
#define NFC_PROTO_FELICA_MASK	  (1 << NFC_PROTO_FELICA)
#define NFC_PROTO_ISO14443_MASK	  (1 << NFC_PROTO_ISO14443)
#define NFC_PROTO_NFC_DEP_MASK	  (1 << NFC_PROTO_NFC_DEP)
#define NFC_PROTO_ISO14443_B_MASK (1 << NFC_PROTO_ISO14443_B)

struct sockaddr_nfc {
	sa_family_t sa_family;
	__u32 dev_idx;
	__u32 target_idx;
	__u32 nfc_protocol;
};

#define NFC_LLCP_MAX_SERVICE_NAME 63
struct sockaddr_nfc_llcp {
	sa_family_t sa_family;
	__u32 dev_idx;
	__u32 target_idx;
	__u32 nfc_protocol;
	__u8 dsap; /* Destination SAP, if known */
	__u8 ssap; /* Source SAP to be bound to */
	char service_name[NFC_LLCP_MAX_SERVICE_NAME]; /* Service name URI */;
	size_t service_name_len;
};

/* NFC socket protocols */
#define NFC_SOCKPROTO_RAW	0
#define NFC_SOCKPROTO_LLCP	1
#define NFC_SOCKPROTO_MAX	2

#define NFC_HEADER_SIZE 1

#endif /*__LINUX_NFC_H */
Commit	Line	Data
4d12b8b1 LRV	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
23b7869c LRV	27	#include <linux/types.h>
	28	#include <linux/socket.h>
	29
4d12b8b1 LRV	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
8b3fe7b5 IE	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)
4d12b8b1 LRV	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)
fc40a8c1 SO	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.
4d12b8b1 LRV	63	*/
	64	enum nfc_commands {
	65	NFC_CMD_UNSPEC,
	66	NFC_CMD_GET_DEVICE,
8b3fe7b5 IE	67	NFC_CMD_DEV_UP,
8b3fe7b5 IE	68	NFC_CMD_DEV_DOWN,
1ed28f61 SO	69	NFC_CMD_DEP_LINK_UP,
1ed28f61 SO	70	NFC_CMD_DEP_LINK_DOWN,
4d12b8b1 LRV	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,
8112a5c9	77	NFC_EVENT_TARGET_LOST,
fc40a8c1 SO	78	NFC_EVENT_TM_ACTIVATED,
fc40a8c1 SO	79	NFC_EVENT_TM_DEACTIVATED,
4d12b8b1 LRV	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)
288e0713	98	* @NFC_ATTR_TARGET_NFCID1: NFC-A targets identifier, max 10 bytes
d5a2ca60 IE	99	* @NFC_ATTR_TARGET_SENSB_RES: NFC-B targets extra information, max 12 bytes
d5a2ca60 IE	100	* @NFC_ATTR_TARGET_SENSF_RES: NFC-F targets extra information, max 18 bytes
1ed28f61 SO	101	* @NFC_ATTR_COMM_MODE: Passive or active mode
1ed28f61 SO	102	* @NFC_ATTR_RF_MODE: Initiator or target
fe7c5800 SO	103	* @NFC_ATTR_IM_PROTOCOLS: Initiator mode protocols to poll for
fe7c5800 SO	104	* @NFC_ATTR_TM_PROTOCOLS: Target mode protocols to listen for
4d12b8b1 LRV	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,
288e0713	114	NFC_ATTR_TARGET_NFCID1,
d5a2ca60 IE	115	NFC_ATTR_TARGET_SENSB_RES,
d5a2ca60 IE	116	NFC_ATTR_TARGET_SENSF_RES,
1ed28f61 SO	117	NFC_ATTR_COMM_MODE,
1ed28f61 SO	118	NFC_ATTR_RF_MODE,
c970a1ac	119	NFC_ATTR_DEVICE_POWERED,
fe7c5800 SO	120	NFC_ATTR_IM_PROTOCOLS,
fe7c5800 SO	121	NFC_ATTR_TM_PROTOCOLS,
4d12b8b1 LRV	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
d5a2ca60 IE	128	#define NFC_NFCID1_MAXSIZE 10
	129	#define NFC_SENSB_RES_MAXSIZE 12
	130	#define NFC_SENSF_RES_MAXSIZE 18
fc40a8c1	131	#define NFC_GB_MAXSIZE 48
4d12b8b1 LRV	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
01d719a2	139	#define NFC_PROTO_ISO14443_B 6
4d12b8b1	140
01d719a2	141	#define NFC_PROTO_MAX 7
4d12b8b1	142
1ed28f61 SO	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
f212ad5e	150	#define NFC_RF_NONE 2
1ed28f61	151
4d12b8b1	152	/* NFC protocols masks used in bitsets */
01d719a2 SO	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)
4d12b8b1	159
23b7869c LRV	160	struct sockaddr_nfc {
	161	sa_family_t sa_family;
	162	__u32 dev_idx;
	163	__u32 target_idx;
	164	__u32 nfc_protocol;
	165	};
	166
d646960f SO	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
c7fe3b52	179	/* NFC socket protocols */
23b7869c	180	#define NFC_SOCKPROTO_RAW 0
d646960f SO	181	#define NFC_SOCKPROTO_LLCP 1
d646960f SO	182	#define NFC_SOCKPROTO_MAX 2
c7fe3b52	183
e8753043 SO	184	#define NFC_HEADER_SIZE 1
e8753043 SO	185
4d12b8b1	186	#endif /__LINUX_NFC_H /