/*
 * Copyright (c) 2019-2023 Beijing Hanwei Innovation Technology Ltd. Co. and
 * its subsidiaries and affiliates (collectly called MKSEMI).
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into an MKSEMI
 *    integrated circuit in a product or a software update for such product,
 *    must reproduce the above copyright notice, this list of conditions and
 *    the following disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. Neither the name of MKSEMI nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    MKSEMI integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be
 *    reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL MKSEMI OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef MK_GPIO_H_
#define MK_GPIO_H_
#include "mk_common.h"
#include "mk_io.h"

/**
 * @addtogroup MK8000_GPIO
 * @{
 */

/** GPIO device instance */
enum GPIO_DEV_T
{
    GPIO_ID0 = 0,
    GPIO_MAX_NUM
};

/** GPIO input/output direction */
enum GPIO_DIR_T
{
    GPIO_DIR_IN = 0,
    GPIO_DIR_OUT = 1,
    GPIO_FLOATING = 2,
};

/** GPIO interrupt types */
enum GPIO_IRQ_TYPE_T
{
    GPIO_IRQ_TYPE_LOW_LEVEL = 0,
    GPIO_IRQ_TYPE_HIGH_LEVEL,
    GPIO_IRQ_TYPE_FALLING_EDGE,
    GPIO_IRQ_TYPE_RISING_EDGE,
};

typedef void (*GPIO_IRQ_HANDLER_T)(enum IO_PIN_T pin);

#ifdef __cplusplus
extern "C" {
#endif

int gpio_open(void);
int gpio_close(void);

void gpio_write(uint32_t value);
uint32_t gpio_read(void);

void gpio_pin_set(enum IO_PIN_T pin);
void gpio_pin_clr(enum IO_PIN_T pin);
void gpio_pin_toggle(enum IO_PIN_T pin);
uint8_t gpio_pin_get_val(enum IO_PIN_T pin);

void gpio_pin_set_dir(enum IO_PIN_T pin, enum GPIO_DIR_T dir, uint8_t out_val);

void gpio_enable_irq(enum IO_PIN_T pin, enum GPIO_IRQ_TYPE_T irq_type, GPIO_IRQ_HANDLER_T irq_handler);
void gpio_disable_irq(enum IO_PIN_T pin);

void GPIO_IRQHandler(void);

#ifdef __cplusplus
}
#endif

/**
 * @}
 */

#endif /* MK_GPIO_H_ */