[deliverable/linux.git] / include / net / nfc / 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef __NET_NFC_H
#define __NET_NFC_H

#include <linux/nfc.h>
#include <linux/device.h>
#include <linux/skbuff.h>

#define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__)
#define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__)

struct nfc_phy_ops {
	int (*write)(void *dev_id, struct sk_buff *skb);
	int (*enable)(void *dev_id);
	void (*disable)(void *dev_id);
};

struct nfc_dev;

/**
 * data_exchange_cb_t - Definition of nfc_data_exchange callback
 *
 * @context: nfc_data_exchange cb_context parameter
 * @skb: response data
 * @err: If an error has occurred during data exchange, it is the
 *	error number. Zero means no error.
 *
 * When a rx or tx package is lost or corrupted or the target gets out
 * of the operating field, err is -EIO.
 */
typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
								int err);

typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);

struct nfc_target;

struct nfc_ops {
	int (*dev_up)(struct nfc_dev *dev);
	int (*dev_down)(struct nfc_dev *dev);
	int (*start_poll)(struct nfc_dev *dev,
			  u32 im_protocols, u32 tm_protocols);
	void (*stop_poll)(struct nfc_dev *dev);
	int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
			   u8 comm_mode, u8 *gb, size_t gb_len);
	int (*dep_link_down)(struct nfc_dev *dev);
	int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
			       u32 protocol);
	void (*deactivate_target)(struct nfc_dev *dev,
				  struct nfc_target *target);
	int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
			     struct sk_buff *skb, data_exchange_cb_t cb,
			     void *cb_context);
	int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
	int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
	int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);

	/* Secure Element API */
	int (*discover_se)(struct nfc_dev *dev);
	int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
	int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
	int (*se_io) (struct nfc_dev *dev, u32 se_idx,
		      u8 *apdu, size_t apdu_length,
		      se_io_cb_t cb, void *cb_context);
};

#define NFC_TARGET_IDX_ANY -1
#define NFC_MAX_GT_LEN 48
#define NFC_ATR_RES_GT_OFFSET 15

/**
 * struct nfc_target - NFC target descriptiom
 *
 * @sens_res: 2 bytes describing the target SENS_RES response, if the target
 *	is a type A one. The %sens_res most significant byte must be byte 2
 *	as described by the NFC Forum digital specification (i.e. the platform
 *	configuration one) while %sens_res least significant byte is byte 1.
 */
struct nfc_target {
	u32 idx;
	u32 supported_protocols;
	u16 sens_res;
	u8 sel_res;
	u8 nfcid1_len;
	u8 nfcid1[NFC_NFCID1_MAXSIZE];
	u8 nfcid2_len;
	u8 nfcid2[NFC_NFCID2_MAXSIZE];
	u8 sensb_res_len;
	u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
	u8 sensf_res_len;
	u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
	u8 hci_reader_gate;
	u8 logical_idx;
	u8 is_iso15693;
	u8 iso15693_dsfid;
	u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
};

/**
 * nfc_se - A structure for NFC accessible secure elements.
 *
 * @idx: The secure element index. User space will enable or
 *       disable a secure element by its index.
 * @type: The secure element type. It can be SE_UICC or
 *        SE_EMBEDDED.
 * @state: The secure element state, either enabled or disabled.
 *
 */
struct nfc_se {
	struct list_head list;
	u32 idx;
	u16 type;
	u16 state;
};

struct nfc_genl_data {
	u32 poll_req_portid;
	struct mutex genl_data_mutex;
};

struct nfc_dev {
	int idx;
	u32 target_next_idx;
	struct nfc_target *targets;
	int n_targets;
	int targets_generation;
	struct device dev;
	bool dev_up;
	bool fw_download_in_progress;
	u8 rf_mode;
	bool polling;
	struct nfc_target *active_target;
	bool dep_link_up;
	struct nfc_genl_data genl_data;
	u32 supported_protocols;

	struct list_head secure_elements;

	int tx_headroom;
	int tx_tailroom;

	struct timer_list check_pres_timer;
	struct work_struct check_pres_work;

	bool shutting_down;

	struct rfkill *rfkill;

	struct nfc_ops *ops;
};
#define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)

extern struct class nfc_class;

struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
				    u32 supported_protocols,
				    int tx_headroom,
				    int tx_tailroom);

/**
 * nfc_free_device - free nfc device
 *
 * @dev: The nfc device to free
 */
