[linux-2.6-block.git] / include / net / nfc / nci.h

/*
 *  The NFC Controller Interface is the communication protocol between an
 *  NFC Controller (NFCC) and a Device Host (DH).
 *
 *  Copyright (C) 2014 Marvell International Ltd.
 *  Copyright (C) 2011 Texas Instruments, Inc.
 *
 *  Written by Ilan Elias <ilane@ti.com>
 *
 *  Acknowledgements:
 *  This file is based on hci.h, which was written
 *  by Maxim Krasnyansky.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation
 *
 *  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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef __NCI_H
#define __NCI_H

#include <net/nfc/nfc.h>

/* NCI constants */
#define NCI_MAX_NUM_MAPPING_CONFIGS				10
#define NCI_MAX_NUM_RF_CONFIGS					10
#define NCI_MAX_NUM_CONN					10
#define NCI_MAX_PARAM_LEN					251

/* NCI Status Codes */
#define NCI_STATUS_OK						0x00
#define NCI_STATUS_REJECTED					0x01
#define NCI_STATUS_RF_FRAME_CORRUPTED				0x02
#define NCI_STATUS_FAILED					0x03
#define NCI_STATUS_NOT_INITIALIZED				0x04
#define NCI_STATUS_SYNTAX_ERROR					0x05
#define NCI_STATUS_SEMANTIC_ERROR				0x06
#define NCI_STATUS_UNKNOWN_GID					0x07
#define NCI_STATUS_UNKNOWN_OID					0x08
#define NCI_STATUS_INVALID_PARAM				0x09
#define NCI_STATUS_MESSAGE_SIZE_EXCEEDED			0x0a
/* Discovery Specific Status Codes */
#define NCI_STATUS_DISCOVERY_ALREADY_STARTED			0xa0
#define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED		0xa1
#define NCI_STATUS_DISCOVERY_TEAR_DOWN				0xa2
/* RF Interface Specific Status Codes */
#define NCI_STATUS_RF_TRANSMISSION_ERROR			0xb0
#define NCI_STATUS_RF_PROTOCOL_ERROR				0xb1
#define NCI_STATUS_RF_TIMEOUT_ERROR				0xb2
/* NFCEE Interface Specific Status Codes */
#define NCI_STATUS_NFCEE_INTERFACE_ACTIVATION_FAILED		0xc0
#define NCI_STATUS_NFCEE_TRANSMISSION_ERROR			0xc1
#define NCI_STATUS_NFCEE_PROTOCOL_ERROR				0xc2
#define NCI_STATUS_NFCEE_TIMEOUT_ERROR				0xc3

/* NFCEE Interface/Protocols */
#define NCI_NFCEE_INTERFACE_APDU           0x00
#define NCI_NFCEE_INTERFACE_HCI_ACCESS     0x01
#define NCI_NFCEE_INTERFACE_TYPE3_CMD_SET  0x02
#define NCI_NFCEE_INTERFACE_TRANSPARENT        0x03

/* Destination type */
#define NCI_DESTINATION_NFCC_LOOPBACK      0x01
#define NCI_DESTINATION_REMOTE_NFC_ENDPOINT    0x02
#define NCI_DESTINATION_NFCEE              0x03

/* Destination-specific parameters type */
#define NCI_DESTINATION_SPECIFIC_PARAM_RF_TYPE     0x00
#define NCI_DESTINATION_SPECIFIC_PARAM_NFCEE_TYPE  0x01

/* NFCEE Discovery Action */
#define NCI_NFCEE_DISCOVERY_ACTION_DISABLE			0x00
#define NCI_NFCEE_DISCOVERY_ACTION_ENABLE			0x01

/* NCI RF Technology and Mode */
#define NCI_NFC_A_PASSIVE_POLL_MODE				0x00
#define NCI_NFC_B_PASSIVE_POLL_MODE				0x01
#define NCI_NFC_F_PASSIVE_POLL_MODE				0x02
#define NCI_NFC_A_ACTIVE_POLL_MODE				0x03
#define NCI_NFC_F_ACTIVE_POLL_MODE				0x05
#define NCI_NFC_V_PASSIVE_POLL_MODE				0x06
#define NCI_NFC_A_PASSIVE_LISTEN_MODE				0x80
#define NCI_NFC_B_PASSIVE_LISTEN_MODE				0x81
#define NCI_NFC_F_PASSIVE_LISTEN_MODE				0x82
#define NCI_NFC_A_ACTIVE_LISTEN_MODE				0x83
#define NCI_NFC_F_ACTIVE_LISTEN_MODE				0x85

#define NCI_RF_TECH_MODE_LISTEN_MASK				0x80

/* NCI RF Technologies */
#define NCI_NFC_RF_TECHNOLOGY_A					0x00
#define NCI_NFC_RF_TECHNOLOGY_B					0x01
#define NCI_NFC_RF_TECHNOLOGY_F					0x02
#define NCI_NFC_RF_TECHNOLOGY_V					0x03

/* NCI Bit Rates */
#define NCI_NFC_BIT_RATE_106					0x00
#define NCI_NFC_BIT_RATE_212					0x01
#define NCI_NFC_BIT_RATE_424					0x02
#define NCI_NFC_BIT_RATE_848					0x03
#define NCI_NFC_BIT_RATE_1695					0x04
#define NCI_NFC_BIT_RATE_3390					0x05
#define NCI_NFC_BIT_RATE_6780					0x06
#define NCI_NFC_BIT_RATE_26					0x20

