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   CAN driver to use.

 */

#define MODULE_HAL_CAN                          CAND1

/**

 * @brief   Configuration for the CAN driver.

 */

extern CANConfig moduleHalCanConfig;

/**

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

 * @{

 */

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

#include <amiro-lld.h>

/**

 * @brief   SYS_REG_EN output signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysRegEn;

/**

 * @brief   IR_INT1 input signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioIrInt1;

/**

 * @brief   POWER_EN output signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioPowerEn;

/**

 * @brief   SYS_UART_DN bidirectional signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysUartDn;

/**

 * @brief   LED output signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioLed;

/**

 * @brief   SYS_UART_UP bidirectional signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysUartUp;

/**

 * @brief   IR_INT2 input signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioIrInt2;

/**

 * @brief   TOUCH_INT input signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioTouchInt;

/**

 * @brief   SYS_DONE input signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysDone;

/**

 * @brief   SYS_PROG output signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysProg;

/**

 * @brief   PATH_DC input signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioPathDc;

/**

 * @brief   SYS_SPI_DIR bidirectional signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysSpiDir;

/**

 * @brief   SYS_SYNC bidirectional signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysSync;

/**

 * @brief   SYS_PD bidirectional signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysPd;

/**

 * @brief   SYS_WARMRST bidirectional signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioSysWarmrst;

/**

 * @brief   BT_RST output signal GPIO.

 */

extern ROMCONST apalControlGpio_t moduleGpioBtRst;

/** @} */

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

/**

 * @name AMiRo-OS core configurations

 * @{

 */

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

/**

 * @brief   Event flag to be set on a IR_INT1 / CHARGE_STAT1A interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_IRINT1           ((eventflags_t)1 << GPIOB_IR_INT1_N)

/**

 * @brief   Event flag to be set on a SYS_UART_DN interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_SYSUARTDN        ((eventflags_t)1 << GPIOB_SYS_UART_DN)

/**

 * @brief   Event flag to be set on a TOUCH_INT interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_TOUCHINT         ((eventflags_t)1 << GPIOC_TOUCH_INT_N)

/**

 * @brief   Event flag to be set on a PATH_DC interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_PATHDC           ((eventflags_t)1 << GPIOC_PATH_DC)

/**

 * @brief   Event flag to be set on a SYS_SPI_DIR interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_SYSSPIDIR        ((eventflags_t)1 << GPIOC_SYS_SPI_DIR)

/**

 * @brief   Event flag to be set on a SYS_SYNC interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_SYSSYNC          ((eventflags_t)1 << GPIOC_SYS_INT_N)

/**

 * @brief   Event flag to be set on a SYS_PD interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_SYSPD            ((eventflags_t)1 << GPIOC_SYS_PD_N)

/**

 * @brief   Event flag to be set on a SYS_WARMRST interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_SYSWARMRST       ((eventflags_t)1 << GPIOC_SYS_WARMRST_N)

/**

 * @brief   Event flag to be set on a SYS_UART_UP interrupt.

 */

#define MODULE_OS_IOEVENTFLAGS_SYSUARTUP        ((eventflags_t)1 << GPIOB_SYS_UART_UP)

#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)

/**

 * @brief   Shell prompt text.

 */

extern ROMCONST char* moduleShellPrompt;

#endif

#endif /* _AMIROOS_MODULE_H_ */

/** @} */