STM32-GPIOv2.hpp

Go to the documentation of this file.

#ifndef SOURCE_CHIP_STM32_PERIPHERALS_GPIOV2_INCLUDE_DISTORTOS_CHIP_STM32_GPIOV2_HPP_
#define SOURCE_CHIP_STM32_PERIPHERALS_GPIOV2_INCLUDE_DISTORTOS_CHIP_STM32_GPIOV2_HPP_

#include "distortos/chip/CMSIS-proxy.h"

#include <utility>

namespace distortos
{

namespace chip
{

/*---------------------------------------------------------------------------------------------------------------------+
| global types
+---------------------------------------------------------------------------------------------------------------------*/

#ifdef GPIOA
static_assert((GPIOA_BASE & 15) == 0, "Cannot combine pin number with GPIOA address!");
#endif  // def GPIOA

#ifdef GPIOB
static_assert((GPIOB_BASE & 15) == 0, "Cannot combine pin number with GPIOB address!");
#endif  // def GPIOB

#ifdef GPIOC
static_assert((GPIOC_BASE & 15) == 0, "Cannot combine pin number with GPIOC address!");
#endif  // def GPIOC

#ifdef GPIOD
static_assert((GPIOD_BASE & 15) == 0, "Cannot combine pin number with GPIOD address!");
#endif  // def GPIOD

#ifdef GPIOE
static_assert((GPIOE_BASE & 15) == 0, "Cannot combine pin number with GPIOE address!");
#endif  // def GPIOE

#ifdef GPIOF
static_assert((GPIOF_BASE & 15) == 0, "Cannot combine pin number with GPIOF address!");
#endif  // def GPIOF

#ifdef GPIOG
static_assert((GPIOG_BASE & 15) == 0, "Cannot combine pin number with GPIOG address!");
#endif  // def GPIOG

#ifdef GPIOH
static_assert((GPIOH_BASE & 15) == 0, "Cannot combine pin number with GPIOH address!");
#endif  // def GPIOH

#ifdef GPIOI
static_assert((GPIOI_BASE & 15) == 0, "Cannot combine pin number with GPIOI address!");
#endif  // def GPIOI

#ifdef GPIOJ
static_assert((GPIOJ_BASE & 15) == 0, "Cannot combine pin number with GPIOJ address!");
#endif  // def GPIOJ

#ifdef GPIOK
static_assert((GPIOK_BASE & 15) == 0, "Cannot combine pin number with GPIOK address!");
#endif  // def GPIOK

enum class Pin : uint32_t
{
#ifdef GPIOA

        pa0 = GPIOA_BASE | 0,
        pa1 = GPIOA_BASE | 1,
        pa2 = GPIOA_BASE | 2,
        pa3 = GPIOA_BASE | 3,
        pa4 = GPIOA_BASE | 4,
        pa5 = GPIOA_BASE | 5,
        pa6 = GPIOA_BASE | 6,
        pa7 = GPIOA_BASE | 7,
        pa8 = GPIOA_BASE | 8,
        pa9 = GPIOA_BASE | 9,
        pa10 = GPIOA_BASE | 10,
        pa11 = GPIOA_BASE | 11,
        pa12 = GPIOA_BASE | 12,
        pa13 = GPIOA_BASE | 13,
        pa14 = GPIOA_BASE | 14,
        pa15 = GPIOA_BASE | 15,

#endif  // def GPIOA

#ifdef GPIOB

        pb0 = GPIOB_BASE | 0,
        pb1 = GPIOB_BASE | 1,
        pb2 = GPIOB_BASE | 2,
        pb3 = GPIOB_BASE | 3,
        pb4 = GPIOB_BASE | 4,
        pb5 = GPIOB_BASE | 5,
        pb6 = GPIOB_BASE | 6,
        pb7 = GPIOB_BASE | 7,
        pb8 = GPIOB_BASE | 8,
        pb9 = GPIOB_BASE | 9,
        pb10 = GPIOB_BASE | 10,
        pb11 = GPIOB_BASE | 11,
        pb12 = GPIOB_BASE | 12,
        pb13 = GPIOB_BASE | 13,
        pb14 = GPIOB_BASE | 14,
        pb15 = GPIOB_BASE | 15,

#endif  // def GPIOB

#ifdef GPIOC

        pc0 = GPIOC_BASE | 0,
        pc1 = GPIOC_BASE | 1,
        pc2 = GPIOC_BASE | 2,
        pc3 = GPIOC_BASE | 3,
        pc4 = GPIOC_BASE | 4,
        pc5 = GPIOC_BASE | 5,
        pc6 = GPIOC_BASE | 6,
        pc7 = GPIOC_BASE | 7,
        pc8 = GPIOC_BASE | 8,
        pc9 = GPIOC_BASE | 9,
        pc10 = GPIOC_BASE | 10,
        pc11 = GPIOC_BASE | 11,
        pc12 = GPIOC_BASE | 12,
        pc13 = GPIOC_BASE | 13,
        pc14 = GPIOC_BASE | 14,
        pc15 = GPIOC_BASE | 15,

#endif  // def GPIOC

#ifdef GPIOD