/* NCI RF Protocols */
#define NCI_RF_PROTOCOL_UNKNOWN					0x00
#define NCI_RF_PROTOCOL_T1T					0x01
#define NCI_RF_PROTOCOL_T2T					0x02
#define NCI_RF_PROTOCOL_T3T					0x03
#define NCI_RF_PROTOCOL_ISO_DEP					0x04
#define NCI_RF_PROTOCOL_NFC_DEP					0x05
#define NCI_RF_PROTOCOL_T5T					0x06

/* NCI RF Interfaces */
#define NCI_RF_INTERFACE_NFCEE_DIRECT				0x00
#define NCI_RF_INTERFACE_FRAME					0x01
#define NCI_RF_INTERFACE_ISO_DEP				0x02
#define NCI_RF_INTERFACE_NFC_DEP				0x03

/* NCI Configuration Parameter Tags */
#define NCI_PN_ATR_REQ_GEN_BYTES				0x29
#define NCI_LN_ATR_RES_GEN_BYTES				0x61
#define NCI_LA_SEL_INFO						0x32
#define NCI_LF_PROTOCOL_TYPE					0x50
#define NCI_LF_CON_BITR_F					0x54

/* NCI Configuration Parameters masks */
#define NCI_LA_SEL_INFO_ISO_DEP_MASK				0x20
#define NCI_LA_SEL_INFO_NFC_DEP_MASK				0x40
#define NCI_LF_PROTOCOL_TYPE_NFC_DEP_MASK			0x02
#define NCI_LF_CON_BITR_F_212					0x02
#define NCI_LF_CON_BITR_F_424					0x04

/* NCI Reset types */
#define NCI_RESET_TYPE_KEEP_CONFIG				0x00
#define NCI_RESET_TYPE_RESET_CONFIG				0x01

/* NCI Static RF connection ID */
#define NCI_STATIC_RF_CONN_ID					0x00

/* NCI Data Flow Control */
#define NCI_DATA_FLOW_CONTROL_NOT_USED				0xff

/* NCI RF_DISCOVER_MAP_CMD modes */
#define NCI_DISC_MAP_MODE_POLL					0x01
#define NCI_DISC_MAP_MODE_LISTEN				0x02

/* NCI Discover Notification Type */
#define NCI_DISCOVER_NTF_TYPE_LAST				0x00
#define NCI_DISCOVER_NTF_TYPE_LAST_NFCC				0x01
#define NCI_DISCOVER_NTF_TYPE_MORE				0x02

/* NCI Deactivation Type */
#define NCI_DEACTIVATE_TYPE_IDLE_MODE				0x00
#define NCI_DEACTIVATE_TYPE_SLEEP_MODE				0x01
#define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE			0x02
#define NCI_DEACTIVATE_TYPE_DISCOVERY				0x03

/* Message Type (MT) */
#define NCI_MT_DATA_PKT						0x00
#define NCI_MT_CMD_PKT						0x01
#define NCI_MT_RSP_PKT						0x02
#define NCI_MT_NTF_PKT						0x03

#define nci_mt(hdr)			(((hdr)[0]>>5)&0x07)
#define nci_mt_set(hdr, mt)		((hdr)[0] |= (__u8)(((mt)&0x07)<<5))

/* Packet Boundary Flag (PBF) */
#define NCI_PBF_LAST						0x00
#define NCI_PBF_CONT						0x01

#define nci_pbf(hdr)			(__u8)(((hdr)[0]>>4)&0x01)
#define nci_pbf_set(hdr, pbf)		((hdr)[0] |= (__u8)(((pbf)&0x01)<<4))

/* Control Opcode manipulation */
#define nci_opcode_pack(gid, oid)	(__u16)((((__u16)((gid)&0x0f))<<8)|\
					((__u16)((oid)&0x3f)))
#define nci_opcode(hdr)			nci_opcode_pack(hdr[0], hdr[1])
#define nci_opcode_gid(op)		(__u8)(((op)&0x0f00)>>8)
#define nci_opcode_oid(op)		(__u8)((op)&0x003f)

/* Payload Length */
#define nci_plen(hdr)			(__u8)((hdr)[2])

/* Connection ID */
#define nci_conn_id(hdr)		(__u8)(((hdr)[0])&0x0f)

/* GID values */
#define NCI_GID_CORE						0x0
#define NCI_GID_RF_MGMT						0x1
#define NCI_GID_NFCEE_MGMT					0x2
#define NCI_GID_PROPRIETARY					0xf

/* ----- NCI over SPI head/crc(tail) room needed for outgoing frames ----- */
#define NCI_SPI_HDR_LEN						4
#define NCI_SPI_CRC_LEN						2

/* ---- NCI Packet structures ---- */
#define NCI_CTRL_HDR_SIZE					3
#define NCI_DATA_HDR_SIZE					3

struct nci_ctrl_hdr {
	__u8	gid;		/* MT & PBF & GID */
	__u8	oid;
	__u8	plen;
} __packed;

struct nci_data_hdr {
	__u8	conn_id;	/* MT & PBF & ConnID */
	__u8	rfu;
	__u8	plen;
} __packed;

/* ------------------------ */
/* -----  NCI Commands ---- */
/* ------------------------ */
#define NCI_OP_CORE_RESET_CMD		nci_opcode_pack(NCI_GID_CORE, 0x00)
struct nci_core_reset_cmd {
	__u8	reset_type;
} __packed;

#define NCI_OP_CORE_INIT_CMD		nci_opcode_pack(NCI_GID_CORE, 0x01)

#define NCI_OP_CORE_SET_CONFIG_CMD	nci_opcode_pack(NCI_GID_CORE, 0x02)
struct set_config_param {
	__u8	id;
	__u8	len;
	__u8	val[NCI_MAX_PARAM_LEN];
} __packed;

