fmc.h 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. /**************************************************************************//**
  2. * @file fmc.h
  3. * @version V1.10
  4. * $Revision: 14 $
  5. * $Date: 15/11/20 9:55a $
  6. * @brief NUC472/NUC442 Flash Memory Controller Driver Header File
  7. *
  8. * @note
  9. * Copyright (C) 2013 Nuvoton Technology Corp. All rights reserved.
  10. *
  11. ******************************************************************************/
  12. #ifndef __FMC_H__
  13. #define __FMC_H__
  14. #ifdef __cplusplus
  15. extern "C"
  16. {
  17. #endif
  18. /** @addtogroup NUC472_442_Device_Driver NUC472/NUC442 Device Driver
  19. @{
  20. */
  21. /** @addtogroup NUC472_442_FMC_Driver FMC Driver
  22. @{
  23. */
  24. /** @addtogroup NUC472_442_FMC_EXPORTED_CONSTANTS FMC Exported Constants
  25. @{
  26. */
  27. /*---------------------------------------------------------------------------------------------------------*/
  28. /* Define Base Address */
  29. /*---------------------------------------------------------------------------------------------------------*/
  30. #define FMC_APROM_BASE 0x00000000UL /*!< APROM Base Address \hideinitializer */
  31. #define FMC_APROM_END 0x00080000UL /*!< APROM End Address \hideinitializer */
  32. #define FMC_LDROM_BASE 0x00100000UL /*!< LDROM Base Address \hideinitializer */
  33. #define FMC_LDROM_END 0x00104000UL /*!< LDROM End Address \hideinitializer */
  34. #define FMC_CONFIG_BASE 0x00300000UL /*!< User Configuration Address \hideinitializer */
  35. #define FMC_FLASH_PAGE_SIZE 0x800 /*!< Flash Page Size (2 Kbytes) \hideinitializer */
  36. #define FMC_LDROM_SIZE 0x4000 /*!< LDROM Size (16 Kbytes) \hideinitializer */
  37. /*---------------------------------------------------------------------------------------------------------*/
  38. /* ISPCMD constant definitions */
  39. /*---------------------------------------------------------------------------------------------------------*/
  40. #define FMC_ISPCMD_READ 0x00 /*!< ISP Command: Read flash word \hideinitializer */
  41. #define FMC_ISPCMD_READ_64 0x40 /*!< ISP Command: Read flash double word \hideinitializer */
  42. #define FMC_ISPCMD_WRITE 0x21 /*!< ISP Command: Write flash word \hideinitializer */
  43. #define FMC_ISPCMD_WRITE_64 0x61 /*!< ISP Command: Write flash double word \hideinitializer */
  44. #define FMC_ISPCMD_PAGE_ERASE 0x22 /*!< ISP Command: Page Erase Flash \hideinitializer */
  45. #define FMC_ISPCMD_READ_CID 0x0B /*!< ISP Command: Read Company ID \hideinitializer */
  46. #define FMC_ISPCMD_READ_PID 0x0C /*!< ISP Command: Read ProductID \hideinitializer */
  47. #define FMC_ISPCMD_READ_UID 0x04 /*!< ISP Command: Read Unique ID \hideinitializer */
  48. #define ISP_ISPCMD_MULTI_WRITE 0x27 /*!< ISP Command: Multiple program \hideinitializer */
  49. #define FMC_ISPCMD_VECMAP 0x2E /*!< ISP Command: Vector Page Remap \hideinitializer */
  50. #define IS_BOOT_FROM_APROM 0 /*!< Is booting from APROM \hideinitializer */
  51. #define IS_BOOT_FROM_LDROM 1 /*!< Is booting from LDROM \hideinitializer */
  52. /*@}*/ /* end of group NUC472_442_FMC_EXPORTED_CONSTANTS */
  53. /** @addtogroup NUC472_442_FMC_EXPORTED_FUNCTIONS FMC Exported Functions
  54. @{
  55. */
  56. /*---------------------------------------------------------------------------------------------------------*/
  57. /* Macros */
  58. /*---------------------------------------------------------------------------------------------------------*/
  59. /**
  60. * @brief This macro selects booting from APROM.
  61. * @param None
  62. * @return None
  63. * \hideinitializer
  64. */
  65. #define FMC_SET_APROM_BOOT() (FMC->ISPCTL &= ~FMC_ISPCTL_BS_Msk)
  66. /**
  67. * @brief This macro selects booting from LDROM.
  68. * @param None
  69. * @return None
  70. * \hideinitializer
  71. */
  72. #define FMC_SET_LDROM_BOOT() (FMC->ISPCTL |= FMC_ISPCTL_BS_Msk)
  73. /**
  74. * @brief This macro enables APROM update function.
  75. * @param None
  76. * @return None
  77. * \hideinitializer
  78. */
  79. #define FMC_ENABLE_AP_UPDATE() (FMC->ISPCTL |= FMC_ISPCTL_APUEN_Msk)
  80. /**
  81. * @brief This macro disables APROM update function.
  82. * @param None
  83. * @return None
  84. * \hideinitializer
  85. */
  86. #define FMC_DISABLE_AP_UPDATE() (FMC->ISPCTL &= ~FMC_ISPCTL_APUEN_Msk)
  87. /**
  88. * @brief This macro enables User Configuration update function.
  89. * @param None
  90. * @return None
  91. * \hideinitializer
  92. */
  93. #define FMC_ENABLE_CFG_UPDATE() (FMC->ISPCTL |= FMC_ISPCTL_CFGUEN_Msk)
  94. /**
  95. * @brief This macro disables User Configuration update function.
  96. * @param None
  97. * @return None
  98. * \hideinitializer
  99. */
  100. #define FMC_DISABLE_CFG_UPDATE() (FMC->ISPCTL &= ~FMC_ISPCTL_CFGUEN_Msk)
  101. /**
  102. * @brief This macro enables LDROM update function.
  103. * @param None
  104. * @return None
  105. * \hideinitializer
  106. */
  107. #define FMC_ENABLE_LD_UPDATE() (FMC->ISPCTL |= FMC_ISPCTL_LDUEN_Msk)
  108. /**
  109. * @brief This macro disables LDROM update function.
  110. * @param None
  111. * @return None
  112. * \hideinitializer
  113. */
  114. #define FMC_DISABLE_LD_UPDATE() (FMC->ISPCTL &= ~FMC_ISPCTL_LDUEN_Msk)
  115. /**
  116. * @brief This macro enables ISP function.
  117. * @param None
  118. * @return None
  119. * \hideinitializer
  120. */
  121. #define FMC_ENABLE_ISP() (FMC->ISPCTL |= FMC_ISPCTL_ISPEN_Msk) /*!< Enable ISP function \hideinitializer */
  122. /**
  123. * @brief This macro disables ISP function.
  124. * @param None
  125. * @return None
  126. * \hideinitializer
  127. */
  128. #define FMC_DISABLE_ISP() (FMC->ISPCTL &= ~FMC_ISPCTL_ISPEN_Msk)
  129. /**
  130. * @brief This macro gets ISP fail flag value.
  131. * @param None
  132. * @return ISP fail flag value.
  133. * \hideinitializer
  134. */
  135. #define FMC_GET_FAIL_FLAG() ((FMC->ISPSTS & FMC_ISPSTS_ISPFF_Msk) ? 1 : 0)
  136. /**
  137. * @brief This macro clears ISP fail flag.
  138. * @param None
  139. * @return None
  140. * \hideinitializer
  141. */
  142. #define FMC_CLR_FAIL_FLAG() (FMC->ISPSTS |= FMC_ISPSTS_ISPFF_Msk) /*!< Clear ISP fail flag \hideinitializer */
  143. /*---------------------------------------------------------------------------------------------------------*/
  144. /* Functions */
  145. /*---------------------------------------------------------------------------------------------------------*/
  146. extern void FMC_Close(void);
  147. extern int32_t FMC_Erase(uint32_t u32PageAddr);
  148. extern int32_t FMC_GetBootSource(void);
  149. extern void FMC_Open(void);
  150. extern uint32_t FMC_Read(uint32_t u32Addr);
  151. extern void FMC_Read_64(uint32_t u32Addr, uint32_t *u32Data0, uint32_t *u32Data1);
  152. extern uint32_t FMC_ReadCID(void);
  153. extern uint32_t FMC_ReadPID(void);
  154. extern uint32_t FMC_ReadUCID(uint32_t u32Index);
  155. extern uint32_t FMC_ReadUID(uint32_t u32Index);
  156. extern uint32_t FMC_ReadDataFlashBaseAddr(void);
  157. extern void FMC_SetVectorPageAddr(uint32_t u32PageAddr);
  158. extern uint32_t FMC_GetVectorPageAddr(void);
  159. extern void FMC_Write(uint32_t u32Addr, uint32_t u32Data);
  160. extern void FMC_Write_64(uint32_t u32Addr, uint32_t u32Data0, uint32_t u32Data1);
  161. extern int32_t FMC_ReadConfig(uint32_t *u32Config, uint32_t u32Count);
  162. extern int32_t FMC_WriteConfig(uint32_t *u32Config, uint32_t u32Count);
  163. extern uint32_t FMC_CRC8(uint32_t au32Data[], int i32Count);
  164. /*@}*/ /* end of group NUC472_442_FMC_EXPORTED_FUNCTIONS */
  165. /*@}*/ /* end of group NUC472_442_FMC_Driver */
  166. /*@}*/ /* end of group NUC472_442_Device_Driver */
  167. #ifdef __cplusplus
  168. }
  169. #endif
  170. #endif
  171. /*** (C) COPYRIGHT 2013 Nuvoton Technology Corp. ***/