xref: /freebsd/sys/netgraph/bluetooth/hci/ng_hci_var.h (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1 /*
2  * ng_hci_var.h
3  */
4 
5 /*-
6  * SPDX-License-Identifier: BSD-2-Clause
7  *
8  * Copyright (c) 2001 Maksim Yevmenkin <m_evmenkin@yahoo.com>
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $Id: ng_hci_var.h,v 1.3 2003/04/26 22:35:21 max Exp $
33  */
34 
35 #ifndef _NETGRAPH_HCI_VAR_H_
36 #define _NETGRAPH_HCI_VAR_H_
37 
38 /* MALLOC decalation */
39 #ifdef NG_SEPARATE_MALLOC
40 MALLOC_DECLARE(M_NETGRAPH_HCI);
41 #else
42 #define M_NETGRAPH_HCI M_NETGRAPH
43 #endif /* NG_SEPARATE_MALLOC */
44 
45 /* Debug */
46 #define	NG_HCI_ALERT	if (unit->debug >= NG_HCI_ALERT_LEVEL) printf
47 #define	NG_HCI_ERR	if (unit->debug >= NG_HCI_ERR_LEVEL)   printf
48 #define	NG_HCI_WARN	if (unit->debug >= NG_HCI_WARN_LEVEL)  printf
49 #define	NG_HCI_INFO	if (unit->debug >= NG_HCI_INFO_LEVEL)  printf
50 
51 /* Wrapper around m_pullup */
52 #define NG_HCI_M_PULLUP(m, s) 				\
53 	do { 						\
54 		if ((m)->m_len < (s)) 			\
55 			(m) = m_pullup((m), (s)); 	\
56 		if ((m) == NULL) 			\
57 			NG_HCI_ALERT("%s: %s - m_pullup(%zd) failed\n", \
58 				__func__, NG_NODE_NAME(unit->node), (s)); \
59 	} while (0)
60 
61 /*
62  * Unit hardware buffer descriptor
63  */
64 
65 typedef struct ng_hci_unit_buff {
66 	u_int8_t			cmd_free; /* space available (cmds) */
67 
68 	u_int8_t			sco_size; /* max. size of one packet */
69 	u_int16_t			sco_pkts; /* size of buffer (packets) */
70 	u_int16_t			sco_free; /* space available (packets)*/
71 
72 	u_int16_t			acl_size; /* max. size of one packet */
73 	u_int16_t			acl_pkts; /* size of buffer (packets) */
74 	u_int16_t			acl_free; /* space available (packets)*/
75 } ng_hci_unit_buff_t;
76 
77 /*
78  * These macro's must be used everywhere in the code. So if extra locking
79  * is required later, it can be added without much troubles.
80  */
81 
82 #define NG_HCI_BUFF_CMD_SET(b, v)	(b).cmd_free = (v)
83 #define NG_HCI_BUFF_CMD_GET(b, v)	(v) = (b).cmd_free
84 #define NG_HCI_BUFF_CMD_USE(b, v)	(b).cmd_free -= (v)
85 
86 #define NG_HCI_BUFF_ACL_USE(b, v)	(b).acl_free -= (v)
87 #define NG_HCI_BUFF_ACL_FREE(b, v) 			\
88 	do { 						\
89 		(b).acl_free += (v);			\
90 		if ((b).acl_free > (b).acl_pkts) 	\
91 			(b).acl_free = (b).acl_pkts; 	\
92 	} while (0)
93 #define NG_HCI_BUFF_ACL_AVAIL(b, v)	(v) = (b).acl_free
94 #define NG_HCI_BUFF_ACL_TOTAL(b, v)	(v) = (b).acl_pkts
95 #define NG_HCI_BUFF_ACL_SIZE(b, v)	(v) = (b).acl_size
96 #define NG_HCI_BUFF_ACL_SET(b, n, s, f) 		\
97 	do { 						\
98 		(b).acl_free = (f); 			\
99 		(b).acl_size = (s); 			\
100 		(b).acl_pkts = (n); 			\
101 	} while (0)
102 
103 #define NG_HCI_BUFF_SCO_USE(b, v)	(b).sco_free -= (v)
104 #define NG_HCI_BUFF_SCO_FREE(b, v) 			\
105 	do { 						\
106 		(b).sco_free += (v); 			\
107 		if ((b).sco_free > (b).sco_pkts) 	\
108 			(b).sco_free = (b).sco_pkts; 	\
109 	} while (0)
110 #define NG_HCI_BUFF_SCO_AVAIL(b, v)	(v) = (b).sco_free
111 #define NG_HCI_BUFF_SCO_TOTAL(b, v)	(v) = (b).sco_pkts
112 #define NG_HCI_BUFF_SCO_SIZE(b, v)	(v) = (b).sco_size
113 #define NG_HCI_BUFF_SCO_SET(b, n, s, f) 		\
114 	do { 						\
115 		(b).sco_free = (f); 			\
116 		(b).sco_size = (s); 			\
117 		(b).sco_pkts = (n); 			\
118 	} while (0)
119 
120 /*
121  * Unit (Node private)
122  */
123 
124 struct ng_hci_unit_con;
125 struct ng_hci_neighbor;
126 
127 typedef struct ng_hci_unit {
128 	node_p				node;           /* node ptr */
129 
130 	ng_hci_node_debug_ep		debug;          /* debug level */
131 	ng_hci_node_state_ep		state;          /* unit state */
132 
133 	bdaddr_t			bdaddr;         /* unit address */
134 	u_int8_t			features[NG_HCI_FEATURES_SIZE];
135 					                /* LMP features */
136 
137 	ng_hci_node_link_policy_mask_ep	link_policy_mask; /* link policy mask */
138 	ng_hci_node_packet_mask_ep	packet_mask;	/* packet mask */
139 	ng_hci_node_role_switch_ep	role_switch;	/* role switch */
140 
141 	ng_hci_node_stat_ep		stat;           /* statistic */
142 #define NG_HCI_STAT_CMD_SENT(s)		(s).cmd_sent ++
143 #define NG_HCI_STAT_EVNT_RECV(s)	(s).evnt_recv ++
144 #define NG_HCI_STAT_ACL_SENT(s, n)	(s).acl_sent += (n)
145 #define NG_HCI_STAT_ACL_RECV(s)		(s).acl_recv ++
146 #define NG_HCI_STAT_SCO_SENT(s, n)	(s).sco_sent += (n)
147 #define NG_HCI_STAT_SCO_RECV(s)		(s).sco_recv ++
148 #define NG_HCI_STAT_BYTES_SENT(s, b)	(s).bytes_sent += (b)
149 #define NG_HCI_STAT_BYTES_RECV(s, b)	(s).bytes_recv += (b)
150 #define NG_HCI_STAT_RESET(s)		bzero(&(s), sizeof((s)))
151 
152 	ng_hci_unit_buff_t		buffer;         /* buffer info */
153 
154 	struct callout			cmd_timo;       /* command timeout */
155 	ng_bt_mbufq_t			cmdq;           /* command queue */
156 #define NG_HCI_CMD_QUEUE_LEN		12		/* max. size of cmd q */
157 
158 	hook_p				drv;            /* driver hook */
159 	hook_p				acl;            /* upstream hook */
160 	hook_p				sco;            /* upstream hook */
161 	hook_p				raw;            /* upstream hook */
162 
163 	LIST_HEAD(, ng_hci_unit_con)	con_list;       /* connections */
164 	LIST_HEAD(, ng_hci_neighbor)	neighbors;      /* unit neighbors */
165 } ng_hci_unit_t;
166 typedef ng_hci_unit_t *			ng_hci_unit_p;
167 
168 /*
169  * Unit connection descriptor
170  */
171 
172 typedef struct ng_hci_unit_con {
173 	ng_hci_unit_p			unit;            /* pointer back */
174 
175 	u_int16_t			state;           /* con. state */
176 	u_int16_t			flags;           /* con. flags */
177 #define NG_HCI_CON_TIMEOUT_PENDING		(1 << 0)
178 #define NG_HCI_CON_NOTIFY_ACL			(1 << 1)
179 #define NG_HCI_CON_NOTIFY_SCO			(1 << 2)
180 
181 	bdaddr_t			bdaddr;          /* remote address */
182 	u_int16_t			con_handle;      /* con. handle */
183 
184 	u_int8_t			link_type;       /* ACL or SCO */
185 	u_int8_t			encryption_mode; /* none, p2p, ... */
186 	u_int8_t			mode;            /* ACTIVE, HOLD ... */
187 	u_int8_t			role;            /* MASTER/SLAVE */
188 
189 	struct callout			con_timo;        /* con. timeout */
190 
191 	int				pending;         /* # of data pkts */
192 	ng_bt_itemq_t			conq;            /* con. queue */
193 
194 	LIST_ENTRY(ng_hci_unit_con)	next;            /* next */
195 } ng_hci_unit_con_t;
196 typedef ng_hci_unit_con_t *		ng_hci_unit_con_p;
197 
198 /*
199  * Unit's neighbor descriptor.
200  * Neighbor is a remote unit that responded to our inquiry.
201  */
202 
203 typedef struct ng_hci_neighbor {
204 	struct timeval			updated;	/* entry was updated */
205 
206 	bdaddr_t			bdaddr;         /* address */
207 	u_int8_t			features[NG_HCI_FEATURES_SIZE];
208 					                /* LMP features */
209 	u_int8_t 			addrtype;	/*Address Type*/
210 
211 	u_int8_t			page_scan_rep_mode; /* PS rep. mode */
212 	u_int8_t			page_scan_mode; /* page scan mode */
213 	u_int16_t			clock_offset;   /* clock offset */
214 	uint8_t				extinq_size;
215 	uint8_t				extinq_data[NG_HCI_EXTINQ_MAX];
216 	LIST_ENTRY(ng_hci_neighbor)	next;
217 } ng_hci_neighbor_t;
218 typedef ng_hci_neighbor_t *		ng_hci_neighbor_p;
219 
220 #endif /* ndef _NETGRAPH_HCI_VAR_H_ */
221