STM32F4-RCC.hpp

Go to the documentation of this file.

#ifndef SOURCE_CHIP_STM32_STM32F4_INCLUDE_DISTORTOS_CHIP_STM32F4_RCC_HPP_
#define SOURCE_CHIP_STM32_STM32F4_INCLUDE_DISTORTOS_CHIP_STM32F4_RCC_HPP_

#include "distortos/distortosConfiguration.h"

#include <cstdint>

namespace distortos
{

namespace chip
{

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

enum class SystemClockSource : uint8_t
{
    hsi,
    hse,
    pll,

#if defined(DISTORTOS_CHIP_STM32F446) || defined(DISTORTOS_CHIP_STM32F469) || defined(DISTORTOS_CHIP_STM32F479)

    pllr,

#endif  // defined(DISTORTOS_CHIP_STM32F446) || defined(DISTORTOS_CHIP_STM32F469) || defined(DISTORTOS_CHIP_STM32F479)
};

/*---------------------------------------------------------------------------------------------------------------------+
| global constants
+---------------------------------------------------------------------------------------------------------------------*/

constexpr uint8_t minPllm {2};

constexpr uint8_t maxPllm {63};

#if defined(DISTORTOS_CHIP_STM32F401)
constexpr uint16_t minPlln {192};
#else   // !defined(DISTORTOS_CHIP_STM32F401)
constexpr uint16_t minPlln {50};
#endif  // !defined(DISTORTOS_CHIP_STM32F401)

constexpr uint16_t maxPlln {432};

constexpr uint8_t minPllq {2};

constexpr uint8_t maxPllq {15};

#if defined(DISTORTOS_CHIP_STM32F412) || defined(DISTORTOS_CHIP_STM32F413) || defined(DISTORTOS_CHIP_STM32F423) || \
        defined(DISTORTOS_CHIP_STM32F446) || defined(DISTORTOS_CHIP_STM32F469) || defined(DISTORTOS_CHIP_STM32F479)

constexpr uint8_t minPllr {2};

constexpr uint8_t maxPllr {7};

#endif  // defined(DISTORTOS_CHIP_STM32F412) || defined(DISTORTOS_CHIP_STM32F413) ||
        // defined(DISTORTOS_CHIP_STM32F423) || defined(DISTORTOS_CHIP_STM32F446) ||
        // defined(DISTORTOS_CHIP_STM32F469) || defined(DISTORTOS_CHIP_STM32F479)

constexpr uint8_t pllpDiv2 {2};

constexpr uint8_t pllpDiv4 {4};

constexpr uint8_t pllpDiv6 {6};

constexpr uint8_t pllpDiv8 {8};

constexpr uint16_t hpreDiv1 {1};

constexpr uint16_t hpreDiv2 {2};

constexpr uint16_t hpreDiv4 {4};

constexpr uint16_t hpreDiv8 {8};

constexpr uint16_t hpreDiv16 {16};

constexpr uint16_t hpreDiv64 {64};

constexpr uint16_t hpreDiv128 {128};

constexpr uint16_t hpreDiv256 {256};

constexpr uint16_t hpreDiv512 {512};

constexpr uint8_t ppreDiv1 {1};

constexpr uint8_t ppreDiv2 {2};

constexpr uint8_t ppreDiv4 {4};

constexpr uint8_t ppreDiv8 {8};

constexpr uint8_t ppreDiv16 {16};

/*---------------------------------------------------------------------------------------------------------------------+
| global functions' declarations
+---------------------------------------------------------------------------------------------------------------------*/

int configureAhbClockDivider(uint16_t hpre);

int configureApbClockDivider(bool ppre2, uint8_t ppre);

void configurePllClockSource(bool hse);

int configurePllInputClockDivider(uint8_t pllm);

void disableHse();

void disablePll();

void enableHse(bool bypass);

#if defined(DISTORTOS_CHIP_STM32F412) || defined(DISTORTOS_CHIP_STM32F413) || defined(DISTORTOS_CHIP_STM32F423) || \
        defined(DISTORTOS_CHIP_STM32F446) || defined(DISTORTOS_CHIP_STM32F469) || defined(DISTORTOS_CHIP_STM32F479)

int enablePll(uint16_t plln, uint8_t pllp, uint8_t pllq, uint8_t pllr);

#else   // !defined(DISTORTOS_CHIP_STM32F412) && !defined(DISTORTOS_CHIP_STM32F413) &&
        // !defined(DISTORTOS_CHIP_STM32F423) && !defined(DISTORTOS_CHIP_STM32F446) &&
        // !defined(DISTORTOS_CHIP_STM32F469) && !defined(DISTORTOS_CHIP_STM32F479)

int enablePll(uint16_t plln, uint8_t pllp, uint8_t pllq);

#endif  // !defined(DISTORTOS_CHIP_STM32F412) && !defined(DISTORTOS_CHIP_STM32F413) &&
        // !defined(DISTORTOS_CHIP_STM32F423) && !defined(DISTORTOS_CHIP_STM32F446) &&
        // !defined(DISTORTOS_CHIP_STM32F469) && !defined(DISTORTOS_CHIP_STM32F479)

void switchSystemClock(SystemClockSource source);

}   // namespace chip

}   // namespace distortos

#endif  // SOURCE_CHIP_STM32_STM32F4_INCLUDE_DISTORTOS_CHIP_STM32F4_RCC_HPP_