Skip to content
Snippets Groups Projects
Marlin.cpp 25 KiB
Newer Older
  • Learn to ignore specific revisions
  •  * Marlin 3D Printer Firmware
    
    Scott Lahteine's avatar
    Scott Lahteine committed
     * Copyright (C) 2016, 2017 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
    
     *
     * Based on Sprinter and grbl.
     * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
     *
     * This program is free software: you can redistribute it and/or modify
     * it under the terms of the GNU General Public License as published by
     * the Free Software Foundation, either version 3 of the License, or
     * (at your option) any later version.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    
     * About Marlin
     *
     * This firmware is a mashup between Sprinter and grbl.
     *  - https://github.com/kliment/Sprinter
    
     *  - https://github.com/grbl/grbl
    
    #include "Marlin.h"
    
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #include "lcd/ultralcd.h"
    
    #include "module/motion.h"
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #include "module/planner.h"
    #include "module/stepper.h"
    #include "module/endstops.h"
    
    #include "module/probe.h"
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #include "module/temperature.h"
    #include "sd/cardreader.h"
    #include "module/configuration_store.h"
    
    #include "module/printcounter.h" // PrintCounter or Stopwatch
    
    #include "feature/closedloop.h"
    
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #include <pins_arduino.h>
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #include <math.h>
    #include "libs/nozzle.h"
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #include "gcode/parser.h"
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #if HAS_BUZZER && DISABLED(LCD_USE_I2C_BUZZER)
      #include "libs/buzzer.h"
    #endif
    
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #if ENABLED(DIGIPOT_I2C)
      #include "feature/digipot/digipot.h"
    #endif
    
    
    #if ENABLED(MIXING_EXTRUDER)
      #include "feature/mixing.h"
    #endif
    
    
    #if ENABLED(BEZIER_CURVE_SUPPORT)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #include "module/planner_bezier.h"
    
    #if ENABLED(MAX7219_DEBUG)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #include "feature/Max7219_Debug_LEDs.h"
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #if HAS_COLOR_LEDS
      #include "feature/leds/leds.h"
    
    dot-bob's avatar
    dot-bob committed
    #endif
    
    
    #if HAS_SERVOS
    
      #include "module/servo.h"
    
    #endif
    
    #if HAS_DIGIPOTSS
      #include <SPI.h>
    #endif
    
    #if ENABLED(DAC_STEPPER_CURRENT)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #include "feature/dac/stepper_dac.h"
    
    #endif
    
    #if ENABLED(EXPERIMENTAL_I2CBUS)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #include "feature/twibus.h"
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      TWIBus i2c;
    
    #if ENABLED(I2C_POSITION_ENCODERS)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #include "feature/I2CPositionEncoder.h"
    
    #if HAS_TRINAMIC
      #include "feature/tmc_util.h"
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      CardReader card;
    
    #if ENABLED(G38_PROBE_TARGET)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      bool G38_move = false,
           G38_endstop_hit = false;
    
    #if ENABLED(DELTA)
      #include "module/delta.h"
    #elif IS_SCARA
      #include "module/scara.h"
    #endif
    
    #if HAS_LEVELING
      #include "feature/bedlevel/bedlevel.h"
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #endif
    
    
    #if ENABLED(ADVANCED_PAUSE_FEATURE) && ENABLED(PAUSE_PARK_NO_STEPPER_TIMEOUT)
      #include "feature/pause.h"
    #endif
    
    #if ENABLED(POWER_LOSS_RECOVERY)
      #include "feature/power_loss_recovery.h"
    #endif
    
    
    #if ENABLED(FILAMENT_RUNOUT_SENSOR)
      #include "feature/runout.h"
    #endif
    
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    #if ENABLED(TEMP_STAT_LEDS)
      #include "feature/leds/tempstat.h"
    #endif
    
    
    #if HAS_CASE_LIGHT
      #include "feature/caselight.h"
    #endif
    
    
    #if HAS_FANMUX
      #include "feature/fanmux.h"
    #endif
    
    
    GMagician's avatar
    GMagician committed
    #if DO_SWITCH_EXTRUDER || ENABLED(SWITCHING_NOZZLE) || ENABLED(PARKING_EXTRUDER)
    
      #include "module/tool_change.h"
    #endif
    
    
    #if ENABLED(USE_CONTROLLER_FAN)
      #include "feature/controllerfan.h"
    #endif
    
    
    #if ENABLED(EXTENSIBLE_UI)
      #include "lcd/extensible_ui/ui_api.h"
    #endif
    
    
    bool Running = true;
    
    
    /**
     * axis_homed
     *   Flags that each linear axis was homed.
     *   XYZ on cartesian, ABC on delta, ABZ on SCARA.
     *
     * axis_known_position
     *   Flags that the position is known in each linear axis. Set when homed.
     *   Cleared whenever a stepper powers off, potentially losing its position.
     */
    
    uint8_t axis_homed, axis_known_position; // = 0
    
    #if ENABLED(TEMPERATURE_UNITS_SUPPORT)
      TempUnit input_temp_units = TEMPUNIT_C;
    #endif
    
    
    #if FAN_COUNT > 0
    
      uint8_t fan_speed[FAN_COUNT] = { 0 };
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #if ENABLED(EXTRA_FAN_SPEED)
    
        uint8_t old_fan_speed[FAN_COUNT], new_fan_speed[FAN_COUNT];
    
      #endif
    
      #if ENABLED(PROBING_FANS_OFF)
    
        bool fans_paused; // = false;
    
        uint8_t paused_fan_speed[FAN_COUNT] = { 0 };
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    // For M109 and M190, this flag may be cleared (by M108) to exit the wait loop
    
    volatile bool wait_for_heatup = true;
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    // For M0/M1, this flag may be cleared (by M108) to exit the wait-for-user loop
    
    #if HAS_RESUME_CONTINUE
    
      volatile bool wait_for_user; // = false;
    
    #if HAS_AUTO_REPORTING || ENABLED(HOST_KEEPALIVE_FEATURE)
    
      bool suspend_auto_report; // = false
    #endif
    
    
    // Inactivity shutdown
    
    millis_t max_inactive_time, // = 0
    
             stepper_inactive_time = (DEFAULT_STEPPER_DEACTIVE_TIME) * 1000UL;
    
    #ifdef CHDK
    
      millis_t chdkHigh; // = 0;
      bool chdkActive; // = false;
    
    #endif
    
    #if ENABLED(I2C_POSITION_ENCODERS)
      I2CPositionEncodersMgr I2CPEM;
    #endif
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    /**
    
     * ***************************************************************************
     * ******************************** FUNCTIONS ********************************
     * ***************************************************************************
    
    void setup_killpin() {
      #if HAS_KILL
        SET_INPUT_PULLUP(KILL_PIN);
    
      #endif
    
    void setup_powerhold() {
      #if HAS_SUICIDE
        OUT_WRITE(SUICIDE_PIN, HIGH);
    
    AnHardt's avatar
    AnHardt committed
      #endif
    
      #if HAS_POWER_SWITCH
        #if ENABLED(PS_DEFAULT_OFF)
    
    /**
     * Stepper Reset (RigidBoard, et.al.)
     */
    #if HAS_STEPPER_RESET
      void disableStepperDrivers() {
        OUT_WRITE(STEPPER_RESET_PIN, LOW);  // drive it down to hold in reset motor driver chips
      }
      void enableStepperDrivers() { SET_INPUT(STEPPER_RESET_PIN); }  // set to input, which allows it to be pulled high by pullups
    #endif
    
    #if ENABLED(EXPERIMENTAL_I2CBUS) && I2C_SLAVE_ADDRESS > 0
    
      void i2c_on_receive(int bytes) { // just echo all bytes received to serial
        i2c.receive(bytes);
      }
    
      void i2c_on_request() {          // just send dummy data for now
        i2c.reply("Hello World!\n");
      }
    
    #endif
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    /**
     * Sensitive pin test for M42, M226
     */
    
    bool pin_is_protected(const pin_t pin) {
      static const pin_t sensitive_pins[] PROGMEM = SENSITIVE_PINS;
      for (uint8_t i = 0; i < COUNT(sensitive_pins); i++) {
        pin_t sensitive_pin;
        memcpy_P(&sensitive_pin, &sensitive_pins[i], sizeof(pin_t));
        if (pin == sensitive_pin) return true;
      }
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      return false;
    }
    
    void protected_pin_err() {
      SERIAL_ERROR_START();
      SERIAL_ERRORLNPGM(MSG_ERR_PROTECTED_PIN);
    }
    
    
    Scott Lahteine's avatar
    Scott Lahteine committed
    void quickstop_stepper() {
    
      planner.quick_stop();
    
      planner.synchronize();
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      set_current_from_steppers_for_axis(ALL_AXES);
    
      sync_plan_position();
    
    Stanley's avatar
    Stanley committed
    
    
    void enable_all_steppers() {
    
      #if ENABLED(AUTO_POWER_CONTROL)
        powerManager.power_on();
      #endif
    
      enable_X();
      enable_Y();
      enable_Z();
      enable_E0();
      enable_E1();
      enable_E2();
      enable_E3();
      enable_E4();
    
    void disable_e_steppers() {
    
      disable_E0();
      disable_E1();
      disable_E2();
      disable_E3();
      disable_E4();
    
    void disable_e_stepper(const uint8_t e) {
      switch (e) {
        case 0: disable_E0(); break;
        case 1: disable_E1(); break;
        case 2: disable_E2(); break;
        case 3: disable_E3(); break;
        case 4: disable_E4(); break;
    
        case 5: disable_E5(); break;
    
    void disable_all_steppers() {
    
      disable_X();
      disable_Y();
      disable_Z();
    
      disable_e_steppers();
    }
    
    
    Scott Lahteine's avatar
    Scott Lahteine committed
     * Manage several activities:
     *  - Check for Filament Runout
     *  - Keep the command buffer full
     *  - Check for maximum inactive time between commands
     *  - Check for maximum inactive time between stepper commands
     *  - Check if pin CHDK needs to go LOW
     *  - Check for KILL button held down
     *  - Check for HOME button held down
     *  - Check if cooling fan needs to be switched on
     *  - Check if an idle but hot extruder needs filament extruded (EXTRUDER_RUNOUT_PREVENT)
    
    void manage_inactivity(const bool ignore_stepper_queue/*=false*/) {
    
      #if ENABLED(FILAMENT_RUNOUT_SENSOR)
    
      if (commands_in_queue < BUFSIZE) get_available_commands();
    
      const millis_t ms = millis();
    
      if (max_inactive_time && ELAPSED(ms, gcode.previous_move_ms + max_inactive_time)) {
    
        SERIAL_ERROR_START();
    
        SERIAL_ECHOLNPAIR(MSG_KILL_INACTIVE_TIME, parser.command_ptr);
    
        kill(PSTR(MSG_KILLED));
      }
    
    
      // Prevent steppers timing-out in the middle of M600
    
      #if ENABLED(ADVANCED_PAUSE_FEATURE) && ENABLED(PAUSE_PARK_NO_STEPPER_TIMEOUT)
    
        #define MOVE_AWAY_TEST !did_pause_print
    
      #else
    
        #define MOVE_AWAY_TEST true
    
      if (stepper_inactive_time) {
        if (planner.has_blocks_queued())
          gcode.previous_move_ms = ms; // reset_stepper_timeout to keep steppers powered
        else if (MOVE_AWAY_TEST && !ignore_stepper_queue && ELAPSED(ms, gcode.previous_move_ms + stepper_inactive_time)) {
          #if ENABLED(DISABLE_INACTIVE_X)
            disable_X();
          #endif
          #if ENABLED(DISABLE_INACTIVE_Y)
            disable_Y();
          #endif
          #if ENABLED(DISABLE_INACTIVE_Z)
            disable_Z();
          #endif
          #if ENABLED(DISABLE_INACTIVE_E)
            disable_e_steppers();
          #endif
          #if ENABLED(AUTO_BED_LEVELING_UBL) && ENABLED(ULTIPANEL)  // Only needed with an LCD
            if (ubl.lcd_map_control) ubl.lcd_map_control = defer_return_to_status = false;
          #endif
        }
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #ifdef CHDK // Check if pin should be set to LOW after M240 set it to HIGH
    
        if (chdkActive && ELAPSED(ms, chdkHigh + CHDK_DELAY)) {
    
    blddk's avatar
    blddk committed
          chdkActive = false;
          WRITE(CHDK, LOW);
        }
      #endif
    
    
      #if HAS_KILL
    
        // Check if the kill button was pressed and wait just in case it was an accidental
        // key kill key press
        // -------------------------------------------------------------------------------
    
        static int killCount = 0;   // make the inactivity button a bit less responsive
        const int KILL_DELAY = 750;
    
        if (!READ(KILL_PIN))
    
        else if (killCount > 0)
    
        // Exceeded threshold and we can confirm that it was not accidental
        // KILL the machine
        // ----------------------------------------------------------------
    
        if (killCount >= KILL_DELAY) {
    
          SERIAL_ERROR_START();
    
          SERIAL_ERRORLNPGM(MSG_KILL_BUTTON);
          kill(PSTR(MSG_KILLED));
        }
    
      #if HAS_HOME
    
        // Check to see if we have to home, use poor man's debouncer
        // ---------------------------------------------------------
    
        static int homeDebounceCount = 0;   // poor man's debouncing count
    
        const int HOME_DEBOUNCE_DELAY = 2500;
    
        if (!IS_SD_PRINTING && !READ(HOME_PIN)) {
    
          if (!homeDebounceCount) {
    
            enqueue_and_echo_commands_P(PSTR("G28"));
    
    fmalpartida's avatar
    fmalpartida committed
            LCD_MESSAGEPGM(MSG_AUTO_HOME);
    
          }
          if (homeDebounceCount < HOME_DEBOUNCE_DELAY)
            homeDebounceCount++;
          else
            homeDebounceCount = 0;
    
      #if ENABLED(USE_CONTROLLER_FAN)
    
        controllerfan_update(); // Check if fan should be turned on to cool stepper drivers down
    
      #if ENABLED(AUTO_POWER_CONTROL)
        powerManager.check();
      #endif
    
    
      #if ENABLED(EXTRUDER_RUNOUT_PREVENT)
    
        if (thermalManager.degHotend(active_extruder) > EXTRUDER_RUNOUT_MINTEMP
    
          && ELAPSED(ms, gcode.previous_move_ms + (EXTRUDER_RUNOUT_SECONDS) * 1000UL)
          && !planner.has_blocks_queued()
    
          #if ENABLED(SWITCHING_EXTRUDER)
    
            bool oldstatus;
            switch (active_extruder) {
              default: oldstatus = E0_ENABLE_READ; enable_E0(); break;
              #if E_STEPPERS > 1
                case 2: case 3: oldstatus = E1_ENABLE_READ; enable_E1(); break;
                #if E_STEPPERS > 2
    
                  case 4: case 5: oldstatus = E2_ENABLE_READ; enable_E2(); break;
    
                #endif // E_STEPPERS > 2
              #endif // E_STEPPERS > 1
            }
    
          #else // !SWITCHING_EXTRUDER
    
            switch (active_extruder) {
    
              default: oldstatus = E0_ENABLE_READ; enable_E0(); break;
    
                case 1: oldstatus = E1_ENABLE_READ; enable_E1(); break;
    
                  case 2: oldstatus = E2_ENABLE_READ; enable_E2(); break;
    
                    case 3: oldstatus = E3_ENABLE_READ; enable_E3(); break;
    
                    #if E_STEPPERS > 4
    
                      case 4: oldstatus = E4_ENABLE_READ; enable_E4(); break;
    
                      #if E_STEPPERS > 5
                        case 5: oldstatus = E5_ENABLE_READ; enable_E5(); break;
                      #endif // E_STEPPERS > 5
    
                    #endif // E_STEPPERS > 4
                  #endif // E_STEPPERS > 3
                #endif // E_STEPPERS > 2
              #endif // E_STEPPERS > 1
    
          #endif // !SWITCHING_EXTRUDER
    
    
          const float olde = current_position[E_AXIS];
          current_position[E_AXIS] += EXTRUDER_RUNOUT_EXTRUDE;
    
          planner.buffer_line(current_position, MMM_TO_MMS(EXTRUDER_RUNOUT_SPEED), active_extruder);
    
          current_position[E_AXIS] = olde;
          planner.set_e_position_mm(olde);
    
          planner.synchronize();
    
          #if ENABLED(SWITCHING_EXTRUDER)
    
            switch (active_extruder) {
              default: oldstatus = E0_ENABLE_WRITE(oldstatus); break;
              #if E_STEPPERS > 1
                case 2: case 3: oldstatus = E1_ENABLE_WRITE(oldstatus); break;
                #if E_STEPPERS > 2
    
                  case 4: case 5: oldstatus = E2_ENABLE_WRITE(oldstatus); break;
    
                #endif // E_STEPPERS > 2
              #endif // E_STEPPERS > 1
            }
          #else // !SWITCHING_EXTRUDER
    
            switch (active_extruder) {
    
              case 0: E0_ENABLE_WRITE(oldstatus); break;
    
                case 1: E1_ENABLE_WRITE(oldstatus); break;
    
                  case 2: E2_ENABLE_WRITE(oldstatus); break;
    
                    case 3: E3_ENABLE_WRITE(oldstatus); break;
    
                    #if E_STEPPERS > 4
    
                      case 4: E4_ENABLE_WRITE(oldstatus); break;
    
                      #if E_STEPPERS > 5
                        case 5: E5_ENABLE_WRITE(oldstatus); break;
                      #endif // E_STEPPERS > 5
    
                    #endif // E_STEPPERS > 4
                  #endif // E_STEPPERS > 3
                #endif // E_STEPPERS > 2
              #endif // E_STEPPERS > 1
    
            }
          #endif // !SWITCHING_EXTRUDER
    
    
          gcode.previous_move_ms = ms; // reset_stepper_timeout to keep steppers powered
    
      #endif // EXTRUDER_RUNOUT_PREVENT
    
      #if ENABLED(DUAL_X_CARRIAGE)
    
        // handle delayed move timeout
    
        if (delayed_move_time && ELAPSED(ms, delayed_move_time + 1000UL) && IsRunning()) {
    
          // travel moves have been received so enact them
          delayed_move_time = 0xFFFFFFFFUL; // force moves to be done
    
          set_destination_from_current();
    
          prepare_move_to_destination();
    
      #if ENABLED(TEMP_STAT_LEDS)
    
        handle_status_leds();
    
      #if ENABLED(MONITOR_DRIVER_STATUS)
        monitor_tmc_driver();
    
      // Limit check_axes_activity frequency to 10Hz
      static millis_t next_check_axes_ms = 0;
      if (ELAPSED(ms, next_check_axes_ms)) {
        planner.check_axes_activity();
        next_check_axes_ms = ms + 100UL;
      }
    
    /**
     * Standard idle routine keeps the machine alive
     */
    void idle(
    
      #if ENABLED(ADVANCED_PAUSE_FEATURE)
    
        bool no_stepper_sleep/*=false*/
      #endif
    ) {
    
      #if ENABLED(MAX7219_DEBUG)
    
      #if ENABLED(HOST_KEEPALIVE_FEATURE)
        gcode.host_keepalive();
      #endif
    
      manage_inactivity(
    
        #if ENABLED(ADVANCED_PAUSE_FEATURE)
    
          no_stepper_sleep
        #endif
      );
    
      thermalManager.manage_heater();
    
      #if ENABLED(PRINTCOUNTER)
        print_job_timer.tick();
      #endif
    
    
      #if HAS_BUZZER && DISABLED(LCD_USE_I2C_BUZZER)
    
        buzzer.tick();
      #endif
    
    
      #if ENABLED(I2C_POSITION_ENCODERS)
    
        static millis_t i2cpem_next_update_ms;
    
        if (planner.has_blocks_queued() && ELAPSED(millis(), i2cpem_next_update_ms)) {
    
          I2CPEM.update();
    
          i2cpem_next_update_ms = millis() + I2CPE_MIN_UPD_TIME_MS;
    
    
      #if HAS_AUTO_REPORTING
        if (!suspend_auto_report) {
          #if ENABLED(AUTO_REPORT_TEMPERATURES)
            thermalManager.auto_report_temperatures();
          #endif
          #if ENABLED(AUTO_REPORT_SD_STATUS)
            card.auto_report_sd_status();
          #endif
        }
      #endif
    
    
      #if ENABLED(USB_FLASH_DRIVE_SUPPORT)
        Sd2Card::idle();
      #endif
    
    }
    
    /**
     * Kill all activity and lock the machine.
     * After this the machine will need to be reset.
     */
    
    void kill(PGM_P lcd_msg) {
    
      SERIAL_ERROR_START();
    
    AnHardt's avatar
    AnHardt committed
      SERIAL_ERRORLNPGM(MSG_ERR_KILLED);
    
    
    rafaljot's avatar
    rafaljot committed
      thermalManager.disable_all_heaters();
      disable_all_steppers();
    
      #if ENABLED(EXTENSIBLE_UI)
        UI::onPrinterKilled(lcd_msg);
      #elif ENABLED(ULTRA_LCD)
    
    AnHardt's avatar
    AnHardt committed
        kill_screen(lcd_msg);
    
      #else
        UNUSED(lcd_msg);
    
      _delay_ms(600); // Wait a short time (allows messages to get out before shutting down.
    
    rafaljot's avatar
    rafaljot committed
      _delay_ms(250); //Wait to ensure all interrupts routines stopped
      thermalManager.disable_all_heaters(); //turn off heaters again
    
      #ifdef ACTION_ON_KILL
    
    Ben Lye's avatar
    Ben Lye committed
        SERIAL_ECHOLNPGM("//action:" ACTION_ON_KILL);
      #endif
    
      #if HAS_POWER_SWITCH
    
    Phr3d13's avatar
    Phr3d13 committed
      #if HAS_SUICIDE
        suicide();
      #endif
    
    
      while (1) {
    
    AnHardt's avatar
    AnHardt committed
        #if ENABLED(USE_WATCHDOG)
          watchdog_reset();
        #endif
    
      } // Wait for reset
    
    /**
     * Turn off heaters and stop the print in progress
     * After a stop the machine may be resumed with M999
     */
    
    void stop() {
    
      thermalManager.disable_all_heaters(); // 'unpause' taken care of in here
    
      #if ENABLED(PROBING_FANS_OFF)
        if (fans_paused) fans_pause(false); // put things back the way they were
      #endif
    
    
      if (IsRunning()) {
        Stopped_gcode_LastN = gcode_LastN; // Save last g_code for restart
    
        SERIAL_ERROR_START();
    
        SERIAL_ERRORLNPGM(MSG_ERR_STOPPED);
        LCD_MESSAGEPGM(MSG_STOPPED);
    
        safe_delay(350);       // allow enough time for messages to get out before stopping
        Running = false;
    
    /**
     * Marlin entry-point: Set up before the program loop
     *  - Set up the kill pin, filament runout, power hold
     *  - Start the serial port
     *  - Print startup messages and diagnostics
     *  - Get EEPROM or default settings
     *  - Initialize managers for:
     *    • temperature
     *    • planner
     *    • watchdog
     *    • stepper
     *    • photo pin
     *    • servos
     *    • LCD controller
     *    • Digipot I2C
     *    • Z probe sled
     *    • status LEDs
     */
    void setup() {
    
    
      #if ENABLED(MAX7219_DEBUG)
    
      #if ENABLED(DISABLE_DEBUG)
        // Disable any hardware debug to free up pins for IO
        #ifdef JTAGSWD_DISABLE
          JTAGSWD_DISABLE();
        #elif defined(JTAG_DISABLE)
          JTAG_DISABLE();
        #else
          #error "DISABLE_DEBUG is not supported for the selected MCU/Board"
        #endif
      #elif ENABLED(DISABLE_JTAG)
    
        // Disable JTAG to free up pins for IO
        #ifdef JTAG_DISABLE
          JTAG_DISABLE();
        #else
          #error "DISABLE_JTAG is not supported for the selected MCU/Board"
        #endif
    
      #endif
    
      #if ENABLED(FILAMENT_RUNOUT_SENSOR)
    
        runout.setup();
    
      #endif
    
      setup_killpin();
    
      setup_powerhold();
    
      #if HAS_STEPPER_RESET
        disableStepperDrivers();
      #endif
    
    
    Thomas Moore's avatar
    Thomas Moore committed
      #if NUM_SERIAL > 0
        MYSERIAL0.begin(BAUDRATE);
        #if NUM_SERIAL > 1
          MYSERIAL1.begin(BAUDRATE);
        #endif
      #endif
    
      #if NUM_SERIAL > 0
        uint32_t serial_connect_timeout = millis() + 1000UL;
    
        while (!MYSERIAL0 && PENDING(millis(), serial_connect_timeout)) { /*nada*/ }
    
    Thomas Moore's avatar
    Thomas Moore committed
        #if NUM_SERIAL > 1
          serial_connect_timeout = millis() + 1000UL;
    
          while (!MYSERIAL1 && PENDING(millis(), serial_connect_timeout)) { /*nada*/ }
    
    Thomas Moore's avatar
    Thomas Moore committed
        #endif
      #endif
    
    
      SERIAL_PROTOCOLLNPGM("start");
    
      SERIAL_ECHO_START();
    
      #if TMC_HAS_SPI
    
        #if DISABLED(TMC_USE_SW_SPI)
          SPI.begin();
        #endif
    
        tmc_init_cs_pins();
      #endif
    
      #if HAS_DRIVER(TMC2208)
    
        tmc2208_serial_begin();
      #endif
    
    
      #ifdef BOARD_INIT
        BOARD_INIT();
      #endif
    
    
      // Check startup - does nothing if bootloader sets MCUSR to 0
    
      byte mcu = HAL_get_reset_source();
    
      if (mcu &  1) SERIAL_ECHOLNPGM(MSG_POWERUP);
      if (mcu &  2) SERIAL_ECHOLNPGM(MSG_EXTERNAL_RESET);
      if (mcu &  4) SERIAL_ECHOLNPGM(MSG_BROWNOUT_RESET);
      if (mcu &  8) SERIAL_ECHOLNPGM(MSG_WATCHDOG_RESET);
    
      if (mcu & 32) SERIAL_ECHOLNPGM(MSG_SOFTWARE_RESET);
    
      SERIAL_ECHOPGM(MSG_MARLIN);
    
      SERIAL_CHAR(' ');
      SERIAL_ECHOLNPGM(SHORT_BUILD_VERSION);
    
      SERIAL_EOL();
    
      #if defined(STRING_DISTRIBUTION_DATE) && defined(STRING_CONFIG_H_AUTHOR)
    
        SERIAL_ECHO_START();
    
        SERIAL_ECHOPGM(MSG_CONFIGURATION_VER);
        SERIAL_ECHOPGM(STRING_DISTRIBUTION_DATE);
        SERIAL_ECHOLNPGM(MSG_AUTHOR STRING_CONFIG_H_AUTHOR);
    
        SERIAL_ECHOLNPGM("Compiled: " __DATE__);
      #endif
    
      SERIAL_ECHO_START();
    
      SERIAL_ECHOPAIR(MSG_FREE_MEMORY, freeMemory());
      SERIAL_ECHOLNPAIR(MSG_PLANNER_BUFFER_BYTES, (int)sizeof(block_t)*BLOCK_BUFFER_SIZE);
    
    
      // Load data from EEPROM if available (or use defaults)
      // This also updates variables in the planner, elsewhere
    
      (void)settings.load();
    
        // Initialize current position based on home_offset
    
        COPY(current_position, home_offset);
    
      #else
        ZERO(current_position);
      #endif
    
    
      // Vital to init stepper/planner equivalent for current_position
    
      sync_plan_position();
    
    
      thermalManager.init();    // Initialize temperature loop
    
    
      print_job_timer.init();   // Initial setup of print job timer
    
    
      endstops.init();          // Init endstops and pullups
    
      stepper.init();           // Init stepper. This enables interrupts!
    
    
      #if HAS_SERVOS
        servo_init();
      #endif
    
      #if HAS_Z_SERVO_PROBE
    
        servo_probe_init();
      #endif
    
    
      #if HAS_PHOTOGRAPH
        OUT_WRITE(PHOTOGRAPH_PIN, LOW);
      #endif
    
    
    Stanley's avatar
    Stanley committed
      #if HAS_CASE_LIGHT
    
        update_case_light();
    
    Stanley's avatar
    Stanley committed
      #endif
    
    
      #if ENABLED(SPINDLE_LASER_ENABLE)
        OUT_WRITE(SPINDLE_LASER_ENABLE_PIN, !SPINDLE_LASER_ENABLE_INVERT);  // init spindle to off
        #if SPINDLE_DIR_CHANGE
          OUT_WRITE(SPINDLE_DIR_PIN, SPINDLE_INVERT_DIR ? 255 : 0);  // init rotation to clockwise (M3)
        #endif
    
    Scott Lahteine's avatar
    Scott Lahteine committed
        #if ENABLED(SPINDLE_LASER_PWM) && defined(SPINDLE_LASER_PWM_PIN) && SPINDLE_LASER_PWM_PIN >= 0
    
          SET_OUTPUT(SPINDLE_LASER_PWM_PIN);
          analogWrite(SPINDLE_LASER_PWM_PIN, SPINDLE_LASER_PWM_INVERT ? 255 : 0);  // set to lowest speed
        #endif
      #endif
    
    
      #if HAS_BED_PROBE
        endstops.enable_z_probe(false);
      #endif
    
    
      #if ENABLED(USE_CONTROLLER_FAN)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
        SET_OUTPUT(CONTROLLER_FAN_PIN);
    
      #endif
    
      #if HAS_STEPPER_RESET
        enableStepperDrivers();
      #endif
    
      #if ENABLED(DIGIPOT_I2C)
        digipot_i2c_init();
      #endif
    
      #if ENABLED(DAC_STEPPER_CURRENT)
        dac_init();
      #endif
    
    
      #if (ENABLED(Z_PROBE_SLED) || ENABLED(SOLENOID_PROBE)) && HAS_SOLENOID_1
    
    Scott Lahteine's avatar
    Scott Lahteine committed
        OUT_WRITE(SOL1_PIN, LOW); // OFF
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #if HAS_HOME
        SET_INPUT_PULLUP(HOME_PIN);
      #endif
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #if PIN_EXISTS(STAT_LED_RED)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
        OUT_WRITE(STAT_LED_RED_PIN, LOW); // OFF
    
    Scott Lahteine's avatar
    Scott Lahteine committed
      #if PIN_EXISTS(STAT_LED_BLUE)
    
    Scott Lahteine's avatar
    Scott Lahteine committed
        OUT_WRITE(STAT_LED_BLUE_PIN, LOW); // OFF
    
      #if HAS_COLOR_LEDS
        leds.setup();
    
      #if ENABLED(RGB_LED) || ENABLED(RGBW_LED)
    
        SET_OUTPUT(RGB_LED_R_PIN);
        SET_OUTPUT(RGB_LED_G_PIN);
        SET_OUTPUT(RGB_LED_B_PIN);
    
        #if ENABLED(RGBW_LED)
          SET_OUTPUT(RGB_LED_W_PIN);
        #endif
    
      #if ENABLED(MK2_MULTIPLEXER)
        SET_OUTPUT(E_MUX0_PIN);
        SET_OUTPUT(E_MUX1_PIN);
        SET_OUTPUT(E_MUX2_PIN);
      #endif
    
      #if HAS_FANMUX
        fanmux_init();
      #endif
    
      lcd_init();
    
      lcd_reset_status();
    
      #if ENABLED(SHOW_BOOTSCREEN)
    
      #endif
    
      #if ENABLED(MIXING_EXTRUDER) && MIXING_VIRTUAL_TOOLS > 1
    
        mixing_tools_init();
    
      #if ENABLED(BLTOUCH)
    
        bltouch_init();
    
      #if ENABLED(I2C_POSITION_ENCODERS)
        I2CPEM.init();
      #endif
    
    
      #if ENABLED(EXPERIMENTAL_I2CBUS) && I2C_SLAVE_ADDRESS > 0
        i2c.onReceive(i2c_on_receive);
        i2c.onRequest(i2c_on_request);
      #endif
    
    GMagician's avatar
    GMagician committed
      #if DO_SWITCH_EXTRUDER
    
        move_extruder_servo(0);  // Initialize extruder servo
      #endif
    
      #if ENABLED(SWITCHING_NOZZLE)
        move_nozzle_servo(0);  // Initialize nozzle servo
      #endif
    
      #if ENABLED(PARKING_EXTRUDER)
    
        pe_magnet_init();
    
      #if ENABLED(POWER_LOSS_RECOVERY)
    
        check_print_job_recovery();
    
      #if ENABLED(USE_WATCHDOG) // Reinit watchdog after HAL_get_reset_source call
        watchdog_init();
      #endif
    
    
      #if ENABLED(EXTERNAL_CLOSED_LOOP_CONTROLLER)
        init_closedloop();
      #endif
    
    
      #if ENABLED(SDSUPPORT) && DISABLED(ULTRA_LCD)
        card.beginautostart();
      #endif
    
    }
    
    /**
     * The main Marlin program loop
     *
     *  - Save or log commands to SD
     *  - Process available commands (if not saving)
     *  - Call endstop manager
    
     *  - Call inactivity manager
    
        #if ENABLED(SDSUPPORT)
          card.checkautostart();
        #endif
    
    
        #if ENABLED(SDSUPPORT) && (ENABLED(ULTIPANEL) || ENABLED(EXTENSIBLE_UI))
    
          if (abort_sd_printing) {
            abort_sd_printing = false;
            card.stopSDPrint(
              #if SD_RESORT
                true
              #endif
            );
            clear_command_queue();
            quickstop_stepper();
            print_job_timer.stop();
            thermalManager.disable_all_heaters();
            #if FAN_COUNT > 0
    
              for (uint8_t i = 0; i < FAN_COUNT; i++) fan_speed[i] = 0;
    
            #endif
            wait_for_heatup = false;
    
            #if ENABLED(POWER_LOSS_RECOVERY)
              card.removeJobRecoveryFile();
            #endif
    
        #endif // SDSUPPORT && (ENABLED(ULTIPANEL) || ENABLED(EXTENSIBLE_UI))
    
        if (commands_in_queue < BUFSIZE) get_available_commands();
        advance_command_queue();
    
        endstops.event_handler();