//_____________________________________________________________________________
//
// Copyright (C) 2018                   Mobsya                   CH-1020 Renens
//_____________________________________________________________________________
//
// PROJECT   XXX
//_____________________________________________________________________________
//
//! \file    gpio.h
//! \brief   This module provides the useful functions to use the GPIO
//!
//! \author  Vincent Gonet
//_____________________________________________________________________________

#ifndef GPIO_H_
#define GPIO_H_

//-----------------------------------------------------------------------------
// Include Section
//-----------------------------------------------------------------------------

#include <stdint.h>

//-----------------------------------------------------------------------------
// Constants/Macros Definitions
//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------
// Types Definitions
//-----------------------------------------------------------------------------

//! \details The mode of the GPIO
typedef enum
{
  E_GpioMode_Input,
  E_GpioMode_Output,
  E_GpioMode_OutputOpenDrain,
  E_GpioMode_InputOutput,
  E_GpioMode_InputOutputOpenDrain
} T_GpioMode;

//! \details The resistor of the GPIO
typedef enum
{
  E_GpioResistor_None,
  E_GpioResistor_PullUp,
  E_GpioResistor_PullDown
} T_GpioResistor;

//! \details The level of the GPIO
typedef enum
{
  E_GpioLevel_Low,
  E_GpioLevel_High
} T_GpioLevel;

//! \details The interrupt of the GPIO
typedef enum
{
  E_GpioInterrupt_Disable,
  E_GpioInterrupt_RisingEdge,
  E_GpioInterrupt_FallingEdge,
  E_GpioInterrupt_AnyEdge,
  E_GpioInterrupt_LowLevel,
  E_GpioInterrupt_HighLevel
} T_GpioInterrupt;

//! \details GPIO pin configuration
typedef struct
{
  uint16_t        pinNumber;  //!< Pin number
  T_GpioMode      mode;       //!< Pin mode
  T_GpioResistor  resistor;   //!< Pin resistor
  T_GpioLevel     level;      //!< Pin output level
  T_GpioInterrupt interrupt;  //!< Interrupt
} T_GpioPinConfig;

//-----------------------------------------------------------------------------
// Exported Global Data
//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------
// Inline Code Definition
//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------
// Exported Functions Prototypes
//-----------------------------------------------------------------------------

//! \brief     Initialize the GPIO.
//! \pre       None
//! \param     None
//! \return    None
extern void Gpio_Init(void);

//! \brief     Run the GPIO task.
//! \pre       First initialize the GPIO
//! \param     None
//! \return    None
//extern void Gpio_Task(void* arg);
extern void Gpio_Task(void);

//! \brief     Configure a GPIO.
//! \pre       None
//! \param     None
//! \return    None
extern void Gpio_ConfigurePin(const T_GpioPinConfig* config);

//! \brief     Set the pin level of a GPIO.
//! \pre       First configure the GPIO.
//! \param     None
//! \return    None
extern void Gpio_SetPinLevel(uint16_t pinNumber, T_GpioLevel level);

//! \brief     Toggle the pin level of a GPIO.
//! \pre       First configure the GPIO.
//! \param     None
//! \return    None
extern void Gpio_TogglePinLevel(uint16_t pinNumber);

//! \brief     Get the pin level of a GPIO.
//! \pre       First configure the GPIO.
//! \param     None
//! \return    None
extern int Gpio_GetPinLevel(uint16_t pinNumber);

#endif // GPIO_H_