157 lines
5.9 KiB
C
157 lines
5.9 KiB
C
/**
|
|
* Marlin 3D Printer Firmware
|
|
* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
|
*
|
|
* Based on Sprinter and grbl.
|
|
* Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
|
|
*
|
|
* 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/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef __SERIAL_H__
|
|
#define __SERIAL_H__
|
|
|
|
#include "../inc/MarlinConfig.h"
|
|
|
|
#if HAS_ABL && ENABLED(DEBUG_LEVELING_FEATURE)
|
|
#include "../libs/vector_3.h"
|
|
#endif
|
|
|
|
/**
|
|
* Define debug bit-masks
|
|
*/
|
|
enum DebugFlags {
|
|
DEBUG_NONE = 0,
|
|
DEBUG_ECHO = _BV(0), ///< Echo commands in order as they are processed
|
|
DEBUG_INFO = _BV(1), ///< Print messages for code that has debug output
|
|
DEBUG_ERRORS = _BV(2), ///< Not implemented
|
|
DEBUG_DRYRUN = _BV(3), ///< Ignore temperature setting and E movement commands
|
|
DEBUG_COMMUNICATION = _BV(4), ///< Not implemented
|
|
DEBUG_LEVELING = _BV(5), ///< Print detailed output for homing and leveling
|
|
DEBUG_MESH_ADJUST = _BV(6), ///< UBL bed leveling
|
|
DEBUG_ALL = 0xFF
|
|
};
|
|
|
|
#if ENABLED(EMERGENCY_PARSER)
|
|
enum e_parser_state {
|
|
state_RESET,
|
|
state_N,
|
|
state_M,
|
|
state_M1,
|
|
state_M10,
|
|
state_M108,
|
|
state_M11,
|
|
state_M112,
|
|
state_M4,
|
|
state_M41,
|
|
state_M410,
|
|
state_IGNORE // to '\n'
|
|
};
|
|
#endif
|
|
|
|
//todo: HAL: breaks encapsulation
|
|
// For AVR only, define a serial interface based on configuration
|
|
#ifdef __AVR__
|
|
#ifdef USBCON
|
|
#include <HardwareSerial.h>
|
|
#if ENABLED(BLUETOOTH)
|
|
#define MYSERIAL bluetoothSerial
|
|
#else
|
|
#define MYSERIAL Serial
|
|
#endif // BLUETOOTH
|
|
#else
|
|
#include "../HAL/HAL_AVR/MarlinSerial.h"
|
|
#define MYSERIAL customizedSerial
|
|
#endif
|
|
#endif
|
|
|
|
#ifdef ARDUINO_ARCH_SAM
|
|
// To pull the Serial port definitions and overrides
|
|
#include "../HAL/HAL_DUE/MarlinSerial_Due.h"
|
|
#endif
|
|
|
|
extern uint8_t marlin_debug_flags;
|
|
#define DEBUGGING(F) (marlin_debug_flags & (DEBUG_## F))
|
|
|
|
extern const char echomagic[] PROGMEM;
|
|
extern const char errormagic[] PROGMEM;
|
|
|
|
#define SERIAL_CHAR(x) ((void)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)))
|
|
#define SERIAL_PROTOCOLLN(x) do{ MYSERIAL.print(x); SERIAL_EOL(); }while(0)
|
|
#define SERIAL_PROTOCOLLNPGM(x) (serialprintPGM(PSTR(x "\n")))
|
|
#define SERIAL_PROTOCOLPAIR(pre, value) (serial_echopair_P(PSTR(pre),(value)))
|
|
#define SERIAL_PROTOCOLLNPAIR(pre, value) do{ SERIAL_PROTOCOLPAIR(pre, value); SERIAL_EOL(); }while(0)
|
|
|
|
#define SERIAL_ECHO_START() (serialprintPGM(echomagic))
|
|
#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)
|
|
#define SERIAL_ECHOPAIR(pre,value) SERIAL_PROTOCOLPAIR(pre, value)
|
|
#define SERIAL_ECHOLNPAIR(pre, value) SERIAL_PROTOCOLLNPAIR(pre, value)
|
|
#define SERIAL_ECHO_F(x,y) SERIAL_PROTOCOL_F(x,y)
|
|
|
|
#define SERIAL_ERROR_START() (serialprintPGM(errormagic))
|
|
#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)
|
|
|
|
// These macros compensate for float imprecision
|
|
#define SERIAL_PROTOCOLPAIR_F(pre, value) SERIAL_PROTOCOLPAIR(pre, FIXFLOAT(value))
|
|
#define SERIAL_PROTOCOLLNPAIR_F(pre, value) SERIAL_PROTOCOLLNPAIR(pre, FIXFLOAT(value))
|
|
#define SERIAL_ECHOPAIR_F(pre,value) SERIAL_ECHOPAIR(pre, FIXFLOAT(value))
|
|
#define SERIAL_ECHOLNPAIR_F(pre, value) SERIAL_ECHOLNPAIR(pre, FIXFLOAT(value))
|
|
|
|
void serial_echopair_P(const char* s_P, const char *v);
|
|
void serial_echopair_P(const char* s_P, char v);
|
|
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 int v);
|
|
void serial_echopair_P(const char* s_P, unsigned long v);
|
|
FORCE_INLINE void serial_echopair_P(const char* s_P, uint8_t v) { serial_echopair_P(s_P, (int)v); }
|
|
FORCE_INLINE void serial_echopair_P(const char* s_P, bool v) { serial_echopair_P(s_P, (int)v); }
|
|
FORCE_INLINE void serial_echopair_P(const char* s_P, void *v) { serial_echopair_P(s_P, (unsigned long)v); }
|
|
|
|
void serial_spaces(uint8_t count);
|
|
#define SERIAL_ECHO_SP(C) serial_spaces(C)
|
|
#define SERIAL_ERROR_SP(C) serial_spaces(C)
|
|
#define SERIAL_PROTOCOL_SP(C) serial_spaces(C)
|
|
|
|
//
|
|
// Functions for serial printing from PROGMEM. (Saves loads of SRAM.)
|
|
//
|
|
void serialprintPGM(const char* str);
|
|
|
|
#if ENABLED(DEBUG_LEVELING_FEATURE)
|
|
void print_xyz(const char* prefix, const char* suffix, const float x, const float y, const float z);
|
|
void print_xyz(const char* prefix, const char* suffix, const float xyz[]);
|
|
#if HAS_ABL
|
|
void print_xyz(const char* prefix, const char* suffix, const vector_3 &xyz);
|
|
#endif
|
|
#define DEBUG_POS(SUFFIX,VAR) do { \
|
|
print_xyz(PSTR(" " STRINGIFY(VAR) "="), PSTR(" : " SUFFIX "\n"), VAR); }while(0)
|
|
#endif
|
|
|
|
#endif // __SERIAL_H__
|