2011-12-22 07:55:45 -06:00
// Tonokip RepRap firmware rewrite based off of Hydra-mmm firmware.
2014-02-25 04:01:15 -06:00
// License: GPL
2011-12-22 07:55:45 -06:00
2012-06-02 13:44:17 -05:00
# ifndef MARLIN_H
# define MARLIN_H
2011-11-04 12:02:56 -05:00
2011-12-22 07:55:45 -06:00
# define FORCE_INLINE __attribute__((always_inline)) inline
2015-08-11 11:38:26 -05:00
/**
2016-03-05 22:41:15 -06:00
* Compiler warning on unused variable .
2015-08-11 11:38:26 -05:00
*/
# define UNUSED(x) (void) (x)
2011-12-22 07:55:45 -06:00
2011-11-30 02:07:56 -06:00
# include <math.h>
2011-12-22 07:55:45 -06:00
# include <stdio.h>
# include <stdlib.h>
# include <string.h>
# include <inttypes.h>
2012-02-09 12:38:53 -06:00
# include <util/delay.h>
2011-12-22 05:38:50 -06:00
# include <avr/pgmspace.h>
2011-12-22 07:55:45 -06:00
# include <avr/eeprom.h>
2012-11-06 05:06:41 -06:00
# include <avr/interrupt.h>
2011-12-22 07:55:45 -06:00
# include "fastio.h"
# include "Configuration.h"
2015-05-21 11:44:40 -05:00
# include "pins.h"
2012-12-09 03:40:33 -06:00
2015-05-12 03:33:51 -05:00
# ifndef SANITYCHECK_H
# error Your Configuration.h and Configuration_adv.h files are outdated!
# endif
2015-06-07 04:40:52 -05:00
# include "Arduino.h"
2015-01-02 10:11:18 -06:00
2015-04-12 20:07:08 -05:00
typedef unsigned long millis_t ;
2015-03-14 06:28:22 -05:00
2015-01-02 10:11:18 -06:00
// Arduino < 1.0.0 does not define this, so we need to do it ourselves
# ifndef analogInputToDigitalPin
2015-03-07 00:14:34 -06:00
# define analogInputToDigitalPin(p) ((p) + 0xA0)
2011-12-01 09:38:01 -06:00
# endif
2011-12-22 05:38:50 -06:00
2015-05-24 11:32:34 -05:00
# ifdef USBCON
2015-03-07 00:14:34 -06:00
# include "HardwareSerial.h"
2013-10-30 05:45:32 -05:00
# endif
2011-11-27 14:12:55 -06:00
# include "MarlinSerial.h"
2011-11-09 13:27:15 -06:00
2011-12-22 07:55:45 -06:00
# ifndef cbi
2015-03-07 00:14:34 -06:00
# define cbi(sfr, bit) (_SFR_BYTE(sfr) &= ~_BV(bit))
2011-12-22 07:55:45 -06:00
# endif
# ifndef sbi
2015-03-07 00:14:34 -06:00
# define sbi(sfr, bit) (_SFR_BYTE(sfr) |= _BV(bit))
2011-12-22 07:55:45 -06:00
# endif
# include "WString.h"
2015-05-24 11:32:34 -05:00
# ifdef USBCON
2015-07-31 18:55:47 -05:00
# if ENABLED(BLUETOOTH)
2015-07-31 22:31:53 -05:00
# define MYSERIAL bluetoothSerial
2015-03-07 00:14:34 -06:00
# else
# define MYSERIAL Serial
2015-07-31 18:55:47 -05:00
# endif // BLUETOOTH
2013-11-10 09:36:37 -06:00
# else
2015-07-31 22:31:53 -05:00
# define MYSERIAL customizedSerial
2013-10-30 05:45:32 -05:00
# endif
2015-04-03 23:43:30 -05:00
# define SERIAL_CHAR(x) MYSERIAL.write(x)
# define SERIAL_EOL SERIAL_CHAR('\n')
# define SERIAL_PROTOCOLCHAR(x) SERIAL_CHAR(x)
# define SERIAL_PROTOCOL(x) MYSERIAL.print(x)
# define SERIAL_PROTOCOL_F(x,y) MYSERIAL.print(x,y)
# define SERIAL_PROTOCOLPGM(x) serialprintPGM(PSTR(x))
2015-07-07 00:06:07 -05:00
# define SERIAL_PROTOCOLLN(x) do{ MYSERIAL.print(x); SERIAL_EOL; }while(0)
# define SERIAL_PROTOCOLLNPGM(x) do{ serialprintPGM(PSTR(x)); SERIAL_EOL; }while(0)
2011-12-04 05:40:18 -06:00
2011-11-09 13:27:15 -06:00
2014-12-28 00:09:42 -06:00
extern const char errormagic [ ] PROGMEM ;
extern const char echomagic [ ] PROGMEM ;
2015-04-03 23:43:30 -05:00
# define SERIAL_ERROR_START serialprintPGM(errormagic)
2011-11-09 13:27:15 -06:00
# define SERIAL_ERROR(x) SERIAL_PROTOCOL(x)
# define SERIAL_ERRORPGM(x) SERIAL_PROTOCOLPGM(x)
# define SERIAL_ERRORLN(x) SERIAL_PROTOCOLLN(x)
# define SERIAL_ERRORLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
2015-04-03 23:43:30 -05:00
# define SERIAL_ECHO_START serialprintPGM(echomagic)
2011-11-09 13:27:15 -06:00
# define SERIAL_ECHO(x) SERIAL_PROTOCOL(x)
# define SERIAL_ECHOPGM(x) SERIAL_PROTOCOLPGM(x)
# define SERIAL_ECHOLN(x) SERIAL_PROTOCOLLN(x)
# define SERIAL_ECHOLNPGM(x) SERIAL_PROTOCOLLNPGM(x)
2015-04-03 23:43:30 -05:00
# define SERIAL_ECHOPAIR(name,value) do{ serial_echopair_P(PSTR(name),(value)); }while(0)
2015-01-28 23:19:51 -06:00
2015-10-03 01:08:58 -05:00
void serial_echopair_P ( const char * s_P , int v ) ;
void serial_echopair_P ( const char * s_P , long v ) ;
void serial_echopair_P ( const char * s_P , float v ) ;
void serial_echopair_P ( const char * s_P , double v ) ;
void serial_echopair_P ( const char * s_P , unsigned long v ) ;
2011-11-09 15:09:16 -06:00
2015-04-03 22:45:24 -05:00
// Things to write to serial from Program memory. Saves 400 to 2k of RAM.
2015-10-03 01:08:58 -05:00
FORCE_INLINE void serialprintPGM ( const char * str ) {
2015-04-03 23:58:48 -05:00
char ch ;
while ( ( ch = pgm_read_byte ( str ) ) ) {
2012-02-11 09:02:47 -06:00
MYSERIAL . write ( ch ) ;
2015-04-03 23:58:48 -05:00
str + + ;
2011-11-09 13:27:15 -06:00
}
}
2011-08-12 15:28:35 -05:00
void get_command ( ) ;
2015-05-26 22:08:21 -05:00
void idle ( ) ; // the standard idle routine calls manage_inactivity(false)
2015-10-03 01:08:58 -05:00
void manage_inactivity ( bool ignore_stepper_queue = false ) ;
2011-08-12 15:28:35 -05:00
2015-07-31 00:24:43 -05:00
# if ENABLED(DUAL_X_CARRIAGE) && HAS_X_ENABLE && HAS_X2_ENABLE
2015-02-23 09:12:35 -06:00
# define enable_x() do { X_ENABLE_WRITE( X_ENABLE_ON); X2_ENABLE_WRITE( X_ENABLE_ON); } while (0)
# define disable_x() do { X_ENABLE_WRITE(!X_ENABLE_ON); X2_ENABLE_WRITE(!X_ENABLE_ON); axis_known_position[X_AXIS] = false; } while (0)
2015-04-03 17:31:35 -05:00
# elif HAS_X_ENABLE
2015-02-23 09:12:35 -06:00
# define enable_x() X_ENABLE_WRITE( X_ENABLE_ON)
# define disable_x() { X_ENABLE_WRITE(!X_ENABLE_ON); axis_known_position[X_AXIS] = false; }
2011-08-12 15:28:35 -05:00
# else
2011-11-06 12:23:08 -06:00
# define enable_x() ;
# define disable_x() ;
2011-08-12 15:28:35 -05:00
# endif
2011-11-06 12:23:08 -06:00
2015-04-03 17:31:35 -05:00
# if HAS_Y_ENABLE
2015-07-31 00:24:43 -05:00
# if ENABLED(Y_DUAL_STEPPER_DRIVERS)
2015-02-23 09:12:35 -06:00
# define enable_y() { Y_ENABLE_WRITE( Y_ENABLE_ON); Y2_ENABLE_WRITE(Y_ENABLE_ON); }
# define disable_y() { Y_ENABLE_WRITE(!Y_ENABLE_ON); Y2_ENABLE_WRITE(!Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
2013-09-17 13:19:20 -05:00
# else
2015-02-23 09:12:35 -06:00
# define enable_y() Y_ENABLE_WRITE( Y_ENABLE_ON)
# define disable_y() { Y_ENABLE_WRITE(!Y_ENABLE_ON); axis_known_position[Y_AXIS] = false; }
2013-09-17 13:19:20 -05:00
# endif
2011-08-12 15:28:35 -05:00
# else
2011-11-06 12:23:08 -06:00
# define enable_y() ;
# define disable_y() ;
2011-08-12 15:28:35 -05:00
# endif
2011-11-06 12:23:08 -06:00
2015-04-03 17:31:35 -05:00
# if HAS_Z_ENABLE
2015-07-31 00:24:43 -05:00
# if ENABLED(Z_DUAL_STEPPER_DRIVERS)
2015-02-23 09:12:35 -06:00
# define enable_z() { Z_ENABLE_WRITE( Z_ENABLE_ON); Z2_ENABLE_WRITE(Z_ENABLE_ON); }
# define disable_z() { Z_ENABLE_WRITE(!Z_ENABLE_ON); Z2_ENABLE_WRITE(!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
2012-08-04 01:32:26 -05:00
# else
2015-02-23 09:12:35 -06:00
# define enable_z() Z_ENABLE_WRITE( Z_ENABLE_ON)
# define disable_z() { Z_ENABLE_WRITE(!Z_ENABLE_ON); axis_known_position[Z_AXIS] = false; }
2012-08-04 01:32:26 -05:00
# endif
2011-08-12 15:28:35 -05:00
# else
2011-11-06 12:23:08 -06:00
# define enable_z() ;
# define disable_z() ;
2011-08-12 15:28:35 -05:00
# endif
2011-11-04 12:02:56 -05:00
2015-04-03 17:31:35 -05:00
# if HAS_E0_ENABLE
2015-04-03 22:45:24 -05:00
# define enable_e0() E0_ENABLE_WRITE( E_ENABLE_ON)
2015-02-23 09:12:35 -06:00
# define disable_e0() E0_ENABLE_WRITE(!E_ENABLE_ON)
2011-08-12 15:28:35 -05:00
# else
2011-12-05 22:33:33 -06:00
# define enable_e0() /* nothing */
# define disable_e0() /* nothing */
2011-08-12 15:28:35 -05:00
# endif
2015-04-03 17:31:35 -05:00
# if (EXTRUDERS > 1) && HAS_E1_ENABLE
2015-04-03 22:45:24 -05:00
# define enable_e1() E1_ENABLE_WRITE( E_ENABLE_ON)
2015-02-23 09:12:35 -06:00
# define disable_e1() E1_ENABLE_WRITE(!E_ENABLE_ON)
2011-12-05 22:33:33 -06:00
# else
# define enable_e1() /* nothing */
# define disable_e1() /* nothing */
# endif
2015-04-03 17:31:35 -05:00
# if (EXTRUDERS > 2) && HAS_E2_ENABLE
2015-04-03 22:45:24 -05:00
# define enable_e2() E2_ENABLE_WRITE( E_ENABLE_ON)
2015-02-23 09:12:35 -06:00
# define disable_e2() E2_ENABLE_WRITE(!E_ENABLE_ON)
2011-12-05 22:33:33 -06:00
# else
# define enable_e2() /* nothing */
# define disable_e2() /* nothing */
# endif
2015-04-03 17:31:35 -05:00
# if (EXTRUDERS > 3) && HAS_E3_ENABLE
2015-04-03 22:45:24 -05:00
# define enable_e3() E3_ENABLE_WRITE( E_ENABLE_ON)
2015-02-23 09:12:35 -06:00
# define disable_e3() E3_ENABLE_WRITE(!E_ENABLE_ON)
2015-01-23 16:13:06 -06:00
# else
# define enable_e3() /* nothing */
# define disable_e3() /* nothing */
# endif
2011-12-05 22:33:33 -06:00
2015-04-03 22:45:24 -05:00
/**
* The axis order in all axis related arrays is X , Y , Z , E
*/
# define NUM_AXIS 4
/**
* Axis indices as enumerated constants
*
* A_AXIS and B_AXIS are used by COREXY printers
* 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 .
*/
2015-10-03 01:08:58 -05:00
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 } ;
2011-08-12 15:28:35 -05:00
2015-10-03 01:08:58 -05:00
enum EndstopEnum { X_MIN = 0 , Y_MIN = 1 , Z_MIN = 2 , Z_MIN_PROBE = 3 , X_MAX = 4 , Y_MAX = 5 , Z_MAX = 6 , Z2_MIN = 7 , Z2_MAX = 8 } ;
2015-05-10 14:37:39 -05:00
2015-04-03 21:25:22 -05:00
void enable_all_steppers ( ) ;
void disable_all_steppers ( ) ;
2011-08-12 15:28:35 -05:00
void FlushSerialRequestResend ( ) ;
2015-05-12 04:08:20 -05:00
void ok_to_send ( ) ;
2011-08-12 15:28:35 -05:00
2015-03-07 12:36:21 -06:00
void reset_bed_level ( ) ;
2011-08-12 15:28:35 -05:00
void prepare_move ( ) ;
2015-10-03 01:08:58 -05:00
void kill ( const char * ) ;
2012-03-25 07:36:51 -05:00
void Stop ( ) ;
2015-07-31 00:24:43 -05:00
# if ENABLED(FILAMENT_RUNOUT_SENSOR)
2015-03-20 04:50:28 -05:00
void filrunout ( ) ;
2015-03-07 14:43:15 -06:00
# endif
2015-04-26 22:08:45 -05:00
/**
* Debug flags - not yet widely applied
*/
enum DebugFlags {
DEBUG_ECHO = BIT ( 0 ) ,
DEBUG_INFO = BIT ( 1 ) ,
DEBUG_ERRORS = BIT ( 2 ) ,
DEBUG_DRYRUN = BIT ( 3 ) ,
2015-08-05 06:40:36 -05:00
DEBUG_COMMUNICATION = BIT ( 4 ) ,
DEBUG_LEVELING = BIT ( 5 )
2015-04-26 22:08:45 -05:00
} ;
extern uint8_t marlin_debug_flags ;
2015-04-08 02:56:19 -05:00
extern bool Running ;
inline bool IsRunning ( ) { return Running ; }
inline bool IsStopped ( ) { return ! Running ; }
2011-08-12 15:28:35 -05:00
2015-10-03 01:08:58 -05:00
bool enqueuecommand ( const char * cmd ) ; //put a single ASCII command at the end of the current buffer or return false when it is full
void enqueuecommands_P ( const char * cmd ) ; //put one or many ASCII commands at the end of the current buffer, read from flash
2015-02-07 16:24:20 -06:00
2011-11-15 13:54:40 -06:00
void prepare_arc_move ( char isclockwise ) ;
2012-08-09 12:15:32 -05:00
void clamp_to_software_endstops ( float target [ 3 ] ) ;
2011-11-04 12:02:56 -05:00
2015-04-12 20:07:08 -05:00
extern millis_t previous_cmd_ms ;
inline void refresh_cmd_timeout ( ) { previous_cmd_ms = millis ( ) ; }
2014-02-03 04:30:12 -06:00
2015-07-31 00:24:43 -05:00
# if ENABLED(FAST_PWM_FAN)
2015-03-20 04:50:28 -05:00
void setPwmFrequency ( uint8_t pin , int val ) ;
2012-05-02 12:26:14 -05:00
# endif
2011-11-04 12:02:56 -05:00
# ifndef CRITICAL_SECTION_START
2011-11-06 12:23:08 -06:00
# define CRITICAL_SECTION_START unsigned char _sreg = SREG; cli();
# define CRITICAL_SECTION_END SREG = _sreg;
2015-04-03 22:45:24 -05:00
# endif
2011-08-12 15:28:35 -05:00
2011-11-04 12:02:56 -05:00
extern bool axis_relative_modes [ ] ;
2015-04-13 19:17:36 -05:00
extern int feedrate_multiplier ;
2014-12-28 19:43:14 -06:00
extern bool volumetric_enabled ;
2015-06-01 15:33:22 -05:00
extern int extruder_multiplier [ EXTRUDERS ] ; // sets extrude multiply factor (in percent) for each extruder individually
2014-12-28 19:43:14 -06:00
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.
2014-01-31 10:43:11 -06:00
extern float volumetric_multiplier [ EXTRUDERS ] ; // reciprocal of cross-sectional area of filament (in square millimeters), stored this way to reduce computational burden in planner
2015-04-03 22:45:24 -05:00
extern float current_position [ NUM_AXIS ] ;
2015-07-14 21:49:43 -05:00
extern float home_offset [ 3 ] ; // axis[n].home_offset
extern float min_pos [ 3 ] ; // axis[n].min_pos
extern float max_pos [ 3 ] ; // axis[n].max_pos
extern bool axis_known_position [ 3 ] ; // axis[n].is_known
2015-04-03 22:45:24 -05:00
2015-09-03 00:38:47 -05:00
# if ENABLED(DELTA)
extern float delta [ 3 ] ;
extern float endstop_adj [ 3 ] ; // axis[n].endstop_adj
extern float delta_radius ;
# ifndef DELTA_RADIUS_TRIM_TOWER_1
# define DELTA_RADIUS_TRIM_TOWER_1 0.0
# endif
# ifndef DELTA_RADIUS_TRIM_TOWER_2
# define DELTA_RADIUS_TRIM_TOWER_2 0.0
# endif
# ifndef DELTA_RADIUS_TRIM_TOWER_3
# define DELTA_RADIUS_TRIM_TOWER_3 0.0
# endif
extern float delta_diagonal_rod ;
# ifndef DELTA_DIAGONAL_ROD_TRIM_TOWER_1
# define DELTA_DIAGONAL_ROD_TRIM_TOWER_1 0.0
# endif
# ifndef DELTA_DIAGONAL_ROD_TRIM_TOWER_2
# define DELTA_DIAGONAL_ROD_TRIM_TOWER_2 0.0
# endif
# ifndef DELTA_DIAGONAL_ROD_TRIM_TOWER_3
# define DELTA_DIAGONAL_ROD_TRIM_TOWER_3 0.0
# endif
extern float delta_segments_per_second ;
2015-07-14 21:49:43 -05:00
void calculate_delta ( float cartesian [ 3 ] ) ;
2015-09-03 00:38:47 -05:00
void recalc_delta_settings ( float radius , float diagonal_rod ) ;
# if ENABLED(AUTO_BED_LEVELING_FEATURE)
extern int delta_grid_spacing [ 2 ] ;
void adjust_delta ( float cartesian [ 3 ] ) ;
2015-07-14 21:49:43 -05:00
# endif
2015-09-03 00:38:47 -05:00
# elif ENABLED(SCARA)
extern float axis_scaling [ 3 ] ; // Build size scaling
void calculate_delta ( float cartesian [ 3 ] ) ;
void calculate_SCARA_forward_Transform ( float f_scara [ 3 ] ) ;
2014-06-23 10:09:57 -05:00
# endif
2015-04-03 22:45:24 -05:00
2015-07-31 00:24:43 -05:00
# if ENABLED(Z_DUAL_ENDSTOPS)
2015-07-14 21:49:43 -05:00
extern float z_endstop_adj ;
# endif
2015-04-03 22:45:24 -05:00
2015-08-05 07:12:26 -05:00
# if ENABLED(AUTO_BED_LEVELING_FEATURE)
2015-03-25 23:14:00 -05:00
extern float zprobe_zoffset ;
# endif
2015-04-03 22:45:24 -05:00
2015-07-31 00:24:43 -05:00
# if ENABLED(PREVENT_DANGEROUS_EXTRUDE)
2015-04-09 03:40:48 -05:00
extern float extrude_min_temp ;
# endif
2012-12-03 05:13:20 -06:00
extern int fanSpeed ;
2015-04-03 22:45:24 -05:00
2015-07-31 00:24:43 -05:00
# if ENABLED(BARICUDA)
2015-03-20 04:50:28 -05:00
extern int ValvePressure ;
extern int EtoPPressure ;
2013-05-14 16:56:32 -05:00
# endif
2012-12-03 05:13:20 -06:00
2015-07-31 00:24:43 -05:00
# if ENABLED(FAN_SOFT_PWM)
2015-03-20 04:50:28 -05:00
extern unsigned char fanSpeedSoftPwm ;
2013-06-09 05:52:49 -05:00
# endif
2015-07-31 00:24:43 -05:00
# if ENABLED(FILAMENT_SENSOR)
2016-03-05 22:41:15 -06:00
extern float filament_width_nominal ; //holds the theoretical filament diameter i.e., 3.00 or 1.75
2015-01-02 10:11:18 -06:00
extern bool filament_sensor ; //indicates that filament sensor readings should control extrusion
extern float filament_width_meas ; //holds the filament diameter as accurately measured
2014-08-06 19:30:57 -05:00
extern signed char measurement_delay [ ] ; //ring buffer to delay measurement
2015-03-20 22:42:49 -05:00
extern int delay_index1 , delay_index2 ; //ring buffer index. used by planner, temperature, and main code
2014-08-06 19:30:57 -05:00
extern float delay_dist ; //delay distance counter
extern int meas_delay_cm ; //delay distance
# endif
2015-08-30 21:04:30 -05:00
# if ENABLED(PID_ADD_EXTRUSION_RATE)
extern int lpq_len ;
# endif
2015-07-31 00:24:43 -05:00
# if ENABLED(FWRETRACT)
2015-03-20 04:50:28 -05:00
extern bool autoretract_enabled ;
2015-07-14 21:49:43 -05:00
extern bool retracted [ EXTRUDERS ] ; // extruder[n].retracted
2015-03-20 04:50:28 -05:00
extern float retract_length , retract_length_swap , retract_feedrate , retract_zlift ;
extern float retract_recover_length , retract_recover_length_swap , retract_recover_feedrate ;
2012-12-03 05:13:20 -06:00
# endif
2011-11-04 12:02:56 -05:00
2015-04-13 19:17:36 -05:00
extern millis_t print_job_start_ms ;
extern millis_t print_job_stop_ms ;
2012-11-06 05:06:41 -06:00
2011-12-05 22:33:33 -06:00
// Handling multiple extruders pins
extern uint8_t active_extruder ;
2015-07-31 00:24:43 -05:00
# if ENABLED(DIGIPOT_I2C)
2015-10-03 01:08:58 -05:00
extern void digipot_i2c_set_current ( int channel , float current ) ;
2015-03-20 04:50:28 -05:00
extern void digipot_i2c_init ( ) ;
2011-11-04 12:02:56 -05:00
# endif
2014-12-28 19:43:14 -06:00
2015-11-09 17:02:11 -06:00
# if HAS_TEMP_0 || HAS_TEMP_BED || ENABLED(HEATER_0_USES_MAX6675)
void print_heaterstates ( ) ;
# endif
2015-01-02 10:11:18 -06:00
extern void calculate_volumetric_multipliers ( ) ;
2015-03-20 04:50:28 -05:00
# endif //MARLIN_H