2017-08-22 15:52:57 +08:00
|
|
|
/*!
|
2021-06-09 16:24:20 +08:00
|
|
|
\file gd32f4xx_ctc.h
|
|
|
|
|
\brief definitions for the CTC
|
|
|
|
|
|
|
|
|
|
\version 2016-08-15, V1.0.0, firmware for GD32F4xx
|
|
|
|
|
\version 2018-12-12, V2.0.0, firmware for GD32F4xx
|
|
|
|
|
\version 2020-09-30, V2.1.0, firmware for GD32F4xx
|
2017-08-22 15:52:57 +08:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*
|
2021-06-09 16:24:20 +08:00
|
|
|
Copyright (c) 2020, GigaDevice Semiconductor Inc.
|
|
|
|
|
|
|
|
|
|
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 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 the copyright holder nor the names of its contributors
|
|
|
|
|
may be used to endorse or promote products derived from this software without
|
|
|
|
|
specific prior written permission.
|
|
|
|
|
|
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
|
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
|
|
|
IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
|
2017-08-22 15:52:57 +08:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef GD32F4XX_CTC_H
|
|
|
|
|
#define GD32F4XX_CTC_H
|
|
|
|
|
|
|
|
|
|
#include "gd32f4xx.h"
|
|
|
|
|
|
|
|
|
|
/* CTC definitions */
|
|
|
|
|
#define CTC CTC_BASE
|
|
|
|
|
|
|
|
|
|
/* registers definitions */
|
|
|
|
|
#define CTC_CTL0 REG32((CTC) + 0x00U) /*!< CTC control register 0 */
|
|
|
|
|
#define CTC_CTL1 REG32((CTC) + 0x04U) /*!< CTC control register 1 */
|
|
|
|
|
#define CTC_STAT REG32((CTC) + 0x08U) /*!< CTC status register */
|
|
|
|
|
#define CTC_INTC REG32((CTC) + 0x0CU) /*!< CTC interrupt clear register */
|
|
|
|
|
|
|
|
|
|
/* bits definitions */
|
|
|
|
|
/* CTC_CTL0 */
|
2021-06-09 16:24:20 +08:00
|
|
|
#define CTC_CTL0_CKOKIE BIT(0) /*!< clock trim OK(CKOKIF) interrupt enable */
|
2017-08-22 15:52:57 +08:00
|
|
|
#define CTC_CTL0_CKWARNIE BIT(1) /*!< clock trim warning(CKWARNIF) interrupt enable */
|
|
|
|
|
#define CTC_CTL0_ERRIE BIT(2) /*!< error(ERRIF) interrupt enable */
|
|
|
|
|
#define CTC_CTL0_EREFIE BIT(3) /*!< EREFIF interrupt enable */
|
|
|
|
|
#define CTC_CTL0_CNTEN BIT(5) /*!< CTC counter enable */
|
|
|
|
|
#define CTC_CTL0_AUTOTRIM BIT(6) /*!< hardware automatically trim mode */
|
|
|
|
|
#define CTC_CTL0_SWREFPUL BIT(7) /*!< software reference source sync pulse */
|
|
|
|
|
#define CTC_CTL0_TRIMVALUE BITS(8,13) /*!< IRC48M trim value */
|
|
|
|
|
|
|
|
|
|
/* CTC_CTL1 */
|
|
|
|
|
#define CTC_CTL1_RLVALUE BITS(0,15) /*!< CTC counter reload value */
|
|
|
|
|
#define CTC_CTL1_CKLIM BITS(16,23) /*!< clock trim base limit value */
|
|
|
|
|
#define CTC_CTL1_REFPSC BITS(24,26) /*!< reference signal source prescaler */
|
|
|
|
|
#define CTC_CTL1_REFSEL BITS(28,29) /*!< reference signal source selection */
|
|
|
|
|
#define CTC_CTL1_USBSOFSEL BIT(30) /*!< USBFS or USBHS SOF signal selection */
|
|
|
|
|
#define CTC_CTL1_REFPOL BIT(31) /*!< reference signal source polarity */
|
|
|
|
|
|
|
|
|
|
/* CTC_STAT */
|
|
|
|
|
#define CTC_STAT_CKOKIF BIT(0) /*!< clock trim OK interrupt flag */
|
|
|
|
|
#define CTC_STAT_CKWARNIF BIT(1) /*!< clock trim warning interrupt flag */
|
|
|
|
|
#define CTC_STAT_ERRIF BIT(2) /*!< error interrupt flag */
|
|
|
|
|
#define CTC_STAT_EREFIF BIT(3) /*!< expect reference interrupt flag */
|
|
|
|
|
#define CTC_STAT_CKERR BIT(8) /*!< clock trim error bit */
|
|
|
|
|
#define CTC_STAT_REFMISS BIT(9) /*!< reference sync pulse miss */
|
|
|
|
|
#define CTC_STAT_TRIMERR BIT(10) /*!< trim value error bit */
|
|
|
|
|
#define CTC_STAT_REFDIR BIT(15) /*!< CTC trim counter direction when reference sync pulse occurred */
|
|
|
|
|
#define CTC_STAT_REFCAP BITS(16,31) /*!< CTC counter capture when reference sync pulse occurred */
|
|
|
|
|
|
|
|
|
|
/* CTC_INTC */
|
|
|
|
|
#define CTC_INTC_CKOKIC BIT(0) /*!< CKOKIF interrupt clear bit */
|
|
|
|
|
#define CTC_INTC_CKWARNIC BIT(1) /*!< CKWARNIF interrupt clear bit */
|
|
|
|
|
#define CTC_INTC_ERRIC BIT(2) /*!< ERRIF interrupt clear bit */
|
|
|
|
|
#define CTC_INTC_EREFIC BIT(3) /*!< EREFIF interrupt clear bit */
|
|
|
|
|
|
|
|
|
|
/* constants definitions */
|
|
|
|
|
/* hardware automatically trim mode definitions */
|
|
|
|
|
#define CTC_HARDWARE_TRIM_MODE_ENABLE CTC_CTL0_AUTOTRIM /*!< hardware automatically trim mode enable*/
|
|
|
|
|
#define CTC_HARDWARE_TRIM_MODE_DISABLE ((uint32_t)0x00000000U) /*!< hardware automatically trim mode disable*/
|
|
|
|
|
|
|
|
|
|
/* reference signal source polarity definitions */
|
|
|
|
|
#define CTC_REFSOURCE_POLARITY_FALLING CTC_CTL1_REFPOL /*!< reference signal source polarity is falling edge*/
|
|
|
|
|
#define CTC_REFSOURCE_POLARITY_RISING ((uint32_t)0x00000000U) /*!< reference signal source polarity is rising edge*/
|
|
|
|
|
|
|
|
|
|
/* USBFS or USBHS SOF signal selection definitions */
|
|
|
|
|
#define CTC_USBSOFSEL_USBHS CTC_CTL1_USBSOFSEL /*!< USBHS SOF signal is selected*/
|
|
|
|
|
#define CTC_USBSOFSEL_USBFS ((uint32_t)0x00000000U) /*!< USBFS SOF signal is selected*/
|
|
|
|
|
|
|
|
|
|
/* reference signal source selection definitions */
|
|
|
|
|
#define CTL1_REFSEL(regval) (BITS(28,29) & ((uint32_t)(regval) << 28))
|
|
|
|
|
#define CTC_REFSOURCE_GPIO CTL1_REFSEL(0) /*!< GPIO is selected */
|
|
|
|
|
#define CTC_REFSOURCE_LXTAL CTL1_REFSEL(1) /*!< LXTAL is clock selected */
|
|
|
|
|
#define CTC_REFSOURCE_USBSOF CTL1_REFSEL(2) /*!< USBSOF is selected */
|
|
|
|
|
|
|
|
|
|
/* reference signal source prescaler definitions */
|
|
|
|
|
#define CTL1_REFPSC(regval) (BITS(24,26) & ((uint32_t)(regval) << 24))
|
|
|
|
|
#define CTC_REFSOURCE_PSC_OFF CTL1_REFPSC(0) /*!< reference signal not divided */
|
|
|
|
|
#define CTC_REFSOURCE_PSC_DIV2 CTL1_REFPSC(1) /*!< reference signal divided by 2 */
|
|
|
|
|
#define CTC_REFSOURCE_PSC_DIV4 CTL1_REFPSC(2) /*!< reference signal divided by 4 */
|
|
|
|
|
#define CTC_REFSOURCE_PSC_DIV8 CTL1_REFPSC(3) /*!< reference signal divided by 8 */
|
|
|
|
|
#define CTC_REFSOURCE_PSC_DIV16 CTL1_REFPSC(4) /*!< reference signal divided by 16 */
|
|
|
|
|
#define CTC_REFSOURCE_PSC_DIV32 CTL1_REFPSC(5) /*!< reference signal divided by 32 */
|
|
|
|
|
#define CTC_REFSOURCE_PSC_DIV64 CTL1_REFPSC(6) /*!< reference signal divided by 64 */
|
|
|
|
|
#define CTC_REFSOURCE_PSC_DIV128 CTL1_REFPSC(7) /*!< reference signal divided by 128 */
|
|
|
|
|
|
|
|
|
|
/* CTC interrupt enable definitions */
|
2021-06-09 16:24:20 +08:00
|
|
|
#define CTC_INT_CKOK CTC_CTL0_CKOKIE /*!< clock trim OK interrupt enable */
|
|
|
|
|
#define CTC_INT_CKWARN CTC_CTL0_CKWARNIE /*!< clock trim warning interrupt enable */
|
|
|
|
|
#define CTC_INT_ERR CTC_CTL0_ERRIE /*!< error interrupt enable */
|
|
|
|
|
#define CTC_INT_EREF CTC_CTL0_EREFIE /*!< expect reference interrupt enable */
|
2017-08-22 15:52:57 +08:00
|
|
|
|
|
|
|
|
/* CTC interrupt source definitions */
|
2021-06-09 16:24:20 +08:00
|
|
|
#define CTC_INT_FLAG_CKOK CTC_STAT_CKOKIF /*!< clock trim OK interrupt flag */
|
|
|
|
|
#define CTC_INT_FLAG_CKWARN CTC_STAT_CKWARNIF /*!< clock trim warning interrupt flag */
|
|
|
|
|
#define CTC_INT_FLAG_ERR CTC_STAT_ERRIF /*!< error interrupt flag */
|
|
|
|
|
#define CTC_INT_FLAG_EREF CTC_STAT_EREFIF /*!< expect reference interrupt flag */
|
|
|
|
|
#define CTC_INT_FLAG_CKERR CTC_STAT_CKERR /*!< clock trim error bit */
|
|
|
|
|
#define CTC_INT_FLAG_REFMISS CTC_STAT_REFMISS /*!< reference sync pulse miss */
|
|
|
|
|
#define CTC_INT_FLAG_TRIMERR CTC_STAT_TRIMERR /*!< trim value error */
|
2017-08-22 15:52:57 +08:00
|
|
|
|
|
|
|
|
/* CTC flag definitions */
|
|
|
|
|
#define CTC_FLAG_CKOK CTC_STAT_CKOKIF /*!< clock trim OK flag */
|
|
|
|
|
#define CTC_FLAG_CKWARN CTC_STAT_CKWARNIF /*!< clock trim warning flag */
|
|
|
|
|
#define CTC_FLAG_ERR CTC_STAT_ERRIF /*!< error flag */
|
|
|
|
|
#define CTC_FLAG_EREF CTC_STAT_EREFIF /*!< expect reference flag */
|
|
|
|
|
#define CTC_FLAG_CKERR CTC_STAT_CKERR /*!< clock trim error bit */
|
|
|
|
|
#define CTC_FLAG_REFMISS CTC_STAT_REFMISS /*!< reference sync pulse miss */
|
|
|
|
|
#define CTC_FLAG_TRIMERR CTC_STAT_TRIMERR /*!< trim value error bit */
|
|
|
|
|
|
|
|
|
|
/* function declarations */
|
|
|
|
|
/* reset ctc clock trim controller */
|
|
|
|
|
void ctc_deinit(void);
|
2021-06-09 16:24:20 +08:00
|
|
|
/* enable CTC trim counter */
|
|
|
|
|
void ctc_counter_enable(void);
|
|
|
|
|
/* disable CTC trim counter */
|
|
|
|
|
void ctc_counter_disable(void);
|
2017-08-22 15:52:57 +08:00
|
|
|
|
|
|
|
|
/* configure the IRC48M trim value */
|
2021-06-09 16:24:20 +08:00
|
|
|
void ctc_irc48m_trim_value_config(uint8_t trim_value);
|
2017-08-22 15:52:57 +08:00
|
|
|
/* generate software reference source sync pulse */
|
|
|
|
|
void ctc_software_refsource_pulse_generate(void);
|
|
|
|
|
/* configure hardware automatically trim mode */
|
2021-06-09 16:24:20 +08:00
|
|
|
void ctc_hardware_trim_mode_config(uint32_t hardmode);
|
2017-08-22 15:52:57 +08:00
|
|
|
|
|
|
|
|
/* configure reference signal source polarity */
|
2021-06-09 16:24:20 +08:00
|
|
|
void ctc_refsource_polarity_config(uint32_t polarity);
|
2017-08-22 15:52:57 +08:00
|
|
|
/* select USBFS or USBHS SOF signal */
|
2021-06-09 16:24:20 +08:00
|
|
|
void ctc_usbsof_signal_select(uint32_t usbsof);
|
2017-08-22 15:52:57 +08:00
|
|
|
/* select reference signal source */
|
2021-06-09 16:24:20 +08:00
|
|
|
void ctc_refsource_signal_select(uint32_t refs);
|
2017-08-22 15:52:57 +08:00
|
|
|
/* configure reference signal source prescaler */
|
2021-06-09 16:24:20 +08:00
|
|
|
void ctc_refsource_prescaler_config(uint32_t prescaler);
|
2017-08-22 15:52:57 +08:00
|
|
|
/* configure clock trim base limit value */
|
2021-06-09 16:24:20 +08:00
|
|
|
void ctc_clock_limit_value_config(uint8_t limit_value);
|
2017-08-22 15:52:57 +08:00
|
|
|
/* configure CTC counter reload value */
|
2021-06-09 16:24:20 +08:00
|
|
|
void ctc_counter_reload_value_config(uint16_t reload_value);
|
2017-08-22 15:52:57 +08:00
|
|
|
|
|
|
|
|
/* read CTC counter capture value when reference sync pulse occurred */
|
|
|
|
|
uint16_t ctc_counter_capture_value_read(void);
|
|
|
|
|
/* read CTC trim counter direction when reference sync pulse occurred */
|
|
|
|
|
FlagStatus ctc_counter_direction_read(void);
|
|
|
|
|
/* read CTC counter reload value */
|
|
|
|
|
uint16_t ctc_counter_reload_value_read(void);
|
|
|
|
|
/* read the IRC48M trim value */
|
|
|
|
|
uint8_t ctc_irc48m_trim_value_read(void);
|
|
|
|
|
|
2021-06-09 16:24:20 +08:00
|
|
|
/* interrupt & flag functions */
|
|
|
|
|
/* enable the CTC interrupt */
|
|
|
|
|
void ctc_interrupt_enable(uint32_t interrupt);
|
|
|
|
|
/* disable the CTC interrupt */
|
|
|
|
|
void ctc_interrupt_disable(uint32_t interrupt);
|
|
|
|
|
/* get CTC interrupt flag */
|
|
|
|
|
FlagStatus ctc_interrupt_flag_get(uint32_t int_flag);
|
|
|
|
|
/* clear CTC interrupt flag */
|
|
|
|
|
void ctc_interrupt_flag_clear(uint32_t int_flag);
|
|
|
|
|
/* get CTC flag */
|
|
|
|
|
FlagStatus ctc_flag_get(uint32_t flag);
|
|
|
|
|
/* clear CTC flag */
|
|
|
|
|
void ctc_flag_clear(uint32_t flag);
|
|
|
|
|
|
2017-08-22 15:52:57 +08:00
|
|
|
#endif /* GD32F4XX_CTC_H */
|