static inline void nfc_free_device(struct nfc_dev *dev)
{
	put_device(&dev->dev);
}

int nfc_register_device(struct nfc_dev *dev);

void nfc_unregister_device(struct nfc_dev *dev);

/**
 * nfc_set_parent_dev - set the parent device
 *
 * @nfc_dev: The nfc device whose parent is being set
 * @dev: The parent device
 */
static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
				      struct device *dev)
{
	nfc_dev->dev.parent = dev;
}

/**
 * nfc_set_drvdata - set driver specifc data
 *
 * @dev: The nfc device
 * @data: Pointer to driver specifc data
 */
static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
{
	dev_set_drvdata(&dev->dev, data);
}

/**
 * nfc_get_drvdata - get driver specifc data
 *
 * @dev: The nfc device
 */
static inline void *nfc_get_drvdata(struct nfc_dev *dev)
{
	return dev_get_drvdata(&dev->dev);
}

/**
 * nfc_device_name - get the nfc device name
 *
 * @dev: The nfc device whose name to return
 */
static inline const char *nfc_device_name(struct nfc_dev *dev)
{
	return dev_name(&dev->dev);
}

struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
				   unsigned int flags, unsigned int size,
				   unsigned int *err);
struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);

int nfc_set_remote_general_bytes(struct nfc_dev *dev,
				 u8 *gt, u8 gt_len);
u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);

int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
			 u32 result);

int nfc_targets_found(struct nfc_dev *dev,
		      struct nfc_target *targets, int ntargets);
int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);

int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
		       u8 comm_mode, u8 rf_mode);

int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
		     u8 *gb, size_t gb_len);
int nfc_tm_deactivated(struct nfc_dev *dev);
int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);

void nfc_driver_failure(struct nfc_dev *dev, int err);

int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);

void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb,
			  u8 payload_type, u8 direction);

#endif /* __NET_NFC_H */
Commit	Line	Data
3e256b8f 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
a6227e26	19	* along with this program; if not, see <http://www.gnu.org/licenses/>.
3e256b8f LRV	20	*/
	21
	22	#ifndef __NET_NFC_H
	23	#define __NET_NFC_H
	24
d5a2ca60	25	#include <linux/nfc.h>
3e256b8f LRV	26	#include <linux/device.h>
	27	#include <linux/skbuff.h>
	28
073a625f JP	29	#define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__)
073a625f JP	30	#define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__)
3e256b8f	31
08f13acf EL	32	struct nfc_phy_ops {
	33	int (write)(void dev_id, struct sk_buff *skb);
	34	int (enable)(void dev_id);
	35	void (disable)(void dev_id);
	36	};
	37
3e256b8f LRV	38	struct nfc_dev;
	39
	40	/**
	41	* data_exchange_cb_t - Definition of nfc_data_exchange callback
	42	*
	43	* @context: nfc_data_exchange cb_context parameter
	44	* @skb: response data
	45	* @err: If an error has occurred during data exchange, it is the
	46	* error number. Zero means no error.
	47	*
	48	* When a rx or tx package is lost or corrupted or the target gets out
	49	* of the operating field, err is -EIO.
	50	*/
	51	typedef void (data_exchange_cb_t)(void context, struct sk_buff *skb,
	52	int err);
	53
