My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Marlin.cpp 24KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016, 2017 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. /**
  23. * About Marlin
  24. *
  25. * This firmware is a mashup between Sprinter and grbl.
  26. * - https://github.com/kliment/Sprinter
  27. * - https://github.com/grbl/grbl
  28. */
  29. #include "Marlin.h"
  30. #include "lcd/ultralcd.h"
  31. #include "module/motion.h"
  32. #include "module/planner.h"
  33. #include "module/stepper.h"
  34. #include "module/endstops.h"
  35. #include "module/probe.h"
  36. #include "module/temperature.h"
  37. #include "sd/cardreader.h"
  38. #include "module/configuration_store.h"
  39. #include "module/printcounter.h" // PrintCounter or Stopwatch
  40. #include "feature/closedloop.h"
  41. #include "HAL/shared/Delay.h"
  42. #ifdef ARDUINO
  43. #include <pins_arduino.h>
  44. #endif
  45. #include <math.h>
  46. #include "libs/nozzle.h"
  47. #include "gcode/gcode.h"
  48. #include "gcode/parser.h"
  49. #include "gcode/queue.h"
  50. #if HAS_BUZZER && DISABLED(LCD_USE_I2C_BUZZER)
  51. #include "libs/buzzer.h"
  52. #endif
  53. #if ENABLED(DIGIPOT_I2C)
  54. #include "feature/digipot/digipot.h"
  55. #endif
  56. #if ENABLED(MIXING_EXTRUDER)
  57. #include "feature/mixing.h"
  58. #endif
  59. #if ENABLED(BEZIER_CURVE_SUPPORT)
  60. #include "module/planner_bezier.h"
  61. #endif
  62. #if ENABLED(MAX7219_DEBUG)
  63. #include "feature/Max7219_Debug_LEDs.h"
  64. #endif
  65. #if HAS_COLOR_LEDS
  66. #include "feature/leds/leds.h"
  67. #endif
  68. #if HAS_SERVOS
  69. #include "module/servo.h"
  70. #endif
  71. #if HAS_DIGIPOTSS
  72. #include <SPI.h>
  73. #endif
  74. #if ENABLED(DAC_STEPPER_CURRENT)
  75. #include "feature/dac/stepper_dac.h"
  76. #endif
  77. #if ENABLED(EXPERIMENTAL_I2CBUS)
  78. #include "feature/twibus.h"
  79. TWIBus i2c;
  80. #endif
  81. #if ENABLED(I2C_POSITION_ENCODERS)
  82. #include "feature/I2CPositionEncoder.h"
  83. #endif
  84. #if HAS_TRINAMIC
  85. #include "feature/tmc_util.h"
  86. #endif
  87. #if ENABLED(SDSUPPORT)
  88. CardReader card;
  89. #endif
  90. #if ENABLED(G38_PROBE_TARGET)
  91. bool G38_move = false,
  92. G38_endstop_hit = false;
  93. #endif
  94. #if ENABLED(DELTA)
  95. #include "module/delta.h"
  96. #elif IS_SCARA
  97. #include "module/scara.h"
  98. #endif
  99. #if HAS_LEVELING
  100. #include "feature/bedlevel/bedlevel.h"
  101. #endif
  102. #if ENABLED(ADVANCED_PAUSE_FEATURE) && ENABLED(PAUSE_PARK_NO_STEPPER_TIMEOUT)
  103. #include "feature/pause.h"
  104. #endif
  105. #if ENABLED(POWER_LOSS_RECOVERY)
  106. #include "feature/power_loss_recovery.h"
  107. #endif
  108. #if ENABLED(FILAMENT_RUNOUT_SENSOR)
  109. #include "feature/runout.h"
  110. #endif
  111. #if ENABLED(TEMP_STAT_LEDS)
  112. #include "feature/leds/tempstat.h"
  113. #endif
  114. #if HAS_CASE_LIGHT
  115. #include "feature/caselight.h"
  116. #endif
  117. #if HAS_FANMUX
  118. #include "feature/fanmux.h"
  119. #endif
  120. #if DO_SWITCH_EXTRUDER || ENABLED(SWITCHING_NOZZLE) || ENABLED(PARKING_EXTRUDER)
  121. #include "module/tool_change.h"
  122. #endif
  123. #if ENABLED(USE_CONTROLLER_FAN)
  124. #include "feature/controllerfan.h"
  125. #endif
  126. #if ENABLED(EXTENSIBLE_UI)
  127. #include "lcd/extensible_ui/ui_api.h"
  128. #endif
  129. bool Running = true;
  130. #if ENABLED(TEMPERATURE_UNITS_SUPPORT)
  131. TempUnit input_temp_units = TEMPUNIT_C;
  132. #endif
  133. #if FAN_COUNT > 0
  134. uint8_t fan_speed[FAN_COUNT] = { 0 };
  135. #if ENABLED(EXTRA_FAN_SPEED)
  136. uint8_t old_fan_speed[FAN_COUNT], new_fan_speed[FAN_COUNT];
  137. #endif
  138. #if ENABLED(PROBING_FANS_OFF)
  139. bool fans_paused; // = false;
  140. uint8_t paused_fan_speed[FAN_COUNT] = { 0 };
  141. #endif
  142. #endif
  143. // For M109 and M190, this flag may be cleared (by M108) to exit the wait loop
  144. volatile bool wait_for_heatup = true;
  145. // For M0/M1, this flag may be cleared (by M108) to exit the wait-for-user loop
  146. #if HAS_RESUME_CONTINUE
  147. volatile bool wait_for_user; // = false;
  148. #endif
  149. #if HAS_AUTO_REPORTING || ENABLED(HOST_KEEPALIVE_FEATURE)
  150. bool suspend_auto_report; // = false
  151. #endif
  152. // Inactivity shutdown
  153. millis_t max_inactive_time, // = 0
  154. stepper_inactive_time = (DEFAULT_STEPPER_DEACTIVE_TIME) * 1000UL;
  155. #ifdef CHDK
  156. millis_t chdkHigh; // = 0;
  157. bool chdkActive; // = false;
  158. #endif
  159. #if ENABLED(I2C_POSITION_ENCODERS)
  160. I2CPositionEncodersMgr I2CPEM;
  161. #endif
  162. /**
  163. * ***************************************************************************
  164. * ******************************** FUNCTIONS ********************************
  165. * ***************************************************************************
  166. */
  167. void setup_killpin() {
  168. #if HAS_KILL
  169. SET_INPUT_PULLUP(KILL_PIN);
  170. #endif
  171. }
  172. void setup_powerhold() {
  173. #if HAS_SUICIDE
  174. OUT_WRITE(SUICIDE_PIN, HIGH);
  175. #endif
  176. #if HAS_POWER_SWITCH
  177. #if ENABLED(PS_DEFAULT_OFF)
  178. PSU_OFF();
  179. #else
  180. PSU_ON();
  181. #endif
  182. #endif
  183. }
  184. /**
  185. * Stepper Reset (RigidBoard, et.al.)
  186. */
  187. #if HAS_STEPPER_RESET
  188. void disableStepperDrivers() {
  189. OUT_WRITE(STEPPER_RESET_PIN, LOW); // drive it down to hold in reset motor driver chips
  190. }
  191. void enableStepperDrivers() { SET_INPUT(STEPPER_RESET_PIN); } // set to input, which allows it to be pulled high by pullups
  192. #endif
  193. #if ENABLED(EXPERIMENTAL_I2CBUS) && I2C_SLAVE_ADDRESS > 0
  194. void i2c_on_receive(int bytes) { // just echo all bytes received to serial
  195. i2c.receive(bytes);
  196. }
  197. void i2c_on_request() { // just send dummy data for now
  198. i2c.reply("Hello World!\n");
  199. }
  200. #endif
  201. /**
  202. * Sensitive pin test for M42, M226
  203. */
  204. #include "pins/sensitive_pins.h"
  205. bool pin_is_protected(const pin_t pin) {
  206. static const pin_t sensitive_pins[] PROGMEM = SENSITIVE_PINS;
  207. for (uint8_t i = 0; i < COUNT(sensitive_pins); i++) {
  208. pin_t sensitive_pin;
  209. memcpy_P(&sensitive_pin, &sensitive_pins[i], sizeof(pin_t));
  210. if (pin == sensitive_pin) return true;
  211. }
  212. return false;
  213. }
  214. void protected_pin_err() {
  215. SERIAL_ERROR_START();
  216. SERIAL_ERRORLNPGM(MSG_ERR_PROTECTED_PIN);
  217. }
  218. void quickstop_stepper() {
  219. planner.quick_stop();
  220. planner.synchronize();
  221. set_current_from_steppers_for_axis(ALL_AXES);
  222. sync_plan_position();
  223. }
  224. void enable_all_steppers() {
  225. #if ENABLED(AUTO_POWER_CONTROL)
  226. powerManager.power_on();
  227. #endif
  228. enable_X();
  229. enable_Y();
  230. enable_Z();
  231. enable_E0();
  232. enable_E1();
  233. enable_E2();
  234. enable_E3();
  235. enable_E4();
  236. enable_E5();
  237. }
  238. void disable_e_steppers() {
  239. disable_E0();
  240. disable_E1();
  241. disable_E2();
  242. disable_E3();
  243. disable_E4();
  244. disable_E5();
  245. }
  246. void disable_e_stepper(const uint8_t e) {
  247. switch (e) {
  248. case 0: disable_E0(); break;
  249. case 1: disable_E1(); break;
  250. case 2: disable_E2(); break;
  251. case 3: disable_E3(); break;
  252. case 4: disable_E4(); break;
  253. case 5: disable_E5(); break;
  254. }
  255. }
  256. void disable_all_steppers() {
  257. disable_X();
  258. disable_Y();
  259. disable_Z();
  260. disable_e_steppers();
  261. }
  262. /**
  263. * Manage several activities:
  264. * - Check for Filament Runout
  265. * - Keep the command buffer full
  266. * - Check for maximum inactive time between commands
  267. * - Check for maximum inactive time between stepper commands
  268. * - Check if pin CHDK needs to go LOW
  269. * - Check for KILL button held down
  270. * - Check for HOME button held down
  271. * - Check if cooling fan needs to be switched on
  272. * - Check if an idle but hot extruder needs filament extruded (EXTRUDER_RUNOUT_PREVENT)
  273. */
  274. void manage_inactivity(const bool ignore_stepper_queue/*=false*/) {
  275. #if ENABLED(FILAMENT_RUNOUT_SENSOR)
  276. runout.run();
  277. #endif
  278. if (commands_in_queue < BUFSIZE) get_available_commands();
  279. const millis_t ms = millis();
  280. if (max_inactive_time && ELAPSED(ms, gcode.previous_move_ms + max_inactive_time)) {
  281. SERIAL_ERROR_START();
  282. SERIAL_ECHOLNPAIR(MSG_KILL_INACTIVE_TIME, parser.command_ptr);
  283. kill();
  284. }
  285. // Prevent steppers timing-out in the middle of M600
  286. #if ENABLED(ADVANCED_PAUSE_FEATURE) && ENABLED(PAUSE_PARK_NO_STEPPER_TIMEOUT)
  287. #define MOVE_AWAY_TEST !did_pause_print
  288. #else
  289. #define MOVE_AWAY_TEST true
  290. #endif
  291. if (stepper_inactive_time) {
  292. if (planner.has_blocks_queued())
  293. gcode.previous_move_ms = ms; // reset_stepper_timeout to keep steppers powered
  294. else if (MOVE_AWAY_TEST && !ignore_stepper_queue && ELAPSED(ms, gcode.previous_move_ms + stepper_inactive_time)) {
  295. #if ENABLED(DISABLE_INACTIVE_X)
  296. disable_X();
  297. #endif
  298. #if ENABLED(DISABLE_INACTIVE_Y)
  299. disable_Y();
  300. #endif
  301. #if ENABLED(DISABLE_INACTIVE_Z)
  302. disable_Z();
  303. #endif
  304. #if ENABLED(DISABLE_INACTIVE_E)
  305. disable_e_steppers();
  306. #endif
  307. #if HAS_LCD_MENU && ENABLED(AUTO_BED_LEVELING_UBL)
  308. if (ubl.lcd_map_control) ubl.lcd_map_control = defer_return_to_status = false;
  309. #endif
  310. }
  311. }
  312. #ifdef CHDK // Check if pin should be set to LOW after M240 set it to HIGH
  313. if (chdkActive && ELAPSED(ms, chdkHigh + CHDK_DELAY)) {
  314. chdkActive = false;
  315. WRITE(CHDK, LOW);
  316. }
  317. #endif
  318. #if HAS_KILL
  319. // Check if the kill button was pressed and wait just in case it was an accidental
  320. // key kill key press
  321. // -------------------------------------------------------------------------------
  322. static int killCount = 0; // make the inactivity button a bit less responsive
  323. const int KILL_DELAY = 750;
  324. if (!READ(KILL_PIN))
  325. killCount++;
  326. else if (killCount > 0)
  327. killCount--;
  328. // Exceeded threshold and we can confirm that it was not accidental
  329. // KILL the machine
  330. // ----------------------------------------------------------------
  331. if (killCount >= KILL_DELAY) {
  332. SERIAL_ERROR_START();
  333. SERIAL_ERRORLNPGM(MSG_KILL_BUTTON);
  334. kill();
  335. }
  336. #endif
  337. #if HAS_HOME
  338. // Check to see if we have to home, use poor man's debouncer
  339. // ---------------------------------------------------------
  340. static int homeDebounceCount = 0; // poor man's debouncing count
  341. const int HOME_DEBOUNCE_DELAY = 2500;
  342. if (!IS_SD_PRINTING() && !READ(HOME_PIN)) {
  343. if (!homeDebounceCount) {
  344. enqueue_and_echo_commands_P(PSTR("G28"));
  345. LCD_MESSAGEPGM(MSG_AUTO_HOME);
  346. }
  347. if (homeDebounceCount < HOME_DEBOUNCE_DELAY)
  348. homeDebounceCount++;
  349. else
  350. homeDebounceCount = 0;
  351. }
  352. #endif
  353. #if ENABLED(USE_CONTROLLER_FAN)
  354. controllerfan_update(); // Check if fan should be turned on to cool stepper drivers down
  355. #endif
  356. #if ENABLED(AUTO_POWER_CONTROL)
  357. powerManager.check();
  358. #endif
  359. #if ENABLED(EXTRUDER_RUNOUT_PREVENT)
  360. if (thermalManager.degHotend(active_extruder) > EXTRUDER_RUNOUT_MINTEMP
  361. && ELAPSED(ms, gcode.previous_move_ms + (EXTRUDER_RUNOUT_SECONDS) * 1000UL)
  362. && !planner.has_blocks_queued()
  363. ) {
  364. #if ENABLED(SWITCHING_EXTRUDER)
  365. bool oldstatus;
  366. switch (active_extruder) {
  367. default: oldstatus = E0_ENABLE_READ; enable_E0(); break;
  368. #if E_STEPPERS > 1
  369. case 2: case 3: oldstatus = E1_ENABLE_READ; enable_E1(); break;
  370. #if E_STEPPERS > 2
  371. case 4: case 5: oldstatus = E2_ENABLE_READ; enable_E2(); break;
  372. #endif // E_STEPPERS > 2
  373. #endif // E_STEPPERS > 1
  374. }
  375. #else // !SWITCHING_EXTRUDER
  376. bool oldstatus;
  377. switch (active_extruder) {
  378. default: oldstatus = E0_ENABLE_READ; enable_E0(); break;
  379. #if E_STEPPERS > 1
  380. case 1: oldstatus = E1_ENABLE_READ; enable_E1(); break;
  381. #if E_STEPPERS > 2
  382. case 2: oldstatus = E2_ENABLE_READ; enable_E2(); break;
  383. #if E_STEPPERS > 3
  384. case 3: oldstatus = E3_ENABLE_READ; enable_E3(); break;
  385. #if E_STEPPERS > 4
  386. case 4: oldstatus = E4_ENABLE_READ; enable_E4(); break;
  387. #if E_STEPPERS > 5
  388. case 5: oldstatus = E5_ENABLE_READ; enable_E5(); break;
  389. #endif // E_STEPPERS > 5
  390. #endif // E_STEPPERS > 4
  391. #endif // E_STEPPERS > 3
  392. #endif // E_STEPPERS > 2
  393. #endif // E_STEPPERS > 1
  394. }
  395. #endif // !SWITCHING_EXTRUDER
  396. const float olde = current_position[E_AXIS];
  397. current_position[E_AXIS] += EXTRUDER_RUNOUT_EXTRUDE;
  398. planner.buffer_line(current_position, MMM_TO_MMS(EXTRUDER_RUNOUT_SPEED), active_extruder);
  399. current_position[E_AXIS] = olde;
  400. planner.set_e_position_mm(olde);
  401. planner.synchronize();
  402. #if ENABLED(SWITCHING_EXTRUDER)
  403. switch (active_extruder) {
  404. default: oldstatus = E0_ENABLE_WRITE(oldstatus); break;
  405. #if E_STEPPERS > 1
  406. case 2: case 3: oldstatus = E1_ENABLE_WRITE(oldstatus); break;
  407. #if E_STEPPERS > 2
  408. case 4: case 5: oldstatus = E2_ENABLE_WRITE(oldstatus); break;
  409. #endif // E_STEPPERS > 2
  410. #endif // E_STEPPERS > 1
  411. }
  412. #else // !SWITCHING_EXTRUDER
  413. switch (active_extruder) {
  414. case 0: E0_ENABLE_WRITE(oldstatus); break;
  415. #if E_STEPPERS > 1
  416. case 1: E1_ENABLE_WRITE(oldstatus); break;
  417. #if E_STEPPERS > 2
  418. case 2: E2_ENABLE_WRITE(oldstatus); break;
  419. #if E_STEPPERS > 3
  420. case 3: E3_ENABLE_WRITE(oldstatus); break;
  421. #if E_STEPPERS > 4
  422. case 4: E4_ENABLE_WRITE(oldstatus); break;
  423. #if E_STEPPERS > 5
  424. case 5: E5_ENABLE_WRITE(oldstatus); break;
  425. #endif // E_STEPPERS > 5
  426. #endif // E_STEPPERS > 4
  427. #endif // E_STEPPERS > 3
  428. #endif // E_STEPPERS > 2
  429. #endif // E_STEPPERS > 1
  430. }
  431. #endif // !SWITCHING_EXTRUDER
  432. gcode.previous_move_ms = ms; // reset_stepper_timeout to keep steppers powered
  433. }
  434. #endif // EXTRUDER_RUNOUT_PREVENT
  435. #if ENABLED(DUAL_X_CARRIAGE)
  436. // handle delayed move timeout
  437. if (delayed_move_time && ELAPSED(ms, delayed_move_time + 1000UL) && IsRunning()) {
  438. // travel moves have been received so enact them
  439. delayed_move_time = 0xFFFFFFFFUL; // force moves to be done
  440. set_destination_from_current();
  441. prepare_move_to_destination();
  442. }
  443. #endif
  444. #if ENABLED(TEMP_STAT_LEDS)
  445. handle_status_leds();
  446. #endif
  447. #if ENABLED(MONITOR_DRIVER_STATUS)
  448. monitor_tmc_driver();
  449. #endif
  450. // Limit check_axes_activity frequency to 10Hz
  451. static millis_t next_check_axes_ms = 0;
  452. if (ELAPSED(ms, next_check_axes_ms)) {
  453. planner.check_axes_activity();
  454. next_check_axes_ms = ms + 100UL;
  455. }
  456. }
  457. /**
  458. * Standard idle routine keeps the machine alive
  459. */
  460. void idle(
  461. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  462. bool no_stepper_sleep/*=false*/
  463. #endif
  464. ) {
  465. #if ENABLED(MAX7219_DEBUG)
  466. max7219.idle_tasks();
  467. #endif
  468. lcd_update();
  469. #if ENABLED(HOST_KEEPALIVE_FEATURE)
  470. gcode.host_keepalive();
  471. #endif
  472. manage_inactivity(
  473. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  474. no_stepper_sleep
  475. #endif
  476. );
  477. thermalManager.manage_heater();
  478. #if ENABLED(PRINTCOUNTER)
  479. print_job_timer.tick();
  480. #endif
  481. #if HAS_BUZZER && DISABLED(LCD_USE_I2C_BUZZER)
  482. buzzer.tick();
  483. #endif
  484. #if ENABLED(I2C_POSITION_ENCODERS)
  485. static millis_t i2cpem_next_update_ms;
  486. if (planner.has_blocks_queued() && ELAPSED(millis(), i2cpem_next_update_ms)) {
  487. I2CPEM.update();
  488. i2cpem_next_update_ms = millis() + I2CPE_MIN_UPD_TIME_MS;
  489. }
  490. #endif
  491. #ifdef HAL_IDLETASK
  492. HAL_idletask();
  493. #endif
  494. #if HAS_AUTO_REPORTING
  495. if (!suspend_auto_report) {
  496. #if ENABLED(AUTO_REPORT_TEMPERATURES)
  497. thermalManager.auto_report_temperatures();
  498. #endif
  499. #if ENABLED(AUTO_REPORT_SD_STATUS)
  500. card.auto_report_sd_status();
  501. #endif
  502. }
  503. #endif
  504. #if ENABLED(USB_FLASH_DRIVE_SUPPORT)
  505. Sd2Card::idle();
  506. #endif
  507. }
  508. /**
  509. * Kill all activity and lock the machine.
  510. * After this the machine will need to be reset.
  511. */
  512. void kill(PGM_P const lcd_msg/*=NULL*/) {
  513. thermalManager.disable_all_heaters();
  514. SERIAL_ERROR_START();
  515. SERIAL_ERRORLNPGM(MSG_ERR_KILLED);
  516. #if ENABLED(ULTRA_LCD) || ENABLED(EXTENSIBLE_UI)
  517. kill_screen(lcd_msg ? lcd_msg : PSTR(MSG_KILLED));
  518. #else
  519. UNUSED(lcd_msg);
  520. #endif
  521. #ifdef ACTION_ON_KILL
  522. SERIAL_ECHOLNPGM("//action:" ACTION_ON_KILL);
  523. #endif
  524. minkill();
  525. }
  526. void minkill() {
  527. // Wait a short time (allows messages to get out before shutting down.
  528. for (int i = 1000; i--;) DELAY_US(600);
  529. cli(); // Stop interrupts
  530. // Wait to ensure all interrupts stopped
  531. for (int i = 1000; i--;) DELAY_US(250);
  532. thermalManager.disable_all_heaters(); // turn off heaters again
  533. #if HAS_POWER_SWITCH
  534. PSU_OFF();
  535. #endif
  536. #if HAS_SUICIDE
  537. suicide();
  538. #endif
  539. while (1) {
  540. #if ENABLED(USE_WATCHDOG)
  541. watchdog_reset();
  542. #endif
  543. } // Wait for reset
  544. }
  545. /**
  546. * Turn off heaters and stop the print in progress
  547. * After a stop the machine may be resumed with M999
  548. */
  549. void stop() {
  550. thermalManager.disable_all_heaters(); // 'unpause' taken care of in here
  551. print_job_timer.stop();
  552. #if ENABLED(PROBING_FANS_OFF)
  553. if (fans_paused) fans_pause(false); // put things back the way they were
  554. #endif
  555. if (IsRunning()) {
  556. Stopped_gcode_LastN = gcode_LastN; // Save last g_code for restart
  557. SERIAL_ERROR_START();
  558. SERIAL_ERRORLNPGM(MSG_ERR_STOPPED);
  559. LCD_MESSAGEPGM(MSG_STOPPED);
  560. safe_delay(350); // allow enough time for messages to get out before stopping
  561. Running = false;
  562. }
  563. }
  564. /**
  565. * Marlin entry-point: Set up before the program loop
  566. * - Set up the kill pin, filament runout, power hold
  567. * - Start the serial port
  568. * - Print startup messages and diagnostics
  569. * - Get EEPROM or default settings
  570. * - Initialize managers for:
  571. * • temperature
  572. * • planner
  573. * • watchdog
  574. * • stepper
  575. * • photo pin
  576. * • servos
  577. * • LCD controller
  578. * • Digipot I2C
  579. * • Z probe sled
  580. * • status LEDs
  581. */
  582. void setup() {
  583. #ifdef HAL_INIT
  584. HAL_init();
  585. #endif
  586. #if ENABLED(MAX7219_DEBUG)
  587. max7219.init();
  588. #endif
  589. #if ENABLED(DISABLE_DEBUG)
  590. // Disable any hardware debug to free up pins for IO
  591. #ifdef JTAGSWD_DISABLE
  592. JTAGSWD_DISABLE();
  593. #elif defined(JTAG_DISABLE)
  594. JTAG_DISABLE();
  595. #else
  596. #error "DISABLE_DEBUG is not supported for the selected MCU/Board"
  597. #endif
  598. #elif ENABLED(DISABLE_JTAG)
  599. // Disable JTAG to free up pins for IO
  600. #ifdef JTAG_DISABLE
  601. JTAG_DISABLE();
  602. #else
  603. #error "DISABLE_JTAG is not supported for the selected MCU/Board"
  604. #endif
  605. #endif
  606. #if ENABLED(FILAMENT_RUNOUT_SENSOR)
  607. runout.setup();
  608. #endif
  609. setup_killpin();
  610. setup_powerhold();
  611. #if HAS_STEPPER_RESET
  612. disableStepperDrivers();
  613. #endif
  614. #if NUM_SERIAL > 0
  615. MYSERIAL0.begin(BAUDRATE);
  616. #if NUM_SERIAL > 1
  617. MYSERIAL1.begin(BAUDRATE);
  618. #endif
  619. #endif
  620. #if NUM_SERIAL > 0
  621. uint32_t serial_connect_timeout = millis() + 1000UL;
  622. while (!MYSERIAL0 && PENDING(millis(), serial_connect_timeout)) { /*nada*/ }
  623. #if NUM_SERIAL > 1
  624. serial_connect_timeout = millis() + 1000UL;
  625. while (!MYSERIAL1 && PENDING(millis(), serial_connect_timeout)) { /*nada*/ }
  626. #endif
  627. #endif
  628. SERIAL_PROTOCOLLNPGM("start");
  629. SERIAL_ECHO_START();
  630. #if TMC_HAS_SPI
  631. #if DISABLED(TMC_USE_SW_SPI)
  632. SPI.begin();
  633. #endif
  634. tmc_init_cs_pins();
  635. #endif
  636. #if HAS_DRIVER(TMC2208)
  637. tmc2208_serial_begin();
  638. #endif
  639. #ifdef BOARD_INIT
  640. BOARD_INIT();
  641. #endif
  642. // Check startup - does nothing if bootloader sets MCUSR to 0
  643. byte mcu = HAL_get_reset_source();
  644. if (mcu & 1) SERIAL_ECHOLNPGM(MSG_POWERUP);
  645. if (mcu & 2) SERIAL_ECHOLNPGM(MSG_EXTERNAL_RESET);
  646. if (mcu & 4) SERIAL_ECHOLNPGM(MSG_BROWNOUT_RESET);
  647. if (mcu & 8) SERIAL_ECHOLNPGM(MSG_WATCHDOG_RESET);
  648. if (mcu & 32) SERIAL_ECHOLNPGM(MSG_SOFTWARE_RESET);
  649. HAL_clear_reset_source();
  650. SERIAL_ECHOPGM(MSG_MARLIN);
  651. SERIAL_CHAR(' ');
  652. SERIAL_ECHOLNPGM(SHORT_BUILD_VERSION);
  653. SERIAL_EOL();
  654. #if defined(STRING_DISTRIBUTION_DATE) && defined(STRING_CONFIG_H_AUTHOR)
  655. SERIAL_ECHO_START();
  656. SERIAL_ECHOPGM(MSG_CONFIGURATION_VER);
  657. SERIAL_ECHOPGM(STRING_DISTRIBUTION_DATE);
  658. SERIAL_ECHOLNPGM(MSG_AUTHOR STRING_CONFIG_H_AUTHOR);
  659. SERIAL_ECHO_START();
  660. SERIAL_ECHOLNPGM("Compiled: " __DATE__);
  661. #endif
  662. SERIAL_ECHO_START();
  663. SERIAL_ECHOPAIR(MSG_FREE_MEMORY, freeMemory());
  664. SERIAL_ECHOLNPAIR(MSG_PLANNER_BUFFER_BYTES, (int)sizeof(block_t)*BLOCK_BUFFER_SIZE);
  665. queue_setup();
  666. // Load data from EEPROM if available (or use defaults)
  667. // This also updates variables in the planner, elsewhere
  668. (void)settings.load();
  669. #if HAS_M206_COMMAND
  670. // Initialize current position based on home_offset
  671. COPY(current_position, home_offset);
  672. #else
  673. ZERO(current_position);
  674. #endif
  675. // Vital to init stepper/planner equivalent for current_position
  676. sync_plan_position();
  677. thermalManager.init(); // Initialize temperature loop
  678. print_job_timer.init(); // Initial setup of print job timer
  679. endstops.init(); // Init endstops and pullups
  680. stepper.init(); // Init stepper. This enables interrupts!
  681. #if HAS_SERVOS
  682. servo_init();
  683. #endif
  684. #if HAS_Z_SERVO_PROBE
  685. servo_probe_init();
  686. #endif
  687. #if HAS_PHOTOGRAPH
  688. OUT_WRITE(PHOTOGRAPH_PIN, LOW);
  689. #endif
  690. #if HAS_CASE_LIGHT
  691. update_case_light();
  692. #endif
  693. #if ENABLED(SPINDLE_LASER_ENABLE)
  694. OUT_WRITE(SPINDLE_LASER_ENABLE_PIN, !SPINDLE_LASER_ENABLE_INVERT); // init spindle to off
  695. #if SPINDLE_DIR_CHANGE
  696. OUT_WRITE(SPINDLE_DIR_PIN, SPINDLE_INVERT_DIR ? 255 : 0); // init rotation to clockwise (M3)
  697. #endif
  698. #if ENABLED(SPINDLE_LASER_PWM) && defined(SPINDLE_LASER_PWM_PIN) && SPINDLE_LASER_PWM_PIN >= 0
  699. SET_OUTPUT(SPINDLE_LASER_PWM_PIN);
  700. analogWrite(SPINDLE_LASER_PWM_PIN, SPINDLE_LASER_PWM_INVERT ? 255 : 0); // set to lowest speed
  701. #endif
  702. #endif
  703. #if HAS_BED_PROBE
  704. endstops.enable_z_probe(false);
  705. #endif
  706. #if ENABLED(USE_CONTROLLER_FAN)
  707. SET_OUTPUT(CONTROLLER_FAN_PIN);
  708. #endif
  709. #if HAS_STEPPER_RESET
  710. enableStepperDrivers();
  711. #endif
  712. #if ENABLED(DIGIPOT_I2C)
  713. digipot_i2c_init();
  714. #endif
  715. #if ENABLED(DAC_STEPPER_CURRENT)
  716. dac_init();
  717. #endif
  718. #if (ENABLED(Z_PROBE_SLED) || ENABLED(SOLENOID_PROBE)) && HAS_SOLENOID_1
  719. OUT_WRITE(SOL1_PIN, LOW); // OFF
  720. #endif
  721. #if HAS_HOME
  722. SET_INPUT_PULLUP(HOME_PIN);
  723. #endif
  724. #if PIN_EXISTS(STAT_LED_RED)
  725. OUT_WRITE(STAT_LED_RED_PIN, LOW); // OFF
  726. #endif
  727. #if PIN_EXISTS(STAT_LED_BLUE)
  728. OUT_WRITE(STAT_LED_BLUE_PIN, LOW); // OFF
  729. #endif
  730. #if HAS_COLOR_LEDS
  731. leds.setup();
  732. #endif
  733. #if ENABLED(RGB_LED) || ENABLED(RGBW_LED)
  734. SET_OUTPUT(RGB_LED_R_PIN);
  735. SET_OUTPUT(RGB_LED_G_PIN);
  736. SET_OUTPUT(RGB_LED_B_PIN);
  737. #if ENABLED(RGBW_LED)
  738. SET_OUTPUT(RGB_LED_W_PIN);
  739. #endif
  740. #endif
  741. #if ENABLED(MK2_MULTIPLEXER)
  742. SET_OUTPUT(E_MUX0_PIN);
  743. SET_OUTPUT(E_MUX1_PIN);
  744. SET_OUTPUT(E_MUX2_PIN);
  745. #endif
  746. #if HAS_FANMUX
  747. fanmux_init();
  748. #endif
  749. lcd_init();
  750. lcd_reset_status();
  751. #if ENABLED(SHOW_BOOTSCREEN)
  752. lcd_bootscreen();
  753. #endif
  754. #if ENABLED(MIXING_EXTRUDER)
  755. mixer.init();
  756. #endif
  757. #if ENABLED(BLTOUCH)
  758. bltouch_init();
  759. #endif
  760. #if ENABLED(I2C_POSITION_ENCODERS)
  761. I2CPEM.init();
  762. #endif
  763. #if ENABLED(EXPERIMENTAL_I2CBUS) && I2C_SLAVE_ADDRESS > 0
  764. i2c.onReceive(i2c_on_receive);
  765. i2c.onRequest(i2c_on_request);
  766. #endif
  767. #if DO_SWITCH_EXTRUDER
  768. move_extruder_servo(0); // Initialize extruder servo
  769. #endif
  770. #if ENABLED(SWITCHING_NOZZLE)
  771. move_nozzle_servo(0); // Initialize nozzle servo
  772. #endif
  773. #if ENABLED(PARKING_EXTRUDER)
  774. pe_magnet_init();
  775. #endif
  776. #if ENABLED(POWER_LOSS_RECOVERY)
  777. check_print_job_recovery();
  778. #endif
  779. #if ENABLED(USE_WATCHDOG) // Reinit watchdog after HAL_get_reset_source call
  780. watchdog_init();
  781. #endif
  782. #if ENABLED(EXTERNAL_CLOSED_LOOP_CONTROLLER)
  783. init_closedloop();
  784. #endif
  785. #if ENABLED(SDSUPPORT) && DISABLED(ULTRA_LCD)
  786. card.beginautostart();
  787. #endif
  788. }
  789. /**
  790. * The main Marlin program loop
  791. *
  792. * - Save or log commands to SD
  793. * - Process available commands (if not saving)
  794. * - Call endstop manager
  795. * - Call inactivity manager
  796. */
  797. void loop() {
  798. for (;;) {
  799. #if ENABLED(SDSUPPORT)
  800. card.checkautostart();
  801. if (card.abort_sd_printing) {
  802. card.stopSDPrint(
  803. #if SD_RESORT
  804. true
  805. #endif
  806. );
  807. clear_command_queue();
  808. quickstop_stepper();
  809. print_job_timer.stop();
  810. thermalManager.disable_all_heaters();
  811. zero_fan_speeds();
  812. wait_for_heatup = false;
  813. #if ENABLED(POWER_LOSS_RECOVERY)
  814. card.removeJobRecoveryFile();
  815. #endif
  816. }
  817. #endif // SDSUPPORT
  818. if (commands_in_queue < BUFSIZE) get_available_commands();
  819. advance_command_queue();
  820. endstops.event_handler();
  821. idle();
  822. }
  823. }