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.h 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  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 SANITYCHECK_H
  19. #error Your Configuration.h and Configuration_adv.h files are outdated!
  20. #endif
  21. #include "Arduino.h"
  22. typedef unsigned long millis_t;
  23. // Arduino < 1.0.0 does not define this, so we need to do it ourselves
  24. #ifndef analogInputToDigitalPin
  25. #define analogInputToDigitalPin(p) ((p) + 0xA0)
  26. #endif
  27. #ifdef USBCON
  28. #include "HardwareSerial.h"
  29. #endif
  30. #include "MarlinSerial.h"
  31. #ifndef cbi
  32. #define cbi(sfr, bit) (_SFR_BYTE(sfr) &= ~_BV(bit))
  33. #endif
  34. #ifndef sbi
  35. #define sbi(sfr, bit) (_SFR_BYTE(sfr) |= _BV(bit))
  36. #endif
  37. #include "WString.h"
  38. #ifdef USBCON
  39. #if ENABLED(BLUETOOTH)
  40. #define MYSERIAL bluetoothSerial
  41. #else
  42. #define MYSERIAL Serial
  43. #endif // BLUETOOTH
  44. #else
  45. #define MYSERIAL customizedSerial
  46. #endif
  47. #define SERIAL_CHAR(x) MYSERIAL.write(x)
  48. #define SERIAL_EOL SERIAL_CHAR('\n')
  49. #define SERIAL_PROTOCOLCHAR(x) SERIAL_CHAR(x)
  50. #define SERIAL_PROTOCOL(x) MYSERIAL.print(x)
  51. #define SERIAL_PROTOCOL_F(x,y) MYSERIAL.print(x,y)
  52. #define SERIAL_PROTOCOLPGM(x) serialprintPGM(PSTR(x))
  53. #define SERIAL_PROTOCOLLN(x) do{ MYSERIAL.print(x); SERIAL_EOL; }while(0)
  54. #define SERIAL_PROTOCOLLNPGM(x) do{ serialprintPGM(PSTR(x)); SERIAL_EOL; }while(0)
  55. extern const char errormagic[] PROGMEM;
  56. extern const char echomagic[] PROGMEM;
  57. #define SERIAL_ERROR_START serialprintPGM(errormagic)
  58. #define SERIAL_ERROR(x) SERIAL_PROTOCOL(x)
  59. #define SERIAL_ERRORPGM(x) SERIAL_PROTOCOLPGM(x)
  60. #define SERIAL_ERRORLN(x) SERIAL_PROTOCOLLN(x)
  61. #define SERIAL_ERRORLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
  62. #define SERIAL_ECHO_START serialprintPGM(echomagic)
  63. #define SERIAL_ECHO(x) SERIAL_PROTOCOL(x)
  64. #define SERIAL_ECHOPGM(x) SERIAL_PROTOCOLPGM(x)
  65. #define SERIAL_ECHOLN(x) SERIAL_PROTOCOLLN(x)
  66. #define SERIAL_ECHOLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
  67. #define SERIAL_ECHOPAIR(name,value) do{ serial_echopair_P(PSTR(name),(value)); }while(0)
  68. void serial_echopair_P(const char *s_P, int v);
  69. void serial_echopair_P(const char *s_P, long v);
  70. void serial_echopair_P(const char *s_P, float v);
  71. void serial_echopair_P(const char *s_P, double v);
  72. void serial_echopair_P(const char *s_P, unsigned long v);
  73. // Things to write to serial from Program memory. Saves 400 to 2k of RAM.
  74. FORCE_INLINE void serialprintPGM(const char *str) {
  75. char ch;
  76. while ((ch = pgm_read_byte(str))) {
  77. MYSERIAL.write(ch);
  78. str++;
  79. }
  80. }
  81. void get_command();
  82. void idle(); // the standard idle routine calls manage_inactivity(false)
  83. void manage_inactivity(bool ignore_stepper_queue=false);
  84. #if ENABLED(DUAL_X_CARRIAGE) && HAS_X_ENABLE && HAS_X2_ENABLE
  85. #define enable_x() do { X_ENABLE_WRITE( X_ENABLE_ON); X2_ENABLE_WRITE( X_ENABLE_ON); } while (0)
  86. #define disable_x() do { X_ENABLE_WRITE(!X_ENABLE_ON); X2_ENABLE_WRITE(!X_ENABLE_ON); axis_known_position[X_AXIS] = false; } while (0)
  87. #elif HAS_X_ENABLE
  88. #define enable_x() X_ENABLE_WRITE( X_ENABLE_ON)
  89. #define disable_x() { X_ENABLE_WRITE(!X_ENABLE_ON); axis_known_position[X_AXIS] = false; }
  90. #else
  91. #define enable_x() ;
  92. #define disable_x() ;
  93. #endif
  94. #if HAS_Y_ENABLE
  95. #if ENABLED(Y_DUAL_STEPPER_DRIVERS)
  96. #define enable_y() { Y_ENABLE_WRITE( Y_ENABLE_ON); Y2_ENABLE_WRITE(Y_ENABLE_ON); }
  97. #define disable_y() { Y_ENABLE_WRITE(!Y_ENABLE_ON); Y2_ENABLE_WRITE(!Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
  98. #else
  99. #define enable_y() Y_ENABLE_WRITE( Y_ENABLE_ON)
  100. #define disable_y() { Y_ENABLE_WRITE(!Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
  101. #endif
  102. #else
  103. #define enable_y() ;
  104. #define disable_y() ;
  105. #endif
  106. #if HAS_Z_ENABLE
  107. #if ENABLED(Z_DUAL_STEPPER_DRIVERS)
  108. #define enable_z() { Z_ENABLE_WRITE( Z_ENABLE_ON); Z2_ENABLE_WRITE(Z_ENABLE_ON); }
  109. #define disable_z() { Z_ENABLE_WRITE(!Z_ENABLE_ON); Z2_ENABLE_WRITE(!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  110. #else
  111. #define enable_z() Z_ENABLE_WRITE( Z_ENABLE_ON)
  112. #define disable_z() { Z_ENABLE_WRITE(!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
  113. #endif
  114. #else
  115. #define enable_z() ;
  116. #define disable_z() ;
  117. #endif
  118. #if HAS_E0_ENABLE
  119. #define enable_e0() E0_ENABLE_WRITE( E_ENABLE_ON)
  120. #define disable_e0() E0_ENABLE_WRITE(!E_ENABLE_ON)
  121. #else
  122. #define enable_e0() /* nothing */
  123. #define disable_e0() /* nothing */
  124. #endif
  125. #if (EXTRUDERS > 1) && HAS_E1_ENABLE
  126. #define enable_e1() E1_ENABLE_WRITE( E_ENABLE_ON)
  127. #define disable_e1() E1_ENABLE_WRITE(!E_ENABLE_ON)
  128. #else
  129. #define enable_e1() /* nothing */
  130. #define disable_e1() /* nothing */
  131. #endif
  132. #if (EXTRUDERS > 2) && HAS_E2_ENABLE
  133. #define enable_e2() E2_ENABLE_WRITE( E_ENABLE_ON)
  134. #define disable_e2() E2_ENABLE_WRITE(!E_ENABLE_ON)
  135. #else
  136. #define enable_e2() /* nothing */
  137. #define disable_e2() /* nothing */
  138. #endif
  139. #if (EXTRUDERS > 3) && HAS_E3_ENABLE
  140. #define enable_e3() E3_ENABLE_WRITE( E_ENABLE_ON)
  141. #define disable_e3() E3_ENABLE_WRITE(!E_ENABLE_ON)
  142. #else
  143. #define enable_e3() /* nothing */
  144. #define disable_e3() /* nothing */
  145. #endif
  146. /**
  147. * The axis order in all axis related arrays is X, Y, Z, E
  148. */
  149. #define NUM_AXIS 4
  150. /**
  151. * Axis indices as enumerated constants
  152. *
  153. * A_AXIS and B_AXIS are used by COREXY printers
  154. * X_HEAD and Y_HEAD is used for systems that don't have a 1:1 relationship between X_AXIS and X Head movement, like CoreXY bots.
  155. */
  156. enum AxisEnum {X_AXIS=0, A_AXIS=0, Y_AXIS=1, B_AXIS=1, Z_AXIS=2, C_AXIS=2, E_AXIS=3, X_HEAD=4, Y_HEAD=5, Z_HEAD=5};
  157. enum EndstopEnum {X_MIN=0, Y_MIN=1, Z_MIN=2, Z_PROBE=3, X_MAX=4, Y_MAX=5, Z_MAX=6, Z2_MIN=7, Z2_MAX=8};
  158. void enable_all_steppers();
  159. void disable_all_steppers();
  160. void FlushSerialRequestResend();
  161. void ok_to_send();
  162. void reset_bed_level();
  163. void prepare_move();
  164. void kill(const char *);
  165. void Stop();
  166. #if ENABLED(FILAMENT_RUNOUT_SENSOR)
  167. void filrunout();
  168. #endif
  169. /**
  170. * Debug flags - not yet widely applied
  171. */
  172. enum DebugFlags {
  173. DEBUG_ECHO = BIT(0),
  174. DEBUG_INFO = BIT(1),
  175. DEBUG_ERRORS = BIT(2),
  176. DEBUG_DRYRUN = BIT(3),
  177. DEBUG_COMMUNICATION = BIT(4)
  178. };
  179. extern uint8_t marlin_debug_flags;
  180. extern bool Running;
  181. inline bool IsRunning() { return Running; }
  182. inline bool IsStopped() { return !Running; }
  183. bool enqueuecommand(const char *cmd); //put a single ASCII command at the end of the current buffer or return false when it is full
  184. void enqueuecommands_P(const char *cmd); //put one or many ASCII commands at the end of the current buffer, read from flash
  185. void prepare_arc_move(char isclockwise);
  186. void clamp_to_software_endstops(float target[3]);
  187. extern millis_t previous_cmd_ms;
  188. inline void refresh_cmd_timeout() { previous_cmd_ms = millis(); }
  189. #if ENABLED(FAST_PWM_FAN)
  190. void setPwmFrequency(uint8_t pin, int val);
  191. #endif
  192. #ifndef CRITICAL_SECTION_START
  193. #define CRITICAL_SECTION_START unsigned char _sreg = SREG; cli();
  194. #define CRITICAL_SECTION_END SREG = _sreg;
  195. #endif
  196. extern bool axis_relative_modes[];
  197. extern int feedrate_multiplier;
  198. extern bool volumetric_enabled;
  199. extern int extruder_multiplier[EXTRUDERS]; // sets extrude multiply factor (in percent) for each extruder individually
  200. 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.
  201. extern float volumetric_multiplier[EXTRUDERS]; // reciprocal of cross-sectional area of filament (in square millimeters), stored this way to reduce computational burden in planner
  202. extern float current_position[NUM_AXIS];
  203. extern float home_offset[3]; // axis[n].home_offset
  204. extern float min_pos[3]; // axis[n].min_pos
  205. extern float max_pos[3]; // axis[n].max_pos
  206. extern bool axis_known_position[3]; // axis[n].is_known
  207. #if ENABLED(DELTA) || ENABLED(SCARA)
  208. void calculate_delta(float cartesian[3]);
  209. #if ENABLED(DELTA)
  210. extern float delta[3];
  211. extern float endstop_adj[3]; // axis[n].endstop_adj
  212. extern float delta_radius;
  213. extern float delta_diagonal_rod;
  214. extern float delta_segments_per_second;
  215. void recalc_delta_settings(float radius, float diagonal_rod);
  216. #if ENABLED(ENABLE_AUTO_BED_LEVELING)
  217. extern int delta_grid_spacing[2];
  218. void adjust_delta(float cartesian[3]);
  219. #endif
  220. #elif ENABLED(SCARA)
  221. extern float axis_scaling[3]; // Build size scaling
  222. void calculate_SCARA_forward_Transform(float f_scara[3]);
  223. #endif
  224. #endif
  225. #if ENABLED(Z_DUAL_ENDSTOPS)
  226. extern float z_endstop_adj;
  227. #endif
  228. #if ENABLED(ENABLE_AUTO_BED_LEVELING)
  229. extern float zprobe_zoffset;
  230. #endif
  231. #if ENABLED(PREVENT_DANGEROUS_EXTRUDE)
  232. extern float extrude_min_temp;
  233. #endif
  234. extern int fanSpeed;
  235. #if ENABLED(BARICUDA)
  236. extern int ValvePressure;
  237. extern int EtoPPressure;
  238. #endif
  239. #if ENABLED(FAN_SOFT_PWM)
  240. extern unsigned char fanSpeedSoftPwm;
  241. #endif
  242. #if ENABLED(FILAMENT_SENSOR)
  243. extern float filament_width_nominal; //holds the theoretical filament diameter ie., 3.00 or 1.75
  244. extern bool filament_sensor; //indicates that filament sensor readings should control extrusion
  245. extern float filament_width_meas; //holds the filament diameter as accurately measured
  246. extern signed char measurement_delay[]; //ring buffer to delay measurement
  247. extern int delay_index1, delay_index2; //ring buffer index. used by planner, temperature, and main code
  248. extern float delay_dist; //delay distance counter
  249. extern int meas_delay_cm; //delay distance
  250. #endif
  251. #if ENABLED(FWRETRACT)
  252. extern bool autoretract_enabled;
  253. extern bool retracted[EXTRUDERS]; // extruder[n].retracted
  254. extern float retract_length, retract_length_swap, retract_feedrate, retract_zlift;
  255. extern float retract_recover_length, retract_recover_length_swap, retract_recover_feedrate;
  256. #endif
  257. extern millis_t print_job_start_ms;
  258. extern millis_t print_job_stop_ms;
  259. // Handling multiple extruders pins
  260. extern uint8_t active_extruder;
  261. #if ENABLED(DIGIPOT_I2C)
  262. extern void digipot_i2c_set_current( int channel, float current );
  263. extern void digipot_i2c_init();
  264. #endif
  265. extern void calculate_volumetric_multipliers();
  266. #endif //MARLIN_H