Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
wsf_detoken.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Token trace decode header file.
6  *
7  * Copyright (c) 2018-2019 Arm Ltd. All Rights Reserved.
8  *
9  * Copyright (c) 2019-2020 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 
25 #ifndef WSF_DETOKEN_H
26 #define WSF_DETOKEN_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 /**************************************************************************************************
33  Macros
34 **************************************************************************************************/
35 
36 /*! \brief Vendor specific event mask opcode. */
37 #define WSF_DETOKEN_VS_SET_EVENT_MASK_OPCODE HCI_OPCODE(HCI_OGF_VENDOR_SPEC, 0x3E1)
38 
39 /*! \brief Event mask bits. */
40 #define WSF_DETOKEN_ENABLE_BIT (1<<1)
41 
42 /*! \brief Vendor specific token event. */
43 #define WSF_DETOKEN_VS_EVT_TOKEN 0xFFF0
44 
45 /** \name Platform identifiers
46  *
47  */
48 /**@{*/
49 #define WSF_DETOKEN_TRACE_NORDIC 1
50 /**@}*/
51 
52 /** \name Parameter mask bits
53  *
54  */
55 /**@{*/
56 #define WSF_DETOKEN_PARAM_VARIABLE 0
57 #define WSF_DETOKEN_PARAM_STRING 1
58 /**@}*/
59 
60 /**************************************************************************************************
61  Function Declarations
62 **************************************************************************************************/
63 
64 /*************************************************************************************************/
65 /*!
66  * \brief Initialize detoken trace.
67  */
68 /*************************************************************************************************/
69 void WsfDetokenInit(void);
70 
71 /*************************************************************************************************/
72 /*!
73  * \brief Enable/disable detoken trace.
74  *
75  * \param enable TRUE to enable, FALSE to disable.
76  */
77 /*************************************************************************************************/
78 void WsfDetokenEnable(bool_t enable);
79 
80 /*************************************************************************************************/
81 /*!
82  * \brief Process vendor specific HCI events and decode token trace events from the LL.
83  *
84  * \param len Length of pBuffer in bytes.
85  * \param pBuffer Buffer containing HCI event.
86  *
87  * \return TRUE if VS HCI message is a token, else FALSE.
88  */
89 /*************************************************************************************************/
90 bool_t WsfDetokenProcessHciEvent(uint16_t len, uint8_t *pBuffer);
91 
92 #ifdef __cplusplus
93 };
94 #endif
95 
96 #endif /* WSF_DETOKEN_H */
WsfDetokenProcessHciEvent
bool_t WsfDetokenProcessHciEvent(uint16_t len, uint8_t *pBuffer)
Process vendor specific HCI events and decode token trace events from the LL.
WsfDetokenInit
void WsfDetokenInit(void)
Initialize detoken trace.
WsfDetokenEnable
void WsfDetokenEnable(bool_t enable)
Enable/disable detoken trace.
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.