Statistics
| Branch: | Tag: | Revision:

amiro-os / core / src / aos_system.c @ c18a848e

History | View | Annotate | Download (35.692 KB)

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

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 53710ca3 Marc Rothmann
/**
20
 * @file    aos_system.c
21
 * @brief   System code.
22
 * @details Contains system initialization and shutdown routines
23
 *          and system shell commands.
24
 *
25
 * @addtogroup aos_system
26
 * @{
27
 */
28
29 3940ba8a Thomas Schöpping
#include <amiroos.h>
30
#include <stdarg.h>
31 e545e620 Thomas Schöpping
#include <string.h>
32 8399aeae Thomas Schöpping
#include <stdlib.h>
33 3940ba8a Thomas Schöpping
34 e545e620 Thomas Schöpping
#if (AMIROOS_CFG_TESTS_ENABLE == true)
35
#include <ch_test.h>
36 0128be0f Marc Rothmann
#include <rt_test_root.h>
37 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
38 e545e620 Thomas Schöpping
39 f3ac1c96 Thomas Schöpping
/******************************************************************************/
40
/* LOCAL DEFINITIONS                                                          */
41
/******************************************************************************/
42
43 e545e620 Thomas Schöpping
/**
44
 * @brief   Period of the system timer.
45
 */
46 1e5f7648 Thomas Schöpping
#define SYSTIMER_PERIOD               (TIME_MAX_SYSTIME - CH_CFG_ST_TIMEDELTA)
47 e545e620 Thomas Schöpping
48
/**
49
 * @brief   Width of the printable system info text.
50
 */
51 08d86900 Thomas Schöpping
#define SYSTEM_INFO_WIDTH             80
52 e545e620 Thomas Schöpping
53 ba516b61 Thomas Schöpping
/**
54
 * @brief   Width of the name column of the system info table.
55
 */
56 08d86900 Thomas Schöpping
#define SYSTEM_INFO_NAMEWIDTH         20
57 ba516b61 Thomas Schöpping
58 f3ac1c96 Thomas Schöpping
/******************************************************************************/
59
/* EXPORTED VARIABLES                                                         */
60
/******************************************************************************/
61
62
/**
63
 * @brief   Global system object.
64
 */
65
aos_system_t aos;
66
67
/******************************************************************************/
68
/* LOCAL TYPES                                                                */
69
/******************************************************************************/
70
71
/******************************************************************************/
72
/* LOCAL VARIABLES                                                            */
73
/******************************************************************************/
74
75
/*
76
 * forward declarations
77
 */
78 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
79 e545e620 Thomas Schöpping
static int _shellcmd_configcb(BaseSequentialStream* stream, int argc, char* argv[]);
80
static int _shellcmd_infocb(BaseSequentialStream* stream, int argc, char* argv[]);
81
static int _shellcmd_shutdowncb(BaseSequentialStream* stream, int argc, char* argv[]);
82 f3ac1c96 Thomas Schöpping
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
83 e545e620 Thomas Schöpping
static int _shellcmd_kerneltestcb(BaseSequentialStream* stream, int argc, char* argv[]);
84 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
85 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
86 e545e620 Thomas Schöpping
87
/**
88
 * @brief   Timer to accumulate system uptime.
89
 */
90
static virtual_timer_t _systimer;
91
92
/**
93
 * @brief   Accumulated system uptime.
94
 */
95
static aos_timestamp_t _uptime;
96
97
/**
98
 * @brief   Timer register value of last accumulation.
99
 */
100
static systime_t _synctime;
101
102 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
103 3e1a9c79 Thomas Schöpping
104 e545e620 Thomas Schöpping
/**
105
 * @brief   Shell thread working area.
106
 */
107 10fd7ac9 Thomas Schöpping
static THD_WORKING_AREA(_shell_wa, AMIROOS_CFG_SHELL_STACKSIZE);
108 e545e620 Thomas Schöpping
109
/**
110
 * @brief   Shell input buffer.
111
 */
112
static char _shell_line[AMIROOS_CFG_SHELL_LINEWIDTH];
113
114
/**
115
 * @brief   Shell command to retrieve system information.
116
 */
117 4c72a54c Thomas Schöpping
static AOS_SHELL_COMMAND(_shellcmd_info, "module:info", _shellcmd_infocb);
118 e545e620 Thomas Schöpping
119
/**
120
 * @brief   Shell command to set or retrieve system configuration.
121
 */
122 4c72a54c Thomas Schöpping
static AOS_SHELL_COMMAND(_shellcmd_config, "module:config", _shellcmd_configcb);
123 e545e620 Thomas Schöpping
124
/**
125
 * @brief   Shell command to shutdown the system.
126
 */
127 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true) || defined(__DOXYGEN__)
128 4c72a54c Thomas Schöpping
static AOS_SHELL_COMMAND(_shellcmd_shutdown, "system:shutdown", _shellcmd_shutdowncb);
129 7de0cc90 Thomas Schöpping
#else /* (AMIROOS_CFG_SSSP_ENABLE == true) */
130 4c72a54c Thomas Schöpping
static AOS_SHELL_COMMAND(_shellcmd_shutdown, "module:shutdown", _shellcmd_shutdowncb);
131 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
132 e545e620 Thomas Schöpping
133
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
134 cda14729 Thomas Schöpping
135 e545e620 Thomas Schöpping
/**
136
 * @brief   Shell kommand to run a test of the ChibiOS/RT kernel.
137
 */
138 4c72a54c Thomas Schöpping
static AOS_SHELL_COMMAND(_shellcmd_kerneltest, "kernel:test", _shellcmd_kerneltestcb);
139 cda14729 Thomas Schöpping
140 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
141 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
142 e545e620 Thomas Schöpping
143 f3ac1c96 Thomas Schöpping
/******************************************************************************/
144
/* LOCAL FUNCTIONS                                                            */
145
/******************************************************************************/
146 e545e620 Thomas Schöpping
147
/**
148
 * @brief   Print a separator line.
149
 *
150 ba516b61 Thomas Schöpping
 * @param[in] stream    Stream to print to or NULL to print to all system streams.
151 e545e620 Thomas Schöpping
 * @param[in] c         Character to use.
152
 * @param[in] n         Length of the separator line.
153
 *
154
 * @return  Number of characters printed.
155
 */
156
static unsigned int _printSystemInfoSeparator(BaseSequentialStream* stream, const char c, const unsigned int n)
157
{
158
  aosDbgCheck(stream != NULL);
159
160
  // print the specified character n times
161
  for (unsigned int i = 0; i < n; ++i) {
162 83e58975 Thomas Schöpping
    streamPut(stream, (uint8_t)c);
163 e545e620 Thomas Schöpping
  }
164
  streamPut(stream, '\n');
165
166
  return n+1;
167
}
168
169
/**
170
 * @brief   Print a system information line.
171
 * @details Prints a system information line with the following format:
172
 *            "<name>[spaces]fmt"
173
 *          The combined width of "<name>[spaces]" can be specified in order to align <fmt> on multiple lines.
174
 *          Note that there is not trailing newline added implicitely.
175
 *
176 ba516b61 Thomas Schöpping
 * @param[in] stream      Stream to print to or NULL to print to all system streams.
177 e545e620 Thomas Schöpping
 * @param[in] name        Name of the entry/line.
178 08d86900 Thomas Schöpping
 * @param[in] namewidth   Minimum width of the name column.
179 e545e620 Thomas Schöpping
 * @param[in] fmt         Formatted string of information content.
180
 *
181
 * @return  Number of characters printed.
182
 */