        pd0 = GPIOD_BASE | 0,
        pd1 = GPIOD_BASE | 1,
        pd2 = GPIOD_BASE | 2,
        pd3 = GPIOD_BASE | 3,
        pd4 = GPIOD_BASE | 4,
        pd5 = GPIOD_BASE | 5,
        pd6 = GPIOD_BASE | 6,
        pd7 = GPIOD_BASE | 7,
        pd8 = GPIOD_BASE | 8,
        pd9 = GPIOD_BASE | 9,
        pd10 = GPIOD_BASE | 10,
        pd11 = GPIOD_BASE | 11,
        pd12 = GPIOD_BASE | 12,
        pd13 = GPIOD_BASE | 13,
        pd14 = GPIOD_BASE | 14,
        pd15 = GPIOD_BASE | 15,

#endif  // def GPIOD

#ifdef GPIOE

        pe0 = GPIOE_BASE | 0,
        pe1 = GPIOE_BASE | 1,
        pe2 = GPIOE_BASE | 2,
        pe3 = GPIOE_BASE | 3,
        pe4 = GPIOE_BASE | 4,
        pe5 = GPIOE_BASE | 5,
        pe6 = GPIOE_BASE | 6,
        pe7 = GPIOE_BASE | 7,
        pe8 = GPIOE_BASE | 8,
        pe9 = GPIOE_BASE | 9,
        pe10 = GPIOE_BASE | 10,
        pe11 = GPIOE_BASE | 11,
        pe12 = GPIOE_BASE | 12,
        pe13 = GPIOE_BASE | 13,
        pe14 = GPIOE_BASE | 14,
        pe15 = GPIOE_BASE | 15,

#endif  // def GPIOE

#ifdef GPIOF

        pf0 = GPIOF_BASE | 0,
        pf1 = GPIOF_BASE | 1,
        pf2 = GPIOF_BASE | 2,
        pf3 = GPIOF_BASE | 3,
        pf4 = GPIOF_BASE | 4,
        pf5 = GPIOF_BASE | 5,
        pf6 = GPIOF_BASE | 6,
        pf7 = GPIOF_BASE | 7,
        pf8 = GPIOF_BASE | 8,
        pf9 = GPIOF_BASE | 9,
        pf10 = GPIOF_BASE | 10,
        pf11 = GPIOF_BASE | 11,
        pf12 = GPIOF_BASE | 12,
        pf13 = GPIOF_BASE | 13,
        pf14 = GPIOF_BASE | 14,
        pf15 = GPIOF_BASE | 15,

#endif  // def GPIOF

#ifdef GPIOG

        pg0 = GPIOG_BASE | 0,
        pg1 = GPIOG_BASE | 1,
        pg2 = GPIOG_BASE | 2,
        pg3 = GPIOG_BASE | 3,
        pg4 = GPIOG_BASE | 4,
        pg5 = GPIOG_BASE | 5,
        pg6 = GPIOG_BASE | 6,
        pg7 = GPIOG_BASE | 7,
        pg8 = GPIOG_BASE | 8,
        pg9 = GPIOG_BASE | 9,
        pg10 = GPIOG_BASE | 10,
        pg11 = GPIOG_BASE | 11,
        pg12 = GPIOG_BASE | 12,
        pg13 = GPIOG_BASE | 13,
        pg14 = GPIOG_BASE | 14,
        pg15 = GPIOG_BASE | 15,

#endif  // def GPIOG

#ifdef GPIOH

        ph0 = GPIOH_BASE | 0,
        ph1 = GPIOH_BASE | 1,
        ph2 = GPIOH_BASE | 2,
        ph3 = GPIOH_BASE | 3,
        ph4 = GPIOH_BASE | 4,
        ph5 = GPIOH_BASE | 5,
        ph6 = GPIOH_BASE | 6,
        ph7 = GPIOH_BASE | 7,
        ph8 = GPIOH_BASE | 8,
        ph9 = GPIOH_BASE | 9,
        ph10 = GPIOH_BASE | 10,
        ph11 = GPIOH_BASE | 11,
        ph12 = GPIOH_BASE | 12,
        ph13 = GPIOH_BASE | 13,
        ph14 = GPIOH_BASE | 14,
        ph15 = GPIOH_BASE | 15,

#endif  // def GPIOH

#ifdef GPIOI

