Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
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  *
9  * Copyright (c) 2019 Packetcraft, Inc.
10  *
11  * Licensed under the Apache License, Version 2.0 (the "License");
12  * you may not use this file except in compliance with the License.
13  * You may obtain a copy of the License at
14  *
15  * http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing, software
18  * distributed under the License is distributed on an "AS IS" BASIS,
19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20  * See the License for the specific language governing permissions and
21  * limitations under the License.
22  */
23 /*************************************************************************************************/
24 #ifndef HCI_TR_H
25 #define HCI_TR_H
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 /**************************************************************************************************
32  Function Declarations
33 **************************************************************************************************/
34 
35 /*************************************************************************************************/
36 /*!
37  * \brief Send a complete HCI ACL packet to the transport.
38  *
39  * \param pContext Connection context.
40  * \param pAclData WSF msg buffer containing an ACL packet.
41  *
42  * \return None.
43  */
44 /*************************************************************************************************/
45 void hciTrSendAclData(void *pContext, uint8_t *pAclData);
46 
47 /*************************************************************************************************/
48 /*!
49  * \brief Send a complete HCI command to the transport.
50  *
51  * \param pCmdData WSF msg buffer containing an HCI command.
52  *
53  * \return None.
54  */
55 /*************************************************************************************************/
56 void hciTrSendCmd(uint8_t *pCmdData);
57 
58 /*************************************************************************************************/
59 /*!
60  * \brief Initialize HCI transport resources.
61  *
62  * \param port COM port.
63  * \param baudRate Baud rate.
64  * \param flowControl TRUE if flow control is enabled
65  *
66  * \return TRUE if initialization succeeds, FALSE otherwise.
67  */
68 /*************************************************************************************************/
69 bool_t hciTrInit(uint8_t port, uint32_t baudRate, bool_t flowControl);
70 
71 /*************************************************************************************************/
72 /*!
73  * \brief Close HCI transport resources.
74  *
75  * \return None.
76  */
77 /*************************************************************************************************/
78 void hciTrShutdown(void);
79 
80 #ifdef __cplusplus
81 };
82 #endif
83 
84 #endif /* HCI_TR_H */
hciTrInit
bool_t hciTrInit(uint8_t port, uint32_t baudRate, bool_t flowControl)
Initialize HCI transport resources.
hciTrSendAclData
void hciTrSendAclData(void *pContext, uint8_t *pAclData)
Send a complete HCI ACL packet to the transport.
hciTrShutdown
void hciTrShutdown(void)
Close HCI transport resources.
hciTrSendCmd
void hciTrSendCmd(uint8_t *pCmdData)
Send a complete HCI command to the transport.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.