1
1
/*
2
2
* Copyright (c) 2015, Freescale Semiconductor, Inc.
3
- * Copyright 2016 - 2019 , NXP
3
+ * Copyright 2016 - 2020 , NXP
4
4
* All rights reserved.
5
5
*
6
6
* SPDX-License-Identifier: BSD-3-Clause
@@ -581,7 +581,7 @@ typedef enum _mcg_monitor_mode
581
581
kMCG_MonitorReset /*!< System reset when clock lost. */
582
582
} mcg_monitor_mode_t ;
583
583
584
- /*! @brief MCG status. */
584
+ /*! @brief MCG status. Enumeration _mcg_status */
585
585
enum
586
586
{
587
587
kStatus_MCG_ModeUnreachable = MAKE_STATUS (kStatusGroup_MCG , 0U ), /*!< Can't switch to target mode. */
595
595
it is in use. */
596
596
};
597
597
598
- /*! @brief MCG status flags. */
598
+ /*! @brief MCG status flags. Enumeration _mcg_status_flags_t */
599
599
enum
600
600
{
601
601
kMCG_Osc0LostFlag = (1U << 0U ), /*!< OSC0 lost. */
@@ -605,14 +605,14 @@ enum
605
605
kMCG_Pll0LockFlag = (1U << 6U ), /*!< PLL0 locked. */
606
606
};
607
607
608
- /*! @brief MCG internal reference clock (MCGIRCLK) enable mode definition. */
608
+ /*! @brief MCG internal reference clock (MCGIRCLK) enable mode definition. Enumeration _mcg_irclk_enable_mode */
609
609
enum
610
610
{
611
611
kMCG_IrclkEnable = MCG_C1_IRCLKEN_MASK , /*!< MCGIRCLK enable. */
612
612
kMCG_IrclkEnableInStop = MCG_C1_IREFSTEN_MASK /*!< MCGIRCLK enable in stop mode. */
613
613
};
614
614
615
- /*! @brief MCG PLL clock enable mode definition. */
615
+ /*! @brief MCG PLL clock enable mode definition. Enumeration _mcg_pll_enable_mode */
616
616
enum
617
617
{
618
618
kMCG_PllEnableIndependent = MCG_C5_PLLCLKEN0_MASK , /*!< MCGPLLCLK enable independent of the
@@ -641,7 +641,7 @@ typedef enum _mcg_mode
641
641
/*! @brief MCG PLL configuration. */
642
642
typedef struct _mcg_pll_config
643
643
{
644
- uint8_t enableMode ; /*!< Enable mode. OR'ed value of @ref _mcg_pll_enable_mode. */
644
+ uint8_t enableMode ; /*!< Enable mode. OR'ed value of enumeration _mcg_pll_enable_mode. */
645
645
uint8_t prdiv ; /*!< Reference divider PRDIV. */
646
646
uint8_t vdiv ; /*!< VCO divider VDIV. */
647
647
} mcg_pll_config_t ;
@@ -771,6 +771,8 @@ static inline void CLOCK_SetFlexio0Clock(uint32_t src)
771
771
* @brief Set debug trace clock source.
772
772
*
773
773
* @param src The value to set debug trace clock source.
774
+ * @param divValue Trace clock divider divisor.
775
+ * @param fracValue Trace clock divider fraction.
774
776
*/
775
777
static inline void CLOCK_SetTraceClock (uint32_t src , uint32_t divValue , uint32_t fracValue )
776
778
{
@@ -947,7 +949,6 @@ void CLOCK_SetSimConfig(sim_clock_config_t const *config);
947
949
* be used before MCG mode change, to make sure system level clocks are in allowed
948
950
* range.
949
951
*
950
- * @param config Pointer to the configure structure.
951
952
*/
952
953
static inline void CLOCK_SetSimSafeDivs (void )
953
954
{
@@ -1044,7 +1045,7 @@ static inline void CLOCK_SetLowPowerEnable(bool enable)
1044
1045
* Calling this function in FBI/PBI/BLPI modes may change the system clock. As a result,
1045
1046
* using the function in these modes it is not allowed.
1046
1047
*
1047
- * @param enableMode MCGIRCLK enable mode, OR'ed value of @ref _mcg_irclk_enable_mode.
1048
+ * @param enableMode MCGIRCLK enable mode, OR'ed value of the enumeration _mcg_irclk_enable_mode.
1048
1049
* @param ircs MCGIRCLK clock source, choose fast or slow.
1049
1050
* @param fcrdiv Fast IRC divider setting (\c FCRDIV).
1050
1051
* @retval kStatus_MCG_SourceUsed Because the internal reference clock is used as a clock source,
@@ -1156,7 +1157,7 @@ void CLOCK_SetPll0MonitorMode(mcg_monitor_mode_t mode);
1156
1157
* @brief Gets the MCG status flags.
1157
1158
*
1158
1159
* This function gets the MCG clock status flags. All status flags are
1159
- * returned as a logical OR of the enumeration @ref _mcg_status_flags_t. To
1160
+ * returned as a logical OR of the enumeration refer to _mcg_status_flags_t. To
1160
1161
* check a specific flag, compare the return value with the flag.
1161
1162
*
1162
1163
* Example:
@@ -1176,15 +1177,15 @@ void CLOCK_SetPll0MonitorMode(mcg_monitor_mode_t mode);
1176
1177
* }
1177
1178
* @endcode
1178
1179
*
1179
- * @return Logical OR value of the @ref _mcg_status_flags_t.
1180
+ * @return Logical OR value of the enumeration _mcg_status_flags_t.
1180
1181
*/
1181
1182
uint32_t CLOCK_GetStatusFlags (void );
1182
1183
1183
1184
/*!
1184
1185
* @brief Clears the MCG status flags.
1185
1186
*
1186
1187
* This function clears the MCG clock lock lost status. The parameter is a logical
1187
- * OR value of the flags to clear. See @ref _mcg_status_flags_t.
1188
+ * OR value of the flags to clear. See the enumeration _mcg_status_flags_t.
1188
1189
*
1189
1190
* Example:
1190
1191
* @code
@@ -1194,7 +1195,7 @@ uint32_t CLOCK_GetStatusFlags(void);
1194
1195
* @endcode
1195
1196
*
1196
1197
* @param mask The status flags to clear. This is a logical OR of members of the
1197
- * enumeration @ref _mcg_status_flags_t.
1198
+ * enumeration _mcg_status_flags_t.
1198
1199
*/
1199
1200
void CLOCK_ClearStatusFlags (uint32_t mask );
1200
1201
@@ -1570,7 +1571,7 @@ status_t CLOCK_BootToFeeMode(
1570
1571
*
1571
1572
* @param fcrdiv Fast IRC divider, FCRDIV.
1572
1573
* @param ircs The internal reference clock to select, IRCS.
1573
- * @param ircEnableMode The MCGIRCLK enable mode, OR'ed value of @ref _mcg_irclk_enable_mode.
1574
+ * @param ircEnableMode The MCGIRCLK enable mode, OR'ed value of the enumeration _mcg_irclk_enable_mode.
1574
1575
*
1575
1576
* @retval kStatus_MCG_SourceUsed Could not change MCGIRCLK setting.
1576
1577
* @retval kStatus_Success Switched to the target mode successfully.
@@ -1613,7 +1614,7 @@ status_t CLOCK_BootToPeeMode(mcg_oscsel_t oscsel, mcg_pll_clk_select_t pllcs, mc
1613
1614
* chooses the correct path.
1614
1615
*
1615
1616
* @param config Pointer to the target MCG mode configuration structure.
1616
- * @return Return kStatus_Success if switched successfully; Otherwise, it returns an error code # _mcg_status.
1617
+ * @return Return kStatus_Success if switched successfully; Otherwise, it returns an error code _mcg_status.
1617
1618
*
1618
1619
* @note If the external clock is used in the target mode, ensure that it is
1619
1620
* enabled. For example, if the OSC0 is used, set up OSC0 correctly before calling this
0 commit comments