AMiRo-OS

/*

AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.

Copyright (C) 2016..2018  Thomas Schöpping et al.

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    

 * @brief   Structures and constant for the PowerManagement module.

 *

 * @addtogroup powermanagement_module

 * @{

 */

#ifndef _AMIROOS_MODULE_H_

#define _AMIROOS_MODULE_H_

/*===========================================================================*/

/**

 * @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

 * @{

 */

/*===========================================================================*/

#include <hal.h>

/**

 * @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;

/**

 * @brief   I2C driver to access multiplexer, proximity sensors 1 to 4, power monitors for VIO1.8 and VIO 3.3, and fuel gauge (rear battery).

 */

#define MODULE_HAL_I2C_PROX_PM18_PM33_GAUGEREAR I2CD1

/**

 * @brief   Configuration for the multiplexer, proximity sensors 1 to 4, power monitors for VIO1.8 and VIO 3.3, and fuel gauge (rear battery) I2C driver.

 */

extern I2CConfig moduleHalI2cProxPm18Pm33GaugeRearConfig;

/**

 * @brief   I2C driver to access multiplexer, proximity sensors 5 to 8, power monitors for VSYS4.2, VIO 5.0 and VDD, EEPROM, touch sensor, and fuel gauge (front battery).

 */

#define MODULE_HAL_I2C_PROX_PM42_PM50_PMVDD_EEPROM_TOUCH_GAUGEFRONT I2CD2

/**

 * @brief   Configuration for the multiplexer, proximity sensors 1 to 4, power monitors for VIO1.8 and VIO 3.3, and fuel gauge (rear battery) I2C driver.

 */

extern I2CConfig moduleHalI2cProxPm42Pm50PmVddEepromTouchGaugeFrontConfig;

/**

 * @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;

/**

 * @brief   Real-Time Clock driver.

 */

#define MODULE_HAL_RTC                          RTCD1

/** @} */

/*===========================================================================*/

/**

 * @name GPIO definitions

 * @{

 */

/*===========================================================================*/

#include <amiro-lld.h>

/**

 * @brief   SYS_REG_EN output signal GPIO.

 */

extern apalControlGpio_t moduleGpioSysRegEn;

/**

 * @brief   IR_INT1 input signal GPIO.

 */

extern apalControlGpio_t moduleGpioIrInt1;

/**

 * @brief   POWER_EN output signal GPIO.

 */

extern apalControlGpio_t moduleGpioPowerEn;

/**

 * @brief   SYS_UART_DN bidirectional signal GPIO.

 */

extern apalControlGpio_t moduleGpioSysUartDn;

/**

 * @brief   CHARGE_STAT2A input signal GPIO.

 */

extern apalControlGpio_t moduleGpioChargeStat2A;

/**

 * @brief   GAUGE_BATLOW2 input signal GPIO.

 */

extern apalControlGpio_t moduleGpioGaugeBatLow2;

/**

 * @brief   GAUGE_BATGD2 input signal GPIO.

 */

extern apalControlGpio_t moduleGpioGaugeBatGd2;

/**

 * @brief   LED output signal GPIO.

 */

extern apalControlGpio_t moduleGpioLed;

/**

 * @brief   SYS_UART_UP bidirectional signal GPIO.

 */

extern apalControlGpio_t moduleGpioSysUartUp;

/**

 * @brief   CHARGE_STAT1A input signal GPIO.

 */

extern apalControlGpio_t moduleGpioChargeStat1A;

/**

 * @brief   GAUGE_BATLOW1 input signal GPIO.

 */

extern apalControlGpio_t moduleGpioGaugeBatLow1;

/**

 * @brief   GAUGE_BATGD1 input signal GPIO.

 */

extern apalControlGpio_t moduleGpioGaugeBatGd1;

/**

 * @brief   CHARG_EN1 output signal GPIO.

 */

extern apalControlGpio_t moduleGpioChargeEn1;

/**

 * @brief   IR_INT2 input signal GPIO.

 */

extern apalControlGpio_t moduleGpioIrInt2;

/**

 * @brief   TOUCH_INT input signal GPIO.

 */

extern apalControlGpio_t moduleGpioTouchInt;

/**

 * @brief   SYS_DONE input signal GPIO.

 */

extern apalControlGpio_t moduleGpioSysDone;

/**

 * @brief   SYS_PROG output signal GPIO.