struct nci_core_set_config_cmd {
	__u8	num_params;
	struct	set_config_param param; /* support 1 param per cmd is enough */
} __packed;

#define NCI_OP_RF_DISCOVER_MAP_CMD	nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
struct disc_map_config {
	__u8	rf_protocol;
	__u8	mode;
	__u8	rf_interface;
} __packed;

struct nci_rf_disc_map_cmd {
	__u8				num_mapping_configs;
	struct disc_map_config		mapping_configs
					[NCI_MAX_NUM_MAPPING_CONFIGS];
} __packed;

#define NCI_OP_RF_DISCOVER_CMD		nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
struct disc_config {
	__u8	rf_tech_and_mode;
	__u8	frequency;
} __packed;

struct nci_rf_disc_cmd {
	__u8				num_disc_configs;
	struct disc_config		disc_configs[NCI_MAX_NUM_RF_CONFIGS];
} __packed;

#define NCI_OP_RF_DISCOVER_SELECT_CMD	nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
struct nci_rf_discover_select_cmd {
	__u8	rf_discovery_id;
	__u8	rf_protocol;
	__u8	rf_interface;
} __packed;

#define NCI_OP_RF_DEACTIVATE_CMD	nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
struct nci_rf_deactivate_cmd {
	__u8	type;
} __packed;

#define NCI_OP_NFCEE_DISCOVER_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
struct nci_nfcee_discover_cmd {
	__u8	discovery_action;
} __packed;

#define NCI_OP_NFCEE_MODE_SET_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
#define NCI_NFCEE_DISABLE	0x00
#define NCI_NFCEE_ENABLE	0x01
struct nci_nfcee_mode_set_cmd {
	__u8	nfcee_id;
	__u8	nfcee_mode;
} __packed;

/* ----------------------- */
/* ---- NCI Responses ---- */
/* ----------------------- */
#define NCI_OP_CORE_RESET_RSP		nci_opcode_pack(NCI_GID_CORE, 0x00)
struct nci_core_reset_rsp {
	__u8	status;
	__u8	nci_ver;
	__u8	config_status;
} __packed;

#define NCI_OP_CORE_INIT_RSP		nci_opcode_pack(NCI_GID_CORE, 0x01)
struct nci_core_init_rsp_1 {
	__u8	status;
	__le32	nfcc_features;
	__u8	num_supported_rf_interfaces;
	__u8	supported_rf_interfaces[0];	/* variable size array */
	/* continuted in nci_core_init_rsp_2 */
} __packed;

struct nci_core_init_rsp_2 {
	__u8	max_logical_connections;
	__le16	max_routing_table_size;
	__u8	max_ctrl_pkt_payload_len;
	__le16	max_size_for_large_params;
	__u8	manufact_id;
	__le32	manufact_specific_info;
} __packed;

#define NCI_OP_CORE_SET_CONFIG_RSP	nci_opcode_pack(NCI_GID_CORE, 0x02)
struct nci_core_set_config_rsp {
	__u8	status;
	__u8	num_params;
	__u8	params_id[0];	/* variable size array */
} __packed;

#define NCI_OP_RF_DISCOVER_MAP_RSP	nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)

#define NCI_OP_RF_DISCOVER_RSP		nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)

#define NCI_OP_RF_DISCOVER_SELECT_RSP	nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)

#define NCI_OP_RF_DEACTIVATE_RSP	nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)

#define NCI_OP_NFCEE_DISCOVER_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
struct nci_nfcee_discover_rsp {
	__u8	status;
	__u8	num_nfcee;
} __packed;

#define NCI_OP_NFCEE_MODE_SET_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
/* --------------------------- */
/* ---- NCI Notifications ---- */
/* --------------------------- */
#define NCI_OP_CORE_CONN_CREDITS_NTF	nci_opcode_pack(NCI_GID_CORE, 0x06)
struct conn_credit_entry {
	__u8	conn_id;
	__u8	credits;
} __packed;

struct nci_core_conn_credit_ntf {
	__u8				num_entries;
	struct conn_credit_entry	conn_entries[NCI_MAX_NUM_CONN];
} __packed;

#define NCI_OP_CORE_GENERIC_ERROR_NTF	nci_opcode_pack(NCI_GID_CORE, 0x07)

#define NCI_OP_CORE_INTF_ERROR_NTF	nci_opcode_pack(NCI_GID_CORE, 0x08)
struct nci_core_intf_error_ntf {
	__u8	status;
	__u8	conn_id;
} __packed;

#define NCI_OP_RF_DISCOVER_NTF		nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
struct rf_tech_specific_params_nfca_poll {
	__u16	sens_res;
	__u8	nfcid1_len;	/* 0, 4, 7, or 10 Bytes */
	__u8	nfcid1[NFC_NFCID1_MAXSIZE];
	__u8	sel_res_len;	/* 0 or 1 Bytes */
	__u8	sel_res;
} __packed;

struct rf_tech_specific_params_nfcb_poll {
	__u8	sensb_res_len;
	__u8	sensb_res[NFC_SENSB_RES_MAXSIZE];	/* 11 or 12 Bytes */
} __packed;

struct rf_tech_specific_params_nfcf_poll {
	__u8	bit_rate;
	__u8	sensf_res_len;
	__u8	sensf_res[NFC_SENSF_RES_MAXSIZE];	/* 16 or 18 Bytes */
} __packed;

struct rf_tech_specific_params_nfcv_poll {
	__u8	res_flags;
	__u8	dsfid;
	__u8	uid[NFC_ISO15693_UID_MAXSIZE];	/* 8 Bytes */
} __packed;

