stm32f10x_flash.c

stm32f10xx的中文译文例程

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

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

/* 自用类型 -----------------------------------------------------------*/
/* 自用定义 ------------------------------------------------------------*/
/* Flash Access Control Register bits */
#define ACR_LATENCY_Mask         ((u32)0x00000038)
#define ACR_HLFCYA_Mask          ((u32)0xFFFFFFF7)
#define ACR_PRFTBE_Mask          ((u32)0xFFFFFFEF)

#ifdef _FLASH_PROG
/* Flash Access Control Register bits */
#define ACR_PRFTBS_Mask          ((u32)0x00000020) 

/* Flash Control Register bits */
#define CR_PG_Set                ((u32)0x00000001)
#define CR_PG_Reset              ((u32)0x00001FFE) 

#define CR_PER_Set               ((u32)0x00000002)
#define CR_PER_Reset             ((u32)0x00001FFD)

#define CR_MER_Set               ((u32)0x00000004)
#define CR_MER_Reset             ((u32)0x00001FFB)

#define CR_OPTPG_Set             ((u32)0x00000010)
#define CR_OPTPG_Reset           ((u32)0x00001FEF)

#define CR_OPTER_Set             ((u32)0x00000020)
#define CR_OPTER_Reset           ((u32)0x00001FDF)

#define CR_STRT_Set              ((u32)0x00000040)
                    		 
#define CR_LOCK_Set              ((u32)0x00000080)

/* FLASH Mask */
#define RDPRT_Mask               ((u32)0x00000002)
#define WRP0_Mask                ((u32)0x000000FF)
#define WRP1_Mask                ((u32)0x0000FF00)
#define WRP2_Mask                ((u32)0x00FF0000)
#define WRP3_Mask                ((u32)0xFF000000)

/* FLASH Keys */
#define RDP_Key                  ((u16)0x00A5)
#define FLASH_KEY1               ((u32)0x45670123)
#define FLASH_KEY2               ((u32)0xCDEF89AB)

/* Delay definition */   
#define EraseTimeout             ((u32)0x00000FFF)
#define ProgramTimeout           ((u32)0x0000000F)
#endif

/* 自用宏 -------------------------------------------------------------*/
/* 自用变量 ---------------------------------------------------------*/
/* 自用函数原型-----------------------------------------------*/
#ifdef _FLASH_PROG
static void delay(void);
#endif

/* 自用函数 ---------------------------------------------------------*/
/*******************************************************************************
* 函数名称: FLASH_SetLatency
* 功能描述: 设置代码延时值.
* 输入参数: FLASH_Latency指定了FLASH延时值。
*                    这个参数可以是下面的值之一:
*                       - FLASH_Latency_0: 0个延时周期
*                       - FLASH_Latency_1: 1个延时周期
*                       - FLASH_Latency_2: 2个延时周期
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void FLASH_SetLatency(u32 FLASH_Latency)
{
  /* Check the parameters [检查参数]*/
  assert_param(IS_FLASH_LATENCY(FLASH_Latency));
  
  /* Sets the Latency value [设置延时值]*/
  FLASH->ACR &= ACR_LATENCY_Mask;
  FLASH->ACR |= FLASH_Latency;
}

/*******************************************************************************
* 函数名称: FLASH_HalfCycleAccessCmd
* 功能描述: 使能（或禁能）半周期Flash访问
* 输入参数: FLASH_HalfCycleAccess：FLASH半周期模式。
*                    这个参数可以是下面的值之一:
*                       - FLASH_HalfCycleAccess_Enable: 使能半周期访问
*                       - FLASH_HalfCycleAccess_Disable: 禁能半周期访问
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void FLASH_HalfCycleAccessCmd(u32 FLASH_HalfCycleAccess)
{
  /* Check the parameters [检查参数]*/
  assert_param(IS_FLASH_HALFCYCLEACCESS_STATE(FLASH_HalfCycleAccess));
  
  /* Enable or disable the Half cycle access [使能或者禁止半周期访问]*/
  FLASH->ACR &= ACR_HLFCYA_Mask;
  FLASH->ACR |= FLASH_HalfCycleAccess;
}

