Home | History | Annotate | Download | only in rfcomm
      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 module contains functions for port emulation entity and RFCOMM
     22  *  communications
     23  *
     24  ******************************************************************************/
     25 #include <base/logging.h>
     26 #include <string.h>
     27 
     28 #include "osi/include/mutex.h"
     29 #include "osi/include/osi.h"
     30 
     31 #include "bt_common.h"
     32 #include "bt_target.h"
     33 #include "bt_utils.h"
     34 #include "btm_api.h"
     35 #include "btm_int.h"
     36 #include "port_api.h"
     37 #include "port_int.h"
     38 #include "rfc_int.h"
     39 #include "rfcdefs.h"
     40 
     41 /*
     42  * Local function definitions
     43 */
     44 uint32_t port_rfc_send_tx_data(tPORT* p_port);
     45 void port_rfc_closed(tPORT* p_port, uint8_t res);
     46 void port_get_credits(tPORT* p_port, uint8_t k);
     47 
     48 /*******************************************************************************
     49  *
     50  * Function         port_open_continue
     51  *
     52  * Description      This function is called after security manager completes
     53  *                  required security checks.
     54  *
     55  * Returns          void
     56  *
     57  ******************************************************************************/
     58 int port_open_continue(tPORT* p_port) {
     59   tRFC_MCB* p_mcb;
     60 
     61   RFCOMM_TRACE_EVENT("port_open_continue, p_port:%p", p_port);
     62 
     63   /* Check if multiplexer channel has already been established */
     64   p_mcb = rfc_alloc_multiplexer_channel(p_port->bd_addr, true);
     65   if (p_mcb == NULL) {
     66     RFCOMM_TRACE_WARNING("port_open_continue no mx channel");
     67     port_release_port(p_port);
     68     return (PORT_NO_RESOURCES);
     69   }
     70 
     71   p_port->rfc.p_mcb = p_mcb;
     72 
     73   p_mcb->port_inx[p_port->dlci] = p_port->inx;
     74 
     75   /* Connection is up and we know local and remote features, select MTU */
     76   port_select_mtu(p_port);
     77 
     78   if (p_mcb->state == RFC_MX_STATE_CONNECTED) {
     79     RFCOMM_ParNegReq(p_mcb, p_port->dlci, p_port->mtu);
     80   } else if ((p_mcb->state == RFC_MX_STATE_IDLE) ||
     81              (p_mcb->state == RFC_MX_STATE_DISC_WAIT_UA)) {
     82     /* In RFC_MX_STATE_IDLE state, MX state machine will create connection */
     83     /* In RFC_MX_STATE_DISC_WAIT_UA state, MX state machine will recreate
     84      * connection */
     85     /*    after disconnecting is completed */
     86     RFCOMM_StartReq(p_mcb);
     87   } else {
     88     /* MX state machine ignores RFC_MX_EVENT_START_REQ in these states */
     89     /* When it enters RFC_MX_STATE_CONNECTED, it will check any openning ports
     90      */
     91     RFCOMM_TRACE_DEBUG(
     92         "port_open_continue: mx state(%d) mx channel is openning",
     93         p_mcb->state);
     94   }
     95   return (PORT_SUCCESS);
     96 }
     97 
     98 /*******************************************************************************
     99  *
    100  * Function         port_start_control
    101  *
    102  * Description      This function is called in the BTU_TASK context to
    103  *                  send control information
    104  *
    105  * Returns          void
    106  *
    107  ******************************************************************************/
    108 void port_start_control(tPORT* p_port) {
    109   tRFC_MCB* p_mcb = p_port->rfc.p_mcb;
    110 
    111   if (p_mcb == NULL) return;
    112 
    113   RFCOMM_ControlReq(p_mcb, p_port->dlci, &p_port->local_ctrl);
    114 }
    115 
    116 /*******************************************************************************
    117  *
    118  * Function         port_start_par_neg
    119  *
    120  * Description      This function is called in the BTU_TASK context to
    121  *                  send configuration information
    122  *
    123  * Returns          void
    124  *
    125  ******************************************************************************/
    126 void port_start_par_neg(tPORT* p_port) {
    127   tRFC_MCB* p_mcb = p_port->rfc.p_mcb;
    128 
    129   if (p_mcb == NULL) return;
    130 
    131   RFCOMM_PortNegReq(p_mcb, p_port->dlci, &p_port->user_port_pars);
    132 }
    133 
    134 /*******************************************************************************
    135  *
    136  * Function         port_start_close
    137  *
    138  * Description      This function is called in the BTU_TASK context to
    139  *                  release DLC
    140  *
    141  * Returns          void
    142  *
    143  ******************************************************************************/
    144 void port_start_close(tPORT* p_port) {
    145   tRFC_MCB* p_mcb = p_port->rfc.p_mcb;
    146   uint8_t old_signals;
    147   uint32_t events = 0;
    148 
    149   /* At first indicate to the user that signals on the connection were dropped
    150    */
    151   p_port->line_status |= LINE_STATUS_FAILED;
    152   old_signals = p_port->peer_ctrl.modem_signal;
    153 
    154   p_port->peer_ctrl.modem_signal &=
    155       ~(PORT_DTRDSR_ON | PORT_CTSRTS_ON | PORT_DCD_ON);
    156 
    157   events |= port_get_signal_changes(p_port, old_signals,
    158                                     p_port->peer_ctrl.modem_signal);
    159 
    160   if (p_port->ev_mask & PORT_EV_CONNECT_ERR) events |= PORT_EV_CONNECT_ERR;
    161 
    162   if (p_port->ev_mask & PORT_EV_ERR) events |= PORT_EV_ERR;
    163 
    164   if ((p_port->p_callback != NULL) && events)
    165     p_port->p_callback(events, p_port->inx);
    166 
    167   /* Check if RFCOMM side has been closed while the message was queued */
    168   if ((p_mcb == NULL) || (p_port->rfc.state == RFC_STATE_CLOSED)) {
    169     /* Call management callback function before calling port_release_port() to
    170      * clear tPort */
    171     if (p_port->p_mgmt_callback)
    172       p_port->p_mgmt_callback(PORT_CLOSED, p_port->inx);
    173 
    174     port_release_port(p_port);
    175   } else {
    176     RFCOMM_DlcReleaseReq(p_mcb, p_port->dlci);
    177   }
    178 }
    179 
    180 /*******************************************************************************
    181  *
    182  * Function         PORT_StartCnf
    183  *
    184  * Description      This function is called from the RFCOMM layer when
    185  *                  establishing of the multiplexer channel is completed.
    186  *                  Continue establishing of the connection for all ports that
    187  *                  are in the OPENING state
    188  *
    189  ******************************************************************************/
    190 void PORT_StartCnf(tRFC_MCB* p_mcb, uint16_t result) {
    191   tPORT* p_port;
    192   int i;
    193   bool no_ports_up = true;
    194 
    195   RFCOMM_TRACE_EVENT("PORT_StartCnf result:%d", result);
    196 
    197   p_port = &rfc_cb.port.port[0];
    198   for (i = 0; i < MAX_RFC_PORTS; i++, p_port++) {
    199     if (p_port->rfc.p_mcb == p_mcb) {
    200       no_ports_up = false;
    201 
    202       if (result == RFCOMM_SUCCESS)
    203         RFCOMM_ParNegReq(p_mcb, p_port->dlci, p_port->mtu);
    204       else {
    205         RFCOMM_TRACE_WARNING("PORT_StartCnf failed result:%d", result);
    206 
    207         /* Warning: result is also set to 4 when l2cap connection
    208            fails due to l2cap connect cnf (no_resources) */
    209         if (result == HCI_ERR_PAGE_TIMEOUT)
    210           p_port->error = PORT_PAGE_TIMEOUT;
    211         else
    212           p_port->error = PORT_START_FAILED;
    213 
    214         rfc_release_multiplexer_channel(p_mcb);
    215 
    216         /* Send event to the application */
    217         if (p_port->p_callback && (p_port->ev_mask & PORT_EV_CONNECT_ERR))
    218           (p_port->p_callback)(PORT_EV_CONNECT_ERR, p_port->inx);
    219 
    220         if (p_port->p_mgmt_callback)
    221           p_port->p_mgmt_callback(PORT_START_FAILED, p_port->inx);
    222 
    223         port_release_port(p_port);
    224       }
    225     }
    226   }
    227 
    228   /* There can be a situation when after starting connection, user closes the */
    229   /* port, we can catch it here to close multiplexor channel */
    230   if (no_ports_up) {
    231     rfc_check_mcb_active(p_mcb);
    232   }
    233 }
    234 
    235 /*******************************************************************************
    236  *
    237  * Function         PORT_StartInd
    238  *
    239  * Description      This function is called from the RFCOMM layer when
    240  *                  some peer device wants to establish a multiplexer
    241  *                  connection.  Check if there are any ports open with this
    242  *                  or not assigned multiplexer.
    243  *
    244  ******************************************************************************/
    245 void PORT_StartInd(tRFC_MCB* p_mcb) {
    246   tPORT* p_port;
    247   int i;
    248 
    249   RFCOMM_TRACE_EVENT("PORT_StartInd");
    250 
    251   p_port = &rfc_cb.port.port[0];
    252   for (i = 0; i < MAX_RFC_PORTS; i++, p_port++) {
    253     if ((p_port->rfc.p_mcb == NULL) || (p_port->rfc.p_mcb == p_mcb)) {
    254       RFCOMM_TRACE_DEBUG(
    255           "PORT_StartInd, RFCOMM_StartRsp RFCOMM_SUCCESS: p_mcb:%p", p_mcb);
    256       RFCOMM_StartRsp(p_mcb, RFCOMM_SUCCESS);
    257       return;
    258     }
    259   }
    260   RFCOMM_StartRsp(p_mcb, RFCOMM_ERROR);
    261 }
    262 
    263 /*******************************************************************************
    264  *
    265  * Function         PORT_ParNegInd
    266  *
    267  * Description      This function is called from the RFCOMM layer to change
    268  *                  DLCI parameters (currently only MTU is negotiated).
    269  *                  If can not find the port do not accept the request.
    270  *                  Otherwise save the MTU size supported by the peer.
    271  *
    272  ******************************************************************************/
    273 void PORT_ParNegInd(tRFC_MCB* p_mcb, uint8_t dlci, uint16_t mtu, uint8_t cl,
    274                     uint8_t k) {
    275   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    276   uint8_t our_cl;
    277   uint8_t our_k;
    278 
    279   RFCOMM_TRACE_EVENT("PORT_ParNegInd dlci:%d mtu:%d", dlci, mtu);
    280 
    281   if (!p_port) {
    282     /* This can be a first request for this port */
    283     p_port = port_find_dlci_port(dlci);
    284     if (!p_port) {
    285       /* If the port cannot be opened, send a DM.  Per Errata 1205 */
    286       rfc_send_dm(p_mcb, dlci, false);
    287       /* check if this is the last port open, some headsets have
    288       problem, they don't disconnect if we send DM */
    289       rfc_check_mcb_active(p_mcb);
    290       RFCOMM_TRACE_EVENT("PORT_ParNegInd: port not found");
    291       return;
    292     }
    293     p_mcb->port_inx[dlci] = p_port->inx;
    294   }
    295 
    296   p_port->bd_addr = p_mcb->bd_addr;
    297 
    298   /* Connection is up and we know local and remote features, select MTU */
    299   port_select_mtu(p_port);
    300 
    301   p_port->rfc.p_mcb = p_mcb;
    302   p_port->mtu = (p_port->mtu < mtu) ? p_port->mtu : mtu;
    303   p_port->peer_mtu = p_port->mtu;
    304 
    305   /* Negotiate the flow control mechanism.  If flow control mechanism for */
    306   /* mux has not been set yet, set it now.  If either we or peer wants TS 07.10,
    307    */
    308   /* use that.  Otherwise both must want credit based, so use that. If flow is
    309    */
    310   /* already defined for this mux, we respond with that value. */
    311   if (p_mcb->flow == PORT_FC_UNDEFINED) {
    312     if ((PORT_FC_DEFAULT == PORT_FC_TS710) ||
    313         (cl == RFCOMM_PN_CONV_LAYER_TYPE_1)) {
    314       p_mcb->flow = PORT_FC_TS710;
    315     } else {
    316       p_mcb->flow = PORT_FC_CREDIT;
    317     }
    318   }
    319 
    320   /* Regardless of our flow control mechanism, if the PN cl is zero, we must */
    321   /* respond with zero.  "A responding implementation must set this field to 14
    322    */
    323   /* if (and only if) the PN request was 15."  This could happen if a PN is sent
    324    */
    325   /* after the DLCI is already established-- the PN in that case must have cl =
    326    * 0. */
    327   /* See RFCOMM spec 5.5.3 */
    328   if (cl == RFCOMM_PN_CONV_LAYER_TYPE_1) {
    329     our_cl = RFCOMM_PN_CONV_LAYER_TYPE_1;
    330     our_k = 0;
    331   } else if (p_mcb->flow == PORT_FC_CREDIT) {
    332     /* get credits */
    333     port_get_credits(p_port, k);
    334 
    335     /* Set convergence layer and number of credits (k) */
    336     our_cl = RFCOMM_PN_CONV_LAYER_CBFC_R;
    337     our_k = (p_port->credit_rx_max < RFCOMM_K_MAX) ? p_port->credit_rx_max
    338                                                    : RFCOMM_K_MAX;
    339     p_port->credit_rx = our_k;
    340   } else {
    341     /* must not be using credit based flow control; use TS 7.10 */
    342     our_cl = RFCOMM_PN_CONV_LAYER_TYPE_1;
    343     our_k = 0;
    344   }
    345   RFCOMM_ParNegRsp(p_mcb, dlci, p_port->mtu, our_cl, our_k);
    346 }
    347 
    348 /*******************************************************************************
    349  *
    350  * Function         PORT_ParNegCnf
    351  *
    352  * Description      This function is called from the RFCOMM layer to change
    353  *                  DLCI parameters (currently only MTU is negotiated).
    354  *                  Save the MTU size supported by the peer.
    355  *                  If the confirmation is received during the port opening
    356  *                  procedure send EstablishRequest to continue.
    357  *
    358  ******************************************************************************/
    359 void PORT_ParNegCnf(tRFC_MCB* p_mcb, uint8_t dlci, uint16_t mtu, uint8_t cl,
    360                     uint8_t k) {
    361   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    362 
    363   RFCOMM_TRACE_EVENT("PORT_ParNegCnf dlci:%d mtu:%d cl: %d k: %d", dlci, mtu,
    364                      cl, k);
    365 
    366   if (!p_port) return;
    367 
    368   /* Flow control mechanism not set yet.  Negotiate flow control mechanism. */
    369   if (p_mcb->flow == PORT_FC_UNDEFINED) {
    370     /* Our stack is configured for TS07.10 and they responded with credit-based.
    371      */
    372     /* This is illegal-- negotiation fails. */
    373     if ((PORT_FC_DEFAULT == PORT_FC_TS710) &&
    374         (cl == RFCOMM_PN_CONV_LAYER_CBFC_R)) {
    375       RFCOMM_TRACE_WARNING("%s, negotiation fails, index=%d", __func__,
    376                            p_port->inx);
    377       rfc_send_disc(p_mcb, p_port->dlci);
    378       rfc_port_closed(p_port);
    379       return;
    380     }
    381     /* Our stack is configured for credit-based and they responded with
    382        credit-based. */
    383     else if (cl == RFCOMM_PN_CONV_LAYER_CBFC_R) {
    384       p_mcb->flow = PORT_FC_CREDIT;
    385     }
    386     /* They responded with any other value.  Treat this as negotiation to
    387        TS07.10. */
    388     else {
    389       p_mcb->flow = PORT_FC_TS710;
    390     }
    391   }
    392   /* If mux flow control mechanism set, we honor that setting regardless of */
    393   /* the CL value in their response.  This allows us to gracefully accept any */
    394   /* illegal PN negotiation scenarios. */
    395 
    396   p_port->mtu = (p_port->mtu < mtu) ? p_port->mtu : mtu;
    397   p_port->peer_mtu = p_port->mtu;
    398 
    399   if (p_mcb->flow == PORT_FC_CREDIT) {
    400     port_get_credits(p_port, k);
    401   }
    402 
    403   if (p_port->state == PORT_STATE_OPENING)
    404     RFCOMM_DlcEstablishReq(p_mcb, p_port->dlci, p_port->mtu);
    405 }
    406 
    407 /*******************************************************************************
    408  *
    409  * Function         PORT_DlcEstablishInd
    410  *
    411  * Description      This function is called from the RFCOMM layer when peer
    412  *                  device wants to establish a new DLC.  If this is not the
    413  *                  first message in the establishment procedure port_handle
    414  *                  has a handle to the port control block otherwise the control
    415  *                  block should be found based on the muliplexer channel and
    416  *                  dlci.  The block should be allocated allocated before
    417  *                  meaning that application already made open.
    418  *
    419  ******************************************************************************/
    420 void PORT_DlcEstablishInd(tRFC_MCB* p_mcb, uint8_t dlci, uint16_t mtu) {
    421   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    422 
    423   RFCOMM_TRACE_DEBUG(
    424       "PORT_DlcEstablishInd p_mcb:%p, dlci:%d mtu:%di, p_port:%p", p_mcb, dlci,
    425       mtu, p_port);
    426   VLOG(1) << __func__ << " p_mcb addr:" << p_mcb->bd_addr;
    427 
    428   if (!p_port) {
    429     /* This can be a first request for this port */
    430     p_port = port_find_dlci_port(dlci);
    431     if (!p_port) {
    432       RFCOMM_DlcEstablishRsp(p_mcb, dlci, 0, RFCOMM_ERROR);
    433       return;
    434     }
    435     p_mcb->port_inx[dlci] = p_port->inx;
    436   }
    437 
    438   /* If L2CAP's mtu less then RFCOMM's take it */
    439   if (mtu && (mtu < p_port->peer_mtu)) p_port->peer_mtu = mtu;
    440 
    441   /* If there was an inactivity timer running for MCB stop it */
    442   rfc_timer_stop(p_mcb);
    443 
    444   RFCOMM_DlcEstablishRsp(p_mcb, dlci, p_port->mtu, RFCOMM_SUCCESS);
    445 
    446   /* This is the server side.  If application wants to know when connection */
    447   /* is established, thats the place */
    448   if (p_port->p_callback && (p_port->ev_mask & PORT_EV_CONNECTED))
    449     (p_port->p_callback)(PORT_EV_CONNECTED, p_port->inx);
    450 
    451   if (p_port->p_mgmt_callback)
    452     p_port->p_mgmt_callback(PORT_SUCCESS, p_port->inx);
    453 
    454   p_port->state = PORT_STATE_OPENED;
    455 }
    456 
    457 /*******************************************************************************
    458  *
    459  * Function         PORT_DlcEstablishCnf
    460  *
    461  * Description      This function is called from the RFCOMM layer when peer
    462  *                  acknowledges establish procedure (SABME/UA).  Send reply
    463  *                  to the user and set state to OPENED if result was
    464  *                  successfull.
    465  *
    466  ******************************************************************************/
    467 void PORT_DlcEstablishCnf(tRFC_MCB* p_mcb, uint8_t dlci, uint16_t mtu,
    468                           uint16_t result) {
    469   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    470 
    471   RFCOMM_TRACE_EVENT("PORT_DlcEstablishCnf dlci:%d mtu:%d result:%d", dlci, mtu,
    472                      result);
    473 
    474   if (!p_port) return;
    475 
    476   if (result != RFCOMM_SUCCESS) {
    477     p_port->error = PORT_START_FAILED;
    478     port_rfc_closed(p_port, PORT_START_FAILED);
    479     return;
    480   }
    481 
    482   /* If L2CAP's mtu less then RFCOMM's take it */
    483   if (mtu && (mtu < p_port->peer_mtu)) p_port->peer_mtu = mtu;
    484 
    485   /* If there was an inactivity timer running for MCB stop it */
    486   rfc_timer_stop(p_mcb);
    487 
    488   if (p_port->p_callback && (p_port->ev_mask & PORT_EV_CONNECTED))
    489     (p_port->p_callback)(PORT_EV_CONNECTED, p_port->inx);
    490 
    491   if (p_port->p_mgmt_callback)
    492     p_port->p_mgmt_callback(PORT_SUCCESS, p_port->inx);
    493 
    494   p_port->state = PORT_STATE_OPENED;
    495 
    496   /* RPN is required only if we want to tell DTE how the port should be opened
    497    */
    498   if ((p_port->uuid == UUID_SERVCLASS_DIALUP_NETWORKING) ||
    499       (p_port->uuid == UUID_SERVCLASS_FAX))
    500     RFCOMM_PortNegReq(p_port->rfc.p_mcb, p_port->dlci, NULL);
    501   else
    502     RFCOMM_ControlReq(p_port->rfc.p_mcb, p_port->dlci, &p_port->local_ctrl);
    503 }
    504 
    505 /*******************************************************************************
    506  *
    507  * Function         PORT_PortNegInd
    508  *
    509  * Description      This function is called from the RFCOMM layer when peer
    510  *                  device wants to set parameters of the port.  As per the spec
    511  *                  this message has to be sent before the first data packet
    512  *                  and can be sent before establish.  The block should be
    513  *                  allocated before meaning that application already made open.
    514  *
    515  ******************************************************************************/
    516 void PORT_PortNegInd(tRFC_MCB* p_mcb, uint8_t dlci, tPORT_STATE* p_pars,
    517                      uint16_t param_mask) {
    518   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    519 
    520   RFCOMM_TRACE_EVENT("PORT_PortNegInd");
    521 
    522   if (!p_port) {
    523     /* This can be a first request for this port */
    524     p_port = port_find_dlci_port(dlci);
    525     if (!p_port) {
    526       RFCOMM_PortNegRsp(p_mcb, dlci, p_pars, 0);
    527       return;
    528     }
    529     p_mcb->port_inx[dlci] = p_port->inx;
    530   }
    531 
    532   /* Check if the flow control is acceptable on local side */
    533   p_port->peer_port_pars = *p_pars;
    534   RFCOMM_PortNegRsp(p_mcb, dlci, p_pars, param_mask);
    535 }
    536 
    537 /*******************************************************************************
    538  *
    539  * Function         PORT_PortNegCnf
    540  *
    541  * Description      This function is called from the RFCOMM layer to change
    542  *                  state for the port.  Propagate change to the user.
    543  *
    544  ******************************************************************************/
    545 void PORT_PortNegCnf(tRFC_MCB* p_mcb, uint8_t dlci,
    546                      UNUSED_ATTR tPORT_STATE* p_pars, uint16_t result) {
    547   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    548 
    549   RFCOMM_TRACE_EVENT("PORT_PortNegCnf");
    550 
    551   if (!p_port) {
    552     RFCOMM_TRACE_WARNING("PORT_PortNegCnf no port");
    553     return;
    554   }
    555   /* Port negotiation failed. Drop the connection */
    556   if (result != RFCOMM_SUCCESS) {
    557     p_port->error = PORT_PORT_NEG_FAILED;
    558 
    559     RFCOMM_DlcReleaseReq(p_mcb, p_port->dlci);
    560 
    561     port_rfc_closed(p_port, PORT_PORT_NEG_FAILED);
    562     return;
    563   }
    564 
    565   if (!(p_port->port_ctrl & PORT_CTRL_REQ_SENT)) {
    566     RFCOMM_ControlReq(p_port->rfc.p_mcb, p_port->dlci, &p_port->local_ctrl);
    567   } else {
    568     RFCOMM_TRACE_WARNING("PORT_PortNegCnf Control Already sent");
    569   }
    570 }
    571 
    572 /*******************************************************************************
    573  *
    574  * Function         PORT_ControlInd
    575  *
    576  * Description      This function is called from the RFCOMM layer on the modem
    577  *                  signal change.  Propagate change to the user.
    578  *
    579  ******************************************************************************/
    580 void PORT_ControlInd(tRFC_MCB* p_mcb, uint8_t dlci, tPORT_CTRL* p_pars) {
    581   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    582   uint32_t event;
    583   uint8_t old_signals;
    584 
    585   RFCOMM_TRACE_EVENT("PORT_ControlInd");
    586 
    587   if (!p_port) return;
    588 
    589   old_signals = p_port->peer_ctrl.modem_signal;
    590 
    591   event = port_get_signal_changes(p_port, old_signals, p_pars->modem_signal);
    592 
    593   p_port->peer_ctrl = *p_pars;
    594 
    595   if (!(p_port->port_ctrl & PORT_CTRL_REQ_SENT))
    596     RFCOMM_ControlReq(p_port->rfc.p_mcb, p_port->dlci, &p_port->local_ctrl);
    597   else {
    598     /* If this is the first time we received control RFCOMM is connected */
    599     if (!(p_port->port_ctrl & PORT_CTRL_IND_RECEIVED)) {
    600       event |= (PORT_EV_CONNECTED & p_port->ev_mask);
    601     }
    602 
    603     if (p_port->port_ctrl & PORT_CTRL_REQ_CONFIRMED) {
    604       event |= port_rfc_send_tx_data(p_port);
    605     }
    606   }
    607 
    608   p_port->port_ctrl |= (PORT_CTRL_IND_RECEIVED | PORT_CTRL_IND_RESPONDED);
    609 
    610   if (p_pars->break_signal) event |= (PORT_EV_BREAK & p_port->ev_mask);
    611 
    612   /* execute call back function only if the application is registered for events
    613    */
    614   if (event && p_port->p_callback) (p_port->p_callback)(event, p_port->inx);
    615 
    616   RFCOMM_TRACE_EVENT(
    617       "PORT_ControlInd DTR_DSR : %d, RTS_CTS : %d, RI : %d, DCD : %d",
    618       ((p_port->peer_ctrl.modem_signal & MODEM_SIGNAL_DTRDSR) ? 1 : 0),
    619       ((p_port->peer_ctrl.modem_signal & MODEM_SIGNAL_RTSCTS) ? 1 : 0),
    620       ((p_port->peer_ctrl.modem_signal & MODEM_SIGNAL_RI) ? 1 : 0),
    621       ((p_port->peer_ctrl.modem_signal & MODEM_SIGNAL_DCD) ? 1 : 0));
    622 }
    623 
    624 /*******************************************************************************
    625  *
    626  * Function         PORT_ControlCnf
    627  *
    628  * Description      This function is called from the RFCOMM layer when
    629  *                  peer acknowleges change of the modem signals.
    630  *
    631  ******************************************************************************/
    632 void PORT_ControlCnf(tRFC_MCB* p_mcb, uint8_t dlci,
    633                      UNUSED_ATTR tPORT_CTRL* p_pars) {
    634   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    635   uint32_t event = 0;
    636 
    637   RFCOMM_TRACE_EVENT("PORT_ControlCnf");
    638 
    639   if (!p_port) return;
    640 
    641   if (!(p_port->port_ctrl & PORT_CTRL_REQ_CONFIRMED)) {
    642     p_port->port_ctrl |= PORT_CTRL_REQ_CONFIRMED;
    643 
    644     if (p_port->port_ctrl & PORT_CTRL_IND_RECEIVED)
    645       event = (p_port->ev_mask & PORT_EV_CONNECTED);
    646   }
    647 
    648   if (p_port->port_ctrl & PORT_CTRL_IND_RECEIVED) {
    649     event |= port_rfc_send_tx_data(p_port);
    650   }
    651 
    652   /* execute call back function only if the application is registered for events
    653    */
    654   if (event && p_port->p_callback) (p_port->p_callback)(event, p_port->inx);
    655 }
    656 
    657 /*******************************************************************************
    658  *
    659  * Function         PORT_LineStatusInd
    660  *
    661  * Description      This function is called from the RFCOMM layer when
    662  *                  peer indicates change in the line status
    663  *
    664  ******************************************************************************/
    665 void PORT_LineStatusInd(tRFC_MCB* p_mcb, uint8_t dlci, uint8_t line_status) {
    666   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    667   uint32_t event = 0;
    668 
    669   RFCOMM_TRACE_EVENT("PORT_LineStatusInd");
    670 
    671   if (!p_port) return;
    672 
    673   p_port->line_status |= line_status;
    674 
    675   if (line_status & PORT_ERR_OVERRUN) event |= PORT_EV_OVERRUN;
    676 
    677   if (line_status & PORT_ERR_BREAK) event |= PORT_EV_BREAK;
    678 
    679   if (line_status & ~(PORT_ERR_OVERRUN | PORT_ERR_BREAK)) event |= PORT_EV_ERR;
    680 
    681   if ((p_port->p_callback != NULL) && (p_port->ev_mask & event))
    682     p_port->p_callback((p_port->ev_mask & event), p_port->inx);
    683 }
    684 
    685 /*******************************************************************************
    686  *
    687  * Function         PORT_DlcReleaseInd
    688  *
    689  * Description      This function is called from the RFCOMM layer when
    690  *                  DLC connection is released.
    691  *
    692  ******************************************************************************/
    693 void PORT_DlcReleaseInd(tRFC_MCB* p_mcb, uint8_t dlci) {
    694   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    695 
    696   RFCOMM_TRACE_EVENT("PORT_DlcReleaseInd");
    697 
    698   if (!p_port) return;
    699 
    700   port_rfc_closed(p_port, PORT_CLOSED);
    701 }
    702 
    703 /*******************************************************************************
    704  *
    705  * Function         PORT_CloseInd
    706  *
    707  * Description      This function is called from the RFCOMM layer when
    708  *                  multiplexer connection is released.
    709  *
    710  ******************************************************************************/
    711 void PORT_CloseInd(tRFC_MCB* p_mcb) {
    712   tPORT* p_port;
    713   int i;
    714 
    715   RFCOMM_TRACE_EVENT("PORT_CloseInd");
    716 
    717   p_port = &rfc_cb.port.port[0];
    718   for (i = 0; i < MAX_RFC_PORTS; i++, p_port++) {
    719     if (p_port->rfc.p_mcb == p_mcb) {
    720       port_rfc_closed(p_port, PORT_PEER_CONNECTION_FAILED);
    721     }
    722   }
    723   rfc_release_multiplexer_channel(p_mcb);
    724 }
    725 
    726 /*******************************************************************************
    727  *
    728  * Function         Port_TimeOutCloseMux
    729  *
    730  * Description      This function is called when RFCOMM timesout on a command
    731  *                  as a result multiplexer connection is closed.
    732  *
    733  ******************************************************************************/
    734 void Port_TimeOutCloseMux(tRFC_MCB* p_mcb) {
    735   tPORT* p_port;
    736   int i;
    737 
    738   RFCOMM_TRACE_EVENT("Port_TimeOutCloseMux");
    739 
    740   p_port = &rfc_cb.port.port[0];
    741   for (i = 0; i < MAX_RFC_PORTS; i++, p_port++) {
    742     if (p_port->rfc.p_mcb == p_mcb) {
    743       port_rfc_closed(p_port, PORT_PEER_TIMEOUT);
    744     }
    745   }
    746 }
    747 
    748 /*******************************************************************************
    749  *
    750  * Function         PORT_DataInd
    751  *
    752  * Description      This function is called from the RFCOMM layer when data
    753  *                  buffer is received from the peer.
    754  *
    755  ******************************************************************************/
    756 void PORT_DataInd(tRFC_MCB* p_mcb, uint8_t dlci, BT_HDR* p_buf) {
    757   tPORT* p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    758   uint8_t rx_char1;
    759   uint32_t events = 0;
    760   uint8_t* p;
    761   int i;
    762 
    763   RFCOMM_TRACE_EVENT(
    764       "PORT_DataInd with data length %d, p_mcb:%p,p_port:%p,dlci:%d",
    765       p_buf->len, p_mcb, p_port, dlci);
    766   if (!p_port) {
    767     osi_free(p_buf);
    768     return;
    769   }
    770   /* If client registered callout callback with flow control we can just deliver
    771    * receive data */
    772   if (p_port->p_data_co_callback) {
    773     /* Another packet is delivered to user.  Send credits to peer if required */
    774     if (p_port->p_data_co_callback(p_port->inx, (uint8_t*)p_buf, -1,
    775                                    DATA_CO_CALLBACK_TYPE_INCOMING)) {
    776       port_flow_control_peer(p_port, true, 1);
    777     } else {
    778       port_flow_control_peer(p_port, false, 0);
    779     }
    780     // osi_free(p_buf);
    781     return;
    782   }
    783   /* If client registered callback we can just deliver receive data */
    784   if (p_port->p_data_callback) {
    785     /* Another packet is delivered to user.  Send credits to peer if required */
    786     port_flow_control_peer(p_port, true, 1);
    787     p_port->p_data_callback(p_port->inx, (uint8_t*)(p_buf + 1) + p_buf->offset,
    788                             p_buf->len);
    789     osi_free(p_buf);
    790     return;
    791   }
    792   /* Check if rx queue exceeds the limit */
    793   if ((p_port->rx.queue_size + p_buf->len > PORT_RX_CRITICAL_WM) ||
    794       (fixed_queue_length(p_port->rx.queue) + 1 > p_port->rx_buf_critical)) {
    795     RFCOMM_TRACE_EVENT("PORT_DataInd. Buffer over run. Dropping the buffer");
    796     osi_free(p_buf);
    797     RFCOMM_LineStatusReq(p_mcb, dlci, LINE_STATUS_OVERRUN);
    798     return;
    799   }
    800   /* If user registered to receive notification when a particular byte is */
    801   /* received we mast check all received bytes */
    802   if (((rx_char1 = p_port->user_port_pars.rx_char1) != 0) &&
    803       (p_port->ev_mask & PORT_EV_RXFLAG)) {
    804     for (i = 0, p = (uint8_t*)(p_buf + 1) + p_buf->offset; i < p_buf->len;
    805          i++) {
    806       if (*p++ == rx_char1) {
    807         events |= PORT_EV_RXFLAG;
    808         break;
    809       }
    810     }
    811   }
    812 
    813   mutex_global_lock();
    814 
    815   fixed_queue_enqueue(p_port->rx.queue, p_buf);
    816   p_port->rx.queue_size += p_buf->len;
    817 
    818   mutex_global_unlock();
    819 
    820   /* perform flow control procedures if necessary */
    821   port_flow_control_peer(p_port, false, 0);
    822 
    823   /* If user indicated flow control can not deliver any notifications to him */
    824   if (p_port->rx.user_fc) {
    825     if (events & PORT_EV_RXFLAG) {
    826       p_port->rx_flag_ev_pending = true;
    827     }
    828     return;
    829   }
    830 
    831   events |= PORT_EV_RXCHAR;
    832 
    833   /* Mask out all events that are not of interest to user */
    834   events &= p_port->ev_mask;
    835 
    836   if (p_port->p_callback && events) p_port->p_callback(events, p_port->inx);
    837 }
    838 
    839 /*******************************************************************************
    840  *
    841  * Function         PORT_FlowInd
    842  *
    843  * Description      This function is called from the RFCOMM layer on the flow
    844  *                  control signal change.  Propagate change to the user.
    845  *
    846  ******************************************************************************/
    847 void PORT_FlowInd(tRFC_MCB* p_mcb, uint8_t dlci, bool enable_data) {
    848   tPORT* p_port = (tPORT*)NULL;
    849   uint32_t events = 0;
    850   int i;
    851 
    852   RFCOMM_TRACE_EVENT("PORT_FlowInd fc:%d", enable_data);
    853 
    854   if (dlci == 0) {
    855     p_mcb->peer_ready = enable_data;
    856   } else {
    857     p_port = port_find_mcb_dlci_port(p_mcb, dlci);
    858     if (p_port == NULL) return;
    859 
    860     p_port->tx.peer_fc = !enable_data;
    861   }
    862 
    863   for (i = 0; i < MAX_RFC_PORTS; i++) {
    864     /* If DLCI is 0 event applies to all ports */
    865     if (dlci == 0) {
    866       p_port = &rfc_cb.port.port[i];
    867       if (!p_port->in_use || (p_port->rfc.p_mcb != p_mcb) ||
    868           (p_port->rfc.state != RFC_STATE_OPENED))
    869         continue;
    870     }
    871     events = 0;
    872 
    873     /* Check if flow of data is still enabled */
    874     events |= port_flow_control_user(p_port);
    875 
    876     /* Check if data can be sent and send it */
    877     events |= port_rfc_send_tx_data(p_port);
    878 
    879     /* Mask out all events that are not of interest to user */
    880     events &= p_port->ev_mask;
    881 
    882     /* Send event to the application */
    883     if (p_port->p_callback && events) (p_port->p_callback)(events, p_port->inx);
    884 
    885     /* If DLCI is not 0 event applies to one port only */
    886     if (dlci != 0) break;
    887   }
    888 }
    889 
    890 /*******************************************************************************
    891  *
    892  * Function         port_rfc_send_tx_data
    893  *
    894  * Description      This function is when forward data can be sent to the peer
    895  *
    896  ******************************************************************************/
    897 uint32_t port_rfc_send_tx_data(tPORT* p_port) {
    898   uint32_t events = 0;
    899   BT_HDR* p_buf;
    900 
    901   /* if there is data to be sent */
    902   if (p_port->tx.queue_size > 0) {
    903     /* while the rfcomm peer is not flow controlling us, and peer is ready */
    904     while (!p_port->tx.peer_fc && p_port->rfc.p_mcb &&
    905            p_port->rfc.p_mcb->peer_ready) {
    906       /* get data from tx queue and send it */
    907       mutex_global_lock();
    908 
    909       p_buf = (BT_HDR*)fixed_queue_try_dequeue(p_port->tx.queue);
    910       if (p_buf != NULL) {
    911         p_port->tx.queue_size -= p_buf->len;
    912 
    913         mutex_global_unlock();
    914 
    915         RFCOMM_TRACE_DEBUG("Sending RFCOMM_DataReq tx.queue_size=%d",
    916                            p_port->tx.queue_size);
    917 
    918         RFCOMM_DataReq(p_port->rfc.p_mcb, p_port->dlci, p_buf);
    919 
    920         events |= PORT_EV_TXCHAR;
    921 
    922         if (p_port->tx.queue_size == 0) {
    923           events |= PORT_EV_TXEMPTY;
    924           break;
    925         }
    926       }
    927       /* queue is empty-- all data sent */
    928       else {
    929         mutex_global_unlock();
    930 
    931         events |= PORT_EV_TXEMPTY;
    932         break;
    933       }
    934     }
    935     /* If we flow controlled user based on the queue size enable data again */
    936     events |= port_flow_control_user(p_port);
    937   }
    938   return (events & p_port->ev_mask);
    939 }
    940 
    941 /*******************************************************************************
    942  *
    943  * Function         port_rfc_closed
    944  *
    945  * Description      Called when RFCOMM port is closed
    946  *
    947  ******************************************************************************/
    948 void port_rfc_closed(tPORT* p_port, uint8_t res) {
    949   uint8_t old_signals;
    950   uint32_t events = 0;
    951   tRFC_MCB* p_mcb = p_port->rfc.p_mcb;
    952 
    953   if ((p_port->state == PORT_STATE_OPENING) && (p_port->is_server)) {
    954     /* The server side was not informed that connection is up, ignore */
    955     RFCOMM_TRACE_WARNING("port_rfc_closed in OPENING state ignored");
    956 
    957     rfc_port_timer_stop(p_port);
    958     p_port->rfc.state = RFC_STATE_CLOSED;
    959 
    960     if (p_mcb) {
    961       p_mcb->port_inx[p_port->dlci] = 0;
    962 
    963       /* If there are no more ports opened on this MCB release it */
    964       rfc_check_mcb_active(p_mcb);
    965       p_port->rfc.p_mcb = NULL;
    966     }
    967 
    968     /* Need to restore DLCI to listening state
    969      * if the server was on the initiating RFC
    970      */
    971     p_port->dlci &= 0xfe;
    972 
    973     return;
    974   }
    975 
    976   if ((p_port->state != PORT_STATE_CLOSING) &&
    977       (p_port->state != PORT_STATE_CLOSED)) {
    978     p_port->line_status |= LINE_STATUS_FAILED;
    979 
    980     old_signals = p_port->peer_ctrl.modem_signal;
    981 
    982     p_port->peer_ctrl.modem_signal &=
    983         ~(PORT_DTRDSR_ON | PORT_CTSRTS_ON | PORT_DCD_ON);
    984 
    985     events |= port_get_signal_changes(p_port, old_signals,
    986                                       p_port->peer_ctrl.modem_signal);
    987 
    988     if (p_port->ev_mask & PORT_EV_CONNECT_ERR) events |= PORT_EV_CONNECT_ERR;
    989   }
    990 
    991   if ((p_port->p_callback != NULL) && events)
    992     p_port->p_callback(events, p_port->inx);
    993 
    994   if (p_port->p_mgmt_callback) p_port->p_mgmt_callback(res, p_port->inx);
    995 
    996   p_port->rfc.state = RFC_STATE_CLOSED;
    997 
    998   RFCOMM_TRACE_WARNING(
    999       "%s: RFCOMM connection closed, index=%d, state=%d reason=%s[%d], "
   1000       "UUID=%04X, bd_addr=%s, is_server=%d",
   1001       __func__, p_port->inx, p_port->state, PORT_GetResultString(res), res,
   1002       p_port->uuid, p_port->bd_addr.ToString().c_str(), p_port->is_server);
   1003 
   1004   port_release_port(p_port);
   1005 }
   1006 
   1007 /*******************************************************************************
   1008  *
   1009  * Function         port_get_credits
   1010  *
   1011  * Description      Set initial values for credits.
   1012  *                  Adjust max number of rx credits based on negotiated MTU.
   1013  *                  Check max allowed num of bytes, max allowed num buffers,
   1014  *                  should be less then 255
   1015  *
   1016  ******************************************************************************/
   1017 void port_get_credits(tPORT* p_port, uint8_t k) {
   1018   p_port->credit_tx = k;
   1019   if (p_port->credit_tx == 0) p_port->tx.peer_fc = true;
   1020 }
   1021