uc comments, format

Author: thinkyhead

Marlin/src/HAL/HC32/HAL.cpp

@@ -32,7 +32,7 @@
 #if ENABLED(EMERGENCY_PARSER)
 
 extern "C" void core_hook_usart_rx_irq(uint8_t ch, uint8_t usart) {
-  // only handle receive on host serial ports
+  // Only handle receive on host serial ports
   if (false
     #ifdef SERIAL_PORT
       || usart != SERIAL_PORT
@@ -47,7 +47,7 @@ extern "C" void core_hook_usart_rx_irq(uint8_t ch, uint8_t usart) {
     return;
   }
 
-  // submit character to emergency parser
+  // Submit character to emergency parser
   if (MYSERIAL1.emergency_parser_enabled())
     emergency_parser.update(MYSERIAL1.emergency_state, ch);
 }

Marlin/src/HAL/HC32/HAL.h

@@ -53,7 +53,7 @@
 #elif WITHIN(SERIAL_PORT, 1, NUM_UARTS)
   #define MYSERIAL1 MSERIAL(SERIAL_PORT)
 #else
-  #define MYSERIAL1 MSERIAL(1) // dummy port
+  #define MYSERIAL1 MSERIAL(1) // Dummy port
   static_assert(false, "SERIAL_PORT must be from 1 to " STRINGIFY(NUM_UARTS) ".")
 #endif
 
@@ -63,7 +63,7 @@
   #elif WITHIN(SERIAL_PORT_2, 1, NUM_UARTS)
     #define MYSERIAL2 MSERIAL(SERIAL_PORT_2)
   #else
-    #define MYSERIAL2 MSERIAL(1) // dummy port
+    #define MYSERIAL2 MSERIAL(1) // Dummy port
     static_assert(false, "SERIAL_PORT_2 must be from 1 to " STRINGIFY(NUM_UARTS) ".")
   #endif
 #endif
@@ -74,7 +74,7 @@
   #elif WITHIN(SERIAL_PORT_3, 1, NUM_UARTS)
     #define MYSERIAL3 MSERIAL(SERIAL_PORT_3)
   #else
-    #define MYSERIAL3 MSERIAL(1) // dummy port
+    #define MYSERIAL3 MSERIAL(1) // Dummy port
     static_assert(false, "SERIAL_PORT_3 must be from 1 to " STRINGIFY(NUM_UARTS) ".")
   #endif
 #endif
@@ -85,7 +85,7 @@
   #elif WITHIN(LCD_SERIAL_PORT, 1, NUM_UARTS)
     #define LCD_SERIAL MSERIAL(LCD_SERIAL_PORT)
   #else
-    #define LCD_SERIAL MSERIAL(1) // dummy port
+    #define LCD_SERIAL MSERIAL(1) // Dummy port
     static_assert(false, "LCD_SERIAL_PORT must be from 1 to " STRINGIFY(NUM_UARTS) ".")
   #endif
 
@@ -134,7 +134,7 @@
 // bss_end alias
 #define __bss_end __bss_end__
 
-// fix bug in pgm_read_ptr
+// Fix bug in pgm_read_ptr
 #undef pgm_read_ptr
 #define pgm_read_ptr(addr) (*(addr))
 

Marlin/src/HAL/HC32/MarlinHAL.cpp

@@ -27,7 +27,7 @@
 
 #include "../../inc/MarlinConfig.h"
 
-#include "HAL.h" // includes MarlinHAL.h
+#include "HAL.h" // Includes MarlinHAL.h
 #include <IWatchdog.h>
 #include <AsyncAnalogRead.h>
 
@@ -39,7 +39,7 @@
 extern "C" char *_sbrk(int incr);
 
 #if ENABLED(POSTMORTEM_DEBUGGING)
-  // from MinSerial.cpp
+  // From MinSerial.cpp
   extern void install_min_serial();
 #endif
 
@@ -87,7 +87,7 @@ extern "C" char *_sbrk(int incr);
       default: break;
     }
 
-    // done
+    // Done
     SERIAL_ECHOPGM("\n--\n");
   }
 #endif // MARLIN_DEV_MODE
