1# CLOCK<a name="1"></a>
2
3## 概述<a name="section1"></a>
4
5### 功能简介<a name="section2"></a>
6
7CLOCK，时钟是系统各个部件运行的基础，以CPU时钟举例，CPU 时钟是指 CPU 内部的时钟发生器，它以频率的形式工作，用来同步和控制 CPU 内部的各个操作。
8
9CLOCK接口定义了完成CLOCK操作的通用方法集合，包括：
10
11-  CLOCK设备管理：打开或关闭时钟设备。
12
13-  CLOCK速率控制：读取或设置时钟速率。
14
15-  CLOCK门控：使能或去使能时钟。
16
17-  CLOCK父时钟管理：获取或者设置父时钟。
18
19### 基本概念<a name="section3"></a>
20
21设备的时钟信号是指在电子设备中用于同步和控制各个模块或组件操作的信号。它是设备内部的一个基本信号源，用于确保设备的正常运行和数据传输的准确性。
22
23### 运作机制<a name="section4"></a>
24
25在HDF框架中，同类型设备对象较多时（可能同时存在十几个同类型配置器），如果采用独立服务模式则需要配置更多的设备节点，且相关服务会占据更多的内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现），实现便捷管理和节约资源的目的。CLOCK模块接口适配模式采用统一服务模式。
26
27## 使用指导<a name="section5"></a>
28
29### 场景介绍<a name="section6"></a>
30
31CLOCK提供芯片级别的时钟管理：时钟功能可用于控制芯片内部的时钟分频、时钟倍频、时钟源选择和时钟门控等操作。通过合理的时钟管理，可以提高芯片的能效，并确保各个功能部件的正确协调和协同工作。
32
33### 接口说明<a name="section7"></a>
34
35CLOCK模块提供的主要接口如表1所示，具体API详见//drivers/hdf_core/framework/include/platform/clock_if.h。
36
37**表 1**  CLOCK驱动API接口功能介绍
38
39<a name="table1"></a>
40
41| **接口名**                                                 | **接口描述**  | 返回值描述                          | 特殊情况说明                            |
42| ---------------------------------------------------------- | ------------- | ----------------------------------- | --------------------------------------- |
43| DevHandle ClockOpen(uint32_t number);                      | 打开Clock设备 | NULL：获取失败，设备句柄：获取成功  |                                         |
44| int32_t ClockClose(DevHandle handle);                      | 关闭Clock设备 | 零:关闭成功，非零：关闭失败         |                                         |
45| int32_t ClockEnable(DevHandle handle);                     | 使能Clock     | 零:使能成功，非零：使能失败         |                                         |
46| int32_t ClockDisable(DevHandle handle);                    | 去使能Clock   | 零:去使能成功，非零：去使能失败     |                                         |
47| int32_t ClockSetRate(DevHandle handle, uint32_t rate);     | 设置时钟速率  | 零:设置时钟速率成功，非零：设置失败 | 失败请检查传入的rate对应的Clock是否支持 |
48| int32_t ClockGetRate(DevHandle handle, uint32_t *rate);    | 获取时钟速率  | 零:获取成功，非零：获取失败         |                                         |
49| int32_t ClockSetParent(DevHandle child, DevHandle parent); | 设置父时钟    | 零:设置父成功，非零：设置父失败     | 父时钟重复设置时不报错，直接返回成功    |
50| DevHandle ClockGetParent(DevHandle handle);                | 获取父时钟    | 零:获取父成功，非零：获取父失败     |                                         |
51
52### 开发步骤<a name="section8"></a>
53
54使用CLOCK设备的一般流程如图2所示。
55
56**图 2**  CLOCK使用流程图<a name="fig2"></a>
57![CLOCK使用流程图](figures/CLOCK使用流程图.png)
58
59### 使用实例<a name="section9"></a>
60
61本例拟对RK3568开发板上CLOCK设备进行简单的读取操作，基本硬件信息如下：
62
63-   SOC：RK3568。
64
65本例程对各个接口进行调用测试
66
67示例如下：
68
69```c
70#include "clock_if.h"          // CLOCK标准接口头文件
71#include "hdf_log.h"         // 标准日志打印头文件
72#define CLOCK_NUM 1
73
74static int32_t TestCaseClock(void)
75{
76    int ret = 0;
77    DevHandle handle = NULL;
78    DevHandle parent = NULL;
79    uint32_t rate = 0;
80
81    handle = ClockOpen(CLOCK_NUM);
82    if (handle == NULL) {
83        HDF_LOGE("Failed to open CLOCK_NUM %d \n", CLOCK_NUM);
84        return HDF_FAILURE;
85    }
86
87    ret = ClockEnable(handle);
88    if (ret != HDF_SUCCESS) {
89        HDF_LOGE("Failed to ClockEnable ret = %d \n",ret);
90        return ret;
91    }
92
93
94    ret = ClockGetRate(handle, &rate);
95    if (ret != HDF_SUCCESS) {
96        HDF_LOGE("Failed to ClockGetRate ret = %d \n",ret);
97        return ret;
98    }
99
100    ret = ClockSetRate(handle, set_rate);
101    if (ret != HDF_SUCCESS) {
102        HDF_LOGE("Failed to ClockSetRate ret = %d \n",ret);
103        return ret;
104    }
105
106    ret = ClockDisable(handle);
107    if (ret != HDF_SUCCESS) {
108        HDF_LOGE("Failed to ClockDisable ret = %d \n",ret);
109        return ret;
110    }
111
112    parent = ClockGetParent(handle);
113    if (parent != NULL) {
114        ret = ClockSetParent(handle, parent);
115        ClockClose(parent);
116    } else {
117        HDF_LOGE("Failed to ClockGetParent ret = %d \n",ret);
118    }
119
120    ret = ClockClose(handle);
121    return ret;
122}
123```