        pi0 = GPIOI_BASE | 0,
        pi1 = GPIOI_BASE | 1,
        pi2 = GPIOI_BASE | 2,
        pi3 = GPIOI_BASE | 3,
        pi4 = GPIOI_BASE | 4,
        pi5 = GPIOI_BASE | 5,
        pi6 = GPIOI_BASE | 6,
        pi7 = GPIOI_BASE | 7,
        pi8 = GPIOI_BASE | 8,
        pi9 = GPIOI_BASE | 9,
        pi10 = GPIOI_BASE | 10,
        pi11 = GPIOI_BASE | 11,
        pi12 = GPIOI_BASE | 12,
        pi13 = GPIOI_BASE | 13,
        pi14 = GPIOI_BASE | 14,
        pi15 = GPIOI_BASE | 15,

#endif  // def GPIOI

#ifdef GPIOJ

        pj0 = GPIOJ_BASE | 0,
        pj1 = GPIOJ_BASE | 1,
        pj2 = GPIOJ_BASE | 2,
        pj3 = GPIOJ_BASE | 3,
        pj4 = GPIOJ_BASE | 4,
        pj5 = GPIOJ_BASE | 5,
        pj6 = GPIOJ_BASE | 6,
        pj7 = GPIOJ_BASE | 7,
        pj8 = GPIOJ_BASE | 8,
        pj9 = GPIOJ_BASE | 9,
        pj10 = GPIOJ_BASE | 10,
        pj11 = GPIOJ_BASE | 11,
        pj12 = GPIOJ_BASE | 12,
        pj13 = GPIOJ_BASE | 13,
        pj14 = GPIOJ_BASE | 14,
        pj15 = GPIOJ_BASE | 15,

#endif  // def GPIOJ

#ifdef GPIOK

        pk0 = GPIOK_BASE | 0,
        pk1 = GPIOK_BASE | 1,
        pk2 = GPIOK_BASE | 2,
        pk3 = GPIOK_BASE | 3,
        pk4 = GPIOK_BASE | 4,
        pk5 = GPIOK_BASE | 5,
        pk6 = GPIOK_BASE | 6,
        pk7 = GPIOK_BASE | 7,
        pk8 = GPIOK_BASE | 8,
        pk9 = GPIOK_BASE | 9,
        pk10 = GPIOK_BASE | 10,
        pk11 = GPIOK_BASE | 11,
        pk12 = GPIOK_BASE | 12,
        pk13 = GPIOK_BASE | 13,
        pk14 = GPIOK_BASE | 14,
        pk15 = GPIOK_BASE | 15,

#endif  // def GPIOK
};

enum class PinAlternateFunction : uint8_t
{
        af0,
        af1,
        af2,
        af3,
        af4,
        af5,
        af6,
        af7,
#ifdef DISTORTOS_CHIP_GPIO_HAS_4_AF_BITS
        af8,
        af9,
        af10,
        af11,
        af12,
        af13,
        af14,
        af15,
#endif  // def DISTORTOS_CHIP_GPIO_HAS_4_AF_BITS
};

enum class PinMode : uint8_t
{
        input,
        output,
        alternateFunction,
        analog,
};

enum class PinOutputSpeed : uint8_t
{
        low,
        medium,
#ifdef DISTORTOS_CHIP_GPIO_HAS_HIGH_SPEED
        high,
#endif  // def DISTORTOS_CHIP_GPIO_HAS_HIGH_SPEED
        veryHigh = 3,
};

enum class PinPull : uint8_t
{
        none,
        up,
        down,
};

/*---------------------------------------------------------------------------------------------------------------------+
| global functions
+---------------------------------------------------------------------------------------------------------------------*/

void configurePin(Pin pin, PinMode mode, bool openDrain, PinOutputSpeed outputSpeed, PinPull pull,
        PinAlternateFunction alternateFunction, bool initialState = {});

inline void configureAlternateFunctionPin(const Pin pin, const PinAlternateFunction alternateFunction,
        const bool openDrain = {}, const PinOutputSpeed outputSpeed = {}, const PinPull pull = {})
{
    configurePin(pin, PinMode::alternateFunction, openDrain, outputSpeed, pull, alternateFunction, {});
}

inline void configureAnalogPin(const Pin pin)
{
    configurePin(pin, PinMode::analog, {}, {}, {}, {}, {});
}

inline void configureInputPin(const Pin pin, const PinPull pull = {})
{
    configurePin(pin, PinMode::input, {}, {}, pull, {}, {});
}

inline void configureOutputPin(const Pin pin, const bool openDrain = {}, const PinOutputSpeed outputSpeed = {},
        const PinPull pull = {}, const bool initialState = {})
{
    configurePin(pin, PinMode::output, openDrain, outputSpeed, pull, {}, initialState);
}

constexpr std::pair<GPIO_TypeDef*, uint8_t> decodePin(const Pin pin)
{
    return std::make_pair(reinterpret_cast<GPIO_TypeDef*>(static_cast<uint32_t>(pin) & ~15),
            static_cast<uint32_t>(pin) & 15);
}

}   // namespace chip

}   // namespace distortos

#endif  // SOURCE_CHIP_STM32_PERIPHERALS_GPIOV2_INCLUDE_DISTORTOS_CHIP_STM32_GPIOV2_HPP_