/*******************************************************************************
* 函数名称: FLASH_PrefetchBufferCmd
* 功能描述: 使能（或禁能）预取缓冲区
* 输入参数: FLASH_PrefetchBuffer：领取缓冲区状态.
*                    这个参数可以是下面的值之一:
*                       - FLASH_PrefetchBuffer_Enable: FLASH 预取缓冲区使能
*                       - FLASH_PrefetchBuffer_Disable: FLASH 预取缓冲区禁能
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void FLASH_PrefetchBufferCmd(u32 FLASH_PrefetchBuffer)
{
  /* Check the parameters [检查参数]*/
  assert_param(IS_FLASH_PREFETCHBUFFER_STATE(FLASH_PrefetchBuffer));
  
  /* Enable or disable the Prefetch Buffer [使能或者禁能预取缓冲区]*/
  FLASH->ACR &= ACR_PRFTBE_Mask;
  FLASH->ACR |= FLASH_PrefetchBuffer;
}

#ifdef _FLASH_PROG
/*******************************************************************************
* 函数名称: FLASH_Unlock
* 功能描述: 解锁FLASH程序擦除控制器.
* 输入参数: 无
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void FLASH_Unlock(void)
{
  /* Authorize the FPEC Access [授权FPEC存取]*/
  FLASH->KEYR = FLASH_KEY1;
  FLASH->KEYR = FLASH_KEY2;
}

/*******************************************************************************
* 函数名称: FLASH_Lock
* 功能描述: 锁定FLASH程序擦除控制器.
* 输入参数: 无
* 输出参数: 无
* 返回参数: 无
*******************************************************************************/
void FLASH_Lock(void)
{
  /* Set the Lock Bit to lock the FPEC and the FCR [置位锁定位来锁定FPEC和FCR]*/
  FLASH->CR |= CR_LOCK_Set;
}

/*******************************************************************************
* 函数名称: FLASH_ErasePage
* 功能描述: 擦除一个FLASH页.
* 输入参数: FLASH_Page：需要擦除的页.
* 输出参数: 无
* 返回参数: FLASH 状态: 返回值可以是: FLASH_BUSY,
*                  FLASH_ERROR_PG, FLASH_ERROR_WRP, FLASH_COMPLETE or 
*                  FLASH_TIMEOUT.
*******************************************************************************/
FLASH_Status FLASH_ErasePage(u32 Page_Address)
{
  FLASH_Status status = FLASH_COMPLETE;

  /* Check the parameters [检查参数]*/
  assert_param(IS_FLASH_ADDRESS(Page_Address));

  /* Wait for last operation to be completed [等待最后一个操作完成]*/
  status = FLASH_WaitForLastOperation(EraseTimeout);
  
  if(status == FLASH_COMPLETE)
  { 
    /* if the previous operation is completed, proceed to erase the page [如果前一个操作已经完成，]*/
    FLASH->CR|= CR_PER_Set;
    FLASH->AR = Page_Address; 
    FLASH->CR|= CR_STRT_Set;
    
    /* Wait for last operation to be completed [等待最后一个操作完成]*/
    status = FLASH_WaitForLastOperation(EraseTimeout);

    if(status != FLASH_BUSY)
    {
      /* if the erase operation is completed, disable the PER Bit [如果擦除操作完成，禁止PER位]*/
      FLASH->CR &= CR_PER_Reset;
    }
  }
  /* Return the Erase Status [返回擦除状态]*/
  return status;
}

