/modules/STM32F407G-DISC1/module.h - Annotate - AMiRo-OS - Research for Cognitive Interaction

amiro-os / modules / STM32F407G-DISC1 / module.h @ 697dba3c

History | View | Annotate | Download (6.745 KB)

-ff44a7
+/*
 AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
-f0ce9e
+Copyright (C) 2016..2019  Thomas Schöpping et al.
-ff44a7
+            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/>.
 */
 /**
  * @file
-            a0301104
+ * @brief   Structures and constant for the STM32F4Discovery module.
-ff44a7
+            Thomas Schöpping
-            a0301104
+ * @addtogroup STM32F4Discovery_module
-ff44a7
+ * @{
  */
-ff06bbf
+#ifndef AMIROOS_MODULE_H
 #define AMIROOS_MODULE_H
-ff44a7
+            Thomas Schöpping
-            e2d7143f
+#include <amiroos.h>
-ff44a7
+/*===========================================================================*/
 /**
  * @name Module specific functions
  * @{
  */
 /*===========================================================================*/
 /*
  * @brief Makro to store data in the core coupled memory (ccm).
  *        Example:
  *        int compute_buffer[128] CCM_RAM;
+ *
  * @note The ccm is not connected to any bus system.
  */
 #define CCM_RAM                                 __attribute__((section(".ram4"), aligned(4)))
 /*
  * @brief Makro to store data in the ethernet memory (eth).
  *        Example:
  *        int dma_buffer[128] ETH_RAM;
+ *
  * @note The eth is a dedicated memory block with its own DMA controller.
  */
 #define ETH_RAM                                 __attribute__((section(".ram2"), aligned(4)))
 /*
  * @brief Makro to store data in the backup memory (bckp).
  *        Example:
  *        int backup_buffer[128] BCKP_RAM;
+ *
  * @note The eth is a dedicated memory block with its own DMA controller.
  */
 #define BCKP_RAM                                __attribute__((section(".ram5"), aligned(4)))
 /** @} */
 /*===========================================================================*/
 /**
  * @name ChibiOS/HAL configuration
  * @{
  */
 /*===========================================================================*/
 /**
  * @brief   Serial driver of the programmer interface.
  */
 #define MODULE_HAL_PROGIF                       SD2
 /**
  * @brief   Configuration for the programmer serial interface driver.
  */
 extern SerialConfig moduleHalProgIfConfig;
 /**
  * @brief   Real-Time Clock driver.
  */
 #define MODULE_HAL_RTC                          RTCD1
 /** @} */
 /*===========================================================================*/
 /**
  * @name GPIO definitions
  * @{
  */
 /*===========================================================================*/
 /**
  * @brief   Red LED output signal.
  */
 extern ROMCONST apalControlGpio_t moduleGpioLedRed;
 /**
  * @brief   Green LED output signal.
  */
 extern ROMCONST apalControlGpio_t moduleGpioLedGreen;
 /**
  * @brief   Blue LED output signal.
  */
 extern ROMCONST apalControlGpio_t moduleGpioLedBlue;
 /**
  * @brief   Orange LED output signal.
  */
 extern ROMCONST apalControlGpio_t moduleGpioLedOrange;
 /**
  * @brief   User button input signal.
  */
 extern ROMCONST apalControlGpio_t moduleGpioUserButton;
 /** @} */
 /*===========================================================================*/
 /**
  * @name AMiRo-OS core configurations
  * @{
  */
 /*===========================================================================*/
 /**
  * @brief   Event flag to be set on a USER_BUTTON interrupt.
  */
-            cda14729
+#define MODULE_OS_GPIOEVENTFLAG_USERBUTTON      AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_BUTTON))
-ff44a7
+            Thomas Schöpping
-            cda14729
+#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
-ff44a7
+/**
  * @brief   Shell prompt text.
  */
 extern ROMCONST char* moduleShellPrompt;
-            cda14729
+#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
-ff44a7
+            Thomas Schöpping
 /**
  * @brief   Interrupt initialization macro.
  */
 #define MODULE_INIT_INTERRUPTS() {                                            \
   /* user button */                                                           \
-            cda14729
+  palSetLineCallback(moduleGpioUserButton.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioUserButton.gpio->line);  \
-dc4779
+  palEnableLineEvent(moduleGpioUserButton.gpio->line, APAL2CH_EDGE(moduleGpioUserButton.meta.edge));                  \
-ff44a7
+            Thomas Schöpping
 /**
-            cda14729
+ * @brief   Test initialization hook.
-ff44a7
+ */
 #define MODULE_INIT_TESTS() {                                                 \
-            cda14729
+  /* add test commands to shell */                                            \
-ff44a7
+            Thomas Schöpping
 /**
  * @brief   Periphery communication interfaces initialization hook.
  */
-c72a54c
+#define MODULE_INIT_PERIPHERY_IF() {                                          \
-ff44a7
+  /* serial driver */                                                         \
   sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig);                        \
+}
 /**
  * @brief   Periphery communication interface deinitialization hook.
  */
-c72a54c
+#define MODULE_SHUTDOWN_PERIPHERY_IF() {                                      \
-            cda14729
+  /* don't stop the serial driver so messages can still be printed */         \
-ff44a7
+            Thomas Schöpping
 /**
  * @brief   HOOK to toggle the LEDs when the user button is pressed.
  */
-            cda14729
+#define MODULE_MAIN_LOOP_GPIOEVENT(eventflags) {                              \
   if (eventflags & MODULE_OS_GPIOEVENTFLAG_USERBUTTON) {                      \
-            c9cecdb6
+    apalControlGpioState_t buttonstate;                                       \
     apalControlGpioGet(&moduleGpioUserButton, &buttonstate);                  \
     apalControlGpioSet(&moduleGpioLedRed, buttonstate);                       \
     apalControlGpioSet(&moduleGpioLedGreen, buttonstate);                     \
     apalControlGpioSet(&moduleGpioLedBlue, buttonstate);                      \
     apalControlGpioSet(&moduleGpioLedOrange, buttonstate);                    \
-ff44a7
+  }                                                                           \
+}
 /** @} */
 /*===========================================================================*/
 /**
  * @name Startup Shutdown Synchronization Protocol (SSSP)
  * @{
  */
 /*===========================================================================*/
-            cda14729
+#if (AMIROOS_CFG_SSSP_ENABLE == true) || defined(__DOXYGEN__)
-            c53ef0b1
+  #error "SSSP is not supported on this module."
-            cda14729
+#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
-ff44a7
+/** @} */
 /*===========================================================================*/
 /**
  * @name Low-level drivers
  * @{
  */
 /*===========================================================================*/
 /** @} */
 /*===========================================================================*/
 /**
-c72a54c
+ * @name Tests
-ff44a7
+ * @{
  */
 /*===========================================================================*/
 #if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
-de0cc90
+#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
-ff44a7
+            Thomas Schöpping
 /** @} */
-ff06bbf
+#endif /* AMIROOS_MODULE_H */
-ff44a7
+            Thomas Schöpping
 /** @} */