Marlin.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512
  1. // Tonokip RepRap firmware rewrite based off of Hydra-mmm firmware.
  2. // License: GPL
  3. #ifndef MARLIN_H
  4. #define MARLIN_H
  5. #include "macros.h"
  6. #include <math.h>
  7. #include <stdio.h>
  8. #include <stdlib.h>
  9. #include <string.h>
  10. #include <inttypes.h>
  11. #include <util/delay.h>
  12. #include <avr/pgmspace.h>
  13. #include <avr/eeprom.h>
  14. #include <avr/interrupt.h>
  15. #include "system_timer.h"
  16. #include "fastio.h"
  17. #include "Configuration.h"
  18. #include "pins.h"
  19. #include "Timer.h"
  20. extern uint8_t mbl_z_probe_nr;
  21. #ifndef AT90USB
  22. #define HardwareSerial_h // trick to disable the standard HWserial
  23. #endif
  24. #if (ARDUINO >= 100)
  25. # include "Arduino.h"
  26. #else
  27. # include "WProgram.h"
  28. #endif
  29. // Arduino < 1.0.0 does not define this, so we need to do it ourselves
  30. #ifndef analogInputToDigitalPin
  31. # define analogInputToDigitalPin(p) ((p) + A0)
  32. #endif
  33. #ifdef AT90USB
  34. #include "HardwareSerial.h"
  35. #endif
  36. #include "MarlinSerial.h"
  37. #ifndef cbi
  38. #define cbi(sfr, bit) (_SFR_BYTE(sfr) &= ~_BV(bit))
  39. #endif
  40. #ifndef sbi
  41. #define sbi(sfr, bit) (_SFR_BYTE(sfr) |= _BV(bit))
  42. #endif
  43. //#include "WString.h"
  44. #ifdef AT90USB
  45. #ifdef BTENABLED
  46. #define MYSERIAL bt
  47. #else
  48. #define MYSERIAL Serial
  49. #endif // BTENABLED
  50. #else
  51. #define MYSERIAL MSerial
  52. #endif
  53. #include "lcd.h"
  54. #ifdef __cplusplus
  55. extern "C" {
  56. #endif
  57. extern FILE _uartout;
  58. #ifdef __cplusplus
  59. }
  60. #endif
  61. #define uartout (&_uartout)
  62. #define SERIAL_PROTOCOL(x) (MYSERIAL.print(x))
  63. #define SERIAL_PROTOCOL_F(x,y) (MYSERIAL.print(x,y))
  64. #define SERIAL_PROTOCOLPGM(x) (serialprintPGM(PSTR(x)))
  65. #define SERIAL_PROTOCOLRPGM(x) (serialprintPGM((x)))
  66. #define SERIAL_PROTOCOLLN(x) (MYSERIAL.println(x))
  67. #define SERIAL_PROTOCOLLNPGM(x) (serialprintlnPGM(PSTR(x)))
  68. #define SERIAL_PROTOCOLLNRPGM(x) (serialprintlnPGM((x)))
  69. extern const char errormagic[] PROGMEM;
  70. extern const char echomagic[] PROGMEM;
  71. #define SERIAL_ERROR_START (serialprintPGM(errormagic))
  72. #define SERIAL_ERROR(x) SERIAL_PROTOCOL(x)
  73. #define SERIAL_ERRORPGM(x) SERIAL_PROTOCOLPGM(x)
  74. #define SERIAL_ERRORRPGM(x) SERIAL_PROTOCOLRPGM(x)
  75. #define SERIAL_ERRORLN(x) SERIAL_PROTOCOLLN(x)
  76. #define SERIAL_ERRORLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
  77. #define SERIAL_ERRORLNRPGM(x) SERIAL_PROTOCOLLNRPGM(x)
  78. #define SERIAL_ECHO_START (serialprintPGM(echomagic))
  79. #define SERIAL_ECHO(x) SERIAL_PROTOCOL(x)
  80. #define SERIAL_ECHOPGM(x) SERIAL_PROTOCOLPGM(x)
  81. #define SERIAL_ECHORPGM(x) SERIAL_PROTOCOLRPGM(x)
  82. #define SERIAL_ECHOLN(x) SERIAL_PROTOCOLLN(x)
  83. #define SERIAL_ECHOLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
  84. #define SERIAL_ECHOLNRPGM(x) SERIAL_PROTOCOLLNRPGM(x)
  85. #define SERIAL_ECHOPAIR(name,value) (serial_echopair_P(PSTR(name),(value)))
  86. void serial_echopair_P(const char *s_P, float v);
  87. void serial_echopair_P(const char *s_P, double v);
  88. void serial_echopair_P(const char *s_P, unsigned long v);
  89. //Things to write to serial from Program memory. Saves 400 to 2k of RAM.
  90. // Making this FORCE_INLINE is not a good idea when running out of FLASH
  91. // I'd rather skip a few CPU ticks than 5.5KB (!!) of FLASH
  92. void serialprintPGM(const char *str);
  93. //The "ln" variant of the function above.
  94. void serialprintlnPGM(const char *str);
  95. bool is_buffer_empty();
  96. void process_commands();
  97. void ramming();
  98. void manage_inactivity(bool ignore_stepper_queue=false);
  99. #if defined(X_ENABLE_PIN) && X_ENABLE_PIN > -1
  100. #define enable_x() WRITE(X_ENABLE_PIN, X_ENABLE_ON)
  101. #define disable_x() { WRITE(X_ENABLE_PIN,!X_ENABLE_ON); axis_known_position[X_AXIS] = false; }
  102. #else
  103. #define enable_x() ;
  104. #define disable_x() ;
  105. #endif
  106. #if defined(Y_ENABLE_PIN) && Y_ENABLE_PIN > -1
  107. #ifdef Y_DUAL_STEPPER_DRIVERS
  108. #define enable_y() { WRITE(Y_ENABLE_PIN, Y_ENABLE_ON); WRITE(Y2_ENABLE_PIN, Y_ENABLE_ON); }
  109. #define disable_y() { WRITE(Y_ENABLE_PIN,!Y_ENABLE_ON); WRITE(Y2_ENABLE_PIN, !Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
  110. #else
  111. #define enable_y() WRITE(Y_ENABLE_PIN, Y_ENABLE_ON)
  112. #define disable_y() { WRITE(Y_ENABLE_PIN,!Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
  113. #endif
  114. #else
  115. #define enable_y() ;
  116. #define disable_y() ;
  117. #endif
  118. #if defined(Z_ENABLE_PIN) && Z_ENABLE_PIN > -1
  119. #if defined(Z_AXIS_ALWAYS_ON)
  120. #ifdef Z_DUAL_STEPPER_DRIVERS
  121. #define poweron_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  122. #define poweroff_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  123. #else
  124. #define poweron_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  125. #define poweroff_z() {}
  126. #endif
  127. #else
  128. #ifdef Z_DUAL_STEPPER_DRIVERS
  129. #define poweron_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  130. #define poweroff_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  131. #else
  132. #define poweron_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  133. #define poweroff_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  134. #endif
  135. #endif
  136. #else
  137. #define poweron_z() {}
  138. #define poweroff_z() {}
  139. #endif
  140. #ifndef PSU_Delta
  141. #define enable_z() poweron_z()
  142. #define disable_z() poweroff_z()
  143. #else
  144. void init_force_z();
  145. void check_force_z();
  146. void enable_force_z();
  147. void disable_force_z();
  148. #define enable_z() enable_force_z()
  149. #define disable_z() disable_force_z()
  150. #endif // PSU_Delta
  151. //#if defined(Z_ENABLE_PIN) && Z_ENABLE_PIN > -1
  152. //#ifdef Z_DUAL_STEPPER_DRIVERS
  153. //#define enable_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  154. //#define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  155. //#else
  156. //#define enable_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  157. //#define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  158. //#endif
  159. //#else
  160. //#define enable_z() ;
  161. //#define disable_z() ;
  162. //#endif
  163. #if defined(E0_ENABLE_PIN) && (E0_ENABLE_PIN > -1)
  164. #define enable_e0() WRITE(E0_ENABLE_PIN, E_ENABLE_ON)
  165. #define disable_e0() WRITE(E0_ENABLE_PIN,!E_ENABLE_ON)
  166. #else
  167. #define enable_e0() /* nothing */
  168. #define disable_e0() /* nothing */
  169. #endif
  170. #if (EXTRUDERS > 1) && defined(E1_ENABLE_PIN) && (E1_ENABLE_PIN > -1)
  171. #define enable_e1() WRITE(E1_ENABLE_PIN, E_ENABLE_ON)
  172. #define disable_e1() WRITE(E1_ENABLE_PIN,!E_ENABLE_ON)
  173. #else
  174. #define enable_e1() /* nothing */
  175. #define disable_e1() /* nothing */
  176. #endif
  177. #if (EXTRUDERS > 2) && defined(E2_ENABLE_PIN) && (E2_ENABLE_PIN > -1)
  178. #define enable_e2() WRITE(E2_ENABLE_PIN, E_ENABLE_ON)
  179. #define disable_e2() WRITE(E2_ENABLE_PIN,!E_ENABLE_ON)
  180. #else
  181. #define enable_e2() /* nothing */
  182. #define disable_e2() /* nothing */
  183. #endif
  184. #define FARM_FILAMENT_COLOR_NONE 99;
  185. enum AxisEnum {X_AXIS=0, Y_AXIS=1, Z_AXIS=2, E_AXIS=3, X_HEAD=4, Y_HEAD=5};
  186. #define X_AXIS_MASK 1
  187. #define Y_AXIS_MASK 2
  188. #define Z_AXIS_MASK 4
  189. #define E_AXIS_MASK 8
  190. #define X_HEAD_MASK 16
  191. #define Y_HEAD_MASK 32
  192. void FlushSerialRequestResend();
  193. void ClearToSend();
  194. void update_currents();
  195. void get_coordinates();
  196. void prepare_move();
  197. void kill(const char *full_screen_message = NULL, unsigned char id = 0);
  198. void finishAndDisableSteppers();
  199. void UnconditionalStop(); // Stop heaters, motion and clear current print status
  200. void Stop(); // Emergency stop used by overtemp functions which allows recovery
  201. bool IsStopped(); // Returns true if the print has been stopped
  202. //put an ASCII command at the end of the current buffer, read from flash
  203. #define enquecommand_P(cmd) enquecommand(cmd, true)
  204. //put an ASCII command at the begin of the current buffer, read from flash
  205. #define enquecommand_front_P(cmd) enquecommand_front(cmd, true)
  206. void prepare_arc_move(bool isclockwise);
  207. void clamp_to_software_endstops(float target[3]);
  208. void refresh_cmd_timeout(void);
  209. // Timer counter, incremented by the 1ms Arduino timer.
  210. // The standard Arduino timer() function returns this value atomically
  211. // by disabling / enabling interrupts. This is costly, if the interrupts are known
  212. // to be disabled.
  213. #ifdef SYSTEM_TIMER_2
  214. extern volatile unsigned long timer2_millis;
  215. #else //SYSTEM_TIMER_2
  216. extern volatile unsigned long timer0_millis;
  217. #endif //SYSTEM_TIMER_2
  218. // An unsynchronized equivalent to a standard Arduino _millis() function.
  219. // To be used inside an interrupt routine.
  220. FORCE_INLINE unsigned long millis_nc() {
  221. #ifdef SYSTEM_TIMER_2
  222. return timer2_millis;
  223. #else //SYSTEM_TIMER_2
  224. return timer0_millis;
  225. #endif //SYSTEM_TIMER_2
  226. }
  227. #ifdef FAST_PWM_FAN
  228. void setPwmFrequency(uint8_t pin, int val);
  229. #endif
  230. enum class HeatingStatus : uint8_t
  231. {
  232. NO_HEATING = 0,
  233. EXTRUDER_HEATING = 1,
  234. EXTRUDER_HEATING_COMPLETE = 2,
  235. BED_HEATING = 3,
  236. BED_HEATING_COMPLETE = 4,
  237. };
  238. extern HeatingStatus heating_status;
  239. extern bool fans_check_enabled;
  240. extern float homing_feedrate[];
  241. extern uint8_t axis_relative_modes;
  242. extern float feedrate;
  243. extern int feedmultiply;
  244. extern int extrudemultiply; // Sets extrude multiply factor (in percent) for all extruders
  245. extern int extruder_multiply[EXTRUDERS]; // sets extrude multiply factor (in percent) for each extruder individually
  246. extern float extruder_multiplier[EXTRUDERS]; // reciprocal of cross-sectional area of filament (in square millimeters), stored this way to reduce computational burden in planner
  247. extern float current_position[NUM_AXIS] ;
  248. extern float destination[NUM_AXIS] ;
  249. extern float min_pos[3];
  250. extern float max_pos[3];
  251. extern bool axis_known_position[3];
  252. extern int fanSpeed;
  253. extern uint8_t newFanSpeed;
  254. extern int8_t lcd_change_fil_state;
  255. extern float default_retraction;
  256. #ifdef TMC2130
  257. void homeaxis(uint8_t axis, uint8_t cnt = 1, uint8_t* pstep = 0);
  258. #else
  259. void homeaxis(uint8_t axis, uint8_t cnt = 1);
  260. #endif //TMC2130
  261. #ifdef FAN_SOFT_PWM
  262. extern unsigned char fanSpeedSoftPwm;
  263. #endif
  264. #ifdef FWRETRACT
  265. extern bool retracted[EXTRUDERS];
  266. extern float retract_length_swap;
  267. extern float retract_recover_length_swap;
  268. #endif
  269. extern uint8_t host_keepalive_interval;
  270. extern unsigned long starttime;
  271. extern unsigned long stoptime;
  272. extern ShortTimer usb_timer;
  273. extern bool homing_flag;
  274. extern bool loading_flag;
  275. extern unsigned long total_filament_used;
  276. void save_statistics(unsigned long _total_filament_used, unsigned long _total_print_time);
  277. extern uint8_t status_number;
  278. extern uint8_t heating_status_counter;
  279. extern unsigned long PingTime;
  280. extern bool no_response;
  281. extern uint8_t important_status;
  282. extern uint8_t saved_filament_type;
  283. extern bool fan_state[2];
  284. extern int fan_edge_counter[2];
  285. extern int fan_speed[2];
  286. // Handling multiple extruders pins
  287. extern uint8_t active_extruder;
  288. //Long pause
  289. extern unsigned long pause_time;
  290. extern unsigned long start_pause_print;
  291. extern unsigned long t_fan_rising_edge;
  292. extern bool mesh_bed_leveling_flag;
  293. // save/restore printing
  294. extern bool saved_printing;
  295. extern uint8_t saved_printing_type;
  296. #define PRINTING_TYPE_SD 0
  297. #define PRINTING_TYPE_USB 1
  298. #define PRINTING_TYPE_NONE 2
  299. //save/restore printing in case that mmu is not responding
  300. extern bool mmu_print_saved;
  301. //estimated time to end of the print
  302. extern uint8_t print_percent_done_normal;
  303. extern uint8_t print_percent_done_silent;
  304. extern uint16_t print_time_remaining_normal;
  305. extern uint16_t print_time_remaining_silent;
  306. extern uint16_t print_time_to_change_normal;
  307. extern uint16_t print_time_to_change_silent;
  308. #define PRINT_TIME_REMAINING_INIT 0xffff
  309. extern uint16_t mcode_in_progress;
  310. extern uint16_t gcode_in_progress;
  311. extern LongTimer safetyTimer;
  312. #define PRINT_PERCENT_DONE_INIT 0xff
  313. #define PRINTER_ACTIVE (IS_SD_PRINTING || usb_timer.running() || isPrintPaused || (custom_message_type == CustomMsg::TempCal) || saved_printing || (lcd_commands_type == LcdCommands::Layer1Cal) || mmu_print_saved || homing_flag || mesh_bed_leveling_flag)
  314. //! Beware - mcode_in_progress is set as soon as the command gets really processed,
  315. //! which is not the same as posting the M600 command into the command queue
  316. //! There can be a considerable lag between posting M600 and its real processing which might result
  317. //! in posting multiple M600's into the command queue
  318. //! Instead, the fsensor uses another state variable :( , which is set to true, when the M600 command is enqued
  319. //! and is reset to false when the fsensor returns into its filament runout finished handler
  320. //! I'd normally change this macro, but who knows what would happen in the MMU :)
  321. #define CHECK_FSENSOR ((IS_SD_PRINTING || usb_timer.running()) && (mcode_in_progress != 600) && !saved_printing && e_active())
  322. extern void calculate_extruder_multipliers();
  323. // Similar to the default Arduino delay function,
  324. // but it keeps the background tasks running.
  325. extern void delay_keep_alive(unsigned int ms);
  326. extern void check_babystep();
  327. extern void long_pause();
  328. extern void crashdet_stop_and_save_print();
  329. #ifdef HEATBED_ANALYSIS
  330. void d_setup();
  331. float d_ReadData();
  332. void bed_analysis(float x_dimension, float y_dimension, int x_points_num, int y_points_num, float shift_x, float shift_y);
  333. void bed_check(float x_dimension, float y_dimension, int x_points_num, int y_points_num, float shift_x, float shift_y);
  334. #endif //HEATBED_ANALYSIS
  335. float temp_comp_interpolation(float temperature);
  336. void show_fw_version_warnings();
  337. uint8_t check_printer_version();
  338. #ifdef PINDA_THERMISTOR
  339. float temp_compensation_pinda_thermistor_offset(float temperature_pinda);
  340. #endif //PINDA_THERMISTOR
  341. void serialecho_temperatures();
  342. bool check_commands();
  343. void uvlo_();
  344. void uvlo_tiny();
  345. void recover_print(uint8_t automatic);
  346. void setup_uvlo_interrupt();
  347. #if defined(TACH_1) && TACH_1 >-1
  348. void setup_fan_interrupt();
  349. #endif
  350. extern bool recover_machine_state_after_power_panic();
  351. extern void restore_print_from_eeprom(bool mbl_was_active);
  352. extern void position_menu();
  353. extern void print_world_coordinates();
  354. extern void print_physical_coordinates();
  355. extern void print_mesh_bed_leveling_table();
  356. extern void stop_and_save_print_to_ram(float z_move, float e_move);
  357. extern void restore_print_from_ram_and_continue(float e_move);
  358. extern void cancel_saved_printing();
  359. //estimated time to end of the print
  360. extern uint8_t calc_percent_done();
  361. // States for managing Marlin and host communication
  362. // Marlin sends messages if blocked or busy
  363. /*enum MarlinBusyState {
  364. NOT_BUSY, // Not in a handler
  365. IN_HANDLER, // Processing a GCode
  366. IN_PROCESS, // Known to be blocking command input (as in G29)
  367. PAUSED_FOR_USER, // Blocking pending any input
  368. PAUSED_FOR_INPUT // Blocking pending text input (concept)
  369. };*/
  370. #define NOT_BUSY 1
  371. #define IN_HANDLER 2
  372. #define IN_PROCESS 3
  373. #define PAUSED_FOR_USER 4
  374. #define PAUSED_FOR_INPUT 5
  375. #define KEEPALIVE_STATE(n) do { busy_state = n;} while (0)
  376. extern void host_keepalive();
  377. //extern MarlinBusyState busy_state;
  378. extern int8_t busy_state;
  379. #ifdef TMC2130
  380. #define FORCE_HIGH_POWER_START force_high_power_mode(true)
  381. #define FORCE_HIGH_POWER_END force_high_power_mode(false)
  382. void force_high_power_mode(bool start_high_power_section);
  383. #endif //TMC2130
  384. // G-codes
  385. bool gcode_M45(bool onlyZ, int8_t verbosity_level);
  386. void gcode_M114();
  387. #if (defined(FANCHECK) && (((defined(TACH_0) && (TACH_0 >-1)) || (defined(TACH_1) && (TACH_1 > -1)))))
  388. void gcode_M123();
  389. #endif //FANCHECK and TACH_0 and TACH_1
  390. void gcode_M701();
  391. #define UVLO !(PINE & (1<<4))
  392. void proc_commands();
  393. void M600_load_filament();
  394. void M600_load_filament_movements();
  395. void M600_wait_for_user(float HotendTempBckp);
  396. void M600_check_state(float nozzle_temp);
  397. void load_filament_final_feed();
  398. void load_filament_final_retract();
  399. void marlin_wait_for_click();
  400. void raise_z_above(float target, bool plan=true);
  401. extern "C" void softReset();
  402. void stack_error();
  403. void pullup_error(bool fromTempISR);
  404. extern uint32_t IP_address;
  405. #endif