granicus.if.org Git - esp-idf/blob - components/bt/bluedroid/stack/rfcomm/rfc_utils.c

   1 /******************************************************************************
   2  *
   3  *  Copyright (C) 1999-2012 Broadcom Corporation
   4  *
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at:
   8  *
   9  *  http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  ******************************************************************************/
  18
  19 /*****************************************************************************
  20  *
  21  *  This file contains collection of utility functions used the RFCOMM unit
  22  *
  23  *****************************************************************************/
  24
  25 #include "common/bt_target.h"
  26
  27 #include "stack/btm_api.h"
  28 #include "btm_int.h"
  29 #include "stack/rfcdefs.h"
  30 #include "stack/port_api.h"
  31 #include "stack/port_ext.h"
  32 #include "port_int.h"
  33 #include "rfc_int.h"
  34 #include "stack/btu.h"
  35 #include "common/bt_defs.h"
  36
  37 #include "osi/allocator.h"
  38 #include "osi/mutex.h"
  39
  40 #include <string.h>
  41
  42 #if (defined RFCOMM_INCLUDED && RFCOMM_INCLUDED == TRUE)
  43 /*******************************************************************************
  44 **
  45 ** Function         rfc_calc_fcs
  46 **
  47 ** Description      Reversed CRC Table , 8-bit, poly=0x07
  48 **                  (GSM 07.10 TS 101 369 V6.3.0)
  49 *******************************************************************************/
  50 static const UINT8 rfc_crctable[] = {
  51     0x00, 0x91, 0xE3, 0x72, 0x07, 0x96, 0xE4, 0x75,  0x0E, 0x9F, 0xED, 0x7C, 0x09, 0x98, 0xEA, 0x7B,
  52     0x1C, 0x8D, 0xFF, 0x6E, 0x1B, 0x8A, 0xF8, 0x69,  0x12, 0x83, 0xF1, 0x60, 0x15, 0x84, 0xF6, 0x67,
  53     0x38, 0xA9, 0xDB, 0x4A, 0x3F, 0xAE, 0xDC, 0x4D,  0x36, 0xA7, 0xD5, 0x44, 0x31, 0xA0, 0xD2, 0x43,
  54     0x24, 0xB5, 0xC7, 0x56, 0x23, 0xB2, 0xC0, 0x51,  0x2A, 0xBB, 0xC9, 0x58, 0x2D, 0xBC, 0xCE, 0x5F,
  55
  56     0x70, 0xE1, 0x93, 0x02, 0x77, 0xE6, 0x94, 0x05,  0x7E, 0xEF, 0x9D, 0x0C, 0x79, 0xE8, 0x9A, 0x0B,
  57     0x6C, 0xFD, 0x8F, 0x1E, 0x6B, 0xFA, 0x88, 0x19,  0x62, 0xF3, 0x81, 0x10, 0x65, 0xF4, 0x86, 0x17,
  58     0x48, 0xD9, 0xAB, 0x3A, 0x4F, 0xDE, 0xAC, 0x3D,  0x46, 0xD7, 0xA5, 0x34, 0x41, 0xD0, 0xA2, 0x33,
  59     0x54, 0xC5, 0xB7, 0x26, 0x53, 0xC2, 0xB0, 0x21,  0x5A, 0xCB, 0xB9, 0x28, 0x5D, 0xCC, 0xBE, 0x2F,
  60
  61     0xE0, 0x71, 0x03, 0x92, 0xE7, 0x76, 0x04, 0x95,  0xEE, 0x7F, 0x0D, 0x9C, 0xE9, 0x78, 0x0A, 0x9B,
  62     0xFC, 0x6D, 0x1F, 0x8E, 0xFB, 0x6A, 0x18, 0x89,  0xF2, 0x63, 0x11, 0x80, 0xF5, 0x64, 0x16, 0x87,
  63     0xD8, 0x49, 0x3B, 0xAA, 0xDF, 0x4E, 0x3C, 0xAD,  0xD6, 0x47, 0x35, 0xA4, 0xD1, 0x40, 0x32, 0xA3,
  64     0xC4, 0x55, 0x27, 0xB6, 0xC3, 0x52, 0x20, 0xB1,  0xCA, 0x5B, 0x29, 0xB8, 0xCD, 0x5C, 0x2E, 0xBF,
  65
  66     0x90, 0x01, 0x73, 0xE2, 0x97, 0x06, 0x74, 0xE5,  0x9E, 0x0F, 0x7D, 0xEC, 0x99, 0x08, 0x7A, 0xEB,
  67     0x8C, 0x1D, 0x6F, 0xFE, 0x8B, 0x1A, 0x68, 0xF9,  0x82, 0x13, 0x61, 0xF0, 0x85, 0x14, 0x66, 0xF7,
  68     0xA8, 0x39, 0x4B, 0xDA, 0xAF, 0x3E, 0x4C, 0xDD,  0xA6, 0x37, 0x45, 0xD4, 0xA1, 0x30, 0x42, 0xD3,
  69     0xB4, 0x25, 0x57, 0xC6, 0xB3, 0x22, 0x50, 0xC1,  0xBA, 0x2B, 0x59, 0xC8, 0xBD, 0x2C, 0x5E, 0xCF
  70 };
  71
  72
  73 /*******************************************************************************
  74 **
  75 ** Function         rfc_calc_fcs
  76 **
  77 ** Description      This function calculate FCS for the RFCOMM frame
  78 **                  (GSM 07.10 TS 101 369 V6.3.0)
  79 **
  80 ** Input            len - number of bytes in the message
  81 **                  p   - points to message
  82 **
  83 *******************************************************************************/
  84 UINT8 rfc_calc_fcs (UINT16 len, UINT8 *p)
  85 {
  86     UINT8  fcs = 0xFF;
  87
  88     while (len--) {
  89         fcs = rfc_crctable[fcs ^ *p++];
  90     }
  91
  92     /* Ones compliment */
  93     return (0xFF - fcs);
  94 }
  95
  96
  97 /*******************************************************************************
  98 **
  99 ** Function         rfc_check_fcs
 100 **
 101 ** Description      This function checks FCS for the RFCOMM frame
 102 **                  (GSM 07.10 TS 101 369 V6.3.0)
 103 **
 104 ** Input            len          - number of bytes in the message
 105 **                  p            - points to message
 106 **                  received_fcs - received FCS
 107 **
 108 *******************************************************************************/
 109 BOOLEAN rfc_check_fcs (UINT16 len, UINT8 *p, UINT8 received_fcs)
 110 {
 111     UINT8  fcs = 0xFF;
 112
 113     while (len--) {
 114         fcs = rfc_crctable[fcs ^ *p++];
 115     }
 116
 117     /* Ones compliment */
 118     fcs = rfc_crctable[fcs ^ received_fcs];
 119
 120     /*0xCF is the reversed order of 11110011.*/
 121     return (fcs == 0xCF);
 122 }
 123
 124
 125 /*******************************************************************************
 126 **
 127 ** Function         rfc_alloc_multiplexer_channel
 128 **
 129 ** Description      This function returns existing or new control block for
 130 **                  the BD_ADDR.
 131 **
 132 *******************************************************************************/
 133 tRFC_MCB *rfc_alloc_multiplexer_channel (BD_ADDR bd_addr, BOOLEAN is_initiator)
 134 {
 135     int i, j;
 136     tRFC_MCB *p_mcb = NULL;
 137     RFCOMM_TRACE_DEBUG("rfc_alloc_multiplexer_channel: bd_addr:%02x:%02x:%02x:%02x:%02x:%02x",
 138                        bd_addr[0], bd_addr[1], bd_addr[2], bd_addr[3], bd_addr[4], bd_addr[5]);
 139     RFCOMM_TRACE_DEBUG("rfc_alloc_multiplexer_channel:is_initiator:%d", is_initiator);
 140
 141     for (i = 0; i < MAX_BD_CONNECTIONS; i++) {
 142         RFCOMM_TRACE_DEBUG("rfc_alloc_multiplexer_channel rfc_cb.port.rfc_mcb[%d].state:%d",
 143                            i, rfc_cb.port.rfc_mcb[i].state);
 144         RFCOMM_TRACE_DEBUG("(rfc_cb.port.rfc_mcb[i].bd_addr:%02x:%02x:%02x:%02x:%02x:%02x",
 145                            rfc_cb.port.rfc_mcb[i].bd_addr[0], rfc_cb.port.rfc_mcb[i].bd_addr[1],
 146                            rfc_cb.port.rfc_mcb[i].bd_addr[2], rfc_cb.port.rfc_mcb[i].bd_addr[3],
 147                            rfc_cb.port.rfc_mcb[i].bd_addr[4], rfc_cb.port.rfc_mcb[i].bd_addr[5]);
 148
 149         if ((rfc_cb.port.rfc_mcb[i].state != RFC_MX_STATE_IDLE)
 150                 && (!memcmp (rfc_cb.port.rfc_mcb[i].bd_addr, bd_addr, BD_ADDR_LEN))) {
 151             /* Multiplexer channel found do not change anything */
 152             /* If there was an inactivity timer running stop it now */
 153             if (rfc_cb.port.rfc_mcb[i].state == RFC_MX_STATE_CONNECTED) {
 154                 rfc_timer_stop (&rfc_cb.port.rfc_mcb[i]);
 155             }
 156             RFCOMM_TRACE_DEBUG("rfc_alloc_multiplexer_channel:is_initiator:%d, found, state:%d, p_mcb:%p",
 157                                is_initiator, rfc_cb.port.rfc_mcb[i].state, &rfc_cb.port.rfc_mcb[i]);
 158             return (&rfc_cb.port.rfc_mcb[i]);
 159         }
 160     }
 161
 162     /* connection with bd_addr does not exist */
 163     for (i = 0, j = rfc_cb.rfc.last_mux + 1; i < MAX_BD_CONNECTIONS; i++, j++) {
 164         if (j >= MAX_BD_CONNECTIONS) {
 165             j = 0;
 166         }
 167
 168         p_mcb = &rfc_cb.port.rfc_mcb[j];
 169         if (rfc_cb.port.rfc_mcb[j].state == RFC_MX_STATE_IDLE) {
 170             /* New multiplexer control block */
 171             fixed_queue_free(p_mcb->cmd_q, NULL);
 172             rfc_timer_free(p_mcb);
 173             memset (p_mcb, 0, sizeof (tRFC_MCB));
 174             memcpy (p_mcb->bd_addr, bd_addr, BD_ADDR_LEN);
 175             RFCOMM_TRACE_DEBUG("rfc_alloc_multiplexer_channel:is_initiator:%d, create new p_mcb:%p, index:%d",
 176                                is_initiator, &rfc_cb.port.rfc_mcb[j], j);
 177
 178             p_mcb->cmd_q = fixed_queue_new(SIZE_MAX);
 179
 180             p_mcb->is_initiator = is_initiator;
 181
 182             rfc_timer_start (p_mcb, RFC_MCB_INIT_INACT_TIMER);
 183
 184             rfc_cb.rfc.last_mux = (UINT8) j;
 185             return (p_mcb);
 186         }
 187     }
 188     return (NULL);
 189 }
 190
 191 void osi_free_fun(void *p){
 192     osi_free(p);
 193 }
 194 /*******************************************************************************
 195 **
 196 ** Function         rfc_release_multiplexer_channel
 197 **
 198 ** Description      This function returns existing or new control block for
 199 **                  the BD_ADDR.
 200 **
 201 *******************************************************************************/
 202 void rfc_release_multiplexer_channel (tRFC_MCB *p_mcb)
 203 {
 204
 205     rfc_timer_free (p_mcb);
 206
 207     fixed_queue_free(p_mcb->cmd_q, osi_free_fun);
 208
 209     memset (p_mcb, 0, sizeof (tRFC_MCB));
 210     p_mcb->state = RFC_MX_STATE_IDLE;
 211 }
 212
 213
 214 /*******************************************************************************
 215 **
 216 ** Function         rfc_timer_start
 217 **
 218 ** Description      Start RFC Timer
 219 **
 220 *******************************************************************************/
 221 void rfc_timer_start (tRFC_MCB *p_mcb, UINT16 timeout)
 222 {
 223     TIMER_LIST_ENT *p_tle = &p_mcb->tle;
 224
 225     RFCOMM_TRACE_EVENT ("rfc_timer_start - timeout:%d", timeout);
 226
 227     p_tle->param = (UINT32)p_mcb;
 228
 229     btu_start_timer (p_tle, BTU_TTYPE_RFCOMM_MFC, timeout);
 230 }
 231
 232 /*******************************************************************************
 233 **
 234 ** Function         rfc_timer_stop
 235 **
 236 ** Description      Stop RFC Timer
 237 **
 238 *******************************************************************************/
 239 void rfc_timer_stop (tRFC_MCB *p_mcb)
 240 {
 241     RFCOMM_TRACE_EVENT ("rfc_timer_stop");
 242
 243     btu_stop_timer (&p_mcb->tle);
 244 }
 245
 246 /*******************************************************************************
 247 **
 248 ** Function         rfc_timer_free
 249 **
 250 ** Description      Stop and free RFC Timer
 251 **
 252 *******************************************************************************/
 253 void rfc_timer_free (tRFC_MCB *p_mcb)
 254 {
 255     RFCOMM_TRACE_EVENT ("rfc_timer_free");
 256
 257     btu_free_timer (&p_mcb->tle);
 258     memset(&p_mcb->tle, 0, sizeof(TIMER_LIST_ENT));
 259 }
 260
 261 /*******************************************************************************
 262 **
 263 ** Function         rfc_port_timer_start
 264 **
 265 ** Description      Start RFC Timer
 266 **
 267 *******************************************************************************/
 268 void rfc_port_timer_start (tPORT *p_port, UINT16 timeout)
 269 {
 270     TIMER_LIST_ENT *p_tle = &p_port->rfc.tle;
 271
 272     RFCOMM_TRACE_EVENT ("rfc_port_timer_start - timeout:%d", timeout);
 273
 274     p_tle->param = (UINT32)p_port;
 275
 276     btu_start_timer (p_tle, BTU_TTYPE_RFCOMM_PORT, timeout);
 277 }
 278
 279 /*******************************************************************************
 280 **
 281 ** Function         rfc_port_timer_stop
 282 **
 283 ** Description      Stop RFC Timer
 284 **
 285 *******************************************************************************/
 286 void rfc_port_timer_stop (tPORT *p_port)
 287 {
 288     RFCOMM_TRACE_EVENT ("rfc_port_timer_stop");
 289
 290     btu_stop_timer (&p_port->rfc.tle);
 291 }
 292
 293 /*******************************************************************************
 294 **
 295 ** Function         rfc_port_timer_free
 296 **
 297 ** Description      Stop and free RFC Timer
 298 **
 299 *******************************************************************************/
 300 void rfc_port_timer_free (tPORT *p_port)
 301 {
 302     RFCOMM_TRACE_EVENT ("rfc_port_timer_stop");
 303
 304     btu_free_timer (&p_port->rfc.tle);
 305     memset(&p_port->rfc.tle, 0, sizeof(TIMER_LIST_ENT));
 306 }
 307
 308 /*******************************************************************************
 309 **
 310 ** Function         rfc_check_mcb_active
 311 **
 312 ** Description      Check if there are any opened ports on the MCB if not
 313 **                  start MCB Inact timer.
 314 **
 315 ** Returns          void
 316 **
 317 *******************************************************************************/
 318 void rfc_check_mcb_active (tRFC_MCB *p_mcb)
 319 {
 320     UINT16 i;
 321
 322     for (i = 0; i < RFCOMM_MAX_DLCI; i++) {
 323         if (p_mcb->port_inx[i] != 0) {
 324             p_mcb->is_disc_initiator = FALSE;
 325             return;
 326         }
 327     }
 328     /* The last port was DISCed.  On the client side start disconnecting Mx */
 329     /* On the server side start inactivity timer */
 330     if (p_mcb->is_disc_initiator) {
 331         p_mcb->is_disc_initiator = FALSE;
 332         rfc_mx_sm_execute (p_mcb, RFC_MX_EVENT_CLOSE_REQ, NULL);
 333     } else {
 334         rfc_timer_start (p_mcb, RFC_MCB_RELEASE_INACT_TIMER);
 335     }
 336 }
 337
 338
 339 /*******************************************************************************
 340 **
 341 ** Function         rfcomm_process_timeout
 342 **
 343 ** Description      The function called every second to check RFCOMM timers
 344 **
 345 ** Returns          void
 346 **
 347 *******************************************************************************/
 348 void rfcomm_process_timeout (TIMER_LIST_ENT  *p_tle)
 349 {
 350     switch (p_tle->event) {
 351     case BTU_TTYPE_RFCOMM_MFC:
 352         rfc_mx_sm_execute ((tRFC_MCB *)p_tle->param, RFC_EVENT_TIMEOUT, NULL);
 353         break;
 354
 355     case BTU_TTYPE_RFCOMM_PORT:
 356         rfc_port_sm_execute ((tPORT *)p_tle->param, RFC_EVENT_TIMEOUT, NULL);
 357         break;
 358
 359     default:
 360         break;
 361     }
 362 }
 363
 364
 365 /*******************************************************************************
 366 **
 367 ** Function         rfc_sec_check_complete
 368 **
 369 ** Description      The function called when Security Manager finishes
 370 **                  verification of the service side connection
 371 **
 372 ** Returns          void
 373 **
 374 *******************************************************************************/
 375 void rfc_sec_check_complete (BD_ADDR bd_addr, tBT_TRANSPORT transport, void *p_ref_data, UINT8 res)
 376 {
 377     tPORT *p_port = (tPORT *)p_ref_data;
 378     UNUSED(bd_addr);
 379     UNUSED(transport);
 380
 381     /* Verify that PORT is still waiting for Security to complete */
 382     if (!p_port->in_use
 383             || ((p_port->rfc.state != RFC_STATE_ORIG_WAIT_SEC_CHECK)
 384                 && (p_port->rfc.state != RFC_STATE_TERM_WAIT_SEC_CHECK))) {
 385         return;
 386     }
 387
 388     rfc_port_sm_execute ((tPORT *)p_ref_data, RFC_EVENT_SEC_COMPLETE, &res);
 389 }
 390
 391
 392 /*******************************************************************************
 393 **
 394 ** Function         rfc_port_closed
 395 **
 396 ** Description      The function is called when port is released based on the
 397 **                  event received from the lower layer, typically L2CAP
 398 **                  connection down, DISC, or DM frame.
 399 **
 400 ** Returns          void
 401 **
 402 *******************************************************************************/
 403 void rfc_port_closed (tPORT *p_port)
 404 {
 405     tRFC_MCB *p_mcb = p_port->rfc.p_mcb;
 406
 407     RFCOMM_TRACE_DEBUG ("rfc_port_closed");
 408
 409     rfc_port_timer_stop (p_port);
 410
 411     p_port->rfc.state = RFC_STATE_CLOSED;
 412
 413     /* If multiplexer channel was up mark it as down */
 414     if (p_mcb) {
 415         p_mcb->port_inx[p_port->dlci] = 0;
 416
 417         /* If there are no more ports opened on this MCB release it */
 418         rfc_check_mcb_active (p_mcb);
 419     }
 420
 421     /* Notify port that RFC connection is gone */
 422     port_rfc_closed (p_port, PORT_CLOSED);
 423 }
 424
 425 /*******************************************************************************
 426 **
 427 ** Function         rfc_inc_credit
 428 **
 429 ** Description      The function is called when a credit is received in a UIH
 430 **                  frame.  It increments the TX credit count, and if data
 431 **                  flow had halted, it restarts it.
 432 **
 433 ** Returns          void
 434 **
 435 *******************************************************************************/
 436 void rfc_inc_credit (tPORT *p_port, UINT8 credit)
 437 {
 438     if (p_port->rfc.p_mcb->flow == PORT_FC_CREDIT) {
 439         p_port->credit_tx += credit;
 440
 441         RFCOMM_TRACE_EVENT ("rfc_inc_credit:%d", p_port->credit_tx);
 442
 443         if (p_port->tx.peer_fc == TRUE) {
 444             PORT_FlowInd(p_port->rfc.p_mcb, p_port->dlci, TRUE);
 445         }
 446     }
 447 }
 448
 449 /*******************************************************************************
 450 **
 451 ** Function         rfc_dec_credit
 452 **
 453 ** Description      The function is called when a UIH frame of user data is
 454 **                  sent.  It decrements the credit count.  If credit count
 455 **                  Reaches zero, peer_fc is set.
 456 **
 457 ** Returns          void
 458 **
 459 *******************************************************************************/
 460 void rfc_dec_credit (tPORT *p_port)
 461 {
 462     if (p_port->rfc.p_mcb->flow == PORT_FC_CREDIT) {
 463         if (p_port->credit_tx > 0) {
 464             p_port->credit_tx--;
 465         }
 466
 467         if (p_port->credit_tx == 0) {
 468             p_port->tx.peer_fc = TRUE;
 469         }
 470     }
 471 }
 472
 473
 474 /*******************************************************************************
 475 **
 476 ** Function         rfc_check_send_cmd
 477 **
 478 ** Description      This function is called to send an RFCOMM command message
 479 **                  or to handle the RFCOMM command message queue.
 480 **
 481 ** Returns          void
 482 **
 483 *******************************************************************************/
 484 void rfc_check_send_cmd(tRFC_MCB *p_mcb, BT_HDR *p_buf)
 485 {
 486     BT_HDR  *p;
 487
 488     /* if passed a buffer queue it */
 489     if (p_buf != NULL) {
 490         if (p_mcb->cmd_q == NULL) {
 491             RFCOMM_TRACE_ERROR("%s: empty queue: p_mcb = %p p_mcb->lcid = %u cached p_mcb = %p",
 492                                __func__, p_mcb, p_mcb->lcid,
 493                                rfc_find_lcid_mcb(p_mcb->lcid));
 494         }
 495         fixed_queue_enqueue(p_mcb->cmd_q, p_buf);
 496     }
 497
 498     /* handle queue if L2CAP not congested */
 499     while (p_mcb->l2cap_congested == FALSE) {
 500         if ((p = (BT_HDR *)fixed_queue_try_dequeue(p_mcb->cmd_q)) == NULL) {
 501             break;
 502         }
 503
 504
 505         L2CA_DataWrite (p_mcb->lcid, p);
 506     }
 507 }
 508
 509
 510 #endif ///(defined RFCOMM_INCLUDED && RFCOMM_INCLUDED == TRUE)