MT2523 API Reference  LinkIt SDK v4
hal_clock.h
1 /* Copyright Statement:
2  *
3  * (C) 2005-2016 MediaTek Inc. All rights reserved.
4  *
5  * This software/firmware and related documentation ("MediaTek Software") are
6  * protected under relevant copyright laws. The information contained herein
7  * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
8  * Without the prior written permission of MediaTek and/or its licensors,
9  * any reproduction, modification, use or disclosure of MediaTek Software,
10  * and information contained herein, in whole or in part, shall be strictly prohibited.
11  * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
12  * if you have agreed to and been bound by the applicable license agreement with
13  * MediaTek ("License Agreement") and been granted explicit permission to do so within
14  * the License Agreement ("Permitted User"). If you are not a Permitted User,
15  * please cease any access or use of MediaTek Software immediately.
16  * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
17  * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
18  * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
19  * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
21  * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
22  * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
23  * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
24  * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
25  * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
26  * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
27  * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
28  * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
29  * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
30  * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
31  * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
32  * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
33  */
34 
35 #ifndef __HAL_CLOCK_H__
36 #define __HAL_CLOCK_H__
37 #include "hal_platform.h"
38 
39 #ifdef HAL_CLOCK_MODULE_ENABLED
40 
90 #ifdef __cplusplus
91 extern "C" {
92 #endif
93 
94 /*****************************************************************************
95 * Enum
96 *****************************************************************************/
101 typedef enum {
107 
112 /*****************************************************************************
113 * Extern global functions
114 *****************************************************************************/
115 
124 
134 
144 
152 
157 uint32_t hal_clock_get_mcu_clock_frequency(void);
158 
159 #ifdef __cplusplus
160 }
161 #endif
162 
168 #endif /* HAL_CLOCK_MODULE_ENABLED */
169 #endif /* __HAL_CLOCK_H__ */
170 
hal_clock_cg_id
Use hal_clock_cg_id in Clock API.
Definition: hal_platform.h:1121
hal_clock_status_t
This enum defines the return status of Clock APIs.
Definition: hal_clock.h:101
Successful.
Definition: hal_clock.h:105
Unknown error.
Definition: hal_clock.h:104
Invalid parameter.
Definition: hal_clock.h:103
hal_clock_status_t hal_clock_init(void)
This function initializes the clock driver and CG before using any Clock API.
bool hal_clock_is_enabled(hal_clock_cg_id clock_id)
This function queries the status of a specific CG clock.
Uninitialized clock driver.
Definition: hal_clock.h:102
uint32_t hal_clock_get_mcu_clock_frequency(void)
This function gets the MCU clock frequency.
hal_clock_status_t hal_clock_disable(hal_clock_cg_id clock_id)
This function disables a specific CG clock.
hal_clock_status_t hal_clock_enable(hal_clock_cg_id clock_id)
This function enables a specific CG clock.