struct rf_tech_specific_params_nfcf_listen {
	__u8	local_nfcid2_len;
	__u8	local_nfcid2[NFC_NFCID2_MAXSIZE];	/* 0 or 8 Bytes */
} __packed;

struct nci_rf_discover_ntf {
	__u8	rf_discovery_id;
	__u8	rf_protocol;
	__u8	rf_tech_and_mode;
	__u8	rf_tech_specific_params_len;

	union {
		struct rf_tech_specific_params_nfca_poll nfca_poll;
		struct rf_tech_specific_params_nfcb_poll nfcb_poll;
		struct rf_tech_specific_params_nfcf_poll nfcf_poll;
		struct rf_tech_specific_params_nfcv_poll nfcv_poll;
	} rf_tech_specific_params;

	__u8	ntf_type;
} __packed;

#define NCI_OP_RF_INTF_ACTIVATED_NTF	nci_opcode_pack(NCI_GID_RF_MGMT, 0x05)
struct activation_params_nfca_poll_iso_dep {
	__u8	rats_res_len;
	__u8	rats_res[20];
};

struct activation_params_nfcb_poll_iso_dep {
	__u8	attrib_res_len;
	__u8	attrib_res[50];
};

struct activation_params_poll_nfc_dep {
	__u8	atr_res_len;
	__u8	atr_res[NFC_ATR_RES_MAXSIZE - 2]; /* ATR_RES from byte 3 */
};

struct activation_params_listen_nfc_dep {
	__u8	atr_req_len;
	__u8	atr_req[NFC_ATR_REQ_MAXSIZE - 2]; /* ATR_REQ from byte 3 */
};

struct nci_rf_intf_activated_ntf {
	__u8	rf_discovery_id;
	__u8	rf_interface;
	__u8	rf_protocol;
	__u8	activation_rf_tech_and_mode;
	__u8	max_data_pkt_payload_size;
	__u8	initial_num_credits;
	__u8	rf_tech_specific_params_len;

	union {
		struct rf_tech_specific_params_nfca_poll nfca_poll;
		struct rf_tech_specific_params_nfcb_poll nfcb_poll;
		struct rf_tech_specific_params_nfcf_poll nfcf_poll;
		struct rf_tech_specific_params_nfcv_poll nfcv_poll;
		struct rf_tech_specific_params_nfcf_listen nfcf_listen;
	} rf_tech_specific_params;

	__u8	data_exch_rf_tech_and_mode;
	__u8	data_exch_tx_bit_rate;
	__u8	data_exch_rx_bit_rate;
	__u8	activation_params_len;

	union {
		struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep;
		struct activation_params_nfcb_poll_iso_dep nfcb_poll_iso_dep;
		struct activation_params_poll_nfc_dep poll_nfc_dep;
		struct activation_params_listen_nfc_dep listen_nfc_dep;
	} activation_params;

} __packed;

#define NCI_OP_RF_DEACTIVATE_NTF	nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
struct nci_rf_deactivate_ntf {
	__u8	type;
	__u8	reason;
} __packed;

#define NCI_OP_NFCEE_DISCOVER_NTF nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
struct nci_nfcee_supported_protocol {
	__u8	num_protocol;
	__u8	supported_protocol[0];
} __packed;

struct nci_nfcee_information_tlv {
	__u8	num_tlv;
	__u8	information_tlv[0];
} __packed;

struct nci_nfcee_discover_ntf {
	__u8	nfcee_id;
	__u8	nfcee_status;
	struct nci_nfcee_supported_protocol supported_protocols;
	struct nci_nfcee_information_tlv	information_tlv;
} __packed;

#endif /* __NCI_H */
Commit	Line	Data
6a2968aa IE	1	/*
	2	* The NFC Controller Interface is the communication protocol between an
	3	* NFC Controller (NFCC) and a Device Host (DH).
	4	*
cfdbeeaf	5	* Copyright (C) 2014 Marvell International Ltd.
6a2968aa IE	6	* Copyright (C) 2011 Texas Instruments, Inc.
	7	*
	8	* Written by Ilan Elias <ilane@ti.com>
	9	*
	10	* Acknowledgements:
	11	* This file is based on hci.h, which was written
	12	* by Maxim Krasnyansky.
	13	*
	14	* This program is free software; you can redistribute it and/or modify
	15	* it under the terms of the GNU General Public License version 2
	16	* as published by the Free Software Foundation
	17	*
	18	* This program is distributed in the hope that it will be useful,
	19	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	* GNU General Public License for more details.
	22	*
	23	* You should have received a copy of the GNU General Public License
a6227e26	24	* along with this program; if not, see <http://www.gnu.org/licenses/>.
6a2968aa IE	25	*
	26	*/
	27
	28	#ifndef __NCI_H
	29	#define __NCI_H
	30
a99903ec JL	31	#include <net/nfc/nfc.h>
a99903ec JL	32
6a2968aa IE	33	/* NCI constants */
	34	#define NCI_MAX_NUM_MAPPING_CONFIGS 10
	35	#define NCI_MAX_NUM_RF_CONFIGS 10
	36	#define NCI_MAX_NUM_CONN 10
7e035230	37	#define NCI_MAX_PARAM_LEN 251
6a2968aa IE	38
6a2968aa IE	39	/* NCI Status Codes */
ccb290fc IE	40	#define NCI_STATUS_OK 0x00
	41	#define NCI_STATUS_REJECTED 0x01
	42	#define NCI_STATUS_RF_FRAME_CORRUPTED 0x02
	43	#define NCI_STATUS_FAILED 0x03
	44	#define NCI_STATUS_NOT_INITIALIZED 0x04
	45	#define NCI_STATUS_SYNTAX_ERROR 0x05
	46	#define NCI_STATUS_SEMANTIC_ERROR 0x06
	47	#define NCI_STATUS_UNKNOWN_GID 0x07
	48	#define NCI_STATUS_UNKNOWN_OID 0x08
	49	#define NCI_STATUS_INVALID_PARAM 0x09
	50	#define NCI_STATUS_MESSAGE_SIZE_EXCEEDED 0x0a
