fix(Examples,PeriphDrivers): Update TMR Clock Source names to be cons…

…istent with the User Guides (#956)
analogdevicesinc · Mar 20, 2024 · 7ee1fd3 · 7ee1fd3
1 parent bd92bea
commit 7ee1fd3
Show file tree

Hide file tree

Showing 26 changed files with 231 additions and 163 deletions.
diff --git a/Examples/MAX32655/TMR/main.c b/Examples/MAX32655/TMR/main.c
@@ -47,9 +47,9 @@
 #define PB2 1
 
 // Parameters for PWM output
-#define OST_CLOCK_SOURCE MXC_TMR_32K_CLK // \ref mxc_tmr_clock_t
+#define OST_CLOCK_SOURCE MXC_TMR_ERTCO_CLK // \ref mxc_tmr_clock_t
 #define PWM_CLOCK_SOURCE MXC_TMR_APB_CLK // \ref mxc_tmr_clock_t
-#define CONT_CLOCK_SOURCE MXC_TMR_8M_CLK // \ref mxc_tmr_clock_t
+#define CONT_CLOCK_SOURCE MXC_TMR_IBRO_CLK // \ref mxc_tmr_clock_t
 
 // Parameters for Continuous timer
 #define OST_FREQ 1 // (Hz)

diff --git a/Examples/MAX32662/TMR/main.c b/Examples/MAX32662/TMR/main.c
@@ -40,8 +40,8 @@
 //#define SLEEP_MODE          // Uncomment to enable sleep mode
 
 // Parameters for PWM output
-#define OST_CLOCK_SOURCE MXC_TMR_32M_CLK // \ref mxc_tmr_clock_t
-#define PWM_CLOCK_SOURCE MXC_TMR_8M_CLK // \ref mxc_tmr_clock_t
+#define OST_CLOCK_SOURCE MXC_TMR_ERFO_CLK // \ref mxc_tmr_clock_t
+#define PWM_CLOCK_SOURCE MXC_TMR_IBRO_CLK // \ref mxc_tmr_clock_t
 #define CONT_CLOCK_SOURCE MXC_TMR_APB_CLK // \ref mxc_tmr_clock_t
 
 // Parameters for Continuous timer

diff --git a/Examples/MAX32670/TMR/main.c b/Examples/MAX32670/TMR/main.c
@@ -39,7 +39,7 @@
 /***** Definitions *****/
 
 // Parameters for PWM output
-#define CLOCK_SOURCE MXC_TMR_8M_CLK // must be mxc_tmr_clock_t
+#define CLOCK_SOURCE MXC_TMR_IBRO_CLK // must be mxc_tmr_clock_t
 
 // Parameters for Continuous timer
 #define OST_FREQ 1 // (Hz)

diff --git a/Examples/MAX32672/TMR/main.c b/Examples/MAX32672/TMR/main.c
@@ -40,7 +40,7 @@
 /***** Definitions *****/
 
 // Parameters for PWM output
-#define CLOCK_SOURCE MXC_TMR_8M_CLK // must be mxc_tmr_clock_t
+#define CLOCK_SOURCE MXC_TMR_IBRO_CLK // must be mxc_tmr_clock_t
 
 // Parameters for Continuous timer
 #define OST_FREQ 1 // (Hz)

diff --git a/Examples/MAX32675/TMR/main.c b/Examples/MAX32675/TMR/main.c
@@ -39,7 +39,7 @@
 /***** Definitions *****/
 
 // Parameters for PWM output
-#define CLOCK_SOURCE MXC_TMR_8M_CLK // must be mxc_tmr_clock_t
+#define CLOCK_SOURCE MXC_TMR_IBRO_CLK // must be mxc_tmr_clock_t
 
 // Parameters for Continuous timer
 #define OST_FREQ 1 // (Hz)

diff --git a/Examples/MAX32680/TMR/main.c b/Examples/MAX32680/TMR/main.c
@@ -47,9 +47,9 @@
 #define PB2 1
 
 // Parameters for PWM output
-#define OST_CLOCK_SOURCE MXC_TMR_32K_CLK // \ref mxc_tmr_clock_t
+#define OST_CLOCK_SOURCE MXC_TMR_ISO_CLK // \ref mxc_tmr_clock_t
 #define PWM_CLOCK_SOURCE MXC_TMR_APB_CLK // \ref mxc_tmr_clock_t
-#define CONT_CLOCK_SOURCE MXC_TMR_8M_CLK // \ref mxc_tmr_clock_t
+#define CONT_CLOCK_SOURCE MXC_TMR_IBRO_CLK // \ref mxc_tmr_clock_t
 
 // Parameters for Continuous timer
 #define OST_FREQ 1 // (Hz)

diff --git a/Examples/MAX32690/TMR/main.c b/Examples/MAX32690/TMR/main.c
@@ -47,8 +47,8 @@
 #define SLEEP_MODE // Select between SLEEP_MODE and LP_MODE for LPTIMER
 
 // Parameters for PWM output
-#define OST_CLOCK_SOURCE MXC_TMR_8M_CLK // \ref mxc_tmr_clock_t
-#define PWM_CLOCK_SOURCE MXC_TMR_60M_CLK // \ref mxc_tmr_clock_t
+#define OST_CLOCK_SOURCE MXC_TMR_IBRO_CLK // \ref mxc_tmr_clock_t
+#define PWM_CLOCK_SOURCE MXC_TMR_ISO_CLK // \ref mxc_tmr_clock_t
 #define CONT_CLOCK_SOURCE MXC_TMR_APB_CLK // \ref mxc_tmr_clock_t
 
 // Parameters for Continuous timer

diff --git a/Examples/MAX78000/TMR/main.c b/Examples/MAX78000/TMR/main.c
@@ -50,9 +50,9 @@
 #define PB2 1
 
 // Parameters for PWM output
-#define OST_CLOCK_SOURCE MXC_TMR_8K_CLK // \ref mxc_tmr_clock_t
-#define PWM_CLOCK_SOURCE MXC_TMR_32K_CLK // \ref mxc_tmr_clock_t
-#define CONT_CLOCK_SOURCE MXC_TMR_8M_CLK // \ref mxc_tmr_clock_t
+#define OST_CLOCK_SOURCE MXC_TMR_INRO_CLK // \ref mxc_tmr_clock_t
+#define PWM_CLOCK_SOURCE MXC_TMR_ERTCO_CLK // \ref mxc_tmr_clock_t
+#define CONT_CLOCK_SOURCE MXC_TMR_IBRO_CLK // \ref mxc_tmr_clock_t
 
 // Parameters for Continuous timer
 #define OST_FREQ 1 // (Hz)

diff --git a/Examples/MAX78002/TMR/main.c b/Examples/MAX78002/TMR/main.c
@@ -44,9 +44,9 @@
 #define PB2 1
 
 // Parameters for PWM output
-#define OST_CLOCK_SOURCE MXC_TMR_32K_CLK // \ref mxc_tmr_clock_t
+#define OST_CLOCK_SOURCE MXC_TMR_ERTCO_CLK // \ref mxc_tmr_clock_t
 #define PWM_CLOCK_SOURCE MXC_TMR_APB_CLK // \ref mxc_tmr_clock_t
-#define CONT_CLOCK_SOURCE MXC_TMR_8M_CLK // \ref mxc_tmr_clock_t
+#define CONT_CLOCK_SOURCE MXC_TMR_IBRO_CLK // \ref mxc_tmr_clock_t
 
 // Parameters for Continuous timer
 #define OST_FREQ 1 // (Hz)

diff --git a/Libraries/PeriphDrivers/Include/MAX32655/tmr.h b/Libraries/PeriphDrivers/Include/MAX32655/tmr.h
@@ -140,15 +140,22 @@ typedef enum {
  * @brief      Peripheral Clock settings 
  */
 typedef enum {
-    MXC_TMR_APB_CLK = 0,
-    MXC_TMR_EXT_CLK,
+    MXC_TMR_APB_CLK = 0, /**< PCLK */
+    MXC_TMR_EXT_CLK = 1, /**< External Clock */
+    MXC_TMR_ISO_CLK = 2, /**< 60MHz Clock */
+    MXC_TMR_IBRO_CLK = 3, /**< 7.3728MHz Clock */
+    MXC_TMR_ERTCO_CLK = 4, /**< 32.768KHz Clock */
+    MXC_TMR_INRO_CLK = 5, /**< 8-30KHz Clock */
+    MXC_TMR_IBRO_DIV8_CLK = 6, /**< (7.3728/8)MHz Clock */
+
+    // Legacy names
     /*8M and 60M clocks can be used for Timers 0,1,2 and 3*/
-    MXC_TMR_32M_CLK,
-    MXC_TMR_8M_CLK,
+    MXC_TMR_32M_CLK, // Not supported as TMR clock source
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK,
     /*32K clock can be used for Timers 0,1,2,3 and 4*/
-    MXC_TMR_32K_CLK,
+    MXC_TMR_32K_CLK = MXC_TMR_ERTCO_CLK,
     /*8K and EXT clocks can only be used for Timers 4 and 5*/
-    MXC_TMR_8K_CLK,
+    MXC_TMR_8K_CLK = MXC_TMR_INRO_CLK,
 } mxc_tmr_clock_t;
 
 /**

diff --git a/Libraries/PeriphDrivers/Include/MAX32662/tmr.h b/Libraries/PeriphDrivers/Include/MAX32662/tmr.h
@@ -141,16 +141,22 @@ typedef enum {
  * @brief      Peripheral Clock settings 
  */
 typedef enum {
-    MXC_TMR_APB_CLK = 0,
-    MXC_TMR_EXT_CLK,
+    MXC_TMR_APB_CLK = 0, /**< PCLK */
+    MXC_TMR_EXT_CLK = 1, /**< External Clock */
+    MXC_TMR_IBRO_CLK = 2, /**< 7.3728MHz Clock */
+    MXC_TMR_ERFO_CLK = 3, /**< 32MHz Clock */
+    MXC_TMR_ERTCO_CLK = 4, /**< 32.768KHz Clock */
+    MXC_TMR_INRO_CLK = 5, /**< 80KHz Clock */
+
+    // Legacy names
     /*8M and 60M clocks can be used for Timers 0,1,2 and 3*/
-    MXC_TMR_60M_CLK,
-    MXC_TMR_32M_CLK,
-    MXC_TMR_8M_CLK,
+    MXC_TMR_60M_CLK, // Not supported as TMR clock source
+    MXC_TMR_32M_CLK = MXC_TMR_ERFO_CLK,
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK,
     /*32K clock can be used for Timers 0,1,2,3 and 4*/
-    MXC_TMR_32K_CLK,
+    MXC_TMR_32K_CLK = MXC_TMR_ERTCO_CLK,
     /*80K and EXT clocks can only be used for Timers 4 and 5*/
-    MXC_TMR_80K_CLK
+    MXC_TMR_80K_CLK = MXC_TMR_INRO_CLK,
 } mxc_tmr_clock_t;
 
 /**

diff --git a/Libraries/PeriphDrivers/Include/MAX32670/tmr.h b/Libraries/PeriphDrivers/Include/MAX32670/tmr.h
@@ -143,12 +143,18 @@ typedef enum {
  *              32K and 80K clocks can only be used for Timers 4 and 5
  */
 typedef enum {
-    MXC_TMR_APB_CLK, ///< PCLK CLock
-    MXC_TMR_EXT_CLK, ///< External Clock
-    MXC_TMR_8M_CLK, ///< 8MHz Clock
-    MXC_TMR_32M_CLK, ///< 32MHz Clock
-    MXC_TMR_32K_CLK, ///< 32KHz Clock
-    MXC_TMR_80K_CLK, ///< 80KHz Clock
+    MXC_TMR_APB_CLK = 0, ///< PCLK
+    MXC_TMR_EXT_CLK = 1, ///< External Clock
+    MXC_TMR_IBRO_CLK = 2, ///< 7.3728MHz Clock
+    MXC_TMR_ERFO_CLK = 3, ///< 32MHz
+    MXC_TMR_ERTCO_CLK = 4, ///< 32.768KHz Clock
+    MXC_TMR_INRO_CLK = 5, ///< 80KHz Clock
+
+    // Legacy names
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK, ///< 8MHz Clock
+    MXC_TMR_32M_CLK = MXC_TMR_ERFO_CLK, ///< 32MHz Clock
+    MXC_TMR_32K_CLK = MXC_TMR_ERTCO_CLK, ///< 32KHz Clock
+    MXC_TMR_80K_CLK = MXC_TMR_INRO_CLK, ///< 80KHz Clock
 } mxc_tmr_clock_t;
 
 /**

diff --git a/Libraries/PeriphDrivers/Include/MAX32672/tmr.h b/Libraries/PeriphDrivers/Include/MAX32672/tmr.h
@@ -143,12 +143,18 @@ typedef enum {
  *              32K and 80K clocks can only be used for Timers 4 and 5
  */
 typedef enum {
-    MXC_TMR_APB_CLK, ///< PCLK CLock
-    MXC_TMR_EXT_CLK, ///< External Clock
-    MXC_TMR_8M_CLK, ///< 8MHz Clock
-    MXC_TMR_32M_CLK, ///< 32MHz Clock
-    MXC_TMR_32K_CLK, ///< 32KHz Clock
-    MXC_TMR_80K_CLK, ///< 80KHz Clock
+    MXC_TMR_APB_CLK = 0, ///< PCLK CLock
+    MXC_TMR_EXT_CLK = 1, ///< External Clock
+    MXC_TMR_IBRO_CLK = 2, ///< 7.3728MHz Clock
+    MXC_TMR_ERFO_CLK = 3, ///< 32MHz Clock
+    MXC_TMR_ERTCO_CLK = 4, ///< 32.768KHz Clock
+    MXC_TMR_INRO_CLK = 5, ///< 80KHz Clock
+
+    // Legacy names
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK, ///< 8MHz Clock
+    MXC_TMR_32M_CLK = MXC_TMR_ERFO_CLK, ///< 32MHz Clock
+    MXC_TMR_32K_CLK = MXC_TMR_ERTCO_CLK, ///< 32KHz Clock
+    MXC_TMR_80K_CLK = MXC_TMR_INRO_CLK, ///< 80KHz Clock
 } mxc_tmr_clock_t;
 
 /**

diff --git a/Libraries/PeriphDrivers/Include/MAX32675/tmr.h b/Libraries/PeriphDrivers/Include/MAX32675/tmr.h
@@ -143,12 +143,17 @@ typedef enum {
  *              32K and 80K clocks can only be used for Timers 4 and 5
  */
 typedef enum {
-    MXC_TMR_APB_CLK, ///< PCLK CLock
-    MXC_TMR_EXT_CLK, ///< External Clock
-    MXC_TMR_8M_CLK, ///< 8MHz Clock
-    MXC_TMR_32M_CLK, ///< 32MHz Clock
-    MXC_TMR_32K_CLK, ///< 32KHz Clock
-    MXC_TMR_80K_CLK, ///< 80KHz Clock
+    MXC_TMR_APB_CLK = 0, ///< PCLK CLock
+    MXC_TMR_EXT_CLK = 1, ///< External Clock
+    MXC_TMR_IBRO_CLK = 2, ///< 7.3728MHz Clock
+    MXC_TMR_ERFO_CLK = 3, ///< 32MHz Clock
+    MXC_TMR_INRO_CLK = 4, ///< 80Khz Clock
+
+    // Legacy names
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK, ///< 8MHz Clock
+    MXC_TMR_32M_CLK = MXC_TMR_ERFO_CLK, ///< 32MHz Clock
+    MXC_TMR_32K_CLK, ///< 32KHz Clock (NOT SUPPORTED as TMR clock source)
+    MXC_TMR_80K_CLK = MXC_TMR_INRO_CLK, ///< 80KHz Clock
 } mxc_tmr_clock_t;
 
 /**

diff --git a/Libraries/PeriphDrivers/Include/MAX32680/tmr.h b/Libraries/PeriphDrivers/Include/MAX32680/tmr.h
@@ -141,15 +141,21 @@ typedef enum {
  * @brief      Peripheral Clock settings 
  */
 typedef enum {
-    MXC_TMR_APB_CLK = 0,
-    MXC_TMR_EXT_CLK,
+    MXC_TMR_APB_CLK = 0, /**< PCLK */
+    MXC_TMR_EXT_CLK = 1, /**< External Clock */
+    MXC_TMR_ISO_CLK = 2, /**< 60MHz Clock */
+    MXC_TMR_IBRO_CLK = 3, /**< 7.3728MHz Clock */
+    MXC_TMR_INRO_CLK = 4, /**< 8-30KHz Clock */
+    MXC_TMR_IBRO_DIV8_CLK = 5, /**< (7.3728/8)MHz Clock */
+
+    // Legacy names
     /*8M and 60M clocks can be used for Timers 0,1,2 and 3*/
-    MXC_TMR_32M_CLK,
-    MXC_TMR_8M_CLK,
+    MXC_TMR_32M_CLK, // ERFO not supported as a clock source for TMR
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK,
     /*32K clock can be used for Timers 0,1,2,3 and 4*/
-    MXC_TMR_32K_CLK,
+    MXC_TMR_32K_CLK, // ERTCO not supported as a clock source for TMR
     /*8K and EXT clocks can only be used for Timers 4 and 5*/
-    MXC_TMR_8K_CLK,
+    MXC_TMR_8K_CLK = MXC_TMR_INRO_CLK,
 } mxc_tmr_clock_t;
 
 /**

diff --git a/Libraries/PeriphDrivers/Include/MAX32690/tmr.h b/Libraries/PeriphDrivers/Include/MAX32690/tmr.h
@@ -141,16 +141,24 @@ typedef enum {
  * @brief      Peripheral Clock settings 
  */
 typedef enum {
-    MXC_TMR_APB_CLK = 0,
-    MXC_TMR_EXT_CLK,
+    MXC_TMR_APB_CLK = 0, /**< PCLK */
+    MXC_TMR_EXT_CLK = 1, /**< External Clock */
+    MXC_TMR_ISO_CLK = 2, /**< 60MHz Clock */
+    MXC_TMR_IBRO_CLK = 3, /**< 7.3728MHz Clock */
+    MXC_TMR_ERFO_CLK = 4,
+    MXC_TMR_ERTCO_CLK = 5, /**< 32.768KHz Clock */
+    MXC_TMR_INRO_CLK = 6, /**< 8KHz Clock */
+    MXC_TMR_IBRO_DIV8_CLK = 7, /**< (7.3728/8)MHz*/
+
+    // Legacy names
     /*8M and 60M clocks can be used for Timers 0,1,2 and 3*/
-    MXC_TMR_60M_CLK,
-    MXC_TMR_32M_CLK,
-    MXC_TMR_8M_CLK,
+    MXC_TMR_60M_CLK = MXC_TMR_ISO_CLK,
+    MXC_TMR_32M_CLK = MXC_TMR_ERFO_CLK,
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK,
     /*32K clock can be used for Timers 0,1,2,3 and 4*/
-    MXC_TMR_32K_CLK,
+    MXC_TMR_32K_CLK = MXC_TMR_ERTCO_CLK,
     /*8K and EXT clocks can only be used for Timers 4 and 5*/
-    MXC_TMR_8K_CLK,
+    MXC_TMR_8K_CLK = MXC_TMR_INRO_CLK,
 } mxc_tmr_clock_t;
 
 /**

diff --git a/Libraries/PeriphDrivers/Include/MAX78000/tmr.h b/Libraries/PeriphDrivers/Include/MAX78000/tmr.h
@@ -141,16 +141,23 @@ typedef enum {
  * @brief      Peripheral Clock settings 
  */
 typedef enum {
-    MXC_TMR_APB_CLK = 0,
-    MXC_TMR_EXT_CLK,
+    MXC_TMR_APB_CLK = 0, /**< PCLK */
+    MXC_TMR_EXT_CLK = 1, /**< External Clock */
+    MXC_TMR_ISO_CLK = 2, /**< 60MHz Clock */
+    MXC_TMR_IBRO_CLK = 3, /**< 7.3728MHz Clock */
+    MXC_TMR_ERTCO_CLK = 4, /**< 32.768KHz Clock */
+    MXC_TMR_INRO_CLK = 5, /**< 8-30KHz Clock */
+    MXC_TMR_IBRO_DIV8_CLK = 6, /**< (7.3728/8)MHz Clock */
+
+    // Legacy names
     /*8M and 60M clocks can be used for Timers 0,1,2 and 3*/
-    MXC_TMR_60M_CLK,
-    MXC_TMR_8M_CLK,
+    MXC_TMR_60M_CLK = MXC_TMR_ISO_CLK,
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK,
     /*32K clock can be used for Timers 0,1,2,3 and 4*/
-    MXC_TMR_32K_CLK,
+    MXC_TMR_32K_CLK = MXC_TMR_ERTCO_CLK,
     /*8K and EXT clocks can only be used for Timers 4 and 5*/
-    MXC_TMR_8K_CLK,
-    MXC_TMR_8M_DIV8_CLK
+    MXC_TMR_8K_CLK = MXC_TMR_INRO_CLK,
+    MXC_TMR_8M_DIV8_CLK = MXC_TMR_IBRO_DIV8_CLK
 } mxc_tmr_clock_t;
 
 /**

diff --git a/Libraries/PeriphDrivers/Include/MAX78002/tmr.h b/Libraries/PeriphDrivers/Include/MAX78002/tmr.h
@@ -141,15 +141,21 @@ typedef enum {
  * @brief      Peripheral Clock settings 
  */
 typedef enum {
-    MXC_TMR_APB_CLK = 0,
-    MXC_TMR_EXT_CLK,
+    MXC_TMR_APB_CLK = 0, /**< PCLK */
+    MXC_TMR_EXT_CLK = 1, /**< External Clock */
+    MXC_TMR_ISO_CLK = 2, /**< 60MHz Clock */
+    MXC_TMR_IBRO_CLK = 3, /**< 7.3728MHz Clock */
+    MXC_TMR_ERTCO_CLK = 4, /**< 32.768KHz Clock */
+    MXC_TMR_INRO_CLK = 5, /**< 8-30KHz Clock */
+
+    // Legacy names
     /*8M and 60M clocks can be used for Timers 0,1,2 and 3*/
-    MXC_TMR_60M_CLK,
-    MXC_TMR_8M_CLK,
+    MXC_TMR_60M_CLK = MXC_TMR_ISO_CLK,
+    MXC_TMR_8M_CLK = MXC_TMR_IBRO_CLK,
     /*32K clock can be used for Timers 0,1,2,3 and 4*/
-    MXC_TMR_32K_CLK,
+    MXC_TMR_32K_CLK = MXC_TMR_ERTCO_CLK,
     /*8K and EXT clocks can only be used for Timers 4 and 5*/
-    MXC_TMR_8K_CLK,
+    MXC_TMR_8K_CLK = MXC_TMR_INRO_CLK,
 } mxc_tmr_clock_t;
 
 /**