VSF Documented
Macros | Typedefs | Enumerations | Functions | Variables
common.h File Reference
#include "hal/vsf_hal_cfg.h"
#include "hal/arch/vsf_arch.h"

Go to the source code of this file.

Macros

#define VSF_HW_CLKRST_REGION(__WORD_OFFSET, __BIT_OFFSET, __BIT_LENGTH)    (((__WORD_OFFSET) << 16) | ((__BIT_LENGTH) << 8) | ((__BIT_OFFSET) << 0))
 
#define vsf_hw_peripheral_clk_set   vsf_hw_clkrst_region_set
 
#define vsf_hw_peripheral_clk_get   vsf_hw_clkrst_region_get
 
#define vsf_hw_peripheral_rst_set   vsf_hw_clkrst_region_set_bit
 
#define vsf_hw_peripheral_rst_clear   vsf_hw_clkrst_region_clear_bit
 
#define vsf_hw_peripheral_rst_get   vsf_hw_clkrst_region_get_bit
 
#define vsf_hw_peripheral_enable   vsf_hw_clkrst_region_set_bit
 
#define vsf_hw_peripheral_disable   vsf_hw_clkrst_region_clear_bit
 
#define VSF_HW_CLK_USART1   VSF_HW_CLK_USART16
 
#define VSF_HW_CLK_USART2   VSF_HW_CLK_USART234578
 
#define VSF_HW_CLK_USART3   VSF_HW_CLK_USART234578
 
#define VSF_HW_CLK_UART4   VSF_HW_CLK_USART234578
 
#define VSF_HW_CLK_UART5   VSF_HW_CLK_USART234578
 
#define VSF_HW_CLK_USART6   VSF_HW_CLK_USART16
 
#define VSF_HW_CLK_UART7   VSF_HW_CLK_USART234578
 
#define VSF_HW_CLK_UART8   VSF_HW_CLK_USART234578
 
#define VSF_HW_CLK_SDMMC1   VSF_HW_CLK_SDMMC
 
#define VSF_HW_CLK_SDMMC2   VSF_HW_CLK_SDMMC
 

Typedefs

typedef enum vsf_hw_peripheral_rst_t vsf_hw_peripheral_rst_t
 
typedef enum vsf_hw_peripheral_en_t vsf_hw_peripheral_en_t
 
typedef struct vsf_hw_clk_t vsf_hw_clk_t
 

Enumerations

enum  vsf_hw_peripheral_rst_t {
  VSF_HW_RST_USART1 = VSF_HW_CLKRST_REGION(0x26, 4, 1) ,
  VSF_HW_RST_USART2 = VSF_HW_CLKRST_REGION(0x24, 17, 1) ,
  VSF_HW_RST_USART3 = VSF_HW_CLKRST_REGION(0x24, 18, 1) ,
  VSF_HW_RST_UART4 = VSF_HW_CLKRST_REGION(0x24, 19, 1) ,
  VSF_HW_RST_UART5 = VSF_HW_CLKRST_REGION(0x24, 20, 1) ,
  VSF_HW_RST_USART6 = VSF_HW_CLKRST_REGION(0x26, 5, 1) ,
  VSF_HW_RST_UART7 = VSF_HW_CLKRST_REGION(0x24, 30, 1) ,
  VSF_HW_RST_UART8 = VSF_HW_CLKRST_REGION(0x24, 31, 1) ,
  VSF_HW_RST_SDMMC1 = VSF_HW_CLKRST_REGION(0x1F, 16, 1) ,
  VSF_HW_RST_SDMMC2 = VSF_HW_CLKRST_REGION(0x21, 9, 1)
}
 
