xref: /freebsd/sys/netgraph/bluetooth/include/ng_btsocket.h (revision 0f8f86b71f022b803e99151c19db81b280f245dc)
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$
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  * XXX: sizeof(hci_node) was NG_NODELEN + 1, but NG_NODESIZ (the equivalent
55  * of NG_NODELEN + 1) has been bumped to 32. The code currently
56  * truncates the node name to sizeof(hci_node), although it would be
57  * possible to correctly handle this by means of the hci_len field.
58  */
59 
60 struct sockaddr_hci {
61 	u_char		hci_len;	/* total length */
62 	u_char		hci_family;	/* address family */
63 	char		hci_node[16];	/* address */
64 };
65 
66 /* Raw HCI socket options */
67 #define SOL_HCI_RAW		0x0802	/* socket options level */
68 
69 #define SO_HCI_RAW_FILTER	1	/* get/set filter on socket */
70 #define SO_HCI_RAW_DIRECTION	2	/* turn on/off direction info */
71 #define SCM_HCI_RAW_DIRECTION	SO_HCI_RAW_DIRECTION /* cmsg_type  */
72 
73 /*
74  * Raw HCI socket filter.
75  *
76  * For packet mask use (1 << (HCI packet indicator - 1))
77  * For event mask use (1 << (Event - 1))
78  */
79 
80 struct ng_btsocket_hci_raw_filter {
81 	bitstr_t	bit_decl(packet_mask, 32);
82 	bitstr_t	bit_decl(event_mask, (NG_HCI_EVENT_MASK_SIZE * 8));
83 };
84 
85 /*
86  * Raw HCI sockets ioctl's
87  */
88 
89 /* Get state */
90 struct ng_btsocket_hci_raw_node_state {
91 	ng_hci_node_state_ep	state;
92 };
93 #define SIOC_HCI_RAW_NODE_GET_STATE \
94 	_IOWR('b', NGM_HCI_NODE_GET_STATE, \
95 		struct ng_btsocket_hci_raw_node_state)
96 
97 /* Initialize */
98 #define SIOC_HCI_RAW_NODE_INIT \
99 	_IO('b', NGM_HCI_NODE_INIT)
100 
101 /* Get/Set debug level */
102 struct ng_btsocket_hci_raw_node_debug {
103 	ng_hci_node_debug_ep	debug;
104 };
105 #define SIOC_HCI_RAW_NODE_GET_DEBUG \
106 	_IOWR('b', NGM_HCI_NODE_GET_DEBUG, \
107 		struct ng_btsocket_hci_raw_node_debug)
108 #define SIOC_HCI_RAW_NODE_SET_DEBUG \
109 	_IOWR('b', NGM_HCI_NODE_SET_DEBUG, \
110 		struct ng_btsocket_hci_raw_node_debug)
111 
112 /* Get buffer info */
113 struct ng_btsocket_hci_raw_node_buffer {
114 	ng_hci_node_buffer_ep	buffer;
115 };
116 #define SIOC_HCI_RAW_NODE_GET_BUFFER \
117 	_IOWR('b', NGM_HCI_NODE_GET_BUFFER, \
118 		struct ng_btsocket_hci_raw_node_buffer)
119 
120 /* Get BD_ADDR */
121 struct ng_btsocket_hci_raw_node_bdaddr {
122 	bdaddr_t	bdaddr;
123 };
124 #define SIOC_HCI_RAW_NODE_GET_BDADDR \
125 	_IOWR('b', NGM_HCI_NODE_GET_BDADDR, \
126 		struct ng_btsocket_hci_raw_node_bdaddr)
127 
128 /* Get features */
129 struct ng_btsocket_hci_raw_node_features {
130 	u_int8_t	features[NG_HCI_FEATURES_SIZE];
131 };
132 #define SIOC_HCI_RAW_NODE_GET_FEATURES \
133 	_IOWR('b', NGM_HCI_NODE_GET_FEATURES, \
134 		struct ng_btsocket_hci_raw_node_features)
135 
136 /* Get stat */
137 struct ng_btsocket_hci_raw_node_stat {
138 	ng_hci_node_stat_ep	stat;
139 };
140 #define SIOC_HCI_RAW_NODE_GET_STAT \
141 	_IOWR('b', NGM_HCI_NODE_GET_STAT, \
142 		struct ng_btsocket_hci_raw_node_stat)
143 
144 /* Reset stat */
145 #define SIOC_HCI_RAW_NODE_RESET_STAT \
146 	_IO('b', NGM_HCI_NODE_RESET_STAT)
147 
148 /* Flush neighbor cache */
149 #define SIOC_HCI_RAW_NODE_FLUSH_NEIGHBOR_CACHE \
150 	_IO('b', NGM_HCI_NODE_FLUSH_NEIGHBOR_CACHE)
151 
152 /* Get neighbor cache */
153 struct ng_btsocket_hci_raw_node_neighbor_cache {
154 	u_int32_t				 num_entries;
155 	ng_hci_node_neighbor_cache_entry_ep	*entries;
156 };
157 #define SIOC_HCI_RAW_NODE_GET_NEIGHBOR_CACHE \
158 	_IOWR('b', NGM_HCI_NODE_GET_NEIGHBOR_CACHE, \
159 		struct ng_btsocket_hci_raw_node_neighbor_cache)
160 
161 /* Get connection list */
162 struct ng_btsocket_hci_raw_con_list {
163 	u_int32_t		 num_connections;
164 	ng_hci_node_con_ep	*connections;
165 };
166 #define SIOC_HCI_RAW_NODE_GET_CON_LIST \
167 	_IOWR('b', NGM_HCI_NODE_GET_CON_LIST, \
168 		struct ng_btsocket_hci_raw_con_list)
169 
170 /* Get/Set link policy settings mask */
171 struct ng_btsocket_hci_raw_node_link_policy_mask {
172 	ng_hci_node_link_policy_mask_ep	policy_mask;
173 };
174 #define SIOC_HCI_RAW_NODE_GET_LINK_POLICY_MASK \
175 	_IOWR('b', NGM_HCI_NODE_GET_LINK_POLICY_SETTINGS_MASK, \
176 		struct ng_btsocket_hci_raw_node_link_policy_mask)
177 #define SIOC_HCI_RAW_NODE_SET_LINK_POLICY_MASK \
178 	_IOWR('b', NGM_HCI_NODE_SET_LINK_POLICY_SETTINGS_MASK, \
179 		struct ng_btsocket_hci_raw_node_link_policy_mask)
180 
181 /* Get/Set packet mask */
182 struct ng_btsocket_hci_raw_node_packet_mask {
183 	ng_hci_node_packet_mask_ep	packet_mask;
184 };
185 #define SIOC_HCI_RAW_NODE_GET_PACKET_MASK \
186 	_IOWR('b', NGM_HCI_NODE_GET_PACKET_MASK, \
187 		struct ng_btsocket_hci_raw_node_packet_mask)
188 #define SIOC_HCI_RAW_NODE_SET_PACKET_MASK \
189 	_IOWR('b', NGM_HCI_NODE_SET_PACKET_MASK, \
190 		struct ng_btsocket_hci_raw_node_packet_mask)
191 
192 /* Get/Set role switch */
193 struct ng_btsocket_hci_raw_node_role_switch {
194 	ng_hci_node_role_switch_ep	role_switch;
195 };
196 #define SIOC_HCI_RAW_NODE_GET_ROLE_SWITCH \
197 	_IOWR('b', NGM_HCI_NODE_GET_ROLE_SWITCH, \
198 		struct ng_btsocket_hci_raw_node_role_switch)
199 #define SIOC_HCI_RAW_NODE_SET_ROLE_SWITCH \
200 	_IOWR('b', NGM_HCI_NODE_SET_ROLE_SWITCH, \
201 		struct ng_btsocket_hci_raw_node_role_switch)
202 
203 /*
204  * XXX FIXME: probably does not belong here
205  * Bluetooth version of struct sockaddr for L2CAP sockets (RAW and SEQPACKET)
206  */
207 
208 struct sockaddr_l2cap {
209 	u_char		l2cap_len;	/* total length */
210 	u_char		l2cap_family;	/* address family */
211 	u_int16_t	l2cap_psm;	/* PSM (Protocol/Service Multiplexor) */
212 	bdaddr_t	l2cap_bdaddr;	/* address */
213 };
214 
215 /* L2CAP socket options */
216 #define SOL_L2CAP		0x1609	/* socket option level */
217 
218 #define SO_L2CAP_IMTU		1	/* get/set incoming MTU */
219 #define SO_L2CAP_OMTU		2	/* get outgoing (peer incoming) MTU */
220 #define SO_L2CAP_IFLOW		3	/* get incoming flow spec. */
221 #define SO_L2CAP_OFLOW		4	/* get/set outgoing flow spec. */
222 #define SO_L2CAP_FLUSH		5	/* get/set flush timeout */
223 
224 /*
225  * Raw L2CAP sockets ioctl's
226  */
227 
228 /* Ping */
229 struct ng_btsocket_l2cap_raw_ping {
230 	u_int32_t		 result;
231 	u_int32_t		 echo_size;
232 	u_int8_t		*echo_data;
233 };
234 #define SIOC_L2CAP_L2CA_PING \
235 	_IOWR('b', NGM_L2CAP_L2CA_PING, \
236 		struct ng_btsocket_l2cap_raw_ping)
237 
238 /* Get info */
239 struct ng_btsocket_l2cap_raw_get_info {
240 	u_int32_t		 result;
241 	u_int32_t		 info_type;
242 	u_int32_t		 info_size;
243 	u_int8_t		*info_data;
244 };
245 #define SIOC_L2CAP_L2CA_GET_INFO \
246 	_IOWR('b', NGM_L2CAP_L2CA_GET_INFO, \
247 		struct ng_btsocket_l2cap_raw_get_info)
248 
249 /* Get flags */
250 struct ng_btsocket_l2cap_raw_node_flags {
251 	ng_l2cap_node_flags_ep	flags;
252 };
253 #define SIOC_L2CAP_NODE_GET_FLAGS \
254 	_IOWR('b', NGM_L2CAP_NODE_GET_FLAGS, \
255 		struct ng_btsocket_l2cap_raw_node_flags)
256 
257 /* Get/Set debug level */
258 struct ng_btsocket_l2cap_raw_node_debug {
259 	ng_l2cap_node_debug_ep	debug;
260 };
261 #define SIOC_L2CAP_NODE_GET_DEBUG \
262 	_IOWR('b', NGM_L2CAP_NODE_GET_DEBUG, \
263 		struct ng_btsocket_l2cap_raw_node_debug)
264 #define SIOC_L2CAP_NODE_SET_DEBUG \
265 	_IOWR('b', NGM_L2CAP_NODE_SET_DEBUG, \
266 		struct ng_btsocket_l2cap_raw_node_debug)
267 
268 /* Get connection list */
269 struct ng_btsocket_l2cap_raw_con_list {
270 	u_int32_t		 num_connections;
271 	ng_l2cap_node_con_ep	*connections;
272 };
273 #define SIOC_L2CAP_NODE_GET_CON_LIST \
274 	_IOWR('b', NGM_L2CAP_NODE_GET_CON_LIST, \
275 		struct ng_btsocket_l2cap_raw_con_list)
276 
277 /* Get channel list */
278 struct ng_btsocket_l2cap_raw_chan_list {
279 	u_int32_t		 num_channels;
280 	ng_l2cap_node_chan_ep	*channels;
281 };
282 #define SIOC_L2CAP_NODE_GET_CHAN_LIST \
283 	_IOWR('b', NGM_L2CAP_NODE_GET_CHAN_LIST, \
284 		struct ng_btsocket_l2cap_raw_chan_list)
285 
286 /* Get/Set auto disconnect timeout */
287 struct ng_btsocket_l2cap_raw_auto_discon_timo
288 {
289 	ng_l2cap_node_auto_discon_ep	timeout;
290 };
291 #define SIOC_L2CAP_NODE_GET_AUTO_DISCON_TIMO \
292 	_IOWR('b', NGM_L2CAP_NODE_GET_AUTO_DISCON_TIMO, \
293 		struct ng_btsocket_l2cap_raw_auto_discon_timo)
294 #define SIOC_L2CAP_NODE_SET_AUTO_DISCON_TIMO \
295 	_IOWR('b', NGM_L2CAP_NODE_SET_AUTO_DISCON_TIMO, \
296 		struct ng_btsocket_l2cap_raw_auto_discon_timo)
297 
298 /*
299  * XXX FIXME: probably does not belong here
300  * Bluetooth version of struct sockaddr for RFCOMM sockets (STREAM)
301  */
302 
303 struct sockaddr_rfcomm {
304 	u_char		rfcomm_len;	/* total length */
305 	u_char		rfcomm_family;	/* address family */
306 	bdaddr_t	rfcomm_bdaddr;	/* address */
307 	u_int8_t	rfcomm_channel;	/* channel */
308 };
309 
310 /* Flow control information */
311 struct ng_btsocket_rfcomm_fc_info {
312 	u_int8_t	lmodem;		/* modem signals (local) */
313 	u_int8_t	rmodem;		/* modem signals (remote) */
314 	u_int8_t	tx_cred;	/* TX credits */
315 	u_int8_t	rx_cred;	/* RX credits */
316 	u_int8_t	cfc;		/* credit flow control */
317 	u_int8_t	reserved;
318 };
319 
320 /* STREAM RFCOMM socket options */
321 #define SOL_RFCOMM		0x0816	/* socket options level */
322 
323 #define SO_RFCOMM_MTU		1	/* get channel MTU */
324 #define SO_RFCOMM_FC_INFO	2	/* get flow control information */
325 
326 /*
327  * Netgraph node type name and cookie
328  */
329 
330 #define	NG_BTSOCKET_HCI_RAW_NODE_TYPE	"btsock_hci_raw"
331 #define	NG_BTSOCKET_L2CAP_RAW_NODE_TYPE	"btsock_l2c_raw"
332 #define	NG_BTSOCKET_L2CAP_NODE_TYPE	"btsock_l2c"
333 
334 /*
335  * Debug levels
336  */
337 
338 #define NG_BTSOCKET_ALERT_LEVEL	1
339 #define NG_BTSOCKET_ERR_LEVEL	2
340 #define NG_BTSOCKET_WARN_LEVEL	3
341 #define NG_BTSOCKET_INFO_LEVEL	4
342 
343 #endif /* _NETGRAPH_BTSOCKET_H_ */
344 
345