1 /*******************************************************************************
2 * Copyright (C) 2019, 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 ddl.h
44  **
45  ** DDL common define.
46  ** @link SampleGroup Some description @endlink
47  **
48  **   - 2019-10-17  1.1  Lux
49  **
50  ******************************************************************************/
51 
52 #ifndef __DDL_H__
53 #define __DDL_H__
54 
55 /******************************************************************************/
56 /* Include files                                                              */
57 /******************************************************************************/
58 #include "base_types.h"
59 #include "board_stkhc32l19x.h"
60 #include "hc32l19x.h"
61 #include "system_hc32l19x.h"
62 #include "hc32l196_sysctrl.h"
63 #include "interrupts_hc32l19x.h"
64 /* C binding of definitions if building with C++ compiler                     */
65 #ifdef __cplusplus
66 extern "C"
67 {
68 #endif
69 
70 /******************************************************************************/
71 /* Global pre-processor symbols/macros ('#define')                            */
72 /* Macro for initializing local structures to zero                            */
73 /******************************************************************************/
74 #define DDL_ZERO_STRUCT(x)          ddl_memclr((uint8_t*)&(x), (uint32_t)(sizeof(x)))
75 
76 #define DEC2BCD(x)                  ((((x)/10)<<4) + ((x)%10))
77 #define BCD2DEC(x)                  ((((x)>>4)*10) + ((x)&0x0F))
78 
79 #define SET_BIT(REG, BIT)     ((REG) |= (BIT))
80 
81 #define CLEAR_BIT(REG, BIT)   ((REG) &= ~(BIT))
82 
83 #define READ_BIT(REG, BIT)    ((REG) & (BIT))
84 
85 #define CLEAR_REG(REG)        ((REG) = (0x0))
86 
87 #define WRITE_REG(REG, VAL)   ((REG) = (VAL))
88 
89 #define READ_REG(REG)         ((REG))
90 
91 #define MODIFY_REG(REG, CLEARMASK, SETMASK)  WRITE_REG((REG), (((READ_REG(REG)) & (~(CLEARMASK))) | (SETMASK)))
92 
93 /**
94  ******************************************************************************
95  ** Global Device Series List
96  ******************************************************************************/
97 #define DDL_DEVICE_SERIES_HC32L17X       (0u)
98 
99 /**
100  ******************************************************************************
101  ** Global Device Package List
102  ******************************************************************************/
103 // package definitions of HC device.
104 #define DDL_DEVICE_PACKAGE_HC_C         (0x00u)
105 #define DDL_DEVICE_PACKAGE_HC_F         (0x10u)
106 #define DDL_DEVICE_PACKAGE_HC_J         (0x20u)
107 #define DDL_DEVICE_PACKAGE_HC_K         (0x30u)
108 
109 /******************************************************************************/
110 /* User Device Setting Include file                                           */
111 /******************************************************************************/
112 #include "ddl_device.h"  // MUST be included here!
113 
114 /******************************************************************************/
115 /* Global type definitions ('typedef')                                        */
116 /******************************************************************************/
117 /**
118  ******************************************************************************
119  ** \brief Level
120  **
121  ** Specifies levels.
122  **
123  ******************************************************************************/
124 typedef enum en_level
125 {
126     DdlLow      = 0u,  ///< Low level  '0'
127     DdlHigh     = 1u   ///< High level '1'
128 } en_level_t;
129 
130 /**
131  ******************************************************************************
132  ** \brief Generic Flag Code
133  **
134  ** Specifies flags.
135  **
136  ******************************************************************************/
137 typedef enum en_flag
138 {
139     DdlClr = 0u,       ///< Flag clr '0'
140     DdlSet = 1u        ///< Flag set '1'
141 } en_stat_flag_t, en_irq_flag_t;
142 /******************************************************************************/
143 /* Global variable declarations ('extern', definition in C source)            */
144 /******************************************************************************/
145 
146 /******************************************************************************/
147 /* Global function prototypes ('extern', definition in C source)              */
148 /******************************************************************************/
149 
150 /*******************************************************************************
151  * Global function prototypes
152  ******************************************************************************/
153 extern void ddl_memclr(void* pu8Address, uint32_t u32Count);
154 uint32_t Log2(uint32_t u32Val);
155 /**
156  *******************************************************************************
157  ** This hook is part of wait loops.
158  ******************************************************************************/
159 void delay1ms(uint32_t u32Cnt);
160 void delay100us(uint32_t u32Cnt);
161 void delay10us(uint32_t u32Cnt);
162 void SetBit(uint32_t addr, uint32_t offset, boolean_t bFlag);
163 void ClrBit(uint32_t addr, uint32_t offset);
164 boolean_t GetBit(uint32_t addr, uint32_t offset);
165 #ifdef __cplusplus
166 }
167 #endif
168 
169 #endif /* __DDL_H__ */
170 
171 /******************************************************************************/
172 /* EOF (not truncated)                                                        */
173 /******************************************************************************/
174 
175