enum  vsf_hw_peripheral_en_t {
  VSF_HW_EN_GPIOA = VSF_HW_CLKRST_REGION(0x38, 0, 1) ,
  VSF_HW_EN_GPIOB = VSF_HW_CLKRST_REGION(0x38, 1, 1) ,
  VSF_HW_EN_GPIOC = VSF_HW_CLKRST_REGION(0x38, 2, 1) ,
  VSF_HW_EN_GPIOD = VSF_HW_CLKRST_REGION(0x38, 3, 1) ,
  VSF_HW_EN_GPIOE = VSF_HW_CLKRST_REGION(0x38, 4, 1) ,
  VSF_HW_EN_GPIOF = VSF_HW_CLKRST_REGION(0x38, 5, 1) ,
  VSF_HW_EN_GPIOG = VSF_HW_CLKRST_REGION(0x38, 6, 1) ,
  VSF_HW_EN_GPIOH = VSF_HW_CLKRST_REGION(0x38, 7, 1) ,
  VSF_HW_EN_GPIOI = VSF_HW_CLKRST_REGION(0x38, 8, 1) ,
  VSF_HW_EN_GPIOJ = VSF_HW_CLKRST_REGION(0x38, 9, 1) ,
  VSF_HW_EN_GPIOK = VSF_HW_CLKRST_REGION(0x38, 10, 1) ,
  VSF_HW_EN_USART1 = VSF_HW_CLKRST_REGION(0x3C, 4, 1) ,
  VSF_HW_EN_USART2 = VSF_HW_CLKRST_REGION(0x3A, 17, 1) ,
  VSF_HW_EN_USART3 = VSF_HW_CLKRST_REGION(0x3A, 18, 1) ,
  VSF_HW_EN_UART4 = VSF_HW_CLKRST_REGION(0x3A, 19, 1) ,
  VSF_HW_EN_UART5 = VSF_HW_CLKRST_REGION(0x3A, 20, 1) ,
  VSF_HW_EN_USART6 = VSF_HW_CLKRST_REGION(0x3C, 5, 1) ,
  VSF_HW_EN_UART7 = VSF_HW_CLKRST_REGION(0x3A, 30, 1) ,
  VSF_HW_EN_UART8 = VSF_HW_CLKRST_REGION(0x3A, 31, 1) ,
  VSF_HW_EN_SDMMC1 = VSF_HW_CLKRST_REGION(0x35, 16, 1) ,
  VSF_HW_EN_SDMMC2 = VSF_HW_CLKRST_REGION(0x37, 9, 1)
}
 

Functions

const vsf_hw_clk_tvsf_hw_clk_get_src (const vsf_hw_clk_t *clk)
 
uint32_t vsf_hw_clk_get_freq_hz (const vsf_hw_clk_t *clk)
 
void vsf_hw_clkrst_region_set (uint32_t region, uint_fast8_t value)
 
uint_fast8_t vsf_hw_clkrst_region_get (uint32_t region)
 
void vsf_hw_clkrst_region_set_bit (uint32_t region)
 
void vsf_hw_clkrst_region_clear_bit (uint32_t region)
 
uint_fast8_t vsf_hw_clkrst_region_get_bit (uint32_t region)
 

Variables

const vsf_hw_clk_t VSF_HW_CLK_HSI
 
const vsf_hw_clk_t VSF_HW_CLK_HSI_KER
 
const vsf_hw_clk_t VSF_HW_CLK_HSI48
 
const vsf_hw_clk_t VSF_HW_CLK_LSI
 
const vsf_hw_clk_t VSF_HW_CLK_CSI
 
const vsf_hw_clk_t VSF_HW_CLK_CSI_KER
 
const vsf_hw_clk_t VSF_HW_CLK_HSE
 
const vsf_hw_clk_t VSF_HW_CLK_LSE
 
const vsf_hw_clk_t VSF_HW_CLK_PLL1_P
 
const vsf_hw_clk_t VSF_HW_CLK_PLL1_Q
 
const vsf_hw_clk_t VSF_HW_CLK_PLL1_R
 
const vsf_hw_clk_t VSF_HW_CLK_PLL2_P
 
const vsf_hw_clk_t VSF_HW_CLK_PLL2_Q
 
const vsf_hw_clk_t VSF_HW_CLK_PLL2_R
 
const vsf_hw_clk_t VSF_HW_CLK_PLL3_P
 
const vsf_hw_clk_t VSF_HW_CLK_PLL3_Q
 
const vsf_hw_clk_t VSF_HW_CLK_PLL3_R
 
const vsf_hw_clk_t VSF_HW_CLK_SYS
 
const vsf_hw_clk_t VSF_HW_CLK_SYSD1
 
const vsf_hw_clk_t VSF_HW_CLK_HCLK
 
const vsf_hw_clk_t VSF_HW_CLK_PER
 
const vsf_hw_clk_t VSF_HW_CLK_PCLK1
 
const vsf_hw_clk_t VSF_HW_CLK_PCLK2
 
const vsf_hw_clk_t VSF_HW_CLK_PCLK3
 
const vsf_hw_clk_t VSF_HW_CLK_PCLK4
 
const vsf_hw_clk_t VSF_HW_CLK_USART16
 
const vsf_hw_clk_t VSF_HW_CLK_USART234578
 
const vsf_hw_clk_t VSF_HW_CLK_SDMMC
 

Macro Definition Documentation

