stm32f10x_rcc.c

stm32f10xx的中文译文例程

/******************** (C) COPYRIGHT 2008 STMicroelectronics ********************
* 文件名称: stm32f10x_rcc.c
* 程序作者: MCD Application Team
* 程序版本: V2.0.2
* 编制日期: 07/11/2008
* 功能描述: 这个文件提供了所有RCC的固件函数.
* 本文汉化: 孙可 2008.08.15
********************************************************************************
* 目前的固件的目的是为客户提供关于他们的产品的编码信息以便于节省他们时间。
* 结果, 意法半导体将不会为此承担任何直接，间接或相应的损害赔偿方面的任何索赔要求，
* 例如固件或使用所作的客户编码中他涉嫌包含与他们的相关产品的信息。
*******************************************************************************/

/* 包涵的文件 ------------------------------------------------------------------*/
#include "stm32f10x_rcc.h"

/* 自用类型 -----------------------------------------------------------*/
/* 自用定义 ------------------------------------------------------------*/
/* ------------ RCC registers bit address in the alias region ----------- */
#define RCC_OFFSET                (RCC_BASE - PERIPH_BASE)

/* --- CR 寄存器 ---*/
/* Alias word address of HSION bit */
#define CR_OFFSET                 (RCC_OFFSET + 0x00)
#define HSION_BitNumber           0x00
#define CR_HSION_BB               (PERIPH_BB_BASE + (CR_OFFSET * 32) + (HSION_BitNumber * 4))

/* Alias word address of PLLON bit */
#define PLLON_BitNumber           0x18
#define CR_PLLON_BB               (PERIPH_BB_BASE + (CR_OFFSET * 32) + (PLLON_BitNumber * 4))

/* Alias word address of CSSON bit */
#define CSSON_BitNumber           0x13
#define CR_CSSON_BB               (PERIPH_BB_BASE + (CR_OFFSET * 32) + (CSSON_BitNumber * 4))

/* --- CFGR 寄存器 ---*/
/* Alias word address of USBPRE bit */
#define CFGR_OFFSET               (RCC_OFFSET + 0x04)
#define USBPRE_BitNumber          0x16
#define CFGR_USBPRE_BB            (PERIPH_BB_BASE + (CFGR_OFFSET * 32) + (USBPRE_BitNumber * 4))

/* --- BDCR 寄存器 ---*/
/* Alias word address of RTCEN bit */
#define BDCR_OFFSET               (RCC_OFFSET + 0x20)
#define RTCEN_BitNumber           0x0F
#define BDCR_RTCEN_BB             (PERIPH_BB_BASE + (BDCR_OFFSET * 32) + (RTCEN_BitNumber * 4))

/* Alias word address of BDRST bit */
#define BDRST_BitNumber           0x10
#define BDCR_BDRST_BB             (PERIPH_BB_BASE + (BDCR_OFFSET * 32) + (BDRST_BitNumber * 4))

/* --- CSR 寄存器 ---*/
/* Alias word address of LSION bit */
#define CSR_OFFSET                (RCC_OFFSET + 0x24)
#define LSION_BitNumber           0x00
#define CSR_LSION_BB              (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (LSION_BitNumber * 4))

/* ---------------------- RCC 寄存器s bit mask ------------------------ */
/* CR register bit mask */
#define CR_HSEBYP_Reset           ((u32)0xFFFBFFFF)
#define CR_HSEBYP_Set             ((u32)0x00040000)
#define CR_HSEON_Reset            ((u32)0xFFFEFFFF)
#define CR_HSEON_Set              ((u32)0x00010000)
#define CR_HSITRIM_Mask           ((u32)0xFFFFFF07)

