1 /*
2 * Copyright (c) 2019-2025 Allwinner Technology Co., Ltd. ALL rights reserved.
3 *
4 * Allwinner is a trademark of Allwinner Technology Co.,Ltd., registered in
5 * the the People's Republic of China and other countries.
6 * All Allwinner Technology Co.,Ltd. trademarks are used with permission.
7 *
8 * DISCLAIMER
9 * THIRD PARTY LICENCES MAY BE REQUIRED TO IMPLEMENT THE SOLUTION/PRODUCT.
10 * IF YOU NEED TO INTEGRATE THIRD PARTY’S TECHNOLOGY (SONY, DTS, DOLBY, AVS OR MPEGLA, ETC.)
11 * IN ALLWINNERS’SDK OR PRODUCTS, YOU SHALL BE SOLELY RESPONSIBLE TO OBTAIN
12 * ALL APPROPRIATELY REQUIRED THIRD PARTY LICENCES.
13 * ALLWINNER SHALL HAVE NO WARRANTY, INDEMNITY OR OTHER OBLIGATIONS WITH RESPECT TO MATTERS
14 * COVERED UNDER ANY REQUIRED THIRD PARTY LICENSE.
15 * YOU ARE SOLELY RESPONSIBLE FOR YOUR USAGE OF THIRD PARTY’S TECHNOLOGY.
16 *
17 *
18 * THIS SOFTWARE IS PROVIDED BY ALLWINNER"AS IS" AND TO THE MAXIMUM EXTENT
19 * PERMITTED BY LAW, ALLWINNER EXPRESSLY DISCLAIMS ALL WARRANTIES OF ANY KIND,
20 * WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING WITHOUT LIMITATION REGARDING
21 * THE TITLE, NON-INFRINGEMENT, ACCURACY, CONDITION, COMPLETENESS, PERFORMANCE
22 * OR MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
23 * IN NO EVENT SHALL ALLWINNER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS, OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
30 * OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 
33 #ifndef __COMMON_CCMU_H__
34 #define __COMMON_CCMU_H__
35 
36 
37 #if defined(CCMU_DBG_LEAVE_TINY) || defined(CCMU_DBG_LEAVE_HIGH)
38 #define CCMU_DBG(fmt,args...)       printf("[CCMU:dbg..] %-*s:%d "fmt ,30, __func__, __LINE__, ##args)
39 #define CCMU_ERR(fmt,args...)       printf("[CCMU:err**] %-*s:%d "fmt ,30, __func__, __LINE__, ##args)
40 #else
41 #define CCMU_DBG(fmt,args...)   do{} while(0)
42 #define CCMU_ERR(fmt,args...)   do{} while(0)
43 #endif
44 
45 #if defined(CCMU_DBG_LEAVE_HIGH)
46 #define CCMU_TRACE()                printf("[CCMU:trace] %-*s:%d \n",30, __func__, __LINE__)
47 #define CCMU_TRACE_CLK(tpye, clk)   printf("CCMU:trace %s:%d CLK "#tpye" id %d\n",__func__, __LINE__, clk)
48 #else
49 #define CCMU_TRACE()            do{} while(0)
50 #define CCMU_TRACE_CLK(clk, rate)   do{} while(0)
51 #endif
52 
53 /************************************************************************************************
54 * Enum hal_clk_status_t
55 * @Description: This enum defines the return status of Clock APIs. User should check the return value after calling the APIs
56 *************************************************************************************************/
57 typedef enum
58 {
59 
60     HAL_CLK_STATUS_DISABLED = -1,
61     HAL_CLK_STATUS_ENABLED = 0,
62     HAL_CLK_STATUS_ERROR_CLK_FACTOR_REFUSED = -11,
63     HAL_CLK_STATUS_ERROR_CLK_NEED_DISABLED  = -10,
64     HAL_CLK_STATUS_ERROR_CLK_PARENT_DISABLED  = -9,
65     HAL_CLK_STATUS_ERROR_CLK_ENABLED_FAILED  = -8,
66     HAL_CLK_STATUS_ERROR_CLK_ROUND_FAILED = -7,
67     HAL_CLK_STATUS_ERROR_CLK_SET_RATE_REFUSED = -6,
68     HAL_CLK_STATUS_ERROR_CLK_NOT_FOUND  = -5,
69     HAL_CLK_STATUS_ERROT_CLK_UNDEFINED  = -4,
70     HAL_CLK_STATUS_UNINITIALIZED = -3,        /**< Uninitialized clock driver. */
71     HAL_CLK_STATUS_INVALID_PARAMETER = -2,    /**< Invalid parameter. */
72     HAL_CLK_STATUS_ERROR = -1,                /**< Unknown error. */
73     HAL_CLK_STATUS_OK = 0,                    /**< Successful. */
74 } hal_clk_status_t;
75 
76 #if defined(CONFIG_DRIVERS_SUNXI_CLK)
77 
78 #define HAL_SUNXI_CCU (0)
79 typedef unsigned int hal_clk_id_t;
80 typedef hal_clk_id_t hal_clk_t;
81 
82 #include "sunxi/clk.h"
83 
84 #endif
85 
86 #if defined(CONFIG_DRIVERS_SUNXI_CCU)
87 /************************************************************************************************
88 * Enum hal_clk_type_t
89 * @Description: This enum defines the type of Clock
90 *************************************************************************************************/
91 typedef enum
92 {
93     HAL_SUNXI_FIXED_CCU = 0,
94     HAL_SUNXI_RTC_CCU,
95     HAL_SUNXI_CCU,
96     HAL_SUNXI_R_CCU,
97     HAL_SUNXI_CCU_NUMBER,
98 } hal_clk_type_t;
99 
100 typedef u32 hal_clk_id_t;
101 
102 #include "sunxi-ng/clk.h"
103 
104 typedef struct clk *hal_clk_t;
105 #endif
106 
107 #endif /* __COMMON_CCMU_H__ */
108 
109