Cordio Stack and Cordio Profiles  r2p3-02rel0
hci_tr.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief HCI transport interface.
6  *
7  * Copyright (c) 2009-2018 Arm Ltd. All Rights Reserved.
8  * Arm Ltd. confidential and proprietary.
9  *
10  * IMPORTANT. Your use of this file is governed by a Software License Agreement
11  * ("Agreement") that must be accepted in order to download or otherwise receive a
12  * copy of this file. You may not use or copy this file for any purpose other than
13  * as described in the Agreement. If you do not agree to all of the terms of the
14  * Agreement do not use this file and delete all copies in your possession or control;
15  * if you do not have a copy of the Agreement, you must contact Arm Ltd. prior
16  * to any use, copying or further distribution of this software.
17  */
18 /*************************************************************************************************/
19 #ifndef HCI_TR_H
20 #define HCI_TR_H
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 /**************************************************************************************************
27  Function Declarations
28 **************************************************************************************************/
29 
30 /*************************************************************************************************/
31 /*!
32  * \brief Send a complete HCI ACL packet to the transport.
33  *
34  * \param pContext Connection context.
35  * \param pAclData WSF msg buffer containing an ACL packet.
36  *
37  * \return None.
38  */
39 /*************************************************************************************************/
40 void hciTrSendAclData(void *pContext, uint8_t *pAclData);
41 
42 /*************************************************************************************************/
43 /*!
44  * \brief Send a complete HCI command to the transport.
45  *
46  * \param pCmdData WSF msg buffer containing an HCI command.
47  *
48  * \return None.
49  */
50 /*************************************************************************************************/
51 void hciTrSendCmd(uint8_t *pCmdData);
52 
53 /*************************************************************************************************/
54 /*!
55  * \brief Initialize HCI transport resources.
56  *
57  * \param port COM port.
58  * \param baudRate Baud rate.
59  * \param flowControl TRUE if flow control is enabled
60  *
61  * \return TRUE if initialization succeeds, FALSE otherwise.
62  */
63 /*************************************************************************************************/
64 bool_t hciTrInit(uint8_t port, uint32_t baudRate, bool_t flowControl);
65 
66 /*************************************************************************************************/
67 /*!
68  * \brief Close HCI transport resources.
69  *
70  * \return None.
71  */
72 /*************************************************************************************************/
73 void hciTrShutdown(void);
74 
75 #ifdef __cplusplus
76 };
77 #endif
78 
79 #endif /* HCI_TR_H */
bool_t hciTrInit(uint8_t port, uint32_t baudRate, bool_t flowControl)
Initialize HCI transport resources.
uint8_t bool_t
Boolean data type.
Definition: wsf_types.h:78
void hciTrSendAclData(void *pContext, uint8_t *pAclData)
Send a complete HCI ACL packet to the transport.
unsigned long uint32_t
Unsigned 32-bit value.
Definition: wsf_types.h:71
void hciTrShutdown(void)
Close HCI transport resources.
void hciTrSendCmd(uint8_t *pCmdData)
Send a complete HCI command to the transport.
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63