rename some functions

Author: irvingywang

source/a_box/main.c

@@ -95,4 +95,4 @@ void HardFault_Handler() {
     while (1) {
         __asm__("NOP"); // Halt forever
     }
-}
+}

source/dashboard/lcd/lcd.c

@@ -489,7 +489,7 @@ void updatePage() {
         page_handlers[curr_page].update();
     }
 
-    lcdTxUpdate();
+    lcd_tx_cmd();
 }
 
 void moveUp() {

source/dashboard/main.c

@@ -124,14 +124,12 @@ extern page_t curr_page;
 volatile dashboard_input_state_t input_state = {0}; // Clear all input states
 
 /* Function Prototypes */
-void preflightAnimation(void);
-void heartBeatLED();
-void lcdTxUpdate();
-void enableInterrupts();
-void encoderISR();
-void handleDashboardInputs();
-void sendBrakeStatus();
-void sendVersion();
+void preflight_animation(void);
+void heartbeat_led();
+void lcd_tx_cmd();
+void config_button_irqs();
+void service_button_inputs();
+void send_version();
 extern void HardFault_Handler();
 
 // Communication queues
@@ -140,59 +138,21 @@ q_handle_t q_tx_usart;
 void preflight_task();
 void can_worker_task();
 
-// The preflight thread must not be interrupted, give highest priority
+// The preflight thread must not be interrupted, give highest priority (will self exit when finished)
 defineThreadStack(preflight_task, 10, osPriorityRealtime, 1024);
 
+// System critical threads
 defineThreadStack(pedalsPeriodic, FILT_THROTTLE_BRAKE_PERIOD_MS, osPriorityHigh, 512);
 defineThreadStack(can_worker_task, 20, osPriorityNormal, 512);
 
+// Auxilary threads
 defineThreadStack(updateFaultDisplay, 500, osPriorityLow, 256);
-defineThreadStack(heartBeatLED, 500, osPriorityLow, 128);
-defineThreadStack(handleDashboardInputs, 50, osPriorityLow, 1024);
-defineThreadStack(sendVersion, DASH_VERSION_PERIOD_MS, osPriorityLow, 256);
+defineThreadStack(heartbeat_led, 500, osPriorityLow, 128);
+defineThreadStack(service_button_inputs, 50, osPriorityLow, 1024);
+defineThreadStack(send_version, DASH_VERSION_PERIOD_MS, osPriorityLow, 256);
 defineThreadStack(updateTelemetryPages, 200, osPriorityLow, 1024);
 defineThreadStack(sendTVParameters, DASHBOARD_VCU_PARAMETERS_PERIOD_MS, osPriorityLow, 256);
 
-void preflight_task() {
-    static uint8_t counter = 0;
-
-    // run animation until for at least 1.5 seconds
-    if (counter >= 150) {
-        PHAL_writeGPIO(HEART_LED_GPIO_Port, HEART_LED_Pin, 0);
-        PHAL_writeGPIO(CONN_LED_GPIO_Port, CONN_LED_Pin, 0);
-        PHAL_writeGPIO(ERROR_LED_GPIO_Port, ERROR_LED_Pin, 0);
-
-        // spawn the other threads
-        createThread(pedalsPeriodic);
-        createThread(can_worker_task);
-
-        createThread(updateFaultDisplay)
-        createThread(heartBeatLED)
-        createThread(handleDashboardInputs)
-        createThread(sendVersion)
-        createThread(updateTelemetryPages)
-        createThread(sendTVParameters)
-        osThreadExit(); // Self delete
-        return;
-    }
-
-    if (counter % 10 == 0) { // Run every 100ms
-        preflightAnimation();
-    }
-    
-    counter++;
-}
-
-void can_worker_task() {
-    // Process all received CAN messages
-    CAN_rx_update();
-
-    // Drain all CAN transmit queues
-    CAN_tx_update();
-
-    lcdTxUpdate();
-}
-
 int main(void) {
     // Hardware Initialization
     if (0 != PHAL_configureClockRates(&clock_config)) {
@@ -216,13 +176,13 @@ int main(void) {
     PHAL_startTxfer(&adc_dma_config);
     PHAL_startADC(&adc_config);
 
-    // Begin Software Init tasks
+    // Software Initialization
     osKernelInitialize();
 
     CAN_library_init();
     initLCD();
     NVIC_EnableIRQ(FDCAN2_IT0_IRQn);
-    enableInterrupts();
+    config_button_irqs();
 
     // show signs of life
     PHAL_writeGPIO(BMS_LED_GPIO_Port, BMS_LED_Pin, 1);
@@ -242,7 +202,47 @@ int main(void) {
     return 0;
 }
 
-void preflightAnimation(void) {
+void preflight_task() {
+    static uint8_t counter = 0;
+
+    // run animation until for at least 1.5 seconds
+    if (counter >= 150) {
+        PHAL_writeGPIO(HEART_LED_GPIO_Port, HEART_LED_Pin, 0);
+        PHAL_writeGPIO(CONN_LED_GPIO_Port, CONN_LED_Pin, 0);
+        PHAL_writeGPIO(ERROR_LED_GPIO_Port, ERROR_LED_Pin, 0);
+
+        // spawn the other threads
+        createThread(pedalsPeriodic);
+        createThread(can_worker_task);
+
+        createThread(updateFaultDisplay)
+        createThread(heartbeat_led)
+        createThread(service_button_inputs)
+        createThread(send_version)
+        createThread(updateTelemetryPages)
+        createThread(sendTVParameters)
+        osThreadExit(); // Self delete
+        return;
+    }
+
+    if (counter % 10 == 0) { // Run every 100ms
+        preflight_animation();
+    }
+    
+    counter++;
+}
+
+void can_worker_task() {
+    // Process all received CAN messages
+    CAN_rx_update();
+
+    // Drain all CAN transmit queues
+    CAN_tx_update();
+
+    lcd_tx_cmd();
+}
+
+void preflight_animation(void) {
     // Controls external LEDs since they are more visible when dash is in car
     static uint32_t external_index;
     static uint32_t sweep_index;
@@ -279,7 +279,7 @@ void preflightAnimation(void) {
     }
 }
 
-void sendVersion() {
+void send_version() {
     CAN_SEND_dash_version(GIT_HASH);
 }
 
@@ -291,7 +291,7 @@ void sendVersion() {
  * Controls heartbeat, connection, precharge, IMD and BMS status LEDs.
  * Handles periodic CAN statistics transmission.
  */
-void heartBeatLED() {
+void heartbeat_led() {
     static uint8_t imd_prev_latched;
     static uint8_t bms_prev_latched;
 
@@ -371,7 +371,7 @@ void EXTI15_10_IRQHandler() {
  *
  * Meant to be called periodically.
  */
-void handleDashboardInputs() {
+void service_button_inputs() {
     if (input_state.up_button) {
         input_state.up_button = 0;
         moveUp();
@@ -408,7 +408,7 @@ void handleDashboardInputs() {
     }
 }
 
-void enableInterrupts() {
+void config_button_irqs() {
     // Enable the SYSCFG clock for interrupts
     RCC->APB2ENR |= RCC_APB2ENR_SYSCFGEN;
 
@@ -441,7 +441,7 @@ void enableInterrupts() {
  * @note The queue holds a max of 10 commands. Design your LCD page updates with this in mind.
  */
 char cmd[NXT_STR_SIZE] = {'\0'}; // Buffer for Nextion LCD commands
-void lcdTxUpdate() {
+void lcd_tx_cmd() {
     if ((false == PHAL_usartTxBusy(&lcd)) && (SUCCESS_G == qReceive(&q_tx_usart, cmd))) {
         PHAL_usartTxDma(&lcd, (uint8_t *)cmd, strlen(cmd));
     }

source/dashboard/main.h

@@ -121,6 +121,6 @@ typedef struct {
 #define LCD_UART_RX_GPIO_Port (GPIOA)
 #define LCD_UART_RX_Pin       (10)
 
-void lcdTxUpdate();
+void lcd_tx_cmd();
 
 #endif

source/main_module/main.c

@@ -154,9 +154,9 @@ dma_init_t adc_dma_config = ADC1_DMA_CONT_CONFIG((uint32_t)&adc_readings,
 /* -------------------------------------------------------
     Procedures
 -------------------------------------------------------- */
-void preflightAnimation(void);
+void preflight_animation(void);
 void preflightChecks(void);
-void heartBeatLED();
+void heartbeat_led();
 void send_fault(uint16_t, bool);
 extern void HardFault_Handler();
 void interpretLoadSensor(void);
@@ -179,11 +179,11 @@ int main(void) {
     schedInit(APB1ClockRateHz);
 
     /* Preflight */
-    configureAnim(preflightAnimation, preflightChecks, 60, 750);
+    configureAnim(preflight_animation, preflightChecks, 60, 750);
 
     /* Periodic Tasks */
     taskCreate(coolingPeriodic, 50);
-    taskCreate(heartBeatLED, 500);
+    taskCreate(heartbeat_led, 500);
     taskCreate(monitorSDCPeriodic, 20);
     taskCreate(carHeartbeat, 500);
     taskCreate(carPeriodic, 15);
@@ -282,7 +282,7 @@ void preflightChecks(void) {
     }
 }
 
-void preflightAnimation(void) {
+void preflight_animation(void) {
     static uint32_t time;
 
     PHAL_writeGPIO(HEARTBEAT_GPIO_Port, HEARTBEAT_Pin, 0);
@@ -305,7 +305,7 @@ void preflightAnimation(void) {
     }
 }
 
-void heartBeatLED(void) {
+void heartbeat_led(void) {
     static uint8_t trig;
     PHAL_toggleGPIO(HEARTBEAT_GPIO_Port, HEARTBEAT_Pin);
     if ((sched.os_ticks - last_can_rx_time_ms) >= CONN_LED_MS_THRESH) {

source/pdu/main.c

@@ -161,7 +161,7 @@ extern uint32_t AHBClockRateHz;
 extern uint32_t PLLClockRateHz;
 
 void HardFault_Handler();
-void preflightAnimation();
+void preflight_animation();
 void preflightChecks(void);
 void heatBeatLED();
 void send_iv_readings();
@@ -192,7 +192,7 @@ int main() {
 
     /* Task Creation */
     schedInit(APB1ClockRateHz);
-    configureAnim(preflightAnimation, preflightChecks, 20, 750);
+    configureAnim(preflight_animation, preflightChecks, 20, 750);
 
     /* Schedule Periodic tasks here */
     taskCreate(heatBeatLED, 500);
@@ -255,7 +255,7 @@ void preflightChecks(void) {
     }
 }
 
-void preflightAnimation(void) {
+void preflight_animation(void) {
     static uint32_t time;
     static int led_number;
     static bool led_decrement = false;

source/torque_vector/main.c

@@ -142,8 +142,8 @@ static uint16_t rxbuffer[(sizeof(rxmsg) + 1) / 2];
 static uint8_t txbuffer[2 + sizeof(txmsg)] = {0xAA, 0x55};
 
 /* Function Prototypes */
-void heartBeatLED(void);
-void preflightAnimation(void);
+void heartbeat_led(void);
+void preflight_animation(void);
 void preflightChecks(void);
 void reportIMU(void);
 void reportGPS(void);
@@ -174,12 +174,12 @@ int main(void) {
 
     /* Task Creation */
     schedInit(APB1ClockRateHz);
-    configureAnim(preflightAnimation, preflightChecks, 74, 1000);
+    configureAnim(preflight_animation, preflightChecks, 74, 1000);
 
     taskCreateBackground(CAN_tx_update);
     taskCreateBackground(CAN_rx_update);
 
-    taskCreate(heartBeatLED, 500);
+    taskCreate(heartbeat_led, 500);
     taskCreate(parseIMU, 20);
     taskCreate(VCU_MAIN, 20);
     taskCreate(reportIMU, IMU_ACCEL_PERIOD_MS);
@@ -312,7 +312,7 @@ void preflightChecks(void) {
     }
 }
 
-void preflightAnimation(void) {
+void preflight_animation(void) {
     static uint32_t time;
 
     PHAL_writeGPIO(HEARTBEAT_GPIO_Port, HEARTBEAT_Pin, 0);
@@ -335,7 +335,7 @@ void preflightAnimation(void) {
     }
 }
 
-void heartBeatLED(void) {
+void heartbeat_led(void) {
     PHAL_toggleGPIO(HEARTBEAT_GPIO_Port, HEARTBEAT_Pin);
 
     if ((sched.os_ticks - can_data.main_hb.last_rx) >= CONN_LED_MS_THRESH)