[deliverable/linux.git] / net / nfc / llcp / llcp.h

/*
 * Copyright (C) 2011  Intel Corporation. All rights reserved.
 *
 * 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.
 */

enum llcp_state {
	LLCP_CONNECTED = 1, /* wait_for_packet() wants that */
	LLCP_CLOSED,
	LLCP_BOUND,
	LLCP_LISTEN,
};

#define LLCP_DEFAULT_LTO 100
#define LLCP_DEFAULT_RW  1
#define LLCP_DEFAULT_MIU 128

#define LLCP_MAX_LTO  0xff
#define LLCP_MAX_RW   15
#define LLCP_MAX_MIUX 0x7ff

#define LLCP_WKS_NUM_SAP   16
#define LLCP_SDP_NUM_SAP   16
#define LLCP_LOCAL_NUM_SAP 32
#define LLCP_LOCAL_SAP_OFFSET (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP)
#define LLCP_MAX_SAP (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP + LLCP_LOCAL_NUM_SAP)
#define LLCP_SDP_UNBOUND   (LLCP_MAX_SAP + 1)

struct nfc_llcp_sock;

struct llcp_sock_list {
	struct hlist_head head;
	rwlock_t          lock;
};

struct nfc_llcp_sdp_tlv {
	u8 *tlv;
	u8 tlv_len;

	char *uri;
	u8 tid;
	u8 sap;

	struct hlist_node node;
};

struct nfc_llcp_local {
	struct list_head list;
	struct nfc_dev *dev;

	struct kref ref;

	struct mutex sdp_lock;

	struct timer_list link_timer;
	struct sk_buff_head tx_queue;
	struct work_struct	 tx_work;
	struct work_struct	 rx_work;
	struct sk_buff *rx_pending;
	struct work_struct	 timeout_work;

	u32 target_idx;
	u8 rf_mode;
	u8 comm_mode;
	u8 lto;
	u8 rw;
	__be16 miux;
	unsigned long local_wks;      /* Well known services */
	unsigned long local_sdp;      /* Local services  */
	unsigned long local_sap; /* Local SAPs, not available for discovery */
	atomic_t local_sdp_cnt[LLCP_SDP_NUM_SAP];

	/* local */
	u8 gb[NFC_MAX_GT_LEN];
	u8 gb_len;

	/* remote */
	u8 remote_gb[NFC_MAX_GT_LEN];
	u8 remote_gb_len;

	u8  remote_version;
	u16 remote_miu;
	u16 remote_lto;
	u8  remote_opt;
	u16 remote_wks;

	/* sockets array */
	struct llcp_sock_list sockets;
	struct llcp_sock_list connecting_sockets;
	struct llcp_sock_list raw_sockets;
};

struct nfc_llcp_sock {
	struct sock sk;
	struct nfc_dev *dev;
	struct nfc_llcp_local *local;
	u32 target_idx;
	u32 nfc_protocol;

	/* Link parameters */
	u8 ssap;
	u8 dsap;
	char *service_name;
	size_t service_name_len;
	u8 rw;
	u16 miux;


	/* Remote link parameters */
	u8 remote_rw;
	u16 remote_miu;

	/* Link variables */
	u8 send_n;
	u8 send_ack_n;
	u8 recv_n;
	u8 recv_ack_n;

	/* Is the remote peer ready to receive */
	u8 remote_ready;

	/* Reserved source SAP */
	u8 reserved_ssap;

	struct sk_buff_head tx_queue;
	struct sk_buff_head tx_pending_queue;

	struct list_head accept_queue;
	struct sock *parent;
};

struct nfc_llcp_ui_cb {
	__u8 dsap;
	__u8 ssap;
};

#define nfc_llcp_ui_skb_cb(__skb) ((struct nfc_llcp_ui_cb *)&((__skb)->cb[0]))

#define nfc_llcp_sock(sk) ((struct nfc_llcp_sock *) (sk))
#define nfc_llcp_dev(sk)  (nfc_llcp_sock((sk))->dev)

#define LLCP_HEADER_SIZE   2
#define LLCP_SEQUENCE_SIZE 1

/* LLCP versions: 1.1 is 1.0 plus SDP */
#define LLCP_VERSION_10 0x10
#define LLCP_VERSION_11 0x11