183
static unsigned int _printSystemInfoLine(BaseSequentialStream* stream, const char* name, const unsigned int namewidth, const char* fmt, ...)
184
{
185
  aosDbgCheck(stream != NULL);
186 ba516b61 Thomas Schöpping
  aosDbgCheck(name != NULL);
187 e545e620 Thomas Schöpping
188
  unsigned int n = 0;
189 ba516b61 Thomas Schöpping
  va_list ap;
190 e545e620 Thomas Schöpping
191 ba516b61 Thomas Schöpping
  va_start(ap, fmt);
192 83e58975 Thomas Schöpping
  n += (unsigned int)chprintf(stream, name);
193 08d86900 Thomas Schöpping
  // print at least a single space character
194
  do {
195 e545e620 Thomas Schöpping
    streamPut(stream, ' ');
196
    ++n;
197 08d86900 Thomas Schöpping
  } while (n < namewidth);
198 83e58975 Thomas Schöpping
  n += (unsigned int)chvprintf(stream, fmt, ap);
199 e545e620 Thomas Schöpping
  va_end(ap);
200
201 933df08e Thomas Schöpping
  streamPut(stream, '\n');
202
  ++n;
203
204 e545e620 Thomas Schöpping
  return n;
205
}
206
207
/**
208
 * @brief   Prints information about the system.
209
 *
210
 * @param[in] stream    Stream to print to.
211
 */
212 ba516b61 Thomas Schöpping
static void _printSystemInfo(BaseSequentialStream* stream)
213 e545e620 Thomas Schöpping
{
214
  aosDbgCheck(stream != NULL);
215
216 933df08e Thomas Schöpping
  // local variables
217 23437e98 Thomas Schöpping
#if (HAL_USE_RTC == TRUE)
218 933df08e Thomas Schöpping
  struct tm dt;
219
  aosSysGetDateTime(&dt);
220 7de0cc90 Thomas Schöpping
#endif /* (HAL_USE_RTC == TRUE) */
221 933df08e Thomas Schöpping
222
  // print static information about module and operating system
223 e545e620 Thomas Schöpping
  _printSystemInfoSeparator(stream, '=', SYSTEM_INFO_WIDTH);
224 1816cbc6 Thomas Schöpping
  _printSystemInfoLine(stream, "Module", SYSTEM_INFO_NAMEWIDTH, "%s", BOARD_NAME);
225 7de0cc90 Thomas Schöpping
#if defined(PLATFORM_NAME)
226 933df08e Thomas Schöpping
  _printSystemInfoLine(stream, "Platform", SYSTEM_INFO_NAMEWIDTH, "%s", PLATFORM_NAME);
227 7de0cc90 Thomas Schöpping
#endif /* defined(PLATFORM_NAME) */
228
#if defined(PORT_CORE_VARIANT_NAME)
229 933df08e Thomas Schöpping
  _printSystemInfoLine(stream, "Core Variant", SYSTEM_INFO_NAMEWIDTH, "%s", PORT_CORE_VARIANT_NAME);
230 7de0cc90 Thomas Schöpping
#endif /* defined(PORT_CORE_VARIANT_NAME) */
231 933df08e Thomas Schöpping
  _printSystemInfoLine(stream, "Architecture", SYSTEM_INFO_NAMEWIDTH, "%s", PORT_ARCHITECTURE_NAME);
232 e545e620 Thomas Schöpping
  _printSystemInfoSeparator(stream, '-', SYSTEM_INFO_WIDTH);
233 9ebb11a9 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true)
234 cda14729 Thomas Schöpping
  _printSystemInfoLine(stream, "AMiRo-OS" , SYSTEM_INFO_NAMEWIDTH, "%u.%u.%u %s (SSSP %u.%u)", AMIROOS_VERSION_MAJOR, AMIROOS_VERSION_MINOR, AMIROOS_VERSION_PATCH, AMIROOS_RELEASE_TYPE, AOS_SSSP_VERSION_MAJOR, AOS_SSSP_VERSION_MINOR);
235 7de0cc90 Thomas Schöpping
#else /* (AMIROOS_CFG_SSSP_ENABLE == true) */
236 9ebb11a9 Thomas Schöpping
  _printSystemInfoLine(stream, "AMiRo-OS" , SYSTEM_INFO_NAMEWIDTH, "%u.%u.%u %s", AMIROOS_VERSION_MAJOR, AMIROOS_VERSION_MINOR, AMIROOS_VERSION_PATCH, AMIROOS_RELEASE_TYPE);
237 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
238 dd56d656 Thomas Schöpping
  _printSystemInfoLine(stream, "AMiRo-LLD" , SYSTEM_INFO_NAMEWIDTH, "%u.%u.%u %s (periphAL %u.%u)", AMIROLLD_VERSION_MAJOR, AMIROLLD_VERSION_MINOR, AMIROLLD_VERSION_PATCH, AMIROLLD_RELEASE_TYPE, PERIPHAL_VERSION_MAJOR, PERIPHAL_VERSION_MINOR);
239 933df08e Thomas Schöpping
  _printSystemInfoLine(stream, "ChibiOS/RT" , SYSTEM_INFO_NAMEWIDTH, "%u.%u.%u %s", CH_KERNEL_MAJOR, CH_KERNEL_MINOR, CH_KERNEL_PATCH, (CH_KERNEL_STABLE == 1) ? "stable" : "non-stable");
240
  _printSystemInfoLine(stream, "ChibiOS/HAL", SYSTEM_INFO_NAMEWIDTH, "%u.%u.%u %s", CH_HAL_MAJOR, CH_HAL_MINOR, CH_HAL_PATCH, (CH_HAL_STABLE == 1) ? "stable" : "non-stable");
241
  _printSystemInfoLine(stream, "build type", SYSTEM_INFO_NAMEWIDTH,"%s", (AMIROOS_CFG_DBG == true) ? "debug" : "release");
242
  _printSystemInfoLine(stream, "Compiler" , SYSTEM_INFO_NAMEWIDTH, "%s %u.%u.%u", "GCC", __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__); // TODO: support other compilers than GCC
243
  _printSystemInfoLine(stream, "Compiled" , SYSTEM_INFO_NAMEWIDTH, "%s - %s", __DATE__, __TIME__);
244
245
  // print static information about the bootloader
246 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_BOOTLOADER != AOS_BOOTLOADER_NONE)
247 e545e620 Thomas Schöpping
  _printSystemInfoSeparator(stream, '-', SYSTEM_INFO_WIDTH);
