AMiRo-OS

/*

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

Copyright (C) 2016..2020  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/>.

*/

#ifndef BOARD_H

#define BOARD_H

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

/* Driver constants.                                                         */

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

/*

 * Setup for STMicroelectronics STM32 Nucleo64-F401RE board.

 */

/*

 * Board identifier.

 */

#define BOARD_ST_NUCLEO64_F401RE

#define BOARD_NAME                  "STMicroelectronics STM32 Nucleo64-F401RE"

/*

 * 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

#define STM32_HSE_BYPASS

/*

 * Board voltages.

 * Required for performance limits calculation.

 */

#define STM32_VDD                   300U

/*

 * MCU type as defined in the ST header.

 */

#define STM32F401xE

/*

 * IO pins assignments.

 */

#define GPIOA_ARD_A0                0U

#define GPIOA_ADC1_IN0              0U

#define GPIOA_ARD_A1                1U

#define GPIOA_ADC1_IN1              1U

#define GPIOA_ARD_D1                2U

#define GPIOA_USART2_TX             2U

#define GPIOA_ARD_D0                3U

#define GPIOA_USART2_RX             3U

#define GPIOA_ARD_A2                4U

#define GPIOA_ADC1_IN4              4U

#define GPIOA_ARD_D13               5U

#define GPIOA_LED_GREEN             5U

#define GPIOA_ARD_D12               6U

#define GPIOA_ARD_D11               7U

#define GPIOA_ARD_D7                8U

#define GPIOA_ARD_D8                9U

#define GPIOA_ARD_D2                10U

#define GPIOA_OTG_FS_DM             11U

#define GPIOA_OTG_FS_DP             12U

#define GPIOA_SWDIO                 13U

#define GPIOA_SWCLK                 14U

#define GPIOA_PIN15                 15U

#define GPIOB_ARD_A3                0U

#define GPIOB_ADC1_IN8              0U

#define GPIOB_PIN1                  1U

#define GPIOB_PIN2                  2U

#define GPIOB_ARD_D3                3U

#define GPIOB_SWO                   3U

#define GPIOB_ARD_D5                4U

#define GPIOB_ARD_D4                5U

#define GPIOB_ARD_D10               6U

#define GPIOB_PIN7                  7U

#define GPIOB_ARD_D15               8U

#define GPIOB_ARD_D14               9U

#define GPIOB_ARD_D6                10U

#define GPIOB_PIN11                 11U

#define GPIOB_PIN12                 12U

#define GPIOB_PIN13                 13U

#define GPIOB_PIN14                 14U

#define GPIOB_PIN15                 15U

#define GPIOC_ARD_A5                0U

#define GPIOC_ADC1_IN10             0U

#define GPIOC_ARD_A4                1U

#define GPIOC_ADC1_IN11             1U

#define GPIOC_PIN2                  2U

#define GPIOC_PIN3                  3U

#define GPIOC_PIN4                  4U

#define GPIOC_PIN5                  5U

#define GPIOC_PIN6                  6U

#define GPIOC_ARD_D9                7U

#define GPIOC_PIN8                  8U

#define GPIOC_PIN9                  9U

#define GPIOC_PIN10                 10U

#define GPIOC_PIN11                 11U

#define GPIOC_PIN12                 12U

#define GPIOC_BUTTON                13U

#define GPIOC_OSC32_IN              14U

#define GPIOC_OSC32_OUT             15U

#define GPIOD_PIN0                  0U

#define GPIOD_PIN1                  1U

#define GPIOD_PIN2                  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_ARD_A0                 PAL_LINE(GPIOA, GPIOA_ARD_A0)

#define LINE_ADC1_IN0               PAL_LINE(GPIOA, GPIOA_ADC1_IN0)

#define LINE_ARD_A1                 PAL_LINE(GPIOA, GPIOA_ARD_A1)

#define LINE_ADC1_IN1               PAL_LINE(GPIOA, GPIOA_ADC1_IN1)

#define LINE_ARD_D1                 PAL_LINE(GPIOA, GPIOA_ARD_D1)

#define LINE_USART2_TX              PAL_LINE(GPIOA, GPIOA_USART2_TX)

#define LINE_ARD_D0                 PAL_LINE(GPIOA, GPIOA_ARD_D0)

#define LINE_USART2_RX              PAL_LINE(GPIOA, GPIOA_USART2_RX)

#define LINE_ARD_A2                 PAL_LINE(GPIOA, GPIOA_ARD_A2)