/* LLCP PDU types */
#define LLCP_PDU_SYMM     0x0
#define LLCP_PDU_PAX      0x1
#define LLCP_PDU_AGF      0x2
#define LLCP_PDU_UI       0x3
#define LLCP_PDU_CONNECT  0x4
#define LLCP_PDU_DISC     0x5
#define LLCP_PDU_CC       0x6
#define LLCP_PDU_DM       0x7
#define LLCP_PDU_FRMR     0x8
#define LLCP_PDU_SNL      0x9
#define LLCP_PDU_I        0xc
#define LLCP_PDU_RR       0xd
#define LLCP_PDU_RNR      0xe

/* Parameters TLV types */
#define LLCP_TLV_VERSION 0x1
#define LLCP_TLV_MIUX    0x2
#define LLCP_TLV_WKS     0x3
#define LLCP_TLV_LTO     0x4
#define LLCP_TLV_RW      0x5
#define LLCP_TLV_SN      0x6
#define LLCP_TLV_OPT     0x7
#define LLCP_TLV_SDREQ   0x8
#define LLCP_TLV_SDRES   0x9
#define LLCP_TLV_MAX     0xa

/* Well known LLCP SAP */
#define LLCP_SAP_SDP   0x1
#define LLCP_SAP_IP    0x2
#define LLCP_SAP_OBEX  0x3
#define LLCP_SAP_SNEP  0x4
#define LLCP_SAP_MAX   0xff

/* Disconnection reason code */
#define LLCP_DM_DISC    0x00
#define LLCP_DM_NOCONN  0x01
#define LLCP_DM_NOBOUND 0x02
#define LLCP_DM_REJ     0x03


void nfc_llcp_sock_link(struct llcp_sock_list *l, struct sock *s);
void nfc_llcp_sock_unlink(struct llcp_sock_list *l, struct sock *s);
struct nfc_llcp_local *nfc_llcp_find_local(struct nfc_dev *dev);
struct nfc_llcp_local *nfc_llcp_local_get(struct nfc_llcp_local *local);
int nfc_llcp_local_put(struct nfc_llcp_local *local);
u8 nfc_llcp_get_sdp_ssap(struct nfc_llcp_local *local,
			 struct nfc_llcp_sock *sock);
u8 nfc_llcp_get_local_ssap(struct nfc_llcp_local *local);
void nfc_llcp_put_ssap(struct nfc_llcp_local *local, u8 ssap);
int nfc_llcp_queue_i_frames(struct nfc_llcp_sock *sock);
void nfc_llcp_send_to_raw_sock(struct nfc_llcp_local *local,
			       struct sk_buff *skb, u8 direction);

/* Sock API */
struct sock *nfc_llcp_sock_alloc(struct socket *sock, int type, gfp_t gfp);
void nfc_llcp_sock_free(struct nfc_llcp_sock *sock);
void nfc_llcp_accept_unlink(struct sock *sk);
void nfc_llcp_accept_enqueue(struct sock *parent, struct sock *sk);
struct sock *nfc_llcp_accept_dequeue(struct sock *sk, struct socket *newsock);

/* TLV API */
int nfc_llcp_parse_gb_tlv(struct nfc_llcp_local *local,
			  u8 *tlv_array, u16 tlv_array_len);
int nfc_llcp_parse_connection_tlv(struct nfc_llcp_sock *sock,
				  u8 *tlv_array, u16 tlv_array_len);

/* Commands API */
void nfc_llcp_recv(void *data, struct sk_buff *skb, int err);
u8 *nfc_llcp_build_tlv(u8 type, u8 *value, u8 value_length, u8 *tlv_length);
struct nfc_llcp_sdp_tlv *nfc_llcp_build_sdres_tlv(u8 tid, u8 sap);
void nfc_llcp_free_sdp_tlv(struct nfc_llcp_sdp_tlv *sdp);
void nfc_llcp_recv(void *data, struct sk_buff *skb, int err);
int nfc_llcp_disconnect(struct nfc_llcp_sock *sock);
int nfc_llcp_send_symm(struct nfc_dev *dev);
int nfc_llcp_send_connect(struct nfc_llcp_sock *sock);
int nfc_llcp_send_cc(struct nfc_llcp_sock *sock);
int nfc_llcp_send_snl_sdres(struct nfc_llcp_local *local,
			    struct hlist_head *tlv_list, size_t tlvs_len);