◆ VSF_HW_CLKRST_REGION

#define VSF_HW_CLKRST_REGION (   __WORD_OFFSET,
  __BIT_OFFSET,
  __BIT_LENGTH 
)     (((__WORD_OFFSET) << 16) | ((__BIT_LENGTH) << 8) | ((__BIT_OFFSET) << 0))

◆ vsf_hw_peripheral_clk_set

#define vsf_hw_peripheral_clk_set   vsf_hw_clkrst_region_set

◆ vsf_hw_peripheral_clk_get

#define vsf_hw_peripheral_clk_get   vsf_hw_clkrst_region_get

◆ vsf_hw_peripheral_rst_set

#define vsf_hw_peripheral_rst_set   vsf_hw_clkrst_region_set_bit

◆ vsf_hw_peripheral_rst_clear

#define vsf_hw_peripheral_rst_clear   vsf_hw_clkrst_region_clear_bit

◆ vsf_hw_peripheral_rst_get

#define vsf_hw_peripheral_rst_get   vsf_hw_clkrst_region_get_bit

◆ vsf_hw_peripheral_enable

#define vsf_hw_peripheral_enable   vsf_hw_clkrst_region_set_bit

◆ vsf_hw_peripheral_disable

#define vsf_hw_peripheral_disable   vsf_hw_clkrst_region_clear_bit

◆ VSF_HW_CLK_USART1

#define VSF_HW_CLK_USART1   VSF_HW_CLK_USART16

◆ VSF_HW_CLK_USART2

#define VSF_HW_CLK_USART2   VSF_HW_CLK_USART234578

◆ VSF_HW_CLK_USART3

#define VSF_HW_CLK_USART3   VSF_HW_CLK_USART234578

◆ VSF_HW_CLK_UART4

#define VSF_HW_CLK_UART4   VSF_HW_CLK_USART234578

◆ VSF_HW_CLK_UART5

#define VSF_HW_CLK_UART5   VSF_HW_CLK_USART234578

◆ VSF_HW_CLK_USART6

#define VSF_HW_CLK_USART6   VSF_HW_CLK_USART16

◆ VSF_HW_CLK_UART7

#define VSF_HW_CLK_UART7   VSF_HW_CLK_USART234578

◆ VSF_HW_CLK_UART8

#define VSF_HW_CLK_UART8   VSF_HW_CLK_USART234578

◆ VSF_HW_CLK_SDMMC1

#define VSF_HW_CLK_SDMMC1   VSF_HW_CLK_SDMMC

◆ VSF_HW_CLK_SDMMC2

#define VSF_HW_CLK_SDMMC2   VSF_HW_CLK_SDMMC

Typedef Documentation

◆ vsf_hw_peripheral_rst_t

◆ vsf_hw_peripheral_en_t

◆ vsf_hw_clk_t

typedef struct vsf_hw_clk_t vsf_hw_clk_t

Enumeration Type Documentation

◆ vsf_hw_peripheral_rst_t

Enumerator
VSF_HW_RST_USART1 
VSF_HW_RST_USART2 
VSF_HW_RST_USART3 
VSF_HW_RST_UART4 
VSF_HW_RST_UART5 
VSF_HW_RST_USART6 
VSF_HW_RST_UART7 
VSF_HW_RST_UART8 
VSF_HW_RST_SDMMC1 
VSF_HW_RST_SDMMC2 

◆ vsf_hw_peripheral_en_t

Enumerator
VSF_HW_EN_GPIOA 
VSF_HW_EN_GPIOB 
VSF_HW_EN_GPIOC 
VSF_HW_EN_GPIOD 
VSF_HW_EN_GPIOE 
VSF_HW_EN_GPIOF 
VSF_HW_EN_GPIOG 
VSF_HW_EN_GPIOH 
VSF_HW_EN_GPIOI 
VSF_HW_EN_GPIOJ 
VSF_HW_EN_GPIOK 
VSF_HW_EN_USART1 
VSF_HW_EN_USART2 
VSF_HW_EN_USART3 
VSF_HW_EN_UART4 
VSF_HW_EN_UART5 
VSF_HW_EN_USART6 
VSF_HW_EN_UART7 
VSF_HW_EN_UART8 
VSF_HW_EN_SDMMC1 
VSF_HW_EN_SDMMC2 

Function Documentation

◆ vsf_hw_clk_get_src()

const vsf_hw_clk_t * vsf_hw_clk_get_src ( const vsf_hw_clk_t clk)
extern

◆ vsf_hw_clk_get_freq_hz()

