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