int nfc_llcp_send_dm(struct nfc_llcp_local *local, u8 ssap, u8 dsap, u8 reason);
int nfc_llcp_send_disconnect(struct nfc_llcp_sock *sock);
int nfc_llcp_send_i_frame(struct nfc_llcp_sock *sock,
			  struct msghdr *msg, size_t len);
int nfc_llcp_send_ui_frame(struct nfc_llcp_sock *sock, u8 ssap, u8 dsap,
			   struct msghdr *msg, size_t len);
int nfc_llcp_send_rr(struct nfc_llcp_sock *sock);

/* Socket API */
int __init nfc_llcp_sock_init(void);
void nfc_llcp_sock_exit(void);
Commit	Line	Data
d646960f SO	1	/*
	2	* Copyright (C) 2011 Intel Corporation. All rights reserved.
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the
	16	* Free Software Foundation, Inc.,
	17	* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	18	*/
	19
	20	enum llcp_state {
	21	LLCP_CONNECTED = 1, /* wait_for_packet() wants that */
	22	LLCP_CLOSED,
	23	LLCP_BOUND,
	24	LLCP_LISTEN,
	25	};
	26
	27	#define LLCP_DEFAULT_LTO 100
	28	#define LLCP_DEFAULT_RW 1
	29	#define LLCP_DEFAULT_MIU 128
	30
eda21f16 SO	31	#define LLCP_MAX_LTO 0xff
	32	#define LLCP_MAX_RW 15
	33	#define LLCP_MAX_MIUX 0x7ff
	34
d646960f SO	35	#define LLCP_WKS_NUM_SAP 16
	36	#define LLCP_SDP_NUM_SAP 16
	37	#define LLCP_LOCAL_NUM_SAP 32
	38	#define LLCP_LOCAL_SAP_OFFSET (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP)
	39	#define LLCP_MAX_SAP (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP + LLCP_LOCAL_NUM_SAP)
8f50020e	40	#define LLCP_SDP_UNBOUND (LLCP_MAX_SAP + 1)
d646960f SO	41
	42	struct nfc_llcp_sock;
	43
a69f32af SO	44	struct llcp_sock_list {
	45	struct hlist_head head;
	46	rwlock_t lock;
	47	};
	48
e0ae7bac TE	49	struct nfc_llcp_sdp_tlv {
	50	u8 *tlv;
	51	u8 tlv_len;
	52
	53	char *uri;
	54	u8 tid;
	55	u8 sap;
	56
	57	struct hlist_node node;
	58	};
	59
d646960f SO	60	struct nfc_llcp_local {
	61	struct list_head list;
	62	struct nfc_dev *dev;
	63
c7aa1225 SO	64	struct kref ref;
c7aa1225 SO	65
d646960f	66	struct mutex sdp_lock;
d646960f SO	67
	68	struct timer_list link_timer;
	69	struct sk_buff_head tx_queue;
d646960f	70	struct work_struct tx_work;
d646960f SO	71	struct work_struct rx_work;
d646960f SO	72	struct sk_buff *rx_pending;
d646960f SO	73	struct work_struct timeout_work;
	74
	75	u32 target_idx;
	76	u8 rf_mode;
	77	u8 comm_mode;
52feb444 TE	78	u8 lto;
	79	u8 rw;
	80	__be16 miux;
d646960f SO	81	unsigned long local_wks; /* Well known services */
	82	unsigned long local_sdp; /* Local services */
	83	unsigned long local_sap; /* Local SAPs, not available for discovery */
8f50020e	84	atomic_t local_sdp_cnt[LLCP_SDP_NUM_SAP];
d646960f SO	85
	86	/* local */
	87	u8 gb[NFC_MAX_GT_LEN];
	88	u8 gb_len;
	89
	90	/* remote */
	91	u8 remote_gb[NFC_MAX_GT_LEN];
	92	u8 remote_gb_len;
	93
	94	u8 remote_version;
	95	u16 remote_miu;
	96	u16 remote_lto;
	97	u8 remote_opt;
	98	u16 remote_wks;
d646960f SO	99
d646960f SO	100	/* sockets array */
a69f32af SO	101	struct llcp_sock_list sockets;
a69f32af SO	102	struct llcp_sock_list connecting_sockets;
4463523b	103	struct llcp_sock_list raw_sockets;
d646960f SO	104	};
	105
	106	struct nfc_llcp_sock {
	107	struct sock sk;
d646960f SO	108	struct nfc_dev *dev;
	109	struct nfc_llcp_local *local;
	110	u32 target_idx;
	111	u32 nfc_protocol;
	112
7a06e586	113	/* Link parameters */
d646960f SO	114	u8 ssap;
	115	u8 dsap;
	116	char *service_name;
	117	size_t service_name_len;
26fd76ca SO	118	u8 rw;
	119	u16 miux;
	120
e4306bec SO	121
	122	/* Remote link parameters */
	123	u8 remote_rw;
	124	u16 remote_miu;
d646960f SO	125
	126	/* Link variables */
	127	u8 send_n;
	128	u8 send_ack_n;
	129	u8 recv_n;
	130	u8 recv_ack_n;
	131
	132	/* Is the remote peer ready to receive */
	133	u8 remote_ready;
	134
cbbf4721 SO	135	/* Reserved source SAP */
	136	u8 reserved_ssap;
	137
d646960f SO	138	struct sk_buff_head tx_queue;
d646960f SO	139	struct sk_buff_head tx_pending_queue;
d646960f SO	140
	141	struct list_head accept_queue;
	142	struct sock *parent;
	143	};
	144
