Add comments

ZuluSCSI · Dec 3, 2024 · a2d07d3 · a2d07d3
1 parent 8ba8cf0
commit a2d07d3
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/lib/ZuluSCSI_platform_GD32F205/ZuluSCSI_platform.h b/lib/ZuluSCSI_platform_GD32F205/ZuluSCSI_platform.h
@@ -84,11 +84,13 @@ void platform_late_init();
 // Initialization after the SD Card has been found
 void platform_post_sd_card_init();
 
-// Write the status LED
+// Set the status LED only if it is not in a blinking routine
 void platform_write_led(bool state);
 #define LED_ON()  platform_write_led(true)
 #define LED_OFF() platform_write_led(false)
+// Used by the blinking routine
 void platform_set_blink_status(bool status);
+// LED override will set the status LED regardless of the blinking routine
 void platform_write_led_override(bool state);
 #define LED_ON_OVERRIDE()  platform_write_led_override(true)
 #define LED_OFF_OVERRIDE()  platform_write_led_override(false)

diff --git a/lib/ZuluSCSI_platform_GD32F450/ZuluSCSI_platform.h b/lib/ZuluSCSI_platform_GD32F450/ZuluSCSI_platform.h
@@ -76,11 +76,13 @@ void platform_post_sd_card_init();
 // Hooks
 void platform_end_of_loop_hook(void);
 
-// Write the status LED
+// Set the status LED only if it is not in a blinking routine
 void platform_write_led(bool state);
 #define LED_ON()  platform_write_led(true)
 #define LED_OFF() platform_write_led(false)
+// Used by the blinking routine
 void platform_set_blink_status(bool status);
+// LED override will set the status LED regardless of the blinking routine
 void platform_write_led_override(bool state);
 #define LED_ON_OVERRIDE()  platform_write_led_override(true)
 #define LED_OFF_OVERRIDE()  platform_write_led_override(false)

diff --git a/lib/ZuluSCSI_platform_RP2MCU/ZuluSCSI_platform.h b/lib/ZuluSCSI_platform_RP2MCU/ZuluSCSI_platform.h
@@ -90,11 +90,13 @@ void platform_late_init();
 // Initialization after the SD Card has been found
 void platform_post_sd_card_init();
 
-// Write the status LED
+// Set the status LED only if it is not in a blinking routine
 void platform_write_led(bool state);
 #define LED_ON()  platform_write_led(true)
 #define LED_OFF() platform_write_led(false)
+// Used by the blinking routine
 void platform_set_blink_status(bool status);
+// LED override will set the status LED regardless of the blinking routine
 void platform_write_led_override(bool state);
 #define LED_ON_OVERRIDE()  platform_write_led_override(true)
 #define LED_OFF_OVERRIDE()  platform_write_led_override(false)