248 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_BOOTLOADER != AOS_BOOTLOADER_NONE) */
249
#if (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT)
250 e545e620 Thomas Schöpping
  if (BL_CALLBACK_TABLE_ADDRESS->magicNumber == BL_MAGIC_NUMBER) {
251 933df08e Thomas Schöpping
    _printSystemInfoLine(stream, "AMiRo-BLT", SYSTEM_INFO_NAMEWIDTH, "%u.%u.%u %s (SSSP %u.%u)", BL_CALLBACK_TABLE_ADDRESS->vBootloader.major, BL_CALLBACK_TABLE_ADDRESS->vBootloader.minor, BL_CALLBACK_TABLE_ADDRESS->vBootloader.patch,
252 e545e620 Thomas Schöpping
                         (BL_CALLBACK_TABLE_ADDRESS->vBootloader.identifier == BL_VERSION_ID_AMiRoBLT_Release) ? "stable" :
253
                         (BL_CALLBACK_TABLE_ADDRESS->vBootloader.identifier == BL_VERSION_ID_AMiRoBLT_ReleaseCandidate) ? "release candidate" :
254
                         (BL_CALLBACK_TABLE_ADDRESS->vBootloader.identifier == BL_VERSION_ID_AMiRoBLT_Beta) ? "beta" :
255
                         (BL_CALLBACK_TABLE_ADDRESS->vBootloader.identifier == BL_VERSION_ID_AMiRoBLT_Alpha) ? "alpha" :
256
                         (BL_CALLBACK_TABLE_ADDRESS->vBootloader.identifier == BL_VERSION_ID_AMiRoBLT_PreAlpha) ? "pre-alpha" :
257
                         "<release type unknown>",
258
                         BL_CALLBACK_TABLE_ADDRESS->vSSSP.major, BL_CALLBACK_TABLE_ADDRESS->vSSSP.minor);
259 9ebb11a9 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true)
260 cda14729 Thomas Schöpping
    if (BL_CALLBACK_TABLE_ADDRESS->vSSSP.major != AOS_SSSP_VERSION_MAJOR) {
261
      const char* msg = "WARNING: AMiRo-BLT and AMiRo-OS implement incompatible SSSP versions!\n";
262
      stream ? chprintf(stream, msg) : aosprintf(msg);
263 ba516b61 Thomas Schöpping
    }
264 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
265 933df08e Thomas Schöpping
    _printSystemInfoLine(stream, "Compiler", SYSTEM_INFO_NAMEWIDTH, "%s %u.%u.%u", (BL_CALLBACK_TABLE_ADDRESS->vCompiler.identifier == BL_VERSION_ID_GCC) ? "GCC" : "<compiler unknown>", BL_CALLBACK_TABLE_ADDRESS->vCompiler.major, BL_CALLBACK_TABLE_ADDRESS->vCompiler.minor, BL_CALLBACK_TABLE_ADDRESS->vCompiler.patch); // TODO: support other compilers than GCC
266 e545e620 Thomas Schöpping
  } else {
267 cda14729 Thomas Schöpping
    const char* msg = "WARNING: AMiRo-BLT incompatible or not available.\n";
268
    stream ? chprintf(stream, "%s", msg) : aosprintf("%s", msg);
269 e545e620 Thomas Schöpping
  }
270 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_BOOTLOADER == X) */
271 933df08e Thomas Schöpping
272 08d86900 Thomas Schöpping
#if defined(AMIROOS_CFG_SYSINFO_HOOK)
273
  // print module specific information
274
  _printSystemInfoSeparator(stream, '-', SYSTEM_INFO_WIDTH);
275
  AMIROOS_CFG_SYSINFO_HOOK();
276
#endif /* defined(AMIROOS_CFG_SYSINFO_HOOK) */
277
278 933df08e Thomas Schöpping
  // print dynamic information about the module
279 8399aeae Thomas Schöpping
  _printSystemInfoSeparator(stream, '-', SYSTEM_INFO_WIDTH);
280 9ebb11a9 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true)
281 933df08e Thomas Schöpping
  if (aos.sssp.moduleId != 0) {
282
    _printSystemInfoLine(stream, "Module ID", SYSTEM_INFO_NAMEWIDTH, "%u", aos.sssp.moduleId);
283
  } else {
284
    _printSystemInfoLine(stream, "Module ID", SYSTEM_INFO_NAMEWIDTH, "not available");
285
  }
286 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
287 23437e98 Thomas Schöpping
#if (HAL_USE_RTC == TRUE)
288 3f716772 Thomas Schöpping
  _printSystemInfoLine(stream, "Date", SYSTEM_INFO_NAMEWIDTH, "%04u-%02u-%02u (%s)",
289
                       dt.tm_year + 1900,
290 8399aeae Thomas Schöpping
                       dt.tm_mon + 1,
291 3f716772 Thomas Schöpping
                       dt.tm_mday,
292
                       (dt.tm_wday == 0) ? "Sunday" : (dt.tm_wday == 1) ? "Monday" : (dt.tm_wday == 2) ? "Tuesday" : (dt.tm_wday == 3) ? "Wednesday" : (dt.tm_wday == 4) ? "Thursday" : (dt.tm_wday == 5) ? "Friday" : "Saturday");
293 933df08e Thomas Schöpping
  _printSystemInfoLine(stream, "Time", SYSTEM_INFO_NAMEWIDTH, "%02u:%02u:%02u", dt.tm_hour, dt.tm_min, dt.tm_sec);
294 7de0cc90 Thomas Schöpping
#endif /* (HAL_USE_RTC == TRUE) */
295 933df08e Thomas Schöpping
296 e545e620 Thomas Schöpping
  _printSystemInfoSeparator(stream, '=', SYSTEM_INFO_WIDTH);
297
298
  return;
299
}
300
301 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
302 e545e620 Thomas Schöpping
/**
303
 * @brief   Callback function for the system:config shell command.
304
 *
305
 * @param[in] stream    The I/O stream to use.
306
 * @param[in] argc      Number of arguments.
307
 * @param[in] argv      List of pointers to the arguments.
308
 *
309
 * @return              An exit status.
310
 * @retval  AOS_OK                  The command was executed successfuly.
311 916f8d28 Thomas Schöpping
 * @retval  AOS_INVALIDARGUMENTS    There was an issue with the arguemnts.
312 e545e620 Thomas Schöpping
 */
