RCC_program.c File Reference

This file contains the implementation for the RCC module. More...

#include "../../LIB/LSTD_TYPES.h"
#include "../../LIB/LSTD_BITMATH.h"
#include "../../LIB/LSTD_COMPILER.h"
#include "../../LIB/LSTD_VALUES.h"
#include "RCC_private.h"
#include "RCC_interface.h"
#include "RCC_config.h"

Include dependency graph for RCC_program.c:

Functions
static void	RCC_vInitHSEClock (void)
	This function initializes the HSE clock. More...
static void	RCC_vInitHSIClock (void)
	This function initializes the HSI clock. More...
static void	RCC_vInitPLL (void)
	This function initializes the PLL clock. More...
static void	RCC_vInitSystemClock (void)
	This function initializes the system clock. More...
static void	RCC_vInitMCO (void)
	This function initializes the MCO. More...
static void	RCC_vSetAPB2PeripheralClockStatus (t_RCC_APB2Peripherals enuPeripheral, t_bool bStatus)
	This function initializes a certain peripheral clock on APB2 bus. More...
static void	RCC_vSetAPB1PeripheralClockStatus (t_RCC_APB1Peripherals enuPeripheral, t_bool bStatus)
	This function initializes a certain peripheral clock on APB1 bus. More...
static void	RCC_vSetAHBPeripheralClockStatus (t_RCC_AHBPeripherals enuPeripheral, t_bool bStatus)
	This function initializes a certain peripheral clock on AHB bus. More...
static void	RCC_vSetADCPreScaler (void)
	This function sets the ADC prescaler. More...
static void	RCC_vSetUSBPrescaler (void)
	This function sets the USB prescaler. More...
static void	RCC_vSetAHBPrescaler (void)
	This function sets the AHB prescaler. More...
static void	RCC_vSetAPB1Prescaler (void)
	This function sets the APB1 prescaler. More...
static void	RCC_vSetAPB2Prescaler (void)
	This function sets the APB2 prescaler. More...
void	RCC_vInit (void)
	This function initializes the RCC peripheral. More...
void	RCC_vEnablePeripheralABP2 (t_RCC_APB2Peripherals enuPeripheral)
	This function enables the clock of a peripheral connected to the APB2 bus. More...
void	RCC_vDisablePeripheralABP2 (t_RCC_APB2Peripherals enuPeripheral)
	This function disables the clock of a peripheral connected to the APB2 bus. More...
void	RCC_vEnablePeripheralABP1 (t_RCC_APB1Peripherals enuPeripheral)
	This function enables the clock of a peripheral connected to the APB1 bus. More...
void	RCC_vDisablePeripheralABP1 (t_RCC_APB1Peripherals enuPeripheral)
	This function disables the clock of a peripheral connected to the APB1 bus. More...
void	RCC_vEnablePeripheralAHB (t_RCC_AHBPeripherals enuPeripheral)
	This function enables the clock of a peripheral connected to the AHB bus. More...
void	RCC_vDisablePeripheralAHB (t_RCC_AHBPeripherals enuPeripheral)
	This function disables the clock of a peripheral connected to the AHB bus. More...

Detailed Description

This file contains the implementation for the RCC module.

Author

Mohamed Alaa

Version

1.0.0

This file contains the implementation for the RCC module.

Date

2023-06-18

Function Documentation

RCC_vInitHSEClock()

static void RCC_vInitHSEClock ( void  )

static

This function initializes the HSE clock.

This function initializes the HSE clock and waits until it is ready

{
    /* Enable HSE bypass */
    RCC.CR.HSEBYP = TRUE;
    /* Enable HSE */
    RCC.CR.HSEON = TRUE;
    /* Wait until HSE is ready */
    while (RCC.CR.HSERDY == FALSE)
        ;
 
    if (RCC_ENABLE_CSS == TRUE)
    {
        /* Enable CSS */
        RCC.CR.CSSON = TRUE;
    }
    else
    {
        /* Disable CSS */
        RCC.CR.CSSON = FALSE;
    }
}

References FALSE, RCC, RCC_ENABLE_CSS, and TRUE.

Referenced by RCC_vInit(), and RCC_vInitPLL().

Here is the caller graph for this function:

RCC_vInitHSIClock()

static void RCC_vInitHSIClock ( void  )

static

This function initializes the HSI clock.

This function initializes the HSI clock and waits until it is ready