/* CFGR register bit mask */
#define CFGR_PLL_Mask             ((u32)0xFFC0FFFF)
#define CFGR_PLLMull_Mask         ((u32)0x003C0000)
#define CFGR_PLLSRC_Mask          ((u32)0x00010000)
#define CFGR_PLLXTPRE_Mask        ((u32)0x00020000)
#define CFGR_SWS_Mask             ((u32)0x0000000C)
#define CFGR_SW_Mask              ((u32)0xFFFFFFFC)
#define CFGR_HPRE_Reset_Mask      ((u32)0xFFFFFF0F)
#define CFGR_HPRE_Set_Mask        ((u32)0x000000F0)
#define CFGR_PPRE1_Reset_Mask     ((u32)0xFFFFF8FF)
#define CFGR_PPRE1_Set_Mask       ((u32)0x00000700)
#define CFGR_PPRE2_Reset_Mask     ((u32)0xFFFFC7FF)
#define CFGR_PPRE2_Set_Mask       ((u32)0x00003800)
#define CFGR_ADCPRE_Reset_Mask    ((u32)0xFFFF3FFF)
#define CFGR_ADCPRE_Set_Mask      ((u32)0x0000C000)

/* CSR register bit mask */
#define CSR_RMVF_Set              ((u32)0x01000000)

/* RCC Flag Mask */
#define FLAG_Mask                 ((u8)0x1F)

/* Typical Value of the HSI in Hz */
#define HSI_Value                 ((u32)8000000)

/* CIR register byte 2 (Bits[15:8]) base address */
#define CIR_BYTE2_ADDRESS         ((u32)0x40021009)
/* CIR register byte 3 (Bits[23:16]) base address */
#define CIR_BYTE3_ADDRESS         ((u32)0x4002100A)

/* CFGR register byte 4 (Bits[31:24]) base address */
#define CFGR_BYTE4_ADDRESS        ((u32)0x40021007)

/* BDCR register base address */
#define BDCR_ADDRESS              (PERIPH_BASE + BDCR_OFFSET)

/* Time out for HSE start up */
#define HSEStartUp_TimeOut        ((u16)0x01FF)

/* 自用宏 -------------------------------------------------------------*/
/* 自用变量 ---------------------------------------------------------*/
static uc8 APBAHBPrescTable[16] = {0, 0, 0, 0, 1, 2, 3, 4, 1, 2, 3, 4, 6, 7, 8, 9};
static uc8 ADCPrescTable[4] = {2, 4, 6, 8};

static volatile FlagStatus HSEStatus;
static vu32 StartUpCounter = 0;

/* 自用函数原型 -----------------------------------------------*/
/* 自用函数 ---------------------------------------------------------*/

/*******************************************************************************
* 函数名称: RCC_DeInit
* 功能描述: 复位RCC外围设备寄存器到默认复位值.
* 输入参数: 无
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void RCC_DeInit(void)
{
  /* Set HSION bit [置位HSION]*/
  RCC->CR |= (u32)0x00000001;

  /* Reset SW[1:0], HPRE[3:0], PPRE1[2:0], PPRE2[2:0], ADCPRE[1:0] and MCO[2:0] bits 
  *      [复位SW[1:0], HPRE[3:0], PPRE1[2:0], PPRE2[2:0], ADCPRE[1:0] 和 MCO[2:0]位]*/
  RCC->CFGR &= (u32)0xF8FF0000;
  
  /* Reset HSEON, CSSON and PLLON bits [复位HSEON, CSSON 和 PLLON位]*/
  RCC->CR &= (u32)0xFEF6FFFF;

  /* Reset HSEBYP bit [复位HSEBYP 位]*/
  RCC->CR &= (u32)0xFFFBFFFF;

  /* Reset PLLSRC, PLLXTPRE, PLLMUL[3:0] and USBPRE bits [复位PLLSRC, PLLXTPRE, PLLMUL[3:0]和USBPRE 位]*/
  RCC->CFGR &= (u32)0xFF80FFFF;

  /* Disable all interrupts [禁止所有中断]*/
  RCC->CIR = 0x00000000;
}

