Statistics
| Branch: | Tag: | Revision:

amiro-os / core / inc / aos_system.h @ 9df585c4

History | View | Annotate | Download (6.71 KB)

1
/*
2
AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
3
Copyright (C) 2016..2018  Thomas Schöpping et al.
4

5
This program is free software: you can redistribute it and/or modify
6
it under the terms of the GNU General Public License as published by
7
the Free Software Foundation, either version 3 of the License, or
8
(at your option) any later version.
9

10
This program is distributed in the hope that it will be useful,
11
but WITHOUT ANY WARRANTY; without even the implied warranty of
12
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
GNU General Public License for more details.
14

15
You should have received a copy of the GNU General Public License
16
along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
*/
18

    
19
/**
20
 * @file    aos_system.h
21
 * @brief   System macros and structures.
22
 *
23
 * @addtogroup aos_system
24
 * @{
25
 */
26

    
27
#ifndef _AMIROOS_SYSTEM_H_
28
#define _AMIROOS_SYSTEM_H_
29

    
30
#include <time.h>
31
#include <aos_iostream.h>
32
#include <amiro-lld.h>
33
#include <aos_shell.h>
34
#include <aos_time.h>
35
#include <chprintf.h>
36

    
37
/**
38
 * @brief   Resolution of the system time measurement.
39
 */
40
#define AOS_SYSTEM_TIME_RESOLUTION              ((MICROSECONDS_PER_SECOND + CH_CFG_ST_FREQUENCY - 1) / CH_CFG_ST_FREQUENCY)
41

    
42
/**
43
 * @brief   System event flag which is emitted when a shutdown was initiated.
44
 */
45
#define AOS_SYSTEM_EVENTFLAGS_SHUTDOWN          (eventflags_t)(1 << 0)
46

    
47
/**
48
 * @brief   System event flag which is emitted when a shutdown to transportation mode was initiated.
49
 */
50
#define AOS_SYSTEM_EVENTFLAGS_TRANSPORTATION    (AOS_SYSTEM_EVENTFLAGS_SHUTDOWN | (eventflags_t)(1 << 1))
51

    
52
/**
53
 * @brief   System event flag which is emitted when a shutdown to deepsleep mode was initiated.
54
 */
55
#define AOS_SYSTEM_EVENTFLAGS_DEEPSLEEP         (AOS_SYSTEM_EVENTFLAGS_SHUTDOWN | (eventflags_t)(1 << 2))
56

    
57
/**
58
 * @brief   System event flag which is emitted when a shutdown to hibernate mode was initiated.
59
 */
60
#define AOS_SYSTEM_EVENTFLAGS_HIBERNATE         (AOS_SYSTEM_EVENTFLAGS_SHUTDOWN | (eventflags_t)(1 << 3))
61

    
62
/**
63
 * @brief   System event flag which is emitted when a system restart was initiated.
64
 */
65
#define AOS_SYSTEM_EVENTFLAGS_RESTART           (AOS_SYSTEM_EVENTFLAGS_SHUTDOWN | (eventflags_t)(1 << 4))
66

    
67
/**
68
 * @brief   Major version of the implemented SSSP.
69
 */
70
#define AOS_SYSTEM_SSSP_VERSION_MAJOR           1
71

    
72
/**
73
 * @brief   Minor version of the implemented SSSP.
74
 */
75
#define AOS_SYSTEM_SSSP_VERSION_MINOR           4
76

    
77
/**
78
 * @brief   Timeout delay according to SSSP.
79
 * @details SSSP defines timeouts to be ten times longer than the signal delay time.
80
 */
81
#define AOS_SYSTEM_SSSP_TIMEOUT                 (10 * AMIROOS_CFG_SSSP_SIGNALDELAY)
82

    
83
/**
84
 * @brief   Enumerator to identify shutdown types.
85
 */
86
typedef enum aos_shutdown {
87
  AOS_SHUTDOWN_NONE,            /**< Default value if no shutdown action was initiated */
88
  AOS_SHUTDOWN_PASSIVE,         /**< Passive shutdown (initiated by another module). */
89
  AOS_SHUTDOWN_HIBERNATE,       /**< Active shutdown to hibernate mode. */
90
  AOS_SHUTDOWN_DEEPSLEEP,       /**< Active shutdown to deepsleep mode. */
91
  AOS_SHUTDOWN_TRANSPORTATION,  /**< Active shutdown to transportation mode. */
92
  AOS_SHUTDOWN_RESTART,         /**< Active saystem restart request. */
93
} aos_shutdown_t;
94

    
95
/**
96
 * @brief   Enumerator of the several stages of SSSP.
97
 */
