ng_btsocket.h revision 139823
1/*
2 * ng_btsocket.h
3 */
4
5/*-
6 * Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com>
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $Id: ng_btsocket.h,v 1.8 2003/04/26 22:32:10 max Exp $
31 * $FreeBSD: head/sys/netgraph/bluetooth/include/ng_btsocket.h 139823 2005-01-07 01:45:51Z imp $
32 */
33
34#ifndef _NETGRAPH_BTSOCKET_H_
35#define _NETGRAPH_BTSOCKET_H_
36
37/*
38 * Bluetooth protocols
39 */
40
41#define BLUETOOTH_PROTO_HCI	134	/* HCI protocol number */
42#define BLUETOOTH_PROTO_L2CAP	135	/* L2CAP protocol number */
43#define BLUETOOTH_PROTO_RFCOMM	136	/* RFCOMM protocol number */
44
45/*
46 * Bluetooth version of struct sockaddr for raw HCI sockets
47 */
48
49struct sockaddr_hci {
50	u_char		hci_len;	/* total length */
51	u_char		hci_family;	/* address family */
52	char		hci_node[32];	/* address (size == NG_NODESIZ ) */
53};
54
55/* Raw HCI socket options */
56#define SOL_HCI_RAW		0x0802	/* socket options level */
57
58#define SO_HCI_RAW_FILTER	1	/* get/set filter on socket */
59#define SO_HCI_RAW_DIRECTION	2	/* turn on/off direction info */
60#define SCM_HCI_RAW_DIRECTION	SO_HCI_RAW_DIRECTION /* cmsg_type  */
61
62/*
63 * Raw HCI socket filter.
64 *
65 * For packet mask use (1 << (HCI packet indicator - 1))
66 * For event mask use (1 << (Event - 1))
67 */
68
69struct ng_btsocket_hci_raw_filter {
70	bitstr_t	bit_decl(packet_mask, 32);
71	bitstr_t	bit_decl(event_mask, (NG_HCI_EVENT_MASK_SIZE * 8));
72};
73
74/*
75 * Raw HCI sockets ioctl's
76 */
77
78/* Get state */
79struct ng_btsocket_hci_raw_node_state {
80	ng_hci_node_state_ep	state;
81};
82#define SIOC_HCI_RAW_NODE_GET_STATE \
83	_IOWR('b', NGM_HCI_NODE_GET_STATE, \
84		struct ng_btsocket_hci_raw_node_state)
85
86/* Initialize */
87#define SIOC_HCI_RAW_NODE_INIT \
88	_IO('b', NGM_HCI_NODE_INIT)
89
90/* Get/Set debug level */
91struct ng_btsocket_hci_raw_node_debug {
92	ng_hci_node_debug_ep	debug;
93};
94#define SIOC_HCI_RAW_NODE_GET_DEBUG \
95	_IOWR('b', NGM_HCI_NODE_GET_DEBUG, \
96		struct ng_btsocket_hci_raw_node_debug)
97#define SIOC_HCI_RAW_NODE_SET_DEBUG \
98	_IOWR('b', NGM_HCI_NODE_SET_DEBUG, \
99		struct ng_btsocket_hci_raw_node_debug)
100
101/* Get buffer info */
102struct ng_btsocket_hci_raw_node_buffer {
103	ng_hci_node_buffer_ep	buffer;
104};
105#define SIOC_HCI_RAW_NODE_GET_BUFFER \
106	_IOWR('b', NGM_HCI_NODE_GET_BUFFER, \
107		struct ng_btsocket_hci_raw_node_buffer)
108
109/* Get BD_ADDR */
110struct ng_btsocket_hci_raw_node_bdaddr {
111	bdaddr_t	bdaddr;
112};
113#define SIOC_HCI_RAW_NODE_GET_BDADDR \
114	_IOWR('b', NGM_HCI_NODE_GET_BDADDR, \
115		struct ng_btsocket_hci_raw_node_bdaddr)
116
117/* Get features */
118struct ng_btsocket_hci_raw_node_features {
119	u_int8_t	features[NG_HCI_FEATURES_SIZE];
120};
121#define SIOC_HCI_RAW_NODE_GET_FEATURES \
122	_IOWR('b', NGM_HCI_NODE_GET_FEATURES, \
123		struct ng_btsocket_hci_raw_node_features)
124
125/* Get stat */
126struct ng_btsocket_hci_raw_node_stat {
127	ng_hci_node_stat_ep	stat;
128};
129#define SIOC_HCI_RAW_NODE_GET_STAT \
130	_IOWR('b', NGM_HCI_NODE_GET_STAT, \
131		struct ng_btsocket_hci_raw_node_stat)
132
133/* Reset stat */
134#define SIOC_HCI_RAW_NODE_RESET_STAT \
135	_IO('b', NGM_HCI_NODE_RESET_STAT)
136
137/* Flush neighbor cache */
138#define SIOC_HCI_RAW_NODE_FLUSH_NEIGHBOR_CACHE \
139	_IO('b', NGM_HCI_NODE_FLUSH_NEIGHBOR_CACHE)
140
141/* Get neighbor cache */
142struct ng_btsocket_hci_raw_node_neighbor_cache {
143	u_int32_t				 num_entries;
144	ng_hci_node_neighbor_cache_entry_ep	*entries;
145};
146#define SIOC_HCI_RAW_NODE_GET_NEIGHBOR_CACHE \
147	_IOWR('b', NGM_HCI_NODE_GET_NEIGHBOR_CACHE, \
148		struct ng_btsocket_hci_raw_node_neighbor_cache)
149
150/* Get connection list */
151struct ng_btsocket_hci_raw_con_list {
152	u_int32_t		 num_connections;
153	ng_hci_node_con_ep	*connections;
154};
155#define SIOC_HCI_RAW_NODE_GET_CON_LIST \
156	_IOWR('b', NGM_HCI_NODE_GET_CON_LIST, \
157		struct ng_btsocket_hci_raw_con_list)
158
159/* Get/Set link policy settings mask */
160struct ng_btsocket_hci_raw_node_link_policy_mask {
161	ng_hci_node_link_policy_mask_ep	policy_mask;
162};
163#define SIOC_HCI_RAW_NODE_GET_LINK_POLICY_MASK \
164	_IOWR('b', NGM_HCI_NODE_GET_LINK_POLICY_SETTINGS_MASK, \
165		struct ng_btsocket_hci_raw_node_link_policy_mask)
166#define SIOC_HCI_RAW_NODE_SET_LINK_POLICY_MASK \
167	_IOWR('b', NGM_HCI_NODE_SET_LINK_POLICY_SETTINGS_MASK, \
168		struct ng_btsocket_hci_raw_node_link_policy_mask)
169
170/* Get/Set packet mask */
171struct ng_btsocket_hci_raw_node_packet_mask {
172	ng_hci_node_packet_mask_ep	packet_mask;
173};
174#define SIOC_HCI_RAW_NODE_GET_PACKET_MASK \
175	_IOWR('b', NGM_HCI_NODE_GET_PACKET_MASK, \
176		struct ng_btsocket_hci_raw_node_packet_mask)
177#define SIOC_HCI_RAW_NODE_SET_PACKET_MASK \
178	_IOWR('b', NGM_HCI_NODE_SET_PACKET_MASK, \
179		struct ng_btsocket_hci_raw_node_packet_mask)
180
181/* Get/Set role switch */
182struct ng_btsocket_hci_raw_node_role_switch {
183	ng_hci_node_role_switch_ep	role_switch;
184};
185#define SIOC_HCI_RAW_NODE_GET_ROLE_SWITCH \
186	_IOWR('b', NGM_HCI_NODE_GET_ROLE_SWITCH, \
187		struct ng_btsocket_hci_raw_node_role_switch)
188#define SIOC_HCI_RAW_NODE_SET_ROLE_SWITCH \
189	_IOWR('b', NGM_HCI_NODE_SET_ROLE_SWITCH, \
190		struct ng_btsocket_hci_raw_node_role_switch)
191
192/*
193 * XXX FIXME: probably does not belong here
194 * Bluetooth version of struct sockaddr for L2CAP sockets (RAW and SEQPACKET)
195 */
196
197struct sockaddr_l2cap {
198	u_char		l2cap_len;	/* total length */
199	u_char		l2cap_family;	/* address family */
200	u_int16_t	l2cap_psm;	/* PSM (Protocol/Service Multiplexor) */
201	bdaddr_t	l2cap_bdaddr;	/* address */
202};
203
204/* L2CAP socket options */
205#define SOL_L2CAP		0x1609	/* socket option level */
206
207#define SO_L2CAP_IMTU		1	/* get/set incoming MTU */
208#define SO_L2CAP_OMTU		2	/* get outgoing (peer incoming) MTU */
209#define SO_L2CAP_IFLOW		3	/* get incoming flow spec. */
210#define SO_L2CAP_OFLOW		4	/* get/set outgoing flow spec. */
211#define SO_L2CAP_FLUSH		5	/* get/set flush timeout */
212
213/*
214 * Raw L2CAP sockets ioctl's
215 */
216
217/* Ping */
218struct ng_btsocket_l2cap_raw_ping {
219	u_int32_t		 result;
220	u_int32_t		 echo_size;
221	u_int8_t		*echo_data;
222};
223#define SIOC_L2CAP_L2CA_PING \
224	_IOWR('b', NGM_L2CAP_L2CA_PING, \
225		struct ng_btsocket_l2cap_raw_ping)
226
227/* Get info */
228struct ng_btsocket_l2cap_raw_get_info {
229	u_int32_t		 result;
230	u_int32_t		 info_type;
231	u_int32_t		 info_size;
232	u_int8_t		*info_data;
233};
234#define SIOC_L2CAP_L2CA_GET_INFO \
235	_IOWR('b', NGM_L2CAP_L2CA_GET_INFO, \
236		struct ng_btsocket_l2cap_raw_get_info)
237
238/* Get flags */
239struct ng_btsocket_l2cap_raw_node_flags {
240	ng_l2cap_node_flags_ep	flags;
241};
242#define SIOC_L2CAP_NODE_GET_FLAGS \
243	_IOWR('b', NGM_L2CAP_NODE_GET_FLAGS, \
244		struct ng_btsocket_l2cap_raw_node_flags)
245
246/* Get/Set debug level */
247struct ng_btsocket_l2cap_raw_node_debug {
248	ng_l2cap_node_debug_ep	debug;
249};
250#define SIOC_L2CAP_NODE_GET_DEBUG \
251	_IOWR('b', NGM_L2CAP_NODE_GET_DEBUG, \
252		struct ng_btsocket_l2cap_raw_node_debug)
253#define SIOC_L2CAP_NODE_SET_DEBUG \
254	_IOWR('b', NGM_L2CAP_NODE_SET_DEBUG, \
255		struct ng_btsocket_l2cap_raw_node_debug)
256
257/* Get connection list */
258struct ng_btsocket_l2cap_raw_con_list {
259	u_int32_t		 num_connections;
260	ng_l2cap_node_con_ep	*connections;
261};
262#define SIOC_L2CAP_NODE_GET_CON_LIST \
263	_IOWR('b', NGM_L2CAP_NODE_GET_CON_LIST, \
264		struct ng_btsocket_l2cap_raw_con_list)
265
266/* Get channel list */
267struct ng_btsocket_l2cap_raw_chan_list {
268	u_int32_t		 num_channels;
269	ng_l2cap_node_chan_ep	*channels;
270};
271#define SIOC_L2CAP_NODE_GET_CHAN_LIST \
272	_IOWR('b', NGM_L2CAP_NODE_GET_CHAN_LIST, \
273		struct ng_btsocket_l2cap_raw_chan_list)
274
275/* Get/Set auto disconnect timeout */
276struct ng_btsocket_l2cap_raw_auto_discon_timo
277{
278	ng_l2cap_node_auto_discon_ep	timeout;
279};
280#define SIOC_L2CAP_NODE_GET_AUTO_DISCON_TIMO \
281	_IOWR('b', NGM_L2CAP_NODE_GET_AUTO_DISCON_TIMO, \
282		struct ng_btsocket_l2cap_raw_auto_discon_timo)
283#define SIOC_L2CAP_NODE_SET_AUTO_DISCON_TIMO \
284	_IOWR('b', NGM_L2CAP_NODE_SET_AUTO_DISCON_TIMO, \
285		struct ng_btsocket_l2cap_raw_auto_discon_timo)
286
287/*
288 * XXX FIXME: probably does not belong here
289 * Bluetooth version of struct sockaddr for RFCOMM sockets (STREAM)
290 */
291
292struct sockaddr_rfcomm {
293	u_char		rfcomm_len;	/* total length */
294	u_char		rfcomm_family;	/* address family */
295	bdaddr_t	rfcomm_bdaddr;	/* address */
296	u_int8_t	rfcomm_channel;	/* channel */
297};
298
299/* Flow control information */
300struct ng_btsocket_rfcomm_fc_info {
301	u_int8_t	lmodem;		/* modem signals (local) */
302	u_int8_t	rmodem;		/* modem signals (remote) */
303	u_int8_t	tx_cred;	/* TX credits */
304	u_int8_t	rx_cred;	/* RX credits */
305	u_int8_t	cfc;		/* credit flow control */
306	u_int8_t	reserved;
307};
308
309/* STREAM RFCOMM socket options */
310#define SOL_RFCOMM		0x0816	/* socket options level */
311
312#define SO_RFCOMM_MTU		1	/* get channel MTU */
313#define SO_RFCOMM_FC_INFO	2	/* get flow control information */
314
315/*
316 * Netgraph node type name and cookie
317 */
318
319#define	NG_BTSOCKET_HCI_RAW_NODE_TYPE	"btsock_hci_raw"
320#define	NG_BTSOCKET_L2CAP_RAW_NODE_TYPE	"btsock_l2c_raw"
321#define	NG_BTSOCKET_L2CAP_NODE_TYPE	"btsock_l2c"
322
323/*
324 * Debug levels
325 */
326
327#define NG_BTSOCKET_ALERT_LEVEL	1
328#define NG_BTSOCKET_ERR_LEVEL	2
329#define NG_BTSOCKET_WARN_LEVEL	3
330#define NG_BTSOCKET_INFO_LEVEL	4
331
332#endif /* _NETGRAPH_BTSOCKET_H_ */
333
334