more doc comments

platform/debug_uart.h

@@ -1,13 +1,29 @@
 //
 // Created by MightyPork on 2017/12/15.
 //
+// Setup and routines for debug printing.
+// The actual printf-like functions used for debug printing are in debug.h
+//
 
 #ifndef GEX_DEBUG_UART_H
 #define GEX_DEBUG_UART_H
 
+/**
+ * Pre-init the debug uart
+ *
+ * Set up the peripheral for printing, do not claim resources yet because the
+ * registry is not initialized
+ */
 void DebugUart_PreInit(void);
+
+/**
+ * Finalize the init (claim resources)
+ */
 void DebugUart_Init(void);
 
+/**
+ * Write some bytes via the debug USART
+ */
 void debug_write(const char *buf, uint16_t len);
 
 #endif //GEX_DEBUG_UART_H

platform/hw_utils.h

@@ -1,8 +1,9 @@
 //
-// Utilities for parsing pins from settings to LL and resources
-//
 // Created by MightyPork on 2017/12/08.
 //
+// Utilities for parsing pins from settings to LL and resources,
+// GPIO init, AF config and some LL driver extensions
+//
 
 #ifndef GEX_PIN_UTILS_H
 #define GEX_PIN_UTILS_H

platform/irq_dispatcher.h

@@ -1,6 +1,8 @@
 //
 // Created by MightyPork on 2018/01/14.
 //
+// Provides a trampoline system for redirecting IRQ calls to assigned callbacks.
+//
 
 #ifndef GEX_F072_IRQ_DISPATCHER_H
 #define GEX_F072_IRQ_DISPATCHER_H

platform/lock_jumper.h

@@ -1,6 +1,8 @@
 //
 // Created by MightyPork on 2017/12/15.
 //
+// Handling the lock jumper or button (used to make the config filesystem visible to the PC OS)
+//
 
 #ifndef GEX_LOCK_JUMPER_H
 #define GEX_LOCK_JUMPER_H

platform/plat_init.c

@@ -1,6 +1,8 @@
 //
 // Created by MightyPork on 2017/11/26.
 //
+// Initialize the platform. Belongs to platform.h
+//
 
 #include "platform.h"
 #include "comm/messages.h"

platform/platform.c

@@ -2,7 +2,6 @@
 // Created by MightyPork on 2017/11/26.
 //
 
-#include <stm32f072xb.h>
 #include "platform.h"
 #include "usbd_core.h"
 #include "USB/usb_device.h"

platform/platform.h

@@ -37,7 +37,7 @@
 // ---
 
 /**
- * Init the platform
+ * Init the platform (run before FreeRTOS starts)
  */
 void plat_init(void);
 

platform/status_led.h

@@ -1,6 +1,8 @@
 //
 // Created by MightyPork on 2017/12/15.
 //
+// Status LED blinking
+//
 
 #ifndef GEX_INDICATORS_H
 #define GEX_INDICATORS_H