Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
hci_cmd.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief HCI command module.
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_CMD_H
25 #define HCI_CMD_H
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 /**************************************************************************************************
32  Function Declarations
33 **************************************************************************************************/
34 
35 /*************************************************************************************************/
36 /*!
37  * \brief Send an HCI command and service the HCI command queue.
38  *
39  * \param pData Buffer containing HCI command to send or NULL.
40  *
41  * \return None.
42  */
43 /*************************************************************************************************/
44 void hciCmdSend(uint8_t *pData);
45 
46 /*************************************************************************************************/
47 /*!
48  * \brief Allocate an HCI command buffer and set the command header fields.
49  *
50  * \param opcode Command opcode.
51  * \param len length of command parameters.
52  *
53  * \return Pointer to WSF msg buffer.
54  */
55 /*************************************************************************************************/
56 uint8_t *hciCmdAlloc(uint16_t opcode, uint16_t len);
57 
58 /*************************************************************************************************/
59 /*!
60  * \brief Initialize the HCI cmd module.
61  *
62  * \return None.
63  */
64 /*************************************************************************************************/
65 void hciCmdInit(void);
66 
67 /*************************************************************************************************/
68 /*!
69  * \brief Process an HCI command timeout.
70  *
71  * \param pMsg Message.
72  *
73  * \return None.
74  */
75 /*************************************************************************************************/
76 void hciCmdTimeout(wsfMsgHdr_t *pMsg);
77 
78 /*************************************************************************************************/
79 /*!
80  * \brief Process an HCI Command Complete or Command Status event.
81  *
82  * \param numCmdPkts Number of commands that can be sent to the controller.
83  *
84  * \return None.
85  */
86 /*************************************************************************************************/
87 void hciCmdRecvCmpl(uint8_t numCmdPkts);
88 
89 
90 
91 #ifdef __cplusplus
92 };
93 #endif
94 
95 #endif /* HCI_CMD_H */
hciCmdTimeout
void hciCmdTimeout(wsfMsgHdr_t *pMsg)
Process an HCI command timeout.
hciCmdAlloc
uint8_t * hciCmdAlloc(uint16_t opcode, uint16_t len)
Allocate an HCI command buffer and set the command header fields.
hciCmdRecvCmpl
void hciCmdRecvCmpl(uint8_t numCmdPkts)
Process an HCI Command Complete or Command Status event.
hciCmdInit
void hciCmdInit(void)
Initialize the HCI cmd module.
wsfMsgHdr_t
Common message structure passed to event handler.
Definition: wsf_os.h:106
hciCmdSend
void hciCmdSend(uint8_t *pData)
Send an HCI command and service the HCI command queue.
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.