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