/*******************************************************************************
* 函数名称: FLASH_EraseAllPages
* 功能描述: 擦除所有的FLASH页.
* 输入参数: 无
* 输出参数: 无
* 返回参数: FLASH 状态: 返回值可以是: FLASH_BUSY,
*                  FLASH_ERROR_PG, FLASH_ERROR_WRP, FLASH_COMPLETE or 
*                  FLASH_TIMEOUT.
*******************************************************************************/
FLASH_Status FLASH_EraseAllPages(void)
{
  FLASH_Status status = FLASH_COMPLETE;

  /* Wait for last operation to be completed [等待最后一个操作完成]*/
  status = FLASH_WaitForLastOperation(EraseTimeout);
  
  if(status == FLASH_COMPLETE)
  {
    /* if the previous operation is completed, proceed to erase all pages [如果前一个操作已经完成，擦除所有的页]*/
     FLASH->CR |= CR_MER_Set;
     FLASH->CR |= CR_STRT_Set;
    
    /* Wait for last operation to be completed [等待最后一个操作完成]*/
    status = FLASH_WaitForLastOperation(EraseTimeout);

    if(status != FLASH_BUSY)
    {
      /* if the erase operation is completed, disable the MER Bit [如果擦除操作完成，禁止MER位]*/
      FLASH->CR &= CR_MER_Reset;
    }
  }    
  /* Return the Erase Status [返回擦除状态]*/
  return status;
}

/*******************************************************************************
* 函数名称: FLASH_EraseOptionBytes
* 功能描述: 擦除FLASH选项字节.
* 输入参数: 无
* 输出参数: 无
* 返回参数: FLASH 状态: 返回值可以是: FLASH_BUSY,
*                  FLASH_ERROR_PG, FLASH_ERROR_WRP, FLASH_COMPLETE or 
*                  FLASH_TIMEOUT.
*******************************************************************************/
FLASH_Status FLASH_EraseOptionBytes(void)
{
  FLASH_Status status = FLASH_COMPLETE;
  
  /* Wait for last operation to be completed [等待最后一个操作完成]*/
  status = FLASH_WaitForLastOperation(EraseTimeout);

  if(status == FLASH_COMPLETE)
  {
    /* Authorize the small information block programming [授权小信息块编程]*/
    FLASH->OPTKEYR = FLASH_KEY1;
    FLASH->OPTKEYR = FLASH_KEY2;
    
    /* if the previous operation is completed, proceed to erase the option bytes [如果前一个操作完成，擦除选项字节]*/
    FLASH->CR |= CR_OPTER_Set;
    FLASH->CR |= CR_STRT_Set;

    /* Wait for last operation to be completed [等待最后一个操作完成]*/
    status = FLASH_WaitForLastOperation(EraseTimeout);
    
    if(status == FLASH_COMPLETE)
    {
      /* if the erase operation is completed, disable the OPTER Bit [如果擦除操作完成，禁止OPTER位]*/
      FLASH->CR &= CR_OPTER_Reset;
       
      /* Enable the Option Bytes Programming operation [使能字节编程操作选项]*/
      FLASH->CR |= CR_OPTPG_Set;

      /* Enable the readout access [使能读出访问]*/
      OB->RDP= RDP_Key; 

      /* Wait for last operation to be completed [等待最后一个操作完成]*/
      status = FLASH_WaitForLastOperation(ProgramTimeout);
 
      if(status != FLASH_BUSY)
      {
        /* if the program operation is completed, disable the OPTPG Bit [如果编程操作完成，禁止OPTPG位]*/
        FLASH->CR &= CR_OPTPG_Reset;
      }
    }
    else
    {
      if (status != FLASH_BUSY)
      {
        /* Disable the OPTPG Bit [禁止OPTPG位]*/
        FLASH->CR &= CR_OPTPG_Reset;
      }
    }  
  }
  /* Return the erase status [返回擦除状态]*/
  return status;
}

/*******************************************************************************
* 函数名称: FLASH_ProgramWord
* 功能描述: 在特定地址编程一个字.
* 输入参数: (1)Address：将要编程的地址.