Marlin.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  1. // Tonokip RepRap firmware rewrite based off of Hydra-mmm firmware.
  2. // License: GPL
  3. #ifndef MARLIN_H
  4. #define MARLIN_H
  5. #define FORCE_INLINE __attribute__((always_inline)) inline
  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. #ifndef AT90USB
  21. #define HardwareSerial_h // trick to disable the standard HWserial
  22. #endif
  23. #if (ARDUINO >= 100)
  24. # include "Arduino.h"
  25. #else
  26. # include "WProgram.h"
  27. #endif
  28. // Arduino < 1.0.0 does not define this, so we need to do it ourselves
  29. #ifndef analogInputToDigitalPin
  30. # define analogInputToDigitalPin(p) ((p) + A0)
  31. #endif
  32. #ifdef AT90USB
  33. #include "HardwareSerial.h"
  34. #endif
  35. #include "MarlinSerial.h"
  36. #ifndef cbi
  37. #define cbi(sfr, bit) (_SFR_BYTE(sfr) &= ~_BV(bit))
  38. #endif
  39. #ifndef sbi
  40. #define sbi(sfr, bit) (_SFR_BYTE(sfr) |= _BV(bit))
  41. #endif
  42. //#include "WString.h"
  43. #ifdef AT90USB
  44. #ifdef BTENABLED
  45. #define MYSERIAL bt
  46. #else
  47. #define MYSERIAL Serial
  48. #endif // BTENABLED
  49. #else
  50. #define MYSERIAL MSerial
  51. #endif
  52. #include "lcd.h"
  53. #ifdef __cplusplus
  54. extern "C" {
  55. #endif
  56. extern FILE _uartout;
  57. #ifdef __cplusplus
  58. }
  59. #endif
  60. #define uartout (&_uartout)
  61. #define SERIAL_PROTOCOL(x) (MYSERIAL.print(x))
  62. #define SERIAL_PROTOCOL_F(x,y) (MYSERIAL.print(x,y))
  63. #define SERIAL_PROTOCOLPGM(x) (serialprintPGM(PSTR(x)))
  64. #define SERIAL_PROTOCOLRPGM(x) (serialprintPGM((x)))
  65. #define SERIAL_PROTOCOLLN(x) (MYSERIAL.print(x),MYSERIAL.write('\n'))
  66. #define SERIAL_PROTOCOLLNPGM(x) (serialprintPGM(PSTR(x)),MYSERIAL.write('\n'))
  67. #define SERIAL_PROTOCOLLNRPGM(x) (serialprintPGM((x)),MYSERIAL.write('\n'))
  68. extern const char errormagic[] PROGMEM;
  69. extern const char echomagic[] PROGMEM;
  70. #define SERIAL_ERROR_START (serialprintPGM(errormagic))
  71. #define SERIAL_ERROR(x) SERIAL_PROTOCOL(x)
  72. #define SERIAL_ERRORPGM(x) SERIAL_PROTOCOLPGM(x)
  73. #define SERIAL_ERRORRPGM(x) SERIAL_PROTOCOLRPGM(x)
  74. #define SERIAL_ERRORLN(x) SERIAL_PROTOCOLLN(x)
  75. #define SERIAL_ERRORLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
  76. #define SERIAL_ERRORLNRPGM(x) SERIAL_PROTOCOLLNRPGM(x)
  77. #define SERIAL_ECHO_START (serialprintPGM(echomagic))
  78. #define SERIAL_ECHO(x) SERIAL_PROTOCOL(x)
  79. #define SERIAL_ECHOPGM(x) SERIAL_PROTOCOLPGM(x)
  80. #define SERIAL_ECHORPGM(x) SERIAL_PROTOCOLRPGM(x)
  81. #define SERIAL_ECHOLN(x) SERIAL_PROTOCOLLN(x)
  82. #define SERIAL_ECHOLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
  83. #define SERIAL_ECHOLNRPGM(x) SERIAL_PROTOCOLLNRPGM(x)
  84. #define SERIAL_ECHOPAIR(name,value) (serial_echopair_P(PSTR(name),(value)))
  85. void serial_echopair_P(const char *s_P, float v);
  86. void serial_echopair_P(const char *s_P, double v);
  87. void serial_echopair_P(const char *s_P, unsigned long v);
  88. //Things to write to serial from Program memory. Saves 400 to 2k of RAM.
  89. FORCE_INLINE void serialprintPGM(const char *str)
  90. {
  91. char ch=pgm_read_byte(str);
  92. while(ch)
  93. {
  94. MYSERIAL.write(ch);
  95. ch=pgm_read_byte(++str);
  96. }
  97. }
  98. bool is_buffer_empty();
  99. void get_command();
  100. void process_commands();
  101. void ramming();
  102. void manage_inactivity(bool ignore_stepper_queue=false);
  103. #if defined(X_ENABLE_PIN) && X_ENABLE_PIN > -1
  104. #define enable_x() WRITE(X_ENABLE_PIN, X_ENABLE_ON)
  105. #define disable_x() { WRITE(X_ENABLE_PIN,!X_ENABLE_ON); axis_known_position[X_AXIS] = false; }
  106. #else
  107. #define enable_x() ;
  108. #define disable_x() ;
  109. #endif
  110. #if defined(Y_ENABLE_PIN) && Y_ENABLE_PIN > -1
  111. #ifdef Y_DUAL_STEPPER_DRIVERS
  112. #define enable_y() { WRITE(Y_ENABLE_PIN, Y_ENABLE_ON); WRITE(Y2_ENABLE_PIN, Y_ENABLE_ON); }
  113. #define disable_y() { WRITE(Y_ENABLE_PIN,!Y_ENABLE_ON); WRITE(Y2_ENABLE_PIN, !Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
  114. #else
  115. #define enable_y() WRITE(Y_ENABLE_PIN, Y_ENABLE_ON)
  116. #define disable_y() { WRITE(Y_ENABLE_PIN,!Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
  117. #endif
  118. #else
  119. #define enable_y() ;
  120. #define disable_y() ;
  121. #endif
  122. #if defined(Z_ENABLE_PIN) && Z_ENABLE_PIN > -1
  123. #if defined(Z_AXIS_ALWAYS_ON)
  124. #ifdef Z_DUAL_STEPPER_DRIVERS
  125. #define enable_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  126. #define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  127. #else
  128. #define enable_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  129. #define disable_z() {}
  130. #endif
  131. #else
  132. #ifdef Z_DUAL_STEPPER_DRIVERS
  133. #define enable_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  134. #define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  135. #else
  136. #define enable_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  137. #define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  138. #endif
  139. #endif
  140. #else
  141. #define enable_z() {}
  142. #define disable_z() {}
  143. #endif
  144. //#if defined(Z_ENABLE_PIN) && Z_ENABLE_PIN > -1
  145. //#ifdef Z_DUAL_STEPPER_DRIVERS
  146. //#define enable_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  147. //#define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  148. //#else
  149. //#define enable_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  150. //#define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  151. //#endif
  152. //#else
  153. //#define enable_z() ;
  154. //#define disable_z() ;
  155. //#endif
  156. #if defined(E0_ENABLE_PIN) && (E0_ENABLE_PIN > -1)
  157. #define enable_e0() WRITE(E0_ENABLE_PIN, E_ENABLE_ON)
  158. #define disable_e0() WRITE(E0_ENABLE_PIN,!E_ENABLE_ON)
  159. #else
  160. #define enable_e0() /* nothing */
  161. #define disable_e0() /* nothing */
  162. #endif
  163. #if (EXTRUDERS > 1) && defined(E1_ENABLE_PIN) && (E1_ENABLE_PIN > -1)
  164. #define enable_e1() WRITE(E1_ENABLE_PIN, E_ENABLE_ON)
  165. #define disable_e1() WRITE(E1_ENABLE_PIN,!E_ENABLE_ON)
  166. #else
  167. #define enable_e1() /* nothing */
  168. #define disable_e1() /* nothing */
  169. #endif
  170. #if (EXTRUDERS > 2) && defined(E2_ENABLE_PIN) && (E2_ENABLE_PIN > -1)
  171. #define enable_e2() WRITE(E2_ENABLE_PIN, E_ENABLE_ON)
  172. #define disable_e2() WRITE(E2_ENABLE_PIN,!E_ENABLE_ON)
  173. #else
  174. #define enable_e2() /* nothing */
  175. #define disable_e2() /* nothing */
  176. #endif
  177. enum AxisEnum {X_AXIS=0, Y_AXIS=1, Z_AXIS=2, E_AXIS=3, X_HEAD=4, Y_HEAD=5};
  178. #define X_AXIS_MASK 1
  179. #define Y_AXIS_MASK 2
  180. #define Z_AXIS_MASK 4
  181. #define E_AXIS_MASK 8
  182. #define X_HEAD_MASK 16
  183. #define Y_HEAD_MASK 32
  184. void FlushSerialRequestResend();
  185. void ClearToSend();
  186. void update_currents();
  187. void get_coordinates();
  188. void prepare_move();
  189. void kill(const char *full_screen_message = NULL, unsigned char id = 0);
  190. void Stop();
  191. bool IsStopped();
  192. //put an ASCII command at the end of the current buffer.
  193. void enquecommand(const char *cmd, bool from_progmem = false);
  194. //put an ASCII command at the end of the current buffer, read from flash
  195. #define enquecommand_P(cmd) enquecommand(cmd, true)
  196. //put an ASCII command at the begin of the current buffer
  197. void enquecommand_front(const char *cmd, bool from_progmem = false);
  198. //put an ASCII command at the begin of the current buffer, read from flash
  199. #define enquecommand_front_P(cmd) enquecommand_front(cmd, true)
  200. void repeatcommand_front();
  201. // Remove all lines from the command queue.
  202. void cmdqueue_reset();
  203. void prepare_arc_move(char isclockwise);
  204. void clamp_to_software_endstops(float target[3]);
  205. void refresh_cmd_timeout(void);
  206. // Timer counter, incremented by the 1ms Arduino timer.
  207. // The standard Arduino timer() function returns this value atomically
  208. // by disabling / enabling interrupts. This is costly, if the interrupts are known
  209. // to be disabled.
  210. #ifdef SYSTEM_TIMER_2
  211. extern volatile unsigned long timer2_millis;
  212. #else //SYSTEM_TIMER_2
  213. extern volatile unsigned long timer0_millis;
  214. #endif //SYSTEM_TIMER_2
  215. // An unsynchronized equivalent to a standard Arduino _millis() function.
  216. // To be used inside an interrupt routine.
  217. FORCE_INLINE unsigned long millis_nc() {
  218. #ifdef SYSTEM_TIMER_2
  219. return timer2_millis;
  220. #else //SYSTEM_TIMER_2
  221. return timer0_millis;
  222. #endif //SYSTEM_TIMER_2
  223. }
  224. #ifdef FAST_PWM_FAN
  225. void setPwmFrequency(uint8_t pin, int val);
  226. #endif
  227. #ifndef CRITICAL_SECTION_START
  228. #define CRITICAL_SECTION_START unsigned char _sreg = SREG; cli();
  229. #define CRITICAL_SECTION_END SREG = _sreg;
  230. #endif //CRITICAL_SECTION_START
  231. extern float homing_feedrate[];
  232. extern bool axis_relative_modes[];
  233. extern int feedmultiply;
  234. extern int extrudemultiply; // Sets extrude multiply factor (in percent) for all extruders
  235. extern int extruder_multiply[EXTRUDERS]; // sets extrude multiply factor (in percent) for each extruder individually
  236. extern float volumetric_multiplier[EXTRUDERS]; // reciprocal of cross-sectional area of filament (in square millimeters), stored this way to reduce computational burden in planner
  237. extern float current_position[NUM_AXIS] ;
  238. extern float destination[NUM_AXIS] ;
  239. extern float min_pos[3];
  240. extern float max_pos[3];
  241. extern bool axis_known_position[3];
  242. extern int fanSpeed;
  243. extern void homeaxis(int axis, uint8_t cnt = 1, uint8_t* pstep = 0);
  244. extern int8_t lcd_change_fil_state;
  245. #ifdef FAN_SOFT_PWM
  246. extern unsigned char fanSpeedSoftPwm;
  247. #endif
  248. #ifdef FWRETRACT
  249. extern bool retracted[EXTRUDERS];
  250. extern float retract_length_swap;
  251. extern float retract_recover_length_swap;
  252. #endif
  253. #ifdef HOST_KEEPALIVE_FEATURE
  254. extern uint8_t host_keepalive_interval;
  255. #endif
  256. extern unsigned long starttime;
  257. extern unsigned long stoptime;
  258. extern int bowden_length[4];
  259. extern bool is_usb_printing;
  260. extern bool homing_flag;
  261. extern bool temp_cal_active;
  262. extern bool loading_flag;
  263. extern unsigned int usb_printing_counter;
  264. extern unsigned long kicktime;
  265. extern unsigned long total_filament_used;
  266. void save_statistics(unsigned long _total_filament_used, unsigned long _total_print_time);
  267. extern unsigned int heating_status;
  268. extern unsigned int status_number;
  269. extern unsigned int heating_status_counter;
  270. extern char snmm_filaments_used;
  271. extern unsigned long PingTime;
  272. extern unsigned long NcTime;
  273. extern bool no_response;
  274. extern uint8_t important_status;
  275. extern uint8_t saved_filament_type;
  276. extern bool fan_state[2];
  277. extern int fan_edge_counter[2];
  278. extern int fan_speed[2];
  279. // Handling multiple extruders pins
  280. extern uint8_t active_extruder;
  281. #endif
  282. //Long pause
  283. extern unsigned long pause_time;
  284. extern unsigned long start_pause_print;
  285. extern unsigned long t_fan_rising_edge;
  286. extern bool mesh_bed_leveling_flag;
  287. extern bool mesh_bed_run_from_menu;
  288. extern bool sortAlpha;
  289. extern char dir_names[3][9];
  290. extern int8_t lcd_change_fil_state;
  291. // save/restore printing
  292. extern bool saved_printing;
  293. //save/restore printing in case that mmu is not responding
  294. extern bool mmu_print_saved;
  295. //estimated time to end of the print
  296. extern uint8_t print_percent_done_normal;
  297. extern uint16_t print_time_remaining_normal;
  298. extern uint8_t print_percent_done_silent;
  299. extern uint16_t print_time_remaining_silent;
  300. #define PRINT_TIME_REMAINING_INIT 0xffff
  301. extern uint16_t mcode_in_progress;
  302. extern uint16_t gcode_in_progress;
  303. extern bool wizard_active; //autoload temporarily disabled during wizard
  304. extern LongTimer safetyTimer;
  305. #define PRINT_PERCENT_DONE_INIT 0xff
  306. #define PRINTER_ACTIVE (IS_SD_PRINTING || is_usb_printing || isPrintPaused || (custom_message_type == CUSTOM_MSG_TYPE_TEMCAL) || saved_printing || (lcd_commands_type == LCD_COMMAND_V2_CAL) || card.paused || mmu_print_saved)
  307. extern void calculate_extruder_multipliers();
  308. // Similar to the default Arduino delay function,
  309. // but it keeps the background tasks running.
  310. extern void delay_keep_alive(unsigned int ms);
  311. extern void check_babystep();
  312. extern void long_pause();
  313. extern void crashdet_stop_and_save_print();
  314. #ifdef DIS
  315. void d_setup();
  316. float d_ReadData();
  317. void bed_analysis(float x_dimension, float y_dimension, int x_points_num, int y_points_num, float shift_x, float shift_y);
  318. #endif
  319. float temp_comp_interpolation(float temperature);
  320. void temp_compensation_apply();
  321. void temp_compensation_start();
  322. void show_fw_version_warnings();
  323. uint8_t check_printer_version();
  324. #ifdef PINDA_THERMISTOR
  325. float temp_compensation_pinda_thermistor_offset(float temperature_pinda);
  326. #endif //PINDA_THERMISTOR
  327. void serialecho_temperatures();
  328. bool check_commands();
  329. void uvlo_();
  330. void uvlo_tiny();
  331. void recover_print(uint8_t automatic);
  332. void setup_uvlo_interrupt();
  333. #if defined(TACH_1) && TACH_1 >-1
  334. void setup_fan_interrupt();
  335. #endif
  336. //extern void recover_machine_state_after_power_panic();
  337. extern void recover_machine_state_after_power_panic(bool bTiny);
  338. extern void restore_print_from_eeprom();
  339. extern void position_menu();
  340. extern void print_world_coordinates();
  341. extern void print_physical_coordinates();
  342. extern void print_mesh_bed_leveling_table();
  343. extern void stop_and_save_print_to_ram(float z_move, float e_move);
  344. extern void restore_print_from_ram_and_continue(float e_move);
  345. //estimated time to end of the print
  346. extern uint16_t print_time_remaining();
  347. extern uint8_t calc_percent_done();
  348. #ifdef HOST_KEEPALIVE_FEATURE
  349. // States for managing Marlin and host communication
  350. // Marlin sends messages if blocked or busy
  351. /*enum MarlinBusyState {
  352. NOT_BUSY, // Not in a handler
  353. IN_HANDLER, // Processing a GCode
  354. IN_PROCESS, // Known to be blocking command input (as in G29)
  355. PAUSED_FOR_USER, // Blocking pending any input
  356. PAUSED_FOR_INPUT // Blocking pending text input (concept)
  357. };*/
  358. #define NOT_BUSY 1
  359. #define IN_HANDLER 2
  360. #define IN_PROCESS 3
  361. #define PAUSED_FOR_USER 4
  362. #define PAUSED_FOR_INPUT 5
  363. #define KEEPALIVE_STATE(n) do { busy_state = n;} while (0)
  364. extern void host_keepalive();
  365. //extern MarlinBusyState busy_state;
  366. extern int busy_state;
  367. #endif //HOST_KEEPALIVE_FEATURE
  368. #ifdef TMC2130
  369. #define FORCE_HIGH_POWER_START force_high_power_mode(true)
  370. #define FORCE_HIGH_POWER_END force_high_power_mode(false)
  371. void force_high_power_mode(bool start_high_power_section);
  372. #endif //TMC2130
  373. // G-codes
  374. void gcode_G28(bool home_x_axis, long home_x_value, bool home_y_axis, long home_y_value, bool home_z_axis, long home_z_value, bool calib, bool without_mbl);
  375. void gcode_G28(bool home_x_axis, bool home_y_axis, bool home_z_axis);
  376. bool gcode_M45(bool onlyZ, int8_t verbosity_level);
  377. void gcode_M114();
  378. void gcode_M701();
  379. #define UVLO !(PINE & (1<<4))
  380. void proc_commands();
  381. void M600_load_filament();
  382. void M600_load_filament_movements();
  383. void M600_wait_for_user(float HotendTempBckp);
  384. void M600_check_state();
  385. void load_filament_final_feed();