AMiRo-OS

/*

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

Copyright (C) 2016..2019  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   PowerManagement v1.2 Board specific macros.

 *

 * @addtogroup powermanagement_board

 * @{

 */

#ifndef BOARD_H

#define BOARD_H

/*

 * Setup for AMiRo PowerManagement v1.2 board.

 */

/*

 * Board identifier.

 */

#define BOARD_POWERMANAGEMENT_1_2

#define BOARD_NAME                      "AMiRo PowerManagement v1.2"

/*

 * Board oscillators-related settings.

 * NOTE: LSE not fitted.

 */

#if !defined(STM32_LSECLK)

#define STM32_LSECLK                    0U

#endif

#if !defined(STM32_HSECLK)

#define STM32_HSECLK                    8000000U

#endif

/*

 * Board voltages.

 * Required for performance limits calculation.

 */

#define STM32_VDD                       330U

/*

 * MCU type as defined in the ST header.

 */

#define STM32F405xx

/*

 * STM32F4 alternate function definitions

 */

#define STM32F4xx_AF_system             0U

#define STM32F4xx_AF_TIM1to2            1U

#define STM32F4xx_AF_TIM3to5            2U

#define STM32F4xx_AF_TIM8to11           3U

#define STM32F4xx_AF_I2C1to3            4U

#define STM32F4xx_AF_SPI1to2            5U

#define STM32F4xx_AF_SPI3               6U

#define STM32F4xx_AF_USART1to3          7U

#define STM32F4xx_AF_USART4to6          8U

#define STM32F4xx_AF_CAN1to2_TIM12to14  9U

#define STM32F4xx_AF_OTG_HSFS           10U

#define STM32F4xx_AF_ETH                11U

#define STM32F4xx_AF_FSMC_SDIO_OTGHS    12U

#define STM32F4xx_AF_DCMI               13U

#define STM32F4xx_AF_EVENTOUT           15U

/*

 * Identifiers for the several sensor rings, which can be attached to the PowerManagement v1.2 module.

 */

#define BOARD_NOSENSORRING              0

#define BOARD_PROXIMITYSENSOR           1

#define BOARD_DISTANCESENSOR_VL53L0X    2

#define BOARD_DISTANCESENSOR_VL53L1X    3

/*

 * Configuration macro to define which type of sensor ring is attached.

 */

#define BOARD_SENSORRING                BOARD_PROXIMITYSENSOR

/*

 * IO pins assignments.

 */

#define GPIOA_WKUP                      0U

#define GPIOA_SWITCH_STATUS_N           1U

#define GPIOA_SYS_UART_TX               2U

#define GPIOA_SYS_UART_RX               3U

#define GPIOA_SYS_SPI_SS0_N             4U

#define GPIOA_SYS_SPI_SCLK              5U

#define GPIOA_SYS_SPI_MISO              6U

#define GPIOA_SYS_SPI_MOSI              7U

#define GPIOA_SYS_REG_EN                8U

#define GPIOA_PROG_RX                   9U

#define GPIOA_PROG_TX                   10U

#define GPIOA_CAN_RX                    11U

#define GPIOA_CAN_TX                    12U

#define GPIOA_SWDIO                     13U

#define GPIOA_SWCLK                     14U

#define GPIOA_SYS_SPI_SS1_N             15U

#define GPIOB_IR_INT1_N                 0U

#define GPIOB_VSYS_SENSE                1U

#define GPIOB_POWER_EN                  2U

#define GPIOB_SYS_UART_DN               3U

#define GPIOB_CHARGE_STAT2A             4U

#define GPIOB_BUZZER                    5U

#define GPIOB_GAUGE_BATLOW2             6U

#define GPIOB_GAUGE_BATGD2_N            7U

#define GPIOB_GAUGE_SCL2                8U

#define GPIOB_GAUGE_SDA2                9U

#define GPIOB_GAUGE_SCL1                10U

#define GPIOB_GAUGE_SDA1                11U