968272bf SO	145	struct nfc_llcp_ui_cb {
	146	__u8 dsap;
	147	__u8 ssap;
	148	};
	149
	150	#define nfc_llcp_ui_skb_cb(__skb) ((struct nfc_llcp_ui_cb *)&((__skb)->cb[0]))
	151
d646960f SO	152	#define nfc_llcp_sock(sk) ((struct nfc_llcp_sock *) (sk))
	153	#define nfc_llcp_dev(sk) (nfc_llcp_sock((sk))->dev)
	154
	155	#define LLCP_HEADER_SIZE 2
	156	#define LLCP_SEQUENCE_SIZE 1
	157
	158	/* LLCP versions: 1.1 is 1.0 plus SDP */
	159	#define LLCP_VERSION_10 0x10
	160	#define LLCP_VERSION_11 0x11
	161
	162	/* LLCP PDU types */
	163	#define LLCP_PDU_SYMM 0x0
	164	#define LLCP_PDU_PAX 0x1
	165	#define LLCP_PDU_AGF 0x2
	166	#define LLCP_PDU_UI 0x3
	167	#define LLCP_PDU_CONNECT 0x4
	168	#define LLCP_PDU_DISC 0x5
	169	#define LLCP_PDU_CC 0x6
	170	#define LLCP_PDU_DM 0x7
	171	#define LLCP_PDU_FRMR 0x8
	172	#define LLCP_PDU_SNL 0x9
	173	#define LLCP_PDU_I 0xc
	174	#define LLCP_PDU_RR 0xd
	175	#define LLCP_PDU_RNR 0xe
	176
	177	/* Parameters TLV types */
	178	#define LLCP_TLV_VERSION 0x1
	179	#define LLCP_TLV_MIUX 0x2
	180	#define LLCP_TLV_WKS 0x3
	181	#define LLCP_TLV_LTO 0x4
	182	#define LLCP_TLV_RW 0x5
	183	#define LLCP_TLV_SN 0x6
	184	#define LLCP_TLV_OPT 0x7
	185	#define LLCP_TLV_SDREQ 0x8
	186	#define LLCP_TLV_SDRES 0x9
	187	#define LLCP_TLV_MAX 0xa
	188
	189	/* Well known LLCP SAP */
	190	#define LLCP_SAP_SDP 0x1
	191	#define LLCP_SAP_IP 0x2
	192	#define LLCP_SAP_OBEX 0x3
	193	#define LLCP_SAP_SNEP 0x4
	194	#define LLCP_SAP_MAX 0xff
	195
	196	/* Disconnection reason code */
	197	#define LLCP_DM_DISC 0x00
	198	#define LLCP_DM_NOCONN 0x01
	199	#define LLCP_DM_NOBOUND 0x02
	200	#define LLCP_DM_REJ 0x03
	201
	202
