granicus.if.org Git - esp-idf/blob - components/bt/bluedroid/stack/rfcomm/include/rfc_int.h

   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 definitions internal to the RFC unit
  22  *
  23  *****************************************************************************/
  24
  25 #ifndef RFC_INT_H
  26 #define RFC_INT_H
  27
  28 #include "l2c_api.h"
  29 #include "port_int.h"
  30
  31 /*
  32 ** Define RFCOMM result codes
  33 */
  34 #define RFCOMM_SUCCESS          0
  35 #define RFCOMM_ERROR            1
  36 #define RFCOMM_LOW_RESOURCES    2
  37 #define RFCOMM_TRY_LATER        3
  38
  39 #define RFCOMM_USER_ERR         111
  40 #define RFCOMM_SECURITY_ERR     112
  41
  42 /*
  43 ** Define max and min RFCOMM MTU (N1)
  44 */
  45 #define RFCOMM_MIN_MTU          23
  46 #define RFCOMM_MAX_MTU          32767
  47
  48 extern void RFCOMM_StartReq (tRFC_MCB *p_mcb);
  49 extern void RFCOMM_StartRsp (tRFC_MCB *p_mcb, UINT16 result);
  50
  51 extern void RFCOMM_DlcEstablishReq (tRFC_MCB *p_mcb, UINT8 dlci, UINT16 mtu);
  52 extern void RFCOMM_DlcEstablishRsp (tRFC_MCB *p_mcb, UINT8 dlci, UINT16 mtu, UINT16 result);
  53
  54 extern void RFCOMM_DataReq (tRFC_MCB *p_mcb, UINT8 dlci, BT_HDR *p_buf);
  55
  56 extern void RFCOMM_DlcReleaseReq (tRFC_MCB *p_mcb, UINT8 dlci);
  57
  58 extern void RFCOMM_ParNegReq (tRFC_MCB *p_mcb, UINT8 dlci, UINT16 mtu);
  59 extern void RFCOMM_ParNegRsp (tRFC_MCB *p_mcb, UINT8 dlci, UINT16 mtu, UINT8 cl, UINT8 k);
  60
  61 extern void RFCOMM_TestReq (UINT8 *p_data, UINT16 len);
  62
  63 #define RFCOMM_FLOW_STATE_DISABLE       0
  64 #define RFCOMM_FLOW_STATE_ENABLE        1
  65
  66 extern void RFCOMM_FlowReq (tRFC_MCB *p_mcb, UINT8 dlci, UINT8 state);
  67
  68 extern void RFCOMM_PortNegReq (tRFC_MCB *p_mcb, UINT8 dlci, tPORT_STATE *p_pars);
  69 extern void RFCOMM_PortNegRsp (tRFC_MCB *p_mcb, UINT8 dlci, tPORT_STATE *p_pars, UINT16 param_mask);
  70
  71 extern void RFCOMM_ControlReq (tRFC_MCB *p_mcb, UINT8 dlci, tPORT_CTRL *p_pars);
  72 extern void RFCOMM_ControlRsp (tRFC_MCB *p_mcb, UINT8 dlci, tPORT_CTRL *p_pars);
  73
  74 extern void RFCOMM_LineStatusReq (tRFC_MCB *p_mcb, UINT8 dlci, UINT8 line_status);
  75 /*
  76 ** Define logical struct used for sending and decoding MX frames
  77 */
  78 typedef struct {
  79     UINT8   dlci;
  80     UINT8   type;
  81     UINT8   cr;
  82     UINT8   ea;
  83     UINT8   pf;
  84     UINT8   credit;
  85
  86     union {
  87         struct {
  88             UINT8 dlci;
  89             UINT8 frame_type;
  90             UINT8 conv_layer;
  91             UINT8 priority;
  92             UINT8 t1;
  93             UINT16 mtu;
  94             UINT8 n2;
  95             UINT8 k;
  96         } pn;
  97         struct {
  98             UINT8   *p_data;
  99             UINT16  data_len;
 100         } test;
 101         struct {
 102             UINT8 dlci;
 103             UINT8 signals;
 104             UINT8 break_present;
 105             UINT8 break_duration;
 106         } msc;
 107         struct {
 108             UINT8 ea;
 109             UINT8 cr;
 110             UINT8 type;
 111         } nsc;
 112         struct {
 113             UINT8 dlci;
 114             UINT8 is_request;
 115             UINT8 baud_rate;
 116             UINT8 byte_size;
 117             UINT8 stop_bits;
 118             UINT8 parity;
 119             UINT8 parity_type;
 120             UINT8 fc_type;
 121             UINT8 xon_char;
 122             UINT8 xoff_char;
 123             UINT16 param_mask;
 124         } rpn;
 125         struct {
 126             UINT8 dlci;
 127             UINT8 line_status;
 128         } rls;
 129     } u;
 130 } MX_FRAME;
 131
 132 #define LINE_STATUS_NO_ERROR       0x00
 133 #define LINE_STATUS_OVERRUN        0x02  /* Receive Overrun Error   */
 134 #define LINE_STATUS_RXPARITY       0x04  /* Receive Parity Error    */
 135 #define LINE_STATUS_FRAME          0x08  /* Receive Framing error   */
 136 #define LINE_STATUS_FAILED         0x10  /* Connection Failed       */
 137
 138 /*
 139 ** Define states and events for the RFC multiplexer state machine
 140 */
 141 #define RFC_MX_STATE_IDLE           0
 142 #define RFC_MX_STATE_WAIT_CONN_CNF  1
 143 #define RFC_MX_STATE_CONFIGURE      2
 144 #define RFC_MX_STATE_SABME_WAIT_UA  3
 145 #define RFC_MX_STATE_WAIT_SABME     4
 146 #define RFC_MX_STATE_CONNECTED      5
 147 #define RFC_MX_STATE_DISC_WAIT_UA   6
 148
 149 /*
 150 ** Define port states
 151 */
 152 #define RFC_STATE_CLOSED                0
 153 #define RFC_STATE_SABME_WAIT_UA         1
 154 #define RFC_STATE_ORIG_WAIT_SEC_CHECK   2
 155 #define RFC_STATE_TERM_WAIT_SEC_CHECK   3
 156 #define RFC_STATE_OPENED                4
 157 #define RFC_STATE_DISC_WAIT_UA          5
 158
 159 /*
 160 ** Events that can be received by multiplexer as well as port state machines
 161 */
 162 #define RFC_EVENT_SABME                 0
 163 #define RFC_EVENT_UA                    1
 164 #define RFC_EVENT_DM                    2
 165 #define RFC_EVENT_DISC                  3
 166 #define RFC_EVENT_UIH                   4
 167 #define RFC_EVENT_TIMEOUT               5
 168 #define RFC_EVENT_BAD_FRAME             50
 169 /*
 170 ** Multiplexer events
 171 */
 172 #define RFC_MX_EVENT_START_REQ          6
 173 #define RFC_MX_EVENT_START_RSP          7
 174 #define RFC_MX_EVENT_CLOSE_REQ          8
 175 #define RFC_MX_EVENT_CONN_CNF           9
 176 #define RFC_MX_EVENT_CONN_IND           10
 177 #define RFC_MX_EVENT_CONF_CNF           11
 178 #define RFC_MX_EVENT_CONF_IND           12
 179 #define RFC_MX_EVENT_QOS_VIOLATION_IND  13
 180 #define RFC_MX_EVENT_DISC_IND           14
 181 #define RFC_MX_EVENT_TEST_CMD           15
 182 #define RFC_MX_EVENT_TEST_RSP           16
 183 #define RFC_MX_EVENT_FCON_CMD           17
 184 #define RFC_MX_EVENT_FCOFF_CMD          18
 185 #define RFC_MX_EVENT_NSC                19
 186 #define RFC_MX_EVENT_NSC_RSP            20
 187
 188 /*
 189 ** Port events
 190 */
 191 #define RFC_EVENT_OPEN                  9
 192 #define RFC_EVENT_ESTABLISH_RSP         11
 193 #define RFC_EVENT_CLOSE                 12
 194 #define RFC_EVENT_CLEAR                 13
 195 #define RFC_EVENT_DATA                  14
 196 #define RFC_EVENT_SEC_COMPLETE          15
 197
 198 // btla-specific ++
 199 #define RFC_T1_TIMEOUT                  20   /* seconds to wait for reply with Poll bit */
 200 #define RFC_PORT_T1_TIMEOUT             60   /* seconds to wait for reply with Poll bit other than MX */
 201 #define RFC_T2_TIMEOUT                  20   /* timeout to wait for Mx UIH */
 202 // btla-specific --
 203 #define RFC_DISC_TIMEOUT                3    /* If something goes wrong and we send DISC we should not wait for min */
 204 #define RFC_CLOSE_TIMEOUT               10
 205 #define RFCOMM_CONN_TIMEOUT            120   /* first connection to be established on Mx */
 206
 207
 208 /* Define RFComm control block
 209 */
 210 typedef struct {
 211     MX_FRAME  rx_frame;
 212     tL2CAP_APPL_INFO  reg_info;              /* L2CAP Registration info */
 213     tRFC_MCB *p_rfc_lcid_mcb[MAX_L2CAP_CHANNELS];     /* MCB based on the L2CAP's lcid */
 214     BOOLEAN   peer_rx_disabled;              /* If TRUE peer sent FCOFF */
 215     UINT8     last_mux;                      /* Last mux allocated */
 216     UINT8     last_port;                     /* Last port allocated */
 217 } tRFCOMM_CB;
 218
 219 /* Main Control Block for the RFCOMM Layer (PORT and RFC) */
 220 typedef struct {
 221     tRFCOMM_CB  rfc;
 222     tPORT_CB    port;
 223     UINT8       trace_level;
 224 } tRFC_CB;
 225
 226
 227 #if RFC_DYNAMIC_MEMORY == FALSE
 228 extern tRFC_CB  rfc_cb;
 229 #else
 230 extern tRFC_CB *rfc_cb_ptr;
 231 #define rfc_cb (*rfc_cb_ptr)
 232 #endif
 233
 234 /* Timer running on the multiplexor channel while no DLCI connection is opened */
 235 #define RFC_MCB_INIT_INACT_TIMER    60  /* in seconds */
 236
 237 /* Timer running on the multiplexor channel after last DLCI is released */
 238 #define RFC_MCB_RELEASE_INACT_TIMER 2   /* in seconds */
 239
 240 /*
 241 ** Define RFCOMM frame processing errors
 242 */
 243 #define RFCOMM_ERR_BAD_SABME        1
 244 #define RFCOMM_ERR_BAD_UA           2
 245 #define RFCOMM_ERR_BAD_DM           3
 246 #define RFCOMM_ERR_BAD_DISC         4
 247 #define RFCOMM_ERR_BAD_UIH          5
 248
 249 #ifdef RFCOMM_PRECALC_FCS
 250
 251 #define RFCOMM_SABME_FCS(p_data, cr, dlci) rfc_sabme_fcs[cr][dlci]
 252 #define RFCOMM_UA_FCS(p_data, cr, dlci)    rfc_ua_fcs[cr][dlci]
 253 #define RFCOMM_DM_FCS(p_data, cr, dlci)    rfc_dm_fcs[cr][dlci]
 254 #define RFCOMM_DISC_FCS(p_data, cr, dlci)  rfc_disc_fcs[cr][dlci]
 255 #define RFCOMM_UIH_FCS(p_data, dlci)       rfc_uih_fcs[dlci]
 256
 257 #else
 258
 259 extern  UINT8 rfc_calc_fcs (UINT16 len, UINT8 *p);
 260
 261 #define RFCOMM_SABME_FCS(p_data, cr, dlci) rfc_calc_fcs(3, p_data)
 262 #define RFCOMM_UA_FCS(p_data, cr, dlci)    rfc_calc_fcs(3, p_data)
 263 #define RFCOMM_DM_FCS(p_data, cr, dlci)    rfc_calc_fcs(3, p_data)
 264 #define RFCOMM_DISC_FCS(p_data, cr, dlci)  rfc_calc_fcs(3, p_data)
 265 #define RFCOMM_UIH_FCS(p_data, dlci)       rfc_calc_fcs(2, p_data)
 266
 267 #endif
 268
 269
 270 #ifdef __cplusplus
 271 extern "C" {
 272 #endif
 273
 274 extern void rfc_mx_sm_execute (tRFC_MCB *p_mcb, UINT16 event, void *p_data);
 275
 276 /*
 277 ** Functions provided by the rfc_port_fsm.c
 278 */
 279 extern void rfc_port_sm_execute (tPORT *p_port, UINT16 event, void *p_data);
 280
 281
 282 extern void rfc_process_pn (tRFC_MCB *p_rfc_mcb, BOOLEAN is_command, MX_FRAME *p_frame);
 283 extern void rfc_process_msc (tRFC_MCB *p_rfc_mcb, BOOLEAN is_command, MX_FRAME *p_frame);
 284 extern void rfc_process_rpn (tRFC_MCB *p_rfc_mcb, BOOLEAN is_command, BOOLEAN is_request, MX_FRAME *p_frame);
 285 extern void rfc_process_rls (tRFC_MCB *p_rfc_mcb, BOOLEAN is_command, MX_FRAME *p_frame);
 286 extern void rfc_process_nsc (tRFC_MCB *p_rfc_mcb, MX_FRAME *p_frame);
 287 extern void rfc_process_test_rsp (tRFC_MCB *p_rfc_mcb, BT_HDR *p_buf);
 288 extern void rfc_process_fcon (tRFC_MCB *p_rfc_mcb, BOOLEAN is_command);
 289 extern void rfc_process_fcoff (tRFC_MCB *p_rfc_mcb, BOOLEAN is_command);
 290 extern void rfc_process_l2cap_congestion (tRFC_MCB *p_mcb, BOOLEAN is_congested);
 291
 292 /*
 293 ** Functions provided by the rfc_utils.c
 294 */
 295 tRFC_MCB  *rfc_alloc_multiplexer_channel (BD_ADDR bd_addr, BOOLEAN is_initiator);
 296 extern void      rfc_release_multiplexer_channel (tRFC_MCB *p_rfc_mcb);
 297 extern void      rfc_timer_start (tRFC_MCB *p_rfc_mcb, UINT16 timeout);
 298 extern void      rfc_timer_stop (tRFC_MCB *p_rfc_mcb);
 299 extern void      rfc_port_timer_start (tPORT *p_port, UINT16 tout);
 300 extern void      rfc_port_timer_stop (tPORT *p_port);
 301
 302 BOOLEAN   rfc_check_uih_fcs (UINT8 dlci, UINT8 received_fcs);
 303 BOOLEAN   rfc_check_fcs (UINT16 len, UINT8 *p, UINT8 received_fcs);
 304 tRFC_MCB  *rfc_find_lcid_mcb (UINT16 lcid);
 305 extern void      rfc_save_lcid_mcb (tRFC_MCB *p_rfc_mcb, UINT16 lcid);
 306 extern void      rfc_check_mcb_active (tRFC_MCB *p_mcb);
 307 extern void      rfc_port_closed (tPORT *p_port);
 308 extern void      rfc_sec_check_complete (BD_ADDR bd_addr, tBT_TRANSPORT transport, void *p_ref_data, UINT8 res);
 309 extern void      rfc_inc_credit (tPORT *p_port, UINT8 credit);
 310 extern void      rfc_dec_credit (tPORT *p_port);
 311 extern void      rfc_check_send_cmd(tRFC_MCB *p_mcb, BT_HDR *p_buf);
 312
 313 /*
 314 ** Functions provided by the rfc_ts_frames.c
 315 */
 316 extern void     rfc_send_sabme (tRFC_MCB *p_rfc_mcb, UINT8 dlci);
 317 extern void     rfc_send_ua (tRFC_MCB *p_rfc_mcb, UINT8 dlci);
 318 extern void     rfc_send_dm (tRFC_MCB *p_rfc_mcb, UINT8 dlci, BOOLEAN pf);
 319 extern void     rfc_send_disc (tRFC_MCB *p_rfc_mcb, UINT8 dlci);
 320 extern void     rfc_send_pn (tRFC_MCB *p_mcb, UINT8 dlci, BOOLEAN is_command, UINT16 mtu,
 321                              UINT8 cl, UINT8 k);
 322 extern void     rfc_send_test (tRFC_MCB *p_rfc_mcb, BOOLEAN is_command, BT_HDR *p_buf);
 323 extern void     rfc_send_msc (tRFC_MCB *p_mcb, UINT8 dlci, BOOLEAN is_command,
 324                               tPORT_CTRL *p_pars);
 325 extern void     rfc_send_rls (tRFC_MCB *p_mcb, UINT8 dlci, BOOLEAN is_command, UINT8 status);
 326 extern void     rfc_send_rpn (tRFC_MCB *p_mcb, UINT8 dlci, BOOLEAN is_command,
 327                               tPORT_STATE *p_pars, UINT16 mask);
 328 extern void     rfc_send_fcon (tRFC_MCB *p_mcb, BOOLEAN is_command);
 329 extern void     rfc_send_fcoff (tRFC_MCB *p_mcb, BOOLEAN is_command);
 330 extern void     rfc_send_buf_uih (tRFC_MCB *p_rfc_mcb, UINT8 dlci, BT_HDR *p_buf);
 331 extern void     rfc_send_credit(tRFC_MCB *p_mcb, UINT8 dlci, UINT8 credit);
 332 extern void     rfc_process_mx_message (tRFC_MCB *p_rfc_mcb, BT_HDR *p_buf);
 333 extern UINT8    rfc_parse_data (tRFC_MCB *p_rfc_mcb, MX_FRAME *p_frame, BT_HDR *p_buf);
 334
 335 /*
 336 ** Functions provided by the rfc_disp.c
 337 */
 338
 339
 340
 341 /* Call back functions from RFCOMM */
 342 extern void rfcomm_l2cap_if_init (void);
 343
 344 extern void PORT_StartInd (tRFC_MCB *p_mcb);
 345 extern void PORT_StartCnf (tRFC_MCB *p_mcb, UINT16 result);
 346
 347 extern void PORT_CloseInd (tRFC_MCB *p_mcb);
 348 extern void Port_TimeOutCloseMux (tRFC_MCB *p_mcb);
 349
 350 extern void PORT_DlcEstablishInd (tRFC_MCB *p_mcb, UINT8 dlci, UINT16 mtu);
 351 extern void PORT_DlcEstablishCnf (tRFC_MCB *p_mcb, UINT8 dlci, UINT16 mtu, UINT16 result);
 352
 353 extern void PORT_DataInd (tRFC_MCB *p_mcb, UINT8 dlci, BT_HDR *p_buf);
 354
 355 extern void PORT_DlcReleaseInd (tRFC_MCB *p_mcb, UINT8 dlci);
 356
 357 extern void PORT_ParNegInd (tRFC_MCB *p_mcb, UINT8 dlci, UINT16 mtu, UINT8 cl, UINT8 k);
 358 extern void PORT_ParNegCnf (tRFC_MCB *p_mcb, UINT8 dlci, UINT16 mtu, UINT8 cl, UINT8 k);
 359
 360 extern void PORT_TestCnf (tRFC_MCB *p_mcb, UINT8 *p_data, UINT16 len);
 361
 362 extern void PORT_FlowInd (tRFC_MCB *p_mcb, UINT8 dlci, BOOLEAN fc);
 363
 364 extern void PORT_PortNegInd (tRFC_MCB *p_mcb, UINT8 dlci, tPORT_STATE *p_pars, UINT16 param_mask);
 365 extern void PORT_PortNegCnf (tRFC_MCB *p_mcb, UINT8 dlci, tPORT_STATE *p_pars, UINT16 result);
 366
 367 extern void PORT_ControlInd (tRFC_MCB *p_mcb, UINT8 dlci, tPORT_CTRL *p_pars);
 368 extern void PORT_ControlCnf (tRFC_MCB *p_mcb, UINT8 dlci, tPORT_CTRL *p_pars);
 369
 370 extern void PORT_LineStatusInd (tRFC_MCB *p_mcb, UINT8 dlci, UINT8 line_status);
 371
 372 #ifdef __cplusplus
 373 }
 374 #endif
 375
 376 #endif