/*
 * 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_TIMER_H_
#define MK_TIMER_H_
#include "mk_common.h"

#ifndef TIMER0_INT_MODE_EN
#define TIMER0_INT_MODE_EN (1)
#endif

#ifndef TIMER1_INT_MODE_EN
#define TIMER1_INT_MODE_EN (1)
#endif

/**
 * @addtogroup MK8000_Timer
 * @{
 */

/**
 * @brief TIMER device IDs enumeration
 */
enum TIMER_DEV_T
{
    TIMER_ID0 = 0,
    TIMER_ID1 = 1,
    TIMER_MAX_NUM,
};

/**
 * @brief TIMER external in type enumeration
 */
enum TIMER_EXTIN_TYPE_T
{
    TIMER_EXTIN_NONE = 0,
    TIMER_EXTIN_AS_ENABLE,
    TIMER_EXTIN_AS_CLOCK,
};

/**
 * @brief TIMER config structure
 */
struct TIMER_CFG_T
{
    enum TIMER_EXTIN_TYPE_T extin_type; /*!< Specifies the external in type*/
    uint32_t load;                      /*!< Specifies the load value of the decrement counter. */
    uint32_t int_en;                    /*!< Specifies whether the interupt is enabled or disabled. \n
                                                This parameter shoule be one of the following values:
                                                    @arg true is enable
                                                    @arg false is disable
                                        */
    drv_callback_t callback;            /*!< Specifies the pointer to TIMER Callback function */
};

/**
 * @brief  TIMER handle Structure
 */
struct TIMER_HANDLE_T
{
    TIMER_TypeDef *const base; /*!< TIMER registers base address */
    const IRQn_Type irq;       /*!< TIMER interupt number */
    uint32_t int_en;           /*!< TIMER interupt switch */
    drv_callback_t callback;   /*!< Pointer to TIMER Callback function */
};

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief  open TIMER
 * @param[in] id            TIMER device ID. \n
 *                          This parameter should be one of the TIMER_DEV_T enum values as below
 *                          @arg TIMER_ID0 timer0
 *                          @arg TIMER_ID1 timer1
 * @param[in] config        Pointer to a TIMER_CFG_T structure that contains the configuration information for TIMER. \n
 * @return
 *         @arg DRV_ERROR   open failed
 *         @arg DEV_OK      open succeed
 */
int timer_open(enum TIMER_DEV_T id, struct TIMER_CFG_T *config);

/**
 * @brief  close TIMER
 * @param[in] id            TIMER device ID. \n
 *                          This parameter should be one of the TIMER_DEV_T enum values as below
 *                          @arg TIMER_ID0 timer0
 *                          @arg TIMER_ID1 timer1
 * @return
 *         @arg DRV_ERROR   open failed
 *         @arg DEV_OK      open succeed
 */
int timer_close(enum TIMER_DEV_T id);

/**
 * @brief  set TIMER load value of the decrement counter
 * @param[in] id            TIMER device ID. \n
 *                          This parameter should be one of the TIMER_DEV_T enum values as below
 *                          @arg TIMER_ID0 timer0
 *                          @arg TIMER_ID1 timer1
 * @param[in] count         Set load value.
 * @return None
 */
void timer_period_set(enum TIMER_DEV_T id, uint32_t count);

/**
 * @brief  get TIMER current value of the decrement counter
 * @param[in] id            TIMER device ID. \n
 *                          This parameter should be one of the TIMER_DEV_T enum values as below
 *                          @arg TIMER_ID0 timer0
 *                          @arg TIMER_ID1 timer1
 * @return Current value of the decrement counter
 */
uint32_t timer_count_get(enum TIMER_DEV_T id);

/**
 * @brief  set TIMER current value of the decrement counter
 * @param[in] id            TIMER device ID. \n
 *                          This parameter should be one of the TIMER_DEV_T enum values as below
 *                          @arg TIMER_ID0 timer0
 *                          @arg TIMER_ID1 timer1
 * @param[in] count         Set current value.
 * @return None
 */
void timer_count_set(enum TIMER_DEV_T id, uint32_t count);

/**
 * @brief This function handles TIMER0 interrupt.
 */
void TIMER0_IRQHandler(void);

/**
 * @brief This function handles TIMER1 interrupt.
 */
void TIMER1_IRQHandler(void);

#ifdef __cplusplus
}
#endif

/**
 * @}
 */

#endif /* MK_TIMER_H_ */