6a2968aa	51	/* Discovery Specific Status Codes */
ccb290fc IE	52	#define NCI_STATUS_DISCOVERY_ALREADY_STARTED 0xa0
	53	#define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED 0xa1
	54	#define NCI_STATUS_DISCOVERY_TEAR_DOWN 0xa2
6a2968aa	55	/* RF Interface Specific Status Codes */
ccb290fc IE	56	#define NCI_STATUS_RF_TRANSMISSION_ERROR 0xb0
	57	#define NCI_STATUS_RF_PROTOCOL_ERROR 0xb1
	58	#define NCI_STATUS_RF_TIMEOUT_ERROR 0xb2
6a2968aa	59	/* NFCEE Interface Specific Status Codes */
637d85a7 IE	60	#define NCI_STATUS_NFCEE_INTERFACE_ACTIVATION_FAILED 0xc0
	61	#define NCI_STATUS_NFCEE_TRANSMISSION_ERROR 0xc1
	62	#define NCI_STATUS_NFCEE_PROTOCOL_ERROR 0xc2
	63	#define NCI_STATUS_NFCEE_TIMEOUT_ERROR 0xc3
6a2968aa	64
8277f693 CR	65	/* NFCEE Interface/Protocols */
	66	#define NCI_NFCEE_INTERFACE_APDU 0x00
	67	#define NCI_NFCEE_INTERFACE_HCI_ACCESS 0x01
	68	#define NCI_NFCEE_INTERFACE_TYPE3_CMD_SET 0x02
	69	#define NCI_NFCEE_INTERFACE_TRANSPARENT 0x03
	70
	71	/* Destination type */
	72	#define NCI_DESTINATION_NFCC_LOOPBACK 0x01
	73	#define NCI_DESTINATION_REMOTE_NFC_ENDPOINT 0x02
	74	#define NCI_DESTINATION_NFCEE 0x03
	75
	76	/* Destination-specific parameters type */
	77	#define NCI_DESTINATION_SPECIFIC_PARAM_RF_TYPE 0x00
	78	#define NCI_DESTINATION_SPECIFIC_PARAM_NFCEE_TYPE 0x01
	79
	80	/* NFCEE Discovery Action */
	81	#define NCI_NFCEE_DISCOVERY_ACTION_DISABLE 0x00
	82	#define NCI_NFCEE_DISCOVERY_ACTION_ENABLE 0x01
	83
6a2968aa IE	84	/* NCI RF Technology and Mode */
	85	#define NCI_NFC_A_PASSIVE_POLL_MODE 0x00
	86	#define NCI_NFC_B_PASSIVE_POLL_MODE 0x01
	87	#define NCI_NFC_F_PASSIVE_POLL_MODE 0x02
	88	#define NCI_NFC_A_ACTIVE_POLL_MODE 0x03
	89	#define NCI_NFC_F_ACTIVE_POLL_MODE 0x05
cfdbeeaf	90	#define NCI_NFC_V_PASSIVE_POLL_MODE 0x06
6a2968aa IE	91	#define NCI_NFC_A_PASSIVE_LISTEN_MODE 0x80
	92	#define NCI_NFC_B_PASSIVE_LISTEN_MODE 0x81
	93	#define NCI_NFC_F_PASSIVE_LISTEN_MODE 0x82
	94	#define NCI_NFC_A_ACTIVE_LISTEN_MODE 0x83
	95	#define NCI_NFC_F_ACTIVE_LISTEN_MODE 0x85
	96
a99903ec JL	97	#define NCI_RF_TECH_MODE_LISTEN_MASK 0x80
a99903ec JL	98
e8c0dacd IE	99	/* NCI RF Technologies */
	100	#define NCI_NFC_RF_TECHNOLOGY_A 0x00
	101	#define NCI_NFC_RF_TECHNOLOGY_B 0x01
	102	#define NCI_NFC_RF_TECHNOLOGY_F 0x02
cfdbeeaf	103	#define NCI_NFC_RF_TECHNOLOGY_V 0x03
e8c0dacd IE	104
	105	/* NCI Bit Rates */
	106	#define NCI_NFC_BIT_RATE_106 0x00
	107	#define NCI_NFC_BIT_RATE_212 0x01
	108	#define NCI_NFC_BIT_RATE_424 0x02
	109	#define NCI_NFC_BIT_RATE_848 0x03
637d85a7 IE	110	#define NCI_NFC_BIT_RATE_1695 0x04
	111	#define NCI_NFC_BIT_RATE_3390 0x05
	112	#define NCI_NFC_BIT_RATE_6780 0x06
cfdbeeaf	113	#define NCI_NFC_BIT_RATE_26 0x20
e8c0dacd	114
6a2968aa IE	115	/* NCI RF Protocols */
	116	#define NCI_RF_PROTOCOL_UNKNOWN 0x00
	117	#define NCI_RF_PROTOCOL_T1T 0x01
	118	#define NCI_RF_PROTOCOL_T2T 0x02
	119	#define NCI_RF_PROTOCOL_T3T 0x03
	120	#define NCI_RF_PROTOCOL_ISO_DEP 0x04
	121	#define NCI_RF_PROTOCOL_NFC_DEP 0x05
