Update code, change documentation

Author: Fescron

README.md

@@ -63,7 +63,7 @@ These are all of the files we've created to make the project more *readable*:
 - `util.c` (& `util.h`)
   - Here we have some *utility functionality* like:
     - A **Delay** method with it's **interrupt handler** and a function to **enable or disable** `systicks`.
-    - A method to **initialize the LED's**.
+    - A method to **initialize the LED's** and to **turn on or off LED0**.
     - A method to **stop code execution when an error occured**.
 
 - `handlers.c` (& `handlers.h`)

code/SLSTK3400A_ADXL362/inc/accel.h

@@ -1,7 +1,7 @@
 /***************************************************************************//**
  * @file accel.h
  * @brief All code for the ADXL362 accelerometer.
- * @version 2.1
+ * @version 3.0
  * @author Brecht Van Eeckhoudt
  ******************************************************************************/
 
@@ -24,20 +24,20 @@
 
 
 /* ADXL SPI GPOI */
-#define ADXL_CLK_PORT gpioPortE
-#define ADXL_CLK_PIN 12
+#define ADXL_CLK_PORT  gpioPortE
+#define ADXL_CLK_PIN   12
 #define ADXL_MOSI_PORT gpioPortE
-#define ADXL_MOSI_PIN 10
+#define ADXL_MOSI_PIN  10
 #define ADXL_MISO_PORT gpioPortE
-#define ADXL_MISO_PIN 11
-#define ADXL_NCS_PORT gpioPortD 	/* Can't use the US0_CS port (PE13) to manually set/clear CS line */
-#define ADXL_NCS_PIN 4
+#define ADXL_MISO_PIN  11
+#define ADXL_NCS_PORT  gpioPortD 	/* Can't use the US0_CS port (PE13) to manually set/clear CS line */
+#define ADXL_NCS_PIN   4
 
 /* Other ADXL GPOI */
 #define ADXL_INT1_PORT gpioPortD
-#define ADXL_INT1_PIN 7
-#define ADXL_VCC_PORT gpioPortD
-#define ADXL_VCC_PIN 5
+#define ADXL_INT1_PIN  7
+#define ADXL_VCC_PORT  gpioPortD
+#define ADXL_VCC_PIN   5
 
 
 /* ADXL REGISTERS */

code/SLSTK3400A_ADXL362/inc/debugging.h

@@ -5,7 +5,7 @@
  *   This header file is called in every other file where there are UART
  *   debugging statements. Commenting the line in this file can remove all
  *   UART functionality in the whole project.
- * @version 2.0
+ * @version 3.0
  * @author Brecht Van Eeckhoudt
  ******************************************************************************/
 

code/SLSTK3400A_ADXL362/inc/handlers.h

@@ -1,7 +1,7 @@
 /***************************************************************************//**
  * @file handlers.h
  * @brief Interrupt handlers.
- * @version 2.0
+ * @version 3.0
  * @author Brecht Van Eeckhoudt
  ******************************************************************************/
 

code/SLSTK3400A_ADXL362/inc/util.h

@@ -1,7 +1,7 @@
 /***************************************************************************//**
  * @file util.h
  * @brief Utility functions.
- * @version 2.0
+ * @version 3.0
  * @author Brecht Van Eeckhoudt
  ******************************************************************************/
 
@@ -19,12 +19,19 @@
 #include "../inc/debugging.h" /* Enable or disable printing to UART */
 
 
+/* PORT and PIN definitoons */
+#define LED0_PORT gpioPortF
+#define LED0_PIN  4
+#define LED1_PORT gpioPortF
+#define LED1_PIN  5
+
+
 /* Prototypes */
 void initLEDS (void);
+void led0 (bool enabled);
 void Error (uint8_t number);
 void Delay (uint32_t dlyTicks);
-void disableSystick (void);
-void enableSystick (void);
+void systickInterrupts (bool enabled);
 
 
 #endif /* _UTIL_H_ */

code/SLSTK3400A_ADXL362/src/accel.c

@@ -2,7 +2,7 @@
  * @file accel.c
  * @brief All code for the ADXL362 accelerometer.
  * @details Started with code from the UART example (main_series0_HG.c) from SiLabs Github.
- * @version 2.1
+ * @version 3.0
  * @author Brecht Van Eeckhoudt
  ******************************************************************************/
 
