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