313
static int _shellcmd_configcb(BaseSequentialStream* stream, int argc, char* argv[])
314
{
315 ba516b61 Thomas Schöpping
  aosDbgCheck(stream != NULL);
316
317 e545e620 Thomas Schöpping
  // local variables
318 916f8d28 Thomas Schöpping
  int retval = AOS_INVALIDARGUMENTS;
319 e545e620 Thomas Schöpping
320
  // if there are additional arguments
321
  if (argc > 1) {
322
    // if the user wants to set or retrieve the shell configuration
323
    if (strcmp(argv[1], "--shell") == 0) {
324
      // if the user wants to modify the shell configuration
325
      if (argc > 2) {
326
        // if the user wants to modify the prompt
327
        if (strcmp(argv[2], "prompt") == 0) {
328
          // there must be a further argument
329
          if (argc > 3) {
330
            // handle the option
331
            if (strcmp(argv[3], "text") == 0) {
332 6b53f6bf Thomas Schöpping
              aos.shell.config &= ~AOS_SHELL_CONFIG_PROMPT_MINIMAL;
333 e545e620 Thomas Schöpping
              retval = AOS_OK;
334
            }
335
            else if (strcmp(argv[3], "minimal") == 0) {
336 6b53f6bf Thomas Schöpping
              aos.shell.config |= AOS_SHELL_CONFIG_PROMPT_MINIMAL;
337 e545e620 Thomas Schöpping
              retval = AOS_OK;
338
            }
339
            else if (strcmp(argv[3], "notime") == 0) {
340 6b53f6bf Thomas Schöpping
              aos.shell.config &= ~(AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME);
341 e545e620 Thomas Schöpping
              retval = AOS_OK;
342
            }
343
            else if (strcmp(argv[3], "uptime") == 0) {
344 6b53f6bf Thomas Schöpping
              aos.shell.config &= ~AOS_SHELL_CONFIG_PROMPT_DATETIME;
345
              aos.shell.config |= AOS_SHELL_CONFIG_PROMPT_UPTIME;
346 e545e620 Thomas Schöpping
              retval = AOS_OK;
347
            }
348 8399aeae Thomas Schöpping
            else if (strcmp(argv[3], "date&time") == 0) {
349 6b53f6bf Thomas Schöpping
              aos.shell.config &= ~AOS_SHELL_CONFIG_PROMPT_UPTIME;
350
              aos.shell.config |= AOS_SHELL_CONFIG_PROMPT_DATETIME;
351 8399aeae Thomas Schöpping
              retval = AOS_OK;
352
            }
353
            else {
354
              chprintf(stream, "unknown option '%s'\n", argv[3]);
355 916f8d28 Thomas Schöpping
              return AOS_INVALIDARGUMENTS;
356 8399aeae Thomas Schöpping
            }
357 e545e620 Thomas Schöpping
          }
358
        }
359
        // if the user wants to modify the string matching
360
        else if (strcmp(argv[2], "match") == 0) {
361
          // there must be a further argument
362
          if (argc > 3) {
363
            if (strcmp(argv[3], "casesensitive") == 0) {
364 6b53f6bf Thomas Schöpping
              aos.shell.config |= AOS_SHELL_CONFIG_MATCH_CASE;
365 e545e620 Thomas Schöpping
              retval = AOS_OK;
366
            }
367
            else if (strcmp(argv[3], "caseinsensitive") == 0) {
368 6b53f6bf Thomas Schöpping
              aos.shell.config &= ~AOS_SHELL_CONFIG_MATCH_CASE;
369 e545e620 Thomas Schöpping
              retval = AOS_OK;
370
            }
371
          }
372
        }
373
      }
374
      // if the user wants to retrieve the shell configuration
375
      else {
376
        chprintf(stream, "current shell configuration:\n");
377
        chprintf(stream, "  prompt text:   %s\n",
378 6b53f6bf Thomas Schöpping
                 (aos.shell.prompt != NULL) ? aos.shell.prompt : "n/a");
379 8399aeae Thomas Schöpping
        char time[10];
380 6b53f6bf Thomas Schöpping
        switch (aos.shell.config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) {
381 8399aeae Thomas Schöpping
          case AOS_SHELL_CONFIG_PROMPT_UPTIME:
382
            strcpy(time, "uptime"); break;
383
          case AOS_SHELL_CONFIG_PROMPT_DATETIME:
384
            strcpy(time, "date&time"); break;
385
          default:
386
            strcpy(time, "no time"); break;
387
        }
388 e545e620 Thomas Schöpping
        chprintf(stream, "  prompt style:  %s, %s\n",
389 6b53f6bf Thomas Schöpping
                 (aos.shell.config & AOS_SHELL_CONFIG_PROMPT_MINIMAL) ? "minimal" : "text",
390 8399aeae Thomas Schöpping
                 time);
391 e545e620 Thomas Schöpping
        chprintf(stream, "  input method:  %s\n",
392 6b53f6bf Thomas Schöpping
                 (aos.shell.config & AOS_SHELL_CONFIG_INPUT_OVERWRITE) ? "replace" : "insert");
393 e545e620 Thomas Schöpping
        chprintf(stream, "  text matching: %s\n",
394 6b53f6bf Thomas Schöpping
                 (aos.shell.config & AOS_SHELL_CONFIG_MATCH_CASE) ? "case sensitive" : "case insensitive");
395 e545e620 Thomas Schöpping
        retval = AOS_OK;
396
      }
397
    }
398 23437e98 Thomas Schöpping
# if (HAL_USE_RTC == TRUE)
399 8399aeae Thomas Schöpping
    // if the user wants to configure the date or time
400
    else if (strcmp(argv[1], "--date&time") == 0 && argc == 4) {
401
      struct tm dt;
402
      aosSysGetDateTime(&dt);
403 23437e98 Thomas Schöpping
      int val = atoi(argv[3]);
404
      if (strcmp(argv[2], "year") == 0 && val >= 1900) {
405 8399aeae Thomas Schöpping
        dt.tm_year = val - 1900;
406
      }
407 23437e98 Thomas Schöpping
      else if (strcmp(argv[2], "month") == 0 && val > 0 && val <= 12) {
408 8399aeae Thomas Schöpping
        dt.tm_mon = val - 1;
409
      }
410 23437e98 Thomas Schöpping
      else if (strcmp(argv[2], "day") == 0 && val > 0 && val <= 31) {
411 8399aeae Thomas Schöpping
        dt.tm_mday = val;
412
      }
413 23437e98 Thomas Schöpping
      else if (strcmp(argv[2], "hour") == 0 && val >= 0 && val < 24) {
414 8399aeae Thomas Schöpping
        dt.tm_hour = val;
415
      }
416 23437e98 Thomas Schöpping
      else if (strcmp(argv[2], "minute") == 0 && val >= 0 && val < 60) {
417 8399aeae Thomas Schöpping
        dt.tm_min = val;
418
      }
419 23437e98 Thomas Schöpping
      else if (strcmp(argv[2], "second") == 0 && val >= 0 && val < 60) {
420 8399aeae Thomas Schöpping
        dt.tm_sec = val;
421
      }
422
      else {
423 23437e98 Thomas Schöpping
        chprintf(stream, "unknown option '%s' or invalid value '%s'\n", argv[2], argv[3]);
424 916f8d28 Thomas Schöpping
        return AOS_INVALIDARGUMENTS;
425 8399aeae Thomas Schöpping
      }
426 cda14729 Thomas Schöpping
      dt.tm_wday = aosTimeDayOfWeekFromDate((uint16_t)dt.tm_mday, (uint8_t)dt.tm_mon+1, (uint16_t)dt.tm_year+1900) % DAYS_PER_WEEK;
427 8399aeae Thomas Schöpping
      aosSysSetDateTime(&dt);
428
429
      // read and print new date and time
430
      aosSysGetDateTime(&dt);
431 437900eb Thomas Schöpping
      chprintf(stream, "date/time set to %04u-%02u-%02u %02u:%02u:%02u\n",
432
               dt.tm_year+1900, dt.tm_mon+1, dt.tm_mday,
433
               dt.tm_hour, dt.tm_min, dt.tm_sec);
434 8399aeae Thomas Schöpping
435
      retval = AOS_OK;
436
    }
437 7de0cc90 Thomas Schöpping
#endif /* (HAL_USE_RTC == TRUE) */
438 e545e620 Thomas Schöpping
  }
439
440
  // print help, if required
441 916f8d28 Thomas Schöpping
  if (retval == AOS_INVALIDARGUMENTS) {
442 e545e620 Thomas Schöpping
    chprintf(stream, "Usage: %s OPTION\n", argv[0]);
443
    chprintf(stream, "Options:\n");
444
    chprintf(stream, "  --help\n");
445
    chprintf(stream, "    Print this help text.\n");
446
    chprintf(stream, "  --shell [OPT [VAL]]\n");
447
    chprintf(stream, "    Set or retrieve shell configuration.\n");
448
    chprintf(stream, "    Possible OPTs and VALs are:\n");
449 8399aeae Thomas Schöpping
    chprintf(stream, "      prompt text|minimal|uptime|date&time|notime\n");
450 e545e620 Thomas Schöpping
    chprintf(stream, "        Configures the prompt.\n");
451
    chprintf(stream, "      match casesensitive|caseinsenitive\n");
452
    chprintf(stream, "        Configures string matching.\n");
453 23437e98 Thomas Schöpping
#if (HAL_USE_RTC == TRUE)
454 8399aeae Thomas Schöpping
    chprintf(stream, "  --date&time OPT VAL\n");
455
    chprintf(stream, "    Set the date/time value of OPT to VAL.\n");
456
    chprintf(stream, "    Possible OPTs are:\n");
457
    chprintf(stream, "      year\n");
458
    chprintf(stream, "      month\n");
459
    chprintf(stream, "      day\n");
460
    chprintf(stream, "      hour\n");
461
    chprintf(stream, "      minute\n");
462
    chprintf(stream, "      second\n");
463 7de0cc90 Thomas Schöpping
#endif /* (HAL_USE_RTC == TRUE) */
464 e545e620 Thomas Schöpping
  }
465
466
  return (argc > 1 && strcmp(argv[1], "--help") == 0) ? AOS_OK : retval;
467
}
468
469
/**
470
 * @brief   Callback function for the system:info shell command.
471
 *
472
 * @param[in] stream    The I/O stream to use.
473
 * @param[in] argc      Number of arguments.
474
 * @param[in] argv      List of pointers to the arguments.
475
 *
476
 * @return            An exit status.
477
 * @retval  AOS_OK    The command was executed successfully.
478
 */
