1 /* 2 * ng_hci_misc.c 3 */ 4 5 /*- 6 * SPDX-License-Identifier: BSD-2-Clause 7 * 8 * Copyright (c) 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_misc.c,v 1.5 2003/09/08 18:57:51 max Exp $ 33 */ 34 35 #include <sys/param.h> 36 #include <sys/systm.h> 37 #include <sys/kernel.h> 38 #include <sys/malloc.h> 39 #include <sys/mbuf.h> 40 #include <sys/queue.h> 41 #include <netgraph/ng_message.h> 42 #include <netgraph/netgraph.h> 43 #include <netgraph/bluetooth/include/ng_bluetooth.h> 44 #include <netgraph/bluetooth/include/ng_hci.h> 45 #include <netgraph/bluetooth/hci/ng_hci_var.h> 46 #include <netgraph/bluetooth/hci/ng_hci_cmds.h> 47 #include <netgraph/bluetooth/hci/ng_hci_evnt.h> 48 #include <netgraph/bluetooth/hci/ng_hci_ulpi.h> 49 #include <netgraph/bluetooth/hci/ng_hci_misc.h> 50 51 /****************************************************************************** 52 ****************************************************************************** 53 ** Utility routines 54 ****************************************************************************** 55 ******************************************************************************/ 56 57 /* 58 * Give packet to RAW hook 59 * Assumes input mbuf is read only. 60 */ 61 62 void 63 ng_hci_mtap(ng_hci_unit_p unit, struct mbuf *m0) 64 { 65 struct mbuf *m = NULL; 66 int error = 0; 67 68 if (unit->raw != NULL && NG_HOOK_IS_VALID(unit->raw)) { 69 m = m_dup(m0, M_NOWAIT); 70 if (m != NULL) 71 NG_SEND_DATA_ONLY(error, unit->raw, m); 72 73 if (error != 0) 74 NG_HCI_INFO( 75 "%s: %s - Could not forward packet, error=%d\n", 76 __func__, NG_NODE_NAME(unit->node), error); 77 } 78 } /* ng_hci_mtap */ 79 80 /* 81 * Send notification to the upper layer's 82 */ 83 84 void 85 ng_hci_node_is_up(node_p node, hook_p hook, void *arg1, int arg2) 86 { 87 ng_hci_unit_p unit = NULL; 88 struct ng_mesg *msg = NULL; 89 ng_hci_node_up_ep *ep = NULL; 90 int error; 91 92 if (node == NULL || NG_NODE_NOT_VALID(node) || 93 hook == NULL || NG_HOOK_NOT_VALID(hook)) 94 return; 95 96 unit = (ng_hci_unit_p) NG_NODE_PRIVATE(node); 97 if ((unit->state & NG_HCI_UNIT_READY) != NG_HCI_UNIT_READY) 98 return; 99 100 if (hook != unit->acl && hook != unit->sco) 101 return; 102 103 NG_MKMESSAGE(msg,NGM_HCI_COOKIE,NGM_HCI_NODE_UP,sizeof(*ep),M_NOWAIT); 104 if (msg != NULL) { 105 ep = (ng_hci_node_up_ep *)(msg->data); 106 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); 110 } else { 111 NG_HCI_BUFF_SCO_SIZE(unit->buffer, ep->pkt_size); 112 NG_HCI_BUFF_SCO_TOTAL(unit->buffer, ep->num_pkts); 113 } 114 115 bcopy(&unit->bdaddr, &ep->bdaddr, sizeof(ep->bdaddr)); 116 117 NG_SEND_MSG_HOOK(error, node, msg, hook, 0); 118 } else 119 error = ENOMEM; 120 121 if (error != 0) 122 NG_HCI_INFO( 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 */ 127 128 /* 129 * Clean unit (helper) 130 */ 131 132 void 133 ng_hci_unit_clean(ng_hci_unit_p unit, int reason) 134 { 135 int size; 136 137 /* Drain command queue */ 138 if (unit->state & NG_HCI_UNIT_COMMAND_PENDING) 139 ng_hci_command_untimeout(unit); 140 141 NG_BT_MBUFQ_DRAIN(&unit->cmdq); 142 NG_HCI_BUFF_CMD_SET(unit->buffer, 1); 143 144 /* Clean up connection list */ 145 while (!LIST_EMPTY(&unit->con_list)) { 146 ng_hci_unit_con_p con = LIST_FIRST(&unit->con_list); 147 148 /* Remove all timeouts (if any) */ 149 if (con->flags & NG_HCI_CON_TIMEOUT_PENDING) 150 ng_hci_con_untimeout(con); 151 152 /* 153 * Notify upper layer protocol and destroy connection 154 * descriptor. Do not really care about the result. 155 */ 156 157 ng_hci_lp_discon_ind(con, reason); 158 ng_hci_free_con(con); 159 } 160 161 NG_HCI_BUFF_ACL_TOTAL(unit->buffer, size); 162 NG_HCI_BUFF_ACL_FREE(unit->buffer, size); 163 164 NG_HCI_BUFF_SCO_TOTAL(unit->buffer, size); 165 NG_HCI_BUFF_SCO_FREE(unit->buffer, size); 166 167 /* Clean up neighbors list */ 168 ng_hci_flush_neighbor_cache(unit); 169 } /* ng_hci_unit_clean */ 170 171 /* 172 * Allocate and link new unit neighbor cache entry 173 */ 174 175 ng_hci_neighbor_p 176 ng_hci_new_neighbor(ng_hci_unit_p unit) 177 { 178 ng_hci_neighbor_p n = NULL; 179 180 n = malloc(sizeof(*n), M_NETGRAPH_HCI, 181 M_NOWAIT | M_ZERO); 182 if (n != NULL) { 183 getmicrotime(&n->updated); 184 LIST_INSERT_HEAD(&unit->neighbors, n, next); 185 } 186 187 return (n); 188 } /* ng_hci_new_neighbor */ 189 190 /* 191 * Free unit neighbor cache entry 192 */ 193 194 void 195 ng_hci_free_neighbor(ng_hci_neighbor_p n) 196 { 197 LIST_REMOVE(n, next); 198 bzero(n, sizeof(*n)); 199 free(n, M_NETGRAPH_HCI); 200 } /* ng_hci_free_neighbor */ 201 202 /* 203 * Flush neighbor cache 204 */ 205 206 void 207 ng_hci_flush_neighbor_cache(ng_hci_unit_p unit) 208 { 209 while (!LIST_EMPTY(&unit->neighbors)) 210 ng_hci_free_neighbor(LIST_FIRST(&unit->neighbors)); 211 } /* ng_hci_flush_neighbor_cache */ 212 213 /* 214 * Lookup unit in neighbor cache 215 */ 216 217 ng_hci_neighbor_p 218 ng_hci_get_neighbor(ng_hci_unit_p unit, bdaddr_p bdaddr,int link_type) 219 { 220 ng_hci_neighbor_p n = NULL; 221 222 for (n = LIST_FIRST(&unit->neighbors); n != NULL; ) { 223 ng_hci_neighbor_p nn = LIST_NEXT(n, next); 224 225 if (!ng_hci_neighbor_stale(n)) { 226 if (n->addrtype == link_type && 227 bcmp(&n->bdaddr, bdaddr, sizeof(*bdaddr)) == 0) 228 break; 229 } else 230 ng_hci_free_neighbor(n); /* remove old entry */ 231 232 n = nn; 233 } 234 235 return (n); 236 } /* ng_hci_get_neighbor */ 237 238 /* 239 * Check if neighbor entry is stale 240 */ 241 242 int 243 ng_hci_neighbor_stale(ng_hci_neighbor_p n) 244 { 245 struct timeval now; 246 247 getmicrotime(&now); 248 249 return (now.tv_sec - n->updated.tv_sec > bluetooth_hci_max_neighbor_age()); 250 } /* ng_hci_neighbor_stale */ 251 252 /* 253 * Allocate and link new connection descriptor 254 */ 255 256 ng_hci_unit_con_p 257 ng_hci_new_con(ng_hci_unit_p unit, int link_type) 258 { 259 ng_hci_unit_con_p con = NULL; 260 int num_pkts; 261 static int fake_con_handle = 0x0f00; 262 263 con = malloc(sizeof(*con), M_NETGRAPH_HCI, 264 M_NOWAIT | M_ZERO); 265 if (con != NULL) { 266 con->unit = unit; 267 con->state = NG_HCI_CON_CLOSED; 268 269 /* 270 * XXX 271 * 272 * Assign fake connection handle to the connection descriptor. 273 * Bluetooth specification marks 0x0f00 - 0x0fff connection 274 * handles as reserved. We need this fake connection handles 275 * for timeouts. Connection handle will be passed as argument 276 * to timeout so when timeout happens we can find the right 277 * connection descriptor. We can not pass pointers, because 278 * timeouts are external (to Netgraph) events and there might 279 * be a race when node/hook goes down and timeout event already 280 * went into node's queue 281 */ 282 283 con->con_handle = fake_con_handle ++; 284 if (fake_con_handle > 0x0fff) 285 fake_con_handle = 0x0f00; 286 287 con->link_type = link_type; 288 289 if (con->link_type != NG_HCI_LINK_SCO) 290 NG_HCI_BUFF_ACL_TOTAL(unit->buffer, num_pkts); 291 else 292 NG_HCI_BUFF_SCO_TOTAL(unit->buffer, num_pkts); 293 294 NG_BT_ITEMQ_INIT(&con->conq, num_pkts); 295 296 ng_callout_init(&con->con_timo); 297 298 LIST_INSERT_HEAD(&unit->con_list, con, next); 299 } 300 301 return (con); 302 } /* ng_hci_new_con */ 303 304 /* 305 * Free connection descriptor 306 */ 307 308 void 309 ng_hci_free_con(ng_hci_unit_con_p con) 310 { 311 LIST_REMOVE(con, next); 312 313 /* 314 * If we have pending packets then assume that Host Controller has 315 * flushed these packets and we can free them too 316 */ 317 318 if (con->link_type != NG_HCI_LINK_SCO) 319 NG_HCI_BUFF_ACL_FREE(con->unit->buffer, con->pending); 320 else 321 NG_HCI_BUFF_SCO_FREE(con->unit->buffer, con->pending); 322 323 NG_BT_ITEMQ_DESTROY(&con->conq); 324 325 bzero(con, sizeof(*con)); 326 free(con, M_NETGRAPH_HCI); 327 } /* ng_hci_free_con */ 328 329 /* 330 * Lookup connection for given unit and connection handle. 331 */ 332 333 ng_hci_unit_con_p 334 ng_hci_con_by_handle(ng_hci_unit_p unit, int con_handle) 335 { 336 ng_hci_unit_con_p con = NULL; 337 338 LIST_FOREACH(con, &unit->con_list, next) 339 if (con->con_handle == con_handle) 340 break; 341 342 return (con); 343 } /* ng_hci_con_by_handle */ 344 345 /* 346 * Lookup connection for given unit, link type and remove unit address 347 */ 348 349 ng_hci_unit_con_p 350 ng_hci_con_by_bdaddr(ng_hci_unit_p unit, bdaddr_p bdaddr, int link_type) 351 { 352 ng_hci_unit_con_p con = NULL; 353 354 LIST_FOREACH(con, &unit->con_list, next) 355 if (con->link_type == link_type && 356 bcmp(&con->bdaddr, bdaddr, sizeof(bdaddr_t)) == 0) 357 break; 358 359 return (con); 360 } /* ng_hci_con_by_bdaddr */ 361 362 /* 363 * Set HCI command timeout 364 * XXX FIXME: check return code from ng_callout 365 */ 366 367 int 368 ng_hci_command_timeout(ng_hci_unit_p unit) 369 { 370 if (unit->state & NG_HCI_UNIT_COMMAND_PENDING) 371 panic( 372 "%s: %s - Duplicated command timeout!\n", __func__, NG_NODE_NAME(unit->node)); 373 374 unit->state |= NG_HCI_UNIT_COMMAND_PENDING; 375 ng_callout(&unit->cmd_timo, unit->node, NULL, 376 bluetooth_hci_command_timeout(), 377 ng_hci_process_command_timeout, NULL, 0); 378 379 return (0); 380 } /* ng_hci_command_timeout */ 381 382 /* 383 * Unset HCI command timeout 384 */ 385 386 int 387 ng_hci_command_untimeout(ng_hci_unit_p unit) 388 { 389 if (!(unit->state & NG_HCI_UNIT_COMMAND_PENDING)) 390 panic( 391 "%s: %s - No command timeout!\n", __func__, NG_NODE_NAME(unit->node)); 392 393 if (ng_uncallout(&unit->cmd_timo, unit->node) < 1) 394 return (ETIMEDOUT); 395 396 unit->state &= ~NG_HCI_UNIT_COMMAND_PENDING; 397 398 return (0); 399 } /* ng_hci_command_untimeout */ 400 401 /* 402 * Set HCI connection timeout 403 * XXX FIXME: check return code from ng_callout 404 */ 405 406 int 407 ng_hci_con_timeout(ng_hci_unit_con_p con) 408 { 409 if (con->flags & NG_HCI_CON_TIMEOUT_PENDING) 410 panic( 411 "%s: %s - Duplicated connection timeout!\n", 412 __func__, NG_NODE_NAME(con->unit->node)); 413 414 con->flags |= NG_HCI_CON_TIMEOUT_PENDING; 415 ng_callout(&con->con_timo, con->unit->node, NULL, 416 bluetooth_hci_connect_timeout(), 417 ng_hci_process_con_timeout, NULL, 418 con->con_handle); 419 420 return (0); 421 } /* ng_hci_con_timeout */ 422 423 /* 424 * Unset HCI connection timeout 425 */ 426 427 int 428 ng_hci_con_untimeout(ng_hci_unit_con_p con) 429 { 430 if (!(con->flags & NG_HCI_CON_TIMEOUT_PENDING)) 431 panic( 432 "%s: %s - No connection timeout!\n", __func__, NG_NODE_NAME(con->unit->node)); 433 434 if (ng_uncallout(&con->con_timo, con->unit->node) < 1) 435 return (ETIMEDOUT); 436 437 con->flags &= ~NG_HCI_CON_TIMEOUT_PENDING; 438 439 return (0); 440 } /* ng_hci_con_untimeout */ 441 442 #if 0 443 /* 444 * Convert numeric error code/reason to a string 445 */ 446 447 char const * const 448 ng_hci_str_error(u_int16_t code) 449 { 450 #define LAST_ERROR_CODE ((sizeof(s)/sizeof(s[0]))-1) 451 static char const * const s[] = { 452 /* 0x00 */ "No error", 453 /* 0x01 */ "Unknown HCI command", 454 /* 0x02 */ "No connection", 455 /* 0x03 */ "Hardware failure", 456 /* 0x04 */ "Page timeout", 457 /* 0x05 */ "Authentication failure", 458 /* 0x06 */ "Key missing", 459 /* 0x07 */ "Memory full", 460 /* 0x08 */ "Connection timeout", 461 /* 0x09 */ "Max number of connections", 462 /* 0x0a */ "Max number of SCO connections to a unit", 463 /* 0x0b */ "ACL connection already exists", 464 /* 0x0c */ "Command disallowed", 465 /* 0x0d */ "Host rejected due to limited resources", 466 /* 0x0e */ "Host rejected due to securiity reasons", 467 /* 0x0f */ "Host rejected due to remote unit is a personal unit", 468 /* 0x10 */ "Host timeout", 469 /* 0x11 */ "Unsupported feature or parameter value", 470 /* 0x12 */ "Invalid HCI command parameter", 471 /* 0x13 */ "Other end terminated connection: User ended connection", 472 /* 0x14 */ "Other end terminated connection: Low resources", 473 /* 0x15 */ "Other end terminated connection: About to power off", 474 /* 0x16 */ "Connection terminated by local host", 475 /* 0x17 */ "Repeated attempts", 476 /* 0x18 */ "Pairing not allowed", 477 /* 0x19 */ "Unknown LMP PDU", 478 /* 0x1a */ "Unsupported remote feature", 479 /* 0x1b */ "SCO offset rejected", 480 /* 0x1c */ "SCO interval rejected", 481 /* 0x1d */ "SCO air mode rejected", 482 /* 0x1e */ "Invalid LMP parameters", 483 /* 0x1f */ "Unspecified error", 484 /* 0x20 */ "Unsupported LMP parameter value", 485 /* 0x21 */ "Role change not allowed", 486 /* 0x22 */ "LMP response timeout", 487 /* 0x23 */ "LMP error transaction collision", 488 /* 0x24 */ "LMP PSU not allowed", 489 /* 0x25 */ "Encryption mode not acceptable", 490 /* 0x26 */ "Unit key used", 491 /* 0x27 */ "QoS is not supported", 492 /* 0x28 */ "Instant passed", 493 /* 0x29 */ "Pairing with unit key not supported", 494 /* 0x2a */ "Different Transaction Collision", 495 /* 0x2b */ "Unknown error (Reserved for future use)", 496 /* 0x2c */ "QoS Unacceptable Parameter", 497 /* 0x2d */ "QoS Rejected", 498 /* 0x2e */ "Channel Classification Not Supported", 499 /* 0x2f */ "Insufficient Security", 500 /* 0x30 */ "Parameter Out Of Mandatory Range", 501 /* 0x31 */ "Unknown error (Reserved for future use)", 502 /* 0x32 */ "Role Switch Pending", 503 /* 0x33 */ "Unknown error (Reserved for future use)", 504 /* 0x34 */ "Reserved Slot Violation", 505 /* 0x35 */ "Role Switch Failed", 506 /* 0x36 */ "Extended Inquiry Response Too Large", 507 /* 0x37 */ "Secure Simple Pairing Not Supported By Host", 508 /* 0x38 */ "Host Busy - Pairing", 509 /* 0x39 */ "Connection Rejected due to No Suitable Channel Found", 510 /* 0x3a */ "Controller Busy", 511 /* 0x3b */ "Unacceptable Connection Parameters", 512 /* 0x3c */ "Advertising Timeout", 513 /* 0x3d */ "Connection Terminated due to MIC Failure", 514 /* 0x3e */ "Connection Failed to be Established / Synchronization Timeout", 515 /* 0x3f */ "MAC Connection Failed", 516 /* 0x40 */ "Coarse Clock Adjustment Rejected but Will Try to Adjust Using Clock Dragging", 517 /* 0x41 */ "Type0 Submap Not Defined", 518 /* 0x42 */ "Unknown Advertising Identifier", 519 /* 0x43 */ "Limit Reached", 520 /* 0x44 */ "Operation Cancelled by Host", 521 /* 0x45 */ "Packet Too Long", 522 /* SHOULD ALWAYS BE LAST */ "Unknown error" 523 }; 524 525 return ((code >= LAST_ERROR_CODE)? s[LAST_ERROR_CODE] : s[code]); 526 } /* ng_hci_str_error */ 527 #endif 528