/**
 *******************************************************************************
 * @file  hc32_ll_dbgc.h
 * @brief This file contains all the functions prototypes of the DBGC driver
 *        library.
 @verbatim
   Change Logs:
   Date             Author          Notes
   2022-12-31       CDT             First version
 @endverbatim
 *******************************************************************************
 * Copyright (C) 2022, Xiaohua Semiconductor Co., Ltd. All rights reserved.
 *
 * This software component is licensed by XHSC 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 __HC32_LL_DBGC_H__
#define __HC32_LL_DBGC_H__

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

/*******************************************************************************
 * Include files
 ******************************************************************************/
#include "hc32_ll_def.h"

#include "hc32f4xx.h"
#include "hc32f4xx_conf.h"
/**
 * @addtogroup LL_Driver
 * @{
 */

/**
 * @addtogroup LL_DBGC
 * @{
 */

#if (LL_DBGC_ENABLE == DDL_ON)

/*******************************************************************************
 * Global type definitions ('typedef')
 ******************************************************************************/
/**
a * @defgroup DBGC_Global_Types DAC Global Types
 * @{
 */

/**
 * @brief DBGC authenticate ID definition
 */
typedef struct {
    uint32_t            u32AuthID0;     /*!< auth ID 0.       */
    uint32_t            u32AuthID1;     /*!< auth ID 1.       */
    uint32_t            u32AuthID2;     /*!< auth ID 2.       */
} stc_dbgc_auth_id_t;
/**
 * @}
 */

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

/**
 * @defgroup DBGC_MCU_Status DBGC MCU Status
 * @{
 */
#define DBGC_MCU_LVL1_FREE_LVL2_FREE        (0x00UL)
#define DBGC_MCU_LVL1_LOCK_LVL2_FREE        (DBGC_MCUSTAT_SAFTYLOCK1)
#define DBGC_MCU_LVL1_UNLOCK_LVL2_FREE      (DBGC_MCUSTAT_SAFTYLOCK1 | DBGC_MCUSTAT_AUTH)
#define DBGC_MCU_LVL1_FREE_LVL2_LOCK        (DBGC_MCUSTAT_SAFTYLOCK2)
#define DBGC_MCU_LVL1_LOCK_LVL2_LOCK        (DBGC_MCUSTAT_SAFTYLOCK1 | DBGC_MCUSTAT_SAFTYLOCK2)
#define DBGC_MCU_LVL1_UNLOCK_LVL2_LOCK      (DBGC_MCUSTAT_SAFTYLOCK1 | DBGC_MCUSTAT_AUTH | DBGC_MCUSTAT_SAFTYLOCK2)

/**
 * @}
 */

/**
 * @defgroup DBGC_Periph_Sel DBGC Periph Selection
 * @{
 */
#define DBGC_PERIPH_SWDT                    (DBGC_MCUSTPCTL_SWDTSTP)
#define DBGC_PERIPH_WDT                     (DBGC_MCUSTPCTL_WDTSTP )
#define DBGC_PERIPH_RTC                     (DBGC_MCUSTPCTL_RTCSTP )
#define DBGC_PERIPH_LVD1                    (DBGC_MCUSTPCTL_PVD1STP)
#define DBGC_PERIPH_LVD2                    (DBGC_MCUSTPCTL_PVD2STP)
#define DBGC_PERIPH_TMR0_1                  (DBGC_MCUSTPCTL_M06STP)
#define DBGC_PERIPH_TMR0_2                  (DBGC_MCUSTPCTL_M07STP)
#define DBGC_PERIPH_TMR4_1                  (DBGC_MCUSTPCTL_M12STP)
#define DBGC_PERIPH_TMR4_2                  (DBGC_MCUSTPCTL_M13STP)
#define DBGC_PERIPH_TMR4_3                  (DBGC_MCUSTPCTL_M14STP)
#define DBGC_PERIPH_TMR6_1                  (DBGC_MCUSTPCTL_M15STP)
#define DBGC_PERIPH_TMR6_2                  (DBGC_MCUSTPCTL_M16STP)
/**
 * @}
 */

/**
 * @defgroup DBGC_Periph2_Sel DBGC Periph2 Selection
 * @{
 */
#define DBGC_PERIPH_TMRA_1                  (DBGC_MCUSTPCTL2_M23STP)
#define DBGC_PERIPH_TMRA_2                  (DBGC_MCUSTPCTL2_M24STP)
#define DBGC_PERIPH_TMRA_3                  (DBGC_MCUSTPCTL2_M25STP)
#define DBGC_PERIPH_TMRA_4                  (DBGC_MCUSTPCTL2_M26STP)
#define DBGC_PERIPH_TMRA_5                  (DBGC_MCUSTPCTL2_M27STP)
/**
 * @}
 */

/**
 * @}
 */

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

/*******************************************************************************
  Global function prototypes (definition in C source)
 ******************************************************************************/
/**
 * @addtogroup DBGC_Global_Functions
 * @{
 */
uint32_t DBGC_GetMcuStatus(void);
int32_t DBGC_FlashErase(void);
void DBGC_GetAuthID(stc_dbgc_auth_id_t *pstcAuthID);
void DBGC_PeriphCmd(uint32_t u32Periph, en_functional_state_t enNewState);
void DBGC_Periph2Cmd(uint32_t u32Periph, en_functional_state_t enNewState);
uint32_t DBGC_GetChipID(void);
/**
 * @}
 */

#endif /* LL_DBGC_ENABLE */

/**
 * @}
 */

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif /* __HC32_LL_DBGC_H__ */

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