cleaned up comments

src/timer.h

@@ -5,78 +5,55 @@
 #define TIMER_H
 #include <Arduino.h>
 
-// Timer code -------------------------------- //
-const int CLOCKFREQ = 1000000; // unlike the lab, here we use a clock divider of 4 to allow for slower speeds
+const int CLOCKFREQ = 1000000; // Unlike the lab, here we use a clock divider of 4 to allow for slower speeds
 
 /**
- * @brief  call this on startup to initialize the timer, it doesn't start the interrupt running.
+ * @brief Call this on startup to initialize the timer, it doesn't start the interrupt running.
  */
 void setupTimer()
 {
-    /*
-     * LAB STEP 4
-     */
-    // Configure and enable GCLK4 for TC:
+    // LAB STEP 4: Configure and enable GCLK4 for TC:
     GCLK->GENDIV.reg = GCLK_GENDIV_DIV(4) | GCLK_GENDIV_ID(4); // clock divider of 4
-    while (GCLK->STATUS.bit.SYNCBUSY)
-        ;
-    // use GCLK->GENCTRL.reg and GCLK->CLKCTRL.reg
+    while (GCLK->STATUS.bit.SYNCBUSY);
     GCLK->GENCTRL.reg = GCLK_GENCTRL_GENEN | GCLK_GENCTRL_IDC | GCLK_GENCTRL_ID(4) | GCLK_GENCTRL_SRC_OSC8M;
-    while (GCLK->STATUS.bit.SYNCBUSY)
-        ;
+    while (GCLK->STATUS.bit.SYNCBUSY);
     GCLK->CLKCTRL.reg = GCLK_CLKCTRL_ID(27) | GCLK_CLKCTRL_CLKEN | GCLK_CLKCTRL_GEN(4);
-
-    /*
-     * LAB STEP 6
-     */
-    // Disable TC (for now)
-    // use TC3->COUNT16.CTRLA.reg and TC3->COUNT16.INTENCLR.reg
+
+    // LAB STEP 6: Disable TC (for now)
     TC3->COUNT16.CTRLA.reg &= ~TC_CTRLA_ENABLE;
-    while (TC3->COUNT16.STATUS.bit.SYNCBUSY)
-        ;
-
+    while (TC3->COUNT16.STATUS.bit.SYNCBUSY);
     TC3->COUNT16.INTENCLR.reg |= TC_INTENCLR_MC0;
-
     // Set up NVIC:
     NVIC_SetPriority(TC3_IRQn, 0);
     NVIC_EnableIRQ(TC3_IRQn);
-
-    // Serial.println("Timer Initialized!");
 }
 
 /**
  * @brief  Sets correct TC timer value and enables TC interrupt at the desired frequency
- * @note  depending on clock frequency and clock devisor there will be lower and upper limits for freq
+ * @note  Depending on clock frequency and clock devisor there will be lower and upper limits for freq
  * Non-blocking: TC interrupts can happen while program executes
- * @param  freq: frequency to run timer interrupt at, in hertz
+ * @param  freq: Frequency to run timer interrupt at, in hertz
  */
 void setTimerISRRate(int freq)
 {
-    // Reference TC with TC3->COUNT16.register_name.reg
     // Turn off interrupts to TC3 on MC0 when configuring
-    // Disable TC (for now)
     TC3->COUNT16.INTENCLR.reg |= TC_INTENCLR_MC0;
-    // CONFIGURE TC3 TO PLAY NOTE
+    // Configure TC3 to play note
     TC3->COUNT16.CTRLA.reg = TC_CTRLA_MODE_COUNT16 | TC_CTRLA_PRESCALER_DIV2 | TC_CTRLA_PRESCSYNC_PRESC | TC_CTRLA_WAVEGEN_MFRQ | TC_CTRLA_ENABLE;
-    while (TC3->COUNT16.STATUS.bit.SYNCBUSY)
-        ;
+    while (TC3->COUNT16.STATUS.bit.SYNCBUSY);
     TC3->COUNT16.CC[0].reg = CLOCKFREQ / freq;
-    while (TC3->COUNT16.STATUS.bit.SYNCBUSY)
-        ;
-    // Turn interrupts to TC3 on MC0 back on when done configuring
+    while (TC3->COUNT16.STATUS.bit.SYNCBUSY);
+    // Turn interrupts to TC3 on MC0 back on
     TC3->COUNT16.INTENSET.reg |= TC_INTENSET_MC0;
 }
 
 /**
- * @brief turns off TC timer
+ * @brief Turns off TC timer
  */
 void stopTimerInterrupts()
 {
-    //  Reference TC with TC3->COUNT16.register_name.reg
     TC3->COUNT16.INTENCLR.reg |= TC_INTENCLR_MC0;
     TC3->COUNT16.CTRLA.reg &= ~TC_CTRLA_ENABLE;
-    while (TC3->COUNT16.STATUS.bit.SYNCBUSY)
-        ;
-    // Serial.println("Timer interrupts stopped!");
+    while (TC3->COUNT16.STATUS.bit.SYNCBUSY);
 }
 #endif