♻️ Binary Stream

Author: thinkyhead

Marlin/src/core/mstring.h

@@ -318,5 +318,5 @@ class MString {
 #ifndef TS_SIZE
   #define TS_SIZE 63
 #endif
-typedef MString<TS_SIZE, DISABLED(UNSAFE_MSTRING)> TString;
+typedef MString<TS_SIZE> TString;
 #define TS(V...) TString(V)

Marlin/src/feature/binary_stream.cpp

@@ -28,7 +28,8 @@
 #include "binary_stream.h"
 
 char* SDFileTransferProtocol::Packet::Open::data = nullptr;
-size_t SDFileTransferProtocol::data_waiting, SDFileTransferProtocol::transfer_timeout, SDFileTransferProtocol::idle_timeout;
+size_t SDFileTransferProtocol::data_waiting;
+TDelay<SDFileTransferProtocol::TIMEOUT> SDFileTransferProtocol::transfer_timeout;
 bool SDFileTransferProtocol::transfer_active, SDFileTransferProtocol::dummy_transfer, SDFileTransferProtocol::compression;
 
 BinaryStream binaryStream[NUM_SERIAL];

Marlin/src/feature/binary_stream.h

@@ -40,6 +40,9 @@ inline int bs_read_serial(const serial_index_t index) {
 }
 
 class SDFileTransferProtocol  {
+public:
+  static const uint16_t VERSION_MAJOR = 0, VERSION_MINOR = 1, VERSION_PATCH = 0, TIMEOUT = 10000, IDLE_PERIOD = 1000;
+
 private:
   struct Packet {
     struct [[gnu::packed]] Open {
@@ -128,22 +131,24 @@ class SDFileTransferProtocol  {
 
   enum class FileTransfer : uint8_t { QUERY, OPEN, CLOSE, WRITE, ABORT };
 
-  static size_t data_waiting, transfer_timeout, idle_timeout;
+  static size_t data_waiting;
+  static TDelay<TIMEOUT> transfer_timeout;
   static bool transfer_active, dummy_transfer, compression;
 
 public:
 
   static void idle() {
-    // If a transfer is interrupted and a file is left open, abort it after 'idle_period' ms
-    const millis_t ms = millis();
-    if (transfer_active && ELAPSED(ms, idle_timeout)) {
-      idle_timeout = ms + idle_period;
-      if (ELAPSED(ms, transfer_timeout)) transfer_abort();
+    // If a transfer is interrupted and a file is left open, abort it after TIMEOUT ms
+    static TDelay<IDLE_PERIOD> idle_timeout;
+    const uint16_t ms = millis16();
+    if (transfer_active && idle_timeout.elapsed(ms)) {
+      idle_timeout.prime(ms);
+      if (transfer_timeout.elapsed(ms)) transfer_abort();
     }
   }
 
   static void process(uint8_t packet_type, char *buffer, const uint16_t length) {
-    transfer_timeout = millis() + timeout;
+    transfer_timeout.prime();
     switch (static_cast<FileTransfer>(packet_type)) {
       case FileTransfer::QUERY:
         SERIAL_ECHO(F("PFT:version:"), version_major, C('.'), version_minor, C('.'), version_patch);
@@ -206,6 +211,8 @@ class BinaryStream {
   enum class StreamState : uint8_t { PACKET_RESET, PACKET_WAIT, PACKET_HEADER, PACKET_DATA, PACKET_FOOTER,
                                      PACKET_PROCESS, PACKET_RESEND, PACKET_TIMEOUT, PACKET_ERROR };
 
+  static const uint16_t PACKET_MAX_WAIT = 500, RX_TIMESLICE = 20, MAX_RETRIES = 0, VERSION_MAJOR = 0, VERSION_MINOR = 1, VERSION_PATCH = 0;
+
   struct Packet { // 10 byte protocol overhead, ascii with checksum and line number has a minimum of 7 increasing with line
 
     union Header {
@@ -236,7 +243,7 @@ class BinaryStream {
     Footer footer;
     uint32_t bytes_received;
     uint16_t checksum, header_checksum;
-    millis_t timeout;
+    TDelay<PACKET_MAX_WAIT> max_wait;
     char* buffer;
 
     void reset() {
@@ -245,7 +252,7 @@ class BinaryStream {
       bytes_received = 0;
       checksum = 0;
       header_checksum = 0;
-      timeout = millis() + packet_max_wait;
+      max_wait.prime();
       buffer = nullptr;
     }
   } packet{};
@@ -258,28 +265,28 @@ class BinaryStream {
 
   // fletchers 16 checksum
   uint32_t checksum(uint32_t cs, uint8_t value) {
-    uint16_t cs_low = (((cs & 0xFF) + value) % 255);
-    return ((((cs >> 8) + cs_low) % 255) << 8)  | cs_low;
+    const uint16_t cs_low = (((cs & 0xFF) + value) % 255);
+    return ((((cs >> 8) + cs_low) % 255) << 8) | cs_low;
   }
 
   // read the next byte from the data stream keeping track of
   // whether the stream times out from data starvation
   // takes the data variable by reference in order to return status
   bool stream_read(uint8_t& data) {
-    if (stream_state != StreamState::PACKET_WAIT && ELAPSED(millis(), packet.timeout)) {
+    if (stream_state != StreamState::PACKET_WAIT && packet.max_wait.pending()) {
       stream_state = StreamState::PACKET_TIMEOUT;
       return false;
     }
     if (!bs_serial_data_available(card.transfer_port_index)) return false;
     data = bs_read_serial(card.transfer_port_index);
-    packet.timeout = millis() + packet_max_wait;
+    packet.max_wait.prime();
     return true;
   }
 
   template<const size_t buffer_size>
   void receive(char (&buffer)[buffer_size]) {
     uint8_t data = 0;
-    millis_t transfer_window = millis() + rx_timeslice;
+    const TDelay<rx_timeslice> transfer_window;
 
     #if HAS_MEDIA
       PORT_REDIRECT(SERIAL_PORTMASK(card.transfer_port_index));
@@ -288,7 +295,7 @@ class BinaryStream {
     #pragma GCC diagnostic push
     #pragma GCC diagnostic ignored "-Warray-bounds"
 
-    while (PENDING(millis(), transfer_window)) {
+    while (transfer_window.pending()) {
       switch (stream_state) {
          /**
           * Data stream packet handling

buildroot/tests/STM32F103RE_btt_USB

@@ -17,7 +17,7 @@ exec_test $1 $2 "BigTreeTech SKR E3 DIP v1.0 - Basic Configuration" "$3"
 restore_configs
 opt_set MOTHERBOARD BOARD_BTT_SKR_CR6 SERIAL_PORT -1 SERIAL_PORT_2 2 TEMP_SENSOR_BED 1 BUTTON1_PIN PA12
 opt_enable CR10_STOCKDISPLAY SDSUPPORT EMERGENCY_PARSER FAN_SOFT_PWM \
-           NOZZLE_AS_PROBE Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN Z_SAFE_HOMING \
+           NOZZLE_AS_PROBE Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN Z_SAFE_HOMING WAIT_FOR_BED_HEATER \
            PROBE_ACTIVATION_SWITCH PROBE_TARE PROBE_TARE_ONLY_WHILE_INACTIVE \
            PROBING_HEATERS_OFF PREHEAT_BEFORE_PROBING CUSTOM_USER_BUTTONS BUTTON1_IMMEDIATE \
            CUSTOM_MENU_MAIN MAIN_MENU_ITEM_1_CONFIRM MAIN_MENU_ITEM_2_IMMEDIATE MAIN_MENU_ITEM_3_DESC MAIN_MENU_ITEM_3_GCODE \

buildroot/tests/STM32F446VE_fysetc

@@ -17,9 +17,10 @@ exec_test $1 $2 "FYSETC S6 Example" "$3"
 # Build with FTDI Eve Touch UI and some features
 #
 restore_configs
-opt_set MOTHERBOARD BOARD_FYSETC_S6_V2_0 SERIAL_PORT 1 X_DRIVER_TYPE TMC2130
+opt_set MOTHERBOARD BOARD_FYSETC_S6_V2_0 SERIAL_PORT 1 X_DRIVER_TYPE TMC2130 \
+        TEMP_SENSOR_PROBE 1 TEMP_PROBE_PIN PB6
 opt_enable TOUCH_UI_FTDI_EVE LCD_FYSETC_TFT81050 S6_TFT_PINMAP LCD_LANGUAGE_2 SDSUPPORT CUSTOM_MENU_MAIN \
-           FIX_MOUNTED_PROBE AUTO_BED_LEVELING_UBL Z_SAFE_HOMING \
+           FIX_MOUNTED_PROBE PTC_PROBE PTC_BED AUTO_BED_LEVELING_UBL Z_SAFE_HOMING \
            EEPROM_SETTINGS PRINTCOUNTER CALIBRATION_GCODE LIN_ADVANCE \
            FILAMENT_RUNOUT_SENSOR ADVANCED_PAUSE_FEATURE NOZZLE_PARK_FEATURE
 exec_test $1 $2 "FYSETC S6 2 with LCD FYSETC TFT81050" "$3"

buildroot/tests/mega1280

@@ -49,7 +49,8 @@ exec_test $1 $2 "ZRIB_V52 | DUAL_X_CARRIAGE" "$3"
 # Delta Config (generic) + Probeless
 #
 use_example_configs delta/generic
-opt_enable REPRAP_DISCOUNT_SMART_CONTROLLER DELTA_AUTO_CALIBRATION DELTA_CALIBRATION_MENU
+opt_enable REPRAP_DISCOUNT_SMART_CONTROLLER DELTA_AUTO_CALIBRATION DELTA_CALIBRATION_MENU \
+           LCD_PROGRESS_BAR LCD_PROGRESS_BAR_TEST
 exec_test $1 $2 "RAMPS | DELTA | RRD LCD | DELTA_AUTO_CALIBRATION | DELTA_CALIBRATION_MENU" "$3"
 
 #

buildroot/tests/mega2560

@@ -63,7 +63,7 @@ opt_set MOTHERBOARD BOARD_AZTEEG_X3_PRO NUM_SERVOS 1 \
         EXTRUDERS 4 TEMP_SENSOR_1 1 TEMP_SENSOR_2 1 TEMP_SENSOR_3 1 TEMP_SENSOR_4 1 FAN_KICKSTART_TIME 500 \
         NUM_RUNOUT_SENSORS 4 FIL_RUNOUT2_PIN 44 FIL_RUNOUT3_PIN 45 FIL_RUNOUT4_PIN 46 \
         FIL_RUNOUT3_STATE HIGH FILAMENT_RUNOUT_SCRIPT '"M600 T%c"'
-opt_enable VIKI2 BOOT_MARLIN_LOGO_ANIMATED SDSUPPORT AUTO_REPORT_SD_STATUS \
+opt_enable VIKI2 BOOT_MARLIN_LOGO_ANIMATED SDSUPPORT AUTO_REPORT_SD_STATUS BINARY_FILE_TRANSFER \
            Z_PROBE_SERVO_NR Z_SERVO_ANGLES Z_SERVO_MEASURE_ANGLE DEACTIVATE_SERVOS_AFTER_MOVE Z_SERVO_DEACTIVATE_AFTER_STOW \
            AUTO_BED_LEVELING_3POINT DEBUG_LEVELING_FEATURE PROBE_PT_1 PROBE_PT_2 PROBE_PT_3 PROBE_WAKEUP_TIME_MS \
            EEPROM_SETTINGS EEPROM_CHITCHAT M114_DETAIL AUTO_REPORT_POSITION \

buildroot/tests/rambo

@@ -12,23 +12,17 @@ set -e
 restore_configs
 opt_set MOTHERBOARD BOARD_RAMBO \
         EXTRUDERS 2 TEMP_SENSOR_0 -2 TEMP_SENSOR_1 1 TEMP_SENSOR_BED 2 \
-        TEMP_SENSOR_PROBE 1 TEMP_PROBE_PIN 12 \
         TEMP_SENSOR_CHAMBER 3 TEMP_CHAMBER_PIN 3 HEATER_CHAMBER_PIN 45 \
         PLR_HEAT_BED_EXTRA 5 PLR_BED_THRESHOLD 60 \
         GRID_MAX_POINTS_X 16 BACKLASH_MEASUREMENT_FEEDRATE 600 \
         AUTO_POWER_E_TEMP 80 FANMUX0_PIN 53 FIL_MOTION1_PIN 45
 opt_disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN USE_WATCHDOG
-opt_enable REPRAP_DISCOUNT_SMART_CONTROLLER LCD_PROGRESS_BAR LCD_PROGRESS_BAR_TEST \
-           FIX_MOUNTED_PROBE CODEPENDENT_XY_HOMING PIDTEMPBED PTC_PROBE PTC_BED \
-           PREHEAT_BEFORE_PROBING PROBING_HEATERS_OFF PROBING_FANS_OFF PROBING_STEPPERS_OFF WAIT_FOR_BED_HEATER \
-           EEPROM_SETTINGS SDSUPPORT SD_REPRINT_LAST_SELECTED_FILE BINARY_FILE_TRANSFER \
+opt_enable REPRAP_DISCOUNT_SMART_CONTROLLER \
+           FIX_MOUNTED_PROBE EEPROM_SETTINGS SDSUPPORT SD_REPRINT_LAST_SELECTED_FILE \
            BLINKM PCA9533 PCA9632 RGB_LED RGB_LED_R_PIN RGB_LED_G_PIN RGB_LED_B_PIN LED_CONTROL_MENU \
            NEOPIXEL_LED NEOPIXEL_PIN CASE_LIGHT_ENABLE CASE_LIGHT_USE_NEOPIXEL CASE_LIGHT_MENU \
            PID_PARAMS_PER_HOTEND PID_AUTOTUNE_MENU PID_EDIT_MENU PID_EXTRUSION_SCALING LCD_SHOW_E_TOTAL \
            PRINTCOUNTER SERVICE_NAME_1 SERVICE_INTERVAL_1 LCD_BED_TRAMMING BED_TRAMMING_INCLUDE_CENTER \
-           NOZZLE_PARK_FEATURE FILAMENT_RUNOUT_SENSOR FILAMENT_RUNOUT_DISTANCE_MM FILAMENT_MOTION_SENSOR FILAMENT_SWITCH_AND_MOTION \
-           ADVANCED_PAUSE_FEATURE FILAMENT_LOAD_UNLOAD_GCODES FILAMENT_UNLOAD_ALL_EXTRUDERS \
-           PASSWORD_FEATURE PASSWORD_ON_STARTUP PASSWORD_ON_SD_PRINT_MENU PASSWORD_AFTER_SD_PRINT_END PASSWORD_AFTER_SD_PRINT_ABORT \
            AUTO_BED_LEVELING_BILINEAR Z_MIN_PROBE_REPEATABILITY_TEST DISTINCT_E_FACTORS \
            SKEW_CORRECTION SKEW_CORRECTION_FOR_Z SKEW_CORRECTION_GCODE ONE_CLICK_PRINT NO_SD_AUTOSTART \
            BACKLASH_COMPENSATION BACKLASH_GCODE BAUD_RATE_GCODE BEZIER_CURVE_SUPPORT \
@@ -59,6 +53,7 @@ opt_set MOTHERBOARD BOARD_RAMBO \
 opt_enable REPRAP_DISCOUNT_FULL_GRAPHIC_SMART_CONTROLLER REVERSE_ENCODER_DIRECTION SDSUPPORT EEPROM_SETTINGS \
            S_CURVE_ACCELERATION X_DUAL_ENDSTOPS Y_DUAL_ENDSTOPS \
            ADAPTIVE_STEP_SMOOTHING CNC_COORDINATE_SYSTEMS GCODE_MOTION_MODES \
+           PASSWORD_FEATURE PASSWORD_ON_STARTUP PASSWORD_ON_SD_PRINT_MENU PASSWORD_AFTER_SD_PRINT_END PASSWORD_AFTER_SD_PRINT_ABORT \
            LCD_INFO_MENU LCD_BED_TRAMMING BED_TRAMMING_INCLUDE_CENTER
 opt_disable MIN_SOFTWARE_ENDSTOP_Z MAX_SOFTWARE_ENDSTOPS
 exec_test $1 $2 "Rambo CNC Configuration" "$3"