/*******************************************************************************
* 函数名称: RCC_HSEConfig
* 功能描述: 配置外部高速振荡器(HSE)
*                  HSE can not be stopped if it is used directly or through the 
*                  PLL as system clock[HSE如果直接或者通过PLL当作系统时钟的时候是不能被停下来的].
* 输入参数: RCC_HSE:HSE的新状态.
*                    这个参数可以是下面的值之一:
*                       - RCC_HSE_OFF: HSE oscillator OFF[HSE振荡器关闭]
*                       - RCC_HSE_ON: HSE oscillator ON[HSE振荡器开启]
*                       - RCC_HSE_Bypass: HSE oscillator bypassed with external
*                         clock[伴随外部时钟的HSE振荡器]
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void RCC_HSEConfig(u32 RCC_HSE)
{
  /* Check the parameters [检查参数]*/
  assert_param(IS_RCC_HSE(RCC_HSE));

  /* Reset HSEON and HSEBYP bits before configuring the HSE [在配置HSE之前复位 HSEON和HSEBYP位]*/
  /* Reset HSEON bit [复位HSEON 位]*/
  RCC->CR &= CR_HSEON_Reset;

  /* Reset HSEBYP bit [复位HSEBYP 位]*/
  RCC->CR &= CR_HSEBYP_Reset;

  /* Configure HSE (RCC_HSE_OFF is already covered by the code section above) [配置HSE（RCC_HSE_OFF已经被部分代码上隐藏）]*/
  switch(RCC_HSE)
  {
    case RCC_HSE_ON:
      /* Set HSEON bit [置位HSEON]*/
      RCC->CR |= CR_HSEON_Set;
      break;
      
    case RCC_HSE_Bypass:
      /* Set HSEBYP and HSEON bits [置位HSEBYP和HSEON]*/
      RCC->CR |= CR_HSEBYP_Set | CR_HSEON_Set;
      break;            
      
    default:
      break;      
  }
}

/*******************************************************************************
* 函数名称: RCC_WaitForHSEStartUp
* 功能描述: 等待HSE启动.
* 输入参数: 无
* 输出参数: 无
* 返回参数: 一个ErrorStatus枚举值:SUCCESS:HSE振荡器稳定并且可以使用.
*                                 ERROR:HSE振荡器没有准备好.
*******************************************************************************/
ErrorStatus RCC_WaitForHSEStartUp(void)
{
  ErrorStatus status = ERROR;

  /* Wait till HSE is ready and if Time out is reached exit [等待HSE准备好,或超时时间到来]*/
  do
  {
    HSEStatus = RCC_GetFlagStatus(RCC_FLAG_HSERDY);
    StartUpCounter++;  
  } while((HSEStatus == RESET) && (StartUpCounter != HSEStartUp_TimeOut));


  if (RCC_GetFlagStatus(RCC_FLAG_HSERDY) != RESET)
  {
    status = SUCCESS;
  }
  else
  {
    status = ERROR;
  }  

  return (status);
}

/*******************************************************************************
* 函数名称: RCC_AdjustHSICalibrationValue
* 功能描述: 校正内部高速振荡器(HSI)标度值.
* 输入参数: HSICalibrationValue:校正标度值，这个参数一定是在0到0x1F之间的值.
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void RCC_AdjustHSICalibrationValue(u8 HSICalibrationValue)
{
  u32 tmpreg = 0;

  /* Check the parameters [检查参数]*/
  assert_param(IS_RCC_CALIBRATION_VALUE(HSICalibrationValue));

  tmpreg = RCC->CR;

  /* Clear HSITRIM[4:0] bits [清HSITRIM[4:0]位]*/
  tmpreg &= CR_HSITRIM_Mask;

  /* Set the HSITRIM[4:0] bits according to HSICalibrationValue value [依照HSICalibrationValue的值设置HSITRIM[4:0]位]*/
  tmpreg |= (u32)HSICalibrationValue << 3;

  /* Store the new value [保存新的值]*/
  RCC->CR = tmpreg;
}

/*******************************************************************************
* 函数名称: RCC_HSICmd
* 功能描述: 使能内部高速振荡器(HIS).
*                  [HSI如果直接或者通过PLL当作系统时钟的时候是不能被停下来的]
* 输入参数: NewStateHSI的新状态.这个参数可以是:ENABLE或DISABLE.
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void RCC_HSICmd(FunctionalState NewState)
{
  /* Check the parameters [检查参数]*/
  assert_param(IS_FUNCTIONAL_STATE(NewState));

  *(vu32 *) CR_HSION_BB = (u32)NewState;
}

