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