hal_gpio.h

/* Copyright Statement:
 *
 * (C) 2005-2017 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_GPIO_H__
#define __HAL_GPIO_H__
#include "hal_platform.h"
#include "hal_pinmux_define.h"

#ifdef HAL_GPIO_MODULE_ENABLED

#ifdef HAL_GPIO_FEATURE_PUPD

#endif


#ifdef HAL_GPIO_FEATURE_INVERSE

#endif


#ifdef HAL_GPIO_FEATURE_CLOCKOUT

#endif


#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HAL_GPIO_DIRECTION_INPUT  = 0,              
    HAL_GPIO_DIRECTION_OUTPUT = 1               
} hal_gpio_direction_t;


typedef enum {
    HAL_GPIO_DATA_LOW  = 0,                     
    HAL_GPIO_DATA_HIGH = 1                      
} hal_gpio_data_t;


typedef enum {
    HAL_GPIO_STATUS_ERROR             = -3,     
    HAL_GPIO_STATUS_ERROR_PIN         = -2,     
    HAL_GPIO_STATUS_INVALID_PARAMETER = -1,     
    HAL_GPIO_STATUS_OK                = 0       
} hal_gpio_status_t;


typedef enum {
    HAL_PINMUX_STATUS_ERROR             = -3,   
    HAL_PINMUX_STATUS_ERROR_PORT        = -2,   
    HAL_PINMUX_STATUS_INVALID_FUNCTION  = -1,   
    HAL_PINMUX_STATUS_OK                = 0     
} hal_pinmux_status_t;

#ifdef HAL_GPIO_FEATURE_SET_DRIVING

typedef enum {
    HAL_GPIO_DRIVING_CURRENT_4MA    = 0,        
    HAL_GPIO_DRIVING_CURRENT_8MA    = 1,        
    HAL_GPIO_DRIVING_CURRENT_12MA   = 2,        
    HAL_GPIO_DRIVING_CURRENT_16MA   = 3         
} hal_gpio_driving_current_t;
#endif

hal_gpio_status_t hal_gpio_init(hal_gpio_pin_t gpio_pin);


hal_gpio_status_t hal_gpio_deinit(hal_gpio_pin_t gpio_pin);


hal_pinmux_status_t hal_pinmux_set_function(hal_gpio_pin_t gpio_pin, uint8_t function_index);


hal_gpio_status_t hal_gpio_get_input(hal_gpio_pin_t gpio_pin, hal_gpio_data_t *gpio_data);


hal_gpio_status_t hal_gpio_set_output(hal_gpio_pin_t gpio_pin, hal_gpio_data_t gpio_data);


hal_gpio_status_t hal_gpio_get_output(hal_gpio_pin_t gpio_pin, hal_gpio_data_t *gpio_data);


hal_gpio_status_t hal_gpio_set_direction(hal_gpio_pin_t gpio_pin, hal_gpio_direction_t gpio_direction);


hal_gpio_status_t hal_gpio_get_direction(hal_gpio_pin_t gpio_pin, hal_gpio_direction_t *gpio_direction);


#ifdef HAL_GPIO_FEATURE_HIGH_Z

hal_gpio_status_t hal_gpio_set_high_impedance(hal_gpio_pin_t gpio_pin);

hal_gpio_status_t hal_gpio_clear_high_impedance(hal_gpio_pin_t gpio_pin);
#endif


hal_gpio_status_t hal_gpio_toggle_pin(hal_gpio_pin_t gpio_pin);


#ifdef HAL_GPIO_FEATURE_INVERSE

hal_gpio_status_t hal_gpio_enable_inversion(hal_gpio_pin_t gpio_pin);


hal_gpio_status_t hal_gpio_disable_inversion(hal_gpio_pin_t gpio_pin);
#endif


hal_gpio_status_t hal_gpio_pull_up(hal_gpio_pin_t gpio_pin);


hal_gpio_status_t hal_gpio_pull_down(hal_gpio_pin_t gpio_pin);


hal_gpio_status_t hal_gpio_disable_pull(hal_gpio_pin_t gpio_pin);


#ifdef HAL_GPIO_FEATURE_PUPD

hal_gpio_status_t hal_gpio_set_pupd_register(hal_gpio_pin_t gpio_pin, uint8_t gpio_pupd, uint8_t gpio_r0, uint8_t gpio_r1);
#endif


#ifdef HAL_GPIO_FEATURE_CLOCKOUT

hal_gpio_status_t hal_gpio_set_clockout(hal_gpio_clock_t gpio_clock_num, hal_gpio_clock_mode_t clock_mode);
#endif


#ifdef HAL_GPIO_FEATURE_SET_DRIVING

hal_gpio_status_t hal_gpio_set_driving_current(hal_gpio_pin_t gpio_pin, hal_gpio_driving_current_t driving);

hal_gpio_status_t hal_gpio_get_driving_current(hal_gpio_pin_t gpio_pin, hal_gpio_driving_current_t *driving);
#endif



#ifdef __cplusplus
}
#endif


#endif /*HAL_GPIO_MODULE_ENABLED*/
#endif /* __HAL_GPIO_H__ */