98
typedef enum aos_ssspstage {
99
  AOS_SSSP_STARTUP_1_1  = 0x10, /**< Identifier of SSSP startup phase stage 1-1. */
100
  AOS_SSSP_STARTUP_1_2  = 0x11, /**< Identifier of SSSP startup phase stage 1-2. */
101
  AOS_SSSP_STARTUP_1_3  = 0x12, /**< Identifier of SSSP startup phase stage 1-3. */
102
  AOS_SSSP_STARTUP_2_1  = 0x14, /**< Identifier of SSSP startup phase stage 2-1. */
103
  AOS_SSSP_STARTUP_2_2  = 0x15, /**< Identifier of SSSP startup phase stage 2-2. */
104
  AOS_SSSP_STARTUP_3_1  = 0x18, /**< Identifier of SSSP startup phase stage 3-1. */
105
  AOS_SSSP_STARTUP_3_2  = 0x19, /**< Identifier of SSSP startup phase stage 3-2. */
106
  AOS_SSSP_STARTUP_3_3  = 0x1A, /**< Identifier of SSSP startup phase stage 3-3. */
107
  AOS_SSSP_STARTUP_3_4  = 0x1B, /**< Identifier of SSSP startup phase stage 3-4. */
108
  AOS_SSSP_OPERATION    = 0x20, /**< Identifier of SSSP operation pahse. */
109
  AOS_SSSP_SHUTDOWN_1_1 = 0x30, /**< Identifier of SSSP shutdown phase stage 1-1. */
110
  AOS_SSSP_SHUTDOWN_1_2 = 0x31, /**< Identifier of SSSP shutdown phase stage 1-2. */
111
  AOS_SSSP_SHUTDOWN_1_3 = 0x32, /**< Identifier of SSSP shutdown phase stage 1-3. */
112
  AOS_SSSP_SHUTDOWN_2_1 = 0x34, /**< Identifier of SSSP shutdown phase stage 2-1. */
113
  AOS_SSSP_SHUTDOWN_2_2 = 0x35, /**< Identifier of SSSP shutdown phase stage 2-2. */
114
  AOS_SSSP_SHUTDOWN_3   = 0x38, /**< Identifier of SSSP shutdown phase stage 3. */
115
} aos_ssspstage_t;
116

    
117
/**
118
 * @brief   Type to represent module IDs.
119
 */
120
typedef uint16_t aos_ssspmoduleid_t;
121

    
122
/**
123
 * @brief   AMiRo-OS base system structure.
124
 */
125
typedef struct aos_system {
126

    
127
  /**
128
   * @brief   SSSP relevant data.
129
   */
130
  struct {
131
    /**
132
     * @brief   Current SSSP stage of the system.
133
     */
134
    aos_ssspstage_t stage;
135

    
136
    /**
137
     * @brief   Module identifier.
138
     * @details A value of 0 indicates an uninitialized ID.
139
     *          The vlaues 0 and ~0 are reserved und must not be set.
140
     */
141
    aos_ssspmoduleid_t moduleId;
142
  } sssp;
143

    
144
  /**
145
   * @brief   System I/O stream.
146
   */
147
  AosIOStream iostream;
148

    
149
  /**
150
   * @brief   Event structure.
151
   */
152
  struct {
153

    
154
    /**
155
     * @brief   I/O event source.
156
     */
157
    event_source_t io;
158

    
159
    /**
160
     * @brief   OS event source.
161
     */
162
    event_source_t os;
163
  } events;
164

    
165
#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
166
  /**
167
   * @brief   Pointer to the shell object.
168
   */
169
  aos_shell_t shell;
170
#endif
171

    
172
} aos_system_t;
173

    
174
/**
175
 * @brief   Global system object.
176
 */
177
extern aos_system_t aos;
178

    
179
/**
180
 * @brief   Printf function that uses the default system I/O stream.
181
 *
182
 * @param[in] fmt   Formatted string to print.
183
 */
184
#define aosprintf(fmt, ...)                     chprintf((BaseSequentialStream*)&aos.iostream, fmt, ##__VA_ARGS__)
185

    
186
#ifdef __cplusplus
187
extern "C" {
188
#endif
189
#if (AMIROOS_CFG_SHELL_ENABLE == true)
190
  void aosSysInit(const char* shellPrompt);
191
#else
192
  void aosSysInit(void);
193
#endif
194
  void aosSysStart(void);
195
  eventmask_t aosSysSsspStartupOsInitSyncCheck(event_listener_t* syncEvtListener);
196
  void aosSysGetUptimeX(aos_timestamp_t* ut);
197
  void aosSysGetDateTime(struct tm* dt);
198
  void aosSysSetDateTime(struct tm* dt);
199
  void aosSysShutdownInit(aos_shutdown_t shutdown);
200
  void aosSysStop(void);
201
  void aosSysDeinit(void);
202
  void aosSysShutdownFinal(aos_shutdown_t shutdown);
203
#ifdef __cplusplus
204
}
205
#endif
206

    
207
/**
208
 * @brief   Retrieves the system uptime.
209
 *
210
 * @param[out] ut   Pointer to the system uptime.
211
 */
212
static inline void aosSysGetUptime(aos_timestamp_t* ut)
213
{
214
  chSysLock();
215
  aosSysGetUptimeX(ut);
216
  chSysUnlock();
217
}
218

    
219
#endif /* _AMIROOS_SYSTEM_H_ */
220

    
221
/** @} */