blob: 3ce8fc2e8b820647fda1163aab78d1c4ed423bfe (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*
* MOST NetServices "Light" V3.2.7.0.1796 MultiInstance Patch
*
* Copyright (C) 2015 Microchip Technology Germany II GmbH & Co. KG
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* You may also obtain this software under a propriety license from Microchip.
* Please contact Microchip for further information.
*
*/
/*!
* \file
* \brief Internal header file of the event handler.
*
* \cond MNS_INTERNAL_DOC
* \addtogroup G_EH
* @{
*/
#ifndef MNS_EH_H
#define MNS_EH_H
/*------------------------------------------------------------------------------------------------*/
/* Includes */
/*------------------------------------------------------------------------------------------------*/
#include "mns_eh_pb.h"
#include "mns_obs.h"
#include "mns_trace.h"
#ifdef __cplusplus
extern "C"
{
#endif
/*------------------------------------------------------------------------------------------------*/
/* Definitions */
/*------------------------------------------------------------------------------------------------*/
/*! \brief A control FIFO synchronization is lost. When this event occurs the PMS still waits
* until all FIFOs are unsynchronized. So this event is no termination event.
*/
#define EH_E_SYNC_LOST 0x0001U
/*! \brief INIC Build-In-Self-Test failed
*/
#define EH_E_BIST_FAILED 0x0002U
/*! \brief Notifies completed un-synchronization of Port Message FIFOs
*/
#define EH_E_UNSYNC_COMPLETE 0x0004U
/*! \brief Notifies that the Port Message Channel was not able to un-synchronize its FIFOs
* within a definite time
*/
#define EH_E_UNSYNC_FAILED 0x0008U
/*! \brief MOST NetServices initialization succeeded
*/
#define EH_E_INIT_SUCCEEDED 0x0010U
/*! \brief MOST NetServices initialization failed
*/
#define EH_E_INIT_FAILED 0x0020U
/*! \brief Mask including all events that lead to the termination of the MNS
*/
#define EH_M_TERMINATION_EVENTS (EH_E_UNSYNC_COMPLETE | EH_E_UNSYNC_FAILED | \
EH_E_BIST_FAILED | EH_E_INIT_FAILED)
/*! \brief Bitmask to identify all internal event codes
*/
#define EH_M_ALL_EVENTS (EH_M_TERMINATION_EVENTS | EH_E_INIT_SUCCEEDED | EH_E_SYNC_LOST)
/*------------------------------------------------------------------------------------------------*/
/* Type definitions */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Function signature used for callback functions which notifies the event handler
* observers.
* \param self Instance pointer
* \param event_code Reported event code
*/
typedef void (*Ehobs_UpdateCb_t)(void *self, uint32_t event_code);
/*------------------------------------------------------------------------------------------------*/
/* Structures */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Class structure of the event handler. */
typedef struct CEventHandler_
{
/*! \brief Subject used for internal events */
CSubject internal_event_subject;
/*! \brief Single subject to report error to application */
CSingleSubject public_error_subject;
/*! \brief MOST NetServices instance ID */
uint8_t mns_inst_id;
} CEventHandler;
/*------------------------------------------------------------------------------------------------*/
/* Prototypes of class CEventHandler */
/*------------------------------------------------------------------------------------------------*/
extern void Eh_Ctor(CEventHandler *self, uint8_t mns_inst_id);
extern void Eh_AddObsrvPublicError(CEventHandler *self, CSingleObserver *obs_ptr);
extern void Eh_DelObsrvPublicError(CEventHandler *self);
extern void Eh_ReportEvent(CEventHandler *self, uint32_t event_code);
extern void Eh_AddObsrvInternalEvent(CEventHandler *self, CMaskedObserver *obs_ptr);
extern void Eh_DelObsrvInternalEvent(CEventHandler *self, CMaskedObserver *obs_ptr);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* #ifndef MNS_EH_H */
/*!
* @}
* \endcond
*/
/*------------------------------------------------------------------------------------------------*/
/* End of file */
/*------------------------------------------------------------------------------------------------*/
|
