xref: /openbmc/linux/net/nfc/llcp.h (revision 84953f96)
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_CONNECTING,
23 	LLCP_DISCONNECTING,
24 	LLCP_CLOSED,
25 	LLCP_BOUND,
26 	LLCP_LISTEN,
27 };
28 
29 #define LLCP_DEFAULT_LTO 100
30 #define LLCP_DEFAULT_RW  1
31 #define LLCP_DEFAULT_MIU 128
32 
33 #define LLCP_MAX_LTO  0xff
34 #define LLCP_MAX_RW   15
35 #define LLCP_MAX_MIUX 0x7ff
36 #define LLCP_MAX_MIU (LLCP_MAX_MIUX + 128)
37 
38 #define LLCP_WKS_NUM_SAP   16
39 #define LLCP_SDP_NUM_SAP   16
40 #define LLCP_LOCAL_NUM_SAP 32
41 #define LLCP_LOCAL_SAP_OFFSET (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP)
42 #define LLCP_MAX_SAP (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP + LLCP_LOCAL_NUM_SAP)
43 #define LLCP_SDP_UNBOUND   (LLCP_MAX_SAP + 1)
44 
45 struct nfc_llcp_sock;
46 
47 struct llcp_sock_list {
48 	struct hlist_head head;
49 	rwlock_t          lock;
50 };
51 
52 struct nfc_llcp_sdp_tlv {
53 	u8 *tlv;
54 	u8 tlv_len;
55 
56 	char *uri;
57 	u8 tid;
58 	u8 sap;
59 
60 	unsigned long time;
61 
62 	struct hlist_node node;
63 };
64 
65 struct nfc_llcp_local {
66 	struct list_head list;
67 	struct nfc_dev *dev;
68 
69 	struct kref ref;
70 
71 	struct mutex sdp_lock;
72 
73 	struct timer_list link_timer;
74 	struct sk_buff_head tx_queue;
75 	struct work_struct	 tx_work;
76 	struct work_struct	 rx_work;
77 	struct sk_buff *rx_pending;
78 	struct work_struct	 timeout_work;
79 
80 	u32 target_idx;
81 	u8 rf_mode;
82 	u8 comm_mode;
83 	u8 lto;
84 	u8 rw;
85 	__be16 miux;
86 	unsigned long local_wks;      /* Well known services */
87 	unsigned long local_sdp;      /* Local services  */
88 	unsigned long local_sap; /* Local SAPs, not available for discovery */
89 	atomic_t local_sdp_cnt[LLCP_SDP_NUM_SAP];
90 
91 	/* local */
92 	u8 gb[NFC_MAX_GT_LEN];
93 	u8 gb_len;
94 
95 	/* remote */
96 	u8 remote_gb[NFC_MAX_GT_LEN];
97 	u8 remote_gb_len;
98 
99 	u8  remote_version;
100 	u16 remote_miu;
101 	u16 remote_lto;
102 	u8  remote_opt;
103 	u16 remote_wks;
104 
105 	struct mutex sdreq_lock;
106 	struct hlist_head pending_sdreqs;
107 	struct timer_list sdreq_timer;
108 	struct work_struct sdreq_timeout_work;
109 	u8 sdreq_next_tid;
110 
111 	/* sockets array */
112 	struct llcp_sock_list sockets;
113 	struct llcp_sock_list connecting_sockets;
114 	struct llcp_sock_list raw_sockets;
115 };
116 
117 struct nfc_llcp_sock {
118 	struct sock sk;
119 	struct nfc_dev *dev;
120 	struct nfc_llcp_local *local;
121 	u32 target_idx;
122 	u32 nfc_protocol;
123 
124 	/* Link parameters */
125 	u8 ssap;
126 	u8 dsap;
127 	char *service_name;
128 	size_t service_name_len;
129 	u8 rw;
130 	__be16 miux;
131 
132 
133 	/* Remote link parameters */
134 	u8 remote_rw;
135 	u16 remote_miu;
136 
137 	/* Link variables */
138 	u8 send_n;
139 	u8 send_ack_n;
140 	u8 recv_n;
141 	u8 recv_ack_n;
142 
143 	/* Is the remote peer ready to receive */
144 	u8 remote_ready;
145 
146 	/* Reserved source SAP */
147 	u8 reserved_ssap;
148 
149 	struct sk_buff_head tx_queue;
150 	struct sk_buff_head tx_pending_queue;
151 
152 	struct list_head accept_queue;
153 	struct sock *parent;
154 };
155 
156 struct nfc_llcp_ui_cb {
157 	__u8 dsap;
158 	__u8 ssap;
159 };
160 
161 #define nfc_llcp_ui_skb_cb(__skb) ((struct nfc_llcp_ui_cb *)&((__skb)->cb[0]))
162 
163 #define nfc_llcp_sock(sk) ((struct nfc_llcp_sock *) (sk))
164 #define nfc_llcp_dev(sk)  (nfc_llcp_sock((sk))->dev)
165 
166 #define LLCP_HEADER_SIZE   2
167 #define LLCP_SEQUENCE_SIZE 1
168 #define LLCP_AGF_PDU_HEADER_SIZE 2
169 
170 /* LLCP versions: 1.1 is 1.0 plus SDP */
171 #define LLCP_VERSION_10 0x10
172 #define LLCP_VERSION_11 0x11
173 
174 /* LLCP PDU types */
175 #define LLCP_PDU_SYMM     0x0
176 #define LLCP_PDU_PAX      0x1
177 #define LLCP_PDU_AGF      0x2
178 #define LLCP_PDU_UI       0x3
179 #define LLCP_PDU_CONNECT  0x4
180 #define LLCP_PDU_DISC     0x5
181 #define LLCP_PDU_CC       0x6
182 #define LLCP_PDU_DM       0x7
183 #define LLCP_PDU_FRMR     0x8
184 #define LLCP_PDU_SNL      0x9
185 #define LLCP_PDU_I        0xc
186 #define LLCP_PDU_RR       0xd
187 #define LLCP_PDU_RNR      0xe
188 
189 /* Parameters TLV types */
190 #define LLCP_TLV_VERSION 0x1
191 #define LLCP_TLV_MIUX    0x2
192 #define LLCP_TLV_WKS     0x3
193 #define LLCP_TLV_LTO     0x4
194 #define LLCP_TLV_RW      0x5
195 #define LLCP_TLV_SN      0x6
196 #define LLCP_TLV_OPT     0x7
197 #define LLCP_TLV_SDREQ   0x8
198 #define LLCP_TLV_SDRES   0x9
199 #define LLCP_TLV_MAX     0xa
200 
201 /* Well known LLCP SAP */
202 #define LLCP_SAP_SDP   0x1
203 #define LLCP_SAP_IP    0x2
204 #define LLCP_SAP_OBEX  0x3
205 #define LLCP_SAP_SNEP  0x4
206 #define LLCP_SAP_MAX   0xff
207 
208 /* Disconnection reason code */
209 #define LLCP_DM_DISC    0x00
210 #define LLCP_DM_NOCONN  0x01
211 #define LLCP_DM_NOBOUND 0x02
212 #define LLCP_DM_REJ     0x03
213 
214 
215 void nfc_llcp_sock_link(struct llcp_sock_list *l, struct sock *s);
216 void nfc_llcp_sock_unlink(struct llcp_sock_list *l, struct sock *s);
217 void nfc_llcp_socket_remote_param_init(struct nfc_llcp_sock *sock);
218 struct nfc_llcp_local *nfc_llcp_find_local(struct nfc_dev *dev);
219 struct nfc_llcp_local *nfc_llcp_local_get(struct nfc_llcp_local *local);
220 int nfc_llcp_local_put(struct nfc_llcp_local *local);
221 u8 nfc_llcp_get_sdp_ssap(struct nfc_llcp_local *local,
222 			 struct nfc_llcp_sock *sock);
223 u8 nfc_llcp_get_local_ssap(struct nfc_llcp_local *local);
224 void nfc_llcp_put_ssap(struct nfc_llcp_local *local, u8 ssap);
225 int nfc_llcp_queue_i_frames(struct nfc_llcp_sock *sock);
226 void nfc_llcp_send_to_raw_sock(struct nfc_llcp_local *local,
227 			       struct sk_buff *skb, u8 direction);
228 
229 /* Sock API */
230 struct sock *nfc_llcp_sock_alloc(struct socket *sock, int type, gfp_t gfp);
231 void nfc_llcp_sock_free(struct nfc_llcp_sock *sock);
232 void nfc_llcp_accept_unlink(struct sock *sk);
233 void nfc_llcp_accept_enqueue(struct sock *parent, struct sock *sk);
234 struct sock *nfc_llcp_accept_dequeue(struct sock *sk, struct socket *newsock);
235 
236 /* TLV API */
237 int nfc_llcp_parse_gb_tlv(struct nfc_llcp_local *local,
238 			  u8 *tlv_array, u16 tlv_array_len);
239 int nfc_llcp_parse_connection_tlv(struct nfc_llcp_sock *sock,
240 				  u8 *tlv_array, u16 tlv_array_len);
241 
242 /* Commands API */
243 void nfc_llcp_recv(void *data, struct sk_buff *skb, int err);
244 u8 *nfc_llcp_build_tlv(u8 type, u8 *value, u8 value_length, u8 *tlv_length);
245 struct nfc_llcp_sdp_tlv *nfc_llcp_build_sdres_tlv(u8 tid, u8 sap);
246 struct nfc_llcp_sdp_tlv *nfc_llcp_build_sdreq_tlv(u8 tid, char *uri,
247 						  size_t uri_len);
248 void nfc_llcp_free_sdp_tlv(struct nfc_llcp_sdp_tlv *sdp);
249 void nfc_llcp_free_sdp_tlv_list(struct hlist_head *sdp_head);
250 void nfc_llcp_recv(void *data, struct sk_buff *skb, int err);
251 int nfc_llcp_send_symm(struct nfc_dev *dev);
252 int nfc_llcp_send_connect(struct nfc_llcp_sock *sock);
253 int nfc_llcp_send_cc(struct nfc_llcp_sock *sock);
254 int nfc_llcp_send_snl_sdres(struct nfc_llcp_local *local,
255 			    struct hlist_head *tlv_list, size_t tlvs_len);
256 int nfc_llcp_send_snl_sdreq(struct nfc_llcp_local *local,
257 			    struct hlist_head *tlv_list, size_t tlvs_len);
258 int nfc_llcp_send_dm(struct nfc_llcp_local *local, u8 ssap, u8 dsap, u8 reason);
259 int nfc_llcp_send_disconnect(struct nfc_llcp_sock *sock);
260 int nfc_llcp_send_i_frame(struct nfc_llcp_sock *sock,
261 			  struct msghdr *msg, size_t len);
262 int nfc_llcp_send_ui_frame(struct nfc_llcp_sock *sock, u8 ssap, u8 dsap,
263 			   struct msghdr *msg, size_t len);
264 int nfc_llcp_send_rr(struct nfc_llcp_sock *sock);
265 
266 /* Socket API */
267 int __init nfc_llcp_sock_init(void);
268 void nfc_llcp_sock_exit(void);
269