#define GPIOB_LED                       12U

#define GPIOB_BT_RTS                    13U

#define GPIOB_BT_CTS                    14U

#define GPIOB_SYS_UART_UP               15U

#define GPIOC_CHARGE_STAT1A             0U

#define GPIOC_GAUGE_BATLOW1             1U

#define GPIOC_GAUGE_BATGD1_N            2U

#define GPIOC_CHARGE_EN1_N              3U

#define GPIOC_IR_INT2_N                 4U

#define GPIOC_TOUCH_INT_N               5U

#define GPIOC_SYS_DONE                  6U

#define GPIOC_SYS_PROG_N                7U

#define GPIOC_PATH_DC                   8U

#define GPIOC_SYS_SPI_DIR               9U

#define GPIOC_BT_RX                     10U

#define GPIOC_BT_TX                     11U

#define GPIOC_SYS_INT_N                 12U

#define GPIOC_SYS_PD_N                  13U

#define GPIOC_SYS_WARMRST_N             14U

#define GPIOC_BT_RST                    15U

#define GPIOD_PIN0                      0U

#define GPIOD_PIN1                      1U

#define GPIOD_CHARGE_EN2_N              2U

#define GPIOD_PIN3                      3U

#define GPIOD_PIN4                      4U

#define GPIOD_PIN5                      5U

#define GPIOD_PIN6                      6U

#define GPIOD_PIN7                      7U

#define GPIOD_PIN8                      8U

#define GPIOD_PIN9                      9U

#define GPIOD_PIN10                     10U

#define GPIOD_PIN11                     11U

#define GPIOD_PIN12                     12U

#define GPIOD_PIN13                     13U

#define GPIOD_PIN14                     14U

#define GPIOD_PIN15                     15U

#define GPIOE_PIN0                      0U

#define GPIOE_PIN1                      1U

#define GPIOE_PIN2                      2U

#define GPIOE_PIN3                      3U

#define GPIOE_PIN4                      4U

#define GPIOE_PIN5                      5U

#define GPIOE_PIN6                      6U

#define GPIOE_PIN7                      7U

#define GPIOE_PIN8                      8U

#define GPIOE_PIN9                      9U

#define GPIOE_PIN10                     10U

#define GPIOE_PIN11                     11U

#define GPIOE_PIN12                     12U

#define GPIOE_PIN13                     13U

#define GPIOE_PIN14                     14U

#define GPIOE_PIN15                     15U

#define GPIOF_PIN0                      0U

#define GPIOF_PIN1                      1U

#define GPIOF_PIN2                      2U

#define GPIOF_PIN3                      3U

#define GPIOF_PIN4                      4U

#define GPIOF_PIN5                      5U

#define GPIOF_PIN6                      6U

#define GPIOF_PIN7                      7U

#define GPIOF_PIN8                      8U

#define GPIOF_PIN9                      9U

#define GPIOF_PIN10                     10U

#define GPIOF_PIN11                     11U

#define GPIOF_PIN12                     12U

#define GPIOF_PIN13                     13U

#define GPIOF_PIN14                     14U

#define GPIOF_PIN15                     15U

#define GPIOG_PIN0                      0U

#define GPIOG_PIN1                      1U

#define GPIOG_PIN2                      2U

#define GPIOG_PIN3                      3U

#define GPIOG_PIN4                      4U

#define GPIOG_PIN5                      5U

#define GPIOG_PIN6                      6U

#define GPIOG_PIN7                      7U

#define GPIOG_PIN8                      8U

#define GPIOG_PIN9                      9U

#define GPIOG_PIN10                     10U

#define GPIOG_PIN11                     11U

#define GPIOG_PIN12                     12U

#define GPIOG_PIN13                     13U

#define GPIOG_PIN14                     14U

#define GPIOG_PIN15                     15U

#define GPIOH_OSC_IN                    0U

#define GPIOH_OSC_OUT                   1U

#define GPIOH_PIN2                      2U

