/**
 *!
 * \file        b_hal_gpio.h
 * \version     v0.0.2
 * \date        2021/07/17
 * \author      Bean(notrynohigh@outlook.com)
 *******************************************************************************
 * @attention
 *
 * Copyright (c) 2020 Bean
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SGPIOL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *******************************************************************************
 */
#ifndef __B_HAL_GPIO_H__
#define __B_HAL_GPIO_H__

#ifdef __cplusplus
extern "C" {
#endif

/*Includes ----------------------------------------------*/
#include <stdint.h>

/**
 * \addtogroup B_HAL
 * \{
 */

/**
 * \addtogroup GPIO
 * \{
 */

/**
 * \defgroup GPIO_Exported_TypesDefinitions
 * \{
 */
typedef enum
{
    B_HAL_GPIOA,
    B_HAL_GPIOB,
    B_HAL_GPIOC,
    B_HAL_GPIOD,
    B_HAL_GPIOE,
    B_HAL_GPIOF,
    B_HAL_GPIOG,
    B_HAL_GPIO_INVALID,
} bHalGPIOPort_t;

typedef enum
{
    B_HAL_PIN0,
    B_HAL_PIN1,
    B_HAL_PIN2,
    B_HAL_PIN3,
    B_HAL_PIN4,
    B_HAL_PIN5,
    B_HAL_PIN6,
    B_HAL_PIN7,
    B_HAL_PIN8,
    B_HAL_PIN9,
    B_HAL_PIN10,
    B_HAL_PIN11,
    B_HAL_PIN12,
    B_HAL_PIN13,
    B_HAL_PIN14,
    B_HAL_PIN15,
    B_HAL_PINAll,
    B_HAL_PIN_INVALID,
} bHalGPIOPin_t;

typedef enum
{
    B_HAL_GPIO_INPUT,
    B_HAL_GPIO_OUTPUT,
    B_HAL_GPIO_DIR_INVALID,
} bHalGPIODir_t;

typedef enum
{
    B_HAL_GPIO_NOPULL,
    B_HAL_GPIO_PULLUP,
    B_HAL_GPIO_PULLDOWN,
    B_HAL_GPIO_PULL_INVALID,
} bHalGPIOPull_t;

typedef struct
{
    bHalGPIOPort_t port;
    bHalGPIOPin_t  pin;
} bHalGPIOInstance_t;

typedef struct
{
    void (*pGpioConfig)(bHalGPIOPort_t port, bHalGPIOPin_t pin, bHalGPIODir_t dir,
                        bHalGPIOPull_t pull);
    void (*pGpioWritePin)(bHalGPIOPort_t port, bHalGPIOPin_t pin, uint8_t s);
    void (*pGpioWritePort)(bHalGPIOPort_t port, uint16_t dat);
    uint8_t (*pGpioReadPin)(bHalGPIOPort_t port, bHalGPIOPin_t pin);
    uint16_t (*pGpioReadPort)(bHalGPIOPort_t port);
} const bHalGPIODriver_t;

/**
 * \}
 */

/**
 * \defgroup GPIO_Exported_Macros
 * \{
 */

#define B_HAL_GPIO_ISVALID(port, pin) (port != B_HAL_GPIO_INVALID && pin != B_HAL_PIN_INVALID)

/**
 * \}
 */

/**
 * \defgroup GPIO_Exported_Variables
 * \{
 */

extern bHalGPIODriver_t bHalGPIODriver;

/**
 * \}
 */

/**
 * \}
 */

/**
 * \}
 */

#ifdef __cplusplus
}
#endif

#endif

/************************ Copyright (c) 2020 Bean *****END OF FILE****/