a69f32af SO	203	void nfc_llcp_sock_link(struct llcp_sock_list l, struct sock s);
a69f32af SO	204	void nfc_llcp_sock_unlink(struct llcp_sock_list l, struct sock s);
d646960f	205	struct nfc_llcp_local nfc_llcp_find_local(struct nfc_dev dev);
c7aa1225 SO	206	struct nfc_llcp_local nfc_llcp_local_get(struct nfc_llcp_local local);
c7aa1225 SO	207	int nfc_llcp_local_put(struct nfc_llcp_local *local);
d646960f	208	u8 nfc_llcp_get_sdp_ssap(struct nfc_llcp_local *local,
427a2eb1	209	struct nfc_llcp_sock *sock);
d646960f SO	210	u8 nfc_llcp_get_local_ssap(struct nfc_llcp_local *local);
d646960f SO	211	void nfc_llcp_put_ssap(struct nfc_llcp_local *local, u8 ssap);
d094afa1	212	int nfc_llcp_queue_i_frames(struct nfc_llcp_sock *sock);
4463523b TE	213	void nfc_llcp_send_to_raw_sock(struct nfc_llcp_local *local,
4463523b TE	214	struct sk_buff *skb, u8 direction);
d646960f SO	215
	216	/* Sock API */
	217	struct sock nfc_llcp_sock_alloc(struct socket sock, int type, gfp_t gfp);
	218	void nfc_llcp_sock_free(struct nfc_llcp_sock *sock);
	219	void nfc_llcp_accept_unlink(struct sock *sk);
	220	void nfc_llcp_accept_enqueue(struct sock parent, struct sock sk);
	221	struct sock nfc_llcp_accept_dequeue(struct sock sk, struct socket *newsock);
	222
	223	/* TLV API */
7a06e586 SO	224	int nfc_llcp_parse_gb_tlv(struct nfc_llcp_local *local,
	225	u8 *tlv_array, u16 tlv_array_len);
	226	int nfc_llcp_parse_connection_tlv(struct nfc_llcp_sock *sock,
	227	u8 *tlv_array, u16 tlv_array_len);
d646960f SO	228
	229	/* Commands API */
	230	void nfc_llcp_recv(void data, struct sk_buff skb, int err);
	231	u8 nfc_llcp_build_tlv(u8 type, u8 value, u8 value_length, u8 *tlv_length);
e0ae7bac TE	232	struct nfc_llcp_sdp_tlv *nfc_llcp_build_sdres_tlv(u8 tid, u8 sap);
e0ae7bac TE	233	void nfc_llcp_free_sdp_tlv(struct nfc_llcp_sdp_tlv *sdp);
d646960f SO	234	void nfc_llcp_recv(void data, struct sk_buff skb, int err);
	235	int nfc_llcp_disconnect(struct nfc_llcp_sock *sock);
	236	int nfc_llcp_send_symm(struct nfc_dev *dev);
	237	int nfc_llcp_send_connect(struct nfc_llcp_sock *sock);
	238	int nfc_llcp_send_cc(struct nfc_llcp_sock *sock);
e0ae7bac TE	239	int nfc_llcp_send_snl_sdres(struct nfc_llcp_local *local,
e0ae7bac TE	240	struct hlist_head *tlv_list, size_t tlvs_len);
d646960f SO	241	int nfc_llcp_send_dm(struct nfc_llcp_local *local, u8 ssap, u8 dsap, u8 reason);
d646960f SO	242	int nfc_llcp_send_disconnect(struct nfc_llcp_sock *sock);
53a0ac2e	243	int nfc_llcp_send_i_frame(struct nfc_llcp_sock *sock,
427a2eb1	244	struct msghdr *msg, size_t len);
94f418a2 SO	245	int nfc_llcp_send_ui_frame(struct nfc_llcp_sock *sock, u8 ssap, u8 dsap,
94f418a2 SO	246	struct msghdr *msg, size_t len);
d094afa1	247	int nfc_llcp_send_rr(struct nfc_llcp_sock *sock);
d646960f SO	248
	249	/* Socket API */
	250	int __init nfc_llcp_sock_init(void);
	251	void nfc_llcp_sock_exit(void);