#define GPIOH_PIN3                      3U

#define GPIOH_PIN4                      4U

#define GPIOH_PIN5                      5U

#define GPIOH_PIN6                      6U

#define GPIOH_PIN7                      7U

#define GPIOH_PIN8                      8U

#define GPIOH_PIN9                      9U

#define GPIOH_PIN10                     10U

#define GPIOH_PIN11                     11U

#define GPIOH_PIN12                     12U

#define GPIOH_PIN13                     13U

#define GPIOH_PIN14                     14U

#define GPIOH_PIN15                     15U

#define GPIOI_PIN0                      0U

#define GPIOI_PIN1                      1U

#define GPIOI_PIN2                      2U

#define GPIOI_PIN3                      3U

#define GPIOI_PIN4                      4U

#define GPIOI_PIN5                      5U

#define GPIOI_PIN6                      6U

#define GPIOI_PIN7                      7U

#define GPIOI_PIN8                      8U

#define GPIOI_PIN9                      9U

#define GPIOI_PIN10                     10U

#define GPIOI_PIN11                     11U

#define GPIOI_PIN12                     12U

#define GPIOI_PIN13                     13U

#define GPIOI_PIN14                     14U

#define GPIOI_PIN15                     15U

/*

 * IO lines assignments.

 */

#define LINE_WKUP                       PAL_LINE(GPIOA, GPIOA_WKUP)

#define LINE_SWITCH_STATUS_N            PAL_LINE(GPIOA, GPIOA_SWITCH_STATUS_N)

#define LINE_SYS_UART_TX                PAL_LINE(GPIOA, GPIOA_SYS_UART_TX)

#define LINE_SYS_UART_RX                PAL_LINE(GPIOA, GPIOA_SYS_UART_RX)

#define LINE_SYS_SPI_SS0_N              PAL_LINE(GPIOA, GPIOA_SYS_SPI_SS0_N)

#define LINE_SYS_SPI_SCLK               PAL_LINE(GPIOA, GPIOA_SYS_SPI_SCLK)

#define LINE_SYS_SPI_MISO               PAL_LINE(GPIOA, GPIOA_SYS_SPI_MISO)

#define LINE_SYS_SPI_MOSI               PAL_LINE(GPIOA, GPIOA_SYS_SPI_MOSI)

#define LINE_SYS_REG_EN                 PAL_LINE(GPIOA, GPIOA_SYS_REG_EN)

#define LINE_PROG_RX                    PAL_LINE(GPIOA, GPIOA_PROG_RX)

#define LINE_PROG_TX                    PAL_LINE(GPIOA, GPIOA_PROG_TX)

#define LINE_CAN_RX                     PAL_LINE(GPIOA, GPIOA_CAN_RX)

#define LINE_CAN_TX                     PAL_LINE(GPIOA, GPIOA_CAN_TX)

#define LINE_SWDIO                      PAL_LINE(GPIOA, GPIOA_SWDIO)

#define LINE_SWCLK                      PAL_LINE(GPIOA, GPIOA_SWCLK)

#define LINE_SYS_SPI_SS1_N              PAL_LINE(GPIOA, GPIOA_SYS_SPI_SS1_N)

#define LINE_IR_INT1_N                  PAL_LINE(GPIOB, GPIOB_IR_INT1_N)

#define LINE_VSYS_SENSE                 PAL_LINE(GPIOB, GPIOB_VSYS_SENSE)

#define LINE_POWER_EN                   PAL_LINE(GPIOB, GPIOB_POWER_EN)

#define LINE_SYS_UART_DN                PAL_LINE(GPIOB, GPIOB_SYS_UART_DN)

#define LINE_CHARGE_STAT2A              PAL_LINE(GPIOB, GPIOB_CHARGE_STAT2A)

#define LINE_BUZZER                     PAL_LINE(GPIOB, GPIOB_BUZZER)

#define LINE_GAUGE_BATLOW2              PAL_LINE(GPIOB, GPIOB_GAUGE_BATLOW2)

