MT7687 API Reference  LinkIt SDK v4
hal_display_pwm.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 #include "hal_platform.h"
36 
37 #ifndef __HAL_DISPLAY_PWM_H__
38 #define __HAL_DISPLAY_PWM_H__
39 
40 #ifdef HAL_DISPLAY_PWM_MODULE_ENABLED
41 
87 #ifdef __cplusplus
88 extern "C" {
89 #endif
90 
96 typedef enum {
97  HAL_DISPLAY_PWM_CLOCK_26MHZ = 0,
98  HAL_DISPLAY_PWM_CLOCK_104MHZ = 1,
99  HAL_DISPLAY_PWM_CLOCK_NUM = 2
100 } hal_display_pwm_clock_t;
101 
103 typedef enum {
104  HAL_DISPLAY_PWM_STATUS_ERROR = -2,
105  HAL_DISPLAY_PWM_STATUS_INVALID_PARAMETER = -1,
106  HAL_DISPLAY_PWM_STATUS_OK = 0,
107 } hal_display_pwm_status_t;
108 
123 hal_display_pwm_status_t hal_display_pwm_init(hal_display_pwm_clock_t clock);
124 
133 hal_display_pwm_status_t hal_display_pwm_deinit(void);
134 
145 hal_display_pwm_status_t hal_display_pwm_set_clock(hal_display_pwm_clock_t clock);
146 
159 hal_display_pwm_status_t hal_display_pwm_set_duty(uint8_t percentage);
160 
171 hal_display_pwm_status_t hal_display_pwm_set_width(uint32_t width);
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 
182 #endif /* HAL_DISPLAY_PWM_MODULE_ENABLED */
183 #endif /* __HAL_DISPLAY_PWM_H__ */