misc cleanup (main_definitions, comments)

Author: aubsw

include/board/bootstub_definitions.h

@@ -1,28 +1,34 @@
 #pragma once
 #include "boards/board.h"
-// ******************** Prototypes ********************
-extern void print(const char *a);
-extern void puth(uint8_t i);
-extern void puth2(uint8_t i);
-extern void puth4(uint8_t i);
-extern void hexdump(const void *a, int l);
 
 // No UART support in bootloader
 typedef struct uart_ring {} uart_ring;
 extern uart_ring uart_ring_som_debug;
 extern uart_ring uart_ring_debug;
 extern uart_ring *get_ring_by_number(int a);
+
+// ******************** Prototypes ********************
+extern void print(const char *a);
+extern void puth(uint8_t i);
+extern void puth2(uint8_t i);
+extern void puth4(uint8_t i);
+extern void hexdump(const void *a, int l);
 extern void uart_init(uart_ring *q, int baud);
 extern bool put_char(uart_ring *q, char elem);
 
-// Varian CAN-related constants not needed in bootloader
-extern uint32_t uptime_cnt; // TODO: should this get a value?
-extern bool ignition_can;
-extern bool heartbeat_lost;
-extern bool bootkick_reset_triggered;
-extern const unsigned char dlc_to_len[];
-
 // ********************* Globals **********************
 extern uint8_t hw_type;
 extern board *current_board;
+extern uint32_t uptime_cnt; // TODO: should this get a value?
 
+// heartbeat state
+extern uint32_t heartbeat_counter;
+extern bool heartbeat_lost;
+
+// siren state
+extern bool siren_enabled;
+
+// Various CAN-related constants not needed in bootloader
+extern bool ignition_can;
+extern bool bootkick_reset_triggered;
+extern const unsigned char dlc_to_len[];

include/board/main_definitions.h

@@ -1,5 +1,4 @@
 #pragma once
-#include <stdint.h>
 #include "boards/board.h"
 
 // ******************** Prototypes ********************
@@ -9,10 +8,6 @@ extern void puth2(unsigned int i);
 extern void puth4(unsigned int i);
 extern void hexdump(const void *a, int l);
 
-//TODO(aubsw): Figure out the best spot to declare these. Currently inlined in pwm.h
-//void pwm_init(TIM_TypeDef *TIM, uint8_t channel);
-//void pwm_set(TIM_TypeDef *TIM, uint8_t channel, uint8_t percentage);
-
 // ********************* Globals **********************
 extern uint8_t hw_type;
 extern board *current_board;

include/board/platform_definitions.h

@@ -1,12 +1,13 @@
+/* Platform includes that provide things that a lot drivers need, e.g.:
+  __enable_irq
+  __disable_irq
+  GPIO_TypeDef
+  TIM_TypeDef
+  IRQn_Type
+  USART_TypeDef
+  CAN_TypeDef
+*/
 #pragma once
-// Platform includes that provide things that a lot drivers need, e.g.:
-//  __enable_irq
-//  __disable_irq
-//  GPIO_TypeDef
-//  TIM_TypeDef
-//  IRQn_Type
-//  USART_TypeDef
-//  CAN_TypeDef
 #define CAN_INIT_TIMEOUT_MS 500U
 #ifdef STM32H7
   #include "stm32h7/stm32h7_platform_definitions.h"