uint32_t vsf_hw_clk_get_freq_hz ( const vsf_hw_clk_t clk)
extern

◆ vsf_hw_clkrst_region_set()

void vsf_hw_clkrst_region_set ( uint32_t  region,
uint_fast8_t  value 
)
extern

◆ vsf_hw_clkrst_region_get()

uint_fast8_t vsf_hw_clkrst_region_get ( uint32_t  region)
extern

◆ vsf_hw_clkrst_region_set_bit()

void vsf_hw_clkrst_region_set_bit ( uint32_t  region)
extern

◆ vsf_hw_clkrst_region_clear_bit()

void vsf_hw_clkrst_region_clear_bit ( uint32_t  region)
extern

◆ vsf_hw_clkrst_region_get_bit()

uint_fast8_t vsf_hw_clkrst_region_get_bit ( uint32_t  region)
extern

Variable Documentation

◆ VSF_HW_CLK_HSI

const vsf_hw_clk_t VSF_HW_CLK_HSI
extern

◆ VSF_HW_CLK_HSI_KER

const vsf_hw_clk_t VSF_HW_CLK_HSI_KER
extern

◆ VSF_HW_CLK_HSI48

const vsf_hw_clk_t VSF_HW_CLK_HSI48
extern

◆ VSF_HW_CLK_LSI

const vsf_hw_clk_t VSF_HW_CLK_LSI
extern

◆ VSF_HW_CLK_CSI

const vsf_hw_clk_t VSF_HW_CLK_CSI
extern

◆ VSF_HW_CLK_CSI_KER

const vsf_hw_clk_t VSF_HW_CLK_CSI_KER
extern

◆ VSF_HW_CLK_HSE

const vsf_hw_clk_t VSF_HW_CLK_HSE
extern

◆ VSF_HW_CLK_LSE

const vsf_hw_clk_t VSF_HW_CLK_LSE
extern

◆ VSF_HW_CLK_PLL1_P

const vsf_hw_clk_t VSF_HW_CLK_PLL1_P
extern

◆ VSF_HW_CLK_PLL1_Q

const vsf_hw_clk_t VSF_HW_CLK_PLL1_Q
extern

◆ VSF_HW_CLK_PLL1_R

const vsf_hw_clk_t VSF_HW_CLK_PLL1_R
extern

◆ VSF_HW_CLK_PLL2_P

const vsf_hw_clk_t VSF_HW_CLK_PLL2_P
extern

◆ VSF_HW_CLK_PLL2_Q

const vsf_hw_clk_t VSF_HW_CLK_PLL2_Q
extern

◆ VSF_HW_CLK_PLL2_R

const vsf_hw_clk_t VSF_HW_CLK_PLL2_R
extern

◆ VSF_HW_CLK_PLL3_P

const vsf_hw_clk_t VSF_HW_CLK_PLL3_P
extern

◆ VSF_HW_CLK_PLL3_Q

const vsf_hw_clk_t VSF_HW_CLK_PLL3_Q
extern

◆ VSF_HW_CLK_PLL3_R

const vsf_hw_clk_t VSF_HW_CLK_PLL3_R
extern

◆ VSF_HW_CLK_SYS

const vsf_hw_clk_t VSF_HW_CLK_SYS
extern

◆ VSF_HW_CLK_SYSD1

const vsf_hw_clk_t VSF_HW_CLK_SYSD1
extern

◆ VSF_HW_CLK_HCLK

const vsf_hw_clk_t VSF_HW_CLK_HCLK
extern

◆ VSF_HW_CLK_PER

const vsf_hw_clk_t VSF_HW_CLK_PER
extern

◆ VSF_HW_CLK_PCLK1

const vsf_hw_clk_t VSF_HW_CLK_PCLK1
extern

◆ VSF_HW_CLK_PCLK2

const vsf_hw_clk_t VSF_HW_CLK_PCLK2
extern

◆ VSF_HW_CLK_PCLK3

const vsf_hw_clk_t VSF_HW_CLK_PCLK3
extern

◆ VSF_HW_CLK_PCLK4

const vsf_hw_clk_t VSF_HW_CLK_PCLK4
extern

◆ VSF_HW_CLK_USART16

const vsf_hw_clk_t VSF_HW_CLK_USART16
extern

◆ VSF_HW_CLK_USART234578

const vsf_hw_clk_t VSF_HW_CLK_USART234578
extern

◆ VSF_HW_CLK_SDMMC

const vsf_hw_clk_t VSF_HW_CLK_SDMMC
extern