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
@@ -556,7 +556,7 @@ typedef enum _mcg_monitor_mode
556
556
kMCG_MonitorReset /*!< System reset when clock lost. */
557
557
} mcg_monitor_mode_t ;
558
558
559
- /*! @brief MCG status. */
559
+ /*! @brief MCG status. Enumeration _mcg_status */
560
560
enum
561
561
{
562
562
kStatus_MCG_ModeUnreachable = MAKE_STATUS (kStatusGroup_MCG , 0U ), /*!< Can't switch to target mode. */
570
570
it is in use. */
571
571
};
572
572
573
- /*! @brief MCG status flags. */
573
+ /*! @brief MCG status flags. Enumeration _mcg_status_flags_t */
574
574
enum
575
575
{
576
576
kMCG_Osc0LostFlag = (1U << 0U ), /*!< OSC0 lost. */
@@ -580,14 +580,14 @@ enum
580
580
kMCG_Pll0LockFlag = (1U << 6U ), /*!< PLL0 locked. */
581
581
};
582
582
583
- /*! @brief MCG internal reference clock (MCGIRCLK) enable mode definition. */
583
+ /*! @brief MCG internal reference clock (MCGIRCLK) enable mode definition. Enumeration _mcg_irclk_enable_mode */
584
584
enum
585
585
{
586
586
kMCG_IrclkEnable = MCG_C1_IRCLKEN_MASK , /*!< MCGIRCLK enable. */
587
587
kMCG_IrclkEnableInStop = MCG_C1_IREFSTEN_MASK /*!< MCGIRCLK enable in stop mode. */
588
588
};
589
589
590
- /*! @brief MCG PLL clock enable mode definition. */
590
+ /*! @brief MCG PLL clock enable mode definition. Enumeration _mcg_pll_enable_mode */
591
591
enum
592
592
{
593
593
kMCG_PllEnableIndependent = MCG_C5_PLLCLKEN0_MASK , /*!< MCGPLLCLK enable independent of the
@@ -616,7 +616,7 @@ typedef enum _mcg_mode
616
616
/*! @brief MCG PLL configuration. */
617
617
typedef struct _mcg_pll_config
618
618
{
619
- uint8_t enableMode ; /*!< Enable mode. OR'ed value of @ref _mcg_pll_enable_mode. */
619
+ uint8_t enableMode ; /*!< Enable mode. OR'ed value of enumeration _mcg_pll_enable_mode. */
620
620
uint8_t prdiv ; /*!< Reference divider PRDIV. */
621
621
uint8_t vdiv ; /*!< VCO divider VDIV. */
622
622
} mcg_pll_config_t ;
@@ -885,7 +885,6 @@ void CLOCK_SetSimConfig(sim_clock_config_t const *config);
885
885
* be used before MCG mode change, to make sure system level clocks are in allowed
886
886
* range.
887
887
*
888
- * @param config Pointer to the configure structure.
889
888
*/
890
889
static inline void CLOCK_SetSimSafeDivs (void )
891
890
{
@@ -982,7 +981,7 @@ static inline void CLOCK_SetLowPowerEnable(bool enable)
982
981
* Calling this function in FBI/PBI/BLPI modes may change the system clock. As a result,
983
982
* using the function in these modes it is not allowed.
984
983
*
985
- * @param enableMode MCGIRCLK enable mode, OR'ed value of @ref _mcg_irclk_enable_mode.
984
+ * @param enableMode MCGIRCLK enable mode, OR'ed value of the enumeration _mcg_irclk_enable_mode.
986
985
* @param ircs MCGIRCLK clock source, choose fast or slow.
987
986
* @param fcrdiv Fast IRC divider setting (\c FCRDIV).
988
987
* @retval kStatus_MCG_SourceUsed Because the internal reference clock is used as a clock source,
@@ -1094,7 +1093,7 @@ void CLOCK_SetPll0MonitorMode(mcg_monitor_mode_t mode);
1094
1093
* @brief Gets the MCG status flags.
1095
1094
*
1096
1095
* This function gets the MCG clock status flags. All status flags are
1097
- * returned as a logical OR of the enumeration @ref _mcg_status_flags_t. To
1096
+ * returned as a logical OR of the enumeration refer to _mcg_status_flags_t. To
1098
1097
* check a specific flag, compare the return value with the flag.
1099
1098
*
1100
1099
* Example:
@@ -1114,15 +1113,15 @@ void CLOCK_SetPll0MonitorMode(mcg_monitor_mode_t mode);
1114
1113
* }
1115
1114
* @endcode
1116
1115
*
1117
- * @return Logical OR value of the @ref _mcg_status_flags_t.
1116
+ * @return Logical OR value of the enumeration _mcg_status_flags_t.
1118
1117
*/
1119
1118
uint32_t CLOCK_GetStatusFlags (void );
1120
1119
1121
1120
/*!
1122
1121
* @brief Clears the MCG status flags.
1123
1122
*
1124
1123
* This function clears the MCG clock lock lost status. The parameter is a logical
1125
- * OR value of the flags to clear. See @ref _mcg_status_flags_t.
1124
+ * OR value of the flags to clear. See the enumeration _mcg_status_flags_t.
1126
1125
*
1127
1126
* Example:
1128
1127
* @code
@@ -1132,7 +1131,7 @@ uint32_t CLOCK_GetStatusFlags(void);
1132
1131
* @endcode
1133
1132
*
1134
1133
* @param mask The status flags to clear. This is a logical OR of members of the
1135
- * enumeration @ref _mcg_status_flags_t.
1134
+ * enumeration _mcg_status_flags_t.
1136
1135
*/
1137
1136
void CLOCK_ClearStatusFlags (uint32_t mask );
1138
1137
@@ -1506,7 +1505,7 @@ status_t CLOCK_BootToFeeMode(
1506
1505
*
1507
1506
* @param fcrdiv Fast IRC divider, FCRDIV.
1508
1507
* @param ircs The internal reference clock to select, IRCS.
1509
- * @param ircEnableMode The MCGIRCLK enable mode, OR'ed value of @ref _mcg_irclk_enable_mode.
1508
+ * @param ircEnableMode The MCGIRCLK enable mode, OR'ed value of the enumeration _mcg_irclk_enable_mode.
1510
1509
*
1511
1510
* @retval kStatus_MCG_SourceUsed Could not change MCGIRCLK setting.
1512
1511
* @retval kStatus_Success Switched to the target mode successfully.
@@ -1549,7 +1548,7 @@ status_t CLOCK_BootToPeeMode(mcg_oscsel_t oscsel, mcg_pll_clk_select_t pllcs, mc
1549
1548
* chooses the correct path.
1550
1549
*
1551
1550
* @param config Pointer to the target MCG mode configuration structure.
1552
- * @return Return kStatus_Success if switched successfully; Otherwise, it returns an error code # _mcg_status.
1551
+ * @return Return kStatus_Success if switched successfully; Otherwise, it returns an error code _mcg_status.
1553
1552
*
1554
1553
* @note If the external clock is used in the target mode, ensure that it is
1555
1554
* enabled. For example, if the OSC0 is used, set up OSC0 correctly before calling this
0 commit comments