/modules/PowerManagement_1-1/aosconf.h - Annotate - AMiRo-OS - Research for Cognitive Interaction

amiro-os / modules / PowerManagement_1-1 / aosconf.h @ 55a84503

History | View | Annotate | Download (6.929 KB)

-            e545e620
+/*
 AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
-f0ce9e
+Copyright (C) 2016..2019  Thomas Schöpping et al.
-            e545e620
+            Thomas Schöpping
 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/>.
 */
-ca3
+/**
-c6b7
+ * @file
-ca3
+ * @brief   AMiRo-OS Configuration file for the PowerManagement v1.1 module.
  * @details Contains the application specific AMiRo-OS settings.
+ *
  * @addtogroup powermanagement_aos_config
  * @{
  */
-ff06bbf
+#ifndef AOSCONF_H
 #define AOSCONF_H
-            e545e620
+            Thomas Schöpping
 /*
  * compatibility guards
  */
 #define _AMIRO_OS_CFG_
-da800ab
+#define AMIRO_OS_CFG_VERSION_MAJOR              2
 #define AMIRO_OS_CFG_VERSION_MINOR              0
-            e545e620
+            Thomas Schöpping
 #include <stdbool.h>
 /*
  * Include an external configuration file to override the following default settings only if required.
  */
 #if defined(AMIRO_APPS) && (AMIRO_APPS == true)
   #include <osconf.h>
 #endif
-b53f6bf
+/*===========================================================================*/
-            e545e620
+/**
-b53f6bf
+ * @name Kernel parameters and options
  * @{
-            e545e620
+ */
-b53f6bf
+/*===========================================================================*/
-            e545e620
+            Thomas Schöpping
 /**
-e1a9c79
+ * @brief   Flag to enable/disable debug API and logic.
-            e545e620
+ */
 #if !defined(OS_CFG_DBG)
   #define AMIROOS_CFG_DBG                       true
 #else
   #define AMIROOS_CFG_DBG                       OS_CFG_DBG
 #endif
 /**
  * @brief   Flag to enable/disable unit tests.
-dd2e257
+ * @note    Setting this flag will implicitely enable the shell.
-            e545e620
+ */
 #if !defined(OS_CFG_TESTS_ENABLE)
   #define AMIROOS_CFG_TESTS_ENABLE              true
 #else
   #define AMIROOS_CFG_TESTS_ENABLE              OS_CFG_TESTS_ENABLE
 #endif
 /**
-e1a9c79
+ * @brief   Flag to enable/disable profiling API and logic.
-            e545e620
+ */
 #if !defined(OS_CFG_PROFILE)
   #define AMIROOS_CFG_PROFILE                   true
 #else
   #define AMIROOS_CFG_PROFILE                   OS_CFG_PROFILE
 #endif
 /**
-c6b7
+ * @brief   Mask for the control thread to listen to certain IO events.
  * @note    Any mandatory events (e.g. for SSSP) are enabled implicitely despite this configuration.
  */
 #if !defined(OS_CFG_MAIN_LOOP_IOEVENT_MASK)
   #define AMIROOS_CFG_MAIN_LOOP_IOEVENT_MASK    0
 #else
   #define AMIROOS_CFG_MAIN_LOOP_IOEVENT_MASK    OS_CFG_MAIN_LOOP_IOEVENT_MASK
 #endif
 /**
-            e545e620
+ * @brief   Timeout value when waiting for events in the main loop in microseconds.
  * @details A value of 0 deactivates the timeout.
  */
 #if !defined(OS_CFG_MAIN_LOOP_TIMEOUT)
   #define AMIROOS_CFG_MAIN_LOOP_TIMEOUT         0
 #else
   #define AMIROOS_CFG_MAIN_LOOP_TIMEOUT         OS_CFG_MAIN_LOOP_TIMEOUT
 #endif
 /** @} */
 /*===========================================================================*/
