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