From b5fc460e4604cef82b71700064deeb73d65d857f Mon Sep 17 00:00:00 2001
From: William Miceli <git@williammiceli.me>
Date: Mon, 31 May 2021 17:36:08 -0400
Subject: [PATCH] Fixed #include directives and comments to be used in a more
 standardized way (that I could find online)

---
 .../Debug_BlinkyLED-Advanced/clock_init.c     | 18 ------------------
 .../Debug_BlinkyLED-Advanced/clock_init.h     | 19 +++++++++++++++++++
 .../Debug_BlinkyLED-Advanced/interrupts.c     |  1 -
 .../Debug_BlinkyLED-Advanced/interrupts.h     |  3 +--
 .../Debug_BlinkyLED-Advanced/io_init.c        | 11 -----------
 .../Debug_BlinkyLED-Advanced/io_init.h        | 10 +++++++++-
 Telem_Debug/Debug_BlinkyLED-Advanced/main.c   |  4 ----
 Telem_Debug/Debug_BlinkyLED-Advanced/timers.c |  7 -------
 Telem_Debug/Debug_BlinkyLED-Advanced/timers.h |  6 ++++++
 .../Debug_BlinkyLED-Basic/clock_init.c        |  2 --
 Telem_Debug/Debug_BlinkyLED-Basic/main.c      |  4 ----
 11 files changed, 35 insertions(+), 50 deletions(-)

diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/clock_init.c b/Telem_Debug/Debug_BlinkyLED-Advanced/clock_init.c
index 2d10d53..377a275 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/clock_init.c
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/clock_init.c
@@ -1,23 +1,5 @@
-/*
- * Clock Initialization Code MSP430F5438A
- * Initialize Clock Source XT1 @ 32768 Hz
- * Initialize Clock Source XT2 @ 20MHz
- *
- * Sunseeker Telemetry 2021
- *
- * Last modified October 2015 by Scott Haver
- * Last modified May 2021 by B. Bazuin
- *
- * Main CLK     :  MCLK  = XT2     = 20 MHz
- * Sub-Main CLK :  SMCLK = XT2/2   = 10  MHz
- * Aux CLK      :  ACLK  = XT1     = 32.768 kHz
- *
- */
-#include <msp430x54xa.h>
-#include "SunseekerTelemetry2021.h"
 #include "clock_init.h"
 
