My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

tmc_util.cpp 41KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  20. *
  21. */
  22. #include "../inc/MarlinConfig.h"
  23. #if HAS_TRINAMIC_CONFIG
  24. #include "tmc_util.h"
  25. #include "../MarlinCore.h"
  26. #include "../module/stepper/indirection.h"
  27. #include "../module/printcounter.h"
  28. #include "../libs/duration_t.h"
  29. #include "../gcode/gcode.h"
  30. #if ENABLED(TMC_DEBUG)
  31. #include "../module/planner.h"
  32. #include "../libs/hex_print.h"
  33. #if ENABLED(MONITOR_DRIVER_STATUS)
  34. static uint16_t report_tmc_status_interval; // = 0
  35. #endif
  36. #endif
  37. #if HAS_LCD_MENU
  38. #include "../module/stepper.h"
  39. #endif
  40. /**
  41. * Check for over temperature or short to ground error flags.
  42. * Report and log warning of overtemperature condition.
  43. * Reduce driver current in a persistent otpw condition.
  44. * Keep track of otpw counter so we don't reduce current on a single instance,
  45. * and so we don't repeatedly report warning before the condition is cleared.
  46. */
  47. #if ENABLED(MONITOR_DRIVER_STATUS)
  48. struct TMC_driver_data {
  49. uint32_t drv_status;
  50. bool is_otpw:1,
  51. is_ot:1,
  52. is_s2g:1,
  53. is_error:1
  54. #if ENABLED(TMC_DEBUG)
  55. , is_stall:1
  56. , is_stealth:1
  57. , is_standstill:1
  58. #if HAS_STALLGUARD
  59. , sg_result_reasonable:1
  60. #endif
  61. #endif
  62. ;
  63. #if ENABLED(TMC_DEBUG)
  64. #if HAS_TMCX1X0 || HAS_TMC220x
  65. uint8_t cs_actual;
  66. #endif
  67. #if HAS_STALLGUARD
  68. uint16_t sg_result;
  69. #endif
  70. #endif
  71. };
  72. #if HAS_TMCX1X0
  73. #if ENABLED(TMC_DEBUG)
  74. static uint32_t get_pwm_scale(TMC2130Stepper &st) { return st.PWM_SCALE(); }
  75. #endif
  76. static TMC_driver_data get_driver_data(TMC2130Stepper &st) {
  77. constexpr uint8_t OT_bp = 25, OTPW_bp = 26;
  78. constexpr uint32_t S2G_bm = 0x18000000;
  79. #if ENABLED(TMC_DEBUG)
  80. constexpr uint16_t SG_RESULT_bm = 0x3FF; // 0:9
  81. constexpr uint8_t STEALTH_bp = 14;
  82. constexpr uint32_t CS_ACTUAL_bm = 0x1F0000; // 16:20
  83. constexpr uint8_t STALL_GUARD_bp = 24;
  84. constexpr uint8_t STST_bp = 31;
  85. #endif
  86. TMC_driver_data data;
  87. const auto ds = data.drv_status = st.DRV_STATUS();
  88. #ifdef __AVR__
  89. // 8-bit optimization saves up to 70 bytes of PROGMEM per axis
  90. uint8_t spart;
  91. #if ENABLED(TMC_DEBUG)
  92. data.sg_result = ds & SG_RESULT_bm;
  93. spart = ds >> 8;
  94. data.is_stealth = TEST(spart, STEALTH_bp - 8);
  95. spart = ds >> 16;
  96. data.cs_actual = spart & (CS_ACTUAL_bm >> 16);
  97. #endif
  98. spart = ds >> 24;
  99. data.is_ot = TEST(spart, OT_bp - 24);
  100. data.is_otpw = TEST(spart, OTPW_bp - 24);
  101. data.is_s2g = !!(spart & (S2G_bm >> 24));
  102. #if ENABLED(TMC_DEBUG)
  103. data.is_stall = TEST(spart, STALL_GUARD_bp - 24);
  104. data.is_standstill = TEST(spart, STST_bp - 24);
  105. data.sg_result_reasonable = !data.is_standstill; // sg_result has no reasonable meaning while standstill
  106. #endif
  107. #else // !__AVR__
  108. data.is_ot = TEST(ds, OT_bp);
  109. data.is_otpw = TEST(ds, OTPW_bp);
  110. data.is_s2g = !!(ds & S2G_bm);
  111. #if ENABLED(TMC_DEBUG)
  112. constexpr uint8_t CS_ACTUAL_sb = 16;
  113. data.sg_result = ds & SG_RESULT_bm;
  114. data.is_stealth = TEST(ds, STEALTH_bp);
  115. data.cs_actual = (ds & CS_ACTUAL_bm) >> CS_ACTUAL_sb;
  116. data.is_stall = TEST(ds, STALL_GUARD_bp);
  117. data.is_standstill = TEST(ds, STST_bp);
  118. data.sg_result_reasonable = !data.is_standstill; // sg_result has no reasonable meaning while standstill
  119. #endif
  120. #endif // !__AVR__
  121. return data;
  122. }
  123. #endif // HAS_TMCX1X0
  124. #if HAS_TMC220x
  125. #if ENABLED(TMC_DEBUG)
  126. static uint32_t get_pwm_scale(TMC2208Stepper &st) { return st.pwm_scale_sum(); }
  127. #endif
  128. static TMC_driver_data get_driver_data(TMC2208Stepper &st) {
  129. constexpr uint8_t OTPW_bp = 0, OT_bp = 1;
  130. constexpr uint8_t S2G_bm = 0b111100; // 2..5
  131. TMC_driver_data data;
  132. const auto ds = data.drv_status = st.DRV_STATUS();
  133. data.is_otpw = TEST(ds, OTPW_bp);
  134. data.is_ot = TEST(ds, OT_bp);
  135. data.is_s2g = !!(ds & S2G_bm);
  136. #if ENABLED(TMC_DEBUG)
  137. constexpr uint32_t CS_ACTUAL_bm = 0x1F0000; // 16:20
  138. constexpr uint8_t STEALTH_bp = 30, STST_bp = 31;
  139. #ifdef __AVR__
  140. // 8-bit optimization saves up to 12 bytes of PROGMEM per axis
  141. uint8_t spart = ds >> 16;
  142. data.cs_actual = spart & (CS_ACTUAL_bm >> 16);
  143. spart = ds >> 24;
  144. data.is_stealth = TEST(spart, STEALTH_bp - 24);
  145. data.is_standstill = TEST(spart, STST_bp - 24);
  146. #else
  147. constexpr uint8_t CS_ACTUAL_sb = 16;
  148. data.cs_actual = (ds & CS_ACTUAL_bm) >> CS_ACTUAL_sb;
  149. data.is_stealth = TEST(ds, STEALTH_bp);
  150. data.is_standstill = TEST(ds, STST_bp);
  151. #endif
  152. TERN_(HAS_STALLGUARD, data.sg_result_reasonable = false);
  153. #endif
  154. return data;
  155. }
  156. #endif // TMC2208 || TMC2209
  157. #if HAS_DRIVER(TMC2660)
  158. #if ENABLED(TMC_DEBUG)
  159. static uint32_t get_pwm_scale(TMC2660Stepper) { return 0; }
  160. #endif
  161. static TMC_driver_data get_driver_data(TMC2660Stepper &st) {
  162. constexpr uint8_t OT_bp = 1, OTPW_bp = 2;
  163. constexpr uint8_t S2G_bm = 0b11000;
  164. TMC_driver_data data;
  165. const auto ds = data.drv_status = st.DRVSTATUS();
  166. uint8_t spart = ds & 0xFF;
  167. data.is_otpw = TEST(spart, OTPW_bp);
  168. data.is_ot = TEST(spart, OT_bp);
  169. data.is_s2g = !!(ds & S2G_bm);
  170. #if ENABLED(TMC_DEBUG)
  171. constexpr uint8_t STALL_GUARD_bp = 0;
  172. constexpr uint8_t STST_bp = 7, SG_RESULT_sp = 10;
  173. constexpr uint32_t SG_RESULT_bm = 0xFFC00; // 10:19
  174. data.is_stall = TEST(spart, STALL_GUARD_bp);
  175. data.is_standstill = TEST(spart, STST_bp);
  176. data.sg_result = (ds & SG_RESULT_bm) >> SG_RESULT_sp;
  177. data.sg_result_reasonable = true;
  178. #endif
  179. return data;
  180. }
  181. #endif // TMC2660
  182. #if ENABLED(STOP_ON_ERROR)
  183. void report_driver_error(const TMC_driver_data &data) {
  184. SERIAL_ECHOPGM(" driver error detected: 0x");
  185. SERIAL_PRINTLN(data.drv_status, PrintBase::Hex);
  186. if (data.is_ot) SERIAL_ECHOLNPGM("overtemperature");
  187. if (data.is_s2g) SERIAL_ECHOLNPGM("coil short circuit");
  188. TERN_(TMC_DEBUG, tmc_report_all());
  189. kill(PSTR("Driver error"));
  190. }
  191. #endif
  192. template<typename TMC>
  193. void report_driver_otpw(TMC &st) {
  194. char timestamp[14];
  195. duration_t elapsed = print_job_timer.duration();
  196. const bool has_days = (elapsed.value > 60*60*24L);
  197. (void)elapsed.toDigital(timestamp, has_days);
  198. SERIAL_EOL();
  199. SERIAL_ECHO(timestamp);
  200. SERIAL_ECHOPGM(": ");
  201. st.printLabel();
  202. SERIAL_ECHOLNPGM(" driver overtemperature warning! (", st.getMilliamps(), "mA)");
  203. }
  204. template<typename TMC>
  205. void report_polled_driver_data(TMC &st, const TMC_driver_data &data) {
  206. const uint32_t pwm_scale = get_pwm_scale(st);
  207. st.printLabel();
  208. SERIAL_CHAR(':'); SERIAL_ECHO(pwm_scale);
  209. #if ENABLED(TMC_DEBUG)
  210. #if HAS_TMCX1X0 || HAS_TMC220x
  211. SERIAL_CHAR('/'); SERIAL_ECHO(data.cs_actual);
  212. #endif
  213. #if HAS_STALLGUARD
  214. SERIAL_CHAR('/');
  215. if (data.sg_result_reasonable)
  216. SERIAL_ECHO(data.sg_result);
  217. else
  218. SERIAL_CHAR('-');
  219. #endif
  220. #endif
  221. SERIAL_CHAR('|');
  222. if (st.error_count) SERIAL_CHAR('E'); // Error
  223. if (data.is_ot) SERIAL_CHAR('O'); // Over-temperature
  224. if (data.is_otpw) SERIAL_CHAR('W'); // over-temperature pre-Warning
  225. #if ENABLED(TMC_DEBUG)
  226. if (data.is_stall) SERIAL_CHAR('G'); // stallGuard
  227. if (data.is_stealth) SERIAL_CHAR('T'); // stealthChop
  228. if (data.is_standstill) SERIAL_CHAR('I'); // standstIll
  229. #endif
  230. if (st.flag_otpw) SERIAL_CHAR('F'); // otpw Flag
  231. SERIAL_CHAR('|');
  232. if (st.otpw_count > 0) SERIAL_ECHO(st.otpw_count);
  233. SERIAL_CHAR('\t');
  234. }
  235. #if CURRENT_STEP_DOWN > 0
  236. template<typename TMC>
  237. void step_current_down(TMC &st) {
  238. if (st.isEnabled()) {
  239. const uint16_t I_rms = st.getMilliamps() - (CURRENT_STEP_DOWN);
  240. if (I_rms > 50) {
  241. st.rms_current(I_rms);
  242. #if ENABLED(REPORT_CURRENT_CHANGE)
  243. st.printLabel();
  244. SERIAL_ECHOLNPGM(" current decreased to ", I_rms);
  245. #endif
  246. }
  247. }
  248. }
  249. #else
  250. #define step_current_down(...)
  251. #endif
  252. template<typename TMC>
  253. bool monitor_tmc_driver(TMC &st, const bool need_update_error_counters, const bool need_debug_reporting) {
  254. TMC_driver_data data = get_driver_data(st);
  255. if (data.drv_status == 0xFFFFFFFF || data.drv_status == 0x0) return false;
  256. bool should_step_down = false;
  257. if (need_update_error_counters) {
  258. if (data.is_ot | data.is_s2g) st.error_count++;
  259. else if (st.error_count > 0) st.error_count--;
  260. #if ENABLED(STOP_ON_ERROR)
  261. if (st.error_count >= 10) {
  262. SERIAL_EOL();
  263. st.printLabel();
  264. report_driver_error(data);
  265. }
  266. #endif
  267. // Report if a warning was triggered
  268. if (data.is_otpw && st.otpw_count == 0)
  269. report_driver_otpw(st);
  270. #if CURRENT_STEP_DOWN > 0
  271. // Decrease current if is_otpw is true and driver is enabled and there's been more than 4 warnings
  272. if (data.is_otpw && st.otpw_count > 4 && st.isEnabled())
  273. should_step_down = true;
  274. #endif
  275. if (data.is_otpw) {
  276. st.otpw_count++;
  277. st.flag_otpw = true;
  278. }
  279. else if (st.otpw_count > 0) st.otpw_count = 0;
  280. }
  281. #if ENABLED(TMC_DEBUG)
  282. if (need_debug_reporting) report_polled_driver_data(st, data);
  283. #endif
  284. return should_step_down;
  285. }
  286. void monitor_tmc_drivers() {
  287. const millis_t ms = millis();
  288. // Poll TMC drivers at the configured interval
  289. static millis_t next_poll = 0;
  290. const bool need_update_error_counters = ELAPSED(ms, next_poll);
  291. if (need_update_error_counters) next_poll = ms + MONITOR_DRIVER_STATUS_INTERVAL_MS;
  292. // Also poll at intervals for debugging
  293. #if ENABLED(TMC_DEBUG)
  294. static millis_t next_debug_reporting = 0;
  295. const bool need_debug_reporting = report_tmc_status_interval && ELAPSED(ms, next_debug_reporting);
  296. if (need_debug_reporting) next_debug_reporting = ms + report_tmc_status_interval;
  297. #else
  298. constexpr bool need_debug_reporting = false;
  299. #endif
  300. if (need_update_error_counters || need_debug_reporting) {
  301. #if AXIS_IS_TMC(X) || AXIS_IS_TMC(X2)
  302. {
  303. bool result = false;
  304. #if AXIS_IS_TMC(X)
  305. if (monitor_tmc_driver(stepperX, need_update_error_counters, need_debug_reporting)) result = true;
  306. #endif
  307. #if AXIS_IS_TMC(X2)
  308. if (monitor_tmc_driver(stepperX2, need_update_error_counters, need_debug_reporting)) result = true;
  309. #endif
  310. if (result) {
  311. #if AXIS_IS_TMC(X)
  312. step_current_down(stepperX);
  313. #endif
  314. #if AXIS_IS_TMC(X2)
  315. step_current_down(stepperX2);
  316. #endif
  317. }
  318. }
  319. #endif
  320. #if AXIS_IS_TMC(Y) || AXIS_IS_TMC(Y2)
  321. {
  322. bool result = false;
  323. #if AXIS_IS_TMC(Y)
  324. if (monitor_tmc_driver(stepperY, need_update_error_counters, need_debug_reporting)) result = true;
  325. #endif
  326. #if AXIS_IS_TMC(Y2)
  327. if (monitor_tmc_driver(stepperY2, need_update_error_counters, need_debug_reporting)) result = true;
  328. #endif
  329. if (result) {
  330. #if AXIS_IS_TMC(Y)
  331. step_current_down(stepperY);
  332. #endif
  333. #if AXIS_IS_TMC(Y2)
  334. step_current_down(stepperY2);
  335. #endif
  336. }
  337. }
  338. #endif
  339. #if AXIS_IS_TMC(Z) || AXIS_IS_TMC(Z2) || AXIS_IS_TMC(Z3) || AXIS_IS_TMC(Z4)
  340. {
  341. bool result = false;
  342. #if AXIS_IS_TMC(Z)
  343. if (monitor_tmc_driver(stepperZ, need_update_error_counters, need_debug_reporting)) result = true;
  344. #endif
  345. #if AXIS_IS_TMC(Z2)
  346. if (monitor_tmc_driver(stepperZ2, need_update_error_counters, need_debug_reporting)) result = true;
  347. #endif
  348. #if AXIS_IS_TMC(Z3)
  349. if (monitor_tmc_driver(stepperZ3, need_update_error_counters, need_debug_reporting)) result = true;
  350. #endif
  351. #if AXIS_IS_TMC(Z4)
  352. if (monitor_tmc_driver(stepperZ4, need_update_error_counters, need_debug_reporting)) result = true;
  353. #endif
  354. if (result) {
  355. #if AXIS_IS_TMC(Z)
  356. step_current_down(stepperZ);
  357. #endif
  358. #if AXIS_IS_TMC(Z2)
  359. step_current_down(stepperZ2);
  360. #endif
  361. #if AXIS_IS_TMC(Z3)
  362. step_current_down(stepperZ3);
  363. #endif
  364. #if AXIS_IS_TMC(Z4)
  365. step_current_down(stepperZ4);
  366. #endif
  367. }
  368. }
  369. #endif
  370. #if AXIS_IS_TMC(I)
  371. if (monitor_tmc_driver(stepperI, need_update_error_counters, need_debug_reporting))
  372. step_current_down(stepperI);
  373. #endif
  374. #if AXIS_IS_TMC(J)
  375. if (monitor_tmc_driver(stepperJ, need_update_error_counters, need_debug_reporting))
  376. step_current_down(stepperJ);
  377. #endif
  378. #if AXIS_IS_TMC(K)
  379. if (monitor_tmc_driver(stepperK, need_update_error_counters, need_debug_reporting))
  380. step_current_down(stepperK);
  381. #endif
  382. #if AXIS_IS_TMC(E0)
  383. (void)monitor_tmc_driver(stepperE0, need_update_error_counters, need_debug_reporting);
  384. #endif
  385. #if AXIS_IS_TMC(E1)
  386. (void)monitor_tmc_driver(stepperE1, need_update_error_counters, need_debug_reporting);
  387. #endif
  388. #if AXIS_IS_TMC(E2)
  389. (void)monitor_tmc_driver(stepperE2, need_update_error_counters, need_debug_reporting);
  390. #endif
  391. #if AXIS_IS_TMC(E3)
  392. (void)monitor_tmc_driver(stepperE3, need_update_error_counters, need_debug_reporting);
  393. #endif
  394. #if AXIS_IS_TMC(E4)
  395. (void)monitor_tmc_driver(stepperE4, need_update_error_counters, need_debug_reporting);
  396. #endif
  397. #if AXIS_IS_TMC(E5)
  398. (void)monitor_tmc_driver(stepperE5, need_update_error_counters, need_debug_reporting);
  399. #endif
  400. #if AXIS_IS_TMC(E6)
  401. (void)monitor_tmc_driver(stepperE6, need_update_error_counters, need_debug_reporting);
  402. #endif
  403. #if AXIS_IS_TMC(E7)
  404. (void)monitor_tmc_driver(stepperE7, need_update_error_counters, need_debug_reporting);
  405. #endif
  406. if (TERN0(TMC_DEBUG, need_debug_reporting)) SERIAL_EOL();
  407. }
  408. }
  409. #endif // MONITOR_DRIVER_STATUS
  410. #if ENABLED(TMC_DEBUG)
  411. /**
  412. * M122 [S<0|1>] [Pnnn] Enable periodic status reports
  413. */
  414. #if ENABLED(MONITOR_DRIVER_STATUS)
  415. void tmc_set_report_interval(const uint16_t update_interval) {
  416. if ((report_tmc_status_interval = update_interval))
  417. SERIAL_ECHOLNPGM("axis:pwm_scale"
  418. #if HAS_STEALTHCHOP
  419. "/curr_scale"
  420. #endif
  421. #if HAS_STALLGUARD
  422. "/mech_load"
  423. #endif
  424. "|flags|warncount"
  425. );
  426. }
  427. #endif
  428. enum TMC_debug_enum : char {
  429. TMC_CODES,
  430. TMC_UART_ADDR,
  431. TMC_ENABLED,
  432. TMC_CURRENT,
  433. TMC_RMS_CURRENT,
  434. TMC_MAX_CURRENT,
  435. TMC_IRUN,
  436. TMC_IHOLD,
  437. TMC_GLOBAL_SCALER,
  438. TMC_CS_ACTUAL,
  439. TMC_PWM_SCALE,
  440. TMC_PWM_SCALE_SUM,
  441. TMC_PWM_SCALE_AUTO,
  442. TMC_PWM_OFS_AUTO,
  443. TMC_PWM_GRAD_AUTO,
  444. TMC_VSENSE,
  445. TMC_STEALTHCHOP,
  446. TMC_MICROSTEPS,
  447. TMC_TSTEP,
  448. TMC_TPWMTHRS,
  449. TMC_TPWMTHRS_MMS,
  450. TMC_OTPW,
  451. TMC_OTPW_TRIGGERED,
  452. TMC_TOFF,
  453. TMC_TBL,
  454. TMC_HEND,
  455. TMC_HSTRT,
  456. TMC_SGT,
  457. TMC_MSCNT,
  458. TMC_INTERPOLATE
  459. };
  460. enum TMC_drv_status_enum : char {
  461. TMC_DRV_CODES,
  462. TMC_STST,
  463. TMC_OLB,
  464. TMC_OLA,
  465. TMC_S2GB,
  466. TMC_S2GA,
  467. TMC_DRV_OTPW,
  468. TMC_OT,
  469. TMC_STALLGUARD,
  470. TMC_DRV_CS_ACTUAL,
  471. TMC_FSACTIVE,
  472. TMC_SG_RESULT,
  473. TMC_DRV_STATUS_HEX,
  474. TMC_T157,
  475. TMC_T150,
  476. TMC_T143,
  477. TMC_T120,
  478. TMC_STEALTH,
  479. TMC_S2VSB,
  480. TMC_S2VSA
  481. };
  482. enum TMC_get_registers_enum : char {
  483. TMC_AXIS_CODES,
  484. TMC_GET_GCONF,
  485. TMC_GET_IHOLD_IRUN,
  486. TMC_GET_GSTAT,
  487. TMC_GET_IOIN,
  488. TMC_GET_TPOWERDOWN,
  489. TMC_GET_TSTEP,
  490. TMC_GET_TPWMTHRS,
  491. TMC_GET_TCOOLTHRS,
  492. TMC_GET_THIGH,
  493. TMC_GET_CHOPCONF,
  494. TMC_GET_COOLCONF,
  495. TMC_GET_PWMCONF,
  496. TMC_GET_PWM_SCALE,
  497. TMC_GET_DRV_STATUS,
  498. TMC_GET_DRVCONF,
  499. TMC_GET_DRVCTRL,
  500. TMC_GET_DRVSTATUS,
  501. TMC_GET_SGCSCONF,
  502. TMC_GET_SMARTEN
  503. };
  504. template<class TMC>
  505. static void print_vsense(TMC &st) { SERIAL_ECHOF(st.vsense() ? F("1=.18") : F("0=.325")); }
  506. #if HAS_DRIVER(TMC2130) || HAS_DRIVER(TMC5130)
  507. static void _tmc_status(TMC2130Stepper &st, const TMC_debug_enum i) {
  508. switch (i) {
  509. case TMC_PWM_SCALE: SERIAL_ECHO(st.PWM_SCALE()); break;
  510. case TMC_SGT: SERIAL_ECHO(st.sgt()); break;
  511. case TMC_STEALTHCHOP: serialprint_truefalse(st.en_pwm_mode()); break;
  512. case TMC_INTERPOLATE: serialprint_truefalse(st.intpol()); break;
  513. default: break;
  514. }
  515. }
  516. #endif
  517. #if HAS_TMCX1X0
  518. static void _tmc_parse_drv_status(TMC2130Stepper &st, const TMC_drv_status_enum i) {
  519. switch (i) {
  520. case TMC_STALLGUARD: if (st.stallguard()) SERIAL_CHAR('*'); break;
  521. case TMC_SG_RESULT: SERIAL_ECHO(st.sg_result()); break;
  522. case TMC_FSACTIVE: if (st.fsactive()) SERIAL_CHAR('*'); break;
  523. case TMC_DRV_CS_ACTUAL: SERIAL_ECHO(st.cs_actual()); break;
  524. default: break;
  525. }
  526. }
  527. #endif
  528. #if HAS_DRIVER(TMC2160) || HAS_DRIVER(TMC5160)
  529. template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  530. void print_vsense(TMCMarlin<TMC2160Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &) { }
  531. template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  532. void print_vsense(TMCMarlin<TMC5160Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &) { }
  533. static void _tmc_status(TMC2160Stepper &st, const TMC_debug_enum i) {
  534. switch (i) {
  535. case TMC_PWM_SCALE: SERIAL_ECHO(st.PWM_SCALE()); break;
  536. case TMC_SGT: SERIAL_ECHO(st.sgt()); break;
  537. case TMC_STEALTHCHOP: serialprint_truefalse(st.en_pwm_mode()); break;
  538. case TMC_GLOBAL_SCALER:
  539. {
  540. uint16_t value = st.GLOBAL_SCALER();
  541. SERIAL_ECHO(value ? value : 256);
  542. SERIAL_ECHOPGM("/256");
  543. }
  544. break;
  545. case TMC_INTERPOLATE: serialprint_truefalse(st.intpol()); break;
  546. default: break;
  547. }
  548. }
  549. #endif
  550. #if HAS_TMC220x
  551. static void _tmc_status(TMC2208Stepper &st, const TMC_debug_enum i) {
  552. switch (i) {
  553. case TMC_PWM_SCALE_SUM: SERIAL_ECHO(st.pwm_scale_sum()); break;
  554. case TMC_PWM_SCALE_AUTO: SERIAL_ECHO(st.pwm_scale_auto()); break;
  555. case TMC_PWM_OFS_AUTO: SERIAL_ECHO(st.pwm_ofs_auto()); break;
  556. case TMC_PWM_GRAD_AUTO: SERIAL_ECHO(st.pwm_grad_auto()); break;
  557. case TMC_STEALTHCHOP: serialprint_truefalse(st.stealth()); break;
  558. case TMC_INTERPOLATE: serialprint_truefalse(st.intpol()); break;
  559. default: break;
  560. }
  561. }
  562. #if HAS_DRIVER(TMC2209)
  563. template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  564. static void _tmc_status(TMCMarlin<TMC2209Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st, const TMC_debug_enum i) {
  565. switch (i) {
  566. case TMC_SGT: SERIAL_ECHO(st.SGTHRS()); break;
  567. case TMC_UART_ADDR: SERIAL_ECHO(st.get_address()); break;
  568. default:
  569. TMC2208Stepper *parent = &st;
  570. _tmc_status(*parent, i);
  571. break;
  572. }
  573. }
  574. #endif
  575. static void _tmc_parse_drv_status(TMC2208Stepper &st, const TMC_drv_status_enum i) {
  576. switch (i) {
  577. case TMC_T157: if (st.t157()) SERIAL_CHAR('*'); break;
  578. case TMC_T150: if (st.t150()) SERIAL_CHAR('*'); break;
  579. case TMC_T143: if (st.t143()) SERIAL_CHAR('*'); break;
  580. case TMC_T120: if (st.t120()) SERIAL_CHAR('*'); break;
  581. case TMC_S2VSA: if (st.s2vsa()) SERIAL_CHAR('*'); break;
  582. case TMC_S2VSB: if (st.s2vsb()) SERIAL_CHAR('*'); break;
  583. case TMC_DRV_CS_ACTUAL: SERIAL_ECHO(st.cs_actual()); break;
  584. default: break;
  585. }
  586. }
  587. #if HAS_DRIVER(TMC2209)
  588. static void _tmc_parse_drv_status(TMC2209Stepper &st, const TMC_drv_status_enum i) {
  589. switch (i) {
  590. case TMC_SG_RESULT: SERIAL_ECHO(st.SG_RESULT()); break;
  591. default: _tmc_parse_drv_status(static_cast<TMC2208Stepper &>(st), i); break;
  592. }
  593. }
  594. #endif
  595. #endif
  596. #if HAS_DRIVER(TMC2660)
  597. static void _tmc_parse_drv_status(TMC2660Stepper, const TMC_drv_status_enum) { }
  598. static void _tmc_status(TMC2660Stepper &st, const TMC_debug_enum i) {
  599. switch (i) {
  600. case TMC_INTERPOLATE: serialprint_truefalse(st.intpol()); break;
  601. default: break;
  602. }
  603. }
  604. #endif
  605. template <typename TMC>
  606. static void tmc_status(TMC &st, const TMC_debug_enum i) {
  607. SERIAL_CHAR('\t');
  608. switch (i) {
  609. case TMC_CODES: st.printLabel(); break;
  610. case TMC_ENABLED: serialprint_truefalse(st.isEnabled()); break;
  611. case TMC_CURRENT: SERIAL_ECHO(st.getMilliamps()); break;
  612. case TMC_RMS_CURRENT: SERIAL_ECHO(st.rms_current()); break;
  613. case TMC_MAX_CURRENT: SERIAL_PRINT((float)st.rms_current() * 1.41, 0); break;
  614. case TMC_IRUN:
  615. SERIAL_ECHO(st.irun());
  616. SERIAL_ECHOPGM("/31");
  617. break;
  618. case TMC_IHOLD:
  619. SERIAL_ECHO(st.ihold());
  620. SERIAL_ECHOPGM("/31");
  621. break;
  622. case TMC_CS_ACTUAL:
  623. SERIAL_ECHO(st.cs_actual());
  624. SERIAL_ECHOPGM("/31");
  625. break;
  626. case TMC_VSENSE: print_vsense(st); break;
  627. case TMC_MICROSTEPS: SERIAL_ECHO(st.microsteps()); break;
  628. case TMC_TSTEP: {
  629. const uint32_t tstep_value = st.TSTEP();
  630. if (tstep_value != 0xFFFFF) SERIAL_ECHO(tstep_value); else SERIAL_ECHOPGM("max");
  631. } break;
  632. #if ENABLED(HYBRID_THRESHOLD)
  633. case TMC_TPWMTHRS: SERIAL_ECHO(uint32_t(st.TPWMTHRS())); break;
  634. case TMC_TPWMTHRS_MMS: {
  635. const uint32_t tpwmthrs_val = st.get_pwm_thrs();
  636. if (tpwmthrs_val) SERIAL_ECHO(tpwmthrs_val); else SERIAL_CHAR('-');
  637. } break;
  638. #endif
  639. case TMC_OTPW: serialprint_truefalse(st.otpw()); break;
  640. #if ENABLED(MONITOR_DRIVER_STATUS)
  641. case TMC_OTPW_TRIGGERED: serialprint_truefalse(st.getOTPW()); break;
  642. #endif
  643. case TMC_TOFF: SERIAL_ECHO(st.toff()); break;
  644. case TMC_TBL: SERIAL_ECHO(st.blank_time()); break;
  645. case TMC_HEND: SERIAL_ECHO(st.hysteresis_end()); break;
  646. case TMC_HSTRT: SERIAL_ECHO(st.hysteresis_start()); break;
  647. case TMC_MSCNT: SERIAL_ECHO(st.get_microstep_counter()); break;
  648. default: _tmc_status(st, i); break;
  649. }
  650. }
  651. #if HAS_DRIVER(TMC2660)
  652. template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  653. void tmc_status(TMCMarlin<TMC2660Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st, const TMC_debug_enum i) {
  654. SERIAL_CHAR('\t');
  655. switch (i) {
  656. case TMC_CODES: st.printLabel(); break;
  657. case TMC_ENABLED: serialprint_truefalse(st.isEnabled()); break;
  658. case TMC_CURRENT: SERIAL_ECHO(st.getMilliamps()); break;
  659. case TMC_RMS_CURRENT: SERIAL_ECHO(st.rms_current()); break;
  660. case TMC_MAX_CURRENT: SERIAL_PRINT((float)st.rms_current() * 1.41, 0); break;
  661. case TMC_IRUN:
  662. SERIAL_ECHO(st.cs());
  663. SERIAL_ECHOPGM("/31");
  664. break;
  665. case TMC_VSENSE: SERIAL_ECHOF(st.vsense() ? F("1=.165") : F("0=.310")); break;
  666. case TMC_MICROSTEPS: SERIAL_ECHO(st.microsteps()); break;
  667. //case TMC_OTPW: serialprint_truefalse(st.otpw()); break;
  668. //case TMC_OTPW_TRIGGERED: serialprint_truefalse(st.getOTPW()); break;
  669. case TMC_SGT: SERIAL_ECHO(st.sgt()); break;
  670. case TMC_TOFF: SERIAL_ECHO(st.toff()); break;
  671. case TMC_TBL: SERIAL_ECHO(st.blank_time()); break;
  672. case TMC_HEND: SERIAL_ECHO(st.hysteresis_end()); break;
  673. case TMC_HSTRT: SERIAL_ECHO(st.hysteresis_start()); break;
  674. default: break;
  675. }
  676. }
  677. #endif
  678. template <typename TMC>
  679. static void tmc_parse_drv_status(TMC &st, const TMC_drv_status_enum i) {
  680. SERIAL_CHAR('\t');
  681. switch (i) {
  682. case TMC_DRV_CODES: st.printLabel(); break;
  683. case TMC_STST: if (!st.stst()) SERIAL_CHAR('*'); break;
  684. case TMC_OLB: if (st.olb()) SERIAL_CHAR('*'); break;
  685. case TMC_OLA: if (st.ola()) SERIAL_CHAR('*'); break;
  686. case TMC_S2GB: if (st.s2gb()) SERIAL_CHAR('*'); break;
  687. case TMC_S2GA: if (st.s2ga()) SERIAL_CHAR('*'); break;
  688. case TMC_DRV_OTPW: if (st.otpw()) SERIAL_CHAR('*'); break;
  689. case TMC_OT: if (st.ot()) SERIAL_CHAR('*'); break;
  690. case TMC_DRV_STATUS_HEX: {
  691. const uint32_t drv_status = st.DRV_STATUS();
  692. SERIAL_CHAR('\t');
  693. st.printLabel();
  694. SERIAL_CHAR('\t');
  695. print_hex_long(drv_status, ':');
  696. if (drv_status == 0xFFFFFFFF || drv_status == 0) SERIAL_ECHOPGM("\t Bad response!");
  697. SERIAL_EOL();
  698. break;
  699. }
  700. default: _tmc_parse_drv_status(st, i); break;
  701. }
  702. }
  703. static void tmc_debug_loop(const TMC_debug_enum n, LOGICAL_AXIS_ARGS(const bool)) {
  704. if (x) {
  705. #if AXIS_IS_TMC(X)
  706. tmc_status(stepperX, n);
  707. #endif
  708. #if AXIS_IS_TMC(X2)
  709. tmc_status(stepperX2, n);
  710. #endif
  711. }
  712. if (TERN0(HAS_Y_AXIS, y)) {
  713. #if AXIS_IS_TMC(Y)
  714. tmc_status(stepperY, n);
  715. #endif
  716. #if AXIS_IS_TMC(Y2)
  717. tmc_status(stepperY2, n);
  718. #endif
  719. }
  720. if (TERN0(HAS_Z_AXIS, z)) {
  721. #if AXIS_IS_TMC(Z)
  722. tmc_status(stepperZ, n);
  723. #endif
  724. #if AXIS_IS_TMC(Z2)
  725. tmc_status(stepperZ2, n);
  726. #endif
  727. #if AXIS_IS_TMC(Z3)
  728. tmc_status(stepperZ3, n);
  729. #endif
  730. #if AXIS_IS_TMC(Z4)
  731. tmc_status(stepperZ4, n);
  732. #endif
  733. }
  734. #if AXIS_IS_TMC(I)
  735. if (i) tmc_status(stepperI, n);
  736. #endif
  737. #if AXIS_IS_TMC(J)
  738. if (j) tmc_status(stepperJ, n);
  739. #endif
  740. #if AXIS_IS_TMC(K)
  741. if (k) tmc_status(stepperK, n);
  742. #endif
  743. if (TERN0(HAS_EXTRUDERS, e)) {
  744. #if AXIS_IS_TMC(E0)
  745. tmc_status(stepperE0, n);
  746. #endif
  747. #if AXIS_IS_TMC(E1)
  748. tmc_status(stepperE1, n);
  749. #endif
  750. #if AXIS_IS_TMC(E2)
  751. tmc_status(stepperE2, n);
  752. #endif
  753. #if AXIS_IS_TMC(E3)
  754. tmc_status(stepperE3, n);
  755. #endif
  756. #if AXIS_IS_TMC(E4)
  757. tmc_status(stepperE4, n);
  758. #endif
  759. #if AXIS_IS_TMC(E5)
  760. tmc_status(stepperE5, n);
  761. #endif
  762. #if AXIS_IS_TMC(E6)
  763. tmc_status(stepperE6, n);
  764. #endif
  765. #if AXIS_IS_TMC(E7)
  766. tmc_status(stepperE7, n);
  767. #endif
  768. }
  769. SERIAL_EOL();
  770. }
  771. static void drv_status_loop(const TMC_drv_status_enum n, LOGICAL_AXIS_ARGS(const bool)) {
  772. if (x) {
  773. #if AXIS_IS_TMC(X)
  774. tmc_parse_drv_status(stepperX, n);
  775. #endif
  776. #if AXIS_IS_TMC(X2)
  777. tmc_parse_drv_status(stepperX2, n);
  778. #endif
  779. }
  780. if (TERN0(HAS_Y_AXIS, y)) {
  781. #if AXIS_IS_TMC(Y)
  782. tmc_parse_drv_status(stepperY, n);
  783. #endif
  784. #if AXIS_IS_TMC(Y2)
  785. tmc_parse_drv_status(stepperY2, n);
  786. #endif
  787. }
  788. if (TERN0(HAS_Z_AXIS, z)) {
  789. #if AXIS_IS_TMC(Z)
  790. tmc_parse_drv_status(stepperZ, n);
  791. #endif
  792. #if AXIS_IS_TMC(Z2)
  793. tmc_parse_drv_status(stepperZ2, n);
  794. #endif
  795. #if AXIS_IS_TMC(Z3)
  796. tmc_parse_drv_status(stepperZ3, n);
  797. #endif
  798. #if AXIS_IS_TMC(Z4)
  799. tmc_parse_drv_status(stepperZ4, n);
  800. #endif
  801. }
  802. #if AXIS_IS_TMC(I)
  803. if (i) tmc_parse_drv_status(stepperI, n);
  804. #endif
  805. #if AXIS_IS_TMC(J)
  806. if (j) tmc_parse_drv_status(stepperJ, n);
  807. #endif
  808. #if AXIS_IS_TMC(K)
  809. if (k) tmc_parse_drv_status(stepperK, n);
  810. #endif
  811. if (TERN0(HAS_EXTRUDERS, e)) {
  812. #if AXIS_IS_TMC(E0)
  813. tmc_parse_drv_status(stepperE0, n);
  814. #endif
  815. #if AXIS_IS_TMC(E1)
  816. tmc_parse_drv_status(stepperE1, n);
  817. #endif
  818. #if AXIS_IS_TMC(E2)
  819. tmc_parse_drv_status(stepperE2, n);
  820. #endif
  821. #if AXIS_IS_TMC(E3)
  822. tmc_parse_drv_status(stepperE3, n);
  823. #endif
  824. #if AXIS_IS_TMC(E4)
  825. tmc_parse_drv_status(stepperE4, n);
  826. #endif
  827. #if AXIS_IS_TMC(E5)
  828. tmc_parse_drv_status(stepperE5, n);
  829. #endif
  830. #if AXIS_IS_TMC(E6)
  831. tmc_parse_drv_status(stepperE6, n);
  832. #endif
  833. #if AXIS_IS_TMC(E7)
  834. tmc_parse_drv_status(stepperE7, n);
  835. #endif
  836. }
  837. SERIAL_EOL();
  838. }
  839. /**
  840. * M122 report functions
  841. */
  842. void tmc_report_all(LOGICAL_AXIS_ARGS(const bool)) {
  843. #define TMC_REPORT(LABEL, ITEM) do{ SERIAL_ECHOPGM(LABEL); tmc_debug_loop(ITEM, LOGICAL_AXIS_ARGS()); }while(0)
  844. #define DRV_REPORT(LABEL, ITEM) do{ SERIAL_ECHOPGM(LABEL); drv_status_loop(ITEM, LOGICAL_AXIS_ARGS()); }while(0)
  845. TMC_REPORT("\t", TMC_CODES);
  846. #if HAS_DRIVER(TMC2209)
  847. TMC_REPORT("Address\t", TMC_UART_ADDR);
  848. #endif
  849. TMC_REPORT("Enabled\t", TMC_ENABLED);
  850. TMC_REPORT("Set current", TMC_CURRENT);
  851. TMC_REPORT("RMS current", TMC_RMS_CURRENT);
  852. TMC_REPORT("MAX current", TMC_MAX_CURRENT);
  853. TMC_REPORT("Run current", TMC_IRUN);
  854. TMC_REPORT("Hold current", TMC_IHOLD);
  855. #if HAS_DRIVER(TMC2160) || HAS_DRIVER(TMC5160)
  856. TMC_REPORT("Global scaler", TMC_GLOBAL_SCALER);
  857. #endif
  858. TMC_REPORT("CS actual", TMC_CS_ACTUAL);
  859. TMC_REPORT("PWM scale", TMC_PWM_SCALE);
  860. #if HAS_DRIVER(TMC2130) || HAS_DRIVER(TMC2224) || HAS_DRIVER(TMC2660) || HAS_TMC220x
  861. TMC_REPORT("vsense\t", TMC_VSENSE);
  862. #endif
  863. TMC_REPORT("stealthChop", TMC_STEALTHCHOP);
  864. TMC_REPORT("msteps\t", TMC_MICROSTEPS);
  865. TMC_REPORT("interp\t", TMC_INTERPOLATE);
  866. TMC_REPORT("tstep\t", TMC_TSTEP);
  867. TMC_REPORT("PWM thresh.", TMC_TPWMTHRS);
  868. TMC_REPORT("[mm/s]\t", TMC_TPWMTHRS_MMS);
  869. TMC_REPORT("OT prewarn", TMC_OTPW);
  870. #if ENABLED(MONITOR_DRIVER_STATUS)
  871. TMC_REPORT("triggered\n OTP\t", TMC_OTPW_TRIGGERED);
  872. #endif
  873. #if HAS_TMC220x
  874. TMC_REPORT("pwm scale sum", TMC_PWM_SCALE_SUM);
  875. TMC_REPORT("pwm scale auto", TMC_PWM_SCALE_AUTO);
  876. TMC_REPORT("pwm offset auto", TMC_PWM_OFS_AUTO);
  877. TMC_REPORT("pwm grad auto", TMC_PWM_GRAD_AUTO);
  878. #endif
  879. TMC_REPORT("off time", TMC_TOFF);
  880. TMC_REPORT("blank time", TMC_TBL);
  881. TMC_REPORT("hysteresis\n -end\t", TMC_HEND);
  882. TMC_REPORT(" -start\t", TMC_HSTRT);
  883. TMC_REPORT("Stallguard thrs", TMC_SGT);
  884. TMC_REPORT("uStep count", TMC_MSCNT);
  885. DRV_REPORT("DRVSTATUS", TMC_DRV_CODES);
  886. #if HAS_TMCX1X0 || HAS_TMC220x
  887. DRV_REPORT("sg_result", TMC_SG_RESULT);
  888. #endif
  889. #if HAS_TMCX1X0
  890. DRV_REPORT("stallguard", TMC_STALLGUARD);
  891. DRV_REPORT("fsactive", TMC_FSACTIVE);
  892. #endif
  893. DRV_REPORT("stst\t", TMC_STST);
  894. DRV_REPORT("olb\t", TMC_OLB);
  895. DRV_REPORT("ola\t", TMC_OLA);
  896. DRV_REPORT("s2gb\t", TMC_S2GB);
  897. DRV_REPORT("s2ga\t", TMC_S2GA);
  898. DRV_REPORT("otpw\t", TMC_DRV_OTPW);
  899. DRV_REPORT("ot\t", TMC_OT);
  900. #if HAS_TMC220x
  901. DRV_REPORT("157C\t", TMC_T157);
  902. DRV_REPORT("150C\t", TMC_T150);
  903. DRV_REPORT("143C\t", TMC_T143);
  904. DRV_REPORT("120C\t", TMC_T120);
  905. DRV_REPORT("s2vsa\t", TMC_S2VSA);
  906. DRV_REPORT("s2vsb\t", TMC_S2VSB);
  907. #endif
  908. DRV_REPORT("Driver registers:\n",TMC_DRV_STATUS_HEX);
  909. SERIAL_EOL();
  910. }
  911. #define PRINT_TMC_REGISTER(REG_CASE) case TMC_GET_##REG_CASE: print_hex_long(st.REG_CASE(), ':'); break
  912. #if HAS_TMCX1X0
  913. static void tmc_get_ic_registers(TMC2130Stepper &st, const TMC_get_registers_enum i) {
  914. switch (i) {
  915. PRINT_TMC_REGISTER(TCOOLTHRS);
  916. PRINT_TMC_REGISTER(THIGH);
  917. PRINT_TMC_REGISTER(COOLCONF);
  918. default: SERIAL_CHAR('\t'); break;
  919. }
  920. }
  921. #endif
  922. #if HAS_TMC220x
  923. static void tmc_get_ic_registers(TMC2208Stepper, const TMC_get_registers_enum) { SERIAL_CHAR('\t'); }
  924. #endif
  925. #if HAS_TRINAMIC_CONFIG
  926. template<class TMC>
  927. static void tmc_get_registers(TMC &st, const TMC_get_registers_enum i) {
  928. switch (i) {
  929. case TMC_AXIS_CODES: SERIAL_CHAR('\t'); st.printLabel(); break;
  930. PRINT_TMC_REGISTER(GCONF);
  931. PRINT_TMC_REGISTER(IHOLD_IRUN);
  932. PRINT_TMC_REGISTER(GSTAT);
  933. PRINT_TMC_REGISTER(IOIN);
  934. PRINT_TMC_REGISTER(TPOWERDOWN);
  935. PRINT_TMC_REGISTER(TSTEP);
  936. PRINT_TMC_REGISTER(TPWMTHRS);
  937. PRINT_TMC_REGISTER(CHOPCONF);
  938. PRINT_TMC_REGISTER(PWMCONF);
  939. PRINT_TMC_REGISTER(PWM_SCALE);
  940. PRINT_TMC_REGISTER(DRV_STATUS);
  941. default: tmc_get_ic_registers(st, i); break;
  942. }
  943. SERIAL_CHAR('\t');
  944. }
  945. #endif
  946. #if HAS_DRIVER(TMC2660)
  947. template <char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  948. static void tmc_get_registers(TMCMarlin<TMC2660Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st, const TMC_get_registers_enum i) {
  949. switch (i) {
  950. case TMC_AXIS_CODES: SERIAL_CHAR('\t'); st.printLabel(); break;
  951. PRINT_TMC_REGISTER(DRVCONF);
  952. PRINT_TMC_REGISTER(DRVCTRL);
  953. PRINT_TMC_REGISTER(CHOPCONF);
  954. PRINT_TMC_REGISTER(DRVSTATUS);
  955. PRINT_TMC_REGISTER(SGCSCONF);
  956. PRINT_TMC_REGISTER(SMARTEN);
  957. default: SERIAL_CHAR('\t'); break;
  958. }
  959. SERIAL_CHAR('\t');
  960. }
  961. #endif
  962. static void tmc_get_registers(TMC_get_registers_enum n, LOGICAL_AXIS_ARGS(const bool)) {
  963. if (x) {
  964. #if AXIS_IS_TMC(X)
  965. tmc_get_registers(stepperX, n);
  966. #endif
  967. #if AXIS_IS_TMC(X2)
  968. tmc_get_registers(stepperX2, n);
  969. #endif
  970. }
  971. if (TERN0(HAS_Y_AXIS, y)) {
  972. #if AXIS_IS_TMC(Y)
  973. tmc_get_registers(stepperY, n);
  974. #endif
  975. #if AXIS_IS_TMC(Y2)
  976. tmc_get_registers(stepperY2, n);
  977. #endif
  978. }
  979. if (TERN0(HAS_Z_AXIS, z)) {
  980. #if AXIS_IS_TMC(Z)
  981. tmc_get_registers(stepperZ, n);
  982. #endif
  983. #if AXIS_IS_TMC(Z2)
  984. tmc_get_registers(stepperZ2, n);
  985. #endif
  986. #if AXIS_IS_TMC(Z3)
  987. tmc_get_registers(stepperZ3, n);
  988. #endif
  989. #if AXIS_IS_TMC(Z4)
  990. tmc_get_registers(stepperZ4, n);
  991. #endif
  992. }
  993. #if AXIS_IS_TMC(I)
  994. if (i) tmc_get_registers(stepperI, n);
  995. #endif
  996. #if AXIS_IS_TMC(J)
  997. if (j) tmc_get_registers(stepperJ, n);
  998. #endif
  999. #if AXIS_IS_TMC(K)
  1000. if (k) tmc_get_registers(stepperK, n);
  1001. #endif
  1002. if (TERN0(HAS_EXTRUDERS, e)) {
  1003. #if AXIS_IS_TMC(E0)
  1004. tmc_get_registers(stepperE0, n);
  1005. #endif
  1006. #if AXIS_IS_TMC(E1)
  1007. tmc_get_registers(stepperE1, n);
  1008. #endif
  1009. #if AXIS_IS_TMC(E2)
  1010. tmc_get_registers(stepperE2, n);
  1011. #endif
  1012. #if AXIS_IS_TMC(E3)
  1013. tmc_get_registers(stepperE3, n);
  1014. #endif
  1015. #if AXIS_IS_TMC(E4)
  1016. tmc_get_registers(stepperE4, n);
  1017. #endif
  1018. #if AXIS_IS_TMC(E5)
  1019. tmc_get_registers(stepperE5, n);
  1020. #endif
  1021. #if AXIS_IS_TMC(E6)
  1022. tmc_get_registers(stepperE6, n);
  1023. #endif
  1024. #if AXIS_IS_TMC(E7)
  1025. tmc_get_registers(stepperE7, n);
  1026. #endif
  1027. }
  1028. SERIAL_EOL();
  1029. }
  1030. void tmc_get_registers(LOGICAL_AXIS_ARGS(bool)) {
  1031. #define _TMC_GET_REG(LABEL, ITEM) do{ SERIAL_ECHOPGM(LABEL); tmc_get_registers(ITEM, LOGICAL_AXIS_ARGS()); }while(0)
  1032. #define TMC_GET_REG(NAME, TABS) _TMC_GET_REG(STRINGIFY(NAME) TABS, TMC_GET_##NAME)
  1033. _TMC_GET_REG("\t", TMC_AXIS_CODES);
  1034. TMC_GET_REG(GCONF, "\t\t");
  1035. TMC_GET_REG(IHOLD_IRUN, "\t");
  1036. TMC_GET_REG(GSTAT, "\t\t");
  1037. TMC_GET_REG(IOIN, "\t\t");
  1038. TMC_GET_REG(TPOWERDOWN, "\t");
  1039. TMC_GET_REG(TSTEP, "\t\t");
  1040. TMC_GET_REG(TPWMTHRS, "\t");
  1041. TMC_GET_REG(TCOOLTHRS, "\t");
  1042. TMC_GET_REG(THIGH, "\t\t");
  1043. TMC_GET_REG(CHOPCONF, "\t");
  1044. TMC_GET_REG(COOLCONF, "\t");
  1045. TMC_GET_REG(PWMCONF, "\t");
  1046. TMC_GET_REG(PWM_SCALE, "\t");
  1047. TMC_GET_REG(DRV_STATUS, "\t");
  1048. }
  1049. #endif // TMC_DEBUG
  1050. #if USE_SENSORLESS
  1051. bool tmc_enable_stallguard(TMC2130Stepper &st) {
  1052. const bool stealthchop_was_enabled = st.en_pwm_mode();
  1053. st.TCOOLTHRS(0xFFFFF);
  1054. st.en_pwm_mode(false);
  1055. st.diag1_stall(true);
  1056. return stealthchop_was_enabled;
  1057. }
  1058. void tmc_disable_stallguard(TMC2130Stepper &st, const bool restore_stealth) {
  1059. st.TCOOLTHRS(0);
  1060. st.en_pwm_mode(restore_stealth);
  1061. st.diag1_stall(false);
  1062. }
  1063. bool tmc_enable_stallguard(TMC2209Stepper &st) {
  1064. const bool stealthchop_was_enabled = !st.en_spreadCycle();
  1065. st.TCOOLTHRS(0xFFFFF);
  1066. st.en_spreadCycle(false);
  1067. return stealthchop_was_enabled;
  1068. }
  1069. void tmc_disable_stallguard(TMC2209Stepper &st, const bool restore_stealth) {
  1070. st.en_spreadCycle(!restore_stealth);
  1071. st.TCOOLTHRS(0);
  1072. }
  1073. bool tmc_enable_stallguard(TMC2660Stepper) {
  1074. // TODO
  1075. return false;
  1076. }
  1077. void tmc_disable_stallguard(TMC2660Stepper, const bool) {};
  1078. #endif // USE_SENSORLESS
  1079. #if HAS_TMC_SPI
  1080. #define SET_CS_PIN(st) OUT_WRITE(st##_CS_PIN, HIGH)
  1081. void tmc_init_cs_pins() {
  1082. #if AXIS_HAS_SPI(X)
  1083. SET_CS_PIN(X);
  1084. #endif
  1085. #if AXIS_HAS_SPI(Y)
  1086. SET_CS_PIN(Y);
  1087. #endif
  1088. #if AXIS_HAS_SPI(Z)
  1089. SET_CS_PIN(Z);
  1090. #endif
  1091. #if AXIS_HAS_SPI(X2)
  1092. SET_CS_PIN(X2);
  1093. #endif
  1094. #if AXIS_HAS_SPI(Y2)
  1095. SET_CS_PIN(Y2);
  1096. #endif
  1097. #if AXIS_HAS_SPI(Z2)
  1098. SET_CS_PIN(Z2);
  1099. #endif
  1100. #if AXIS_HAS_SPI(Z3)
  1101. SET_CS_PIN(Z3);
  1102. #endif
  1103. #if AXIS_HAS_SPI(Z4)
  1104. SET_CS_PIN(Z4);
  1105. #endif
  1106. #if AXIS_HAS_SPI(I)
  1107. SET_CS_PIN(I);
  1108. #endif
  1109. #if AXIS_HAS_SPI(J)
  1110. SET_CS_PIN(J);
  1111. #endif
  1112. #if AXIS_HAS_SPI(K)
  1113. SET_CS_PIN(K);
  1114. #endif
  1115. #if AXIS_HAS_SPI(E0)
  1116. SET_CS_PIN(E0);
  1117. #endif
  1118. #if AXIS_HAS_SPI(E1)
  1119. SET_CS_PIN(E1);
  1120. #endif
  1121. #if AXIS_HAS_SPI(E2)
  1122. SET_CS_PIN(E2);
  1123. #endif
  1124. #if AXIS_HAS_SPI(E3)
  1125. SET_CS_PIN(E3);
  1126. #endif
  1127. #if AXIS_HAS_SPI(E4)
  1128. SET_CS_PIN(E4);
  1129. #endif
  1130. #if AXIS_HAS_SPI(E5)
  1131. SET_CS_PIN(E5);
  1132. #endif
  1133. #if AXIS_HAS_SPI(E6)
  1134. SET_CS_PIN(E6);
  1135. #endif
  1136. #if AXIS_HAS_SPI(E7)
  1137. SET_CS_PIN(E7);
  1138. #endif
  1139. }
  1140. #endif // HAS_TMC_SPI
  1141. template<typename TMC>
  1142. static bool test_connection(TMC &st) {
  1143. SERIAL_ECHOPGM("Testing ");
  1144. st.printLabel();
  1145. SERIAL_ECHOPGM(" connection... ");
  1146. const uint8_t test_result = st.test_connection();
  1147. if (test_result > 0) SERIAL_ECHOPGM("Error: All ");
  1148. FSTR_P stat;
  1149. switch (test_result) {
  1150. default:
  1151. case 0: stat = F("OK"); break;
  1152. case 1: stat = F("HIGH"); break;
  1153. case 2: stat = F("LOW"); break;
  1154. }
  1155. SERIAL_ECHOLNF(stat);
  1156. return test_result;
  1157. }
  1158. void test_tmc_connection(LOGICAL_AXIS_ARGS(const bool)) {
  1159. uint8_t axis_connection = 0;
  1160. if (x) {
  1161. #if AXIS_IS_TMC(X)
  1162. axis_connection += test_connection(stepperX);
  1163. #endif
  1164. #if AXIS_IS_TMC(X2)
  1165. axis_connection += test_connection(stepperX2);
  1166. #endif
  1167. }
  1168. if (TERN0(HAS_Y_AXIS, y)) {
  1169. #if AXIS_IS_TMC(Y)
  1170. axis_connection += test_connection(stepperY);
  1171. #endif
  1172. #if AXIS_IS_TMC(Y2)
  1173. axis_connection += test_connection(stepperY2);
  1174. #endif
  1175. }
  1176. if (TERN0(HAS_Z_AXIS, z)) {
  1177. #if AXIS_IS_TMC(Z)
  1178. axis_connection += test_connection(stepperZ);
  1179. #endif
  1180. #if AXIS_IS_TMC(Z2)
  1181. axis_connection += test_connection(stepperZ2);
  1182. #endif
  1183. #if AXIS_IS_TMC(Z3)
  1184. axis_connection += test_connection(stepperZ3);
  1185. #endif
  1186. #if AXIS_IS_TMC(Z4)
  1187. axis_connection += test_connection(stepperZ4);
  1188. #endif
  1189. }
  1190. #if AXIS_IS_TMC(I)
  1191. if (i) axis_connection += test_connection(stepperI);
  1192. #endif
  1193. #if AXIS_IS_TMC(J)
  1194. if (j) axis_connection += test_connection(stepperJ);
  1195. #endif
  1196. #if AXIS_IS_TMC(K)
  1197. if (k) axis_connection += test_connection(stepperK);
  1198. #endif
  1199. if (TERN0(HAS_EXTRUDERS, e)) {
  1200. #if AXIS_IS_TMC(E0)
  1201. axis_connection += test_connection(stepperE0);
  1202. #endif
  1203. #if AXIS_IS_TMC(E1)
  1204. axis_connection += test_connection(stepperE1);
  1205. #endif
  1206. #if AXIS_IS_TMC(E2)
  1207. axis_connection += test_connection(stepperE2);
  1208. #endif
  1209. #if AXIS_IS_TMC(E3)
  1210. axis_connection += test_connection(stepperE3);
  1211. #endif
  1212. #if AXIS_IS_TMC(E4)
  1213. axis_connection += test_connection(stepperE4);
  1214. #endif
  1215. #if AXIS_IS_TMC(E5)
  1216. axis_connection += test_connection(stepperE5);
  1217. #endif
  1218. #if AXIS_IS_TMC(E6)
  1219. axis_connection += test_connection(stepperE6);
  1220. #endif
  1221. #if AXIS_IS_TMC(E7)
  1222. axis_connection += test_connection(stepperE7);
  1223. #endif
  1224. }
  1225. if (axis_connection) LCD_MESSAGEPGM(MSG_ERROR_TMC);
  1226. }
  1227. #endif // HAS_TRINAMIC_CONFIG