#define LINE_GAUGE_BATGD2_N             PAL_LINE(GPIOB, GPIOB_GAUGE_BATGD2_N)

#define LINE_GAUGE_SCL2                 PAL_LINE(GPIOB, GPIOB_GAUGE_SCL2)

#define LINE_GAUGE_SDA2                 PAL_LINE(GPIOB, GPIOB_GAUGE_SDA2)

#define LINE_GAUGE_SCL1                 PAL_LINE(GPIOB, GPIOB_GAUGE_SCL1)

#define LINE_GAUGE_SDA1                 PAL_LINE(GPIOB, GPIOB_GAUGE_SDA1)

#define LINE_LED                        PAL_LINE(GPIOB, GPIOB_LED)

#define LINE_BT_RTS                     PAL_LINE(GPIOB, GPIOB_BT_RTS)

#define LINE_BT_CTS                     PAL_LINE(GPIOB, GPIOB_BT_CTS)

#define LINE_SYS_UART_UP                PAL_LINE(GPIOB, GPIOB_SYS_UART_UP)

#define LINE_CHARGE_STAT1A              PAL_LINE(GPIOC, GPIOC_CHARGE_STAT1A)

#define LINE_GAUGE_BATLOW1              PAL_LINE(GPIOC, GPIOC_GAUGE_BATLOW1)

#define LINE_GAUGE_BATGD1_N             PAL_LINE(GPIOC, GPIOC_GAUGE_BATGD1_N)

#define LINE_CHARGE_EN1_N               PAL_LINE(GPIOC, GPIOC_CHARGE_EN1_N)

#define LINE_IR_INT2_N                  PAL_LINE(GPIOC, GPIOC_IR_INT2_N)

#define LINE_TOUCH_INT_N                PAL_LINE(GPIOC, GPIOC_TOUCH_INT_N)

#define LINE_SYS_DONE                   PAL_LINE(GPIOC, GPIOC_SYS_DONE)

#define LINE_SYS_PROG_N                 PAL_LINE(GPIOC, GPIOC_SYS_PROG_N)

#define LINE_PATH_DC                    PAL_LINE(GPIOC, GPIOC_PATH_DC)

#define LINE_SYS_SPI_DIR                PAL_LINE(GPIOC, GPIOC_SYS_SPI_DIR)

#define LINE_BT_RX                      PAL_LINE(GPIOC, GPIOC_BT_RX)

#define LINE_BT_TX                      PAL_LINE(GPIOC, GPIOC_BT_TX)

#define LINE_SYS_INT_N                  PAL_LINE(GPIOC, GPIOC_SYS_INT_N)

#define LINE_SYS_PD_N                   PAL_LINE(GPIOC, GPIOC_SYS_PD_N)

#define LINE_SYS_WARMRST_N              PAL_LINE(GPIOC, GPIOC_SYS_WARMRST_N)

#define LINE_BT_RST                     PAL_LINE(GPIOC, GPIOC_BT_RST)

#define LINE_CHARGE_EN2_N               PAL_LINE(GPIOD, GPIOD_CHARGE_EN2_N)

#define LINE_OSC_IN                     PAL_LINE(GPIOH, 0U)

#define LINE_OSC_OUT                    PAL_LINE(GPIOH, 1U)

/*

 * I/O ports initial setup, this configuration is established soon after reset

 * in the initialization code.

 * Please refer to the STM32 Reference Manual for details.

 */

#define PIN_IGNORE(n)                   (1U << (n))

#define PIN_MODE_INPUT(n)               (0U << ((n) * 2U))

#define PIN_MODE_OUTPUT(n)              (1U << ((n) * 2U))

#define PIN_MODE_ALTERNATE(n)           (2U << ((n) * 2U))

#define PIN_MODE_ANALOG(n)              (3U << ((n) * 2U))

#define PIN_ODR_LOW(n)                  (0U << (n))

#define PIN_ODR_HIGH(n)                 (1U << (n))