hal_pwm.h

/* Copyright Statement:
 *
 * (C) 2005-2016  MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User").  If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __HAL_PWM_H__
#define __HAL_PWM_H__
#include "hal_platform.h"

#ifdef HAL_PWM_MODULE_ENABLED

#ifdef HAL_PWM_FEATURE_ADVANCED_CONFIG


#else

#endif


#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HAL_PWM_STATUS_ERROR                = -4,         
    HAL_PWM_STATUS_ERROR_CHANNEL        = -3,         
    HAL_PWM_STATUS_INVALID_PARAMETER    = -2,         
    HAL_PWM_STATUS_INVALID_FREQUENCY    = -1,         
    HAL_PWM_STATUS_OK                   =  0          
} hal_pwm_status_t;



typedef enum {
    HAL_PWM_IDLE = 0,                         
    HAL_PWM_BUSY = 1                          
} hal_pwm_running_status_t;

#ifdef   HAL_PWM_FEATURE_ADVANCED_CONFIG

typedef enum {
    HAL_PWM_CLOCK_DIVISION_2 = 1,            
    HAL_PWM_CLOCK_DIVISION_4 = 2,            
    HAL_PWM_CLOCK_DIVISION_8 = 3             
} hal_pwm_advanced_config_t;

#endif



#ifdef HAL_PWM_FEATURE_SINGLE_SOURCE_CLOCK

hal_pwm_status_t hal_pwm_init(hal_pwm_source_clock_t source_clock);

hal_pwm_status_t hal_pwm_deinit(void);


#else

hal_pwm_status_t hal_pwm_init(hal_pwm_channel_t pwm_channel, hal_pwm_source_clock_t source_clock);


hal_pwm_status_t hal_pwm_deinit(hal_pwm_channel_t pwm_channel);

#endif

hal_pwm_status_t hal_pwm_set_frequency(hal_pwm_channel_t pwm_channel, uint32_t frequency, uint32_t *total_count);


hal_pwm_status_t hal_pwm_set_duty_cycle(hal_pwm_channel_t pwm_channel, uint32_t duty_cycle);



hal_pwm_status_t hal_pwm_start(hal_pwm_channel_t pwm_channel);

hal_pwm_status_t hal_pwm_stop(hal_pwm_channel_t pwm_channel);


hal_pwm_status_t hal_pwm_get_frequency(hal_pwm_channel_t pwm_channel, uint32_t *frequency);



hal_pwm_status_t hal_pwm_get_duty_cycle(hal_pwm_channel_t pwm_channel, uint32_t *duty_cycle);


hal_pwm_status_t hal_pwm_get_running_status(hal_pwm_channel_t pwm_channel, hal_pwm_running_status_t *running_status);


#ifdef  HAL_PWM_FEATURE_ADVANCED_CONFIG

hal_pwm_status_t hal_pwm_set_advanced_config(hal_pwm_channel_t pwm_channel, hal_pwm_advanced_config_t advanced_config);

#else

#endif


#ifdef __cplusplus
}
#endif


#endif /*HAL_PWM_MODULE_ENABLED*/
#endif /* __HAL_PWM_H__ */