Firmware/Marlin/tmc_util.h

108 lines
3.2 KiB
C
Raw Normal View History

2018-01-10 02:05:37 +01:00
/**
* 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 _TMC_UTIL_H_
#define _TMC_UTIL_H_
#include "MarlinConfig.h"
2018-07-25 02:50:49 +02:00
#if HAS_DRIVER(TMC2130)
2018-03-13 08:12:22 +01:00
#include <TMC2130Stepper.h>
#endif
2018-07-25 02:50:49 +02:00
#if HAS_DRIVER(TMC2208)
2018-03-13 08:12:22 +01:00
#include <TMC2208Stepper.h>
#endif
2018-01-10 02:05:37 +01:00
extern bool report_tmc_status;
2018-03-15 01:14:48 +01:00
enum TMC_AxisEnum : char { TMC_X, TMC_Y, TMC_Z, TMC_X2, TMC_Y2, TMC_Z2, TMC_E0, TMC_E1, TMC_E2, TMC_E3, TMC_E4 };
2018-01-10 02:05:37 +01:00
constexpr uint32_t _tmc_thrs(const uint16_t msteps, const int32_t thrs, const uint32_t spmm) {
return 12650000UL * msteps / (256 * thrs * spmm);
}
2018-03-07 04:03:57 +01:00
void _tmc_say_axis(const TMC_AxisEnum axis);
void _tmc_say_current(const TMC_AxisEnum axis, const uint16_t curr);
void _tmc_say_otpw(const TMC_AxisEnum axis, const bool otpw);
void _tmc_say_otpw_cleared(const TMC_AxisEnum axis);
void _tmc_say_pwmthrs(const TMC_AxisEnum axis, const uint32_t thrs);
void _tmc_say_sgt(const TMC_AxisEnum axis, const int8_t sgt);
2018-01-10 02:05:37 +01:00
template<typename TMC>
2018-03-07 04:03:57 +01:00
void tmc_get_current(TMC &st, const TMC_AxisEnum axis) {
_tmc_say_current(axis, st.getCurrent());
2018-01-10 02:05:37 +01:00
}
template<typename TMC>
2018-05-10 06:42:40 +02:00
void tmc_set_current(TMC &st, const int mA) {
2018-01-10 02:05:37 +01:00
st.setCurrent(mA, R_SENSE, HOLD_MULTIPLIER);
}
template<typename TMC>
2018-03-07 04:03:57 +01:00
void tmc_report_otpw(TMC &st, const TMC_AxisEnum axis) {
_tmc_say_otpw(axis, st.getOTPW());
2018-01-10 02:05:37 +01:00
}
template<typename TMC>
2018-03-07 04:03:57 +01:00
void tmc_clear_otpw(TMC &st, const TMC_AxisEnum axis) {
2018-01-10 02:05:37 +01:00
st.clear_otpw();
2018-03-07 04:03:57 +01:00
_tmc_say_otpw_cleared(axis);
2018-01-10 02:05:37 +01:00
}
template<typename TMC>
2018-03-07 04:03:57 +01:00
void tmc_get_pwmthrs(TMC &st, const TMC_AxisEnum axis, const uint16_t spmm) {
_tmc_say_pwmthrs(axis, _tmc_thrs(st.microsteps(), st.TPWMTHRS(), spmm));
2018-01-10 02:05:37 +01:00
}
template<typename TMC>
2018-05-10 06:42:40 +02:00
void tmc_set_pwmthrs(TMC &st, const int32_t thrs, const uint32_t spmm) {
2018-01-10 02:05:37 +01:00
st.TPWMTHRS(_tmc_thrs(st.microsteps(), thrs, spmm));
}
template<typename TMC>
2018-03-07 04:03:57 +01:00
void tmc_get_sgt(TMC &st, const TMC_AxisEnum axis) {
_tmc_say_sgt(axis, st.sgt());
2018-01-10 02:05:37 +01:00
}
template<typename TMC>
2018-05-10 06:42:40 +02:00
void tmc_set_sgt(TMC &st, const int8_t sgt_val) {
2018-01-10 02:05:37 +01:00
st.sgt(sgt_val);
}
void monitor_tmc_driver();
#if ENABLED(TMC_DEBUG)
void tmc_set_report_status(const bool status);
void tmc_report_all();
#endif
/**
* TMC2130 specific sensorless homing using stallGuard2.
* stallGuard2 only works when in spreadCycle mode.
* spreadCycle and stealthChop are mutually exclusive.
*
* Defined here because of limitations with templates and headers.
*/
#if ENABLED(SENSORLESS_HOMING)
2018-04-27 00:52:20 +02:00
void tmc_sensorless_homing(TMC2130Stepper &st, const bool enable=true);
2018-01-10 02:05:37 +01:00
#endif
2018-07-25 02:50:49 +02:00
#if HAS_DRIVER(TMC2130)
2018-02-10 18:16:08 +01:00
void tmc_init_cs_pins();
#endif
2018-01-10 02:05:37 +01:00
#endif // _TMC_UTIL_H_