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