Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
dm_handler.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Interface to DM event handler.
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 DM_HANDLER_H
25 #define DM_HANDLER_H
26 
27 #include "wsf_os.h"
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /*! \addtogroup STACK_EVENT
34  * \{ */
35 
36 /** \name DM Event Handling
37  * Message passing interface to DM from other tasks through WSF.
38  */
39 /**@{*/
40 
41 /**************************************************************************************************
42  Function Declarations
43 **************************************************************************************************/
44 
45 /*************************************************************************************************/
46 /*!
47  * \brief DM handler init function called during system initialization.
48  *
49  * \param handlerId WSF handler ID for DM.
50  *
51  * \return None.
52  */
53 /*************************************************************************************************/
54 void DmHandlerInit(wsfHandlerId_t handlerId);
55 
56 
57 /*************************************************************************************************/
58 /*!
59  * \brief WSF event handler for DM.
60  *
61  * \param event WSF event mask.
62  * \param pMsg WSF message.
63  *
64  * \return None.
65  */
66 /*************************************************************************************************/
67 void DmHandler(wsfEventMask_t event, wsfMsgHdr_t *pMsg);
68 
69 /**@}*/
70 
71 /*! \} */ /* STACK_DM_API */
72 
73 #ifdef __cplusplus
74 };
75 #endif
76 
77 #endif /* DM_HANDLER_H */
wsfEventMask_t
uint16_t wsfEventMask_t
Event handler event mask data type.
Definition: wsf_os.h:83
DmHandler
void DmHandler(wsfEventMask_t event, wsfMsgHdr_t *pMsg)
WSF event handler for DM.
DmHandlerInit
void DmHandlerInit(wsfHandlerId_t handlerId)
DM handler init function called during system initialization.
wsfHandlerId_t
uint8_t wsfHandlerId_t
Event handler ID data type.
Definition: wsf_os.h:80
wsf_os.h
Software foundation OS API.
wsfMsgHdr_t
Common message structure passed to event handler.
Definition: wsf_os.h:106
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.