479
static int _shellcmd_infocb(BaseSequentialStream* stream, int argc, char* argv[])
480
{
481 ba516b61 Thomas Schöpping
  aosDbgCheck(stream != NULL);
482
483 e545e620 Thomas Schöpping
  (void)argc;
484
  (void)argv;
485
486
  // print system information
487
  _printSystemInfo(stream);
488
489
  // print time measurement precision
490 3e1a9c79 Thomas Schöpping
  chprintf(stream, "module time resolution: %uus\n", AOS_SYSTEM_TIME_RESOLUTION);
491 e545e620 Thomas Schöpping
492
  // print system uptime
493
  aos_timestamp_t uptime;
494
  aosSysGetUptime(&uptime);
495
  chprintf(stream, "The system is running for\n");
496
  chprintf(stream, "%10u days\n", (uint32_t)(uptime / MICROSECONDS_PER_DAY));
497
  chprintf(stream, "%10u hours\n", (uint8_t)(uptime % MICROSECONDS_PER_DAY / MICROSECONDS_PER_HOUR));
498
  chprintf(stream, "%10u minutes\n", (uint8_t)(uptime % MICROSECONDS_PER_HOUR / MICROSECONDS_PER_MINUTE));
499
  chprintf(stream, "%10u seconds\n", (uint8_t)(uptime % MICROSECONDS_PER_MINUTE / MICROSECONDS_PER_SECOND));
500
  chprintf(stream, "%10u milliseconds\n", (uint16_t)(uptime % MICROSECONDS_PER_SECOND / MICROSECONDS_PER_MILLISECOND));
501
  chprintf(stream, "%10u microseconds\n", (uint16_t)(uptime % MICROSECONDS_PER_MILLISECOND / MICROSECONDS_PER_MICROSECOND));
502 9ebb11a9 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true) && (AMIROOS_CFG_SSSP_MASTER != true) && (AMIROOS_CFG_PROFILE == true)
503 c218345a Thomas Schöpping
  chprintf(stream, "SSSP synchronization offset: %.3fus per %uus\n", (double)aosSsspGetSyncSkew(), AMIROOS_CFG_SSSP_SYSSYNCPERIOD);
504 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) && (AMIROOS_CFG_SSSP_MASTER != true) && (AMIROOS_CFG_PROFILE == true) */
505 3e1a9c79 Thomas Schöpping
  _printSystemInfoSeparator(stream, '=', SYSTEM_INFO_WIDTH);
506 e545e620 Thomas Schöpping
507 aed3754b Thomas Schöpping
  // print shell info
508
  chprintf(stream, "System shell information:\n");
509 62397067 Thomas Schöpping
  chprintf(stream, "\tcommands available:     %u\n", aosShellCountCommands(&aos.shell));
510 10fd7ac9 Thomas Schöpping
  chprintf(stream, "\tline width:             %u characters\n", aos.shell.input.length);
511
  chprintf(stream, "\tmaximum arguments:      %u\n", aos.shell.input.nargs);
512 5c9e9b9d Thomas Schöpping
#if (AMIROOS_CFG_DBG == true)
513 62397067 Thomas Schöpping
  chprintf(stream, "\tthread stack size:      %u bytes\n", aosThdGetStacksize(aos.shell.thread));
514 aed3754b Thomas Schöpping
#if (CH_DBG_FILL_THREADS == TRUE)
515 83e58975 Thomas Schöpping
  chprintf(stream, "\tstack peak utilization: %u bytes (%.2f%%)\n", aosThdGetStackPeakUtilization(aos.shell.thread), (double)((float)(aosThdGetStackPeakUtilization(aos.shell.thread)) / (float)(aosThdGetStacksize(aos.shell.thread)) * 100.0f));
516 7de0cc90 Thomas Schöpping
#endif /* (CH_DBG_FILL_THREADS == TRUE) */
517
#endif /* (AMIROOS_CFG_DBG == true) */
518 aed3754b Thomas Schöpping
  _printSystemInfoSeparator(stream, '=', SYSTEM_INFO_WIDTH);
519
520 e545e620 Thomas Schöpping
  return AOS_OK;
521
}
522
523
/**
524 cda14729 Thomas Schöpping
 * @brief   Callback function for the sytem:shutdown or module:shutdown shell command.
525 e545e620 Thomas Schöpping
 *
526
 * @param[in] stream    The I/O stream to use.
527
 * @param[in] argc      Number of arguments.
528
 * @param[in] argv      List of pointers to the arguments.
529
 *
530
 * @return              An exit status.
531
 * @retval  AOS_OK                  The command was executed successfully.
532 916f8d28 Thomas Schöpping
 * @retval  AOS_INVALIDARGUMENTS   There was an issue with the arguments.
533 e545e620 Thomas Schöpping
 */
534
static int _shellcmd_shutdowncb(BaseSequentialStream* stream, int argc, char* argv[])
535
{
536 ba516b61 Thomas Schöpping
  aosDbgCheck(stream != NULL);
537
538 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_NONE)
539
540
  (void)argv;
541
542 510b93cc Thomas Schöpping
  if (argc != 1) {
543
    // error
544
    chprintf(stream, "ERROR: no arguments allowed.\n");
545
    return AOS_INVALIDARGUMENTS;
546
  } else {
547
    // broadcast shutdown event
548
    chEvtBroadcastFlags(&aos.events.os, AOS_SYSTEM_EVENTFLAGS_SHUTDOWN_MASK);
549
    // set terminate flag so no further prompt will be printed
550
    chThdTerminate(chThdGetSelfX());
551
    return AOS_OK;
552
  }
553 cda14729 Thomas Schöpping
554
#elif (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT)
555
556 e545e620 Thomas Schöpping
  // print help text
557
  if (argc != 2 || strcmp(argv[1], "--help") == 0) {
558
    chprintf(stream, "Usage: %s OPTION\n", argv[0]);
559
    chprintf(stream, "Options:\n");
560
    chprintf(stream, "  --help\n");
561
    chprintf(stream, "    Print this help text.\n");
562
    chprintf(stream, "  --hibernate, -h\n");
563
    chprintf(stream, "    Shutdown to hibernate mode.\n");
564
    chprintf(stream, "    Least energy saving, but allows charging via pins.\n");
565
    chprintf(stream, "  --deepsleep, -d\n");
566
    chprintf(stream, "    Shutdown to deepsleep mode.\n");
567
    chprintf(stream, "    Minimum energy consumption while allowing charging via plug.\n");
568
    chprintf(stream, "  --transportation, -t\n");
569
    chprintf(stream, "    Shutdown to transportation mode.\n");
570
    chprintf(stream, "    Minimum energy consumption with all interrupts disabled (no charging).\n");
571
    chprintf(stream, "  --restart, -r\n");
572
    chprintf(stream, "    Shutdown and restart system.\n");
573
574 916f8d28 Thomas Schöpping
    return (argc != 2) ? AOS_INVALIDARGUMENTS : AOS_OK;
575 e545e620 Thomas Schöpping
  }
