/**
 *******************************************************************************
 * @file  hc32f4a0_ots.h
 * @brief This file contains all the functions prototypes of the OTS driver
 *        library.
 @verbatim
   Change Logs:
   Date             Author          Notes
   2020-06-12       Wuze            First version
 @endverbatim
 *******************************************************************************
 * Copyright (C) 2020, Huada Semiconductor Co., Ltd. All rights reserved.
 *
 * This software component is licensed by HDSC under BSD 3-Clause license
 * (the "License"); You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at:
 *                    opensource.org/licenses/BSD-3-Clause
 *
 *******************************************************************************
 */
#ifndef __HC32F4A0_OTS_H__
#define __HC32F4A0_OTS_H__

/* C binding of definitions if building with C++ compiler */
#ifdef __cplusplus
extern "C"
{
#endif

/*******************************************************************************
 * Include files
 ******************************************************************************/
#include "hc32_common.h"
#include "ddl_config.h"

/**
 * @addtogroup HC32F4A0_DDL_Driver
 * @{
 */

/**
 * @addtogroup DDL_OTS
 * @{
 */

#if (DDL_OTS_ENABLE == DDL_ON)

/*******************************************************************************
 * Global type definitions ('typedef')
 ******************************************************************************/
/**
 * @defgroup OTS_Global_Types OTS Global Types
 * @{
 */

/**
 * @brief Conditions for default parameters(slope K and offset M).
 * @note 'u8T1' CANNOT equal 'u8T2'.
 */
typedef struct
{
    uint16_t u16ClkFreq;                    /*!< Frequency(MHz) of clock sources that OTS is going to use. */
    uint8_t u8T1;                           /*!< Temperature value T1 for the default parameter.
                                                 This parameter can be a value of @ref OTS_Temp_Condition */
    uint8_t u8T2;                           /*!< Temperature value T2 for the default parameter.
                                                 This parameter can be a value of @ref OTS_Temp_Condition */
} stc_para_cond_t;

/**
 * @brief OTS initialization structure.
 */
typedef struct
{
    uint16_t u16ClkSrc;                     /*!< Specifies clock source for OTS.
                                                 This parameter can be a value of @ref OTS_Clock_Source */
    float32_t f32SlopeK;                    /*!< K: Temperature slope (calculated by calibration experiment). \
                                                 When you want to use the default parameters(slope K and offset M), specify it as ZERO. */
    float32_t f32OffsetM;                   /*!< M: Temperature offset (calculated by calibration experiment). \
                                                 When you want to use the default parameters(slope K and offset M), specify it as ZERO. */
    uint16_t u16AutoOffEn;                  /*!< OTS automatic-off function control.
                                                 This parameter can be a value of @ref OTS_Automatic_Off_Ctrl */
    stc_para_cond_t stcParaCond;            /*!< Specify the conditions when you want to use the default parameters(slope K and offset M). */
} stc_ots_init_t;

/**
 * @}
 */

/*******************************************************************************
 * Global pre-processor symbols/macros ('#define')
 ******************************************************************************/
/**
 * @defgroup OTS_Global_Macros OTS Global Macros
 * @{
 */

/**
 * @defgroup OTS_Clock_Source OTS Clock Source
 * @{
 */
#define OTS_CLK_XTAL                    (0x0U)              /*!< Select XTAL as OTS clock. */
#define OTS_CLK_HRC                     (OTS_CTL_OTSCK)     /*!< Select HRC as OTS clock */
/**
 * @}
 */

/**
 * @defgroup OTS_Automatic_Off_Ctrl OTS Automatic Off Control
 * @{
 */
#define OTS_AUTO_OFF_DISABLE            (0x0U)
#define OTS_AUTO_OFF_ENABLE             (OTS_CTL_TSSTP)
/**
 * @}
 */

/**
 * @defgroup OTS_Temp_Condition OTS Temperature Condition For Default Parameters(slope K and offset M)
 * @{
 */
#define OTS_COND_TN40                   (0U)                /*!< -40 degrees Celsius. */
#define OTS_COND_T25                    (1U)                /*!< 25 degrees Celsius. */
#define OTS_COND_T125                   (2U)                /*!< 125 degrees Celsius. */
/**
 * @}
 */

/**
 * @defgroup OTS_Common_Trigger_Sel OTS Common Trigger Source Select
 * @{
 */
#define OTS_COM_TRIG1                   (AOS_OTS_TRG_COMTRG_EN_0)
#define OTS_COM_TRIG2                   (AOS_OTS_TRG_COMTRG_EN_1)
/**
 * @}
 */

/**
 * @}
 */

/*******************************************************************************
 * Global variable definitions ('extern')
 ******************************************************************************/

/*******************************************************************************
  Global function prototypes (definition in C source)
 ******************************************************************************/
/**
 * @addtogroup OTS_Global_Functions
 * @{
 */

/**
 * @brief  Start OTS.
 * @param  None
 * @retval None
 */
__STATIC_INLINE void OTS_Start(void)
{
    bM4_OTS->CTL_b.OTSST = (uint32_t)1U;
}

/**
 * @brief  Stop OTS.
 * @param  None
 * @retval None
 */
__STATIC_INLINE void OTS_Stop(void)
{
    bM4_OTS->CTL_b.OTSST = (uint32_t)0U;
}

en_result_t OTS_Init(const stc_ots_init_t *pstcInit);
en_result_t OTS_StructInit(stc_ots_init_t *pstcInit);
void OTS_DeInit(void);

en_result_t OTS_Polling(float32_t *pf32Temp, uint32_t u32Timeout);

void OTS_IntCmd(en_functional_state_t enNewState);
void OTS_SetTriggerSrc(en_event_src_t enEvent);
void OTS_ComTriggerCmd(uint32_t u32ComTrig, en_functional_state_t enNewState);

en_result_t OTS_ScalingExperiment(uint16_t *pu16Dr1, uint16_t *pu16Dr2, \
                                  uint16_t *pu16Ecr, float32_t *pf32A,  \
                                  uint32_t u32Timeout);

float OTS_CalculateTemp(void);

/**
 * @}
 */

#endif /* DDL_OTS_ENABLE */

/**
 * @}
 */

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif /* __HC32F4A0_OTS_H__ */

/*******************************************************************************
 * EOF (not truncated)
 ******************************************************************************/