1
0
mirror of https://github.com/MarlinFirmware/Marlin.git synced 2024-12-15 06:51:40 +00:00
MarlinFirmware/Marlin/src/module/stepper/trinamic.cpp

926 lines
24 KiB
C++
Raw Normal View History

/**
2016-03-24 18:01:20 +00:00
* Marlin 3D Printer Firmware
2020-02-03 14:00:57 +00:00
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
2016-03-24 18:01:20 +00:00
*
* Based on Sprinter and grbl.
2019-06-28 04:57:50 +00:00
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
2016-03-24 18:01:20 +00: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/>.
*
*/
/**
2019-09-01 00:44:45 +00:00
* stepper/trinamic.cpp
* Stepper driver indirection for Trinamic
*/
2015-02-26 11:57:46 +00:00
2019-09-01 00:44:45 +00:00
#include "../../inc/MarlinConfig.h"
2018-01-21 23:13:56 +00:00
2019-09-01 00:44:45 +00:00
#if HAS_TRINAMIC
2015-02-26 11:57:46 +00:00
2019-09-01 00:44:45 +00:00
#include "trinamic.h"
#include "../stepper.h"
2019-09-01 00:44:45 +00:00
#include <HardwareSerial.h>
#include <SPI.h>
2019-09-01 00:44:45 +00:00
enum StealthIndex : uint8_t { STEALTH_AXIS_XY, STEALTH_AXIS_Z, STEALTH_AXIS_E };
#define _TMC_INIT_1(ST, STEALTH_INDEX) tmc_init(stepper##ST, ST##_CURRENT, ST##_MICROSTEPS)
#define _TMC_INIT_2(ST, STEALTH_INDEX) tmc_init(stepper##ST, ST##_CURRENT, ST##_MICROSTEPS, stealthchop_by_axis[STEALTH_INDEX], ST##_HYBRID_THRESHOLD)
#define _TMC_INIT_3(ST, STEALTH_INDEX) tmc_init(stepper##ST, ST##_CURRENT, ST##_MICROSTEPS, stealthchop_by_axis[STEALTH_INDEX], ST##_HYBRID_THRESHOLD, ST##_COOLSTEP_SPEED_THRESHOLD, ST##_COOLSTEP_LOWER_LOAD_THRESHOLD, ST##_COOLSTEP_UPPER_LOAD_THRESHOLD, ST##_COOLSTEP_SEUP, ST##_COOLSTEP_SEDN, ST##_COOLSTEP_SEIMIN)
#define _TMC_INIT_TMC2660(ST, STEALTH_INDEX) _TMC_INIT_1(ST, STEALTH_INDEX)
#define _TMC_INIT_TMC2160(ST, STEALTH_INDEX) _TMC_INIT_2(ST, STEALTH_INDEX)
#define _TMC_INIT_TMC2208(ST, STEALTH_INDEX) _TMC_INIT_2(ST, STEALTH_INDEX)
#define _TMC_INIT_TMC5130(ST, STEALTH_INDEX) _TMC_INIT_3(ST, STEALTH_INDEX)
#define _TMC_INIT_TMC5160(ST, STEALTH_INDEX) _TMC_INIT_3(ST, STEALTH_INDEX)
#define _TMC_INIT_TMC2130(ST, STEALTH_INDEX) _TMC_INIT_3(ST, STEALTH_INDEX)
#define _TMC_INIT_TMC2209(ST, STEALTH_INDEX) _TMC_INIT_3(ST, STEALTH_INDEX)
#define __TMC_INIT(DRV, ST, STEALTH_INDEX) _TMC_INIT_##DRV(ST, STEALTH_INDEX)
#define _TMC_INIT(DRV, ST, STEALTH_INDEX) __TMC_INIT(DRV, ST, STEALTH_INDEX)
#define TMC_INIT(ST, STEALTH_INDEX) _TMC_INIT(ST##_DRIVER_TYPE, ST, STEALTH_INDEX)
2019-09-01 00:44:45 +00:00
// IC = TMC model number
// ST = Stepper object letter
// L = Label characters
// AI = Axis Enum Index
// SWHW = SW/SH UART selection
#if ENABLED(TMC_USE_SW_SPI)
#define __TMC_SPI_DEFINE(IC, ST, L, AI) TMCMarlin<IC##Stepper, L, AI> stepper##ST(ST##_CS_PIN, ST##_RSENSE, TMC_SW_MOSI, TMC_SW_MISO, TMC_SW_SCK, ST##_CHAIN_POS)
2019-09-01 00:44:45 +00:00
#else
#define __TMC_SPI_DEFINE(IC, ST, L, AI) TMCMarlin<IC##Stepper, L, AI> stepper##ST(ST##_CS_PIN, ST##_RSENSE, ST##_CHAIN_POS)
2019-09-01 00:44:45 +00:00
#endif
2019-09-01 00:44:45 +00:00
#define TMC_UART_HW_DEFINE(IC, ST, L, AI) TMCMarlin<IC##Stepper, L, AI> stepper##ST(&ST##_HARDWARE_SERIAL, ST##_RSENSE, ST##_SLAVE_ADDRESS)
#define TMC_UART_SW_DEFINE(IC, ST, L, AI) TMCMarlin<IC##Stepper, L, AI> stepper##ST(ST##_SERIAL_RX_PIN, ST##_SERIAL_TX_PIN, ST##_RSENSE, ST##_SLAVE_ADDRESS, ST##_SERIAL_RX_PIN > -1)
2019-09-01 00:44:45 +00:00
#define _TMC_SPI_DEFINE(IC, ST, AI) __TMC_SPI_DEFINE(IC, ST, TMC_##ST##_LABEL, AI)
#define TMC_SPI_DEFINE(ST, AI) _TMC_SPI_DEFINE(ST##_DRIVER_TYPE, ST, AI##_AXIS)
2019-09-01 00:44:45 +00:00
#define _TMC_UART_DEFINE(SWHW, IC, ST, AI) TMC_UART_##SWHW##_DEFINE(IC, ST, TMC_##ST##_LABEL, AI)
#define TMC_UART_DEFINE(SWHW, ST, AI) _TMC_UART_DEFINE(SWHW, ST##_DRIVER_TYPE, ST, AI##_AXIS)
2019-09-01 00:44:45 +00:00
#if ENABLED(DISTINCT_E_FACTORS) && E_STEPPERS > 1
#define TMC_SPI_DEFINE_E(AI) TMC_SPI_DEFINE(E##AI, E##AI)
#define TMC_UART_DEFINE_E(SWHW, AI) TMC_UART_DEFINE(SWHW, E##AI, E##AI)
#else
#define TMC_SPI_DEFINE_E(AI) TMC_SPI_DEFINE(E##AI, E)
#define TMC_UART_DEFINE_E(SWHW, AI) TMC_UART_DEFINE(SWHW, E##AI, E)
#endif
2019-09-01 00:44:45 +00:00
// Stepper objects of TMC2130/TMC2160/TMC2660/TMC5130/TMC5160 steppers used
#if AXIS_HAS_SPI(X)
TMC_SPI_DEFINE(X, X);
#endif
#if AXIS_HAS_SPI(X2)
TMC_SPI_DEFINE(X2, X);
#endif
#if AXIS_HAS_SPI(Y)
TMC_SPI_DEFINE(Y, Y);
#endif
#if AXIS_HAS_SPI(Y2)
TMC_SPI_DEFINE(Y2, Y);
#endif
#if AXIS_HAS_SPI(Z)
TMC_SPI_DEFINE(Z, Z);
#endif
#if AXIS_HAS_SPI(Z2)
TMC_SPI_DEFINE(Z2, Z);
#endif
#if AXIS_HAS_SPI(Z3)
TMC_SPI_DEFINE(Z3, Z);
#endif
2020-01-20 05:35:07 +00:00
#if AXIS_HAS_SPI(Z4)
TMC_SPI_DEFINE(Z4, Z);
#endif
2019-09-01 00:44:45 +00:00
#if AXIS_HAS_SPI(E0)
TMC_SPI_DEFINE_E(0);
#endif
#if AXIS_HAS_SPI(E1)
TMC_SPI_DEFINE_E(1);
#endif
#if AXIS_HAS_SPI(E2)
TMC_SPI_DEFINE_E(2);
#endif
#if AXIS_HAS_SPI(E3)
TMC_SPI_DEFINE_E(3);
#endif
#if AXIS_HAS_SPI(E4)
TMC_SPI_DEFINE_E(4);
#endif
#if AXIS_HAS_SPI(E5)
TMC_SPI_DEFINE_E(5);
#endif
2020-02-04 18:37:20 +00:00
#if AXIS_HAS_SPI(E6)
TMC_SPI_DEFINE_E(6);
#endif
#if AXIS_HAS_SPI(E7)
TMC_SPI_DEFINE_E(7);
#endif
2019-11-06 23:08:12 +00:00
#ifndef TMC_BAUD_RATE
#define TMC_BAUD_RATE 115200
#endif
#if HAS_DRIVER(TMC2130)
template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
void tmc_init(
TMCMarlin<TMC2130Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st,
const uint16_t mA,
const uint16_t microsteps,
const bool stealth,
const uint32_t hyb_thrs,
const uint32_t cool_thrs,
const uint8_t cool_semin,
const uint8_t cool_semax,
const uint8_t cool_seup,
const uint8_t cool_sedn,
const bool cool_seimin
) {
st.begin();
2018-10-03 07:48:49 +00:00
CHOPCONF_t chopconf{0};
chopconf.tbl = 1;
chopconf.toff = chopper_timing.toff;
2018-10-03 07:48:49 +00:00
chopconf.intpol = INTERPOLATE;
chopconf.hend = chopper_timing.hend + 3;
chopconf.hstrt = chopper_timing.hstrt - 1;
2019-06-09 10:08:05 +00:00
#if ENABLED(SQUARE_WAVE_STEPPING)
chopconf.dedge = true;
#endif
2018-10-03 07:48:49 +00:00
st.CHOPCONF(chopconf.sr);
st.rms_current(mA, HOLD_MULTIPLIER);
st.microsteps(microsteps);
2018-10-03 07:48:49 +00:00
st.iholddelay(10);
st.TPOWERDOWN(128); // ~2s until driver lowers to hold current
st.en_pwm_mode(stealth);
st.stored.stealthChop_enabled = stealth;
PWMCONF_t pwmconf{0};
pwmconf.pwm_freq = 0b01; // f_pwm = 2/683 f_clk
pwmconf.pwm_autoscale = true;
pwmconf.pwm_grad = 5;
pwmconf.pwm_ampl = 180;
st.PWMCONF(pwmconf.sr);
#if ENABLED(HYBRID_THRESHOLD)
st.set_pwm_thrs(hyb_thrs);
#else
UNUSED(hyb_thrs);
#endif
st.set_cool_thrs(cool_thrs); // (mm/s)
COOLCONF_t coolconf{0};
coolconf.semin = cool_semin;
coolconf.semax = cool_semax;
coolconf.seup = cool_seup;
coolconf.sedn = cool_sedn;
coolconf.seimin = cool_seimin;
st.COOLCONF(coolconf.sr);
2018-10-03 07:48:49 +00:00
st.GSTAT(); // Clear GSTAT
}
#endif // TMC2130
2019-02-06 12:33:14 +00:00
#if HAS_DRIVER(TMC2160)
template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
void tmc_init(
TMCMarlin<TMC2160Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st,
const uint16_t mA,
const uint16_t microsteps,
const bool stealth,
const uint32_t hyb_thrs
) {
2019-02-06 12:33:14 +00:00
st.begin();
CHOPCONF_t chopconf{0};
chopconf.tbl = 1;
chopconf.toff = chopper_timing.toff;
2019-02-06 12:33:14 +00:00
chopconf.intpol = INTERPOLATE;
chopconf.hend = chopper_timing.hend + 3;
chopconf.hstrt = chopper_timing.hstrt - 1;
2019-06-09 10:08:05 +00:00
#if ENABLED(SQUARE_WAVE_STEPPING)
chopconf.dedge = true;
#endif
2019-02-06 12:33:14 +00:00
st.CHOPCONF(chopconf.sr);
st.rms_current(mA, HOLD_MULTIPLIER);
st.microsteps(microsteps);
st.iholddelay(10);
st.TPOWERDOWN(128); // ~2s until driver lowers to hold current
st.en_pwm_mode(stealth);
st.stored.stealthChop_enabled = stealth;
2019-02-06 12:33:14 +00:00
2019-06-08 19:34:50 +00:00
TMC2160_n::PWMCONF_t pwmconf{0};
pwmconf.pwm_lim = 12;
pwmconf.pwm_reg = 8;
pwmconf.pwm_autograd = true;
2019-02-06 12:33:14 +00:00
pwmconf.pwm_autoscale = true;
2019-06-08 19:34:50 +00:00
pwmconf.pwm_freq = 0b01;
pwmconf.pwm_grad = 14;
pwmconf.pwm_ofs = 36;
2019-02-06 12:33:14 +00:00
st.PWMCONF(pwmconf.sr);
#if ENABLED(HYBRID_THRESHOLD)
st.set_pwm_thrs(hyb_thrs);
2019-02-06 12:33:14 +00:00
#else
UNUSED(hyb_thrs);
2019-02-06 12:33:14 +00:00
#endif
st.GSTAT(); // Clear GSTAT
}
#endif // TMC2160
2017-12-15 21:03:14 +00:00
//
2019-06-20 20:47:50 +00:00
// TMC2208/2209 Driver objects and inits
2017-12-15 21:03:14 +00:00
//
2019-07-09 03:59:51 +00:00
#if HAS_TMC220x
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(X)
#ifdef X_HARDWARE_SERIAL
TMC_UART_DEFINE(HW, X, X);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE(SW, X, X);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(X2)
#ifdef X2_HARDWARE_SERIAL
TMC_UART_DEFINE(HW, X2, X);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE(SW, X2, X);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Y)
#ifdef Y_HARDWARE_SERIAL
TMC_UART_DEFINE(HW, Y, Y);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE(SW, Y, Y);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Y2)
#ifdef Y2_HARDWARE_SERIAL
TMC_UART_DEFINE(HW, Y2, Y);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE(SW, Y2, Y);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Z)
#ifdef Z_HARDWARE_SERIAL
TMC_UART_DEFINE(HW, Z, Z);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE(SW, Z, Z);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Z2)
#ifdef Z2_HARDWARE_SERIAL
TMC_UART_DEFINE(HW, Z2, Z);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE(SW, Z2, Z);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Z3)
#ifdef Z3_HARDWARE_SERIAL
TMC_UART_DEFINE(HW, Z3, Z);
#else
TMC_UART_DEFINE(SW, Z3, Z);
#endif
#endif
2020-01-20 05:35:07 +00:00
#if AXIS_HAS_UART(Z4)
#ifdef Z4_HARDWARE_SERIAL
TMC_UART_DEFINE(HW, Z4, Z);
#else
TMC_UART_DEFINE(SW, Z4, Z);
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E0)
#ifdef E0_HARDWARE_SERIAL
TMC_UART_DEFINE_E(HW, 0);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE_E(SW, 0);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E1)
#ifdef E1_HARDWARE_SERIAL
TMC_UART_DEFINE_E(HW, 1);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE_E(SW, 1);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E2)
#ifdef E2_HARDWARE_SERIAL
TMC_UART_DEFINE_E(HW, 2);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE_E(SW, 2);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E3)
#ifdef E3_HARDWARE_SERIAL
TMC_UART_DEFINE_E(HW, 3);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE_E(SW, 3);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E4)
#ifdef E4_HARDWARE_SERIAL
TMC_UART_DEFINE_E(HW, 4);
2017-12-15 21:03:14 +00:00
#else
TMC_UART_DEFINE_E(SW, 4);
2017-12-15 21:03:14 +00:00
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E5)
2018-09-17 04:57:50 +00:00
#ifdef E5_HARDWARE_SERIAL
TMC_UART_DEFINE_E(HW, 5);
2018-09-17 04:57:50 +00:00
#else
TMC_UART_DEFINE_E(SW, 5);
2018-09-17 04:57:50 +00:00
#endif
#endif
#if AXIS_HAS_UART(E6)
#ifdef E6_HARDWARE_SERIAL
TMC_UART_DEFINE_E(HW, 6);
#else
TMC_UART_DEFINE_E(SW, 6);
#endif
#endif
#if AXIS_HAS_UART(E7)
#ifdef E7_HARDWARE_SERIAL
TMC_UART_DEFINE_E(HW, 7);
#else
TMC_UART_DEFINE_E(SW, 7);
#endif
#endif
2017-12-15 21:03:14 +00:00
2019-06-20 20:47:50 +00:00
void tmc_serial_begin() {
#if AXIS_HAS_UART(X)
#ifdef X_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
X_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperX.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(X2)
#ifdef X2_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
X2_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperX2.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Y)
#ifdef Y_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
Y_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperY.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Y2)
#ifdef Y2_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
Y2_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperY2.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Z)
#ifdef Z_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
Z_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperZ.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Z2)
#ifdef Z2_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
Z2_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperZ2.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(Z3)
#ifdef Z3_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
Z3_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperZ3.beginSerial(TMC_BAUD_RATE);
#endif
#endif
2020-01-20 05:35:07 +00:00
#if AXIS_HAS_UART(Z4)
#ifdef Z4_HARDWARE_SERIAL
Z4_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
stepperZ4.beginSerial(TMC_BAUD_RATE);
#endif
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E0)
#ifdef E0_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
E0_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperE0.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E1)
#ifdef E1_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
E1_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperE1.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E2)
#ifdef E2_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
E2_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperE2.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E3)
#ifdef E3_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
E3_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperE3.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E4)
#ifdef E4_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
E4_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
2019-11-06 23:08:12 +00:00
stepperE4.beginSerial(TMC_BAUD_RATE);
#endif
2017-12-15 21:03:14 +00:00
#endif
2019-06-20 20:47:50 +00:00
#if AXIS_HAS_UART(E5)
2018-09-17 04:57:50 +00:00
#ifdef E5_HARDWARE_SERIAL
2019-11-06 23:08:12 +00:00
E5_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
2018-09-17 04:57:50 +00:00
#else
2019-11-06 23:08:12 +00:00
stepperE5.beginSerial(TMC_BAUD_RATE);
2018-09-17 04:57:50 +00:00
#endif
#endif
#if AXIS_HAS_UART(E6)
#ifdef E6_HARDWARE_SERIAL
E6_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
stepperE6.beginSerial(TMC_BAUD_RATE);
#endif
#endif
#if AXIS_HAS_UART(E7)
#ifdef E7_HARDWARE_SERIAL
E7_HARDWARE_SERIAL.begin(TMC_BAUD_RATE);
#else
stepperE7.beginSerial(TMC_BAUD_RATE);
#endif
#endif
2017-12-15 21:03:14 +00:00
}
2019-06-20 20:47:50 +00:00
#endif
2017-12-15 21:03:14 +00:00
2019-06-20 20:47:50 +00:00
#if HAS_DRIVER(TMC2208)
template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
void tmc_init(
TMCMarlin<TMC2208Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st,
const uint16_t mA,
const uint16_t microsteps,
const bool stealth,
const uint32_t hyb_thrs
) {
2018-10-03 07:48:49 +00:00
TMC2208_n::GCONF_t gconf{0};
gconf.pdn_disable = true; // Use UART
gconf.mstep_reg_select = true; // Select microsteps with UART
gconf.i_scale_analog = false;
gconf.en_spreadcycle = !stealth;
st.GCONF(gconf.sr);
st.stored.stealthChop_enabled = stealth;
2018-10-03 07:48:49 +00:00
TMC2208_n::CHOPCONF_t chopconf{0};
chopconf.tbl = 0b01; // blank_time = 24
chopconf.toff = chopper_timing.toff;
2018-10-03 07:48:49 +00:00
chopconf.intpol = INTERPOLATE;
chopconf.hend = chopper_timing.hend + 3;
chopconf.hstrt = chopper_timing.hstrt - 1;
2019-06-09 10:08:05 +00:00
#if ENABLED(SQUARE_WAVE_STEPPING)
chopconf.dedge = true;
#endif
2018-10-03 07:48:49 +00:00
st.CHOPCONF(chopconf.sr);
st.rms_current(mA, HOLD_MULTIPLIER);
2017-12-15 21:03:14 +00:00
st.microsteps(microsteps);
2018-10-03 07:48:49 +00:00
st.iholddelay(10);
2017-12-15 21:03:14 +00:00
st.TPOWERDOWN(128); // ~2s until driver lowers to hold current
TMC2208_n::PWMCONF_t pwmconf{0};
pwmconf.pwm_lim = 12;
pwmconf.pwm_reg = 8;
pwmconf.pwm_autograd = true;
pwmconf.pwm_autoscale = true;
pwmconf.pwm_freq = 0b01;
pwmconf.pwm_grad = 14;
pwmconf.pwm_ofs = 36;
st.PWMCONF(pwmconf.sr);
#if ENABLED(HYBRID_THRESHOLD)
st.set_pwm_thrs(hyb_thrs);
2017-12-15 21:03:14 +00:00
#else
UNUSED(hyb_thrs);
2017-12-15 21:03:14 +00:00
#endif
2017-12-15 21:03:14 +00:00
st.GSTAT(0b111); // Clear
delay(200);
}
#endif // TMC2208
2017-12-15 21:03:14 +00:00
2019-06-20 20:47:50 +00:00
#if HAS_DRIVER(TMC2209)
template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
void tmc_init(
TMCMarlin<TMC2209Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st,
const uint16_t mA,
const uint16_t microsteps,
const bool stealth,
const uint32_t hyb_thrs,
const uint32_t cool_thrs,
const uint8_t cool_semin,
const uint8_t cool_semax,
const uint8_t cool_seup,
const uint8_t cool_sedn,
const bool cool_seimin
) {
2019-06-20 20:47:50 +00:00
TMC2208_n::GCONF_t gconf{0};
gconf.pdn_disable = true; // Use UART
gconf.mstep_reg_select = true; // Select microsteps with UART
gconf.i_scale_analog = false;
gconf.en_spreadcycle = !stealth;
st.GCONF(gconf.sr);
st.stored.stealthChop_enabled = stealth;
TMC2208_n::CHOPCONF_t chopconf{0};
chopconf.tbl = 0b01; // blank_time = 24
chopconf.toff = chopper_timing.toff;
chopconf.intpol = INTERPOLATE;
chopconf.hend = chopper_timing.hend + 3;
chopconf.hstrt = chopper_timing.hstrt - 1;
#if ENABLED(SQUARE_WAVE_STEPPING)
chopconf.dedge = true;
#endif
2019-06-20 20:47:50 +00:00
st.CHOPCONF(chopconf.sr);
st.rms_current(mA, HOLD_MULTIPLIER);
st.microsteps(microsteps);
st.iholddelay(10);
st.TPOWERDOWN(128); // ~2s until driver lowers to hold current
TMC2208_n::PWMCONF_t pwmconf{0};
pwmconf.pwm_lim = 12;
pwmconf.pwm_reg = 8;
pwmconf.pwm_autograd = true;
pwmconf.pwm_autoscale = true;
pwmconf.pwm_freq = 0b01;
pwmconf.pwm_grad = 14;
pwmconf.pwm_ofs = 36;
st.PWMCONF(pwmconf.sr);
#if ENABLED(HYBRID_THRESHOLD)
st.set_pwm_thrs(hyb_thrs);
2019-06-20 20:47:50 +00:00
#else
UNUSED(hyb_thrs);
2019-06-20 20:47:50 +00:00
#endif
st.set_cool_thrs(cool_thrs); // (mm/s)
COOLCONF_t coolconf{0};
coolconf.semin = cool_semin;
coolconf.semax = cool_semax;
coolconf.seup = cool_seup;
coolconf.sedn = cool_sedn;
coolconf.seimin = cool_seimin;
st.COOLCONF(coolconf.sr);
2019-06-20 20:47:50 +00:00
st.GSTAT(0b111); // Clear
delay(200);
2019-06-20 20:47:50 +00:00
}
#endif // TMC2209
2018-10-06 22:18:10 +00:00
#if HAS_DRIVER(TMC2660)
template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
void tmc_init(
TMCMarlin<TMC2660Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st,
const uint16_t mA,
const uint16_t microsteps
) {
2018-10-06 22:18:10 +00:00
st.begin();
TMC2660_n::CHOPCONF_t chopconf{0};
chopconf.tbl = 1;
chopconf.toff = chopper_timing.toff;
chopconf.hend = chopper_timing.hend + 3;
chopconf.hstrt = chopper_timing.hstrt - 1;
st.CHOPCONF(chopconf.sr);
2019-06-14 04:16:10 +00:00
st.sdoff(0);
2018-10-06 22:18:10 +00:00
st.rms_current(mA);
st.microsteps(microsteps);
2019-06-14 04:16:10 +00:00
#if ENABLED(SQUARE_WAVE_STEPPING)
st.dedge(true);
#endif
2018-10-06 22:18:10 +00:00
st.intpol(INTERPOLATE);
st.diss2g(true); // Disable short to ground protection. Too many false readings?
#if ENABLED(TMC_DEBUG)
st.rdsel(0b01);
#endif
2018-10-06 22:18:10 +00:00
}
#endif // TMC2660
2019-02-06 12:33:14 +00:00
#if HAS_DRIVER(TMC5130)
template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
void tmc_init(
TMCMarlin<TMC5130Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st,
const uint16_t mA,
const uint16_t microsteps,
const bool stealth,
const uint32_t hyb_thrs,
const uint32_t cool_thrs,
const uint8_t cool_semin,
const uint8_t cool_semax,
const uint8_t cool_seup,
const uint8_t cool_sedn,
const bool cool_seimin
) {
2019-02-06 12:33:14 +00:00
st.begin();
CHOPCONF_t chopconf{0};
chopconf.tbl = 1;
chopconf.toff = chopper_timing.toff;
chopconf.intpol = INTERPOLATE;
chopconf.hend = chopper_timing.hend + 3;
chopconf.hstrt = chopper_timing.hstrt - 1;
2019-06-09 10:08:05 +00:00
#if ENABLED(SQUARE_WAVE_STEPPING)
chopconf.dedge = true;
#endif
2019-02-06 12:33:14 +00:00
st.CHOPCONF(chopconf.sr);
st.rms_current(mA, HOLD_MULTIPLIER);
st.microsteps(microsteps);
st.iholddelay(10);
st.TPOWERDOWN(128); // ~2s until driver lowers to hold current
st.en_pwm_mode(stealth);
st.stored.stealthChop_enabled = stealth;
PWMCONF_t pwmconf{0};
pwmconf.pwm_freq = 0b01; // f_pwm = 2/683 f_clk
pwmconf.pwm_autoscale = true;
pwmconf.pwm_grad = 5;
pwmconf.pwm_ampl = 180;
st.PWMCONF(pwmconf.sr);
#if ENABLED(HYBRID_THRESHOLD)
st.set_pwm_thrs(hyb_thrs);
2019-02-06 12:33:14 +00:00
#else
UNUSED(hyb_thrs);
2019-02-06 12:33:14 +00:00
#endif
st.set_cool_thrs(cool_thrs); // (mm/s)
COOLCONF_t coolconf{0};
coolconf.semin = cool_semin;
coolconf.semax = cool_semax;
coolconf.seup = cool_seup;
coolconf.sedn = cool_sedn;
coolconf.seimin = cool_seimin;
st.COOLCONF(coolconf.sr);
2019-02-06 12:33:14 +00:00
st.GSTAT(); // Clear GSTAT
}
#endif // TMC5130
#if HAS_DRIVER(TMC5160)
template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
void tmc_init(
TMCMarlin<TMC5160Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st,
const uint16_t mA,
const uint16_t microsteps,
const bool stealth,
const uint32_t hyb_thrs,
const uint32_t cool_thrs,
const uint8_t cool_semin,
const uint8_t cool_semax,
const uint8_t cool_seup,
const uint8_t cool_sedn,
const bool cool_seimin
) {
2019-02-06 12:33:14 +00:00
st.begin();
CHOPCONF_t chopconf{0};
chopconf.tbl = 1;
chopconf.toff = chopper_timing.toff;
2019-02-06 12:33:14 +00:00
chopconf.intpol = INTERPOLATE;
chopconf.hend = chopper_timing.hend + 3;
chopconf.hstrt = chopper_timing.hstrt - 1;
2019-06-09 10:08:05 +00:00
#if ENABLED(SQUARE_WAVE_STEPPING)
chopconf.dedge = true;
#endif
2019-02-06 12:33:14 +00:00
st.CHOPCONF(chopconf.sr);
st.rms_current(mA, HOLD_MULTIPLIER);
st.microsteps(microsteps);
st.iholddelay(10);
st.TPOWERDOWN(128); // ~2s until driver lowers to hold current
st.en_pwm_mode(stealth);
st.stored.stealthChop_enabled = stealth;
2019-02-06 12:33:14 +00:00
2019-06-08 19:34:50 +00:00
TMC2160_n::PWMCONF_t pwmconf{0};
pwmconf.pwm_lim = 12;
pwmconf.pwm_reg = 8;
pwmconf.pwm_autograd = true;
2019-02-06 12:33:14 +00:00
pwmconf.pwm_autoscale = true;
2019-06-08 19:34:50 +00:00
pwmconf.pwm_freq = 0b01;
pwmconf.pwm_grad = 14;
pwmconf.pwm_ofs = 36;
2019-02-06 12:33:14 +00:00
st.PWMCONF(pwmconf.sr);
#if ENABLED(HYBRID_THRESHOLD)
st.set_pwm_thrs(hyb_thrs);
2019-02-06 12:33:14 +00:00
#else
UNUSED(hyb_thrs);
2019-02-06 12:33:14 +00:00
#endif
st.set_cool_thrs(cool_thrs); // (mm/s)
COOLCONF_t coolconf{0};
coolconf.semin = cool_semin;
coolconf.semax = cool_semax;
coolconf.seup = cool_seup;
coolconf.sedn = cool_sedn;
coolconf.seimin = cool_seimin;
st.COOLCONF(coolconf.sr);
2019-02-06 12:33:14 +00:00
st.GSTAT(); // Clear GSTAT
}
#endif // TMC5160
2019-09-01 00:44:45 +00:00
void restore_trinamic_drivers() {
#if AXIS_IS_TMC(X)
stepperX.push();
#endif
#if AXIS_IS_TMC(X2)
stepperX2.push();
#endif
#if AXIS_IS_TMC(Y)
stepperY.push();
#endif
#if AXIS_IS_TMC(Y2)
stepperY2.push();
#endif
#if AXIS_IS_TMC(Z)
stepperZ.push();
#endif
#if AXIS_IS_TMC(Z2)
stepperZ2.push();
#endif
#if AXIS_IS_TMC(Z3)
stepperZ3.push();
#endif
2020-01-20 05:35:07 +00:00
#if AXIS_IS_TMC(Z4)
stepperZ4.push();
#endif
#if AXIS_IS_TMC(E0)
stepperE0.push();
#endif
#if AXIS_IS_TMC(E1)
stepperE1.push();
#endif
#if AXIS_IS_TMC(E2)
stepperE2.push();
#endif
#if AXIS_IS_TMC(E3)
stepperE3.push();
#endif
#if AXIS_IS_TMC(E4)
stepperE4.push();
#endif
2018-09-17 04:57:50 +00:00
#if AXIS_IS_TMC(E5)
stepperE5.push();
#endif
#if AXIS_IS_TMC(E6)
stepperE6.push();
#endif
#if AXIS_IS_TMC(E7)
stepperE7.push();
#endif
}
2019-09-01 00:44:45 +00:00
void reset_trinamic_drivers() {
static constexpr bool stealthchop_by_axis[] = {
#if ENABLED(STEALTHCHOP_XY)
true
#else
false
#endif
,
#if ENABLED(STEALTHCHOP_Z)
true
#else
false
#endif
,
#if ENABLED(STEALTHCHOP_E)
true
#else
false
#endif
};
2018-10-03 07:48:49 +00:00
#if AXIS_IS_TMC(X)
TMC_INIT(X, STEALTH_AXIS_XY);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(X2)
TMC_INIT(X2, STEALTH_AXIS_XY);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(Y)
TMC_INIT(Y, STEALTH_AXIS_XY);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(Y2)
TMC_INIT(Y2, STEALTH_AXIS_XY);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(Z)
TMC_INIT(Z, STEALTH_AXIS_Z);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(Z2)
TMC_INIT(Z2, STEALTH_AXIS_Z);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(Z3)
TMC_INIT(Z3, STEALTH_AXIS_Z);
2018-10-03 07:48:49 +00:00
#endif
2020-01-20 05:35:07 +00:00
#if AXIS_IS_TMC(Z4)
TMC_INIT(Z4, STEALTH_AXIS_Z);
2020-01-20 05:35:07 +00:00
#endif
2018-10-03 07:48:49 +00:00
#if AXIS_IS_TMC(E0)
TMC_INIT(E0, STEALTH_AXIS_E);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(E1)
TMC_INIT(E1, STEALTH_AXIS_E);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(E2)
TMC_INIT(E2, STEALTH_AXIS_E);
#endif
2018-10-03 07:48:49 +00:00
#if AXIS_IS_TMC(E3)
TMC_INIT(E3, STEALTH_AXIS_E);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(E4)
TMC_INIT(E4, STEALTH_AXIS_E);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(E5)
TMC_INIT(E5, STEALTH_AXIS_E);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_IS_TMC(E6)
TMC_INIT(E6, STEALTH_AXIS_E);
#endif
#if AXIS_IS_TMC(E7)
TMC_INIT(E7, STEALTH_AXIS_E);
#endif
2018-10-03 07:48:49 +00:00
#if USE_SENSORLESS
2018-10-03 07:48:49 +00:00
#if X_SENSORLESS
#if AXIS_HAS_STALLGUARD(X)
2019-06-20 20:47:50 +00:00
stepperX.homing_threshold(X_STALL_SENSITIVITY);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_HAS_STALLGUARD(X2) && !X2_SENSORLESS
2019-06-20 20:47:50 +00:00
stepperX2.homing_threshold(X_STALL_SENSITIVITY);
2018-10-03 07:48:49 +00:00
#endif
#endif
#if X2_SENSORLESS
stepperX2.homing_threshold(X2_STALL_SENSITIVITY);
#endif
2018-10-03 07:48:49 +00:00
#if Y_SENSORLESS
#if AXIS_HAS_STALLGUARD(Y)
2019-06-20 20:47:50 +00:00
stepperY.homing_threshold(Y_STALL_SENSITIVITY);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_HAS_STALLGUARD(Y2)
2019-06-20 20:47:50 +00:00
stepperY2.homing_threshold(Y_STALL_SENSITIVITY);
2018-10-03 07:48:49 +00:00
#endif
#endif
#if Z_SENSORLESS
#if AXIS_HAS_STALLGUARD(Z)
2019-06-20 20:47:50 +00:00
stepperZ.homing_threshold(Z_STALL_SENSITIVITY);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_HAS_STALLGUARD(Z2)
2019-06-20 20:47:50 +00:00
stepperZ2.homing_threshold(Z_STALL_SENSITIVITY);
2018-10-03 07:48:49 +00:00
#endif
#if AXIS_HAS_STALLGUARD(Z3)
2019-06-20 20:47:50 +00:00
stepperZ3.homing_threshold(Z_STALL_SENSITIVITY);
2018-10-03 07:48:49 +00:00
#endif
2020-01-20 05:35:07 +00:00
#if AXIS_HAS_STALLGUARD(Z4)
stepperZ4.homing_threshold(Z_STALL_SENSITIVITY);
#endif
2018-10-03 07:48:49 +00:00
#endif
#endif
2018-10-03 07:48:49 +00:00
#ifdef TMC_ADV
TMC_ADV()
#endif
2018-10-03 07:48:49 +00:00
2019-09-01 00:44:45 +00:00
stepper.set_directions();
}
2019-09-01 00:44:45 +00:00
#endif // HAS_TRINAMIC