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