cfdbeeaf	122	#define NCI_RF_PROTOCOL_T5T 0x06
6a2968aa IE	123
6a2968aa IE	124	/* NCI RF Interfaces */
e8c0dacd	125	#define NCI_RF_INTERFACE_NFCEE_DIRECT 0x00
ccb290fc IE	126	#define NCI_RF_INTERFACE_FRAME 0x01
	127	#define NCI_RF_INTERFACE_ISO_DEP 0x02
	128	#define NCI_RF_INTERFACE_NFC_DEP 0x03
6a2968aa	129
7e035230 IE	130	/* NCI Configuration Parameter Tags */
7e035230 IE	131	#define NCI_PN_ATR_REQ_GEN_BYTES 0x29
529ee066	132	#define NCI_LN_ATR_RES_GEN_BYTES 0x61
90d78c13 JL	133	#define NCI_LA_SEL_INFO 0x32
	134	#define NCI_LF_PROTOCOL_TYPE 0x50
	135	#define NCI_LF_CON_BITR_F 0x54
	136
	137	/* NCI Configuration Parameters masks */
	138	#define NCI_LA_SEL_INFO_ISO_DEP_MASK 0x20
	139	#define NCI_LA_SEL_INFO_NFC_DEP_MASK 0x40
	140	#define NCI_LF_PROTOCOL_TYPE_NFC_DEP_MASK 0x02
	141	#define NCI_LF_CON_BITR_F_212 0x02
	142	#define NCI_LF_CON_BITR_F_424 0x04
7e035230	143
e8c0dacd IE	144	/* NCI Reset types */
	145	#define NCI_RESET_TYPE_KEEP_CONFIG 0x00
	146	#define NCI_RESET_TYPE_RESET_CONFIG 0x01
	147
	148	/* NCI Static RF connection ID */
	149	#define NCI_STATIC_RF_CONN_ID 0x00
	150
db98c829 IE	151	/* NCI Data Flow Control */
	152	#define NCI_DATA_FLOW_CONTROL_NOT_USED 0xff
	153
6a2968aa IE	154	/* NCI RF_DISCOVER_MAP_CMD modes */
	155	#define NCI_DISC_MAP_MODE_POLL 0x01
	156	#define NCI_DISC_MAP_MODE_LISTEN 0x02
6a2968aa	157
019c4fba IE	158	/* NCI Discover Notification Type */
	159	#define NCI_DISCOVER_NTF_TYPE_LAST 0x00
	160	#define NCI_DISCOVER_NTF_TYPE_LAST_NFCC 0x01
	161	#define NCI_DISCOVER_NTF_TYPE_MORE 0x02
	162
6a2968aa	163	/* NCI Deactivation Type */
ccb290fc IE	164	#define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00
	165	#define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01
	166	#define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02
	167	#define NCI_DEACTIVATE_TYPE_DISCOVERY 0x03
6a2968aa IE	168
	169	/* Message Type (MT) */
	170	#define NCI_MT_DATA_PKT 0x00
	171	#define NCI_MT_CMD_PKT 0x01
	172	#define NCI_MT_RSP_PKT 0x02
	173	#define NCI_MT_NTF_PKT 0x03
	174
	175	#define nci_mt(hdr) (((hdr)[0]>>5)&0x07)
	176	#define nci_mt_set(hdr, mt) ((hdr)[0] \|= (__u8)(((mt)&0x07)<<5))
	177
	178	/* Packet Boundary Flag (PBF) */
	179	#define NCI_PBF_LAST 0x00
	180	#define NCI_PBF_CONT 0x01
	181
	182	#define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01)
	183	#define nci_pbf_set(hdr, pbf) ((hdr)[0] \|= (__u8)(((pbf)&0x01)<<4))
	184
	185	/* Control Opcode manipulation */
	186	#define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)\|\
	187	((__u16)((oid)&0x3f)))
	188	#define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1])
	189	#define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8)
	190	#define nci_opcode_oid(op) (__u8)((op)&0x003f)
	191
	192	/* Payload Length */
	193	#define nci_plen(hdr) (__u8)((hdr)[2])
	194
	195	/* Connection ID */
	196	#define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f)
	197
	198	/* GID values */
ccb290fc IE	199	#define NCI_GID_CORE 0x0
	200	#define NCI_GID_RF_MGMT 0x1
	201	#define NCI_GID_NFCEE_MGMT 0x2
	202	#define NCI_GID_PROPRIETARY 0xf
6a2968aa	203
fa544fff EL	204	/* ----- NCI over SPI head/crc(tail) room needed for outgoing frames ----- */
	205	#define NCI_SPI_HDR_LEN 4
	206	#define NCI_SPI_CRC_LEN 2
	207
6a2968aa IE	208	/* ---- NCI Packet structures ---- */
	209	#define NCI_CTRL_HDR_SIZE 3
	210	#define NCI_DATA_HDR_SIZE 3
	211
	212	struct nci_ctrl_hdr {
	213	__u8 gid; /* MT & PBF & GID */
	214	__u8 oid;
	215	__u8 plen;
	216	} __packed;
	217
	218	struct nci_data_hdr {
	219	__u8 conn_id; /* MT & PBF & ConnID */
	220	__u8 rfu;
	221	__u8 plen;
	222	} __packed;
	223
	224	/* ------------------------ */
	225	/* ----- NCI Commands ---- */
	226	/* ------------------------ */
	227	#define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00)
e8c0dacd IE	228	struct nci_core_reset_cmd {
	229	__u8 reset_type;
	230	} __packed;
6a2968aa IE	231
	232	#define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01)
	233
