[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)

struct nfc_llcp_sock;

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

	struct mutex sdp_lock;
	struct mutex socket_lock;

	struct timer_list link_timer;
	struct sk_buff_head tx_queue;
	struct workqueue_struct	*tx_wq;
	struct work_struct	 tx_work;
	struct workqueue_struct	*rx_wq;
	struct work_struct	 rx_work;
	struct sk_buff *rx_pending;
	struct workqueue_struct	*timeout_wq;
	struct work_struct	 timeout_work;

	u32 target_idx;
	u8 rf_mode;
	u8 comm_mode;
	unsigned long local_wks;      /* Well known services */
	unsigned long local_sdp;      /* Local services  */
	unsigned long local_sap; /* Local SAPs, not available for discovery */

	/* 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;
	u8  remote_rw;

	/* sockets array */
	struct nfc_llcp_sock *sockets[LLCP_MAX_SAP];
};

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

	u8 ssap;
	u8 dsap;
	char *service_name;
	size_t service_name_len;

	/* 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;

	struct sk_buff_head tx_queue;
	struct sk_buff_head tx_pending_queue;
	struct sk_buff_head tx_backlog_queue;

	struct list_head accept_queue;
	struct sock *parent;
};

#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


struct nfc_llcp_local *nfc_llcp_find_local(struct nfc_dev *dev);
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);

/* 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_tlv(struct nfc_llcp_local *local,
		       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);
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_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_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)
	40
	41	struct nfc_llcp_sock;
	42
	43	struct nfc_llcp_local {
	44	struct list_head list;
	45	struct nfc_dev *dev;
	46
	47	struct mutex sdp_lock;
	48	struct mutex socket_lock;
	49
	50	struct timer_list link_timer;
	51	struct sk_buff_head tx_queue;
	52	struct workqueue_struct *tx_wq;
	53	struct work_struct tx_work;
	54	struct workqueue_struct *rx_wq;
	55	struct work_struct rx_work;
	56	struct sk_buff *rx_pending;
	57	struct workqueue_struct *timeout_wq;
	58	struct work_struct timeout_work;
	59
	60	u32 target_idx;
	61	u8 rf_mode;
	62	u8 comm_mode;
	63	unsigned long local_wks; /* Well known services */
	64	unsigned long local_sdp; /* Local services */
	65	unsigned long local_sap; /* Local SAPs, not available for discovery */
	66
	67	/* local */
	68	u8 gb[NFC_MAX_GT_LEN];
	69	u8 gb_len;
	70
	71	/* remote */
	72	u8 remote_gb[NFC_MAX_GT_LEN];
	73	u8 remote_gb_len;
	74
	75	u8 remote_version;
	76	u16 remote_miu;
	77	u16 remote_lto;
	78	u8 remote_opt;
	79	u16 remote_wks;
	80	u8 remote_rw;
	81
	82	/* sockets array */
	83	struct nfc_llcp_sock *sockets[LLCP_MAX_SAP];
	84	};
	85
	86	struct nfc_llcp_sock {
	87	struct sock sk;
	88	struct list_head list;
	89	struct nfc_dev *dev;
	90	struct nfc_llcp_local *local;
	91	u32 target_idx;
	92	u32 nfc_protocol;
	93
	94	u8 ssap;
	95	u8 dsap;
	96	char *service_name;
	97	size_t service_name_len;
	98
99	/* Link variables */
100	u8 send_n;
101	u8 send_ack_n;
102	u8 recv_n;
103	u8 recv_ack_n;
104
105	/* Is the remote peer ready to receive */
106	u8 remote_ready;
107
108	struct sk_buff_head tx_queue;
109	struct sk_buff_head tx_pending_queue;
110	struct sk_buff_head tx_backlog_queue;
111
112	struct list_head accept_queue;
113	struct sock *parent;
114	};
115
116	#define nfc_llcp_sock(sk) ((struct nfc_llcp_sock *) (sk))
117	#define nfc_llcp_dev(sk) (nfc_llcp_sock((sk))->dev)
118
119	#define LLCP_HEADER_SIZE 2
120	#define LLCP_SEQUENCE_SIZE 1
121
122	/* LLCP versions: 1.1 is 1.0 plus SDP */
123	#define LLCP_VERSION_10 0x10
124	#define LLCP_VERSION_11 0x11
125
126	/* LLCP PDU types */
127	#define LLCP_PDU_SYMM 0x0
128	#define LLCP_PDU_PAX 0x1
129	#define LLCP_PDU_AGF 0x2
130	#define LLCP_PDU_UI 0x3
131	#define LLCP_PDU_CONNECT 0x4
132	#define LLCP_PDU_DISC 0x5
133	#define LLCP_PDU_CC 0x6
134	#define LLCP_PDU_DM 0x7
135	#define LLCP_PDU_FRMR 0x8
136	#define LLCP_PDU_SNL 0x9
137	#define LLCP_PDU_I 0xc
138	#define LLCP_PDU_RR 0xd
139	#define LLCP_PDU_RNR 0xe
140
141	/* Parameters TLV types */
142	#define LLCP_TLV_VERSION 0x1
143	#define LLCP_TLV_MIUX 0x2
144	#define LLCP_TLV_WKS 0x3
145	#define LLCP_TLV_LTO 0x4
146	#define LLCP_TLV_RW 0x5
147	#define LLCP_TLV_SN 0x6
148	#define LLCP_TLV_OPT 0x7
149	#define LLCP_TLV_SDREQ 0x8
150	#define LLCP_TLV_SDRES 0x9
151	#define LLCP_TLV_MAX 0xa
152
153	/* Well known LLCP SAP */
154	#define LLCP_SAP_SDP 0x1
155	#define LLCP_SAP_IP 0x2
156	#define LLCP_SAP_OBEX 0x3
157	#define LLCP_SAP_SNEP 0x4
158	#define LLCP_SAP_MAX 0xff
159
160	/* Disconnection reason code */
161	#define LLCP_DM_DISC 0x00
162	#define LLCP_DM_NOCONN 0x01
163	#define LLCP_DM_NOBOUND 0x02
164	#define LLCP_DM_REJ 0x03
165
166
167	struct nfc_llcp_local nfc_llcp_find_local(struct nfc_dev dev);
168	u8 nfc_llcp_get_sdp_ssap(struct nfc_llcp_local *local,
427a2eb1	169	struct nfc_llcp_sock *sock);
d646960f SO	170	u8 nfc_llcp_get_local_ssap(struct nfc_llcp_local *local);
d646960f SO	171	void nfc_llcp_put_ssap(struct nfc_llcp_local *local, u8 ssap);
d094afa1	172	int nfc_llcp_queue_i_frames(struct nfc_llcp_sock *sock);
d646960f SO	173
	174	/* Sock API */
	175	struct sock nfc_llcp_sock_alloc(struct socket sock, int type, gfp_t gfp);
	176	void nfc_llcp_sock_free(struct nfc_llcp_sock *sock);
	177	void nfc_llcp_accept_unlink(struct sock *sk);
	178	void nfc_llcp_accept_enqueue(struct sock parent, struct sock sk);
	179	struct sock nfc_llcp_accept_dequeue(struct sock sk, struct socket *newsock);
	180
	181	/* TLV API */
	182	int nfc_llcp_parse_tlv(struct nfc_llcp_local *local,
427a2eb1	183	u8 *tlv_array, u16 tlv_array_len);
d646960f SO	184
	185	/* Commands API */
	186	void nfc_llcp_recv(void data, struct sk_buff skb, int err);
	187	u8 nfc_llcp_build_tlv(u8 type, u8 value, u8 value_length, u8 *tlv_length);
	188	void nfc_llcp_recv(void data, struct sk_buff skb, int err);
	189	int nfc_llcp_disconnect(struct nfc_llcp_sock *sock);
	190	int nfc_llcp_send_symm(struct nfc_dev *dev);
	191	int nfc_llcp_send_connect(struct nfc_llcp_sock *sock);
	192	int nfc_llcp_send_cc(struct nfc_llcp_sock *sock);
	193	int nfc_llcp_send_dm(struct nfc_llcp_local *local, u8 ssap, u8 dsap, u8 reason);
	194	int nfc_llcp_send_disconnect(struct nfc_llcp_sock *sock);
53a0ac2e	195	int nfc_llcp_send_i_frame(struct nfc_llcp_sock *sock,
427a2eb1	196	struct msghdr *msg, size_t len);
d094afa1	197	int nfc_llcp_send_rr(struct nfc_llcp_sock *sock);
d646960f SO	198
	199	/* Socket API */
	200	int __init nfc_llcp_sock_init(void);
	201	void nfc_llcp_sock_exit(void);