clean up rtc and timer macros

Author: mateoconlechuga

docs/doxyfile

@@ -2165,7 +2165,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = FORCE_INTERRUPTS
+PREDEFINED             = FORCE_INTERRUPTS=1 tiflags=
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

examples/standalone/real_time_clock/src/main.c

@@ -3,30 +3,29 @@
 
 int main(void)
 {
-    unsigned int seconds = 0;
+    uint8_t seconds = 0;
 
     /* Clear the homescreen */
     os_ClrHome();
 
-    /* Configure the RTC */
-    rtc_LoadSeconds = rtc_LoadMinutes = rtc_LoadHours = rtc_LoadDays = 0;
-    rtc_Control = RTC_ENABLE | RTC_LOAD | RTC_SEC_INT_SOURCE;
+    /* Enable the RTC, and enable second change interrupts */
+    rtc_Enable(RTC_SEC_INT);
 
-    /* Wait for the RTC to load in the new values and acknowledge all the interrupts */
+    /* Wait for the RTC to not be busy and acknowledge all interrupts */
     while (rtc_IsBusy());
-    rtc_IntAcknowledge = RTC_INT_MASK;
+    rtc_AckInterrupt(RTC_INT_MASK);
 
     /* Wait until 5 seconds have passed */
     while (seconds < 5)
     {
-        /* If a second passed, increment the second counter */
-        /* Fill the screen with a new color */
-        if (rtc_IntStatus & RTC_SEC_INT)
+        /* If a second passed, increment the second counter and then */
+        /* fill the screen with a fresh color */
+        if (rtc_ChkInterrupt(RTC_SEC_INT))
         {
-            memset((void*)lcd_Ram, randInt(0,255), LCD_SIZE);
+            memset((void*)lcd_Ram, randInt(0, 255), LCD_SIZE);
             seconds++;
 
-            rtc_IntAcknowledge = rtc_IntStatus;
+            rtc_AckInterrupt(RTC_SEC_INT);
         }
     }
 

examples/standalone/second_counter/src/main.c

@@ -1,9 +1,10 @@
 #include <tice.h>
 #include <stdio.h>
 
-#define ONE_SECOND      (32768/1)
-#define HALF_SECOND     (32768/2)
-#define QUARTER_SECOND  (32768/4)
+#define TIMER_FREQ      32768 /* Frequency of timer in Hz */
+#define ONE_SECOND      (TIMER_FREQ / 1)
+#define HALF_SECOND     (TIMER_FREQ / 2)
+#define QUARTER_SECOND  (TIMER_FREQ / 4)
 
 int main(void)
 {
@@ -13,23 +14,23 @@ int main(void)
     /* Clear the homescreen */
     os_ClrHome();
 
-    /* Disable the timer so it doesn't run when setting the configuration */
-    timer_Control = TIMER1_DISABLE;
+    /* Disable timer 1 so it doesn't run when setting the configuration */
+    timer_Disable(1);
 
-    /* By using the 32768 kHz clock, we can count for exactly 1 second */
-    /* or for a more precise interval of time */
-    timer_1_ReloadValue = timer_1_Counter = ONE_SECOND;
+    /* Count for 1 second. The counter will be reloaded once it reaches 0 */
+    timer_Set(1, ONE_SECOND);
+    timer_SetReload(1, ONE_SECOND);
 
-    /* Enable the timer */
-    /* Set the timer to use the 32768 kHz clock */
-    /* Enable an interrupt once the timer reaches 0 */
+    /* Enable timer 1 */
+    /* Set the timer to use the 32768 Hz clock */
+    /* Trigger an interrupt once the timer reaches 0 and reloads */
     /* Set the timer to count down */
-    timer_Control = TIMER1_ENABLE | TIMER1_32K | TIMER1_0INT | TIMER1_DOWN;
+    timer_Enable(1, TIMER_32K, TIMER_0INT, TIMER_DOWN);
 
     do
     {
         /* If the timer is reloaded, we reached 0 */
-        if (timer_IntStatus & TIMER1_RELOADED)
+        if (timer_ChkInterrupt(1, TIMER_RELOADED))
         {
             /* Increment number of counts */
             count++;
@@ -40,7 +41,7 @@ int main(void)
             os_PutStrFull(str);
 
             /* Acknowledge the reload */
-            timer_IntAcknowledge = TIMER1_RELOADED;
+            timer_AckInterrupt(1, TIMER_RELOADED);
         }
     } while (!os_GetCSC());
 

examples/standalone/second_counter2/src/main.c

@@ -1,30 +1,46 @@
 #include <tice.h>
 #include <stdio.h>
 
-#define ONE_SECOND      (32768/1)
-#define HALF_SECOND     (32768/2)
-#define QUARTER_SECOND  (32768/4)
+#define TIMER_FREQ      32768 /* Frequency of timer in Hz */
+#define ONE_SECOND      (TIMER_FREQ / 1)
+#define HALF_SECOND     (TIMER_FREQ / 2)
+#define QUARTER_SECOND  (TIMER_FREQ / 4)
 
-void reset_counter(void);
+static void reset_counter(void)
+{
+    /* Disable timer 1 so it doesn't run when setting the configuration */
+    timer_Disable(1);
+
+    /* Count for 1 second. The counter will be reloaded once it reaches 0 */
+    timer_Set(1, ONE_SECOND);
+    timer_SetReload(1, ONE_SECOND);
+
+    /* Enable timer 1 */
+    /* Set the timer to use the 32768 Hz clock */
+    /* Trigger an interrupt once the timer reaches 0 and reloads */
+    /* Set the timer to count down */
+    timer_Enable(1, TIMER_32K, TIMER_0INT, TIMER_DOWN);
+}
 
 int main(void)
 {
     unsigned int count = 0;
     char str[10];
 
-    /* Set the match value to trigger the interrupt in the timer */
-    timer_1_MatchValue_1 = ONE_SECOND;
-
     /* Clear the homescreen */
     os_ClrHome();
 
+    /* Trigger an interrupt when the timer 1's match 1 count is equal to */
+    /* one second. There are 2 match count comparators per timer. */
+    timer_SetMatch(1, TIMER_MATCH(1), ONE_SECOND);
+
     /* Reset the counter */
     reset_counter();
 
     do
     {
-        /* Poll until we reach the match value */
-        if (timer_IntStatus & TIMER1_MATCH1)
+        /* Poll until the match value is detected */
+        if (timer_ChkInterrupt(1, TIMER_MATCH(1)))
         {
             /* Print the count */
             sprintf(str, "%u", count++);
@@ -35,26 +51,10 @@ int main(void)
             reset_counter();
 
             /* Acknowledge the interrupt */
-            timer_IntStatus = TIMER1_MATCH1;
+            timer_AckInterrupt(1, TIMER_MATCH(1));
         }
 
     } while (count < 5);
 
     return 0;
 }
-
-void reset_counter(void)
-{
-    /* Disable the timer so it doesn't run when setting the configuration */
-    timer_Control = TIMER1_DISABLE;
-
-    /* By using the 32768 kHz clock, we can count for a */
-    /* precise interval of time */
-    timer_1_ReloadValue = timer_1_Counter = timer_1_MatchValue_1;
-
-    /* Enable the timer */
-    /* Set the timer to use the 32768 kHz clock */
-    /* Enable an interrupt once the timer reaches 0 */
-    /* Set the timer to count down */
-    timer_Control = TIMER1_ENABLE | TIMER1_32K | TIMER1_0INT | TIMER1_DOWN;
-}

examples/standalone/stopwatch/src/main.c

@@ -1,6 +1,26 @@
 #include <tice.h>
 
-void PrintTime(float elapsed);
+/* Print a stopwatch value on the home screen */
+static void PrintTime(float elapsed)
+{
+    /* Float format for printf may be unimplemented, so go through an OS real */
+    real_t elapsed_real;
+
+    /* Max stopwatch value is (2^32 - 1) / 32768 = 131072.00, */
+    /* so create a buffer with room for 9 characters plus a null terminator */
+    char str[10];
+
+    /* If the elapsed time is small enough that the OS would print it using */
+    /* scientific notation, force it down to zero before conversion */
+    elapsed_real = os_FloatToReal(elapsed <= 0.001f ? 0.0f : elapsed);
+
+    /* Convert the elapsed time real to a string */
+    os_RealToStr(str, &elapsed_real, 8, 1, 2);
+
+    /* print the string */
+    os_SetCursorPos(0, 0);
+    os_PutStrFull(str);
+}
 
 int main(void)
 {
@@ -10,23 +30,24 @@ int main(void)
     /* Display an initial time of zero */
     PrintTime(0.0f);
 
-    /* Disable the timer */
-    timer_Control = TIMER1_DISABLE;
+    /* Disable timer 1 so it doesn't run when setting the configuration */
+    timer_Disable(1);
 
     /* Reset the timer's counter */
-    timer_1_Counter = 0;
+    timer_Set(1, 0);
 
     /* Wait for a key press */
     while (!os_GetCSC());
 
-    /* Enable the timer while setting it to 32768 KHz and making it count up */
-    timer_Control = TIMER1_ENABLE | TIMER1_32K | TIMER1_UP;
+    /* Enable the timer while setting it to 32768 Hz and making it count up */
+    timer_Enable(1, TIMER_32K, TIMER_0INT, TIMER_UP);
 
     /* Continue running until a key is pressed */
     do
     {
         /* Calculate and print the elapsed time */
-        float elapsed = (float)atomic_load_increasing_32(&timer_1_Counter) / 32768;
+        /* timer_Get or timer_GetLow may be used in place of timer_GetSafe */
+        float elapsed = (float)timer_GetSafe(1, TIMER_UP) / 32768;
         PrintTime(elapsed);
     } while (!os_GetCSC());
 
@@ -35,25 +56,3 @@ int main(void)
 
     return 0;
 }
-
-/* PrintTime a stopwatch value on the home screen */
-void PrintTime(float elapsed)
-{
-    /* Float format for printf may be unimplemented, so go through an OS real */
-    real_t elapsed_real;
-
-    /* Max stopwatch value is (2^32 - 1) / 32768 = 131072.00, */
-    /* so create a buffer with room for 9 characters plus a null terminator */
-    char str[10];
-
-    /* If the elapsed time is small enough that the OS would print it using */
-    /* scientific notation, force it down to zero before conversion */
-    elapsed_real = os_FloatToReal(elapsed <= 0.001f ? 0.0f : elapsed);
-
-    /* Convert the elapsed time real to a string */
-    os_RealToStr(str, &elapsed_real, 8, 1, 2);
-
-    /* print the string */
-    os_SetCursorPos(0, 0);
-    os_PutStrFull(str);
-}