7e035230 IE	234	#define NCI_OP_CORE_SET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x02)
	235	struct set_config_param {
	236	__u8 id;
	237	__u8 len;
	238	__u8 val[NCI_MAX_PARAM_LEN];
	239	} __packed;
	240
	241	struct nci_core_set_config_cmd {
	242	__u8 num_params;
	243	struct set_config_param param; /* support 1 param per cmd is enough */
	244	} __packed;
	245
6a2968aa IE	246	#define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
	247	struct disc_map_config {
	248	__u8 rf_protocol;
	249	__u8 mode;
637d85a7	250	__u8 rf_interface;
6a2968aa IE	251	} __packed;
	252
	253	struct nci_rf_disc_map_cmd {
	254	__u8 num_mapping_configs;
	255	struct disc_map_config mapping_configs
	256	[NCI_MAX_NUM_MAPPING_CONFIGS];
	257	} __packed;
	258
	259	#define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
	260	struct disc_config {
637d85a7	261	__u8 rf_tech_and_mode;
6a2968aa IE	262	__u8 frequency;
	263	} __packed;
	264
	265	struct nci_rf_disc_cmd {
	266	__u8 num_disc_configs;
	267	struct disc_config disc_configs[NCI_MAX_NUM_RF_CONFIGS];
	268	} __packed;
	269
019c4fba IE	270	#define NCI_OP_RF_DISCOVER_SELECT_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
	271	struct nci_rf_discover_select_cmd {
	272	__u8 rf_discovery_id;
	273	__u8 rf_protocol;
	274	__u8 rf_interface;
	275	} __packed;
	276
6a2968aa IE	277	#define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
	278	struct nci_rf_deactivate_cmd {
	279	__u8 type;
	280	} __packed;
	281
8277f693 CR	282	#define NCI_OP_NFCEE_DISCOVER_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
	283	struct nci_nfcee_discover_cmd {
	284	__u8 discovery_action;
	285	} __packed;
	286
f7f793f3 CR	287	#define NCI_OP_NFCEE_MODE_SET_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
	288	#define NCI_NFCEE_DISABLE 0x00
	289	#define NCI_NFCEE_ENABLE 0x01
	290	struct nci_nfcee_mode_set_cmd {
	291	__u8 nfcee_id;
	292	__u8 nfcee_mode;
	293	} __packed;
	294
6a2968aa IE	295	/* ----------------------- */
	296	/* ---- NCI Responses ---- */
	297	/* ----------------------- */
	298	#define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00)
	299	struct nci_core_reset_rsp {
	300	__u8 status;
	301	__u8 nci_ver;
e8c0dacd	302	__u8 config_status;
6a2968aa IE	303	} __packed;
	304
	305	#define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01)
	306	struct nci_core_init_rsp_1 {
	307	__u8 status;
	308	__le32 nfcc_features;
	309	__u8 num_supported_rf_interfaces;
	310	__u8 supported_rf_interfaces[0]; /* variable size array */
	311	/* continuted in nci_core_init_rsp_2 */
	312	} __packed;
	313
	314	struct nci_core_init_rsp_2 {
	315	__u8 max_logical_connections;
	316	__le16 max_routing_table_size;
e8c0dacd IE	317	__u8 max_ctrl_pkt_payload_len;
e8c0dacd IE	318	__le16 max_size_for_large_params;
e8c0dacd IE	319	__u8 manufact_id;
e8c0dacd IE	320	__le32 manufact_specific_info;
6a2968aa IE	321	} __packed;
6a2968aa IE	322
7e035230 IE	323	#define NCI_OP_CORE_SET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x02)
	324	struct nci_core_set_config_rsp {
	325	__u8 status;
	326	__u8 num_params;
	327	__u8 params_id[0]; /* variable size array */
	328	} __packed;
	329
6a2968aa IE	330	#define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
	331
	332	#define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
	333
019c4fba IE	334	#define NCI_OP_RF_DISCOVER_SELECT_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
019c4fba IE	335
6a2968aa IE	336	#define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
6a2968aa IE	337
8277f693 CR	338	#define NCI_OP_NFCEE_DISCOVER_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
	339	struct nci_nfcee_discover_rsp {
	340	__u8 status;
	341	__u8 num_nfcee;
	342	} __packed;
	343
f7f793f3	344	#define NCI_OP_NFCEE_MODE_SET_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
6a2968aa IE	345	/* --------------------------- */
	346	/* ---- NCI Notifications ---- */
	347	/* --------------------------- */
637d85a7	348	#define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x06)
6a2968aa IE	349	struct conn_credit_entry {
	350	__u8 conn_id;
	351	__u8 credits;
	352	} __packed;
	353
	354	struct nci_core_conn_credit_ntf {
	355	__u8 num_entries;
	356	struct conn_credit_entry conn_entries[NCI_MAX_NUM_CONN];
	357	} __packed;
6a2968aa	358
019c4fba IE	359	#define NCI_OP_CORE_GENERIC_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x07)
019c4fba IE	360
004161cb IE	361	#define NCI_OP_CORE_INTF_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x08)
	362	struct nci_core_intf_error_ntf {
	363	__u8 status;
	364	__u8 conn_id;
	365	} __packed;
	366
019c4fba	367	#define NCI_OP_RF_DISCOVER_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
6a2968aa IE	368	struct rf_tech_specific_params_nfca_poll {
	369	__u16 sens_res;
	370	__u8 nfcid1_len; /* 0, 4, 7, or 10 Bytes */
a99903ec	371	__u8 nfcid1[NFC_NFCID1_MAXSIZE];
6a2968aa IE	372	__u8 sel_res_len; /* 0 or 1 Bytes */
	373	__u8 sel_res;
	374	} __packed;
	375
