Firmware2/Marlin/src/MarlinCore.h

128 lines
3.8 KiB
C
Raw Normal View History

/**
2016-03-24 19:01:20 +01:00
* Marlin 3D Printer Firmware
2020-02-03 15:00:57 +01:00
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
2016-03-24 19:01:20 +01:00
*
* Based on Sprinter and grbl.
2019-06-28 06:57:50 +02:00
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
2016-03-24 19:01:20 +01:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#pragma once
2017-09-06 13:28:33 +02:00
#include "inc/MarlinConfig.h"
#ifdef DEBUG_GCODE_PARSER
2017-09-06 13:28:33 +02:00
#include "gcode/parser.h"
#endif
2017-11-19 20:59:40 +01:00
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
2017-09-06 13:28:33 +02:00
void stop();
2020-04-02 08:22:48 +02:00
// Pass true to keep steppers from timing out
void idle(TERN_(ADVANCED_PAUSE_FEATURE, bool no_stepper_sleep=false));
inline void idle_no_sleep() { idle(TERN_(ADVANCED_PAUSE_FEATURE, true)); }
2020-02-27 13:34:48 +01:00
2017-09-17 09:49:13 +02:00
#if ENABLED(EXPERIMENTAL_I2CBUS)
#include "feature/twibus.h"
extern TWIBus i2c;
#endif
2016-09-29 22:06:01 +02:00
#if ENABLED(G38_PROBE_TARGET)
2019-03-10 23:22:09 +01:00
extern uint8_t G38_move; // Flag to tell the ISR that G38 is in progress, and the type
extern bool G38_did_trigger; // Flag from the ISR to indicate the endstop changed
#endif
/**
* The axis order in all axis related arrays is X, Y, Z, E
*/
void enable_e_steppers();
void enable_all_steppers();
void disable_e_stepper(const uint8_t e);
2017-03-18 03:12:19 +01:00
void disable_e_steppers();
void disable_all_steppers();
2019-10-10 02:46:10 +02:00
void kill(PGM_P const lcd_error=nullptr, PGM_P const lcd_component=nullptr, const bool steppers_off=false);
void minkill(const bool steppers_off=false);
void quickstop_stepper();
2016-06-03 02:11:54 +02:00
2020-03-15 00:47:44 +01:00
// Global State of the firmware
enum MarlinState : uint8_t {
MF_INITIALIZING = 0,
MF_RUNNING = _BV(0),
MF_PAUSED = _BV(1),
MF_WAITING = _BV(2),
MF_STOPPED = _BV(3),
MF_SD_COMPLETE = _BV(4),
2020-03-15 00:47:44 +01:00
MF_KILLED = _BV(7)
};
extern MarlinState marlin_state;
inline bool IsRunning() { return marlin_state == MF_RUNNING; }
inline bool IsStopped() { return marlin_state != MF_RUNNING; }
2011-08-12 22:28:35 +02:00
2019-10-03 01:54:20 +02:00
bool printingIsActive();
bool printingIsPaused();
void startOrResumeJob();
2019-10-03 01:54:20 +02:00
2019-03-10 15:13:54 +01:00
extern bool wait_for_heatup;
#if HAS_RESUME_CONTINUE
extern bool wait_for_user;
void wait_for_user_response(millis_t ms=0, const bool no_sleep=false);
2016-09-12 03:51:53 +02:00
#endif
2017-09-17 06:57:09 +02:00
// Inactivity shutdown timer
extern millis_t max_inactive_time, stepper_inactive_time;
2019-10-22 22:43:37 +02:00
#if ENABLED(PSU_CONTROL)
extern bool powersupply_on;
#define PSU_PIN_ON() do{ OUT_WRITE(PS_ON_PIN, PSU_ACTIVE_HIGH); powersupply_on = true; }while(0)
#define PSU_PIN_OFF() do{ OUT_WRITE(PS_ON_PIN, !PSU_ACTIVE_HIGH); powersupply_on = false; }while(0)
#if ENABLED(AUTO_POWER_CONTROL)
#define PSU_ON() powerManager.power_on()
#define PSU_OFF() powerManager.power_off()
#else
#define PSU_ON() PSU_PIN_ON()
#define PSU_OFF() PSU_PIN_OFF()
#endif
#endif
bool pin_is_protected(const pin_t pin);
2018-06-11 00:45:39 +02:00
void protected_pin_err();
2017-09-16 10:42:05 +02:00
#if HAS_SUICIDE
2019-10-24 21:07:28 +02:00
inline void suicide() { OUT_WRITE(SUICIDE_PIN, SUICIDE_PIN_INVERTING); }
#endif
2019-01-28 05:43:13 +01:00
#if HAS_KILL
#ifndef KILL_PIN_STATE
#define KILL_PIN_STATE LOW
#endif
inline bool kill_state() { return READ(KILL_PIN) == KILL_PIN_STATE; }
#endif
2019-02-12 22:55:47 +01:00
#if ENABLED(G29_RETRY_AND_RECOVER)
void event_probe_recover();
void event_probe_failure();
2019-01-28 05:43:13 +01:00
#endif
2019-11-02 05:51:25 +01:00
2020-01-20 02:00:17 +01:00
extern const char NUL_STR[], M112_KILL_STR[], G28_STR[], M21_STR[], M23_STR[], M24_STR[],
2020-03-01 14:36:25 +01:00
SP_P_STR[], SP_T_STR[], SP_X_STR[], SP_Y_STR[], SP_Z_STR[], SP_E_STR[],
X_LBL[], Y_LBL[], Z_LBL[], E_LBL[], SP_X_LBL[], SP_Y_LBL[], SP_Z_LBL[], SP_E_LBL[];