1 /*************************************************************************************
2 * Copyright (C) 2016, Huada Semiconductor Co.,Ltd All rights reserved.
3 *
4 * This software is owned and published by:
5 * Huada Semiconductor Co.,Ltd ("HDSC").
6 *
7 * BY DOWNLOADING, INSTALLING OR USING THIS SOFTWARE, YOU AGREE TO BE BOUND
8 * BY ALL THE TERMS AND CONDITIONS OF THIS AGREEMENT.
9 *
10 * This software contains source code for use with HDSC
11 * components. This software is licensed by HDSC to be adapted only
12 * for use in systems utilizing HDSC components. HDSC shall not be
13 * responsible for misuse or illegal use of this software for devices not
14 * supported herein. HDSC is providing this software "AS IS" and will
15 * not be responsible for issues arising from incorrect user implementation
16 * of the software.
17 *
18 * Disclaimer:
19 * HDSC MAKES NO WARRANTY, EXPRESS OR IMPLIED, ARISING BY LAW OR OTHERWISE,
20 * REGARDING THE SOFTWARE (INCLUDING ANY ACOOMPANYING WRITTEN MATERIALS),
21 * ITS PERFORMANCE OR SUITABILITY FOR YOUR INTENDED USE, INCLUDING,
22 * WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, THE IMPLIED
23 * WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE, AND THE IMPLIED
24 * WARRANTY OF NONINFRINGEMENT.
25 * HDSC SHALL HAVE NO LIABILITY (WHETHER IN CONTRACT, WARRANTY, TORT,
26 * NEGLIGENCE OR OTHERWISE) FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT
27 * LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION,
28 * LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS) ARISING FROM USE OR
29 * INABILITY TO USE THE SOFTWARE, INCLUDING, WITHOUT LIMITATION, ANY DIRECT,
30 * INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES OR LOSS OF DATA,
31 * SAVINGS OR PROFITS,
32 * EVEN IF Disclaimer HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
33 * YOU ASSUME ALL RESPONSIBILITIES FOR SELECTION OF THE SOFTWARE TO ACHIEVE YOUR
34 * INTENDED RESULTS, AND FOR THE INSTALLATION OF, USE OF, AND RESULTS OBTAINED
35 * FROM, THE SOFTWARE.
36 *
37 * This software may be replicated in part or whole for the licensed use,
38 * with the restriction that this Disclaimer and Copyright notice must be
39 * included with each copy of this software, whether used in part or whole,
40 * at all times.
41 */
42 /******************************************************************************/
43 /** \file flash.h
44  **
45  ** FLASH 数据结构及API声明.
46  **
47  ** - 2017-05-02 LuX V1.0
48  **
49  ******************************************************************************/
50 
51 #ifndef __FLASH_H__
52 #define __FLASH_H__
53 
54 /******************************************************************************/
55 /* Include files                                                              */
56 /******************************************************************************/
57 #include "hc32l196_ddl.h"
58 
59 /* C binding of definitions if building with C++ compiler */
60 #ifdef __cplusplus
61 extern "C"
62 {
63 #endif
64 
65 /**
66  ******************************************************************************
67  ** \defgroup FlashGroup Flash Controller (Flash)
68  **
69  **
70  ******************************************************************************/
71 //@{
72 
73 /******************************************************************************
74  * Global type definitions
75  ******************************************************************************/
76 /**
77  ******************************************************************************
78   ** \brief Flash中断类型重定义
79  *****************************************************************************/
80 typedef enum en_flash_int_type
81 {
82     FlashPCInt    = 0x01u,          ///<擦写PC地址报警中断
83     FlashSlockInt = 0x02u,          ///<擦写保护报警中断
84 } en_flash_int_type_t;
85 
86 
87 /**
88  ******************************************************************************
89   ** \brief Flash读等待周期类型重定义
90  *****************************************************************************/
91 typedef enum en_flash_waitcycle
92 {
93     FlashWaitCycle0 = 0u,       ///< 读等待周期设置为0-即读周期为1(当HCLK小于等于24MHz时)
94     FlashWaitCycle1 = 1u,       ///< 读等待周期设置为1-即读周期为2(当HCLK大于24MHz时必须至少为1)
95     FlashWaitCycle2 = 2u,       ///< 读等待周期设置为2-即读周期为3(当HCK大于48MHz时必须至少为2)
96 } en_flash_waitcycle_t;
97 
98 /**
99  ******************************************************************************
100   ** \brief Flash擦写保护范围重定义
101  *****************************************************************************/
102 typedef enum en_flash_lock
103 {
104     FlashLock0 = 0u,           ///<LOCK0
105     FlashLock1 = 1u,           ///<LOCK1
106     FlashLock2 = 4u,           ///<LOCK2
107     FlashLock3 = 5u,           ///<LOCK3
108 } en_flash_lock_t;
109 
110 /**
111  ******************************************************************************
112  ** \brief Redefinition of FLASH register structure
113  ******************************************************************************/
114 
115 /******************************************************************************
116  * Global definitions
117  ******************************************************************************/
118 
119 /******************************************************************************
120  * Local type definitions ('typedef')
121  ******************************************************************************/
122 
123 /******************************************************************************
124  * Global variable definitions ('extern')
125  ******************************************************************************/
126 
127 /******************************************************************************
128  * Global function prototypes (definition in C source)
129  ******************************************************************************/
130 ///<Flash 初始化配置(中断函数、编程时间参数及休眠模式配置)
131 en_result_t Flash_Init(uint8_t u8FreqCfg, boolean_t bDpstbEn);
132 
133 ///<Flash 页/全片擦除
134 en_result_t Flash_SectorErase(uint32_t u32SectorAddr);
135 en_result_t Flash_ChipErase(void);
136 
137 ///<Flash 字节/半字/字写
138 en_result_t Flash_WriteByte(uint32_t u32Addr, uint8_t u8Data);
139 en_result_t Flash_WriteHalfWord(uint32_t u32Addr, uint16_t u16Data);
140 en_result_t Flash_WriteWord(uint32_t u32Addr, uint32_t u32Data);
141 
142 ///<Flash 编程保护加锁/解锁
143 void Flash_LockAll(void);
144 void Flash_UnlockAll(void);
145 en_result_t Flash_LockSet(en_flash_lock_t enLock, uint32_t u32LockValue);
146 
147 
148 ///<Flash 读等待周期设定
149 en_result_t Flash_WaitCycle(en_flash_waitcycle_t enWaitCycle);
150 
151 ///<中断相关函数
152 ///<中断使能/禁止
153 en_result_t Flash_EnableIrq(en_flash_int_type_t enFlashIntType);
154 en_result_t Flash_DisableIrq(en_flash_int_type_t enFlashIntType);
155 ///<中断标志获取
156 boolean_t Flash_GetIntFlag(en_flash_int_type_t enFlashIntType);
157 ///<中断标志清除
158 en_result_t Flash_ClearIntFlag(en_flash_int_type_t enFlashIntType);
159 
160 //@} // FlashGroup
161 
162 #ifdef __cplusplus
163 }
164 #endif
165 
166 #endif /* __FLASH_H__ */
167 /******************************************************************************/
168 /* EOF (not truncated)                                                        */
169 /******************************************************************************/
170