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

amiro-os / modules / PowerManagement_1-1 / module.h @ 9af9aaea

History | View | Annotate | Download (31.073 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
+/**
-            acc97cbf
+ * @file
-ca3
+ * @brief   Structures and constant for the PowerManagement module.
+ *
  * @addtogroup powermanagement_module
  * @{
  */
-ff06bbf
+#ifndef AMIROOS_MODULE_H
 #define AMIROOS_MODULE_H
-            e545e620
+            Thomas Schöpping
-            e2d7143f
+#include <amiroos.h>
-            e545e620
+/*===========================================================================*/
 /**
  * @name Module specific functions
  * @{
  */
 /*===========================================================================*/
-c1b3372
+/**
-            e545e620
+ * @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.
  */
-c1b3372
+#define CCM_RAM(...)                            __attribute__((section(".ram4"), ##__VA_ARGS__))
-            e545e620
+            Thomas Schöpping
-c1b3372
+/**
-            e545e620
+ * @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.
  */
-c1b3372
+#define ETH_RAM(...)                            __attribute__((section(".ram2"), ##__VA_ARGS__))
-            e545e620
+            Thomas Schöpping
-c1b3372
+/**
-            e545e620
+ * @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.
  */
-c1b3372
+#define BCKP_RAM(...)                           __attribute__((section(".ram5"), ##__VA_ARGS__))
-            e545e620
+            Thomas Schöpping
 /** @} */
 /*===========================================================================*/
 /**
  * @name ChibiOS/HAL configuration
  * @{
  */
 /*===========================================================================*/
 /**
  * @brief   ADC driver for reading the system voltage.
  */
 #define MODULE_HAL_ADC_VSYS                     ADCD1
 /**
  * @brief   Configuration for the ADC.
  */
 extern ADCConversionGroup moduleHalAdcVsysConversionGroup;
 /**
  * @brief   CAN driver to use.
  */
 #define MODULE_HAL_CAN                          CAND1
 /**
  * @brief   Configuration for the CAN driver.
  */
 extern CANConfig moduleHalCanConfig;
 /**
-be006e0
+ * @brief   I2C driver to access the sensor ring, power monitors for VIO1.8 and VIO3.3, and fuel gauge (rear battery).
  * @details Depending on the attached sensor ring, the devices connected to this bus vary:
  *          ProximitySensor:
  *            - I2C multiplexer (PCA9544A)
  *            - proximity sensors (VCNL4020) #1 - #4
  *          DistanceSensor (VL53L0X):
  *            TODO
  *          DistanceSensor (VL53L1X):
  *            TODO
  */
 #define MODULE_HAL_I2C_SR_PM18_PM33_GAUGEREAR   I2CD1
 /**
  * @brief   Configuration for the sensor ring, power monitors for VIO1.8 and VIO3.3, and fuel gauge (rear battery) I2C driver.
  * @details Depending on the attached sensor ring, the devices connected to this bus vary:
  *          ProximitySensor:
  *            - I2C multiplexer (PCA9544A)
  *            - proximity sensors (VCNL4020) #1 - #4
  *          DistanceSensor (VL53L0X):
  *            TODO
  *          DistanceSensor (VL53L1X):
  *            TODO
  */
 extern I2CConfig moduleHalI2cSrPm18Pm33GaugeRearConfig;
 /**
  * @brief   I2C driver to access the sensor ring, power monitors for VSYS4.2, VIO5.0 and VDD, EEPROM, and fuel gauge (front battery).
  * @details Depending on the attached sensor ring, the devices connected to this bus vary:
  *          ProximitySensor:
  *            - I2C multiplexer (PCA9544A)
  *            - proximity sensors (VCNL4020) #1 - #4
  *            - touch sensor (MPR121)
  *          DistanceSensor (VL53L0X):
  *            TODO
  *          DistanceSensor (VL53L1X):
  *            TODO
  */
 #define MODULE_HAL_I2C_SR_PM42_PM50_PMVDD_EEPROM_GAUGEFRONT I2CD2
 /**
  * @brief   Configuration for the sensor ring, power monitors for VSYS4.2, VIO5.0 and VDD, EEPROM, and fuel gauge (front battery) I2C driver.
  * @details Depending on the attached sensor ring, the devices connected to this bus vary:
  *          ProximitySensor:
  *            - I2C multiplexer (PCA9544A)
  *            - proximity sensors (VCNL4020) #1 - #4
  *            - touch sensor (MPR121)
  *          DistanceSensor (VL53L0X):
  *            TODO
  *          DistanceSensor (VL53L1X):
  *            TODO
  */
 extern I2CConfig moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   PWM driver for the buzzer.
  */
 #define MODULE_HAL_PWM_BUZZER                   PWMD3
 /**
  * @brief   Configuration of the PWM driver.
  */
 extern PWMConfig moduleHalPwmBuzzerConfig;
 /**
  * @brief   PWM channeö for the buzzer.
  */
 #define MODULE_HAL_PWM_BUZZER_CHANNEL           1
 /**
  * @brief   Serial driver of the programmer interface.
  */
 #define MODULE_HAL_PROGIF                       SD1
 /**
  * @brief   Configuration for the programmer serial interface driver.
  */
 extern SerialConfig moduleHalProgIfConfig;
-aeae
+/**
  * @brief   Real-Time Clock driver.
  */
 #define MODULE_HAL_RTC                          RTCD1
-            e545e620
+/** @} */
 /*===========================================================================*/
 /**
  * @name GPIO definitions
  * @{
  */
 /*===========================================================================*/
 /**
  * @brief   SYS_REG_EN output signal GPIO.
  */
-            acc97cbf
+extern ROMCONST apalControlGpio_t moduleGpioSysRegEn;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   IR_INT1 input signal GPIO.
  */
-            acc97cbf
+extern ROMCONST apalControlGpio_t moduleGpioIrInt1;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   POWER_EN output signal GPIO.
  */
-            acc97cbf
+extern ROMCONST apalControlGpio_t moduleGpioPowerEn;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   SYS_UART_DN bidirectional signal GPIO.
  */
-            acc97cbf
+extern ROMCONST apalControlGpio_t moduleGpioSysUartDn;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   CHARGE_STAT2A input signal GPIO.
  */
-            acc97cbf
+extern ROMCONST apalControlGpio_t moduleGpioChargeStat2A;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   GAUGE_BATLOW2 input signal GPIO.
  */
-            acc97cbf
+extern ROMCONST apalControlGpio_t moduleGpioGaugeBatLow2;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   GAUGE_BATGD2 input signal GPIO.
  */
-            acc97cbf
+extern ROMCONST apalControlGpio_t moduleGpioGaugeBatGd2;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   LED output signal GPIO.
  */
-            acc97cbf
+extern ROMCONST apalControlGpio_t moduleGpioLed;
-            e545e620
+            Thomas Schöpping
 /**
  * @brief   SYS_UART_UP bidirectional signal GPIO.
  */