Cordio Stack and Cordio Profiles  r2p3-02rel0
smp_handler.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Interface to SMP event handler.
6  *
7  * Copyright (c) 2010-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 SMP_HANDLER_H
20 #define SMP_HANDLER_H
21 
22 #include "wsf_os.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /*! \addtogroup STACK_EVENT
29  * \{ */
30 
31 /** \name SMP Event Handling
32  * Message passing interface to SMP from other tasks through WSF.
33  */
34 /**@{*/
35 
36 /**************************************************************************************************
37  Function Declarations
38 **************************************************************************************************/
39 
40 /*************************************************************************************************/
41 /*!
42  * \brief SMP handler init function called during system initialization.
43  *
44  * \param handlerId WSF handler ID for SMP.
45  *
46  * \return None.
47  */
48 /*************************************************************************************************/
49 void SmpHandlerInit(wsfHandlerId_t handlerId);
50 
51 
52 /*************************************************************************************************/
53 /*!
54  * \brief WSF event handler for SMP.
55  *
56  * \param event WSF event mask.
57  * \param pMsg WSF message.
58  *
59  * \return None.
60  */
61 /*************************************************************************************************/
62 void SmpHandler(wsfEventMask_t event, wsfMsgHdr_t *pMsg);
63 
64 /**@}*/
65 
66 /*! \} */ /* STACK_SMP_API */
67 
68 #ifdef __cplusplus
69 };
70 #endif
71 
72 #endif /* SMP_HANDLER_H */
uint8_t wsfEventMask_t
Event handler event mask data type.
Definition: wsf_os.h:77
void SmpHandler(wsfEventMask_t event, wsfMsgHdr_t *pMsg)
WSF event handler for SMP.
void SmpHandlerInit(wsfHandlerId_t handlerId)
SMP handler init function called during system initialization.
uint8_t wsfHandlerId_t
Event handler ID data type.
Definition: wsf_os.h:74
Software foundation OS API.
Common message structure passed to event handler.
Definition: wsf_os.h:97