576
  // handle argument
577
  else {
578
    if (strcmp(argv[1], "-h") == 0 || strcmp(argv[1], "--hibernate") == 0) {
579 cda14729 Thomas Schöpping
      // broadcast shutdown event
580
      chEvtBroadcastFlags(&aos.events.os, AOS_SYSTEM_EVENTFLAGS_SHUTDOWN_HIBERNATE);
581
      // set terminate flag so no further prompt will be printed
582 9b5281e9 Thomas Schöpping
      chThdTerminate(chThdGetSelfX());
583 e545e620 Thomas Schöpping
      return AOS_OK;
584
    }
585
    else if (strcmp(argv[1], "-d") == 0 || strcmp(argv[1], "--deepsleep") == 0) {
586 cda14729 Thomas Schöpping
      // broadcast shutdown event
587
      chEvtBroadcastFlags(&aos.events.os, AOS_SYSTEM_EVENTFLAGS_SHUTDOWN_DEEPSLEEP);
588
      // set terminate flag so no further prompt will be printed
589 9b5281e9 Thomas Schöpping
      chThdTerminate(chThdGetSelfX());
590 e545e620 Thomas Schöpping
      return AOS_OK;
591
    }
592
    else if (strcmp(argv[1], "-t") == 0 || strcmp(argv[1], "--transportation") == 0) {
593 cda14729 Thomas Schöpping
      // broadcast shutdown event
594
      chEvtBroadcastFlags(&aos.events.os, AOS_SYSTEM_EVENTFLAGS_SHUTDOWN_TRANSPORTATION);
595
      // set terminate flag so no further prompt will be printed
596 9b5281e9 Thomas Schöpping
      chThdTerminate(chThdGetSelfX());
597 e545e620 Thomas Schöpping
      return AOS_OK;
598
    }
599
    else if (strcmp(argv[1], "-r") == 0 || strcmp(argv[1], "--restart") == 0) {
600 cda14729 Thomas Schöpping
      // broadcast shutdown event
601
      chEvtBroadcastFlags(&aos.events.os, AOS_SYSTEM_EVENTFLAGS_SHUTDOWN_RESTART);
602
      // set terminate flag so no further prompt will be printed
603 9b5281e9 Thomas Schöpping
      chThdTerminate(chThdGetSelfX());
604 e545e620 Thomas Schöpping
      return AOS_OK;
605
    }
606
    else {
607
      chprintf(stream, "unknown argument %s\n", argv[1]);
608 916f8d28 Thomas Schöpping
      return AOS_INVALIDARGUMENTS;
609 e545e620 Thomas Schöpping
    }
610
  }
611 1d3e002f Thomas Schöpping
612 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_BOOTLOADER == X) */
613 e545e620 Thomas Schöpping
}
614
615
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
616 cda14729 Thomas Schöpping
617 e545e620 Thomas Schöpping
/**
618
 * @brief   Callback function for the kernel:test shell command.
619
 *
620
 * @param[in] stream    The I/O stream to use.
621
 * @param[in] argc      Number of arguments.
622
 * @param[in] argv      List of pointers to the arguments.
623
 *
624
 * @return      An exit status.
625
 */
626
static int _shellcmd_kerneltestcb(BaseSequentialStream* stream, int argc, char* argv[])
627
{
628 ba516b61 Thomas Schöpping
  aosDbgCheck(stream != NULL);
629
630 e545e620 Thomas Schöpping
  (void)argc;
631
  (void)argv;
632
633 0128be0f Marc Rothmann
  msg_t retval = test_execute(stream, &rt_test_suite);
634 e545e620 Thomas Schöpping
635
  return retval;
636
}
637 cda14729 Thomas Schöpping
638 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
639 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
640 e545e620 Thomas Schöpping
641 6d5d8856 Thomas Schöpping
// suppress warning in case no interrupt GPIOs are defined
642
#pragma GCC diagnostic push
643
#pragma GCC diagnostic ignored "-Wunused-function"
644 e545e620 Thomas Schöpping
/**
645 1e5f7648 Thomas Schöpping
 * @brief   Generic callback function for GPIO interrupts.
646 e545e620 Thomas Schöpping
 *
647 3106e8cc Thomas Schöpping
 * @param[in] args   Pointer to the GPIO line identifier.
648 e545e620 Thomas Schöpping
 */
649 cda14729 Thomas Schöpping
static void _gpioCallback(void* args)
650 e545e620 Thomas Schöpping
{
651 3106e8cc Thomas Schöpping
  aosDbgCheck((args != NULL) && (*((ioline_t*)args) != PAL_NOLINE) && (PAL_PAD(*((ioline_t*)args)) < sizeof(eventflags_t) * 8));
652 e545e620 Thomas Schöpping
653
  chSysLockFromISR();
654 cda14729 Thomas Schöpping
  chEvtBroadcastFlagsI(&aos.events.gpio, AOS_GPIOEVENT_FLAG(PAL_PAD(*((ioline_t*)args))));
655 e545e620 Thomas Schöpping
  chSysUnlockFromISR();
656
657
  return;
658
}
659 6d5d8856 Thomas Schöpping
#pragma GCC diagnostic pop
660 e545e620 Thomas Schöpping
661
/**
662
 * @brief   Callback function for the uptime accumulation timer.
663
 *
664
 * @param[in] par   Generic parameter.
665
 */
666
static void _uptimeCallback(void* par)
667
{
668
  (void)par;
669
670
  chSysLockFromISR();
671
  // read current time in system ticks
672
  register const systime_t st = chVTGetSystemTimeX();
673
  // update the uptime variables
674 1e5f7648 Thomas Schöpping
  _uptime += chTimeI2US(chTimeDiffX(_synctime, st));
675 e545e620 Thomas Schöpping
  _synctime = st;
676
  // enable the timer again
677
  chVTSetI(&_systimer, SYSTIMER_PERIOD, &_uptimeCallback, NULL);
678
  chSysUnlockFromISR();
679
680
  return;
681
}
682
683 cda14729 Thomas Schöpping
/**
684
 * @brief   Retreive the number of active threads.
685
 *
686
 * @return  Number of active threads.
687
 */
688
size_t _numActiveThreads(void)
689
{
690
  size_t threads = 0;
691
  thread_t* tp = chRegFirstThread();
692
  while (tp) {
693
    threads += (tp->state == CH_STATE_FINAL) ? 1 : 0;
694
    tp = chRegNextThread(tp);
695
  }
696
697
  return threads;
698
}
699
700 f3ac1c96 Thomas Schöpping
/******************************************************************************/
701
/* EXPORTED FUNCTIONS                                                         */
702
/******************************************************************************/
703
704 e545e620 Thomas Schöpping
/**
705
 * @brief   AMiRo-OS system initialization.
706
 * @note    Must be called from the system control thread (usually main thread).
707
 *
708
 * @param[in] shellPrompt   String to be printed as prompt of the system shell.
709
 */
