From 05abe853f95c0db31f3c8c5309e67d4c5949f81d Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Sat, 4 Mar 2017 18:01:22 -0600 Subject: [PATCH 1/5] New option: NO_WORKSPACE_OFFSETS --- Marlin/Configuration_adv.h | 9 +++++++++ .../example_configurations/Cartesio/Configuration_adv.h | 9 +++++++++ Marlin/example_configurations/Felix/Configuration_adv.h | 9 +++++++++ .../example_configurations/Hephestos/Configuration_adv.h | 9 +++++++++ .../Hephestos_2/Configuration_adv.h | 9 +++++++++ Marlin/example_configurations/K8200/Configuration_adv.h | 9 +++++++++ Marlin/example_configurations/K8400/Configuration_adv.h | 9 +++++++++ .../example_configurations/RigidBot/Configuration_adv.h | 9 +++++++++ Marlin/example_configurations/SCARA/Configuration_adv.h | 9 +++++++++ Marlin/example_configurations/TAZ4/Configuration_adv.h | 9 +++++++++ Marlin/example_configurations/WITBOX/Configuration_adv.h | 9 +++++++++ .../delta/generic/Configuration_adv.h | 9 +++++++++ .../delta/kossel_mini/Configuration_adv.h | 9 +++++++++ .../delta/kossel_pro/Configuration_adv.h | 9 +++++++++ .../delta/kossel_xl/Configuration_adv.h | 9 +++++++++ .../example_configurations/makibox/Configuration_adv.h | 9 +++++++++ .../tvrrug/Round2/Configuration_adv.h | 9 +++++++++ 17 files changed, 153 insertions(+) diff --git a/Marlin/Configuration_adv.h b/Marlin/Configuration_adv.h index 247b672722..8e1c520989 100644 --- a/Marlin/Configuration_adv.h +++ b/Marlin/Configuration_adv.h @@ -1169,4 +1169,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/Cartesio/Configuration_adv.h b/Marlin/example_configurations/Cartesio/Configuration_adv.h index 5280af8cd1..cae9fdcd95 100644 --- a/Marlin/example_configurations/Cartesio/Configuration_adv.h +++ b/Marlin/example_configurations/Cartesio/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/Felix/Configuration_adv.h b/Marlin/example_configurations/Felix/Configuration_adv.h index 2ebb2f5e4e..d2c4a34ba8 100644 --- a/Marlin/example_configurations/Felix/Configuration_adv.h +++ b/Marlin/example_configurations/Felix/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/Hephestos/Configuration_adv.h b/Marlin/example_configurations/Hephestos/Configuration_adv.h index 65af0e844c..40c4f93579 100644 --- a/Marlin/example_configurations/Hephestos/Configuration_adv.h +++ b/Marlin/example_configurations/Hephestos/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/Hephestos_2/Configuration_adv.h b/Marlin/example_configurations/Hephestos_2/Configuration_adv.h index d4adbb60e6..da40c30bb4 100644 --- a/Marlin/example_configurations/Hephestos_2/Configuration_adv.h +++ b/Marlin/example_configurations/Hephestos_2/Configuration_adv.h @@ -1149,4 +1149,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/K8200/Configuration_adv.h b/Marlin/example_configurations/K8200/Configuration_adv.h index fbd4aeff4d..c6b8f8a4a5 100644 --- a/Marlin/example_configurations/K8200/Configuration_adv.h +++ b/Marlin/example_configurations/K8200/Configuration_adv.h @@ -1179,4 +1179,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/K8400/Configuration_adv.h b/Marlin/example_configurations/K8400/Configuration_adv.h index 992bab4251..363166a5c4 100644 --- a/Marlin/example_configurations/K8400/Configuration_adv.h +++ b/Marlin/example_configurations/K8400/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/RigidBot/Configuration_adv.h b/Marlin/example_configurations/RigidBot/Configuration_adv.h index f8f2f0b4c2..3d390dcee6 100644 --- a/Marlin/example_configurations/RigidBot/Configuration_adv.h +++ b/Marlin/example_configurations/RigidBot/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/SCARA/Configuration_adv.h b/Marlin/example_configurations/SCARA/Configuration_adv.h index 63eaedfb4d..373e48be3a 100644 --- a/Marlin/example_configurations/SCARA/Configuration_adv.h +++ b/Marlin/example_configurations/SCARA/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/TAZ4/Configuration_adv.h b/Marlin/example_configurations/TAZ4/Configuration_adv.h index d0c2b481b0..4802fcddd5 100644 --- a/Marlin/example_configurations/TAZ4/Configuration_adv.h +++ b/Marlin/example_configurations/TAZ4/Configuration_adv.h @@ -1174,4 +1174,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/WITBOX/Configuration_adv.h b/Marlin/example_configurations/WITBOX/Configuration_adv.h index 65af0e844c..40c4f93579 100644 --- a/Marlin/example_configurations/WITBOX/Configuration_adv.h +++ b/Marlin/example_configurations/WITBOX/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/delta/generic/Configuration_adv.h b/Marlin/example_configurations/delta/generic/Configuration_adv.h index a2236a9c80..36f3c131ed 100644 --- a/Marlin/example_configurations/delta/generic/Configuration_adv.h +++ b/Marlin/example_configurations/delta/generic/Configuration_adv.h @@ -1168,4 +1168,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h index a2236a9c80..36f3c131ed 100644 --- a/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h @@ -1168,4 +1168,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h index cc39740a3c..f7426991b7 100644 --- a/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h @@ -1173,4 +1173,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h index 814bcc464a..0c78535cd2 100644 --- a/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h @@ -1168,4 +1168,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/makibox/Configuration_adv.h b/Marlin/example_configurations/makibox/Configuration_adv.h index 9d06015a8b..7f7ebced2e 100644 --- a/Marlin/example_configurations/makibox/Configuration_adv.h +++ b/Marlin/example_configurations/makibox/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h b/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h index c9601c6c74..65fca6677c 100644 --- a/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h +++ b/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h @@ -1166,4 +1166,13 @@ */ //#define VOLUMETRIC_DEFAULT_ON +/** + * Enable this option for a leaner build of Marlin that removes all + * workspace offsets, simplifying coordinate transformations, leveling, etc. + * + * - M206 and M428 are disabled. + * - G92 will revert to its behavior from Marlin 1.0. + */ +//#define NO_WORKSPACE_OFFSETS + #endif // CONFIGURATION_ADV_H From 5f7e85398b898f7fab51f487c44995b4fa247df4 Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Sat, 4 Mar 2017 18:01:33 -0600 Subject: [PATCH 2/5] Implement NO_WORKSPACE_OFFSETS --- Marlin/Marlin.h | 45 +++-- Marlin/Marlin_main.cpp | 306 ++++++++++++++++++--------------- Marlin/configuration_store.cpp | 35 ++-- 3 files changed, 224 insertions(+), 162 deletions(-) diff --git a/Marlin/Marlin.h b/Marlin/Marlin.h index 97af92c583..7d759553cc 100644 --- a/Marlin/Marlin.h +++ b/Marlin/Marlin.h @@ -275,27 +275,18 @@ extern volatile bool wait_for_heatup; #endif extern float current_position[NUM_AXIS]; -extern float position_shift[XYZ]; -extern float home_offset[XYZ]; -#if HOTENDS > 1 - extern float hotend_offset[XYZ][HOTENDS]; -#endif - -// Software Endstops -void update_software_endstops(AxisEnum axis); -#if ENABLED(min_software_endstops) || ENABLED(max_software_endstops) - extern bool soft_endstops_enabled; - void clamp_to_software_endstops(float target[XYZ]); +// Workspace offsets +#if DISABLED(NO_WORKSPACE_OFFSETS) + extern float position_shift[XYZ]; + extern float home_offset[XYZ]; + #define LOGICAL_POSITION(POS, AXIS) ((POS) + home_offset[AXIS] + position_shift[AXIS]) + #define RAW_POSITION(POS, AXIS) ((POS) - home_offset[AXIS] - position_shift[AXIS]) #else - #define soft_endstops_enabled false - #define clamp_to_software_endstops(x) NOOP + #define LOGICAL_POSITION(POS, AXIS) (POS) + #define RAW_POSITION(POS, AXIS) (POS) #endif -extern float soft_endstop_min[XYZ]; -extern float soft_endstop_max[XYZ]; -#define LOGICAL_POSITION(POS, AXIS) ((POS) + home_offset[AXIS] + position_shift[AXIS]) -#define RAW_POSITION(POS, AXIS) ((POS) - home_offset[AXIS] - position_shift[AXIS]) #define LOGICAL_X_POSITION(POS) LOGICAL_POSITION(POS, X_AXIS) #define LOGICAL_Y_POSITION(POS) LOGICAL_POSITION(POS, Y_AXIS) #define LOGICAL_Z_POSITION(POS) LOGICAL_POSITION(POS, Z_AXIS) @@ -304,6 +295,26 @@ extern float soft_endstop_max[XYZ]; #define RAW_Z_POSITION(POS) RAW_POSITION(POS, Z_AXIS) #define RAW_CURRENT_POSITION(AXIS) RAW_POSITION(current_position[AXIS], AXIS) +#if HOTENDS > 1 + extern float hotend_offset[XYZ][HOTENDS]; +#endif + +// Software Endstops +extern float soft_endstop_min[XYZ]; +extern float soft_endstop_max[XYZ]; + +#if ENABLED(min_software_endstops) || ENABLED(max_software_endstops) + extern bool soft_endstops_enabled; + void clamp_to_software_endstops(float target[XYZ]); +#else + #define soft_endstops_enabled false + #define clamp_to_software_endstops(x) NOOP +#endif + +#if DISABLED(NO_WORKSPACE_OFFSETS) || ENABLED(DUAL_X_CARRIAGE) || ENABLED(DELTA) + void update_software_endstops(const AxisEnum axis); +#endif + // GCode support for external objects bool code_seen(char); int code_value_int(); diff --git a/Marlin/Marlin_main.cpp b/Marlin/Marlin_main.cpp index c57c2e296f..3c6ef8bd5e 100755 --- a/Marlin/Marlin_main.cpp +++ b/Marlin/Marlin_main.cpp @@ -396,12 +396,16 @@ bool axis_relative_modes[] = AXIS_RELATIVE_MODES, float filament_size[EXTRUDERS] = ARRAY_BY_EXTRUDERS1(DEFAULT_NOMINAL_FILAMENT_DIA), volumetric_multiplier[EXTRUDERS] = ARRAY_BY_EXTRUDERS1(1.0); -// The distance that XYZ has been offset by G92. Reset by G28. -float position_shift[XYZ] = { 0 }; +#if DISABLED(NO_WORKSPACE_OFFSETS) -// This offset is added to the configured home position. -// Set by M206, M428, or menu item. Saved to EEPROM. -float home_offset[XYZ] = { 0 }; + // The distance that XYZ has been offset by G92. Reset by G28. + float position_shift[XYZ] = { 0 }; + + // This offset is added to the configured home position. + // Set by M206, M428, or menu item. Saved to EEPROM. + float home_offset[XYZ] = { 0 }; + +#endif // Software Endstops are based on the configured limits. #if ENABLED(min_software_endstops) || ENABLED(max_software_endstops) @@ -1333,76 +1337,83 @@ bool get_target_extruder_from_command(int code) { #endif // DUAL_X_CARRIAGE -/** - * Software endstops can be used to monitor the open end of - * an axis that has a hardware endstop on the other end. Or - * they can prevent axes from moving past endstops and grinding. - * - * To keep doing their job as the coordinate system changes, - * the software endstop positions must be refreshed to remain - * at the same positions relative to the machine. - */ -void update_software_endstops(AxisEnum axis) { - float offs = LOGICAL_POSITION(0, axis); +#if DISABLED(NO_WORKSPACE_OFFSETS) || ENABLED(DUAL_X_CARRIAGE) || ENABLED(DELTA) - #if ENABLED(DUAL_X_CARRIAGE) - if (axis == X_AXIS) { + /** + * Software endstops can be used to monitor the open end of + * an axis that has a hardware endstop on the other end. Or + * they can prevent axes from moving past endstops and grinding. + * + * To keep doing their job as the coordinate system changes, + * the software endstop positions must be refreshed to remain + * at the same positions relative to the machine. + */ + void update_software_endstops(const AxisEnum axis) { + const float offs = LOGICAL_POSITION(0, axis); - // In Dual X mode hotend_offset[X] is T1's home position - float dual_max_x = max(hotend_offset[X_AXIS][1], X2_MAX_POS); + #if ENABLED(DUAL_X_CARRIAGE) + if (axis == X_AXIS) { - if (active_extruder != 0) { - // T1 can move from X2_MIN_POS to X2_MAX_POS or X2 home position (whichever is larger) - soft_endstop_min[X_AXIS] = X2_MIN_POS + offs; - soft_endstop_max[X_AXIS] = dual_max_x + offs; + // In Dual X mode hotend_offset[X] is T1's home position + float dual_max_x = max(hotend_offset[X_AXIS][1], X2_MAX_POS); + + if (active_extruder != 0) { + // T1 can move from X2_MIN_POS to X2_MAX_POS or X2 home position (whichever is larger) + soft_endstop_min[X_AXIS] = X2_MIN_POS + offs; + soft_endstop_max[X_AXIS] = dual_max_x + offs; + } + else if (dual_x_carriage_mode == DXC_DUPLICATION_MODE) { + // In Duplication Mode, T0 can move as far left as X_MIN_POS + // but not so far to the right that T1 would move past the end + soft_endstop_min[X_AXIS] = base_min_pos(X_AXIS) + offs; + soft_endstop_max[X_AXIS] = min(base_max_pos(X_AXIS), dual_max_x - duplicate_extruder_x_offset) + offs; + } + else { + // In other modes, T0 can move from X_MIN_POS to X_MAX_POS + soft_endstop_min[axis] = base_min_pos(axis) + offs; + soft_endstop_max[axis] = base_max_pos(axis) + offs; + } } - else if (dual_x_carriage_mode == DXC_DUPLICATION_MODE) { - // In Duplication Mode, T0 can move as far left as X_MIN_POS - // but not so far to the right that T1 would move past the end - soft_endstop_min[X_AXIS] = base_min_pos(X_AXIS) + offs; - soft_endstop_max[X_AXIS] = min(base_max_pos(X_AXIS), dual_max_x - duplicate_extruder_x_offset) + offs; + #else + soft_endstop_min[axis] = base_min_pos(axis) + offs; + soft_endstop_max[axis] = base_max_pos(axis) + offs; + #endif + + #if ENABLED(DEBUG_LEVELING_FEATURE) + if (DEBUGGING(LEVELING)) { + SERIAL_ECHOPAIR("For ", axis_codes[axis]); + #if DISABLED(NO_WORKSPACE_OFFSETS) + SERIAL_ECHOPAIR(" axis:\n home_offset = ", home_offset[axis]); + SERIAL_ECHOPAIR("\n position_shift = ", position_shift[axis]); + #endif + SERIAL_ECHOPAIR("\n soft_endstop_min = ", soft_endstop_min[axis]); + SERIAL_ECHOLNPAIR("\n soft_endstop_max = ", soft_endstop_max[axis]); } - else { - // In other modes, T0 can move from X_MIN_POS to X_MAX_POS - soft_endstop_min[axis] = base_min_pos(axis) + offs; - soft_endstop_max[axis] = base_max_pos(axis) + offs; - } - } - #else - soft_endstop_min[axis] = base_min_pos(axis) + offs; - soft_endstop_max[axis] = base_max_pos(axis) + offs; - #endif + #endif - #if ENABLED(DEBUG_LEVELING_FEATURE) - if (DEBUGGING(LEVELING)) { - SERIAL_ECHOPAIR("For ", axis_codes[axis]); - SERIAL_ECHOPAIR(" axis:\n home_offset = ", home_offset[axis]); - SERIAL_ECHOPAIR("\n position_shift = ", position_shift[axis]); - SERIAL_ECHOPAIR("\n soft_endstop_min = ", soft_endstop_min[axis]); - SERIAL_ECHOLNPAIR("\n soft_endstop_max = ", soft_endstop_max[axis]); - } - #endif + #if ENABLED(DELTA) + if (axis == Z_AXIS) + delta_clip_start_height = soft_endstop_max[axis] - delta_safe_distance_from_top(); + #endif + } - #if ENABLED(DELTA) - if (axis == Z_AXIS) - delta_clip_start_height = soft_endstop_max[axis] - delta_safe_distance_from_top(); - #endif +#endif // NO_WORKSPACE_OFFSETS -} - -/** - * Change the home offset for an axis, update the current - * position and the software endstops to retain the same - * relative distance to the new home. - * - * Since this changes the current_position, code should - * call sync_plan_position soon after this. - */ -static void set_home_offset(AxisEnum axis, float v) { - current_position[axis] += v - home_offset[axis]; - home_offset[axis] = v; - update_software_endstops(axis); -} +#if DISABLED(NO_WORKSPACE_OFFSETS) + /** + * Change the home offset for an axis, update the current + * position and the software endstops to retain the same + * relative distance to the new home. + * + * Since this changes the current_position, code should + * call sync_plan_position soon after this. + */ + static void set_home_offset(AxisEnum axis, float v) { + current_position[axis] += v - home_offset[axis]; + home_offset[axis] = v; + update_software_endstops(axis); + } +#endif // NO_WORKSPACE_OFFSETS /** * Set an axis' current position to its home position (after homing). @@ -1433,8 +1444,10 @@ static void set_axis_is_at_home(AxisEnum axis) { axis_known_position[axis] = axis_homed[axis] = true; - position_shift[axis] = 0; - update_software_endstops(axis); + #if DISABLED(NO_WORKSPACE_OFFSETS) + position_shift[axis] = 0; + update_software_endstops(axis); + #endif #if ENABLED(DUAL_X_CARRIAGE) if (axis == X_AXIS && (active_extruder == 1 || dual_x_carriage_mode == DXC_DUPLICATION_MODE)) { @@ -1507,8 +1520,10 @@ static void set_axis_is_at_home(AxisEnum axis) { #if ENABLED(DEBUG_LEVELING_FEATURE) if (DEBUGGING(LEVELING)) { - SERIAL_ECHOPAIR("> home_offset[", axis_codes[axis]); - SERIAL_ECHOLNPAIR("] = ", home_offset[axis]); + #if DISABLED(NO_WORKSPACE_OFFSETS) + SERIAL_ECHOPAIR("> home_offset[", axis_codes[axis]); + SERIAL_ECHOLNPAIR("] = ", home_offset[axis]); + #endif DEBUG_POS("", current_position); SERIAL_ECHOPAIR("<<< set_axis_is_at_home(", axis_codes[axis]); SERIAL_CHAR(')'); @@ -4603,8 +4618,10 @@ inline void gcode_G92() { if (i != E_AXIS) { didXYZ = true; - position_shift[i] += v - p; // Offset the coordinate space - update_software_endstops((AxisEnum)i); + #if DISABLED(NO_WORKSPACE_OFFSETS) + position_shift[i] += v - p; // Offset the coordinate space + update_software_endstops((AxisEnum)i); + #endif } #endif } @@ -6334,22 +6351,26 @@ inline void gcode_M205() { if (code_seen('E')) planner.max_jerk[E_AXIS] = code_value_axis_units(E_AXIS); } -/** - * M206: Set Additional Homing Offset (X Y Z). SCARA aliases T=X, P=Y - */ -inline void gcode_M206() { - LOOP_XYZ(i) - if (code_seen(axis_codes[i])) - set_home_offset((AxisEnum)i, code_value_axis_units(i)); +#if DISABLED(NO_WORKSPACE_OFFSETS) - #if ENABLED(MORGAN_SCARA) - if (code_seen('T')) set_home_offset(A_AXIS, code_value_axis_units(A_AXIS)); // Theta - if (code_seen('P')) set_home_offset(B_AXIS, code_value_axis_units(B_AXIS)); // Psi - #endif + /** + * M206: Set Additional Homing Offset (X Y Z). SCARA aliases T=X, P=Y + */ + inline void gcode_M206() { + LOOP_XYZ(i) + if (code_seen(axis_codes[i])) + set_home_offset((AxisEnum)i, code_value_axis_units(i)); - SYNC_PLAN_POSITION_KINEMATIC(); - report_current_position(); -} + #if ENABLED(MORGAN_SCARA) + if (code_seen('T')) set_home_offset(A_AXIS, code_value_axis_units(A_AXIS)); // Theta + if (code_seen('P')) set_home_offset(B_AXIS, code_value_axis_units(B_AXIS)); // Psi + #endif + + SYNC_PLAN_POSITION_KINEMATIC(); + report_current_position(); + } + +#endif // NO_WORKSPACE_OFFSETS #if ENABLED(DELTA) /** @@ -7173,45 +7194,49 @@ void quickstop_stepper() { #endif -/** - * M428: Set home_offset based on the distance between the - * current_position and the nearest "reference point." - * If an axis is past center its endstop position - * is the reference-point. Otherwise it uses 0. This allows - * the Z offset to be set near the bed when using a max endstop. - * - * M428 can't be used more than 2cm away from 0 or an endstop. - * - * Use M206 to set these values directly. - */ -inline void gcode_M428() { - bool err = false; - LOOP_XYZ(i) { - if (axis_homed[i]) { - float base = (current_position[i] > (soft_endstop_min[i] + soft_endstop_max[i]) * 0.5) ? base_home_pos((AxisEnum)i) : 0, - diff = current_position[i] - LOGICAL_POSITION(base, i); - if (diff > -20 && diff < 20) { - set_home_offset((AxisEnum)i, home_offset[i] - diff); - } - else { - SERIAL_ERROR_START; - SERIAL_ERRORLNPGM(MSG_ERR_M428_TOO_FAR); - LCD_ALERTMESSAGEPGM("Err: Too far!"); - BUZZ(200, 40); - err = true; - break; +#if DISABLED(NO_WORKSPACE_OFFSETS) + + /** + * M428: Set home_offset based on the distance between the + * current_position and the nearest "reference point." + * If an axis is past center its endstop position + * is the reference-point. Otherwise it uses 0. This allows + * the Z offset to be set near the bed when using a max endstop. + * + * M428 can't be used more than 2cm away from 0 or an endstop. + * + * Use M206 to set these values directly. + */ + inline void gcode_M428() { + bool err = false; + LOOP_XYZ(i) { + if (axis_homed[i]) { + float base = (current_position[i] > (soft_endstop_min[i] + soft_endstop_max[i]) * 0.5) ? base_home_pos((AxisEnum)i) : 0, + diff = current_position[i] - LOGICAL_POSITION(base, i); + if (diff > -20 && diff < 20) { + set_home_offset((AxisEnum)i, home_offset[i] - diff); + } + else { + SERIAL_ERROR_START; + SERIAL_ERRORLNPGM(MSG_ERR_M428_TOO_FAR); + LCD_ALERTMESSAGEPGM("Err: Too far!"); + BUZZ(200, 40); + err = true; + break; + } } } + + if (!err) { + SYNC_PLAN_POSITION_KINEMATIC(); + report_current_position(); + LCD_MESSAGEPGM(MSG_HOME_OFFSETS_APPLIED); + BUZZ(200, 659); + BUZZ(200, 698); + } } - if (!err) { - SYNC_PLAN_POSITION_KINEMATIC(); - report_current_position(); - LCD_MESSAGEPGM(MSG_HOME_OFFSETS_APPLIED); - BUZZ(200, 659); - BUZZ(200, 698); - } -} +#endif // NO_WORKSPACE_OFFSETS /** * M500: Store settings in EEPROM @@ -8081,10 +8106,14 @@ void tool_change(const uint8_t tmp_extruder, const float fr_mm_s/*=0.0*/, bool n // The newly-selected extruder XY is actually at... current_position[X_AXIS] += xydiff[X_AXIS]; current_position[Y_AXIS] += xydiff[Y_AXIS]; - for (uint8_t i = X_AXIS; i <= Y_AXIS; i++) { - position_shift[i] += xydiff[i]; - update_software_endstops((AxisEnum)i); - } + #if DISABLED(NO_WORKSPACE_OFFSETS) || ENABLED(DUAL_X_CARRIAGE) + for (uint8_t i = X_AXIS; i <= Y_AXIS; i++) { + #if DISABLED(NO_WORKSPACE_OFFSETS) + position_shift[i] += xydiff[i]; + #endif + update_software_endstops((AxisEnum)i); + } + #endif // Set the new active extruder active_extruder = tmp_extruder; @@ -8639,9 +8668,12 @@ void process_next_command() { case 205: //M205: Set advanced settings gcode_M205(); break; - case 206: // M206: Set home offsets - gcode_M206(); - break; + + #if DISABLED(NO_WORKSPACE_OFFSETS) + case 206: // M206: Set home offsets + gcode_M206(); + break; + #endif #if ENABLED(DELTA) case 665: // M665: Set delta configurations @@ -8805,9 +8837,11 @@ void process_next_command() { break; #endif - case 428: // M428: Apply current_position to home_offset - gcode_M428(); - break; + #if DISABLED(NO_WORKSPACE_OFFSETS) + case 428: // M428: Apply current_position to home_offset + gcode_M428(); + break; + #endif case 500: // M500: Store settings in EEPROM gcode_M500(); @@ -10488,8 +10522,12 @@ void setup() { // This also updates variables in the planner, elsewhere Config_RetrieveSettings(); - // Initialize current position based on home_offset - memcpy(current_position, home_offset, sizeof(home_offset)); + #if DISABLED(NO_WORKSPACE_OFFSETS) + // Initialize current position based on home_offset + memcpy(current_position, home_offset, sizeof(home_offset)); + #else + ZERO(current_position); + #endif // Vital to init stepper/planner equivalent for current_position SYNC_PLAN_POSITION_KINEMATIC(); diff --git a/Marlin/configuration_store.cpp b/Marlin/configuration_store.cpp index 360b3f2c25..68475f8604 100644 --- a/Marlin/configuration_store.cpp +++ b/Marlin/configuration_store.cpp @@ -171,8 +171,10 @@ void Config_Postprocess() { calculate_volumetric_multipliers(); - // Software endstops depend on home_offset - LOOP_XYZ(i) update_software_endstops((AxisEnum)i); + #if DISABLED(NO_WORKSPACE_OFFSETS) || ENABLED(DUAL_X_CARRIAGE) || ENABLED(DELTA) + // Software endstops depend on home_offset + LOOP_XYZ(i) update_software_endstops((AxisEnum)i); + #endif } #if ENABLED(EEPROM_SETTINGS) @@ -251,6 +253,9 @@ void Config_Postprocess() { EEPROM_WRITE(planner.min_travel_feedrate_mm_s); EEPROM_WRITE(planner.min_segment_time); EEPROM_WRITE(planner.max_jerk); + #if ENABLED(NO_WORKSPACE_OFFSETS) + float home_offset[XYZ] = { 0 }; + #endif EEPROM_WRITE(home_offset); #if HOTENDS > 1 @@ -498,6 +503,10 @@ void Config_Postprocess() { EEPROM_READ(planner.min_travel_feedrate_mm_s); EEPROM_READ(planner.min_segment_time); EEPROM_READ(planner.max_jerk); + + #if ENABLED(NO_WORKSPACE_OFFSETS) + float home_offset[XYZ]; + #endif EEPROM_READ(home_offset); #if HOTENDS > 1 @@ -726,7 +735,9 @@ void Config_ResetDefault() { planner.max_jerk[Y_AXIS] = DEFAULT_YJERK; planner.max_jerk[Z_AXIS] = DEFAULT_ZJERK; planner.max_jerk[E_AXIS] = DEFAULT_EJERK; - home_offset[X_AXIS] = home_offset[Y_AXIS] = home_offset[Z_AXIS] = 0; + #if DISABLED(NO_WORKSPACE_OFFSETS) + ZERO(home_offset); + #endif #if HOTENDS > 1 constexpr float tmp4[XYZ][HOTENDS] = { @@ -937,15 +948,17 @@ void Config_ResetDefault() { SERIAL_ECHOPAIR(" E", planner.max_jerk[E_AXIS]); SERIAL_EOL; - CONFIG_ECHO_START; - if (!forReplay) { - SERIAL_ECHOLNPGM("Home offset (mm)"); + #if DISABLED(NO_WORKSPACE_OFFSETS) CONFIG_ECHO_START; - } - SERIAL_ECHOPAIR(" M206 X", home_offset[X_AXIS]); - SERIAL_ECHOPAIR(" Y", home_offset[Y_AXIS]); - SERIAL_ECHOPAIR(" Z", home_offset[Z_AXIS]); - SERIAL_EOL; + if (!forReplay) { + SERIAL_ECHOLNPGM("Home offset (mm)"); + CONFIG_ECHO_START; + } + SERIAL_ECHOPAIR(" M206 X", home_offset[X_AXIS]); + SERIAL_ECHOPAIR(" Y", home_offset[Y_AXIS]); + SERIAL_ECHOPAIR(" Z", home_offset[Z_AXIS]); + SERIAL_EOL; + #endif #if HOTENDS > 1 CONFIG_ECHO_START; From e141f3a03f1999a3478897e92ea626b437d40466 Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Sat, 4 Mar 2017 19:18:11 -0600 Subject: [PATCH 3/5] Optimize coordinate transformation Pre-compute the combined position shift and home offset to save a single float fetch-and-add per conversion. Great for delta/scara and bed leveling. --- Marlin/Marlin.h | 9 +++++---- Marlin/Marlin_main.cpp | 7 +++++-- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/Marlin/Marlin.h b/Marlin/Marlin.h index 7d759553cc..cb6654eae8 100644 --- a/Marlin/Marlin.h +++ b/Marlin/Marlin.h @@ -278,10 +278,11 @@ extern float current_position[NUM_AXIS]; // Workspace offsets #if DISABLED(NO_WORKSPACE_OFFSETS) - extern float position_shift[XYZ]; - extern float home_offset[XYZ]; - #define LOGICAL_POSITION(POS, AXIS) ((POS) + home_offset[AXIS] + position_shift[AXIS]) - #define RAW_POSITION(POS, AXIS) ((POS) - home_offset[AXIS] - position_shift[AXIS]) + extern float position_shift[XYZ], + home_offset[XYZ], + workspace_offset[XYZ]; + #define LOGICAL_POSITION(POS, AXIS) ((POS) + workspace_offset[AXIS]) + #define RAW_POSITION(POS, AXIS) ((POS) - workspace_offset[AXIS]) #else #define LOGICAL_POSITION(POS, AXIS) (POS) #define RAW_POSITION(POS, AXIS) (POS) diff --git a/Marlin/Marlin_main.cpp b/Marlin/Marlin_main.cpp index 3c6ef8bd5e..5923447f44 100755 --- a/Marlin/Marlin_main.cpp +++ b/Marlin/Marlin_main.cpp @@ -405,6 +405,9 @@ float filament_size[EXTRUDERS] = ARRAY_BY_EXTRUDERS1(DEFAULT_NOMINAL_FILAMENT_DI // Set by M206, M428, or menu item. Saved to EEPROM. float home_offset[XYZ] = { 0 }; + // The above two are combined to save on computes + float workspace_offset[XYZ] = { 0 }; + #endif // Software Endstops are based on the configured limits. @@ -1349,7 +1352,7 @@ bool get_target_extruder_from_command(int code) { * at the same positions relative to the machine. */ void update_software_endstops(const AxisEnum axis) { - const float offs = LOGICAL_POSITION(0, axis); + const float offs = workspace_offset[axis] = LOGICAL_POSITION(0, axis); #if ENABLED(DUAL_X_CARRIAGE) if (axis == X_AXIS) { @@ -1408,7 +1411,7 @@ bool get_target_extruder_from_command(int code) { * Since this changes the current_position, code should * call sync_plan_position soon after this. */ - static void set_home_offset(AxisEnum axis, float v) { + static void set_home_offset(const AxisEnum axis, const float v) { current_position[axis] += v - home_offset[axis]; home_offset[axis] = v; update_software_endstops(axis); From 87b03b16bd3df3ce6d4b697e8a3c8a81e27f57c2 Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Sat, 4 Mar 2017 19:19:06 -0600 Subject: [PATCH 4/5] Use a macro for array copies --- Marlin/Marlin_main.cpp | 30 +++++++++++++++--------------- Marlin/macros.h | 1 + Marlin/planner.cpp | 4 ++-- 3 files changed, 18 insertions(+), 17 deletions(-) diff --git a/Marlin/Marlin_main.cpp b/Marlin/Marlin_main.cpp index 5923447f44..8e47bc78f2 100755 --- a/Marlin/Marlin_main.cpp +++ b/Marlin/Marlin_main.cpp @@ -1567,8 +1567,8 @@ inline void line_to_destination(float fr_mm_s) { } inline void line_to_destination() { line_to_destination(feedrate_mm_s); } -inline void set_current_to_destination() { memcpy(current_position, destination, sizeof(current_position)); } -inline void set_destination_to_current() { memcpy(destination, current_position, sizeof(destination)); } +inline void set_current_to_destination() { COPY(current_position, destination); } +inline void set_destination_to_current() { COPY(destination, current_position); } #if IS_KINEMATIC /** @@ -3583,7 +3583,7 @@ inline void gcode_G28() { HOMEAXIS(X); // Consider the active extruder to be parked - memcpy(raised_parked_position, current_position, sizeof(raised_parked_position)); + COPY(raised_parked_position, current_position); delayed_move_time = 0; active_extruder_parked = true; @@ -4383,7 +4383,7 @@ inline void gcode_G28() { #endif float converted[XYZ]; - memcpy(converted, current_position, sizeof(converted)); + COPY(converted, current_position); planner.abl_enabled = true; planner.unapply_leveling(converted); // use conversion machinery @@ -4405,7 +4405,7 @@ inline void gcode_G28() { } // The rotated XY and corrected Z are now current_position - memcpy(current_position, converted, sizeof(converted)); + COPY(current_position, converted); #if ENABLED(DEBUG_LEVELING_FEATURE) if (DEBUGGING(LEVELING)) DEBUG_POS("G29 corrected XYZ", current_position); @@ -7965,7 +7965,7 @@ void tool_change(const uint8_t tmp_extruder, const float fr_mm_s/*=0.0*/, bool n break; case DXC_AUTO_PARK_MODE: // record raised toolhead position for use by unpark - memcpy(raised_parked_position, current_position, sizeof(raised_parked_position)); + COPY(raised_parked_position, current_position); raised_parked_position[Z_AXIS] += TOOLCHANGE_UNPARK_ZLIFT; #if ENABLED(max_software_endstops) NOMORE(raised_parked_position[Z_AXIS], soft_endstop_max[Z_AXIS]); @@ -9332,7 +9332,7 @@ void set_current_from_steppers_for_axis(const AxisEnum axis) { planner.unapply_leveling(cartes); #endif if (axis == ALL_AXES) - memcpy(current_position, cartes, sizeof(cartes)); + COPY(current_position, cartes); else current_position[axis] = cartes[axis]; } @@ -9367,14 +9367,14 @@ void set_current_from_steppers_for_axis(const AxisEnum axis) { // Split at the left/front border of the right/top square int8_t gcx = max(cx1, cx2), gcy = max(cy1, cy2); if (cx2 != cx1 && TEST(x_splits, gcx)) { - memcpy(end, destination, sizeof(end)); + COPY(end, destination); destination[X_AXIS] = LOGICAL_X_POSITION(mbl.get_probe_x(gcx)); normalized_dist = (destination[X_AXIS] - current_position[X_AXIS]) / (end[X_AXIS] - current_position[X_AXIS]); destination[Y_AXIS] = MBL_SEGMENT_END(Y); CBI(x_splits, gcx); } else if (cy2 != cy1 && TEST(y_splits, gcy)) { - memcpy(end, destination, sizeof(end)); + COPY(end, destination); destination[Y_AXIS] = LOGICAL_Y_POSITION(mbl.get_probe_y(gcy)); normalized_dist = (destination[Y_AXIS] - current_position[Y_AXIS]) / (end[Y_AXIS] - current_position[Y_AXIS]); destination[X_AXIS] = MBL_SEGMENT_END(X); @@ -9394,7 +9394,7 @@ void set_current_from_steppers_for_axis(const AxisEnum axis) { mesh_line_to_destination(fr_mm_s, x_splits, y_splits); // Restore destination from stack - memcpy(destination, end, sizeof(end)); + COPY(destination, end); mesh_line_to_destination(fr_mm_s, x_splits, y_splits); } @@ -9430,14 +9430,14 @@ void set_current_from_steppers_for_axis(const AxisEnum axis) { // Split at the left/front border of the right/top square int8_t gcx = max(cx1, cx2), gcy = max(cy1, cy2); if (cx2 != cx1 && TEST(x_splits, gcx)) { - memcpy(end, destination, sizeof(end)); + COPY(end, destination); destination[X_AXIS] = LOGICAL_X_POSITION(bilinear_start[X_AXIS] + ABL_BG_SPACING(X_AXIS) * gcx); normalized_dist = (destination[X_AXIS] - current_position[X_AXIS]) / (end[X_AXIS] - current_position[X_AXIS]); destination[Y_AXIS] = LINE_SEGMENT_END(Y); CBI(x_splits, gcx); } else if (cy2 != cy1 && TEST(y_splits, gcy)) { - memcpy(end, destination, sizeof(end)); + COPY(end, destination); destination[Y_AXIS] = LOGICAL_Y_POSITION(bilinear_start[Y_AXIS] + ABL_BG_SPACING(Y_AXIS) * gcy); normalized_dist = (destination[Y_AXIS] - current_position[Y_AXIS]) / (end[Y_AXIS] - current_position[Y_AXIS]); destination[X_AXIS] = LINE_SEGMENT_END(X); @@ -9457,7 +9457,7 @@ void set_current_from_steppers_for_axis(const AxisEnum axis) { bilinear_line_to_destination(fr_mm_s, x_splits, y_splits); // Restore destination from stack - memcpy(destination, end, sizeof(end)); + COPY(destination, end); bilinear_line_to_destination(fr_mm_s, x_splits, y_splits); } @@ -9552,7 +9552,7 @@ void set_current_from_steppers_for_axis(const AxisEnum axis) { // Get the logical current position as starting point float logical[XYZE]; - memcpy(logical, current_position, sizeof(logical)); + COPY(logical, current_position); #define DELTA_VAR logical @@ -10527,7 +10527,7 @@ void setup() { #if DISABLED(NO_WORKSPACE_OFFSETS) // Initialize current position based on home_offset - memcpy(current_position, home_offset, sizeof(home_offset)); + COPY(current_position, home_offset); #else ZERO(current_position); #endif diff --git a/Marlin/macros.h b/Marlin/macros.h index 2859bfeee2..0ab08c31b8 100644 --- a/Marlin/macros.h +++ b/Marlin/macros.h @@ -79,6 +79,7 @@ #define NUMERIC_SIGNED(a) (NUMERIC(a) || (a) == '-') #define COUNT(a) (sizeof(a)/sizeof(*a)) #define ZERO(a) memset(a,0,sizeof(a)) +#define COPY(a,b) memcpy(a,b,min(sizeof(a),sizeof(b))) // Macros for initializing arrays #define ARRAY_6(v1, v2, v3, v4, v5, v6, ...) { v1, v2, v3, v4, v5, v6 } diff --git a/Marlin/planner.cpp b/Marlin/planner.cpp index ec81cd300d..09fad3bc83 100644 --- a/Marlin/planner.cpp +++ b/Marlin/planner.cpp @@ -1298,7 +1298,7 @@ void Planner::_buffer_line(const float &a, const float &b, const float &c, const block->flag |= BLOCK_FLAG_RECALCULATE | (block->nominal_speed <= v_allowable ? BLOCK_FLAG_NOMINAL_LENGTH : 0); // Update previous path unit_vector and nominal speed - memcpy(previous_speed, current_speed, sizeof(previous_speed)); + COPY(previous_speed, current_speed); previous_nominal_speed = block->nominal_speed; previous_safe_speed = safe_speed; @@ -1360,7 +1360,7 @@ void Planner::_buffer_line(const float &a, const float &b, const float &c, const block_buffer_head = next_buffer_head; // Update the position (only when a move was queued) - memcpy(position, target, sizeof(position)); + COPY(position, target); #if ENABLED(LIN_ADVANCE) position_float[X_AXIS] = a; position_float[Y_AXIS] = b; From 8e89a802f7cb7df17ba2bea1cfea87f38483ad4a Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Sat, 4 Mar 2017 22:27:41 -0600 Subject: [PATCH 5/5] Document PROTOCOL_VERSION --- Marlin/Version.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Marlin/Version.h b/Marlin/Version.h index 33a9260f47..63f4b81ab8 100644 --- a/Marlin/Version.h +++ b/Marlin/Version.h @@ -61,7 +61,9 @@ #define REQUIRED_CONFIGURATION_ADV_H_VERSION 010100 /** - * @todo: Missing documentation block + * The protocol for communication to the host. Protocol indicates communication + * standards such as the use of ASCII, "echo:" and "error:" line prefixes, etc. + * (Other behaviors are given by the firmware version and capabilities report.) */ #define PROTOCOL_VERSION "1.0"