-b53f6bf
+/**
  * @name SSSP (Startup Shutdown Synchronization Protocol) configuration.
  * @{
  */
 /*===========================================================================*/
 /**
-ebb11a9
+ * @brief   Flag to enable SSSP.
  */
 #if !defined(OS_CFG_SSSP_ENABLE)
   #define AMIROOS_CFG_SSSP_ENABLE               true
 #else
   #define AMIROOS_CFG_SSSP_ENABLE               OS_CFG_SSSP_ENABLE
 #endif
 /**
-b53f6bf
+ * @brief   Flag to set the module as SSSP master.
  * @details There must be only one module with this flag set to true in a system.
  */
 #if !defined(OS_CFG_SSSP_MASTER)
   #define AMIROOS_CFG_SSSP_MASTER               true
 #else
   #define AMIROOS_CFG_SSSP_MASTER               OS_CFG_SSSP_MASTER
 #endif
 /**
-df08e
+ * @brief   Flag to set the module to be the first in the stack.
  * @details There must be only one module with this flag set to true in a system.
  */
 #if !defined(OS_CFG_SSSP_STACK_START)
   #define AMIROOS_CFG_SSSP_STACK_START          false
 #else
   #define AMIROOS_CFG_SSSP_STACK_START          OS_CFG_SSSP_STACK_START
 #endif
 /**
  * @brief   Flag to set the module to be the last in the stack.
  * @details There must be only one module with this flag set to true in a system.
  */
 #if !defined(OS_CFG_SSSP_STACK_END)
   #define AMIROOS_CFG_SSSP_STACK_END            false
 #else
   #define AMIROOS_CFG_SSSP_STACK_END            OS_CFG_SSSP_STACK_END
 #endif
 /**
  * @brief   Delay time (in microseconds) how long a SSSP signal must be active.
  */
 #if !defined(OS_CFG_SSSP_SIGNALDELAY)
   #define AMIROOS_CFG_SSSP_SIGNALDELAY          1000
 #else
   #define AMIROOS_CFG_SSSP_SIGNALDELAY          OS_CFG_SSSP_SIGNALDELAY
 #endif
 /**
-b53f6bf
+ * @brief   Time boundary for robot wide clock synchronization in microseconds.
  * @details Whenever the SSSP S (snychronization) signal gets logically deactivated,
  *          All modules need to align their local uptime to the nearest multiple of this value.
  */
 #if !defined(OS_CFG_SSSP_SYSSYNCPERIOD)
   #define AMIROOS_CFG_SSSP_SYSSYNCPERIOD        1000000
 #else
   #define AMIROOS_CFG_SSSP_SYSSYNCPERIOD        OS_CFG_SSSP_SYSSYNCPERIOD
 #endif
 /** @} */
 /*===========================================================================*/
-            e545e620
+/**
  * @name System shell options
  * @{
  */
 /*===========================================================================*/
 /**
  * @brief   Shell enable flag.
  */
-dd2e257
+#if !defined(OS_CFG_SHELL_ENABLE)
-            e545e620
+  #define AMIROOS_CFG_SHELL_ENABLE              true
 #else
   #define AMIROOS_CFG_SHELL_ENABLE              OS_CFG_SHELL_ENABLE
 #endif
 /**
  * @brief   Shell thread stack size.
  */
 #if !defined(OS_CFG_SHELL_STACKSIZE)
   #define AMIROOS_CFG_SHELL_STACKSIZE           1024
 #else
   #define AMIROOS_CFG_SHELL_STACKSIZE           OS_CFG_SHELL_STACKSIZE
 #endif
 /**
-a98
+ * @brief   Shell thread priority.
-abac1
+ * @details Thread priorities are specified as an integer value.
  *          Predefined ranges are:
  *            lowest  ┌ THD_LOWPRIO_MIN
  *                    │ ...
  *                    └ THD_LOWPRIO_MAX
  *                    ┌ THD_NORMALPRIO_MIN
  *                    │ ...
  *                    └ THD_NORMALPRIO_MAX
  *                    ┌ THD_HIGHPRIO_MIN
  *                    │ ...
  *                    └ THD_HIGHPRIO_MAX
  *                    ┌ THD_RTPRIO_MIN
  *                    │ ...
  *            highest └ THD_RTPRIO_MAX
-a98
+ */
 #if !defined(OS_CFG_SHELL_THREADPRIO)
-abac1
+  #define AMIROOS_CFG_SHELL_THREADPRIO          AOS_THD_NORMALPRIO_MIN
-a98
+#else
   #define AMIROOS_CFG_SHELL_THREADPRIO          OS_CFG_SHELL_THREADPRIO
 #endif
 /**
-            e545e620
+ * @brief   Shell maximum input line length.
  */
 #if !defined(OS_CFG_SHELL_LINEWIDTH)
   #define AMIROOS_CFG_SHELL_LINEWIDTH           64
 #else
   #define AMIROOS_CFG_SHELL_LINEWIDTH           OS_CFG_SHELL_LINEWIDTH
 #endif
 /**
  * @brief   Shell maximum number of arguments.
  */
 #if !defined(OS_CFG_SHELL_MAXARGS)
   #define AMIROOS_CFG_SHELL_MAXARGS             4
 #else
   #define AMIROOS_CFG_SHELL_MAXARGS             OS_CFG_SHELL_MAXARGS
 #endif
 /** @} */
-ff06bbf
+#endif /* AOSCONF_H */
-            e545e620
+            Thomas Schöpping
-ca3
+/** @} */