6 * Copyright (c) Maksim Yevmenkin <m_evmenkin@yahoo.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
30 * $Id: ng_hci_misc.c,v 1.5 2003/09/08 18:57:51 max Exp $
31 * $FreeBSD: src/sys/netgraph/bluetooth/hci/ng_hci_misc.c,v 1.10 2005/01/07 01:45:43 imp Exp $
32 * $DragonFly: src/sys/netgraph7/bluetooth/hci/ng_hci_misc.c,v 1.2 2008/06/26 23:05:40 dillon Exp $
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/malloc.h>
40 #include <sys/queue.h>
41 #include "ng_message.h"
43 #include "bluetooth/include/ng_bluetooth.h"
44 #include "bluetooth/include/ng_hci.h"
45 #include "bluetooth/hci/ng_hci_var.h"
46 #include "bluetooth/hci/ng_hci_cmds.h"
47 #include "bluetooth/hci/ng_hci_evnt.h"
48 #include "bluetooth/hci/ng_hci_ulpi.h"
49 #include "bluetooth/hci/ng_hci_misc.h"
51 /******************************************************************************
52 ******************************************************************************
54 ******************************************************************************
55 ******************************************************************************/
58 * Give packet to RAW hook
59 * Assumes input mbuf is read only.
63 ng_hci_mtap(ng_hci_unit_p unit, struct mbuf *m0)
65 struct mbuf *m = NULL;
68 if (unit->raw != NULL && NG_HOOK_IS_VALID(unit->raw)) {
69 m = m_dup(m0, MB_DONTWAIT);
71 NG_SEND_DATA_ONLY(error, unit->raw, m);
75 "%s: %s - Could not forward packet, error=%d\n",
76 __func__, NG_NODE_NAME(unit->node), error);
81 * Send notification to the upper layer's
85 ng_hci_node_is_up(node_p node, hook_p hook, void *arg1, int arg2)
87 ng_hci_unit_p unit = NULL;
88 struct ng_mesg *msg = NULL;
89 ng_hci_node_up_ep *ep = NULL;
92 if (node == NULL || NG_NODE_NOT_VALID(node) ||
93 hook == NULL || NG_HOOK_NOT_VALID(hook))
96 unit = (ng_hci_unit_p) NG_NODE_PRIVATE(node);
97 if ((unit->state & NG_HCI_UNIT_READY) != NG_HCI_UNIT_READY)
100 if (hook != unit->acl && hook != unit->sco)
103 NG_MKMESSAGE(msg,NGM_HCI_COOKIE,NGM_HCI_NODE_UP,sizeof(*ep),M_WAITOK | M_NULLOK);
105 ep = (ng_hci_node_up_ep *)(msg->data);
107 if (hook == unit->acl) {
108 NG_HCI_BUFF_ACL_SIZE(unit->buffer, ep->pkt_size);
109 NG_HCI_BUFF_ACL_TOTAL(unit->buffer, ep->num_pkts);
111 NG_HCI_BUFF_SCO_SIZE(unit->buffer, ep->pkt_size);
112 NG_HCI_BUFF_SCO_TOTAL(unit->buffer, ep->num_pkts);
115 bcopy(&unit->bdaddr, &ep->bdaddr, sizeof(ep->bdaddr));
117 NG_SEND_MSG_HOOK(error, node, msg, hook, 0);
123 "%s: %s - failed to send NODE_UP message to hook \"%s\", error=%d\n",
124 __func__, NG_NODE_NAME(unit->node),
125 NG_HOOK_NAME(hook), error);
126 } /* ng_hci_node_is_up */
129 * Clean unit (helper)
133 ng_hci_unit_clean(ng_hci_unit_p unit, int reason)
137 /* Drain command queue */
138 if (unit->state & NG_HCI_UNIT_COMMAND_PENDING)
139 ng_hci_command_untimeout(unit);
141 NG_BT_MBUFQ_DRAIN(&unit->cmdq);
142 NG_HCI_BUFF_CMD_SET(unit->buffer, 1);
144 /* Clean up connection list */
145 while (!LIST_EMPTY(&unit->con_list)) {
146 ng_hci_unit_con_p con = LIST_FIRST(&unit->con_list);
148 /* Remove all timeouts (if any) */
149 if (con->flags & NG_HCI_CON_TIMEOUT_PENDING)
150 ng_hci_con_untimeout(con);
153 * Notify upper layer protocol and destroy connection
154 * descriptor. Do not really care about the result.
157 ng_hci_lp_discon_ind(con, reason);
158 ng_hci_free_con(con);
161 NG_HCI_BUFF_ACL_TOTAL(unit->buffer, size);
162 NG_HCI_BUFF_ACL_FREE(unit->buffer, size);
164 NG_HCI_BUFF_SCO_TOTAL(unit->buffer, size);
165 NG_HCI_BUFF_SCO_FREE(unit->buffer, size);
167 /* Clean up neighbors list */
168 ng_hci_flush_neighbor_cache(unit);
169 } /* ng_hci_unit_clean */
172 * Allocate and link new unit neighbor cache entry
176 ng_hci_new_neighbor(ng_hci_unit_p unit)
178 ng_hci_neighbor_p n = NULL;
180 MALLOC(n, ng_hci_neighbor_p, sizeof(*n), M_NETGRAPH_HCI,
181 M_WAITOK | M_NULLOK | M_ZERO);
183 getmicrotime(&n->updated);
184 LIST_INSERT_HEAD(&unit->neighbors, n, next);
188 } /* ng_hci_new_neighbor */
191 * Free unit neighbor cache entry
195 ng_hci_free_neighbor(ng_hci_neighbor_p n)
197 LIST_REMOVE(n, next);
198 bzero(n, sizeof(*n));
199 FREE(n, M_NETGRAPH_HCI);
200 } /* ng_hci_free_neighbor */
203 * Flush neighbor cache
207 ng_hci_flush_neighbor_cache(ng_hci_unit_p unit)
209 while (!LIST_EMPTY(&unit->neighbors))
210 ng_hci_free_neighbor(LIST_FIRST(&unit->neighbors));
211 } /* ng_hci_flush_neighbor_cache */
214 * Lookup unit in neighbor cache
218 ng_hci_get_neighbor(ng_hci_unit_p unit, bdaddr_p bdaddr)
220 ng_hci_neighbor_p n = NULL;
222 for (n = LIST_FIRST(&unit->neighbors); n != NULL; ) {
223 ng_hci_neighbor_p nn = LIST_NEXT(n, next);
225 if (!ng_hci_neighbor_stale(n)) {
226 if (bcmp(&n->bdaddr, bdaddr, sizeof(*bdaddr)) == 0)
229 ng_hci_free_neighbor(n); /* remove old entry */
235 } /* ng_hci_get_neighbor */
238 * Check if neighbor entry is stale
242 ng_hci_neighbor_stale(ng_hci_neighbor_p n)
248 return (now.tv_sec - n->updated.tv_sec > bluetooth_hci_max_neighbor_age());
249 } /* ng_hci_neighbor_stale */
252 * Allocate and link new connection descriptor
256 ng_hci_new_con(ng_hci_unit_p unit, int link_type)
258 ng_hci_unit_con_p con = NULL;
260 static int fake_con_handle = 0x0f00;
262 MALLOC(con, ng_hci_unit_con_p, sizeof(*con), M_NETGRAPH_HCI,
263 M_WAITOK | M_NULLOK | M_ZERO);
266 con->state = NG_HCI_CON_CLOSED;
271 * Assign fake connection handle to the connection descriptor.
272 * Bluetooth specification marks 0x0f00 - 0x0fff connection
273 * handles as reserved. We need this fake connection handles
274 * for timeouts. Connection handle will be passed as argument
275 * to timeout so when timeout happens we can find the right
276 * connection descriptor. We can not pass pointers, because
277 * timeouts are external (to Netgraph) events and there might
278 * be a race when node/hook goes down and timeout event already
279 * went into node's queue
282 con->con_handle = fake_con_handle ++;
283 if (fake_con_handle > 0x0fff)
284 fake_con_handle = 0x0f00;
286 con->link_type = link_type;
288 if (con->link_type == NG_HCI_LINK_ACL)
289 NG_HCI_BUFF_ACL_TOTAL(unit->buffer, num_pkts);
291 NG_HCI_BUFF_SCO_TOTAL(unit->buffer, num_pkts);
293 NG_BT_ITEMQ_INIT(&con->conq, num_pkts);
295 ng_callout_init(&con->con_timo);
297 LIST_INSERT_HEAD(&unit->con_list, con, next);
301 } /* ng_hci_new_con */
304 * Free connection descriptor
308 ng_hci_free_con(ng_hci_unit_con_p con)
310 LIST_REMOVE(con, next);
313 * If we have pending packets then assume that Host Controller has
314 * flushed these packets and we can free them too
317 if (con->link_type == NG_HCI_LINK_ACL)
318 NG_HCI_BUFF_ACL_FREE(con->unit->buffer, con->pending);
320 NG_HCI_BUFF_SCO_FREE(con->unit->buffer, con->pending);
322 NG_BT_ITEMQ_DESTROY(&con->conq);
324 bzero(con, sizeof(*con));
325 FREE(con, M_NETGRAPH_HCI);
326 } /* ng_hci_free_con */
329 * Lookup connection for given unit and connection handle.
333 ng_hci_con_by_handle(ng_hci_unit_p unit, int con_handle)
335 ng_hci_unit_con_p con = NULL;
337 LIST_FOREACH(con, &unit->con_list, next)
338 if (con->con_handle == con_handle)
342 } /* ng_hci_con_by_handle */
345 * Lookup connection for given unit, link type and remove unit address
349 ng_hci_con_by_bdaddr(ng_hci_unit_p unit, bdaddr_p bdaddr, int link_type)
351 ng_hci_unit_con_p con = NULL;
353 LIST_FOREACH(con, &unit->con_list, next)
354 if (con->link_type == link_type &&
355 bcmp(&con->bdaddr, bdaddr, sizeof(bdaddr_t)) == 0)
359 } /* ng_hci_con_by_bdaddr */
362 * Set HCI command timeout
363 * XXX FIXME: check return code from ng_callout
367 ng_hci_command_timeout(ng_hci_unit_p unit)
369 if (unit->state & NG_HCI_UNIT_COMMAND_PENDING)
371 "%s: %s - Duplicated command timeout!\n", __func__, NG_NODE_NAME(unit->node));
373 unit->state |= NG_HCI_UNIT_COMMAND_PENDING;
374 ng_callout(&unit->cmd_timo, unit->node, NULL,
375 bluetooth_hci_command_timeout(),
376 ng_hci_process_command_timeout, NULL, 0);
379 } /* ng_hci_command_timeout */
382 * Unset HCI command timeout
386 ng_hci_command_untimeout(ng_hci_unit_p unit)
388 if (!(unit->state & NG_HCI_UNIT_COMMAND_PENDING))
390 "%s: %s - No command timeout!\n", __func__, NG_NODE_NAME(unit->node));
392 if (ng_uncallout(&unit->cmd_timo, unit->node) == 0)
395 unit->state &= ~NG_HCI_UNIT_COMMAND_PENDING;
398 } /* ng_hci_command_untimeout */
401 * Set HCI connection timeout
402 * XXX FIXME: check return code from ng_callout
406 ng_hci_con_timeout(ng_hci_unit_con_p con)
408 if (con->flags & NG_HCI_CON_TIMEOUT_PENDING)
410 "%s: %s - Duplicated connection timeout!\n",
411 __func__, NG_NODE_NAME(con->unit->node));
413 con->flags |= NG_HCI_CON_TIMEOUT_PENDING;
414 ng_callout(&con->con_timo, con->unit->node, NULL,
415 bluetooth_hci_connect_timeout(),
416 ng_hci_process_con_timeout, NULL,
420 } /* ng_hci_con_timeout */
423 * Unset HCI connection timeout
427 ng_hci_con_untimeout(ng_hci_unit_con_p con)
429 if (!(con->flags & NG_HCI_CON_TIMEOUT_PENDING))
431 "%s: %s - No connection timeout!\n", __func__, NG_NODE_NAME(con->unit->node));
433 if (ng_uncallout(&con->con_timo, con->unit->node) == 0)
436 con->flags &= ~NG_HCI_CON_TIMEOUT_PENDING;
439 } /* ng_hci_con_untimeout */
443 * Convert numeric error code/reason to a string
447 ng_hci_str_error(u_int16_t code)
449 #define LAST_ERROR_CODE ((sizeof(s)/sizeof(s[0]))-1)
450 static char const * const s[] = {
451 /* 0x00 */ "No error",
452 /* 0x01 */ "Unknown HCI command",
453 /* 0x02 */ "No connection",
454 /* 0x03 */ "Hardware failure",
455 /* 0x04 */ "Page timeout",
456 /* 0x05 */ "Authentication failure",
457 /* 0x06 */ "Key missing",
458 /* 0x07 */ "Memory full",
459 /* 0x08 */ "Connection timeout",
460 /* 0x09 */ "Max number of connections",
461 /* 0x0a */ "Max number of SCO connections to a unit",
462 /* 0x0b */ "ACL connection already exists",
463 /* 0x0c */ "Command disallowed",
464 /* 0x0d */ "Host rejected due to limited resources",
465 /* 0x0e */ "Host rejected due to securiity reasons",
466 /* 0x0f */ "Host rejected due to remote unit is a personal unit",
467 /* 0x10 */ "Host timeout",
468 /* 0x11 */ "Unsupported feature or parameter value",
469 /* 0x12 */ "Invalid HCI command parameter",
470 /* 0x13 */ "Other end terminated connection: User ended connection",
471 /* 0x14 */ "Other end terminated connection: Low resources",
472 /* 0x15 */ "Other end terminated connection: About to power off",
473 /* 0x16 */ "Connection terminated by local host",
474 /* 0x17 */ "Repeated attempts",
475 /* 0x18 */ "Pairing not allowed",
476 /* 0x19 */ "Unknown LMP PDU",
477 /* 0x1a */ "Unsupported remote feature",
478 /* 0x1b */ "SCO offset rejected",
479 /* 0x1c */ "SCO interval rejected",
480 /* 0x1d */ "SCO air mode rejected",
481 /* 0x1e */ "Invalid LMP parameters",
482 /* 0x1f */ "Unspecified error",
483 /* 0x20 */ "Unsupported LMP parameter value",
484 /* 0x21 */ "Role change not allowed",
485 /* 0x22 */ "LMP response timeout",
486 /* 0x23 */ "LMP error transaction collision",
487 /* 0x24 */ "LMP PSU not allowed",
488 /* 0x25 */ "Encryption mode not acceptable",
489 /* 0x26 */ "Unit key used",
490 /* 0x27 */ "QoS is not supported",
491 /* 0x28 */ "Instant passed",
492 /* 0x29 */ "Paring with unit key not supported",
493 /* SHOULD ALWAYS BE LAST */ "Unknown error"
496 return ((code >= LAST_ERROR_CODE)? s[LAST_ERROR_CODE] : s[code]);
497 } /* ng_hci_str_error */