72b70b6e SO	54	typedef void (se_io_cb_t)(void context, u8 *apdu, size_t apdu_len, int err);
72b70b6e SO	55
90099433 EL	56	struct nfc_target;
90099433 EL	57
3e256b8f	58	struct nfc_ops {
8b3fe7b5 IE	59	int (dev_up)(struct nfc_dev dev);
8b3fe7b5 IE	60	int (dev_down)(struct nfc_dev dev);
fe7c5800 SO	61	int (start_poll)(struct nfc_dev dev,
fe7c5800 SO	62	u32 im_protocols, u32 tm_protocols);
3e256b8f	63	void (stop_poll)(struct nfc_dev dev);
90099433 EL	64	int (dep_link_up)(struct nfc_dev dev, struct nfc_target *target,
90099433 EL	65	u8 comm_mode, u8 *gb, size_t gb_len);
1ed28f61	66	int (dep_link_down)(struct nfc_dev dev);
90099433	67	int (activate_target)(struct nfc_dev dev, struct nfc_target *target,
0a40acb2	68	u32 protocol);
90099433 EL	69	void (deactivate_target)(struct nfc_dev dev,
90099433 EL	70	struct nfc_target *target);
be9ae4ce	71	int (im_transceive)(struct nfc_dev dev, struct nfc_target *target,
0a40acb2 SO	72	struct sk_buff *skb, data_exchange_cb_t cb,
0a40acb2 SO	73	void *cb_context);
be9ae4ce	74	int (tm_send)(struct nfc_dev dev, struct sk_buff *skb);
90099433	75	int (check_presence)(struct nfc_dev dev, struct nfc_target *target);
9ea7187c	76	int (fw_download)(struct nfc_dev dev, const char *firmware_name);
0a946301 SO	77
	78	/* Secure Element API */
	79	int (discover_se)(struct nfc_dev dev);
	80	int (enable_se)(struct nfc_dev dev, u32 se_idx);
	81	int (disable_se)(struct nfc_dev dev, u32 se_idx);
72b70b6e SO	82	int (se_io) (struct nfc_dev dev, u32 se_idx,
	83	u8 *apdu, size_t apdu_length,
	84	se_io_cb_t cb, void *cb_context);
3e256b8f LRV	85	};
3e256b8f LRV	86
1ed28f61 SO	87	#define NFC_TARGET_IDX_ANY -1
1ed28f61 SO	88	#define NFC_MAX_GT_LEN 48
767f19ae	89	#define NFC_ATR_RES_GT_OFFSET 15
1ed28f61	90
b9c0c678 SO	91	/**
	92	* struct nfc_target - NFC target descriptiom
	93	*
	94	* @sens_res: 2 bytes describing the target SENS_RES response, if the target
	95	* is a type A one. The %sens_res most significant byte must be byte 2
	96	* as described by the NFC Forum digital specification (i.e. the platform
	97	* configuration one) while %sens_res least significant byte is byte 1.
	98	*/
4d12b8b1 LRV	99	struct nfc_target {
	100	u32 idx;
	101	u32 supported_protocols;
	102	u16 sens_res;
	103	u8 sel_res;
288e0713	104	u8 nfcid1_len;
d5a2ca60	105	u8 nfcid1[NFC_NFCID1_MAXSIZE];
322bce95 SO	106	u8 nfcid2_len;
322bce95 SO	107	u8 nfcid2[NFC_NFCID2_MAXSIZE];
d5a2ca60 IE	108	u8 sensb_res_len;
	109	u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
	110	u8 sensf_res_len;
	111	u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
8b8d2e08	112	u8 hci_reader_gate;
c4fbb651	113	u8 logical_idx;
e487e4dc MG	114	u8 is_iso15693;
	115	u8 iso15693_dsfid;
	116	u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
4d12b8b1 LRV	117	};
4d12b8b1 LRV	118
fed7c25e SO	119	/**
	120	* nfc_se - A structure for NFC accessible secure elements.
	121	*
	122	* @idx: The secure element index. User space will enable or
	123	* disable a secure element by its index.
	124	* @type: The secure element type. It can be SE_UICC or
	125	* SE_EMBEDDED.
	126	* @state: The secure element state, either enabled or disabled.
	127	*
	128	*/
	129	struct nfc_se {
	130	struct list_head list;
	131	u32 idx;
	132	u16 type;
	133	u16 state;
	134	};
	135
4d12b8b1	136	struct nfc_genl_data {
15e47304	137	u32 poll_req_portid;
4d12b8b1 LRV	138	struct mutex genl_data_mutex;
	139	};
	140
3e256b8f	141	struct nfc_dev {
7eda8b8e	142	int idx;
01ae0eea	143	u32 target_next_idx;
4d12b8b1 LRV	144	struct nfc_target *targets;
	145	int n_targets;
	146	int targets_generation;
3e256b8f	147	struct device dev;
8b3fe7b5	148	bool dev_up;
9ea7187c	149	bool fw_download_in_progress;
f212ad5e	150	u8 rf_mode;
3e256b8f	151	bool polling;
90099433	152	struct nfc_target *active_target;
1ed28f61	153	bool dep_link_up;
4d12b8b1	154	struct nfc_genl_data genl_data;
3e256b8f LRV	155	u32 supported_protocols;
3e256b8f LRV	156
fed7c25e	157	struct list_head secure_elements;
390a1bd8	158
e8753043 SO	159	int tx_headroom;
	160	int tx_tailroom;
	161
c8d56ae7	162	struct timer_list check_pres_timer;
c8d56ae7 EL	163	struct work_struct check_pres_work;
c8d56ae7 EL	164
f0c91038 EL	165	bool shutting_down;
f0c91038 EL	166
be055b2f SO	167	struct rfkill *rfkill;
be055b2f SO	168
3e256b8f LRV	169	struct nfc_ops *ops;
	170	};
	171	#define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
	172
	173	extern struct class nfc_class;
	174
	175	struct nfc_dev nfc_allocate_device(struct nfc_ops ops,
0a40acb2 SO	176	u32 supported_protocols,
	177	int tx_headroom,
	178	int tx_tailroom);
