1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/boards/feather-m0/include/arduino_iomap.h
Marian Buschsieweke 043e8cc88e
boards,sys/arduino: major clean up
- Rename all `arduino_pinmap.h` to `arduino_iomap.h`
    - An empty `arduino_pinmap.h` that just includes `arduino_iomap.h`
      is provided for backward compatibility
    - Move all info from `arduino_board.h` into the new file as trivial
      macros, so that they can also be used outside of sketches
    - The new name reflects the fact not just pin mappings, but also
      other I/O features such as PWMs are mapped
- Drop all `arduino_board.h`
    - `arduino_board.h` and `arduino_iomap.h` now provide the exact
      same information, just in a different format
    - a generic `arduino_board.h` is provided instead that just
      uses the info in `arduinio_iomap.h` and provides them in the
      format the code in `sys/arduino` expects it
- Add fine grained features to indicate for mappings
    - availability of mappings for analog pins, DAC pins, PWM pins,
      UART devices, SPI/I2C buses to the corresponding RIOT
      identification can now be expressed:
        - `arduino_pins`: `ARDUINO_PIN_0` etc. are available
        - `arduino_analog`: `ARDUINO_A0` etc. are available
        - `arduino_pwm`: `ARDUINO_PIN_13_PWM_DEV` etc. are available
        - `arduino_dac`: `ARDUINO_DAC0` etc. are available
        - `arduino_uart`: `ARDUINO_UART_D0D1` or similar are available
        - `arduino_spi`: `ARDUINO_SPI_ISP` or similar are available
        - `arduino_i2c`: `ARDUINO_I2C_UNO` or similar are available
    - mechanical/electrical compatibility with specific form factors
      can now be expressed as features:
        - `aruino_shield_nano`: Arduino NANO compatible headers
        - `aruino_shield_uno`: Arduino UNO compatible headers
        - `aruino_shield_mega`: Arduino MEGA compatible headers
        - `aruino_shield_isp`: ISP header is available

This provides the groundwork to implement shield support as modules
that can rely on the I/O mappings, rather than having to provide a
configuration per board.
2023-06-26 17:24:07 +02:00

108 lines
3.7 KiB
C

/*
* Copyright (C) 2021 J. David Ibáñez <jdavid.ibp@gmail.com>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @ingroup boards_feather-m0
* @{
*
* @file
* @brief Mapping from MCU pins to Arduino pins
*
* You can use the defines in this file for simplified interaction with the
* Arduino specific pin numbers.
*
* @author J. David Ibáñez <jdavid.ibp@gmail.com>
*/
#ifndef ARDUINO_IOMAP_H
#define ARDUINO_IOMAP_H
#include "periph/gpio.h"
#include "periph/adc.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @name Mapping of MCU pins to Arduino pins
*
* @{
*/
#define ARDUINO_PIN_0 GPIO_PIN(PA, 11) /**< D0 (RX) */
#define ARDUINO_PIN_1 GPIO_PIN(PA, 10) /**< D1 (TX) */
#define ARDUINO_PIN_5 GPIO_PIN(PA, 15) /**< D5 */
#define ARDUINO_PIN_6 GPIO_PIN(PA, 20) /**< D6 */
#define ARDUINO_PIN_9 GPIO_PIN(PA, 7) /**< D9 */
#define ARDUINO_PIN_10 GPIO_PIN(PA, 18) /**< D10 */
#define ARDUINO_PIN_11 GPIO_PIN(PA, 16) /**< D11 */
#define ARDUINO_PIN_12 GPIO_PIN(PA, 19) /**< D12 */
#define ARDUINO_PIN_13 GPIO_PIN(PA, 17) /**< D13 (LED) */
#define ARDUINO_PIN_14 GPIO_PIN(PA, 2) /**< D14 (A0) */
#define ARDUINO_PIN_15 GPIO_PIN(PB, 8) /**< D15 (A1) */
#define ARDUINO_PIN_16 GPIO_PIN(PB, 9) /**< D16 (A2) */
#define ARDUINO_PIN_17 GPIO_PIN(PA, 4) /**< D17 (A3) */
#define ARDUINO_PIN_18 GPIO_PIN(PA, 5) /**< D18 (A4) */
#define ARDUINO_PIN_19 GPIO_PIN(PB, 2) /**< D19 (A5) */
#define ARDUINO_PIN_20 GPIO_PIN(PA, 22) /**< D20 (I2C SDA) */
#define ARDUINO_PIN_21 GPIO_PIN(PA, 23) /**< D21 (I2C SCL) */
#define ARDUINO_PIN_22 GPIO_PIN(PA, 12) /**< D22 (SPI MISO) */
#define ARDUINO_PIN_23 GPIO_PIN(PB, 10) /**< D23 (SPI MOSI) */
#define ARDUINO_PIN_24 GPIO_PIN(PB, 11) /**< D24 (SPI SCK) */
#define ARDUINO_PIN_LAST 24
#if defined(BOARD_FEATHER_M0_WIFI)
# define ARDUINO_PIN_2 GPIO_PIN(PA, 14) /**< D2 (WINC_CHIP_EN) */
# define ARDUINO_PIN_4 GPIO_PIN(PA, 8) /**< D4 (WINC_RST) */
# define ARDUINO_PIN_7 GPIO_PIN(PA, 21) /**< D7 (WINC_IRQ) */
# define ARDUINO_PIN_8 GPIO_PIN(PA, 6) /**< D8 (WINC_CS) */
#elif defined(BOARD_FEATHER_M0_LORA)
# define ARDUINO_PIN_3 GPIO_PIN(PA, 9) /**< D3 (LORA_IRQ) */
# define ARDUINO_PIN_4 GPIO_PIN(PA, 8) /**< D4 (LORA_RST) */
# define ARDUINO_PIN_7 GPIO_UNDEF /**< D7 */
# define ARDUINO_PIN_8 GPIO_PIN(PA, 6) /**< D8 (LORA_CS) */
#endif
/** @} */
/**
* @name Aliases for analog pins
* @{
*/
#define ARDUINO_PIN_A0 ARDUINO_PIN_14
#define ARDUINO_PIN_A1 ARDUINO_PIN_15
#define ARDUINO_PIN_A2 ARDUINO_PIN_16
#define ARDUINO_PIN_A3 ARDUINO_PIN_17
#define ARDUINO_PIN_A4 ARDUINO_PIN_18
#define ARDUINO_PIN_A5 ARDUINO_PIN_19
#define ARDUINO_PIN_A7 ARDUINO_PIN_9
/** @} */
/**
* @name Mapping of Arduino analog pins to RIOT ADC lines
* @{
*/
#define ARDUINO_A0 ADC_LINE(0) /**< ADC 0 */
#define ARDUINO_A1 ADC_LINE(2) /**< ADC 1 */
#define ARDUINO_A2 ADC_LINE(3) /**< ADC 2 */
#define ARDUINO_A3 ADC_LINE(4) /**< ADC 3 */
#define ARDUINO_A4 ADC_LINE(5) /**< ADC 4 */
#define ARDUINO_A5 ADC_LINE(10) /**< ADC 5 */
#define ARDUINO_A7 ADC_LINE(7) /**< ADC 7 */
#define ARDUINO_ANALOG_PIN_LAST 7
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* ARDUINO_IOMAP_H */
/** @} */