710 6b53f6bf Thomas Schöpping
void aosSysInit(const char* shellPrompt)
711 e545e620 Thomas Schöpping
{
712 1e5f7648 Thomas Schöpping
  /* set control thread to maximum priority */
713 512abac1 Thomas Schöpping
  chThdSetPriority(AOS_THD_CTRLPRIO);
714 e545e620 Thomas Schöpping
715 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true)
716 c218345a Thomas Schöpping
  aosSsspInit(&_uptime);
717 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
718
719 1e5f7648 Thomas Schöpping
  /* set local variables */
720 e545e620 Thomas Schöpping
  chVTObjectInit(&_systimer);
721 9ebb11a9 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true)
722 c218345a Thomas Schöpping
  // uptime counter is started when SSSP proceeds to operation phase
723 e545e620 Thomas Schöpping
  _synctime = 0;
724
  _uptime = 0;
725 7de0cc90 Thomas Schöpping
#else /* (AMIROOS_CFG_SSSP_ENABLE == true) */
726 9ebb11a9 Thomas Schöpping
  // start the uptime counter
727
  chSysLock();
728 c218345a Thomas Schöpping
  aosSysStartUptimeS();
729 9ebb11a9 Thomas Schöpping
  chSysUnlock();
730 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
731 e545e620 Thomas Schöpping
732 1e5f7648 Thomas Schöpping
  /* initialize aos configuration */
733 ba516b61 Thomas Schöpping
  aosIOStreamInit(&aos.iostream);
734 cda14729 Thomas Schöpping
  chEvtObjectInit(&aos.events.gpio);
735 6b53f6bf Thomas Schöpping
  chEvtObjectInit(&aos.events.os);
736 e545e620 Thomas Schöpping
737 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SHELL_ENABLE == true)
738
739 1e5f7648 Thomas Schöpping
  /* init shell */
740 6b53f6bf Thomas Schöpping
  aosShellInit(&aos.shell,
741
               &aos.events.os,
742 e545e620 Thomas Schöpping
               shellPrompt,
743
               _shell_line,
744
               AMIROOS_CFG_SHELL_LINEWIDTH,
745
               AMIROOS_CFG_SHELL_MAXARGS);
746
  // add system commands
747 6b53f6bf Thomas Schöpping
  aosShellAddCommand(&aos.shell, &_shellcmd_config);
748
  aosShellAddCommand(&aos.shell, &_shellcmd_info);
749
  aosShellAddCommand(&aos.shell, &_shellcmd_shutdown);
750 e545e620 Thomas Schöpping
#if (AMIROOS_CFG_TESTS_ENABLE == true)
751 6b53f6bf Thomas Schöpping
  aosShellAddCommand(&aos.shell, &_shellcmd_kerneltest);
752 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
753 cda14729 Thomas Schöpping
754 c218345a Thomas Schöpping
#else /* (AMIROOS_CFG_SHELL_ENABLE == true) */
755
756
  // suppress unused variable warnings
757
  (void)shellPrompt;
758
759 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
760 e545e620 Thomas Schöpping
761
  return;
762
}
763
764
/**
765
 * @brief   Starts the system and all system threads.
766
 */
767 cda14729 Thomas Schöpping
void aosSysStart(void)
768 e545e620 Thomas Schöpping
{
769 ba516b61 Thomas Schöpping
  // print system information;
770
  _printSystemInfo((BaseSequentialStream*)&aos.iostream);
771 e545e620 Thomas Schöpping
  aosprintf("\n");
772
773 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SHELL_ENABLE == true)
774 e545e620 Thomas Schöpping
  // start system shell thread
775 0a89baf2 Thomas Schöpping
#if (CH_CFG_USE_THREADHIERARCHY == TRUE)
776
  aos.shell.thread = chThdCreateStatic(_shell_wa, sizeof(_shell_wa), AMIROOS_CFG_SHELL_THREADPRIO, aosShellThread, &aos.shell, &ch.mainthread);
777 7de0cc90 Thomas Schöpping
#else /* (CH_CFG_USE_THREADHIERARCHY == TRUE) */
778 6b53f6bf Thomas Schöpping
  aos.shell.thread = chThdCreateStatic(_shell_wa, sizeof(_shell_wa), AMIROOS_CFG_SHELL_THREADPRIO, aosShellThread, &aos.shell);
779 7de0cc90 Thomas Schöpping
#endif /* (CH_CFG_USE_THREADHIERARCHY == TRUE) */
780 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
781 e545e620 Thomas Schöpping
782
  return;
783
}
784
785
/**
786 cda14729 Thomas Schöpping
 * @brief   Start the system uptime measurement.
787 c218345a Thomas Schöpping
 * @note    Must be called from a locked context.
788 e545e620 Thomas Schöpping
 */
789 c218345a Thomas Schöpping
void aosSysStartUptimeS(void)
790 e545e620 Thomas Schöpping
{
791 c218345a Thomas Schöpping
  chDbgCheckClassS();
792 e545e620 Thomas Schöpping
793 c218345a Thomas Schöpping
  // start the uptime aggregation counter
794 cda14729 Thomas Schöpping
  _synctime = chVTGetSystemTimeX();
795
  _uptime = 0;
796
  chVTSetI(&_systimer, SYSTIMER_PERIOD, &_uptimeCallback, NULL);
797 e545e620 Thomas Schöpping
798 cda14729 Thomas Schöpping
  return;
799 e545e620 Thomas Schöpping
}
800 cda14729 Thomas Schöpping
801 e545e620 Thomas Schöpping
/**
802
 * @brief   Retrieves the system uptime.
803
 *
804
 * @param[out] ut   The system uptime.
805
 */
806 cda14729 Thomas Schöpping
void aosSysGetUptimeX(aos_timestamp_t* ut)
807 e545e620 Thomas Schöpping
{
808
  aosDbgCheck(ut != NULL);
809
810 1e5f7648 Thomas Schöpping
  *ut = _uptime + chTimeI2US(chTimeDiffX(_synctime, chVTGetSystemTimeX()));
811 e545e620 Thomas Schöpping
812
  return;
813
}
814
815 23437e98 Thomas Schöpping
#if (HAL_USE_RTC == TRUE) || defined(__DOXYGEN__)
816
817 e545e620 Thomas Schöpping
/**
818 8399aeae Thomas Schöpping
 * @brief   retrieves the date and time from the MCU clock.
819
 *
820
 * @param[out] td   The date and time.
821
 */
822
void aosSysGetDateTime(struct tm* dt)
823
{
824
  aosDbgCheck(dt != NULL);
825
826
  RTCDateTime rtc;
827
  rtcGetTime(&MODULE_HAL_RTC, &rtc);
828
  rtcConvertDateTimeToStructTm(&rtc, dt, NULL);
829
830
  return;
831
}
832
833
/**
834
 * @brief   set the date and time of the MCU clock.
835
 *
836
 * @param[in] dt    The date and time to set.
837
 */
838
void aosSysSetDateTime(struct tm* dt)
839
{
840
  aosDbgCheck(dt != NULL);
841
842
  RTCDateTime rtc;
843
  rtcConvertStructTmToDateTime(dt, 0, &rtc);
844
  rtcSetTime(&MODULE_HAL_RTC, &rtc);
845
846
  return;
847
}
848
849 7de0cc90 Thomas Schöpping
#endif /* (HAL_USE_RTC == TRUE) */
850 23437e98 Thomas Schöpping
851 8399aeae Thomas Schöpping
/**
852 e545e620 Thomas Schöpping
 * @brief   Initializes/Acknowledges a system shutdown/restart request.
853
 * @note    This functions should be called from the thread with highest priority.
854
 *
855
 * @param[in] shutdown    Type of shutdown.
856
 */