-
 void clock_init(void)
 {
     WDTCTL = WDTPW + WDTHOLD;   // Stop watchdog timer; `WDTPW` is the "WatchDog Timer PassWord", required for all `WDTCTL` operations
diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/clock_init.h b/Telem_Debug/Debug_BlinkyLED-Advanced/clock_init.h
index 890afbb..176fe37 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/clock_init.h
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/clock_init.h
@@ -1,6 +1,25 @@
+/*
+ * Clock Initialization Code MSP430F5438A
+ * Initialize Clock Source XT1 @ 32768 Hz
+ * Initialize Clock Source XT2 @ 20MHz
+ *
+ * Sunseeker Telemetry 2021
+ *
+ * Last modified October 2015 by Scott Haver
+ * Last modified May 2021 by B. Bazuin
+ *
+ * Main CLK     :  MCLK  = XT2     = 20 MHz
+ * Sub-Main CLK :  SMCLK = XT2/2   = 10  MHz
+ * Aux CLK      :  ACLK  = XT1     = 32.768 kHz
+ *
+ */
+
 #ifndef CLOCK_INIT_H_
 #define CLOCK_INIT_H_
 
+#include <msp430x54xa.h>
+#include "SunseekerTelemetry2021.h"
+
 void Port_Init(void);
 void Clock_XT1_Init(void);
 void Clock_XT2_Init(void);
diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/interrupts.c b/Telem_Debug/Debug_BlinkyLED-Advanced/interrupts.c
index 5db50eb..2c91246 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/interrupts.c
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/interrupts.c
@@ -1,4 +1,3 @@
-#include "SunseekerTelemetry2021.h"
 #include "interrupts.h"
 
 extern volatile unsigned char status_flag;
diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/interrupts.h b/Telem_Debug/Debug_BlinkyLED-Advanced/interrupts.h
index 0e8a74d..e0a4156 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/interrupts.h
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/interrupts.h
@@ -1,7 +1,6 @@
 #ifndef INTERRUPTS_H_
 #define INTERRUPTS_H_
 
-
-
+#include "SunseekerTelemetry2021.h"
 
 #endif /* INTERRUPTS_H_ */
diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/io_init.c b/Telem_Debug/Debug_BlinkyLED-Advanced/io_init.c
index 9cecb36..b3d69cf 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/io_init.c
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/io_init.c
@@ -1,14 +1,3 @@
-/*
- *  I/O Initialization
- */
-
-/*
- * Initialize I/O port directions and states
- * Drive unused pins as outputs to avoid floating inputs and wasting power
- *
- */
-
-#include "SunseekerTelemetry2021.h"
 #include "io_init.h"
 
 void io_init(void)
diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/io_init.h b/Telem_Debug/Debug_BlinkyLED-Advanced/io_init.h
index 2616501..b8e531d 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/io_init.h
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/io_init.h
@@ -1,10 +1,18 @@
 /*
- * io_init.h
+ *  I/O Initialization
+ */
+
+/*
+ * Initialize I/O port directions and states
+ * Drive unused pins as outputs to avoid floating inputs and wasting power
+ *
  */
 
 #ifndef IO_INIT_H_
 #define IO_INIT_H_
 
+#include "SunseekerTelemetry2021.h"
+
 void io_init(void);
 
 #endif /* IO_INIT_H_ */
diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/main.c b/Telem_Debug/Debug_BlinkyLED-Advanced/main.c
index d9e2ce2..c9b0e10 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/main.c
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/main.c
@@ -1,7 +1,3 @@
-/*
- * main.c
- */
-
 #include "SunseekerTelemetry2021.h"
 #include "clock_init.h"
 #include "interrupts.h"
diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/timers.c b/Telem_Debug/Debug_BlinkyLED-Advanced/timers.c
index 9595e77..621a8d6 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/timers.c
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/timers.c
@@ -1,10 +1,3 @@
-
-/*
-* Initialize Timer B
-*   - Provides timer tick timebase at 100 Hz
-*/
-
-#include "SunseekerTelemetry2021.h"
 #include "timers.h"
 
 void timerB_init(void)
diff --git a/Telem_Debug/Debug_BlinkyLED-Advanced/timers.h b/Telem_Debug/Debug_BlinkyLED-Advanced/timers.h
index 89aca96..a015607 100644
--- a/Telem_Debug/Debug_BlinkyLED-Advanced/timers.h
+++ b/Telem_Debug/Debug_BlinkyLED-Advanced/timers.h
@@ -1,6 +1,12 @@
 #ifndef TIMERS_H_
 #define TIMERS_H_
 
+#include "SunseekerTelemetry2021.h"
+
+/*
+* Initialize Timer B
+*   - Provides timer tick timebase at 100 Hz
+*/
 void timerB_init(void);
 
 #endif /* TIMERS_H_ */
diff --git a/Telem_Debug/Debug_BlinkyLED-Basic/clock_init.c b/Telem_Debug/Debug_BlinkyLED-Basic/clock_init.c
index 5c57f4e..a4f0dca 100644
--- a/Telem_Debug/Debug_BlinkyLED-Basic/clock_init.c
+++ b/Telem_Debug/Debug_BlinkyLED-Basic/clock_init.c
@@ -15,13 +15,11 @@
  */
 #include <msp430x54xa.h>
 
-
 void Port_Init(void);
 void Clock_XT1_Init(void);
 void Clock_XT2_Init(void);
 void SetVCoreUp(unsigned int level);
 
-
 void clock_init(void)
 {
     WDTCTL = WDTPW + WDTHOLD;   //Stop watchdog timer
diff --git a/Telem_Debug/Debug_BlinkyLED-Basic/main.c b/Telem_Debug/Debug_BlinkyLED-Basic/main.c
index 6beac45..d7da34c 100644
--- a/Telem_Debug/Debug_BlinkyLED-Basic/main.c
+++ b/Telem_Debug/Debug_BlinkyLED-Basic/main.c
@@ -1,7 +1,3 @@
-/*
- * main.c
- */
-
 #include "SunseekerTelemetry2021.h"
 
 int main(void) {