#define LINE_ADC1_IN4               PAL_LINE(GPIOA, GPIOA_ADC1_IN4)

#define LINE_ARD_D13                PAL_LINE(GPIOA, GPIOA_ARD_D13)

#define LINE_LED_GREEN              PAL_LINE(GPIOA, GPIOA_LED_GREEN)

#define LINE_ARD_D12                PAL_LINE(GPIOA, GPIOA_ARD_D12)

#define LINE_ARD_D11                PAL_LINE(GPIOA, GPIOA_ARD_D11)

#define LINE_ARD_D7                 PAL_LINE(GPIOA, GPIOA_ARD_D7)

#define LINE_ARD_D8                 PAL_LINE(GPIOA, GPIOA_ARD_D8)

#define LINE_ARD_D2                 PAL_LINE(GPIOA, GPIOA_ARD_D2)

#define LINE_OTG_FS_DM              PAL_LINE(GPIOA, GPIOA_OTG_FS_DM)

#define LINE_OTG_FS_DP              PAL_LINE(GPIOA, GPIOA_OTG_FS_DP)

#define LINE_SWDIO                  PAL_LINE(GPIOA, GPIOA_SWDIO)

#define LINE_SWCLK                  PAL_LINE(GPIOA, GPIOA_SWCLK)

#define LINE_ARD_A3                 PAL_LINE(GPIOB, GPIOB_ARD_A3)

#define LINE_ADC1_IN8               PAL_LINE(GPIOB, GPIOB_ADC1_IN8)

#define LINE_ARD_D3                 PAL_LINE(GPIOB, GPIOB_ARD_D3)

#define LINE_SWO                    PAL_LINE(GPIOB, GPIOB_SWO)

#define LINE_ARD_D5                 PAL_LINE(GPIOB, GPIOB_ARD_D5)

#define LINE_ARD_D4                 PAL_LINE(GPIOB, GPIOB_ARD_D4)

#define LINE_ARD_D10                PAL_LINE(GPIOB, GPIOB_ARD_D10)

#define LINE_ARD_D15                PAL_LINE(GPIOB, GPIOB_ARD_D15)

#define LINE_ARD_D14                PAL_LINE(GPIOB, GPIOB_ARD_D14)

#define LINE_ARD_D6                 PAL_LINE(GPIOB, GPIOB_ARD_D6)

#define LINE_ARD_A5                 PAL_LINE(GPIOC, GPIOC_ARD_A5)

#define LINE_ADC1_IN10              PAL_LINE(GPIOC, GPIOC_ADC1_IN10)

#define LINE_ARD_A4                 PAL_LINE(GPIOC, GPIOC_ARD_A4)

#define LINE_ADC1_IN11              PAL_LINE(GPIOC, GPIOC_ADC1_IN11)

#define LINE_ARD_D9                 PAL_LINE(GPIOC, GPIOC_ARD_D9)

#define LINE_BUTTON                 PAL_LINE(GPIOC, GPIOC_BUTTON)

#define LINE_OSC32_IN               PAL_LINE(GPIOC, GPIOC_OSC32_IN)

#define LINE_OSC32_OUT              PAL_LINE(GPIOC, GPIOC_OSC32_OUT)

#define LINE_OSC_IN                 PAL_LINE(GPIOH, GPIOH_OSC_IN)

#define LINE_OSC_OUT                PAL_LINE(GPIOH, GPIOH_OSC_OUT)

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

/* Driver pre-compile time settings.                                         */

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

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

/* Derived constants and error checks.                                       */

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

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

/* Driver data structures and types.                                         */

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

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

/* Driver macros.                                                            */

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

/*

 * 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_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))

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

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

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

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

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

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

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

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

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

#define PIN_AFIO_AF(n, v)           ((v) << (((n) % 8U) * 4U))

/*

 * GPIOA setup:

 *

 * PA0  - ARD_A0 ADC1_IN0           (input pullup).

 * PA1  - ARD_A1 ADC1_IN1           (input pullup).

 * PA2  - ARD_D1 USART2_TX          (alternate 7).

 * PA3  - ARD_D0 USART2_RX          (alternate 7).

 * PA4  - ARD_A2 ADC1_IN4           (input pullup).

 * PA5  - LED_GREEN ARD_D13         (output pushpull high).

 * PA6  - ARD_D12                   (input pullup).

 * PA7  - ARD_D11                   (input pullup).