Marlin.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  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 "fastio.h"
  16. #include "Configuration.h"
  17. #include "pins.h"
  18. #ifndef AT90USB
  19. #define HardwareSerial_h // trick to disable the standard HWserial
  20. #endif
  21. #if (ARDUINO >= 100)
  22. # include "Arduino.h"
  23. #else
  24. # include "WProgram.h"
  25. #endif
  26. // Arduino < 1.0.0 does not define this, so we need to do it ourselves
  27. #ifndef analogInputToDigitalPin
  28. # define analogInputToDigitalPin(p) ((p) + A0)
  29. #endif
  30. #ifdef AT90USB
  31. #include "HardwareSerial.h"
  32. #endif
  33. #include "MarlinSerial.h"
  34. #ifndef cbi
  35. #define cbi(sfr, bit) (_SFR_BYTE(sfr) &= ~_BV(bit))
  36. #endif
  37. #ifndef sbi
  38. #define sbi(sfr, bit) (_SFR_BYTE(sfr) |= _BV(bit))
  39. #endif
  40. #include "WString.h"
  41. #ifdef AT90USB
  42. #ifdef BTENABLED
  43. #define MYSERIAL bt
  44. #else
  45. #define MYSERIAL Serial
  46. #endif // BTENABLED
  47. #else
  48. #define MYSERIAL MSerial
  49. #endif
  50. extern FILE _lcdout;
  51. #define lcdout (&_lcdout)
  52. extern FILE _uartout;
  53. #define uartout (&_uartout)
  54. #define SERIAL_PROTOCOL(x) (MYSERIAL.print(x))
  55. #define SERIAL_PROTOCOL_F(x,y) (MYSERIAL.print(x,y))
  56. #define SERIAL_PROTOCOLPGM(x) (serialprintPGM(PSTR(x)))
  57. #define SERIAL_PROTOCOLRPGM(x) (serialprintPGM((x)))
  58. #define SERIAL_PROTOCOLLN(x) (MYSERIAL.print(x),MYSERIAL.write('\n'))
  59. #define SERIAL_PROTOCOLLNPGM(x) (serialprintPGM(PSTR(x)),MYSERIAL.write('\n'))
  60. #define SERIAL_PROTOCOLLNRPGM(x) (serialprintPGM((x)),MYSERIAL.write('\n'))
  61. extern const char errormagic[] PROGMEM;
  62. extern const char echomagic[] PROGMEM;
  63. #define SERIAL_ERROR_START (serialprintPGM(errormagic))
  64. #define SERIAL_ERROR(x) SERIAL_PROTOCOL(x)
  65. #define SERIAL_ERRORPGM(x) SERIAL_PROTOCOLPGM(x)
  66. #define SERIAL_ERRORRPGM(x) SERIAL_PROTOCOLRPGM(x)
  67. #define SERIAL_ERRORLN(x) SERIAL_PROTOCOLLN(x)
  68. #define SERIAL_ERRORLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
  69. #define SERIAL_ERRORLNRPGM(x) SERIAL_PROTOCOLLNRPGM(x)
  70. #define SERIAL_ECHO_START (serialprintPGM(echomagic))
  71. #define SERIAL_ECHO(x) SERIAL_PROTOCOL(x)
  72. #define SERIAL_ECHOPGM(x) SERIAL_PROTOCOLPGM(x)
  73. #define SERIAL_ECHORPGM(x) SERIAL_PROTOCOLRPGM(x)
  74. #define SERIAL_ECHOLN(x) SERIAL_PROTOCOLLN(x)
  75. #define SERIAL_ECHOLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
  76. #define SERIAL_ECHOLNRPGM(x) SERIAL_PROTOCOLLNRPGM(x)
  77. #define SERIAL_ECHOPAIR(name,value) (serial_echopair_P(PSTR(name),(value)))
  78. void serial_echopair_P(const char *s_P, float v);
  79. void serial_echopair_P(const char *s_P, double v);
  80. void serial_echopair_P(const char *s_P, unsigned long v);
  81. //Things to write to serial from Program memory. Saves 400 to 2k of RAM.
  82. FORCE_INLINE void serialprintPGM(const char *str)
  83. {
  84. char ch=pgm_read_byte(str);
  85. while(ch)
  86. {
  87. MYSERIAL.write(ch);
  88. ch=pgm_read_byte(++str);
  89. }
  90. }
  91. bool is_buffer_empty();
  92. void get_command();
  93. void process_commands();
  94. void ramming();
  95. void manage_inactivity(bool ignore_stepper_queue=false);
  96. #if defined(X_ENABLE_PIN) && X_ENABLE_PIN > -1
  97. #define enable_x() WRITE(X_ENABLE_PIN, X_ENABLE_ON)
  98. #define disable_x() { WRITE(X_ENABLE_PIN,!X_ENABLE_ON); axis_known_position[X_AXIS] = false; }
  99. #else
  100. #define enable_x() ;
  101. #define disable_x() ;
  102. #endif
  103. #if defined(Y_ENABLE_PIN) && Y_ENABLE_PIN > -1
  104. #ifdef Y_DUAL_STEPPER_DRIVERS
  105. #define enable_y() { WRITE(Y_ENABLE_PIN, Y_ENABLE_ON); WRITE(Y2_ENABLE_PIN, Y_ENABLE_ON); }
  106. #define disable_y() { WRITE(Y_ENABLE_PIN,!Y_ENABLE_ON); WRITE(Y2_ENABLE_PIN, !Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
  107. #else
  108. #define enable_y() WRITE(Y_ENABLE_PIN, Y_ENABLE_ON)
  109. #define disable_y() { WRITE(Y_ENABLE_PIN,!Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
  110. #endif
  111. #else
  112. #define enable_y() ;
  113. #define disable_y() ;
  114. #endif
  115. #if defined(Z_ENABLE_PIN) && Z_ENABLE_PIN > -1
  116. #if defined(Z_AXIS_ALWAYS_ON)
  117. #ifdef Z_DUAL_STEPPER_DRIVERS
  118. #define enable_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  119. #define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  120. #else
  121. #define enable_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  122. #define disable_z() ;
  123. #endif
  124. #else
  125. #ifdef Z_DUAL_STEPPER_DRIVERS
  126. #define enable_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  127. #define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  128. #else
  129. #define enable_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  130. #define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  131. #endif
  132. #endif
  133. #else
  134. #define enable_z() ;
  135. #define disable_z() ;
  136. #endif
  137. //#if defined(Z_ENABLE_PIN) && Z_ENABLE_PIN > -1
  138. //#ifdef Z_DUAL_STEPPER_DRIVERS
  139. //#define enable_z() { WRITE(Z_ENABLE_PIN, Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN, Z_ENABLE_ON); }
  140. //#define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); WRITE(Z2_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  141. //#else
  142. //#define enable_z() WRITE(Z_ENABLE_PIN, Z_ENABLE_ON)
  143. //#define disable_z() { WRITE(Z_ENABLE_PIN,!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  144. //#endif
  145. //#else
  146. //#define enable_z() ;
  147. //#define disable_z() ;
  148. //#endif
  149. #if defined(E0_ENABLE_PIN) && (E0_ENABLE_PIN > -1)
  150. #define enable_e0() WRITE(E0_ENABLE_PIN, E_ENABLE_ON)
  151. #define disable_e0() WRITE(E0_ENABLE_PIN,!E_ENABLE_ON)
  152. #else
  153. #define enable_e0() /* nothing */
  154. #define disable_e0() /* nothing */
  155. #endif
  156. #if (EXTRUDERS > 1) && defined(E1_ENABLE_PIN) && (E1_ENABLE_PIN > -1)
  157. #define enable_e1() WRITE(E1_ENABLE_PIN, E_ENABLE_ON)
  158. #define disable_e1() WRITE(E1_ENABLE_PIN,!E_ENABLE_ON)
  159. #else
  160. #define enable_e1() /* nothing */
  161. #define disable_e1() /* nothing */
  162. #endif
  163. #if (EXTRUDERS > 2) && defined(E2_ENABLE_PIN) && (E2_ENABLE_PIN > -1)
  164. #define enable_e2() WRITE(E2_ENABLE_PIN, E_ENABLE_ON)
  165. #define disable_e2() WRITE(E2_ENABLE_PIN,!E_ENABLE_ON)
  166. #else
  167. #define enable_e2() /* nothing */
  168. #define disable_e2() /* nothing */
  169. #endif
  170. enum AxisEnum {X_AXIS=0, Y_AXIS=1, Z_AXIS=2, E_AXIS=3, X_HEAD=4, Y_HEAD=5};
  171. #define X_AXIS_MASK 1
  172. #define Y_AXIS_MASK 2
  173. #define Z_AXIS_MASK 4
  174. #define E_AXIS_MASK 8
  175. #define X_HEAD_MASK 16
  176. #define Y_HEAD_MASK 32
  177. void FlushSerialRequestResend();
  178. void ClearToSend();
  179. void get_coordinates();
  180. void prepare_move();
  181. void kill(const char *full_screen_message = NULL, unsigned char id = 0);
  182. void Stop();
  183. bool IsStopped();
  184. //put an ASCII command at the end of the current buffer.
  185. void enquecommand(const char *cmd, bool from_progmem = false);
  186. //put an ASCII command at the end of the current buffer, read from flash
  187. #define enquecommand_P(cmd) enquecommand(cmd, true)
  188. void enquecommand_front(const char *cmd, bool from_progmem = false);
  189. //put an ASCII command at the end of the current buffer, read from flash
  190. #define enquecommand_P(cmd) enquecommand(cmd, true)
  191. #define enquecommand_front_P(cmd) enquecommand_front(cmd, true)
  192. void repeatcommand_front();
  193. // Remove all lines from the command queue.
  194. void cmdqueue_reset();
  195. void prepare_arc_move(char isclockwise);
  196. void clamp_to_software_endstops(float target[3]);
  197. void refresh_cmd_timeout(void);
  198. #ifdef FAST_PWM_FAN
  199. void setPwmFrequency(uint8_t pin, int val);
  200. #endif
  201. #ifndef CRITICAL_SECTION_START
  202. #define CRITICAL_SECTION_START unsigned char _sreg = SREG; cli();
  203. #define CRITICAL_SECTION_END SREG = _sreg;
  204. #endif //CRITICAL_SECTION_START
  205. extern float homing_feedrate[];
  206. extern bool axis_relative_modes[];
  207. extern int feedmultiply;
  208. extern int extrudemultiply; // Sets extrude multiply factor (in percent) for all extruders
  209. extern bool volumetric_enabled;
  210. extern int extruder_multiply[EXTRUDERS]; // sets extrude multiply factor (in percent) for each extruder individually
  211. extern float filament_size[EXTRUDERS]; // cross-sectional area of filament (in millimeters), typically around 1.75 or 2.85, 0 disables the volumetric calculations for the extruder.
  212. extern float volumetric_multiplier[EXTRUDERS]; // reciprocal of cross-sectional area of filament (in square millimeters), stored this way to reduce computational burden in planner
  213. extern float current_position[NUM_AXIS] ;
  214. extern float destination[NUM_AXIS] ;
  215. extern float add_homing[3];
  216. extern float min_pos[3];
  217. extern float max_pos[3];
  218. extern bool axis_known_position[3];
  219. extern float zprobe_zoffset;
  220. extern int fanSpeed;
  221. extern void homeaxis(int axis);
  222. #ifdef FAN_SOFT_PWM
  223. extern unsigned char fanSpeedSoftPwm;
  224. #endif
  225. #ifdef FILAMENT_SENSOR
  226. extern float filament_width_nominal; //holds the theoretical filament diameter ie., 3.00 or 1.75
  227. extern bool filament_sensor; //indicates that filament sensor readings should control extrusion
  228. extern float filament_width_meas; //holds the filament diameter as accurately measured
  229. extern signed char measurement_delay[]; //ring buffer to delay measurement
  230. extern int delay_index1, delay_index2; //index into ring buffer
  231. extern float delay_dist; //delay distance counter
  232. extern int meas_delay_cm; //delay distance
  233. #endif
  234. #ifdef FWRETRACT
  235. extern bool autoretract_enabled;
  236. extern bool retracted[EXTRUDERS];
  237. extern float retract_length, retract_length_swap, retract_feedrate, retract_zlift;
  238. extern float retract_recover_length, retract_recover_length_swap, retract_recover_feedrate;
  239. #endif
  240. #ifdef HOST_KEEPALIVE_FEATURE
  241. extern uint8_t host_keepalive_interval;
  242. #endif
  243. extern unsigned long starttime;
  244. extern unsigned long stoptime;
  245. extern int bowden_length[4];
  246. extern bool is_usb_printing;
  247. extern bool homing_flag;
  248. extern bool temp_cal_active;
  249. extern bool loading_flag;
  250. extern unsigned int usb_printing_counter;
  251. extern unsigned long kicktime;
  252. extern unsigned long total_filament_used;
  253. void save_statistics(unsigned long _total_filament_used, unsigned long _total_print_time);
  254. extern unsigned int heating_status;
  255. extern unsigned int status_number;
  256. extern unsigned int heating_status_counter;
  257. extern bool custom_message;
  258. extern unsigned int custom_message_type;
  259. extern unsigned int custom_message_state;
  260. extern char snmm_filaments_used;
  261. extern unsigned long PingTime;
  262. extern bool fan_state[2];
  263. extern int fan_edge_counter[2];
  264. extern int fan_speed[2];
  265. // Handling multiple extruders pins
  266. extern uint8_t active_extruder;
  267. #ifdef DIGIPOT_I2C
  268. extern void digipot_i2c_set_current( int channel, float current );
  269. extern void digipot_i2c_init();
  270. #endif
  271. #endif
  272. //Long pause
  273. extern int saved_feedmultiply;
  274. extern float HotendTempBckp;
  275. extern int fanSpeedBckp;
  276. extern float pause_lastpos[4];
  277. extern unsigned long pause_time;
  278. extern unsigned long start_pause_print;
  279. extern unsigned long t_fan_rising_edge;
  280. extern bool mesh_bed_leveling_flag;
  281. extern bool mesh_bed_run_from_menu;
  282. extern float distance_from_min[2];
  283. extern bool sortAlpha;
  284. extern char dir_names[3][9];
  285. extern void calculate_volumetric_multipliers();
  286. // Similar to the default Arduino delay function,
  287. // but it keeps the background tasks running.
  288. extern void delay_keep_alive(unsigned int ms);
  289. extern void check_babystep();
  290. extern void long_pause();
  291. #ifdef DIS
  292. void d_setup();
  293. float d_ReadData();
  294. void bed_analysis(float x_dimension, float y_dimension, int x_points_num, int y_points_num, float shift_x, float shift_y);
  295. #endif
  296. float temp_comp_interpolation(float temperature);
  297. void temp_compensation_apply();
  298. void temp_compensation_start();
  299. #ifdef PINDA_THERMISTOR
  300. float temp_compensation_pinda_thermistor_offset(float temperature_pinda);
  301. #endif //PINDA_THERMISTOR
  302. void wait_for_heater(long codenum);
  303. void serialecho_temperatures();
  304. bool check_commands();
  305. void uvlo_();
  306. void recover_print(uint8_t automatic);
  307. void setup_uvlo_interrupt();
  308. void setup_fan_interrupt();
  309. extern void recover_machine_state_after_power_panic();
  310. extern void restore_print_from_eeprom();
  311. extern void position_menu();
  312. extern void print_world_coordinates();
  313. extern void print_physical_coordinates();
  314. extern void print_mesh_bed_leveling_table();
  315. #ifdef PAT9125
  316. extern void fsensor_init();
  317. #endif //PAT9125
  318. #ifdef HOST_KEEPALIVE_FEATURE
  319. // States for managing Marlin and host communication
  320. // Marlin sends messages if blocked or busy
  321. /*enum MarlinBusyState {
  322. NOT_BUSY, // Not in a handler
  323. IN_HANDLER, // Processing a GCode
  324. IN_PROCESS, // Known to be blocking command input (as in G29)
  325. PAUSED_FOR_USER, // Blocking pending any input
  326. PAUSED_FOR_INPUT // Blocking pending text input (concept)
  327. };*/
  328. #define NOT_BUSY 1
  329. #define IN_HANDLER 2
  330. #define IN_PROCESS 3
  331. #define PAUSED_FOR_USER 4
  332. #define PAUSED_FOR_INPUT 5
  333. #define KEEPALIVE_STATE(n) do { busy_state = n;} while (0)
  334. extern void host_keepalive();
  335. //extern MarlinBusyState busy_state;
  336. extern int busy_state;
  337. #endif //HOST_KEEPALIVE_FEATURE
  338. #ifdef TMC2130
  339. #define FORCE_HIGH_POWER_START force_high_power_mode(true)
  340. #define FORCE_HIGH_POWER_END force_high_power_mode(false)
  341. void force_high_power_mode(bool start_high_power_section);
  342. #endif //TMC2130
  343. // G-codes
  344. bool gcode_M45(bool onlyZ);
  345. void gcode_M701();
  346. #define UVLO !(PINE & (1<<4))
  347. void extr_unload2();