@@ -187,7 +187,7 @@ void testADXL (void)
 
 /**************************************************************************//**
  * @brief
- *   Read and display g values forever with a one second interval.
+ *   Read and display g values forever with a 100ms interval.
  *
  * @details
  *   The accelerometer is put in measurement mode at 12.5Hz ODR, new
@@ -204,7 +204,7 @@ void readValuesADXL (void)
 	/* Infinite loop */
 	while (1)
 	{
-		GPIO_PinOutSet(gpioPortF, 4); /* Enable LED0 */
+		led0(true); /* Enable LED0 */
 
 		/* Read XYZ sensor data */
 		readADXL_XYZDATA();
@@ -224,7 +224,7 @@ void readValuesADXL (void)
 		//dbprintln("");
 #endif /* DEBUGGING */
 
-		GPIO_PinOutClear(gpioPortF, 4); /* Disable LED0 */
+		led0(false); /* Disable LED0 */
 
 		counter++;
 
@@ -576,7 +576,7 @@ void softResetADXL (void)
 
 
 /**************************************************************************//**
- * @brief Check if the ID is correct
+ * @brief Check if the ID is correct.
  *
  * @return
  *   @li true - Correct ID returned.

code/SLSTK3400A_ADXL362/src/handlers.c

@@ -1,7 +1,7 @@
 /***************************************************************************//**
  * @file handlers.c
  * @brief Interrupt handlers.
- * @version 2.0
+ * @version 3.0
  * @author Brecht Van Eeckhoudt
  ******************************************************************************/
 

code/SLSTK3400A_ADXL362/src/main.c

@@ -1,7 +1,7 @@
 /***************************************************************************//**
  * @file main.c
  * @brief The main file for the program to interface to the accelerometer.
- * @version 2.1
+ * @version 3.0
  * @author Brecht Van Eeckhoudt
  *
  * ******************************************************************************
@@ -59,7 +59,7 @@
  *   Initialize buttons PB0 and PB1 on falling-edge interrupts and
  *   ADXL_INT1 on rising-edge interrupts.
  *****************************************************************************/
-void initWakeup (void)
+void initGPIOwakeup (void)
 {
 	/* Enable necessary clock */
 	CMU_ClockEnable(cmuClock_GPIO, true);
@@ -89,7 +89,7 @@ void initWakeup (void)
 /**************************************************************************//**
  * @brief RTCC initialization
  *****************************************************************************/
-void initRTCC (void)
+void initRTCcomp (void)
 {
 	/* Enable the oscillator for the RTC */
 	CMU_OscillatorEnable(cmuOsc_LFXO, true, true);
@@ -132,10 +132,10 @@ int main (void)
 	if (SysTick_Config(CMU_ClockFreqGet(cmuClock_CORE) / 1000)) while (1);
 
 	/* Initialize RTC compare settings */
-	initRTCC();
+	initRTCcomp();
 
 	/* Initialize GPIO wakeup */
-	initWakeup();
+	initGPIOwakeup();
 
 #ifdef DEBUGGING /* DEBUGGING */
 	dbprint_INIT(USART1, 4, true, false); /* VCOM */
@@ -196,9 +196,9 @@ int main (void)
 
 	while(1)
 	{
-		GPIO_PinOutSet(gpioPortF, 4); /* Enable LED0 */
+		led0(true); /* Enable LED0 */
 		Delay(1000);
-		GPIO_PinOutClear(gpioPortF, 4); /* Disable LED0 */
+		led0(false); /* Disable LED0 */
 
 		/* Read status register to acknowledge interrupt
 		 * (can be disabled by changing LINK/LOOP mode in ADXL_REG_ACT_INACT_CTL) */
@@ -212,8 +212,8 @@ int main (void)
 	dbinfo("Disabling systick & going to sleep...\r\n");
 #endif /* DEBUGGING */
 
-		disableSystick();
+		systickInterrupts(false); /* Disable SysTick interrupts */
 		EMU_EnterEM2(true); /* "true": Save and restore oscillators, clocks and voltage scaling */
-		enableSystick();
+		systickInterrupts(true); /* Enable SysTick interrupts */
 	}
 }

code/SLSTK3400A_ADXL362/src/util.c

@@ -1,7 +1,7 @@
 /***************************************************************************//**
  * @file util.c
  * @brief Utility functions.
- * @version 2.0
+ * @version 3.0
  * @author Brecht Van Eeckhoudt
  ******************************************************************************/
 
@@ -19,10 +19,25 @@ volatile uint32_t msTicks; /* Volatile because it's a global variable that's mod
  *****************************************************************************/
 void initLEDS (void)
 {
-	GPIO_PinModeSet(gpioPortF, 4, gpioModePushPull, 1); /* LED0 */
-	GPIO_PinModeSet(gpioPortF, 5, gpioModePushPull, 1); /* LED1 */
-	GPIO_PinOutClear(gpioPortF, 4); /* Disable LED0 */
-	GPIO_PinOutClear(gpioPortF, 5); /* Disable LED1 */
+	GPIO_PinModeSet(LED0_PORT, LED0_PIN, gpioModePushPull, 1);
+	GPIO_PinModeSet(LED1_PORT, LED1_PIN, gpioModePushPull, 1);
+	GPIO_PinOutClear(LED0_PORT, LED0_PIN); /* Disable LED0 */
+	GPIO_PinOutClear(LED1_PORT, LED1_PIN); /* Disable LED1 */
+}
+
+
+/**************************************************************************//**
+ * @brief
+ *   Enable or disable LED0.
+ *
+ * @param[in] enabled
+ *   @li True - Enable LED0
+ *   @li False - Disable LED0.
+ *****************************************************************************/
+void led0 (bool enabled)
+{
+	if (enabled) GPIO_PinOutSet(LED0_PORT, LED0_PIN);
+	else GPIO_PinOutClear(LED0_PORT, LED0_PIN);
 }
 
 
@@ -44,14 +59,14 @@ void Error (uint8_t number)
 	dbcritInt(">>> Error (", number, ")! Please reset MCU. <<<", false);
 #endif /* DEBUGGING */
 
-	GPIO_PinOutClear(gpioPortF, 4); /* Disable LED0 */
-	GPIO_PinOutSet(gpioPortF, 5);   /* Enable LED1 */
+	GPIO_PinOutClear(LED0_PORT, LED0_PIN); /* Disable LED0 */
+	GPIO_PinOutSet(LED1_PORT, LED1_PIN);   /* Enable LED1 */
 
 	while(1)
 	{
 		Delay(100);
-		GPIO_PinOutToggle(gpioPortF, 4); /* Toggle LED0 */
-		GPIO_PinOutToggle(gpioPortF, 5); /* Toggle LED1 */
+		GPIO_PinOutToggle(LED0_PORT, LED0_PIN); /* Toggle LED0 */
+		GPIO_PinOutToggle(LED1_PORT, LED1_PIN); /* Toggle LED1 */
 	}
 }
 
@@ -83,27 +98,19 @@ void Delay (uint32_t dlyTicks)
 
 /**************************************************************************//**
  * @brief
- *   Disable SysTick interrupt and counter by clearing their bits.
+ *   Disable
  *
  * @note
  *   SysTick interrupt and counter (used by Delay) need to
  *   be disabled before going to EM2.
- *****************************************************************************/
-void disableSystick (void)
-{
-	SysTick->CTRL &= ~SysTick_CTRL_TICKINT_Msk & ~SysTick_CTRL_ENABLE_Msk;
-}
-
-
-/**************************************************************************//**
- * @brief
- *   Enable SysTick interrupt and counter by setting their bits.
  *
- * @note
- *   SysTick interrupt and counter (used by Delay) need to
- *   be enabled after waking up from EM2.
+ * @param[in] enabled
+ *   @li True - Enable SysTick interrupt and counter by setting their bits.
+ *   @li False - Disable SysTick interrupt and counter by clearing their bits.
  *****************************************************************************/
-void enableSystick (void)
+void systickInterrupts (bool enabled)
 {
-	SysTick->CTRL |= SysTick_CTRL_TICKINT_Msk | SysTick_CTRL_ENABLE_Msk;
+	if (enabled) SysTick->CTRL |= SysTick_CTRL_TICKINT_Msk | SysTick_CTRL_ENABLE_Msk;
+	else SysTick->CTRL &= ~SysTick_CTRL_TICKINT_Msk & ~SysTick_CTRL_ENABLE_Msk;
 }
+