hal_isink.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_ISINK_H__
#define __HAL_ISINK_H__

#include "hal_platform.h"
#ifdef HAL_ISINK_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HAL_ISINK_CHANNEL_0 = 0,                          
    HAL_ISINK_CHANNEL_1 = 1,                          
    HAL_ISINK_MAX_CHANNEL                             
} hal_isink_channel_t;


typedef enum {
    HAL_ISINK_CLOCK_SOURCE_32KHZ = 0,                 
    HAL_ISINK_CLOCK_SOURCE_2MHZ = 1                   
} hal_isink_clock_source_t ;

typedef enum {
    HAL_ISINK_MODE_PWM = 0,                              
    HAL_ISINK_MODE_BREATH = 1,                           
    HAL_ISINK_MODE_REGISTER = 2                         
} hal_isink_mode_t ;


typedef enum {
    HAL_ISINK_OUTPUT_CURRENT_4_MA = 0,                       
    HAL_ISINK_OUTPUT_CURRENT_8_MA = 1,                       
    HAL_ISINK_OUTPUT_CURRENT_12_MA = 2,                      
    HAL_ISINK_OUTPUT_CURRENT_16_MA = 3,                      
    HAL_ISINK_OUTPUT_CURRENT_20_MA = 4,                      
    HAL_ISINK_OUTPUT_CURRENT_24_MA = 5                       
} hal_isink_current_t ;

typedef enum {
    HAL_ISINK_TIME_0_123_SECOND = 0,                       
    HAL_ISINK_TIME_0_338_SECOND = 1,                       
    HAL_ISINK_TIME_0_523_SECOND = 2,                       
    HAL_ISINK_TIME_0_707_SECOND = 3,                       
    HAL_ISINK_TIME_0_926_SECOND = 4,                       
    HAL_ISINK_TIME_1_107_SECOND = 5,                       
    HAL_ISINK_TIME_1_291_SECOND = 6,                       
    HAL_ISINK_TIME_1_507_SECOND = 7,                       
    HAL_ISINK_TIME_1_691_SECOND = 8,                       
    HAL_ISINK_TIME_1_876_SECOND = 9,                       
    HAL_ISINK_TIME_2_091_SECOND = 10,                      
    HAL_ISINK_TIME_2_276_SECOND = 11,                      
    HAL_ISINK_TIME_2_460_SECOND = 12,                      
    HAL_ISINK_TIME_2_676_SECOND = 13,                      
    HAL_ISINK_TIME_2_860_SECOND = 14,                      
    HAL_ISINK_TIME_3_075_SECOND = 15                       
} hal_isink_breath_adjust_on_t ;

typedef enum {
    HAL_ISINK_TIME_0_246_SECOND = 0,                       
    HAL_ISINK_TIME_0_677_SECOND = 1,                       
    HAL_ISINK_TIME_1_046_SECOND = 2,                       
    HAL_ISINK_TIME_1_417_SECOND = 3,                       
    HAL_ISINK_TIME_1_845_SECOND = 4,                       
    HAL_ISINK_TIME_2_214_SECOND = 5,                       
    HAL_ISINK_TIME_2_583_SECOND = 6,                       
    HAL_ISINK_TIME_3_014_SECOND = 7,                       
    HAL_ISINK_TIME_3_383_SECOND = 8,                       
    HAL_ISINK_TIME_3_752_SECOND = 9,                       
    HAL_ISINK_TIME_4_183_SECOND = 10,                      
    HAL_ISINK_TIME_4_552_SECOND = 11,                      
    HAL_ISINK_TIME_4_921_SECOND = 12,                      
    HAL_ISINK_TIME_5_351_SECOND = 13,                      
    HAL_ISINK_TIME_5_720_SECOND = 14,                      
    HAL_ISINK_TIME_6_151_SECOND = 15                       
} hal_isink_breath_adjust_off_t ;


typedef enum {
    HAL_ISINK_STATUS_ERROR               = -3,       
    HAL_ISINK_STATUS_ERROR_CHANNEL       = -2,       
    HAL_ISINK_STATUS_ERROR_INVALID_PARAMETER   = -1, 
    HAL_ISINK_STATUS_OK   = 0                       
} hal_isink_status_t;


typedef enum {
    HAL_ISINK_IDLE = 0,                         
    HAL_ISINK_BUSY = 1                          
} hal_isink_running_status_t;

typedef struct {
    hal_isink_breath_adjust_on_t  darker_to_lighter_time1;         
    hal_isink_breath_adjust_on_t  darker_to_lighter_time2;         
    hal_isink_breath_adjust_on_t  lightest_time;                   
    hal_isink_breath_adjust_on_t  lighter_to_darker_time1;         
    hal_isink_breath_adjust_on_t  lighter_to_darker_time2;         
    hal_isink_breath_adjust_off_t darkest_time;                    
} hal_isink_breath_mode_t;


hal_isink_status_t  hal_isink_init(hal_isink_channel_t channel);



hal_isink_status_t  hal_isink_deinit(hal_isink_channel_t channel);



hal_isink_status_t hal_isink_set_clock_source(hal_isink_channel_t channel, hal_isink_clock_source_t source_clock);



hal_isink_status_t hal_isink_set_mode(hal_isink_channel_t channel, hal_isink_mode_t mode);



hal_isink_status_t hal_isink_set_step_current(hal_isink_channel_t channel, hal_isink_current_t current);


hal_isink_status_t hal_isink_set_double_current(hal_isink_channel_t channel, hal_isink_current_t current);


hal_isink_status_t hal_isink_enable_breath_mode(hal_isink_channel_t channel, hal_isink_breath_mode_t breath_mode);



hal_isink_status_t hal_isink_get_running_status(hal_isink_channel_t channel, hal_isink_running_status_t *running_status);



#ifdef __cplusplus
}
#endif


#endif /*HAL_ISINK_MODULE_ENABLED*/
#endif /* __HAL_ISINK_H__ */