NANO103 BSP V3.01.004
The Board Support Package for Nano103 Series
fmc.h
Go to the documentation of this file.
1/**************************************************************************/
13#ifndef __FMC_H__
14#define __FMC_H__
15
16#ifdef __cplusplus
17extern "C"
18{
19#endif
20
35/*---------------------------------------------------------------------------------------------------------*/
36/* Define Base Address */
37/*---------------------------------------------------------------------------------------------------------*/
38#define FMC_APROM_BASE 0x00000000UL
39#define FMC_APROM_END 0x00010000UL
40#define FMC_LDROM_BASE 0x00100000UL
41#define FMC_LDROM_END 0x00101200UL
42#define FMC_CONFIG_BASE 0x00300000UL
43#define FMC_KPROM_BASE 0x00301000UL
45#define FMC_FLASH_PAGE_SIZE 0x200
46#define FMC_PAGE_ADDR_MASK 0xFFFFFE00UL
48#define FMC_LDROM_SIZE 0x1200
51/*---------------------------------------------------------------------------------------------------------*/
52/* ISPCMD constant definitions */
53/*---------------------------------------------------------------------------------------------------------*/
54#define FMC_ISPCMD_READ 0x00
55#define FMC_ISPCMD_PROGRAM 0x21
56#define FMC_ISPCMD_PAGE_ERASE 0x22
57#define FMC_ISPCMD_READ_CID 0x0B
58#define FMC_ISPCMD_READ_PID 0x0C
59#define FMC_ISPCMD_READ_UID 0x04
60#define FMC_ISPCMD_RUN_CKS 0x2D
61#define FMC_ISPCMD_READ_CKS 0x0D
62#define FMC_ISPCMD_RUN_ALL1 0x28
63#define FMC_ISPCMD_READ_ALL1 0x08
64#define FMC_ISPCMD_VECMAP 0x2E
66#define IS_BOOT_FROM_APROM 0
67#define IS_BOOT_FROM_LDROM 1
69#define READ_ALLONE_YES 0xA11FFFFF
70#define READ_ALLONE_NOT 0xA1100000
71#define READ_ALLONE_CMD_FAIL 0xFFFFFFFF
73/*---------------------------------------------------------------------------------------------------------*/
74/* FMC Time-out Handler Constant Definitions */
75/*---------------------------------------------------------------------------------------------------------*/
76#define FMC_TIMEOUT_READ ((SystemCoreClock/10)*2)
77#define FMC_TIMEOUT_WRITE ((SystemCoreClock/10)*2)
78#define FMC_TIMEOUT_ERASE ((SystemCoreClock/10)*4)
79#define FMC_TIMEOUT_CHKSUM (SystemCoreClock*2)
80#define FMC_TIMEOUT_CHKALLONE (SystemCoreClock*2) /* end of group NANO103_FMC_EXPORTED_CONSTANTS */
83
84
89/*---------------------------------------------------------------------------------------------------------*/
90/* Macros */
91/*---------------------------------------------------------------------------------------------------------*/
92
93#define FMC_SET_APROM_BOOT() (FMC->ISPCTL &= ~FMC_ISPCTL_BS_Msk)
94#define FMC_SET_LDROM_BOOT() (FMC->ISPCTL |= FMC_ISPCTL_BS_Msk)
95#define FMC_ENABLE_AP_UPDATE() (FMC->ISPCTL |= FMC_ISPCTL_APUEN_Msk)
96#define FMC_DISABLE_AP_UPDATE() (FMC->ISPCTL &= ~FMC_ISPCTL_APUEN_Msk)
97#define FMC_ENABLE_CFG_UPDATE() (FMC->ISPCTL |= FMC_ISPCTL_CFGUEN_Msk)
98#define FMC_DISABLE_CFG_UPDATE() (FMC->ISPCTL &= ~FMC_ISPCTL_CFGUEN_Msk)
99#define FMC_ENABLE_LD_UPDATE() (FMC->ISPCTL |= FMC_ISPCTL_LDUEN_Msk)
100#define FMC_DISABLE_LD_UPDATE() (FMC->ISPCTL &= ~FMC_ISPCTL_LDUEN_Msk)
101#define FMC_DISABLE_ISP() (FMC->ISPCTL &= ~FMC_ISPCTL_ISPEN_Msk)
102#define FMC_ENABLE_ISP() (FMC->ISPCTL |= FMC_ISPCTL_ISPEN_Msk)
103#define FMC_GET_FAIL_FLAG() ((FMC->ISPCTL & FMC_ISPCTL_ISPFF_Msk) ? 1 : 0)
104#define FMC_CLR_FAIL_FLAG() (FMC->ISPCTL |= FMC_ISPCTL_ISPFF_Msk)
106/*---------------------------------------------------------------------------------------------------------*/
107/* Functions */
108/*---------------------------------------------------------------------------------------------------------*/
109
110extern void FMC_Close(void);
111extern int32_t FMC_Erase(uint32_t u32PageAddr);
112extern int32_t FMC_GetBootSource(void);
113extern void FMC_Open(void);
114extern uint32_t FMC_Read(uint32_t u32Addr);
115extern uint32_t FMC_ReadCID(void);
116extern uint32_t FMC_ReadPID(void);
117extern uint32_t FMC_ReadUCID(uint32_t u32Index);
118extern uint32_t FMC_ReadUID(uint32_t u32Index);
119extern uint32_t FMC_ReadDataFlashBaseAddr(void);
120extern void FMC_SetVectorPageAddr(uint32_t u32PageAddr);
121extern uint32_t FMC_GetVectorPageAddr(void);
122extern int32_t FMC_Write(uint32_t u32Addr, uint32_t u32Data);
123extern int32_t FMC_ReadConfig(uint32_t *u32Config, uint32_t u32Count);
124extern int32_t FMC_WriteConfig(uint32_t *u32Config, uint32_t u32Count);
125extern int32_t FMC_GetChkSum(uint32_t u32Addr, uint32_t u32Count, uint32_t *u32ChkSum);
126extern uint32_t FMC_CheckAllOne(uint32_t u32addr, uint32_t u32count);
127extern int32_t FMC_SKey_Setup(uint32_t key[3], uint32_t kpmax, uint32_t kemax, int lock_CONFIG);
128extern int32_t FMC_SKey_Compare(uint32_t key[3]);
129
130 /* end of group NANO103_FMC_EXPORTED_FUNCTIONS */
132 /* end of group NANO103_FMC_Driver */
134 /* end of group NANO103_Device_Driver */
136
137#ifdef __cplusplus
138}
139#endif
140
141#endif // __FMC_H__
142
143/*** (C) COPYRIGHT 2015 Nuvoton Technology Corp. ***/
void FMC_Close(void)
Disable FMC ISP function.
Definition: fmc.c:38
int32_t FMC_ReadConfig(uint32_t *u32Config, uint32_t u32Count)
Execute ISP command to read User Configuration.
Definition: fmc.c:343
void FMC_SetVectorPageAddr(uint32_t u32PageAddr)
This function will force re-map assigned flash page to CPU address 0x0.
Definition: fmc.c:273
uint32_t FMC_ReadCID(void)
Read company ID.
Definition: fmc.c:144
uint32_t FMC_GetVectorPageAddr(void)
Obtain the current vector page address setting.
Definition: fmc.c:294
uint32_t FMC_ReadUID(uint32_t u32Index)
This function reads one of the three UID.
Definition: fmc.c:233
int32_t FMC_Erase(uint32_t u32PageAddr)
Execute FMC_ISPCMD_PAGE_ERASE command to erase a flash page. The page size is 512 bytes.
Definition: fmc.c:51
int32_t FMC_SKey_Setup(uint32_t key[3], uint32_t kpmax, uint32_t kemax, int lock_CONFIG)
Setup security key.
Definition: fmc.c:523
uint32_t FMC_ReadDataFlashBaseAddr(void)
Get the base address of Data Flash if enabled.
Definition: fmc.c:259
int32_t FMC_Write(uint32_t u32Addr, uint32_t u32Data)
Execute ISP command to program a word to flash.
Definition: fmc.c:311
uint32_t FMC_Read(uint32_t u32Addr)
Execute ISP command to read a word from flash.
Definition: fmc.c:116
uint32_t FMC_ReadPID(void)
Read product ID.
Definition: fmc.c:173
uint32_t FMC_CheckAllOne(uint32_t u32addr, uint32_t u32count)
Run flash all one verification and get result.
Definition: fmc.c:448
int32_t FMC_GetBootSource(void)
Get the current boot source.
Definition: fmc.c:87
int32_t FMC_WriteConfig(uint32_t *u32Config, uint32_t u32Count)
Execute ISP command to write User Configuration.
Definition: fmc.c:362
void FMC_Open(void)
Enable FMC ISP function.
Definition: fmc.c:100
int32_t FMC_SKey_Compare(uint32_t key[3])
Execute security key comparison.
Definition: fmc.c:610
int32_t FMC_GetChkSum(uint32_t u32Addr, uint32_t u32Count, uint32_t *u32ChkSum)
Run CRC32 checksum calculation and get result.
Definition: fmc.c:387
uint32_t FMC_ReadUCID(uint32_t u32Index)
This function reads one of the four UCID.
Definition: fmc.c:203