{
    /* Enable HSI */
    RCC.CR.HSION = TRUE;
    /* Wait until HSI is ready */
    while (RCC.CR.HSIRDY == FALSE)
        ;
}

References FALSE, RCC, and TRUE.

Referenced by RCC_vInit(), and RCC_vInitPLL().

Here is the caller graph for this function:

RCC_vInitPLL()

static void RCC_vInitPLL ( void  )

static

This function initializes the PLL clock.

This function initializes the PLL clock and waits until it is ready

{
    if (RCC_PLL_SRC == RCC_PLLSource_HSE)
    {
        RCC_vInitHSEClock();
    }
    else if (RCC_PLL_SRC == RCC_PLLSource_HSI_DividedBy2)
    {
        RCC_vInitHSIClock();
    }
    else
    {
        /* Do nothing */
    }
 
    /* Set PLL source to HSE */
    RCC.CFGR.PLLSRC = RCC_PLL_SRC;
    /* Set PLL multiplication factor */
    RCC.CFGR.PLLMUL = RCC_PLL_MUL;
    /* Set PLL entry HSE divider */
    RCC.CFGR.PLLXTPRE = RCC_PLL_HSE_DIVIDE_BY_2;
    /* Enable PLL */
    RCC.CR.PLLON = TRUE;
    /* Wait until PLL is ready */
    while (RCC.CR.PLLRDY == FALSE)
        ;
}

References FALSE, RCC, RCC_PLL_HSE_DIVIDE_BY_2, RCC_PLL_MUL, RCC_PLL_SRC, RCC_PLLSource_HSE, RCC_PLLSource_HSI_DividedBy2, RCC_vInitHSEClock(), RCC_vInitHSIClock(), and TRUE.

Referenced by RCC_vInit().

Here is the call graph for this function:

Here is the caller graph for this function:

RCC_vInitSystemClock()

static void RCC_vInitSystemClock ( void  )

static

This function initializes the system clock.

This function initializes the system clock

{
    /* Set system clock source */
    RCC.CFGR.SW = RCC_SYSTEM_CLOCK_SOURCE;
    /* Wait until system clock source is set */
    while (RCC.CFGR.SWS != RCC_SYSTEM_CLOCK_SOURCE)
        ;
}

References RCC, and RCC_SYSTEM_CLOCK_SOURCE.

Referenced by RCC_vInit().

Here is the caller graph for this function:

RCC_vInitMCO()

static void RCC_vInitMCO ( void  )

static

This function initializes the MCO.

This function initializes the MCO (Microcontroller Clock Output) and waits until it is ready

{
    /* Set MCO source */
    RCC.CFGR.MCO = RCC_MCO_SOURCE;
}

References RCC, and RCC_MCO_SOURCE.

Referenced by RCC_vInit().

Here is the caller graph for this function:

RCC_vSetAPB2PeripheralClockStatus()

static void RCC_vSetAPB2PeripheralClockStatus ( t_RCC_APB2Peripherals  enuPeripheral, t_bool  bStatus  )

static

This function initializes a certain peripheral clock on APB2 bus.

This function initializes a certain peripheral clock on APB2 bus

Parameters

[in]	enuPeripheral	Peripheral to enable/disable its clock
[in]	bStatus	Enable/Disable peripheral clock

See also

RCC_APB2Peripherals

{
    switch (enuPeripheral)
    {
    case RCC_APB2Peripherals_AFIO:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, AFIOEN, bStatus);
        break;
    case RCC_APB2Peripherals_PORTA:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, IOPAEN, bStatus);
        break;
    case RCC_APB2Peripherals_PORTB:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, IOPBEN, bStatus);
        break;
    case RCC_APB2Peripherals_PORTC:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, IOPCEN, bStatus);
        break;
    case RCC_APB2Peripherals_PORTD:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, IOPDEN, bStatus);
        break;
    case RCC_APB2Peripherals_PORTE:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, IOPEEN, bStatus);
        break;
    case RCC_APB2Peripherals_PORTF:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, IOPFEN, bStatus);
        break;
    case RCC_APB2Peripherals_PORTG:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, IOPGEN, bStatus);
        break;
    case RCC_APB2Peripherals_ADC1:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, ADC1EN, bStatus);
        break;
    case RCC_APB2Peripherals_ADC2:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, ADC2EN, bStatus);
        break;
    case RCC_APB2Peripherals_TIM1:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, TIM1EN, bStatus);
        break;
    case RCC_APB2Peripherals_SPI1:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, SPI1EN, bStatus);
        break;
    case RCC_APB2Peripherals_USART1:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, USART1EN, bStatus);
        break;
    case RCC_APB2Peripherals_ADC3:
        RCC_SET_REGISTER_BIT_STATUS(APB2ENR, ADC3EN, bStatus);
        break;
    default:
        /* Do nothing */
        break;
    }
}

