mbed-os/targets/TARGET_NUVOTON/TARGET_NANO100/device/StdDriver/nano100_fmc.h

202 lines
6.7 KiB
C

/**************************************************************************//**
* @file fmc.h
* @version V1.00
* $Revision: 5 $
* $Date: 15/06/12 2:11p $
* @brief Nano100B Series Flash Memory Controller Driver Header File
*
* @note
* Copyright (C) 2015 Nuvoton Technology Corp. All rights reserved.
*
******************************************************************************/
#ifndef __FMC_H__
#define __FMC_H__
#ifdef __cplusplus
extern "C"
{
#endif
/** @addtogroup NANO100_Device_Driver NANO100 Device Driver
@{
*/
/** @addtogroup NANO100_FMC_Driver FMC Driver
@{
*/
/** @addtogroup NANO100_FMC_EXPORTED_CONSTANTS FMC Exported Constants
@{
*/
/*---------------------------------------------------------------------------------------------------------*/
/* Define Base Address */
/*---------------------------------------------------------------------------------------------------------*/
#define FMC_APROM_BASE 0x00000000UL /*!< APROM Base Address */
#define FMC_APROM_END 0x0001EC00UL /*!< APROM End Address */
#define FMC_LDROM_BASE 0x00100000UL /*!< LDROM Base Address */
#define FMC_LDROM_END 0x00101000UL /*!< LDROM End Address */
#define FMC_CONFIG_BASE 0x00300000UL /*!< User Configuration Address */
#define FMC_FLASH_PAGE_SIZE 0x200 /*!< Flash Page Size (512 bytes) */
#define FMC_LDROM_SIZE 0x1000 /*!< LDROM Size (4 Kbytes) */
/*---------------------------------------------------------------------------------------------------------*/
/* ISPCMD constant definitions */
/*---------------------------------------------------------------------------------------------------------*/
#define FMC_ISPCMD_READ 0x00 /*!< ISP Command: Read flash word */
#define FMC_ISPCMD_PROGRAM 0x21 /*!< ISP Command: Write flash word */
#define FMC_ISPCMD_PAGE_ERASE 0x22 /*!< ISP Command: Page Erase Flash */
#define FMC_ISPCMD_READ_CID 0x0B /*!< ISP Command: Read Company ID */
#define FMC_ISPCMD_READ_PID 0x0C /*!< ISP Command: Read Product ID */
#define FMC_ISPCMD_READ_UID 0x04 /*!< ISP Command: Read Unique ID */
#define FMC_ISPCMD_VECMAP 0x2E /*!< ISP Command: Vector Page Remap */
#define IS_BOOT_FROM_APROM 0 /*!< Is booting from APROM */
#define IS_BOOT_FROM_LDROM 1 /*!< Is booting from LDROM */
/*@}*/ /* end of group NANO100_FMC_EXPORTED_CONSTANTS */
/** @addtogroup NANO100_FMC_EXPORTED_FUNCTIONS FMC Exported Functions
@{
*/
/*---------------------------------------------------------------------------------------------------------*/
/* Macros */
/*---------------------------------------------------------------------------------------------------------*/
/**
* @brief This macro selects booting from APROM.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_SET_APROM_BOOT() (FMC->ISPCON &= ~FMC_ISPCON_BS_Msk)
/**
* @brief This macro selects booting from LDROM.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_SET_LDROM_BOOT() (FMC->ISPCON |= FMC_ISPCON_BS_Msk)
/**
* @brief This macro enables APROM update function.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_ENABLE_AP_UPDATE() (FMC->ISPCON |= FMC_ISPCON_APUEN_Msk)
/**
* @brief This macro disables APROM update function.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_DISABLE_AP_UPDATE() (FMC->ISPCON &= ~FMC_ISPCON_APUEN_Msk)
/**
* @brief This macro enables User Configuration update function.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_ENABLE_CFG_UPDATE() (FMC->ISPCON |= FMC_ISPCON_CFGUEN_Msk)
/**
* @brief This macro disables User Configuration update function.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_DISABLE_CFG_UPDATE() (FMC->ISPCON &= ~FMC_ISPCON_CFGUEN_Msk)
/**
* @brief This macro enables LDROM update function.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_ENABLE_LD_UPDATE() (FMC->ISPCON |= FMC_ISPCON_LDUEN_Msk)
/**
* @brief This macro disables LDROM update function.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_DISABLE_LD_UPDATE() (FMC->ISPCON &= ~FMC_ISPCON_LDUEN_Msk)
/**
* @brief This macro enables ISP function.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_ENABLE_ISP() (FMC->ISPCON |= FMC_ISPCON_ISPEN_Msk)
/**
* @brief This macro disables ISP function.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_DISABLE_ISP() (FMC->ISPCON &= ~FMC_ISPCON_ISPEN_Msk)
/**
* @brief This macro gets ISP fail flag value.
* @param None
* @return ISP fail flag value.
* \hideinitializer
*/
#define FMC_GET_FAIL_FLAG() ((FMC->ISPCON & FMC_ISPCON_ISPFF_Msk) ? 1 : 0)
/**
* @brief This macro clears ISP fail flag.
* @param None
* @return None
* \hideinitializer
*/
#define FMC_CLR_FAIL_FLAG() (FMC->ISPCON |= FMC_ISPCON_ISPFF_Msk)
/*---------------------------------------------------------------------------------------------------------*/
/* Functions */
/*---------------------------------------------------------------------------------------------------------*/
extern void FMC_Close(void);
extern int32_t FMC_Erase(uint32_t u32PageAddr);
extern int32_t FMC_GetBootSource(void);
extern void FMC_Open(void);
extern uint32_t FMC_Read(uint32_t u32Addr);
extern uint32_t FMC_ReadCID(void);
extern uint32_t FMC_ReadPID(void);
extern uint32_t FMC_ReadUCID(uint32_t u32Index);
extern uint32_t FMC_ReadUID(uint32_t u32Index);
extern uint32_t FMC_ReadDataFlashBaseAddr(void);
extern void FMC_SetVectorPageAddr(uint32_t u32PageAddr);
extern uint32_t FMC_GetVectorPageAddr(void);
extern void FMC_Write(uint32_t u32Addr, uint32_t u32Data);
extern int32_t FMC_ReadConfig(uint32_t *u32Config, uint32_t u32Count);
extern int32_t FMC_WriteConfig(uint32_t *u32Config, uint32_t u32Count);
/*@}*/ /* end of group NANO100_FMC_EXPORTED_FUNCTIONS */
/*@}*/ /* end of group NANO100_FMC_Driver */
/*@}*/ /* end of group NANO100_Device_Driver */
#ifdef __cplusplus
}
#endif
#endif // __FMC_H__
/*** (C) COPYRIGHT 2015 Nuvoton Technology Corp. ***/