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