/*******************************************************************************
* 函数名称: RCC_PLLConfig
* 功能描述: 配置PLL时钟源和乘法因子.
*                  This function must be used only when the PLL is disabled.
* 输入参数: (1)RCC_PLLSource:PLL进入时钟源.
*                    这个参数可以是下面的值之一:
*                       - RCC_PLLSource_HSI_Div2: PLL时钟输入等于HIS时钟二分频
*                       - RCC_PLLSource_HSE_Div1: PLL时钟输入等于HIS时钟
*                       - RCC_PLLSource_HSE_Div2: PLL时钟输入等于HIS时钟二分频
*           (2)RCC_PLLMul:PLL乘法因子.
*                    这个参数可以是 RCC_PLLMul_x x可以取:[2,16]
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void RCC_PLLConfig(u32 RCC_PLLSource, u32 RCC_PLLMul)
{
  u32 tmpreg = 0;

  /* Check the parameters [检查参数]*/
  assert_param(IS_RCC_PLL_SOURCE(RCC_PLLSource));
  assert_param(IS_RCC_PLL_MUL(RCC_PLLMul));

  tmpreg = RCC->CFGR;

  /* Clear PLLSRC, PLLXTPRE and PLLMUL[3:0] bits [清PLLSRC, PLLXTPRE和PLLMUL[3:0]位]*/
  tmpreg &= CFGR_PLL_Mask;

  /* Set the PLL configuration bits [设置PLL 配置位]*/
  tmpreg |= RCC_PLLSource | RCC_PLLMul;

  /* Store the new value [保存新的值]*/
  RCC->CFGR = tmpreg;
}

/*******************************************************************************
* 函数名称: RCC_PLLCmd
* 功能描述: 使能或关闭PLL。
*                  如果PLL被用作系统时钟，它是不可以禁止的。
* 输入参数: NewState:PLL的新状态.这个参数可以是:ENABLE或DISABLE
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void RCC_PLLCmd(FunctionalState NewState)
{
  /* Check the parameters [检查参数]*/
  assert_param(IS_FUNCTIONAL_STATE(NewState));

  *(vu32 *) CR_PLLON_BB = (u32)NewState;
}

/*******************************************************************************
* 函数名称: RCC_SYSCLKConfig
* 功能描述: 配置系统时钟(SYSCLK).
* 输入参数: RCC_SYSCLKSource:作为系统时钟的时钟源.
*                 这个参数可以是下面的值之一:
*                       - RCC_SYSCLKSource_HSI: 选择HSI作为系统时钟
*                       - RCC_SYSCLKSource_HSE: 选择HSE作为系统时钟.
*                       - RCC_SYSCLKSource_PLLCLK: 选择PLL作为系统时钟.
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void RCC_SYSCLKConfig(u32 RCC_SYSCLKSource)
{
  u32 tmpreg = 0;

  /* Check the parameters [检查参数]*/
  assert_param(IS_RCC_SYSCLK_SOURCE(RCC_SYSCLKSource));

  tmpreg = RCC->CFGR;

  /* Clear SW[1:0] bits [清SW[1:0]位]*/
  tmpreg &= CFGR_SW_Mask;

  /* Set SW[1:0] bits according to RCC_SYSCLKSource value [依照RCC_SYSCLKSource的值设置SW[1:0]位]*/
  tmpreg |= RCC_SYSCLKSource;

  /* Store the new value [保存新的值]*/
  RCC->CFGR = tmpreg;
}

/*******************************************************************************
* 函数名称: RCC_GetSYSCLKSource
* 功能描述: 返回用作系统时钟的时钟源.
* 输入参数: 无
* 输出参数: 无
* 返回参数: 时钟源作为系统时钟使用. 
*              返回值可以是: -0x00:使用HSI作为系统时钟
*                            -0x04:使用HSE作为系统时钟
*                            -0x08:使用PLL作为系统时钟.
*******************************************************************************/
u8 RCC_GetSYSCLKSource(void)
{
  return ((u8)(RCC->CFGR & CFGR_SWS_Mask));
}