@@ -210,7 +210,7 @@ void MarlinHAL::adc_init() {}
 void MarlinHAL::adc_enable(const pin_t pin) {
   #if TEMP_SENSOR_SOC
     if (pin == TEMP_SOC_PIN) {
-      // start OTS, min. 1s between reads
+      // Start OTS, min. 1s between reads
       ChipTemperature.begin();
       ChipTemperature.setMinimumReadDeltaMillis(1000);
       return;
@@ -226,7 +226,7 @@ void MarlinHAL::adc_start(const pin_t pin) {
 
   #if TEMP_SENSOR_SOC
     if (pin == TEMP_SOC_PIN) {
-      // read OTS
+      // Read OTS
       float temp;
       if (ChipTemperature.read(temp))
         MarlinHAL::soc_temp = temp;
@@ -262,11 +262,11 @@ uint16_t MarlinHAL::adc_value() {
 }
 
 void MarlinHAL::set_pwm_duty(const pin_t pin, const uint16_t value, const uint16_t scale, const bool invert) {
-  // invert value if requested
+  // Invert value if requested
   const uint16_t val = invert ? scale - value : value;
 
-  // analogWrite the value, core handles the rest
-  // pin mode should be set by Marlin by calling SET_PWM() before calling this function
+  // AnalogWrite the value, core handles the rest
+  // Pin mode should be set by Marlin by calling SET_PWM() before calling this function
   analogWriteScaled(pin, val, scale);
 }
 

Marlin/src/HAL/HC32/MarlinSerial.cpp

@@ -44,7 +44,7 @@ constexpr bool serial_handles_emergency(int port) {
 }
 
 //
-// define serial ports
+// Define serial ports
 //
 #define DEFINE_HWSERIAL_MARLIN(name, n)      \
   MSerialT name(serial_handles_emergency(n), \
@@ -56,7 +56,7 @@ DEFINE_HWSERIAL_MARLIN(MSerial1, 1);
 DEFINE_HWSERIAL_MARLIN(MSerial2, 2);
 
 //
-// serial port assertions
+// Serial port assertions
 //
 
 // Check the type of each serial port by passing it to a template function.

Marlin/src/HAL/HC32/MarlinSerial.h

@@ -24,7 +24,7 @@
 #include "../../core/serial_hook.h"
 #include <drivers/usart/Usart.h>
 
-// optionally set uart IRQ priority to reduce overflow errors
+// Optionally set uart IRQ priority to reduce overflow errors
 // #define UART_IRQ_PRIO 1
 
 struct MarlinSerial : public Usart {

Marlin/src/HAL/HC32/MinSerial.cpp

@@ -29,36 +29,36 @@
 #include <drivers/usart/usart_sync.h>
 
 //
-// shared by both panic and PostMortem debugging
+// Shared by both panic and PostMortem debugging
 //
 static void minserial_begin() {
   #if !WITHIN(SERIAL_PORT, 1, 3)
     #warning "MinSerial requires a physical UART port for output."
     #warning "Disabling MinSerial because the used serial port is not a HW port."
   #else
 
-    // prepare usart_sync configuration
+    // Prepare usart_sync configuration
     const stc_usart_uart_init_t usart_config = {
-        .enClkMode = UsartIntClkCkNoOutput,
-        .enClkDiv = UsartClkDiv_1,
-        .enDataLength = UsartDataBits8,
-        .enDirection = UsartDataLsbFirst,
-        .enStopBit = UsartOneStopBit,
-        .enParity = UsartParityNone,
-        .enSampleMode = UsartSampleBit8,
-        .enDetectMode = UsartStartBitFallEdge,
-        .enHwFlow = UsartRtsEnable,
+      .enClkMode = UsartIntClkCkNoOutput,
+      .enClkDiv = UsartClkDiv_1,
+      .enDataLength = UsartDataBits8,
+      .enDirection = UsartDataLsbFirst,
+      .enStopBit = UsartOneStopBit,
+      .enParity = UsartParityNone,
+      .enSampleMode = UsartSampleBit8,
+      .enDetectMode = UsartStartBitFallEdge,
+      .enHwFlow = UsartRtsEnable,
     };
 
-    // initializes usart_sync driver
+    // Initializes usart_sync driver
     #define __USART_SYNC_INIT(port_no, baud, config) \
       usart_sync_init(M4_USART##port_no,             \
                       BOARD_USART##port_no##_TX_PIN, \
                       baud,                          \
                       config);
     #define USART_SYNC_INIT(port_no, baud, config) __USART_SYNC_INIT(port_no, baud, config)
 
-    // this will reset the baudrate to what is defined in Configuration.h,
+    // This will reset the baudrate to what is defined in Configuration.h,
     // ignoring any changes made with e.g. M575.
     // keeping the dynamic baudrate would require re-calculating the baudrate
     // using the register values, which is a pain...
@@ -74,8 +74,7 @@ static void minserial_begin() {
 
 static void minserial_putc(char c) {
   #if WITHIN(SERIAL_PORT, 1, 3)
-    #define __USART_SYNC_PUTC(port_no, ch) \
-      usart_sync_putc(M4_USART##port_no, ch);
+    #define __USART_SYNC_PUTC(port_no, ch) usart_sync_putc(M4_USART##port_no, ch);
     #define USART_SYNC_PUTC(port_no, ch) __USART_SYNC_PUTC(port_no, ch)
 
     USART_SYNC_PUTC(SERIAL_PORT, c);
@@ -86,20 +85,19 @@ static void minserial_putc(char c) {
 }
 
 //
-// panic only
+// Panic only
 //
 #ifdef PANIC_ENABLE
+
 void panic_begin() {
   minserial_begin();
-
   panic_puts("\n\nPANIC:\n");
 }
 
 void panic_puts(const char *str) {
-  while (*str) {
-    minserial_putc(*str++);
-  }
+  while (*str) minserial_putc(*str++);
 }
+
 #endif // PANIC_ENABLE
 
 //
@@ -111,9 +109,9 @@ void panic_puts(const char *str) {
 #include <drivers/panic/fault_handlers.h>
 
 void fault_handlers_init() {
-  // enable cpu traps:
-  // - divide by zero
-  // - unaligned access
+  // Enable cpu traps:
+  // - Divide by zero
+  // - Unaligned access
   SCB->CCR |= SCB_CCR_DIV_0_TRP_Msk; //| SCB_CCR_UNALIGN_TRP_Msk;
 }
 
@@ -138,16 +136,14 @@ extern "C" {
 #endif // POSTMORTEM_DEBUGGING || PANIC_ENABLE
 
 //
-// panic_end is always required to print the '!!' to the host
+// Panic_end is always required to print the '!!' to the host
 //
 void panic_end() {
-  // print '!!' to signal error to host
-  // do it 10x so it's not missed
-  for (int i = 0; i < 10; i++) {
-    panic_printf("\n!!\n");
-  }
+  // Print '!!' to signal error to host
+  // Do it 10x so it's not missed
+  for (uint_fast8_t i = 10; i--;) panic_printf("\n!!\n");
 
-  // then, reset the board
+  // Then, reset the board
   NVIC_SystemReset();
 }
 

Marlin/src/HAL/HC32/Servo.cpp

@@ -43,18 +43,14 @@ MarlinServo::MarlinServo() {
 }
 
 int8_t MarlinServo::attach(const pin_t apin) {
-  // use last pin if pin not given
-  if (apin >= 0) {
-    this->pin = apin;
-  }
-
-  // if attached, do nothing but no fail
-  if (this->servo.attached()) {
-    return 0;
-  }
-
-  // attach
-  uint8_t rc = this->servo.attach(this->pin);
+  // Use last pin if pin not given
+  if (apin >= 0) this->pin = apin;
+
+  // If attached, do nothing but no fail
+  if (this->servo.attached()) return 0;
+
+  // Attach
+  const uint8_t rc = this->servo.attach(this->pin);
   return rc == INVALID_SERVO ? -1 : rc;
 }
 
@@ -72,11 +68,8 @@ void MarlinServo::write(servo_angle_t angle) {
 }
 
 void MarlinServo::move(servo_angle_t angle) {
-  // attach with pin=-1 to use last pin attach() was called with
-  if (attach(-1) < 0) {
-    // attach failed
-    return;
-  }
+  // Attach with pin=-1 to use last pin attach() was called with
+  if (attach(-1) < 0) return; // Attach failed
 
   write(angle);
   safe_delay(servoDelays[this->channel]);

Marlin/src/HAL/HC32/Servo.h

@@ -93,5 +93,5 @@ class MarlinServo {
   servo_angle_t angle;
 };
 
-// alias for marlin HAL
+// Alias for marlin HAL
 typedef MarlinServo hal_servo_t;

Marlin/src/HAL/HC32/eeprom_sdcard.cpp

@@ -46,32 +46,23 @@ size_t PersistentStore::capacity() {
 static char _ALIGN(4) HAL_eeprom_data[MARLIN_EEPROM_SIZE];
 
 bool PersistentStore::access_start() {
-  if (!card.isMounted()) {
-    return false;
-  }
+  if (!card.isMounted()) return false;
 
   MediaFile file, root = card.getroot();
-  if (!file.open(&root, EEPROM_FILENAME, O_RDONLY)) {
-    return true; // false aborts the save
-  }
+  if (!file.open(&root, EEPROM_FILENAME, O_RDONLY)) return true; // False aborts the save
 
   int bytes_read = file.read(HAL_eeprom_data, MARLIN_EEPROM_SIZE);
-  if (bytes_read < 0) {
-    return false;
-  }
+  if (bytes_read < 0) return false;
 
-  for (; bytes_read < MARLIN_EEPROM_SIZE; bytes_read++) {
+  for (; bytes_read < MARLIN_EEPROM_SIZE; bytes_read++)
     HAL_eeprom_data[bytes_read] = 0xFF;
-  }
 
   file.close();
   return true;
 }
 
 bool PersistentStore::access_finish() {
-  if (!card.isMounted()) {
-    return false;
-  }
+  if (!card.isMounted()) return false;
 
   MediaFile file, root = card.getroot();
   int bytes_written = 0;
@@ -84,9 +75,7 @@ bool PersistentStore::access_finish() {
 }
 
 bool PersistentStore::write_data(int &pos, const uint8_t *value, size_t size, uint16_t *crc) {
-  for (size_t i = 0; i < size; i++) {
-    HAL_eeprom_data[pos + i] = value[i];
-  }
+  for (size_t i = 0; i < size; i++) HAL_eeprom_data[pos + i] = value[i];
 
   crc16(crc, value, size);
   pos += size;
@@ -96,10 +85,7 @@ bool PersistentStore::write_data(int &pos, const uint8_t *value, size_t size, ui
 bool PersistentStore::read_data(int &pos, uint8_t *value, const size_t size, uint16_t *crc, const bool writing /*=true*/) {
   for (size_t i = 0; i < size; i++) {
     uint8_t c = HAL_eeprom_data[pos + i];
-    if (writing) {
-      value[i] = c;
-    }
-
+    if (writing) value[i] = c;
     crc16(crc, &c, 1);
   }