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