References RCC_APB2Peripherals_ADC1, RCC_APB2Peripherals_ADC2, RCC_APB2Peripherals_ADC3, RCC_APB2Peripherals_AFIO, RCC_APB2Peripherals_PORTA, RCC_APB2Peripherals_PORTB, RCC_APB2Peripherals_PORTC, RCC_APB2Peripherals_PORTD, RCC_APB2Peripherals_PORTE, RCC_APB2Peripherals_PORTF, RCC_APB2Peripherals_PORTG, RCC_APB2Peripherals_SPI1, RCC_APB2Peripherals_TIM1, RCC_APB2Peripherals_USART1, and RCC_SET_REGISTER_BIT_STATUS.

Referenced by RCC_vDisablePeripheralABP2(), and RCC_vEnablePeripheralABP2().

Here is the caller graph for this function:

RCC_vSetAPB1PeripheralClockStatus()

static void RCC_vSetAPB1PeripheralClockStatus ( t_RCC_APB1Peripherals  enuPeripheral, t_bool  bStatus  )

static

This function initializes a certain peripheral clock on APB1 bus.

This function initializes a certain peripheral clock on APB1 bus

Parameters

[in]	enuPeripheral	Peripheral to enable/disable its clock
[in]	bStatus	Enable/Disable peripheral clock

See also

t_RCC_APB1Peripherals

{
    switch (enuPeripheral)
    {
    case RCC_APB1Peripherals_TIM2:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, TIM2EN, bStatus);
        break;
    case RCC_APB1Peripherals_TIM3:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, TIM3EN, bStatus);
        break;
    case RCC_APB1Peripherals_TIM4:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, TIM4EN, bStatus);
        break;
    case RCC_APB1Peripherals_TIM5:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, TIM5EN, bStatus);
        break;
    case RCC_APB1Peripherals_TIM6:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, TIM6EN, bStatus);
        break;
    case RCC_APB1Peripherals_TIM7:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, TIM7EN, bStatus);
        break;
    case RCC_APB1Peripherals_WWDG:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, WWDGEN, bStatus);
        break;
    case RCC_APB1Peripherals_SPI2:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, SPI2EN, bStatus);
        break;
    case RCC_APB1Peripherals_SPI3:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, SPI3EN, bStatus);
        break;
    case RCC_APB1Peripherals_USART2:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, USART2EN, bStatus);
        break;
    case RCC_APB1Peripherals_USART3:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, USART3EN, bStatus);
        break;
    case RCC_APB1Peripherals_UART4:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, UART4EN, bStatus);
        break;
    case RCC_APB1Peripherals_UART5:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, UART5EN, bStatus);
        break;
    case RCC_APB1Peripherals_I2C1:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, I2C1EN, bStatus);
        break;
    case RCC_APB1Peripherals_I2C2:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, I2C2EN, bStatus);
        break;
    case RCC_APB1Peripherals_USB:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, USBEN, bStatus);
        break;
    case RCC_APB1Peripherals_CAN:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, CANEN, bStatus);
        break;
    case RCC_APB1Peripherals_BKP:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, BKPEN, bStatus);
        break;
    case RCC_APB1Peripherals_PWR:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, PWREN, bStatus);
        break;
    case RCC_APB1Peripherals_DAC:
        RCC_SET_REGISTER_BIT_STATUS(APB1ENR, DACEN, bStatus);
        break;
    default:
        /* Do nothing */
        break;
    }
}

