/*******************************************************************************
 * File Name         : LED.h
 * Description       :
 * Created on        : 2021Äê3ÔÂ27ÈÕ
 * Author            : www.hido-studio.com
 *******************************************************************************/

#ifndef HAL_LED_H_
#define HAL_LED_H_
/*******************************************************************************
 *                              Include Files                                  *
 *******************************************************************************/
#include "HIDO_TypeDef.h"

/*******************************************************************************
 *                                  Macro                                      *
 *******************************************************************************/

/*******************************************************************************
 *                             Type Definition                                 *
 *******************************************************************************/
typedef enum
{
    LED_ID_0,
    LED_ID_1,
    LED_ID_2,
    LED_ID_3,
    LED_ID_4,

    LED_ID_MAX,
}E_LedID;

typedef enum
{
    LED_ACTIVE_STATE_RESET,
    LED_ACTIVE_STATE_SET,
} E_LedActiveState;

typedef struct
{
#define LED_LOOP_CNT_FOREVER                            0xFFFFFFFF

    HIDO_UINT32 m_u32ActiveTime;
    HIDO_UINT32 m_u32InactiveTime;
    HIDO_UINT32 m_u32LoopCnt;
} ST_LedCtrl;

/*******************************************************************************
 *                             Global Function                                 *
 *******************************************************************************/

/*******************************************************************************
 * Function Name     : Led_PinRegister
 * Description       :
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2018Äê8ÔÂ8ÈÕ
 *******************************************************************************/
HIDO_INT32 Led_PinRegister(E_LedID _eID, HIDO_VOID *_pGPIO, HIDO_UINT16 _u16Pin, E_LedActiveState _eActiveState);

/*******************************************************************************
 * Function Name     : Led_On
 * Description       :
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2018Äê8ÔÂ8ÈÕ
 *******************************************************************************/
HIDO_INT32 Led_On(E_LedID _eID);

/*******************************************************************************
 * Function Name     : Led_Off
 * Description       :
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2018Äê8ÔÂ8ÈÕ
 *******************************************************************************/
HIDO_INT32 Led_Off(E_LedID _eID);

/*******************************************************************************
 * Function Name     : Led_AllOff
 * Description       : LEDÈ«²¿¹Ø±Õ
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2018Äê8ÔÂ8ÈÕ
 *******************************************************************************/
HIDO_INT32 Led_AllOff(HIDO_VOID);

/*******************************************************************************
 * Function Name     : Led_AllOn
 * Description       : LEDÈ«²¿¿ªÆô
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2018Äê8ÔÂ8ÈÕ
 *******************************************************************************/
HIDO_INT32 Led_AllOn(HIDO_VOID);

/*******************************************************************************
 * Function Name     : Led_Toggle
 * Description       :
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2018Äê8ÔÂ8ÈÕ
 *******************************************************************************/
HIDO_INT32 Led_Toggle(E_LedID _eID);

/*******************************************************************************
 * Function Name     : Led_10MsISR
 * Description       :
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê3ÔÂ25ÈÕ
 *******************************************************************************/
HIDO_VOID Led_10MsISR(HIDO_VOID);

/*******************************************************************************
 * Function Name     : Led_Ctrl
 * Description       : LED¿ØÖÆ
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê3ÔÂ25ÈÕ
 *******************************************************************************/
HIDO_INT32 Led_Ctrl(E_LedID _eID, ST_LedCtrl *_pstCtrl);

/*******************************************************************************
 * Function Name     : Led_Init
 * Description       :
 * Input             :
 * Output            :
 * Return            :
 * Author            : www.hido-studio.com
 * Modified Date:    : 2018Äê8ÔÂ8ÈÕ
 *******************************************************************************/
HIDO_INT32 Led_Init(void);

#endif /* HAL_LED_H_ */