d5a2ca60 IE	376	struct rf_tech_specific_params_nfcb_poll {
d5a2ca60 IE	377	__u8 sensb_res_len;
a99903ec	378	__u8 sensb_res[NFC_SENSB_RES_MAXSIZE]; /* 11 or 12 Bytes */
d5a2ca60 IE	379	} __packed;
	380
	381	struct rf_tech_specific_params_nfcf_poll {
	382	__u8 bit_rate;
	383	__u8 sensf_res_len;
a99903ec	384	__u8 sensf_res[NFC_SENSF_RES_MAXSIZE]; /* 16 or 18 Bytes */
d5a2ca60 IE	385	} __packed;
d5a2ca60 IE	386
cfdbeeaf VC	387	struct rf_tech_specific_params_nfcv_poll {
	388	__u8 res_flags;
	389	__u8 dsfid;
a99903ec JL	390	__u8 uid[NFC_ISO15693_UID_MAXSIZE]; /* 8 Bytes */
	391	} __packed;
	392
	393	struct rf_tech_specific_params_nfcf_listen {
	394	__u8 local_nfcid2_len;
	395	__u8 local_nfcid2[NFC_NFCID2_MAXSIZE]; /* 0 or 8 Bytes */
cfdbeeaf VC	396	} __packed;
cfdbeeaf VC	397
019c4fba IE	398	struct nci_rf_discover_ntf {
	399	__u8 rf_discovery_id;
	400	__u8 rf_protocol;
	401	__u8 rf_tech_and_mode;
	402	__u8 rf_tech_specific_params_len;
	403
	404	union {
	405	struct rf_tech_specific_params_nfca_poll nfca_poll;
	406	struct rf_tech_specific_params_nfcb_poll nfcb_poll;
	407	struct rf_tech_specific_params_nfcf_poll nfcf_poll;
cfdbeeaf	408	struct rf_tech_specific_params_nfcv_poll nfcv_poll;
019c4fba IE	409	} rf_tech_specific_params;
	410
	411	__u8 ntf_type;
	412	} __packed;
	413
	414	#define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05)
6a2968aa IE	415	struct activation_params_nfca_poll_iso_dep {
	416	__u8 rats_res_len;
	417	__u8 rats_res[20];
	418	};
	419
d5a2ca60 IE	420	struct activation_params_nfcb_poll_iso_dep {
	421	__u8 attrib_res_len;
	422	__u8 attrib_res[50];
	423	};
	424
ac206838 IE	425	struct activation_params_poll_nfc_dep {
ac206838 IE	426	__u8 atr_res_len;
a99903ec JL	427	__u8 atr_res[NFC_ATR_RES_MAXSIZE - 2]; /* ATR_RES from byte 3 */
	428	};
	429
	430	struct activation_params_listen_nfc_dep {
	431	__u8 atr_req_len;
	432	__u8 atr_req[NFC_ATR_REQ_MAXSIZE - 2]; /* ATR_REQ from byte 3 */
ac206838 IE	433	};
ac206838 IE	434
e8c0dacd IE	435	struct nci_rf_intf_activated_ntf {
e8c0dacd IE	436	__u8 rf_discovery_id;
637d85a7	437	__u8 rf_interface;
6a2968aa	438	__u8 rf_protocol;
e8c0dacd	439	__u8 activation_rf_tech_and_mode;
637d85a7 IE	440	__u8 max_data_pkt_payload_size;
637d85a7 IE	441	__u8 initial_num_credits;
6a2968aa IE	442	__u8 rf_tech_specific_params_len;
	443
	444	union {
	445	struct rf_tech_specific_params_nfca_poll nfca_poll;
d5a2ca60 IE	446	struct rf_tech_specific_params_nfcb_poll nfcb_poll;
d5a2ca60 IE	447	struct rf_tech_specific_params_nfcf_poll nfcf_poll;
cfdbeeaf	448	struct rf_tech_specific_params_nfcv_poll nfcv_poll;
a99903ec	449	struct rf_tech_specific_params_nfcf_listen nfcf_listen;
6a2968aa IE	450	} rf_tech_specific_params;
6a2968aa IE	451
e8c0dacd IE	452	__u8 data_exch_rf_tech_and_mode;
	453	__u8 data_exch_tx_bit_rate;
	454	__u8 data_exch_rx_bit_rate;
6a2968aa IE	455	__u8 activation_params_len;
	456
	457	union {
	458	struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep;
d5a2ca60	459	struct activation_params_nfcb_poll_iso_dep nfcb_poll_iso_dep;
ac206838	460	struct activation_params_poll_nfc_dep poll_nfc_dep;
a99903ec	461	struct activation_params_listen_nfc_dep listen_nfc_dep;
6a2968aa IE	462	} activation_params;
	463
	464	} __packed;
	465
	466	#define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
e8c0dacd IE	467	struct nci_rf_deactivate_ntf {
	468	__u8 type;
	469	__u8 reason;
	470	} __packed;
6a2968aa	471
8277f693 CR	472	#define NCI_OP_NFCEE_DISCOVER_NTF nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
	473	struct nci_nfcee_supported_protocol {
	474	__u8 num_protocol;
	475	__u8 supported_protocol[0];
	476	} __packed;
	477
	478	struct nci_nfcee_information_tlv {
	479	__u8 num_tlv;
	480	__u8 information_tlv[0];
	481	} __packed;
	482
	483	struct nci_nfcee_discover_ntf {
	484	__u8 nfcee_id;
	485	__u8 nfcee_status;
	486	struct nci_nfcee_supported_protocol supported_protocols;
	487	struct nci_nfcee_information_tlv information_tlv;
	488	} __packed;
	489
6a2968aa	490	#endif /* __NCI_H */