References RCC_APB1Peripherals_BKP, RCC_APB1Peripherals_CAN, RCC_APB1Peripherals_DAC, RCC_APB1Peripherals_I2C1, RCC_APB1Peripherals_I2C2, RCC_APB1Peripherals_PWR, RCC_APB1Peripherals_SPI2, RCC_APB1Peripherals_SPI3, RCC_APB1Peripherals_TIM2, RCC_APB1Peripherals_TIM3, RCC_APB1Peripherals_TIM4, RCC_APB1Peripherals_TIM5, RCC_APB1Peripherals_TIM6, RCC_APB1Peripherals_TIM7, RCC_APB1Peripherals_UART4, RCC_APB1Peripherals_UART5, RCC_APB1Peripherals_USART2, RCC_APB1Peripherals_USART3, RCC_APB1Peripherals_USB, RCC_APB1Peripherals_WWDG, and RCC_SET_REGISTER_BIT_STATUS.

Referenced by RCC_vDisablePeripheralABP1(), and RCC_vEnablePeripheralABP1().

Here is the caller graph for this function:

RCC_vSetAHBPeripheralClockStatus()

static void RCC_vSetAHBPeripheralClockStatus ( t_RCC_AHBPeripherals  enuPeripheral, t_bool  bStatus  )

static

This function initializes a certain peripheral clock on AHB bus.

This function initializes a certain peripheral clock on AHB bus

Parameters

[in]	enuPeripheral	Peripheral to enable/disable its clock
[in]	bStatus	Enable/Disable peripheral clock

See also

t_RCC_AHBPeripherals

{
    switch (enuPeripheral)
    {
    case RCC_AHBPeripherals_DMA1:
        RCC_SET_REGISTER_BIT_STATUS(AHBENR, DMA1EN, bStatus);
        break;
    case RCC_AHBPeripherals_DMA2:
        RCC_SET_REGISTER_BIT_STATUS(AHBENR, DMA2EN, bStatus);
        break;
    case RCC_AHBPeripherals_CRC:
        RCC_SET_REGISTER_BIT_STATUS(AHBENR, CRCEN, bStatus);
        break;
    default:
        /* Do nothing */
        break;
    }
}

References RCC_AHBPeripherals_CRC, RCC_AHBPeripherals_DMA1, RCC_AHBPeripherals_DMA2, and RCC_SET_REGISTER_BIT_STATUS.

Referenced by RCC_vDisablePeripheralAHB(), and RCC_vEnablePeripheralAHB().

Here is the caller graph for this function:

RCC_vSetADCPreScaler()

static void RCC_vSetADCPreScaler ( void  )

static

This function sets the ADC prescaler.

This function sets the ADC prescaler to be used by ADC

{
    /* Set ADC prescaler */
    RCC.CFGR.ADCPRE = RCC_ADC_PRESCALER;
}

References RCC, and RCC_ADC_PRESCALER.

Referenced by RCC_vInit().

Here is the caller graph for this function:

RCC_vSetUSBPrescaler()

static void RCC_vSetUSBPrescaler ( void  )

static

This function sets the USB prescaler.

This function sets the USB prescaler to be used by USB

{
    /* Set USB prescaler */
    RCC.CFGR.USBPRE = RCC_USB_PRESCALER;
}

References RCC, and RCC_USB_PRESCALER.

Referenced by RCC_vInit().

Here is the caller graph for this function:

RCC_vSetAHBPrescaler()

static void RCC_vSetAHBPrescaler ( void  )

static

This function sets the AHB prescaler.

This function sets the AHB prescaler to be used by AHB bus

{
    /* Set AHB prescaler */
    RCC.CFGR.HPRE = RCC_AHB_PRESCALER;
}

References RCC, and RCC_AHB_PRESCALER.

Referenced by RCC_vInit().

Here is the caller graph for this function:

RCC_vSetAPB1Prescaler()

static void RCC_vSetAPB1Prescaler ( void  )

static

This function sets the APB1 prescaler.

This function sets the APB1 prescaler to be used by APB1 bus

{
    /* Set APB1 prescaler */
    RCC.CFGR.PPRE1 = RCC_APB1_PRESCALER;
}

References RCC, and RCC_APB1_PRESCALER.

Referenced by RCC_vInit().

Here is the caller graph for this function:

RCC_vSetAPB2Prescaler()

static void RCC_vSetAPB2Prescaler ( void  )

static

This function sets the APB2 prescaler.

This function sets the APB2 prescaler to be used by APB2 bus

{
    /* Set APB2 prescaler */
    RCC.CFGR.PPRE2 = RCC_APB2_PRESCALER;
}

References RCC, and RCC_APB2_PRESCALER.

Referenced by RCC_vInit().

Here is the caller graph for this function: