summaryrefslogtreecommitdiffstats
path: root/mnsl/mns_base.h
blob: 132243d126cabb749355197fa055178f02942a81 (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
/*
 * 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 3 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 Base class.
 *
 * \cond MNS_INTERNAL_DOC
 * \addtogroup G_BASE
 * @{
 */

#ifndef MNS_BASE_H
#define MNS_BASE_H

/*------------------------------------------------------------------------------------------------*/
/* Includes                                                                                       */
/*------------------------------------------------------------------------------------------------*/
#include "mns_cfg.h"
#include "mns_timer.h"
#include "mns_scheduler.h"
#include "mns_trace.h"
#include "mns_eh.h"
#include "mns_alm.h"

#ifdef __cplusplus
extern "C"
{
#endif

/*------------------------------------------------------------------------------------------------*/
/* Structures                                                                                     */
/*------------------------------------------------------------------------------------------------*/
/*! \brief  Initialization structure of the Base class. */
typedef struct Base_InitData_
{
    Scd_InitData_t scd;             /*!< \brief Initialization data of the scheduler */
    Tm_InitData_t tm;               /*!< \brief Initialization data of the timer management */
    uint8_t mns_inst_id;            /*!< \brief MOST NetServices instance ID */

} Base_InitData_t;

/*! \brief   Class structure of the Base class. */
typedef struct CBase_
{
    CScheduler scd;                 /*!< \brief Scheduler instance */
    CTimerManagement tm;            /*!< \brief Timer management instance */
    CEventHandler eh;               /*!< \brief Event handler instance */
    CApiLockingManager alm;         /*!< \brief API locking manager instance */
    uint8_t mns_inst_id;            /*!< \brief MOST NetServices instance ID */

} CBase;

/*------------------------------------------------------------------------------------------------*/
/* Prototypes                                                                                     */
/*------------------------------------------------------------------------------------------------*/
void Base_Ctor(CBase *self, Base_InitData_t *init_ptr);

#ifdef __cplusplus
}   /* extern "C" */
#endif

#endif  /* #ifndef MNS_BASE_H */

/*!
 * @}
 * \endcond
 */

/*------------------------------------------------------------------------------------------------*/
/* End of file                                                                                    */
/*------------------------------------------------------------------------------------------------*/