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 the PORT API definitions
22  *
23  ******************************************************************************/
24 #ifndef PORT_API_H
25 #define PORT_API_H
26 
27 #include "common/bt_target.h"
28 #include "common/bt_defs.h"
29 
30 /*****************************************************************************
31 **  Constants and Types
32 *****************************************************************************/
33 
34 /*
35 ** Define port settings structure send from the application in the
36 ** set settings request, or to the application in the set settings indication.
37 */
38 typedef struct {
39 
40 #define PORT_BAUD_RATE_2400       0x00
41 #define PORT_BAUD_RATE_4800       0x01
42 #define PORT_BAUD_RATE_7200       0x02
43 #define PORT_BAUD_RATE_9600       0x03
44 #define PORT_BAUD_RATE_19200      0x04
45 #define PORT_BAUD_RATE_38400      0x05
46 #define PORT_BAUD_RATE_57600      0x06
47 #define PORT_BAUD_RATE_115200     0x07
48 #define PORT_BAUD_RATE_230400     0x08
49 
50     UINT8  baud_rate;
51 
52 #define PORT_5_BITS               0x00
53 #define PORT_6_BITS               0x01
54 #define PORT_7_BITS               0x02
55 #define PORT_8_BITS               0x03
56 
57     UINT8  byte_size;
58 
59 #define PORT_ONESTOPBIT           0x00
60 #define PORT_ONE5STOPBITS         0x01
61     UINT8   stop_bits;
62 
63 #define PORT_PARITY_NO            0x00
64 #define PORT_PARITY_YES           0x01
65     UINT8   parity;
66 
67 #define PORT_ODD_PARITY           0x00
68 #define PORT_EVEN_PARITY          0x01
69 #define PORT_MARK_PARITY          0x02
70 #define PORT_SPACE_PARITY         0x03
71 
72     UINT8   parity_type;
73 
74 #define PORT_FC_OFF               0x00
75 #define PORT_FC_XONXOFF_ON_INPUT  0x01
76 #define PORT_FC_XONXOFF_ON_OUTPUT 0x02
77 #define PORT_FC_CTS_ON_INPUT      0x04
78 #define PORT_FC_CTS_ON_OUTPUT     0x08
79 #define PORT_FC_DSR_ON_INPUT      0x10
80 #define PORT_FC_DSR_ON_OUTPUT     0x20
81 
82     UINT8 fc_type;
83 
84     UINT8 rx_char1;
85 
86 #define PORT_XON_DC1              0x11
87     UINT8 xon_char;
88 
89 #define PORT_XOFF_DC3             0x13
90     UINT8 xoff_char;
91 
92 } tPORT_STATE;
93 
94 
95 /*
96 ** Define the callback function prototypes.  Parameters are specific
97 ** to each event and are described bellow
98 */
99 typedef int  (tPORT_DATA_CALLBACK) (UINT16 port_handle, void *p_data, UINT16 len);
100 
101 #define DATA_CO_CALLBACK_TYPE_INCOMING          1
102 #define DATA_CO_CALLBACK_TYPE_OUTGOING_SIZE     2
103 #define DATA_CO_CALLBACK_TYPE_OUTGOING          3
104 typedef int  (tPORT_DATA_CO_CALLBACK) (UINT16 port_handle, UINT8 *p_buf, UINT16 len, int type);
105 
106 typedef void (tPORT_CALLBACK) (UINT32 code, UINT16 port_handle);
107 
108 typedef void (tPORT_MGMT_CALLBACK) (UINT32 code, UINT16 port_handle, void* data);
109 
110 /**
111  * Define the server port manage callback function argument
112  */
113 typedef struct {
114     BOOLEAN accept; /* If upper layer accepts the incoming connection */
115     BOOLEAN ignore_rfc_state; /* If need to ignore rfc state for PORT_CheckConnection */
116 } tPORT_MGMT_SR_CALLBACK_ARG;
117 
118 /*
119 ** Define events that registered application can receive in the callback
120 */
121 
122 #define PORT_EV_RXCHAR  0x00000001   /* Any Character received */
123 #define PORT_EV_RXFLAG  0x00000002   /* Received certain character */
124 #define PORT_EV_TXEMPTY 0x00000004   /* Transmitt Queue Empty */
125 #define PORT_EV_CTS     0x00000008   /* CTS changed state */
126 #define PORT_EV_DSR     0x00000010   /* DSR changed state */
127 #define PORT_EV_RLSD    0x00000020   /* RLSD changed state */
128 #define PORT_EV_BREAK   0x00000040   /* BREAK received */
129 #define PORT_EV_ERR     0x00000080   /* Line status error occurred */
130 #define PORT_EV_RING    0x00000100   /* Ring signal detected */
131 #define PORT_EV_CTSS    0x00000400   /* CTS state */
132 #define PORT_EV_DSRS    0x00000800   /* DSR state */
133 #define PORT_EV_RLSDS   0x00001000   /* RLSD state */
134 #define PORT_EV_OVERRUN 0x00002000   /* receiver buffer overrun */
135 #define PORT_EV_TXCHAR  0x00004000   /* Any character transmitted */
136 
137 #define PORT_EV_CONNECTED    0x00000200  /* RFCOMM connection established */
138 #define PORT_EV_CONNECT_ERR  0x00008000  /* Was not able to establish connection */
139 /* or disconnected */
140 #define PORT_EV_FC      0x00010000   /* data flow enabled flag changed by remote */
141 #define PORT_EV_FCS     0x00020000   /* data flow enable status true = enabled */
142 
143 /*
144 ** To register for events application should provide bitmask with
145 ** corresponding bit set
146 */
147 
148 #define PORT_MASK_ALL             (PORT_EV_RXCHAR | PORT_EV_TXEMPTY | PORT_EV_CTS | \
149                                    PORT_EV_DSR | PORT_EV_RLSD | PORT_EV_BREAK | \
150                                    PORT_EV_ERR | PORT_EV_RING | PORT_EV_CONNECT_ERR | \
151                                    PORT_EV_DSRS | PORT_EV_CTSS | PORT_EV_RLSDS | \
152                                    PORT_EV_RXFLAG | PORT_EV_TXCHAR | PORT_EV_OVERRUN | \
153                                    PORT_EV_FC | PORT_EV_FCS | PORT_EV_CONNECTED)
154 
155 
156 /*
157 ** Define port result codes
158 */
159 #define PORT_SUCCESS                0
160 
161 #define PORT_ERR_BASE               0
162 
163 #define PORT_UNKNOWN_ERROR          (PORT_ERR_BASE + 1)
164 #define PORT_ALREADY_OPENED         (PORT_ERR_BASE + 2)
165 #define PORT_CMD_PENDING            (PORT_ERR_BASE + 3)
166 #define PORT_APP_NOT_REGISTERED     (PORT_ERR_BASE + 4)
167 #define PORT_NO_MEM                 (PORT_ERR_BASE + 5)
168 #define PORT_NO_RESOURCES           (PORT_ERR_BASE + 6)
169 #define PORT_BAD_BD_ADDR            (PORT_ERR_BASE + 7)
170 #define PORT_BAD_HANDLE             (PORT_ERR_BASE + 9)
171 #define PORT_NOT_OPENED             (PORT_ERR_BASE + 10)
172 #define PORT_LINE_ERR               (PORT_ERR_BASE + 11)
173 #define PORT_START_FAILED           (PORT_ERR_BASE + 12)
174 #define PORT_PAR_NEG_FAILED         (PORT_ERR_BASE + 13)
175 #define PORT_PORT_NEG_FAILED        (PORT_ERR_BASE + 14)
176 #define PORT_SEC_FAILED             (PORT_ERR_BASE + 15)
177 #define PORT_PEER_CONNECTION_FAILED (PORT_ERR_BASE + 16)
178 #define PORT_PEER_FAILED            (PORT_ERR_BASE + 17)
179 #define PORT_PEER_TIMEOUT           (PORT_ERR_BASE + 18)
180 #define PORT_CLOSED                 (PORT_ERR_BASE + 19)
181 #define PORT_TX_FULL                (PORT_ERR_BASE + 20)
182 #define PORT_LOCAL_CLOSED           (PORT_ERR_BASE + 21)
183 #define PORT_LOCAL_TIMEOUT          (PORT_ERR_BASE + 22)
184 #define PORT_TX_QUEUE_DISABLED      (PORT_ERR_BASE + 23)
185 #define PORT_PAGE_TIMEOUT           (PORT_ERR_BASE + 24)
186 #define PORT_INVALID_SCN            (PORT_ERR_BASE + 25)
187 
188 #define PORT_ERR_MAX                (PORT_ERR_BASE + 26)
189 
190 /*****************************************************************************
191 **  External Function Declarations
192 *****************************************************************************/
193 #ifdef __cplusplus
194 extern "C"
195 {
196 #endif
197 
198 /*******************************************************************************
199 **
200 ** Function         RFCOMM_CreateConnection
201 **
202 ** Description      RFCOMM_CreateConnection function is used from the application
203 **                  to establish serial port connection to the peer device,
204 **                  or allow RFCOMM to accept a connection from the peer
205 **                  application.
206 **
207 ** Parameters:      scn          - Service Channel Number as registered with
208 **                                 the SDP (server) or obtained using SDP from
209 **                                 the peer device (client).
210 **                  is_server    - TRUE if requesting application is a server
211 **                  mtu          - Maximum frame size the application can accept
212 **                  bd_addr      - BD_ADDR of the peer (client)
213 **                  mask         - specifies events to be enabled.  A value
214 **                                 of zero disables all events.
215 **                  p_handle     - OUT pointer to the handle.
216 **                  p_mgmt_cb    - pointer to callback function to receive
217 **                                 connection up/down events.
218 ** Notes:
219 **
220 ** Server can call this function with the same scn parameter multiple times if
221 ** it is ready to accept multiple simulteneous connections.
222 **
223 ** DLCI for the connection is (scn * 2 + 1) if client originates connection on
224 ** existing none initiator multiplexer channel.  Otherwise it is (scn * 2).
225 ** For the server DLCI can be changed later if client will be calling it using
226 ** (scn * 2 + 1) dlci.
227 **
228 *******************************************************************************/
229 extern int RFCOMM_CreateConnection (UINT16 uuid, UINT8 scn,
230                                     BOOLEAN is_server, UINT16 mtu,
231                                     BD_ADDR bd_addr, UINT16 *p_handle,
232                                     tPORT_MGMT_CALLBACK *p_mgmt_cb);
233 
234 
235 /*******************************************************************************
236 **
237 ** Function         RFCOMM_RemoveConnection
238 **
239 ** Description      This function is called to close the specified connection.
240 **
241 ** Parameters:      handle     - Handle of the port returned in the Open
242 **
243 *******************************************************************************/
244 extern int RFCOMM_RemoveConnection (UINT16 handle);
245 
246 
247 /*******************************************************************************
248 **
249 ** Function         RFCOMM_RemoveServer
250 **
251 ** Description      This function is called to close the server port.
252 **
253 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
254 **
255 *******************************************************************************/
256 extern int RFCOMM_RemoveServer (UINT16 handle);
257 
258 
259 /*******************************************************************************
260 **
261 ** Function         PORT_SetEventCallback
262 **
263 ** Description      Set event callback the specified connection.
264 **
265 ** Parameters:      handle       - Handle of the port returned in the Open
266 **                  p_callback   - address of the callback function which should
267 **                                 be called from the RFCOMM when an event
268 **                                 specified in the mask occurs.
269 **
270 *******************************************************************************/
271 extern int PORT_SetEventCallback (UINT16 port_handle,
272                                   tPORT_CALLBACK *p_port_cb);
273 
274 /*******************************************************************************
275 **
276 ** Function         PORT_ClearKeepHandleFlag
277 **
278 ** Description      This function is called to clear the keep handle flag
279 **                  which will cause not to keep the port handle open when closed
280 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
281 **
282 *******************************************************************************/
283 int PORT_ClearKeepHandleFlag (UINT16 port_handle);
284 
285 /*******************************************************************************
286 **
287 ** Function         PORT_SetEventCallback
288 **
289 ** Description      Set event data callback the specified connection.
290 **
291 ** Parameters:      handle       - Handle of the port returned in the Open
292 **                  p_callback   - address of the callback function which should
293 **                                 be called from the RFCOMM when a data
294 **                                 packet is received.
295 **
296 *******************************************************************************/
297 extern int PORT_SetDataCallback (UINT16 port_handle,
298                                  tPORT_DATA_CALLBACK *p_cb);
299 
300 extern int PORT_SetDataCOCallback (UINT16 port_handle, tPORT_DATA_CO_CALLBACK *p_port_cb);
301 /*******************************************************************************
302 **
303 ** Function         PORT_SetEventMask
304 **
305 ** Description      This function is called to close the specified connection.
306 **
307 ** Parameters:      handle - Handle of the port returned in the Open
308 **                  mask   - specifies events to be enabled.  A value
309 **                           of zero disables all events.
310 **
311 *******************************************************************************/
312 extern int PORT_SetEventMask (UINT16 port_handle, UINT32 mask);
313 
314 
315 /*******************************************************************************
316 **
317 ** Function         PORT_CheckConnection
318 **
319 ** Description      This function returns PORT_SUCCESS if connection referenced
320 **                  by handle is up and running
321 **
322 ** Parameters:      handle     - Handle of the port returned in the Open
323 **                  ignore_rfc_state - If need to ignore rfc state
324 **                  bd_addr    - OUT bd_addr of the peer
325 **                  p_lcid     - OUT L2CAP's LCID
326 **
327 *******************************************************************************/
328 extern int PORT_CheckConnection (UINT16 handle, BOOLEAN ignore_rfc_state, BD_ADDR bd_addr,
329                                  UINT16 *p_lcid);
330 
331 /*******************************************************************************
332 **
333 ** Function         PORT_IsOpening
334 **
335 ** Description      This function returns TRUE if there is any RFCOMM connection
336 **                  opening in process.
337 **
338 ** Parameters:      TRUE if any connection opening is found
339 **                  bd_addr    - bd_addr of the peer
340 **
341 *******************************************************************************/
342 extern BOOLEAN PORT_IsOpening (BD_ADDR bd_addr);
343 
344 /*******************************************************************************
345 **
346 ** Function         PORT_SetState
347 **
348 ** Description      This function configures connection according to the
349 **                  specifications in the tPORT_STATE structure.
350 **
351 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
352 **                  p_settings - Pointer to a tPORT_STATE structure containing
353 **                               configuration information for the connection.
354 **
355 *******************************************************************************/
356 extern int PORT_SetState (UINT16 handle, tPORT_STATE *p_settings);
357 
358 /*******************************************************************************
359 **
360 ** Function         PORT_GetRxQueueCnt
361 **
362 ** Description      This function return number of buffers on the rx queue.
363 **
364 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
365 **                  p_rx_queue_count - Pointer to return queue count in.
366 **
367 *******************************************************************************/
368 extern int PORT_GetRxQueueCnt (UINT16 handle, UINT16 *p_rx_queue_count);
369 
370 /*******************************************************************************
371 **
372 ** Function         PORT_GetState
373 **
374 ** Description      This function is called to fill tPORT_STATE structure
375 **                  with the current control settings for the port
376 **
377 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
378 **                  p_settings - Pointer to a tPORT_STATE structure in which
379 **                               configuration information is returned.
380 **
381 *******************************************************************************/
382 extern int PORT_GetState (UINT16 handle, tPORT_STATE *p_settings);
383 
384 
385 /*******************************************************************************
386 **
387 ** Function         PORT_Control
388 **
389 ** Description      This function directs a specified connection to pass control
390 **                  control information to the peer device.
391 **
392 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
393 **                  signal     - specify the function to be passed
394 **
395 *******************************************************************************/
396 #define PORT_SET_DTRDSR         0x01
397 #define PORT_CLR_DTRDSR         0x02
398 #define PORT_SET_CTSRTS         0x03
399 #define PORT_CLR_CTSRTS         0x04
400 #define PORT_SET_RI             0x05        /* DCE only */
401 #define PORT_CLR_RI             0x06        /* DCE only */
402 #define PORT_SET_DCD            0x07        /* DCE only */
403 #define PORT_CLR_DCD            0x08        /* DCE only */
404 #define PORT_BREAK              0x09        /* Break event */
405 
406 extern int PORT_Control (UINT16 handle, UINT8 signal);
407 
408 
409 /*******************************************************************************
410 **
411 ** Function         PORT_FlowControl
412 **
413 ** Description      This function directs a specified connection to pass
414 **                  flow control message to the peer device.  Enable flag passed
415 **                  shows if port can accept more data.
416 **
417 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
418 **                  enable     - enables data flow
419 **
420 *******************************************************************************/
421 extern int PORT_FlowControl (UINT16 handle, BOOLEAN enable);
422 
423 /*******************************************************************************
424 **
425 ** Function         PORT_FlowControl_GiveCredit
426 **
427 ** Description      This function gives specified credits to the peer
428 **
429 ** Parameters:      handle        - Handle returned in the RFCOMM_CreateConnection
430 **                  enable        - enables data flow
431 **                  credits_given - credits to give
432 **
433 *******************************************************************************/
434 extern int PORT_FlowControl_GiveCredit (UINT16 handle, BOOLEAN enable, UINT16 credits_given);
435 /*******************************************************************************
436 **
437 ** Function         PORT_GetModemStatus
438 **
439 ** Description      This function retrieves modem control signals.  Normally
440 **                  application will call this function after a callback
441 **                  function is called with notification that one of signals
442 **                  has been changed.
443 **
444 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
445 **                               callback.
446 **                  p_signal   - specify the pointer to control signals info
447 **
448 *******************************************************************************/
449 #define PORT_DTRDSR_ON          0x01
450 #define PORT_CTSRTS_ON          0x02
451 #define PORT_RING_ON            0x04
452 #define PORT_DCD_ON             0x08
453 
454 /*
455 ** Define default initial local modem signals state set after connection established
456 */
457 #define PORT_OBEX_DEFAULT_SIGNAL_STATE  (PORT_DTRDSR_ON | PORT_CTSRTS_ON | PORT_DCD_ON)
458 #define PORT_SPP_DEFAULT_SIGNAL_STATE   (PORT_DTRDSR_ON | PORT_CTSRTS_ON | PORT_DCD_ON)
459 #define PORT_PPP_DEFAULT_SIGNAL_STATE   (PORT_DTRDSR_ON | PORT_CTSRTS_ON | PORT_DCD_ON)
460 #define PORT_DUN_DEFAULT_SIGNAL_STATE   (PORT_DTRDSR_ON | PORT_CTSRTS_ON)
461 
462 extern int PORT_GetModemStatus (UINT16 handle, UINT8 *p_control_signal);
463 
464 
465 /*******************************************************************************
466 **
467 ** Function         PORT_ClearError
468 **
469 ** Description      This function retreives information about a communications
470 **                  error and reports current status of a connection.  The
471 **                  function should be called when an error occures to clear
472 **                  the connection error flag and to enable additional read
473 **                  and write operations.
474 **
475 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
476 **                  p_errors   - pointer of the variable to receive error codes
477 **                  p_status   - pointer to the tPORT_STATUS structur to receive
478 **                               connection status
479 **
480 *******************************************************************************/
481 
482 #define PORT_ERR_BREAK      0x01    /* Break condition occured on the peer device */
483 #define PORT_ERR_OVERRUN    0x02    /* Overrun is reported by peer device */
484 #define PORT_ERR_FRAME      0x04    /* Framing error reported by peer device */
485 #define PORT_ERR_RXOVER     0x08    /* Input queue overflow occured */
486 #define PORT_ERR_TXFULL     0x10    /* Output queue overflow occured */
487 
488 typedef struct {
489 #define PORT_FLAG_CTS_HOLD  0x01    /* Tx is waiting for CTS signal */
490 #define PORT_FLAG_DSR_HOLD  0x02    /* Tx is waiting for DSR signal */
491 #define PORT_FLAG_RLSD_HOLD 0x04    /* Tx is waiting for RLSD signal */
492 
493     UINT16  flags;
494     UINT16  in_queue_size;          /* Number of bytes in the input queue */
495     UINT16  out_queue_size;         /* Number of bytes in the output queue */
496     UINT16  mtu_size;               /* peer MTU size */
497 } tPORT_STATUS;
498 
499 
500 extern int PORT_ClearError (UINT16 handle, UINT16 *p_errors,
501                             tPORT_STATUS *p_status);
502 
503 
504 /*******************************************************************************
505 **
506 ** Function         PORT_SendError
507 **
508 ** Description      This function send a communications error to the peer device
509 **
510 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
511 **                  errors     - receive error codes
512 **
513 *******************************************************************************/
514 extern int PORT_SendError (UINT16 handle, UINT8 errors);
515 
516 
517 /*******************************************************************************
518 **
519 ** Function         PORT_GetQueueStatus
520 **
521 ** Description      This function reports current status of a connection.
522 **
523 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
524 **                  p_status   - pointer to the tPORT_STATUS structur to receive
525 **                               connection status
526 **
527 *******************************************************************************/
528 extern int PORT_GetQueueStatus (UINT16 handle, tPORT_STATUS *p_status);
529 
530 
531 /*******************************************************************************
532 **
533 ** Function         PORT_Purge
534 **
535 ** Description      This function discards all the data from the output or
536 **                  input queues of the specified connection.
537 **
538 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
539 **                  purge_flags - specify the action to take.
540 **
541 *******************************************************************************/
542 #define PORT_PURGE_TXCLEAR  0x01
543 #define PORT_PURGE_RXCLEAR  0x02
544 
545 extern int PORT_Purge (UINT16 handle, UINT8 purge_flags);
546 
547 
548 /*******************************************************************************
549 **
550 ** Function         PORT_Read
551 **
552 ** Description      This function returns the pointer to the buffer received
553 **                  from the peer device.  Normally application will call this
554 **                  function after receiving PORT_EVT_RXCHAR event.
555 **                  Application calling this function is responsible to free
556 **                  buffer returned.
557 **
558 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
559 **                                callback.
560 **                  pp_buf      - pointer to address of buffer with data,
561 **
562 *******************************************************************************/
563 extern int PORT_Read (UINT16 handle, BT_HDR **pp_buf);
564 
565 
566 /*******************************************************************************
567 **
568 ** Function         PORT_ReadData
569 **
570 ** Description      Normally application will call this function after receiving
571 **                  PORT_EVT_RXCHAR event.
572 **
573 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
574 **                                callback.
575 **                  p_data      - Data area
576 **                  max_len     - Byte count requested
577 **                  p_len       - Byte count received
578 **
579 *******************************************************************************/
580 extern int PORT_ReadData (UINT16 handle, char *p_data, UINT16 max_len,
581                           UINT16 *p_len);
582 
583 
584 /*******************************************************************************
585 **
586 ** Function         PORT_Write
587 **
588 ** Description      This function to send BT buffer to the peer device.
589 **                  Application should not free the buffer.
590 **
591 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
592 **                  p_buf       - pointer to the buffer with data,
593 **
594 *******************************************************************************/
595 extern int PORT_Write (UINT16 handle, BT_HDR *p_buf);
596 
597 
598 /*******************************************************************************
599 **
600 ** Function         PORT_WriteData
601 **
602 ** Description      This function is called from the legacy application to
603 **                  send data.
604 **
605 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
606 **                  p_data      - Data area
607 **                  max_len     - Byte count to write
608 **                  p_len       - Bytes written
609 **
610 *******************************************************************************/
611 extern int PORT_WriteData (UINT16 handle, char *p_data, UINT16 max_len,
612                            UINT16 *p_len);
613 
614 /*******************************************************************************
615 **
616 ** Function         PORT_WriteDataCO
617 **
618 ** Description      Normally not GKI aware application will call this function
619 **                  to send data to the port by callout functions.
620 **
621 ** Parameters:      handle     - Handle returned in the RFCOMM_CreateConnection
622 **
623 *******************************************************************************/
624 extern int PORT_WriteDataCO (UINT16 handle, int *p_len, int len, UINT8 *p_data);
625 
626 /*******************************************************************************
627 **
628 ** Function         PORT_Test
629 **
630 ** Description      Application can call this function to send RFCOMM Test frame
631 **
632 ** Parameters:      handle      - Handle returned in the RFCOMM_CreateConnection
633 **                  p_data      - Data area
634 **                  max_len     - Byte count requested
635 **
636 *******************************************************************************/
637 extern int PORT_Test (UINT16 handle, UINT8 *p_data, UINT16 len);
638 
639 
640 /*******************************************************************************
641 **
642 ** Function         RFCOMM_Init
643 **
644 ** Description      This function is called to initialize RFCOMM layer
645 **
646 *******************************************************************************/
647 extern bt_status_t RFCOMM_Init (void);
648 
649 /*******************************************************************************
650 **
651 ** Function         RFCOMM_Deinit
652 **
653 ** Description      This function is called to deinitialize the control block
654 **                  for this layer.
655 **
656 ** Returns          void
657 **
658 *******************************************************************************/
659 extern void RFCOMM_Deinit(void);
660 
661 /*******************************************************************************
662 **
663 ** Function         PORT_SetTraceLevel
664 **
665 ** Description      This function sets the trace level for RFCOMM. If called with
666 **                  a value of 0xFF, it simply reads the current trace level.
667 **
668 ** Returns          the new (current) trace level
669 **
670 *******************************************************************************/
671 extern UINT8 PORT_SetTraceLevel (UINT8 new_level);
672 
673 
674 /*******************************************************************************
675 **
676 ** Function         PORT_GetResultString
677 **
678 ** Description      This function returns the human-readable string for a given
679 **                  result code.
680 **
681 ** Returns          a pointer to the human-readable string for the given
682 **                  result. Note that the string returned must not be freed.
683 **
684 *******************************************************************************/
685 extern const char *PORT_GetResultString (const uint8_t result_code);
686 
687 #ifdef __cplusplus
688 }
689 #endif
690 
691 #endif  /* PORT_API_H */
692