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