| Nano102_112 Series BSP V3.03.002 The Board Support Package for Nano102_112 Series

fmc.h
Go to the documentation of this file.
1 /**************************************************************************/
13 #ifndef __FMC_H__
14 #define __FMC_H__
15
16 #ifdef __cplusplus
17 extern "C"
18 {
19 #endif
20
35 /*---------------------------------------------------------------------------------------------------------*/
36 /* Define Base Address */
37 /*---------------------------------------------------------------------------------------------------------*/
38 #define FMC_APROM_BASE 0x00000000UL
39 #define FMC_APROM_END 0x00008000UL
40 #define FMC_LDROM_BASE 0x00100000UL
41 #define FMC_LDROM_END 0x00101000UL
42 #define FMC_SPROM_BASE 0x00200000UL
43 #define FMC_SPROM_END 0x00200200UL
44 #define FMC_CONFIG_BASE 0x00300000UL
46 #define FMC_FLASH_PAGE_SIZE 0x200
47 #define FMC_LDROM_SIZE 0x1000
49 /*---------------------------------------------------------------------------------------------------------*/
50 /* ISPCMD constant definitions */
51 /*---------------------------------------------------------------------------------------------------------*/
52 #define FMC_ISPCMD_READ 0x00
53 #define FMC_ISPCMD_PROGRAM 0x21
54 #define FMC_ISPCMD_PAGE_ERASE 0x22
55 #define FMC_ISPCMD_READ_CID 0x0B
56 #define FMC_ISPCMD_READ_PID 0x0C
57 #define FMC_ISPCMD_READ_UID 0x04
58 #define FMC_ISPCMD_VECMAP 0x2E
60 #define IS_BOOT_FROM_APROM 0
61 #define IS_BOOT_FROM_LDROM 1
64 /* end of group NANO1X2_FMC_EXPORTED_CONSTANTS */
65
66
71 /*---------------------------------------------------------------------------------------------------------*/
72 /* Macros */
73 /*---------------------------------------------------------------------------------------------------------*/
74
75 #define FMC_SET_APROM_BOOT() (FMC->ISPCON &= ~FMC_ISPCON_BS_Msk)
76 #define FMC_SET_LDROM_BOOT() (FMC->ISPCON |= FMC_ISPCON_BS_Msk)
77 #define FMC_ENABLE_AP_UPDATE() (FMC->ISPCON |= FMC_ISPCON_APUEN_Msk)
78 #define FMC_DISABLE_AP_UPDATE() (FMC->ISPCON &= ~FMC_ISPCON_APUEN_Msk)
79 #define FMC_ENABLE_CFG_UPDATE() (FMC->ISPCON |= FMC_ISPCON_CFGUEN_Msk)
80 #define FMC_DISABLE_CFG_UPDATE() (FMC->ISPCON &= ~FMC_ISPCON_CFGUEN_Msk)
81 #define FMC_ENABLE_LD_UPDATE() (FMC->ISPCON |= FMC_ISPCON_LDUEN_Msk)
82 #define FMC_DISABLE_LD_UPDATE() (FMC->ISPCON &= ~FMC_ISPCON_LDUEN_Msk)
83 #define FMC_DISABLE_ISP() (FMC->ISPCON &= ~FMC_ISPCON_ISPEN_Msk)
84 #define FMC_ENABLE_ISP() (FMC->ISPCON |= FMC_ISPCON_ISPEN_Msk)
85 #define FMC_GET_FAIL_FLAG() ((FMC->ISPCON & FMC_ISPCON_ISPFF_Msk) ? 1 : 0)
86 #define FMC_CLR_FAIL_FLAG() (FMC->ISPCON |= FMC_ISPCON_ISPFF_Msk)
88 /*---------------------------------------------------------------------------------------------------------*/
89 /* Functions */
90 /*---------------------------------------------------------------------------------------------------------*/
91
92 extern void FMC_Close(void);
93 extern int32_t FMC_Erase(uint32_t u32PageAddr);
94 extern int32_t FMC_GetBootSource(void);
95 extern void FMC_Open(void);
96 extern uint32_t FMC_Read(uint32_t u32Addr);
97 extern uint32_t FMC_ReadCID(void);
98 extern uint32_t FMC_ReadPID(void);
99 extern uint32_t FMC_ReadUCID(uint32_t u32Index);
100 extern uint32_t FMC_ReadUID(uint32_t u32Index);
101 extern uint32_t FMC_ReadDataFlashBaseAddr(void);
102 extern void FMC_SetVectorPageAddr(uint32_t u32PageAddr);
103 extern uint32_t FMC_GetVectorPageAddr(void);
104 extern void FMC_Write(uint32_t u32Addr, uint32_t u32Data);
105 extern int32_t FMC_ReadConfig(uint32_t *u32Config, uint32_t u32Count);
106 extern int32_t FMC_WriteConfig(uint32_t *u32Config, uint32_t u32Count);
107
108 /* end of group NANO1X2_FMC_EXPORTED_FUNCTIONS */
110 /* end of group NANO1X2_FMC_Driver */
112 /* end of group NANO1X2_Device_Driver */
114
115 #ifdef __cplusplus
116 }
117 #endif
118
119 #endif // __FMC_H__
120
121 /*** (C) COPYRIGHT 2014 Nuvoton Technology Corp. ***/
FMC_SetVectorPageAddr
void FMC_SetVectorPageAddr(uint32_t u32PageAddr)
This function will force re-map assigned flash page to CPU address 0x0.
Definition: fmc.c:188
FMC_ReadUCID
uint32_t FMC_ReadUCID(uint32_t u32Index)
This function reads one of the four UCID.
Definition: fmc.c:144
FMC_ReadCID
uint32_t FMC_ReadCID(void)
Read company ID.
Definition: fmc.c:115
FMC_ReadConfig
int32_t FMC_ReadConfig(uint32_t *u32Config, uint32_t u32Count)
Execute ISP command to read User Configuration.
Definition: fmc.c:233
FMC_Open
void FMC_Open(void)
Enable FMC ISP function.
Definition: fmc.c:87
FMC_ReadUID
uint32_t FMC_ReadUID(uint32_t u32Index)
This function reads one of the three UID.
Definition: fmc.c:161
FMC_Close
void FMC_Close(void)
Disable FMC ISP function.
Definition: fmc.c:37
FMC_GetBootSource
int32_t FMC_GetBootSource(void)
Get the current boot source.
Definition: fmc.c:74
FMC_ReadPID
uint32_t FMC_ReadPID(void)
Read product ID.
Definition: fmc.c:129
FMC_Write
void FMC_Write(uint32_t u32Addr, uint32_t u32Data)
Execute ISP command to program a word to flash.
Definition: fmc.c:214
FMC_GetVectorPageAddr
uint32_t FMC_GetVectorPageAddr(void)
Obtain the current vector page address setting.
Definition: fmc.c:201
FMC_Erase
int32_t FMC_Erase(uint32_t u32PageAddr)
Execute ISP command to erase a flash page. The page size is 512 bytes.
Definition: fmc.c:51
FMC_Read
uint32_t FMC_Read(uint32_t u32Addr)
Execute ISP command to read a word from flash.
Definition: fmc.c:99
FMC_ReadDataFlashBaseAddr
uint32_t FMC_ReadDataFlashBaseAddr(void)
Get the base address of Data Flash if enabled.
Definition: fmc.c:177
FMC_WriteConfig
int32_t FMC_WriteConfig(uint32_t *u32Config, uint32_t u32Count)
Execute ISP command to write User Configuration.
Definition: fmc.c:252