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