Merge from vendor branch PKGSRC:
[netbsd-mini2440.git] / sys / netbt / l2cap.h
blob1fcd29cf9bd4d4d5bee5342e392e3afe5c9c6a20
1 /* $NetBSD: l2cap.h,v 1.8 2008/09/08 23:36:55 gmcgarry Exp $ */
3 /*-
4 * Copyright (c) 2005 Iain Hibbert.
5 * Copyright (c) 2006 Itronix Inc.
6 * All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The name of Itronix Inc. may not be used to endorse
17 * or promote products derived from this software without specific
18 * prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
24 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27 * ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
32 /*-
33 * Copyright (c) Maksim Yevmenkin <m_evmenkin@yahoo.com>
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55 * SUCH DAMAGE.
57 * $Id: l2cap.h,v 1.9 2009/09/13 18:45:11 pooka Exp $
58 * $FreeBSD: src/sys/netgraph/bluetooth/include/l2cap.h,v 1.4 2005/08/31 18:13:23 emax Exp $
62 * This file contains everything that application needs to know about
63 * Link Layer Control and Adaptation Protocol (L2CAP). All information
64 * was obtained from Bluetooth Specification Books (v1.1 and up)
66 * This file can be included by both kernel and userland applications.
69 #ifndef _NETBT_L2CAP_H_
70 #define _NETBT_L2CAP_H_
72 #include <sys/types.h>
74 /**************************************************************************
75 **************************************************************************
76 ** Common defines and types (L2CAP)
77 **************************************************************************
78 **************************************************************************/
81 * Channel IDs are assigned per machine. So the total number of channels that
82 * a machine can have open at the same time is 0xffff - 0x0040 = 0xffbf (65471).
83 * This number does not depend on number of HCI connections.
86 #define L2CAP_NULL_CID 0x0000 /* DO NOT USE THIS CID */
87 #define L2CAP_SIGNAL_CID 0x0001 /* signaling channel ID */
88 #define L2CAP_CLT_CID 0x0002 /* connectionless channel ID */
89 /* 0x0003 - 0x003f Reserved */
90 #define L2CAP_FIRST_CID 0x0040 /* dynamically alloc. (start) */
91 #define L2CAP_LAST_CID 0xffff /* dynamically alloc. (end) */
93 /* L2CAP MTU */
94 #define L2CAP_MTU_MINIMUM 48
95 #define L2CAP_MTU_DEFAULT 672
96 #define L2CAP_MTU_MAXIMUM 0xffff
98 /* L2CAP flush and link timeouts */
99 #define L2CAP_FLUSH_TIMO_DEFAULT 0xffff /* always retransmit */
100 #define L2CAP_LINK_TIMO_DEFAULT 0xffff
102 /* L2CAP Command Reject reasons */
103 #define L2CAP_REJ_NOT_UNDERSTOOD 0x0000
104 #define L2CAP_REJ_MTU_EXCEEDED 0x0001
105 #define L2CAP_REJ_INVALID_CID 0x0002
106 /* 0x0003 - 0xffff - reserved for future use */
108 /* Protocol/Service Multiplexor (PSM) values */
109 #define L2CAP_PSM_ANY 0x0000 /* Any/Invalid PSM */
110 #define L2CAP_PSM_SDP 0x0001 /* Service Discovery Protocol */
111 #define L2CAP_PSM_RFCOMM 0x0003 /* RFCOMM protocol */
112 #define L2CAP_PSM_TCP 0x0005 /* Telephony Control Protocol */
113 #define L2CAP_PSM_TCS 0x0007 /* TCS cordless */
114 #define L2CAP_PSM_BNEP 0x000f /* Bluetooth Network */
115 /* Encapsulation Protocol*/
116 #define L2CAP_PSM_HID_CNTL 0x0011 /* HID Control */
117 #define L2CAP_PSM_HID_INTR 0x0013 /* HID Interrupt */
118 #define L2CAP_PSM_ESDP 0x0015 /* Extended Service */
119 /* Discovery Profile */
120 #define L2CAP_PSM_AVCTP 0x0017 /* Audio/Visual Control */
121 /* Transport Protocol */
122 #define L2CAP_PSM_AVDTP 0x0019 /* Audio/Visual Distribution */
123 /* Transport Protocol */
124 /* 0x0019 - 0x1000 - reserved for future use */
126 #define L2CAP_PSM_INVALID(psm) (((psm) & 0x0101) != 0x0001)
128 /* L2CAP Connection response command result codes */
129 #define L2CAP_SUCCESS 0x0000
130 #define L2CAP_PENDING 0x0001
131 #define L2CAP_PSM_NOT_SUPPORTED 0x0002
132 #define L2CAP_SECURITY_BLOCK 0x0003
133 #define L2CAP_NO_RESOURCES 0x0004
134 #define L2CAP_TIMEOUT 0xeeee
135 #define L2CAP_UNKNOWN 0xffff
136 /* 0x0005 - 0xffff - reserved for future use */
138 /* L2CAP Connection response status codes */
139 #define L2CAP_NO_INFO 0x0000
140 #define L2CAP_AUTH_PENDING 0x0001
141 #define L2CAP_AUTZ_PENDING 0x0002
142 /* 0x0003 - 0xffff - reserved for future use */
144 /* L2CAP Configuration response result codes */
145 #define L2CAP_UNACCEPTABLE_PARAMS 0x0001
146 #define L2CAP_REJECT 0x0002
147 #define L2CAP_UNKNOWN_OPTION 0x0003
148 /* 0x0003 - 0xffff - reserved for future use */
150 /* L2CAP Configuration options */
151 #define L2CAP_OPT_CFLAG_BIT 0x0001
152 #define L2CAP_OPT_CFLAG(flags) ((flags) & L2CAP_OPT_CFLAG_BIT)
153 #define L2CAP_OPT_HINT_BIT 0x80
154 #define L2CAP_OPT_HINT(type) ((type) & L2CAP_OPT_HINT_BIT)
155 #define L2CAP_OPT_HINT_MASK 0x7f
156 #define L2CAP_OPT_MTU 0x01
157 #define L2CAP_OPT_MTU_SIZE sizeof(uint16_t)
158 #define L2CAP_OPT_FLUSH_TIMO 0x02
159 #define L2CAP_OPT_FLUSH_TIMO_SIZE sizeof(uint16_t)
160 #define L2CAP_OPT_QOS 0x03
161 #define L2CAP_OPT_QOS_SIZE sizeof(l2cap_qos_t)
162 #define L2CAP_OPT_RFC 0x04
163 #define L2CAP_OPT_RFC_SIZE sizeof(l2cap_rfc_t)
164 /* 0x05 - 0xff - reserved for future use */
166 /* L2CAP Information request type codes */
167 #define L2CAP_CONNLESS_MTU 0x0001
168 #define L2CAP_EXTENDED_FEATURES 0x0002
169 /* 0x0003 - 0xffff - reserved for future use */
171 /* L2CAP Information response codes */
172 #define L2CAP_NOT_SUPPORTED 0x0001
173 /* 0x0002 - 0xffff - reserved for future use */
175 /* L2CAP Quality of Service option */
176 typedef struct {
177 uint8_t flags; /* reserved for future use */
178 uint8_t service_type; /* service type */
179 uint32_t token_rate; /* bytes per second */
180 uint32_t token_bucket_size; /* bytes */
181 uint32_t peak_bandwidth; /* bytes per second */
182 uint32_t latency; /* microseconds */
183 uint32_t delay_variation; /* microseconds */
184 } __packed l2cap_qos_t;
186 /* L2CAP QoS type */
187 #define L2CAP_QOS_NO_TRAFFIC 0x00
188 #define L2CAP_QOS_BEST_EFFORT 0x01 /* (default) */
189 #define L2CAP_QOS_GUARANTEED 0x02
190 /* 0x03 - 0xff - reserved for future use */
192 /* L2CAP Retransmission & Flow Control option */
193 typedef struct {
194 uint8_t mode; /* RFC mode */
195 uint8_t window_size; /* bytes */
196 uint8_t max_transmit; /* max retransmissions */
197 uint16_t retransmit_timo; /* milliseconds */
198 uint16_t monitor_timo; /* milliseconds */
199 uint16_t max_pdu_size; /* bytes */
200 } __packed l2cap_rfc_t;
202 /* L2CAP RFC mode */
203 #define L2CAP_RFC_BASIC 0x00 /* (default) */
204 #define L2CAP_RFC_RETRANSMIT 0x01
205 #define L2CAP_RFC_FLOW 0x02
206 /* 0x03 - 0xff - reserved for future use */
208 /**************************************************************************
209 **************************************************************************
210 ** Link level defines, headers and types
211 **************************************************************************
212 **************************************************************************/
214 /* L2CAP header */
215 typedef struct {
216 uint16_t length; /* payload size */
217 uint16_t dcid; /* destination channel ID */
218 } __packed l2cap_hdr_t;
220 /* L2CAP ConnectionLess Traffic (dcid == L2CAP_CLT_CID) */
221 typedef struct {
222 uint16_t psm; /* Protocol/Service Multiplexor */
223 } __packed l2cap_clt_hdr_t;
225 #define L2CAP_CLT_MTU_MAXIMUM \
226 (L2CAP_MTU_MAXIMUM - sizeof(l2cap_clt_hdr_t))
228 /* L2CAP Command header (dcid == L2CAP_SIGNAL_CID) */
229 typedef struct {
230 uint8_t code; /* command OpCode */
231 uint8_t ident; /* identifier to match request and response */
232 uint16_t length; /* command parameters length */
233 } __packed l2cap_cmd_hdr_t;
235 /* L2CAP Command Reject */
236 #define L2CAP_COMMAND_REJ 0x01
237 typedef struct {
238 uint16_t reason; /* reason to reject command */
239 uint16_t data[2];/* optional data */
240 } __packed l2cap_cmd_rej_cp;
242 /* L2CAP Connection Request */
243 #define L2CAP_CONNECT_REQ 0x02
244 typedef struct {
245 uint16_t psm; /* Protocol/Service Multiplexor (PSM) */
246 uint16_t scid; /* source channel ID */
247 } __packed l2cap_con_req_cp;
249 /* L2CAP Connection Response */
250 #define L2CAP_CONNECT_RSP 0x03
251 typedef struct {
252 uint16_t dcid; /* destination channel ID */
253 uint16_t scid; /* source channel ID */
254 uint16_t result; /* 0x00 - success */
255 uint16_t status; /* more info if result != 0x00 */
256 } __packed l2cap_con_rsp_cp;
258 /* L2CAP Configuration Request */
259 #define L2CAP_CONFIG_REQ 0x04
260 typedef struct {
261 uint16_t dcid; /* destination channel ID */
262 uint16_t flags; /* flags */
263 /* uint8_t options[] -- options */
264 } __packed l2cap_cfg_req_cp;
266 /* L2CAP Configuration Response */
267 #define L2CAP_CONFIG_RSP 0x05
268 typedef struct {
269 uint16_t scid; /* source channel ID */
270 uint16_t flags; /* flags */
271 uint16_t result; /* 0x00 - success */
272 /* uint8_t options[] -- options */
273 } __packed l2cap_cfg_rsp_cp;
275 /* L2CAP configuration option */
276 typedef struct {
277 uint8_t type;
278 uint8_t length;
279 /* uint8_t value[] -- option value (depends on type) */
280 } __packed l2cap_cfg_opt_t;
282 /* L2CAP configuration option value */
283 typedef union {
284 uint16_t mtu; /* L2CAP_OPT_MTU */
285 uint16_t flush_timo; /* L2CAP_OPT_FLUSH_TIMO */
286 l2cap_qos_t qos; /* L2CAP_OPT_QOS */
287 l2cap_rfc_t rfc; /* L2CAP_OPT_RFC */
288 } l2cap_cfg_opt_val_t;
290 /* L2CAP Disconnect Request */
291 #define L2CAP_DISCONNECT_REQ 0x06
292 typedef struct {
293 uint16_t dcid; /* destination channel ID */
294 uint16_t scid; /* source channel ID */
295 } __packed l2cap_discon_req_cp;
297 /* L2CAP Disconnect Response */
298 #define L2CAP_DISCONNECT_RSP 0x07
299 typedef l2cap_discon_req_cp l2cap_discon_rsp_cp;
301 /* L2CAP Echo Request */
302 #define L2CAP_ECHO_REQ 0x08
303 /* No command parameters, only optional data */
305 /* L2CAP Echo Response */
306 #define L2CAP_ECHO_RSP 0x09
307 #define L2CAP_MAX_ECHO_SIZE \
308 (L2CAP_MTU_MAXIMUM - sizeof(l2cap_cmd_hdr_t))
309 /* No command parameters, only optional data */
311 /* L2CAP Information Request */
312 #define L2CAP_INFO_REQ 0x0a
313 typedef struct {
314 uint16_t type; /* requested information type */
315 } __packed l2cap_info_req_cp;
317 /* L2CAP Information Response */
318 #define L2CAP_INFO_RSP 0x0b
319 typedef struct {
320 uint16_t type; /* requested information type */
321 uint16_t result; /* 0x00 - success */
322 /* uint8_t info[] -- info data (depends on type)
324 * L2CAP_CONNLESS_MTU - 2 bytes connectionless MTU
326 } __packed l2cap_info_rsp_cp;
328 typedef union {
329 /* L2CAP_CONNLESS_MTU */
330 struct {
331 uint16_t mtu;
332 } __packed mtu;
333 } l2cap_info_rsp_data_t;
335 /**************************************************************************
336 **************************************************************************
337 ** L2CAP Socket Definitions
338 **************************************************************************
339 **************************************************************************/
341 /* Socket options */
342 #define SO_L2CAP_IMTU 1 /* incoming MTU */
343 #define SO_L2CAP_OMTU 2 /* outgoing MTU */
344 #define SO_L2CAP_IQOS 3 /* incoming QoS */
345 #define SO_L2CAP_OQOS 4 /* outgoing QoS */
346 #define SO_L2CAP_FLUSH 5 /* flush timeout */
347 #define SO_L2CAP_LM 6 /* link mode */
349 /* L2CAP link mode flags */
350 #define L2CAP_LM_AUTH (1<<0) /* want authentication */
351 #define L2CAP_LM_ENCRYPT (1<<1) /* want encryption */
352 #define L2CAP_LM_SECURE (1<<2) /* want secured link */
354 #ifdef _KERNEL
356 LIST_HEAD(l2cap_channel_list, l2cap_channel);
358 /* global variables */
359 extern struct l2cap_channel_list l2cap_active_list;
360 extern struct l2cap_channel_list l2cap_listen_list;
361 extern struct pool l2cap_pdu_pool;
362 extern struct pool l2cap_req_pool;
363 extern const l2cap_qos_t l2cap_default_qos;
365 /* sysctl variables */
366 extern int l2cap_response_timeout;
367 extern int l2cap_response_extended_timeout;
368 extern int l2cap_sendspace, l2cap_recvspace;
371 * L2CAP Channel
373 struct l2cap_channel {
374 struct hci_link *lc_link; /* ACL connection (down) */
375 uint16_t lc_state; /* channel state */
376 uint16_t lc_flags; /* channel flags */
377 uint8_t lc_ident; /* cached request id */
379 uint16_t lc_lcid; /* local channel ID */
380 struct sockaddr_bt lc_laddr; /* local address */
382 uint16_t lc_rcid; /* remote channel ID */
383 struct sockaddr_bt lc_raddr; /* remote address */
385 int lc_mode; /* link mode */
386 uint16_t lc_imtu; /* incoming mtu */
387 uint16_t lc_omtu; /* outgoing mtu */
388 uint16_t lc_flush; /* flush timeout */
389 l2cap_qos_t lc_iqos; /* incoming QoS flow control */
390 l2cap_qos_t lc_oqos; /* outgoing Qos flow control */
392 uint8_t lc_pending; /* num of pending PDUs */
393 MBUFQ_HEAD() lc_txq; /* transmit queue */
395 const struct btproto *lc_proto; /* upper layer callbacks */
396 void *lc_upper; /* upper layer argument */
398 LIST_ENTRY(l2cap_channel)lc_ncid; /* next channel (ascending CID) */
401 /* l2cap_channel state */
402 #define L2CAP_CLOSED 0 /* closed */
403 #define L2CAP_WAIT_SEND_CONNECT_REQ 1 /* waiting to send connect request */
404 #define L2CAP_WAIT_RECV_CONNECT_RSP 2 /* waiting to recv connect response */
405 #define L2CAP_WAIT_SEND_CONNECT_RSP 3 /* waiting to send connect response */
406 #define L2CAP_WAIT_CONFIG 4 /* waiting for configuration */
407 #define L2CAP_OPEN 5 /* user data transfer state */
408 #define L2CAP_WAIT_DISCONNECT 6 /* have sent disconnect request */
410 /* l2cap_channel flags */
411 #define L2CAP_SHUTDOWN (1<<0) /* channel is closing */
412 #define L2CAP_WAIT_CONFIG_REQ (1<<1) /* waiting for config request */
413 #define L2CAP_WAIT_CONFIG_RSP (1<<2) /* waiting for config response */
416 * L2CAP Request
418 struct l2cap_req {
419 struct hci_link *lr_link; /* ACL connection */
420 struct l2cap_channel *lr_chan; /* channel pointer */
421 uint8_t lr_code; /* request code */
422 uint8_t lr_id; /* request id */
423 callout_t lr_rtx; /* response timer */
424 TAILQ_ENTRY(l2cap_req) lr_next; /* next request on link */
428 * L2CAP Protocol Data Unit
430 struct l2cap_pdu {
431 struct l2cap_channel *lp_chan; /* PDU owner */
432 MBUFQ_HEAD() lp_data; /* PDU data */
433 TAILQ_ENTRY(l2cap_pdu) lp_next; /* next PDU on link */
434 int lp_pending; /* # of fragments pending */
438 * L2CAP function prototypes
441 struct socket;
442 struct sockopt;
443 struct mbuf;
445 /* l2cap_lower.c */
446 void l2cap_close(struct l2cap_channel *, int);
447 void l2cap_recv_frame(struct mbuf *, struct hci_link *);
448 int l2cap_start(struct l2cap_channel *);
450 /* l2cap_misc.c */
451 int l2cap_setmode(struct l2cap_channel *);
452 int l2cap_cid_alloc(struct l2cap_channel *);
453 struct l2cap_channel *l2cap_cid_lookup(uint16_t);
454 int l2cap_request_alloc(struct l2cap_channel *, uint8_t);
455 struct l2cap_req *l2cap_request_lookup(struct hci_link *, uint8_t);
456 void l2cap_request_free(struct l2cap_req *);
457 void l2cap_rtx(void *);
458 void l2cap_init(void);
460 /* l2cap_signal.c */
461 void l2cap_recv_signal(struct mbuf *, struct hci_link *);
462 int l2cap_send_connect_req(struct l2cap_channel *);
463 int l2cap_send_config_req(struct l2cap_channel *);
464 int l2cap_send_disconnect_req(struct l2cap_channel *);
465 int l2cap_send_connect_rsp(struct hci_link *, uint8_t, uint16_t, uint16_t, uint16_t);
467 /* l2cap_socket.c */
468 int l2cap_usrreq(struct socket *, int, struct mbuf *, struct mbuf *, struct mbuf *, struct lwp *);
469 int l2cap_ctloutput(int, struct socket *, struct sockopt *);
471 /* l2cap_upper.c */
472 int l2cap_attach(struct l2cap_channel **, const struct btproto *, void *);
473 int l2cap_bind(struct l2cap_channel *, struct sockaddr_bt *);
474 int l2cap_sockaddr(struct l2cap_channel *, struct sockaddr_bt *);
475 int l2cap_connect(struct l2cap_channel *, struct sockaddr_bt *);
476 int l2cap_peeraddr(struct l2cap_channel *, struct sockaddr_bt *);
477 int l2cap_disconnect(struct l2cap_channel *, int);
478 int l2cap_detach(struct l2cap_channel **);
479 int l2cap_listen(struct l2cap_channel *);
480 int l2cap_send(struct l2cap_channel *, struct mbuf *);
481 int l2cap_setopt(struct l2cap_channel *, const struct sockopt *);
482 int l2cap_getopt(struct l2cap_channel *, struct sockopt *);
484 #endif /* _KERNEL */
486 #endif /* _NETBT_L2CAP_H_ */