3e256b8f LRV	179
	180	/**
	181	* nfc_free_device - free nfc device
	182	*
	183	* @dev: The nfc device to free
	184	*/
	185	static inline void nfc_free_device(struct nfc_dev *dev)
	186	{
	187	put_device(&dev->dev);
	188	}
	189
	190	int nfc_register_device(struct nfc_dev *dev);
	191
	192	void nfc_unregister_device(struct nfc_dev *dev);
	193
	194	/**
	195	* nfc_set_parent_dev - set the parent device
	196	*
	197	* @nfc_dev: The nfc device whose parent is being set
	198	* @dev: The parent device
	199	*/
	200	static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
0a40acb2	201	struct device *dev)
3e256b8f LRV	202	{
	203	nfc_dev->dev.parent = dev;
	204	}
	205
	206	/**
	207	* nfc_set_drvdata - set driver specifc data
	208	*
	209	* @dev: The nfc device
	210	* @data: Pointer to driver specifc data
	211	*/
	212	static inline void nfc_set_drvdata(struct nfc_dev dev, void data)
	213	{
	214	dev_set_drvdata(&dev->dev, data);
	215	}
	216
	217	/**
	218	* nfc_get_drvdata - get driver specifc data
	219	*
	220	* @dev: The nfc device
	221	*/
	222	static inline void nfc_get_drvdata(struct nfc_dev dev)
	223	{
	224	return dev_get_drvdata(&dev->dev);
	225	}
	226
	227	/**
	228	* nfc_device_name - get the nfc device name
	229	*
	230	* @dev: The nfc device whose name to return
	231	*/
	232	static inline const char nfc_device_name(struct nfc_dev dev)
	233	{
	234	return dev_name(&dev->dev);
	235	}
	236
7c7cd3bf	237	struct sk_buff nfc_alloc_send_skb(struct nfc_dev dev, struct sock *sk,
0a40acb2 SO	238	unsigned int flags, unsigned int size,
0a40acb2 SO	239	unsigned int *err);
7c7cd3bf	240	struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
3e256b8f	241
541d920b	242	int nfc_set_remote_general_bytes(struct nfc_dev *dev,
0a40acb2	243	u8 *gt, u8 gt_len);
ab73b751	244	u8 nfc_get_local_general_bytes(struct nfc_dev dev, size_t *gb_len);
541d920b	245
352a5f5f EL	246	int nfc_fw_download_done(struct nfc_dev dev, const char firmware_name,
352a5f5f EL	247	u32 result);
ef04158e	248
0a40acb2 SO	249	int nfc_targets_found(struct nfc_dev *dev,
0a40acb2 SO	250	struct nfc_target *targets, int ntargets);
e1da0efa	251	int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
4d12b8b1	252
1ed28f61 SO	253	int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
	254	u8 comm_mode, u8 rf_mode);
	255
fc40a8c1 SO	256	int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
	257	u8 *gb, size_t gb_len);
	258	int nfc_tm_deactivated(struct nfc_dev *dev);
73167ced	259	int nfc_tm_data_received(struct nfc_dev dev, struct sk_buff skb);
fc40a8c1	260
456411ca EL	261	void nfc_driver_failure(struct nfc_dev *dev, int err);
456411ca EL	262
fed7c25e SO	263	int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
fed7c25e SO	264	int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
d8eb18ee	265	struct nfc_se nfc_find_se(struct nfc_dev dev, u32 se_idx);
fed7c25e	266
57be1f3f HT	267	void nfc_send_to_raw_sock(struct nfc_dev dev, struct sk_buff skb,
	268	u8 payload_type, u8 direction);
	269
3e256b8f	270	#endif /* __NET_NFC_H */