857
void aosSysShutdownInit(aos_shutdown_t shutdown)
858
{
859
  // check arguments
860
  aosDbgCheck(shutdown != AOS_SHUTDOWN_NONE);
861
862 9ebb11a9 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true)
863 cda14729 Thomas Schöpping
864
  // activate the PD signal only if this module initiated the shutdown
865 e545e620 Thomas Schöpping
  if (shutdown != AOS_SHUTDOWN_PASSIVE) {
866 c218345a Thomas Schöpping
    aosSsspShutdownInit(true);
867 e545e620 Thomas Schöpping
  }
868
869
  switch (shutdown) {
870
    case AOS_SHUTDOWN_PASSIVE:
871 cda14729 Thomas Schöpping
      chEvtBroadcastFlags(&aos.events.os, AOS_SYSTEM_EVENTFLAGS_SHUTDOWN_PASSIVE);
872 e545e620 Thomas Schöpping
      aosprintf("shutdown request received...\n");
873
      break;
874 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_NONE)
875
    case AOS_SHUTDOWN_ACTIVE:
876
      aosprintf("shutdown initiated...\n");
877
      break;
878
#elif (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT)
879 e545e620 Thomas Schöpping
    case AOS_SHUTDOWN_HIBERNATE:
880
      aosprintf("shutdown to hibernate mode...\n");
881
      break;
882
    case AOS_SHUTDOWN_DEEPSLEEP:
883
      aosprintf("shutdown to deepsleep mode...\n");
884
      break;
885
    case AOS_SHUTDOWN_TRANSPORTATION:
886
      aosprintf("shutdown to transportation mode...\n");
887
      break;
888
    case AOS_SHUTDOWN_RESTART:
889
      aosprintf("restarting system...\n");
890
      break;
891 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_BOOTLOADER == X) */
892 1d3e002f Thomas Schöpping
    case AOS_SHUTDOWN_NONE:
893 cda14729 Thomas Schöpping
      // must never occur
894
      aosDbgAssert(false);
895 e545e620 Thomas Schöpping
      break;
896
  }
897
898 cda14729 Thomas Schöpping
#else /* (AMIROOS_CFG_SSSP_ENABLE == true) */
899
900
  aosprintf("shutdown initiated...\n");
901
902 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
903 e545e620 Thomas Schöpping
904
  return;
905
}
906
907
/**
908
 * @brief   Stops the system and all related threads (not the thread this function is called from).
909
 */
910
void aosSysStop(void)
911
{
912 cda14729 Thomas Schöpping
  // wait until the calling thread is the only remaining active thread
913
#if (CH_CFG_NO_IDLE_THREAD == TRUE)
914
  while (_numActiveThreads() > 1) {
915
#else /* (CH_CFG_NO_IDLE_THREAD == TRUE) */
916
  while (_numActiveThreads() > 2) {
917
#endif /* (CH_CFG_NO_IDLE_THREAD == TRUE) */
918
    aosDbgPrintf("waiting for all threads to terminate...\n");
919
    chThdYield();
920
  }
921 e545e620 Thomas Schöpping
922
  return;
923
}
924
925
/**
926
 * @brief   Deinitialize all system variables.
927
 */
928
void aosSysDeinit(void)
929
{
930
  return;
931
}
932
933 cda14729 Thomas Schöpping
#if ((AMIROOS_CFG_SSSP_ENABLE == true) && (AMIROOS_CFG_SSSP_SHUTDOWN != true)) ||                 \
934
    ((AMIROOS_CFG_SSSP_ENABLE != true) && (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT)) || \
935
    defined(__DOXYGEN__)
936
937 e545e620 Thomas Schöpping
/**
938
 * @brief   Finally shuts down the system and calls the bootloader callback function.
939
 * @note    This function should be called from the thtead with highest priority.
940
 *
941
 * @param[in] shutdown    Type of shutdown.
942
 */
943 cda14729 Thomas Schöpping
void aosSysShutdownToBootloader(aos_shutdown_t shutdown)
944 e545e620 Thomas Schöpping
{
945
  // check arguments
946
  aosDbgCheck(shutdown != AOS_SHUTDOWN_NONE);
947
948 1e5f7648 Thomas Schöpping
  // disable all interrupts
949
  irqDeinit();
950 e545e620 Thomas Schöpping
951 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT)
952
  // validate AMiRo-BLT
953 41fc7088 Thomas Schöpping
  if ((BL_CALLBACK_TABLE_ADDRESS->magicNumber == BL_MAGIC_NUMBER) &&
954
      (BL_CALLBACK_TABLE_ADDRESS->vBootloader.major == BL_VERSION_MAJOR) &&
955
      (BL_CALLBACK_TABLE_ADDRESS->vBootloader.minor >= BL_VERSION_MINOR)) {
956
    // call bootloader callback depending on arguments
957
    switch (shutdown) {
958 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true)
959 41fc7088 Thomas Schöpping
      case AOS_SHUTDOWN_PASSIVE:
960
        BL_CALLBACK_TABLE_ADDRESS->cbHandleShutdownRequest();
961
        break;
962 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
963 41fc7088 Thomas Schöpping
      case AOS_SHUTDOWN_HIBERNATE:
964
        BL_CALLBACK_TABLE_ADDRESS->cbShutdownHibernate();
965
        break;
966
      case AOS_SHUTDOWN_DEEPSLEEP:
967
        BL_CALLBACK_TABLE_ADDRESS->cbShutdownDeepsleep();
968
        break;
969
      case AOS_SHUTDOWN_TRANSPORTATION:
970
        BL_CALLBACK_TABLE_ADDRESS->cbShutdownTransportation();
971
        break;
972
      case AOS_SHUTDOWN_RESTART:
973
        BL_CALLBACK_TABLE_ADDRESS->cbShutdownRestart();
974
        break;
975
      // must never occur
976
      case AOS_SHUTDOWN_NONE:
977
      default:
978
        break;
979
    }
980
  } else {
981 cda14729 Thomas Schöpping
    // fallback if AMiRo-BLT was found to be invalid
982
    aosprintf("ERROR: AMiRo-BLT incompatible or not available!\n");
983 ffbd63e4 Thomas Schöpping
    aosThdMSleep(10);
984
    chSysDisable();
985 e545e620 Thomas Schöpping
  }
986 cda14729 Thomas Schöpping
#endif /* (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT) */
987 e545e620 Thomas Schöpping
988
  return;
989
}
990 53710ca3 Marc Rothmann
991 cda14729 Thomas Schöpping
#endif /* ((AMIROOS_CFG_SSSP_ENABLE == true) && (AMIROOS_CFG_SSSP_SHUTDOWN != true)) || ((AMIROOS_CFG_SSSP_ENABLE != true) && (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT)) */
992
993 3106e8cc Thomas Schöpping
/**
994
 * @brief   Generic callback function for GPIO interrupts.
995
 *
996 56dc4779 Thomas Schöpping
 * @return  Pointer to the callback function.
997 3106e8cc Thomas Schöpping
 */
998 cda14729 Thomas Schöpping
palcallback_t aosSysGetStdGpioCallback(void)
999 3106e8cc Thomas Schöpping
{
1000 cda14729 Thomas Schöpping
  return _gpioCallback;
1001 3106e8cc Thomas Schöpping
}
1002
1003 53710ca3 Marc Rothmann
/** @} */