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

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343
  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(F("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. TERN_(HAS_STEALTHCHOP, "/curr_scale")
  419. TERN_(HAS_STALLGUARD, "/mech_load")
  420. "|flags|warncount"
  421. );
  422. }
  423. #endif
  424. enum TMC_debug_enum : char {
  425. TMC_CODES,
  426. TMC_UART_ADDR,
  427. TMC_ENABLED,
  428. TMC_CURRENT,
  429. TMC_RMS_CURRENT,
  430. TMC_MAX_CURRENT,
  431. TMC_IRUN,
  432. TMC_IHOLD,
  433. TMC_GLOBAL_SCALER,
  434. TMC_CS_ACTUAL,
  435. TMC_PWM_SCALE,
  436. TMC_PWM_SCALE_SUM,
  437. TMC_PWM_SCALE_AUTO,
  438. TMC_PWM_OFS_AUTO,
  439. TMC_PWM_GRAD_AUTO,
  440. TMC_VSENSE,
  441. TMC_STEALTHCHOP,
  442. TMC_MICROSTEPS,
  443. TMC_TSTEP,
  444. TMC_TPWMTHRS,
  445. TMC_TPWMTHRS_MMS,
  446. TMC_OTPW,
  447. TMC_OTPW_TRIGGERED,
  448. TMC_TOFF,
  449. TMC_TBL,
  450. TMC_HEND,
  451. TMC_HSTRT,
  452. TMC_SGT,
  453. TMC_MSCNT,
  454. TMC_INTERPOLATE
  455. };
  456. enum TMC_drv_status_enum : char {
  457. TMC_DRV_CODES,
  458. TMC_STST,
  459. TMC_OLB,
  460. TMC_OLA,
  461. TMC_S2GB,
  462. TMC_S2GA,
  463. TMC_DRV_OTPW,
  464. TMC_OT,
  465. TMC_STALLGUARD,
  466. TMC_DRV_CS_ACTUAL,
  467. TMC_FSACTIVE,
  468. TMC_SG_RESULT,
  469. TMC_DRV_STATUS_HEX,
  470. TMC_T157,
  471. TMC_T150,
  472. TMC_T143,
  473. TMC_T120,
  474. TMC_STEALTH,
  475. TMC_S2VSB,
  476. TMC_S2VSA
  477. };
  478. enum TMC_get_registers_enum : char {
  479. TMC_AXIS_CODES,
  480. TMC_GET_GCONF,
  481. TMC_GET_IHOLD_IRUN,
  482. TMC_GET_GSTAT,
  483. TMC_GET_IOIN,
  484. TMC_GET_TPOWERDOWN,
  485. TMC_GET_TSTEP,
  486. TMC_GET_TPWMTHRS,
  487. TMC_GET_TCOOLTHRS,
  488. TMC_GET_THIGH,
  489. TMC_GET_CHOPCONF,
  490. TMC_GET_COOLCONF,
  491. TMC_GET_PWMCONF,
  492. TMC_GET_PWM_SCALE,
  493. TMC_GET_DRV_STATUS,
  494. TMC_GET_DRVCONF,
  495. TMC_GET_DRVCTRL,
  496. TMC_GET_DRVSTATUS,
  497. TMC_GET_SGCSCONF,
  498. TMC_GET_SMARTEN
  499. };
  500. template<class TMC>
  501. static void print_vsense(TMC &st) { SERIAL_ECHOF(st.vsense() ? F("1=.18") : F("0=.325")); }
  502. #if HAS_DRIVER(TMC2130) || HAS_DRIVER(TMC5130)
  503. static void _tmc_status(TMC2130Stepper &st, const TMC_debug_enum i) {
  504. switch (i) {
  505. case TMC_PWM_SCALE: SERIAL_ECHO(st.PWM_SCALE()); break;
  506. case TMC_SGT: SERIAL_ECHO(st.sgt()); break;
  507. case TMC_STEALTHCHOP: serialprint_truefalse(st.en_pwm_mode()); break;
  508. case TMC_INTERPOLATE: serialprint_truefalse(st.intpol()); break;
  509. default: break;
  510. }
  511. }
  512. #endif
  513. #if HAS_TMCX1X0
  514. static void _tmc_parse_drv_status(TMC2130Stepper &st, const TMC_drv_status_enum i) {
  515. switch (i) {
  516. case TMC_STALLGUARD: if (st.stallguard()) SERIAL_CHAR('*'); break;
  517. case TMC_SG_RESULT: SERIAL_ECHO(st.sg_result()); break;
  518. case TMC_FSACTIVE: if (st.fsactive()) SERIAL_CHAR('*'); break;
  519. case TMC_DRV_CS_ACTUAL: SERIAL_ECHO(st.cs_actual()); break;
  520. default: break;
  521. }
  522. }
  523. #endif
  524. #if HAS_DRIVER(TMC2160) || HAS_DRIVER(TMC5160)
  525. template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  526. void print_vsense(TMCMarlin<TMC2160Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &) { }
  527. template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  528. void print_vsense(TMCMarlin<TMC5160Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &) { }
  529. static void _tmc_status(TMC2160Stepper &st, const TMC_debug_enum i) {
  530. switch (i) {
  531. case TMC_PWM_SCALE: SERIAL_ECHO(st.PWM_SCALE()); break;
  532. case TMC_SGT: SERIAL_ECHO(st.sgt()); break;
  533. case TMC_STEALTHCHOP: serialprint_truefalse(st.en_pwm_mode()); break;
  534. case TMC_GLOBAL_SCALER:
  535. {
  536. uint16_t value = st.GLOBAL_SCALER();
  537. SERIAL_ECHO(value ? value : 256);
  538. SERIAL_ECHOPGM("/256");
  539. }
  540. break;
  541. case TMC_INTERPOLATE: serialprint_truefalse(st.intpol()); break;
  542. default: break;
  543. }
  544. }
  545. #endif
  546. #if HAS_TMC220x
  547. static void _tmc_status(TMC2208Stepper &st, const TMC_debug_enum i) {
  548. switch (i) {
  549. case TMC_PWM_SCALE_SUM: SERIAL_ECHO(st.pwm_scale_sum()); break;
  550. case TMC_PWM_SCALE_AUTO: SERIAL_ECHO(st.pwm_scale_auto()); break;
  551. case TMC_PWM_OFS_AUTO: SERIAL_ECHO(st.pwm_ofs_auto()); break;
  552. case TMC_PWM_GRAD_AUTO: SERIAL_ECHO(st.pwm_grad_auto()); break;
  553. case TMC_STEALTHCHOP: serialprint_truefalse(st.stealth()); break;
  554. case TMC_INTERPOLATE: serialprint_truefalse(st.intpol()); break;
  555. default: break;
  556. }
  557. }
  558. #if HAS_DRIVER(TMC2209)
  559. template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  560. static void _tmc_status(TMCMarlin<TMC2209Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st, const TMC_debug_enum i) {
  561. switch (i) {
  562. case TMC_SGT: SERIAL_ECHO(st.SGTHRS()); break;
  563. case TMC_UART_ADDR: SERIAL_ECHO(st.get_address()); break;
  564. default:
  565. TMC2208Stepper *parent = &st;
  566. _tmc_status(*parent, i);
  567. break;
  568. }
  569. }
  570. #endif
  571. static void _tmc_parse_drv_status(TMC2208Stepper &st, const TMC_drv_status_enum i) {
  572. switch (i) {
  573. case TMC_T157: if (st.t157()) SERIAL_CHAR('*'); break;
  574. case TMC_T150: if (st.t150()) SERIAL_CHAR('*'); break;
  575. case TMC_T143: if (st.t143()) SERIAL_CHAR('*'); break;
  576. case TMC_T120: if (st.t120()) SERIAL_CHAR('*'); break;
  577. case TMC_S2VSA: if (st.s2vsa()) SERIAL_CHAR('*'); break;
  578. case TMC_S2VSB: if (st.s2vsb()) SERIAL_CHAR('*'); break;
  579. case TMC_DRV_CS_ACTUAL: SERIAL_ECHO(st.cs_actual()); break;
  580. default: break;
  581. }
  582. }
  583. #if HAS_DRIVER(TMC2209)
  584. static void _tmc_parse_drv_status(TMC2209Stepper &st, const TMC_drv_status_enum i) {
  585. switch (i) {
  586. case TMC_SG_RESULT: SERIAL_ECHO(st.SG_RESULT()); break;
  587. default: _tmc_parse_drv_status(static_cast<TMC2208Stepper &>(st), i); break;
  588. }
  589. }
  590. #endif
  591. #endif
  592. #if HAS_DRIVER(TMC2660)
  593. static void _tmc_parse_drv_status(TMC2660Stepper, const TMC_drv_status_enum) { }
  594. static void _tmc_status(TMC2660Stepper &st, const TMC_debug_enum i) {
  595. switch (i) {
  596. case TMC_INTERPOLATE: serialprint_truefalse(st.intpol()); break;
  597. default: break;
  598. }
  599. }
  600. #endif
  601. template <typename TMC>
  602. static void tmc_status(TMC &st, const TMC_debug_enum i) {
  603. SERIAL_CHAR('\t');
  604. switch (i) {
  605. case TMC_CODES: st.printLabel(); break;
  606. case TMC_ENABLED: serialprint_truefalse(st.isEnabled()); break;
  607. case TMC_CURRENT: SERIAL_ECHO(st.getMilliamps()); break;
  608. case TMC_RMS_CURRENT: SERIAL_ECHO(st.rms_current()); break;
  609. case TMC_MAX_CURRENT: SERIAL_PRINT((float)st.rms_current() * 1.41, 0); break;
  610. case TMC_IRUN:
  611. SERIAL_ECHO(st.irun());
  612. SERIAL_ECHOPGM("/31");
  613. break;
  614. case TMC_IHOLD:
  615. SERIAL_ECHO(st.ihold());
  616. SERIAL_ECHOPGM("/31");
  617. break;
  618. case TMC_CS_ACTUAL:
  619. SERIAL_ECHO(st.cs_actual());
  620. SERIAL_ECHOPGM("/31");
  621. break;
  622. case TMC_VSENSE: print_vsense(st); break;
  623. case TMC_MICROSTEPS: SERIAL_ECHO(st.microsteps()); break;
  624. case TMC_TSTEP: {
  625. const uint32_t tstep_value = st.TSTEP();
  626. if (tstep_value != 0xFFFFF) SERIAL_ECHO(tstep_value); else SERIAL_ECHOPGM("max");
  627. } break;
  628. #if ENABLED(HYBRID_THRESHOLD)
  629. case TMC_TPWMTHRS: SERIAL_ECHO(uint32_t(st.TPWMTHRS())); break;
  630. case TMC_TPWMTHRS_MMS: {
  631. const uint32_t tpwmthrs_val = st.get_pwm_thrs();
  632. if (tpwmthrs_val) SERIAL_ECHO(tpwmthrs_val); else SERIAL_CHAR('-');
  633. } break;
  634. #endif
  635. case TMC_OTPW: serialprint_truefalse(st.otpw()); break;
  636. #if ENABLED(MONITOR_DRIVER_STATUS)
  637. case TMC_OTPW_TRIGGERED: serialprint_truefalse(st.getOTPW()); break;
  638. #endif
  639. case TMC_TOFF: SERIAL_ECHO(st.toff()); break;
  640. case TMC_TBL: SERIAL_ECHO(st.blank_time()); break;
  641. case TMC_HEND: SERIAL_ECHO(st.hysteresis_end()); break;
  642. case TMC_HSTRT: SERIAL_ECHO(st.hysteresis_start()); break;
  643. case TMC_MSCNT: SERIAL_ECHO(st.get_microstep_counter()); break;
  644. default: _tmc_status(st, i); break;
  645. }
  646. }
  647. #if HAS_DRIVER(TMC2660)
  648. template<char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  649. void tmc_status(TMCMarlin<TMC2660Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st, const TMC_debug_enum i) {
  650. SERIAL_CHAR('\t');
  651. switch (i) {
  652. case TMC_CODES: st.printLabel(); break;
  653. case TMC_ENABLED: serialprint_truefalse(st.isEnabled()); break;
  654. case TMC_CURRENT: SERIAL_ECHO(st.getMilliamps()); break;
  655. case TMC_RMS_CURRENT: SERIAL_ECHO(st.rms_current()); break;
  656. case TMC_MAX_CURRENT: SERIAL_PRINT((float)st.rms_current() * 1.41, 0); break;
  657. case TMC_IRUN:
  658. SERIAL_ECHO(st.cs());
  659. SERIAL_ECHOPGM("/31");
  660. break;
  661. case TMC_VSENSE: SERIAL_ECHOF(st.vsense() ? F("1=.165") : F("0=.310")); break;
  662. case TMC_MICROSTEPS: SERIAL_ECHO(st.microsteps()); break;
  663. //case TMC_OTPW: serialprint_truefalse(st.otpw()); break;
  664. //case TMC_OTPW_TRIGGERED: serialprint_truefalse(st.getOTPW()); break;
  665. case TMC_SGT: SERIAL_ECHO(st.sgt()); break;
  666. case TMC_TOFF: SERIAL_ECHO(st.toff()); break;
  667. case TMC_TBL: SERIAL_ECHO(st.blank_time()); break;
  668. case TMC_HEND: SERIAL_ECHO(st.hysteresis_end()); break;
  669. case TMC_HSTRT: SERIAL_ECHO(st.hysteresis_start()); break;
  670. default: break;
  671. }
  672. }
  673. #endif
  674. template <typename TMC>
  675. static void tmc_parse_drv_status(TMC &st, const TMC_drv_status_enum i) {
  676. SERIAL_CHAR('\t');
  677. switch (i) {
  678. case TMC_DRV_CODES: st.printLabel(); break;
  679. case TMC_STST: if (!st.stst()) SERIAL_CHAR('*'); break;
  680. case TMC_OLB: if (st.olb()) SERIAL_CHAR('*'); break;
  681. case TMC_OLA: if (st.ola()) SERIAL_CHAR('*'); break;
  682. case TMC_S2GB: if (st.s2gb()) SERIAL_CHAR('*'); break;
  683. case TMC_S2GA: if (st.s2ga()) SERIAL_CHAR('*'); break;
  684. case TMC_DRV_OTPW: if (st.otpw()) SERIAL_CHAR('*'); break;
  685. case TMC_OT: if (st.ot()) SERIAL_CHAR('*'); break;
  686. case TMC_DRV_STATUS_HEX: {
  687. const uint32_t drv_status = st.DRV_STATUS();
  688. SERIAL_CHAR('\t');
  689. st.printLabel();
  690. SERIAL_CHAR('\t');
  691. print_hex_long(drv_status, ':');
  692. if (drv_status == 0xFFFFFFFF || drv_status == 0) SERIAL_ECHOPGM("\t Bad response!");
  693. SERIAL_EOL();
  694. break;
  695. }
  696. default: _tmc_parse_drv_status(st, i); break;
  697. }
  698. }
  699. static void tmc_debug_loop(const TMC_debug_enum n, LOGICAL_AXIS_ARGS(const bool)) {
  700. if (x) {
  701. #if AXIS_IS_TMC(X)
  702. tmc_status(stepperX, n);
  703. #endif
  704. #if AXIS_IS_TMC(X2)
  705. tmc_status(stepperX2, n);
  706. #endif
  707. }
  708. if (TERN0(HAS_Y_AXIS, y)) {
  709. #if AXIS_IS_TMC(Y)
  710. tmc_status(stepperY, n);
  711. #endif
  712. #if AXIS_IS_TMC(Y2)
  713. tmc_status(stepperY2, n);
  714. #endif
  715. }
  716. if (TERN0(HAS_Z_AXIS, z)) {
  717. #if AXIS_IS_TMC(Z)
  718. tmc_status(stepperZ, n);
  719. #endif
  720. #if AXIS_IS_TMC(Z2)
  721. tmc_status(stepperZ2, n);
  722. #endif
  723. #if AXIS_IS_TMC(Z3)
  724. tmc_status(stepperZ3, n);
  725. #endif
  726. #if AXIS_IS_TMC(Z4)
  727. tmc_status(stepperZ4, n);
  728. #endif
  729. }
  730. #if AXIS_IS_TMC(I)
  731. if (i) tmc_status(stepperI, n);
  732. #endif
  733. #if AXIS_IS_TMC(J)
  734. if (j) tmc_status(stepperJ, n);
  735. #endif
  736. #if AXIS_IS_TMC(K)
  737. if (k) tmc_status(stepperK, n);
  738. #endif
  739. if (TERN0(HAS_EXTRUDERS, e)) {
  740. #if AXIS_IS_TMC(E0)
  741. tmc_status(stepperE0, n);
  742. #endif
  743. #if AXIS_IS_TMC(E1)
  744. tmc_status(stepperE1, n);
  745. #endif
  746. #if AXIS_IS_TMC(E2)
  747. tmc_status(stepperE2, n);
  748. #endif
  749. #if AXIS_IS_TMC(E3)
  750. tmc_status(stepperE3, n);
  751. #endif
  752. #if AXIS_IS_TMC(E4)
  753. tmc_status(stepperE4, n);
  754. #endif
  755. #if AXIS_IS_TMC(E5)
  756. tmc_status(stepperE5, n);
  757. #endif
  758. #if AXIS_IS_TMC(E6)
  759. tmc_status(stepperE6, n);
  760. #endif
  761. #if AXIS_IS_TMC(E7)
  762. tmc_status(stepperE7, n);
  763. #endif
  764. }
  765. SERIAL_EOL();
  766. }
  767. static void drv_status_loop(const TMC_drv_status_enum n, LOGICAL_AXIS_ARGS(const bool)) {
  768. if (x) {
  769. #if AXIS_IS_TMC(X)
  770. tmc_parse_drv_status(stepperX, n);
  771. #endif
  772. #if AXIS_IS_TMC(X2)
  773. tmc_parse_drv_status(stepperX2, n);
  774. #endif
  775. }
  776. if (TERN0(HAS_Y_AXIS, y)) {
  777. #if AXIS_IS_TMC(Y)
  778. tmc_parse_drv_status(stepperY, n);
  779. #endif
  780. #if AXIS_IS_TMC(Y2)
  781. tmc_parse_drv_status(stepperY2, n);
  782. #endif
  783. }
  784. if (TERN0(HAS_Z_AXIS, z)) {
  785. #if AXIS_IS_TMC(Z)
  786. tmc_parse_drv_status(stepperZ, n);
  787. #endif
  788. #if AXIS_IS_TMC(Z2)
  789. tmc_parse_drv_status(stepperZ2, n);
  790. #endif
  791. #if AXIS_IS_TMC(Z3)
  792. tmc_parse_drv_status(stepperZ3, n);
  793. #endif
  794. #if AXIS_IS_TMC(Z4)
  795. tmc_parse_drv_status(stepperZ4, n);
  796. #endif
  797. }
  798. #if AXIS_IS_TMC(I)
  799. if (i) tmc_parse_drv_status(stepperI, n);
  800. #endif
  801. #if AXIS_IS_TMC(J)
  802. if (j) tmc_parse_drv_status(stepperJ, n);
  803. #endif
  804. #if AXIS_IS_TMC(K)
  805. if (k) tmc_parse_drv_status(stepperK, n);
  806. #endif
  807. if (TERN0(HAS_EXTRUDERS, e)) {
  808. #if AXIS_IS_TMC(E0)
  809. tmc_parse_drv_status(stepperE0, n);
  810. #endif
  811. #if AXIS_IS_TMC(E1)
  812. tmc_parse_drv_status(stepperE1, n);
  813. #endif
  814. #if AXIS_IS_TMC(E2)
  815. tmc_parse_drv_status(stepperE2, n);
  816. #endif
  817. #if AXIS_IS_TMC(E3)
  818. tmc_parse_drv_status(stepperE3, n);
  819. #endif
  820. #if AXIS_IS_TMC(E4)
  821. tmc_parse_drv_status(stepperE4, n);
  822. #endif
  823. #if AXIS_IS_TMC(E5)
  824. tmc_parse_drv_status(stepperE5, n);
  825. #endif
  826. #if AXIS_IS_TMC(E6)
  827. tmc_parse_drv_status(stepperE6, n);
  828. #endif
  829. #if AXIS_IS_TMC(E7)
  830. tmc_parse_drv_status(stepperE7, n);
  831. #endif
  832. }
  833. SERIAL_EOL();
  834. }
  835. /**
  836. * M122 report functions
  837. */
  838. void tmc_report_all(LOGICAL_AXIS_ARGS(const bool)) {
  839. #define TMC_REPORT(LABEL, ITEM) do{ SERIAL_ECHOPGM(LABEL); tmc_debug_loop(ITEM, LOGICAL_AXIS_ARGS()); }while(0)
  840. #define DRV_REPORT(LABEL, ITEM) do{ SERIAL_ECHOPGM(LABEL); drv_status_loop(ITEM, LOGICAL_AXIS_ARGS()); }while(0)
  841. TMC_REPORT("\t", TMC_CODES);
  842. #if HAS_DRIVER(TMC2209)
  843. TMC_REPORT("Address\t", TMC_UART_ADDR);
  844. #endif
  845. TMC_REPORT("Enabled\t", TMC_ENABLED);
  846. TMC_REPORT("Set current", TMC_CURRENT);
  847. TMC_REPORT("RMS current", TMC_RMS_CURRENT);
  848. TMC_REPORT("MAX current", TMC_MAX_CURRENT);
  849. TMC_REPORT("Run current", TMC_IRUN);
  850. TMC_REPORT("Hold current", TMC_IHOLD);
  851. #if HAS_DRIVER(TMC2160) || HAS_DRIVER(TMC5160)
  852. TMC_REPORT("Global scaler", TMC_GLOBAL_SCALER);
  853. #endif
  854. TMC_REPORT("CS actual", TMC_CS_ACTUAL);
  855. TMC_REPORT("PWM scale", TMC_PWM_SCALE);
  856. #if HAS_DRIVER(TMC2130) || HAS_DRIVER(TMC2224) || HAS_DRIVER(TMC2660) || HAS_TMC220x
  857. TMC_REPORT("vsense\t", TMC_VSENSE);
  858. #endif
  859. TMC_REPORT("stealthChop", TMC_STEALTHCHOP);
  860. TMC_REPORT("msteps\t", TMC_MICROSTEPS);
  861. TMC_REPORT("interp\t", TMC_INTERPOLATE);
  862. TMC_REPORT("tstep\t", TMC_TSTEP);
  863. TMC_REPORT("PWM thresh.", TMC_TPWMTHRS);
  864. TMC_REPORT("[mm/s]\t", TMC_TPWMTHRS_MMS);
  865. TMC_REPORT("OT prewarn", TMC_OTPW);
  866. #if ENABLED(MONITOR_DRIVER_STATUS)
  867. TMC_REPORT("triggered\n OTP\t", TMC_OTPW_TRIGGERED);
  868. #endif
  869. #if HAS_TMC220x
  870. TMC_REPORT("pwm scale sum", TMC_PWM_SCALE_SUM);
  871. TMC_REPORT("pwm scale auto", TMC_PWM_SCALE_AUTO);
  872. TMC_REPORT("pwm offset auto", TMC_PWM_OFS_AUTO);
  873. TMC_REPORT("pwm grad auto", TMC_PWM_GRAD_AUTO);
  874. #endif
  875. TMC_REPORT("off time", TMC_TOFF);
  876. TMC_REPORT("blank time", TMC_TBL);
  877. TMC_REPORT("hysteresis\n -end\t", TMC_HEND);
  878. TMC_REPORT(" -start\t", TMC_HSTRT);
  879. TMC_REPORT("Stallguard thrs", TMC_SGT);
  880. TMC_REPORT("uStep count", TMC_MSCNT);
  881. DRV_REPORT("DRVSTATUS", TMC_DRV_CODES);
  882. #if HAS_TMCX1X0 || HAS_TMC220x
  883. DRV_REPORT("sg_result", TMC_SG_RESULT);
  884. #endif
  885. #if HAS_TMCX1X0
  886. DRV_REPORT("stallguard", TMC_STALLGUARD);
  887. DRV_REPORT("fsactive", TMC_FSACTIVE);
  888. #endif
  889. DRV_REPORT("stst\t", TMC_STST);
  890. DRV_REPORT("olb\t", TMC_OLB);
  891. DRV_REPORT("ola\t", TMC_OLA);
  892. DRV_REPORT("s2gb\t", TMC_S2GB);
  893. DRV_REPORT("s2ga\t", TMC_S2GA);
  894. DRV_REPORT("otpw\t", TMC_DRV_OTPW);
  895. DRV_REPORT("ot\t", TMC_OT);
  896. #if HAS_TMC220x
  897. DRV_REPORT("157C\t", TMC_T157);
  898. DRV_REPORT("150C\t", TMC_T150);
  899. DRV_REPORT("143C\t", TMC_T143);
  900. DRV_REPORT("120C\t", TMC_T120);
  901. DRV_REPORT("s2vsa\t", TMC_S2VSA);
  902. DRV_REPORT("s2vsb\t", TMC_S2VSB);
  903. #endif
  904. DRV_REPORT("Driver registers:\n",TMC_DRV_STATUS_HEX);
  905. SERIAL_EOL();
  906. }
  907. #define PRINT_TMC_REGISTER(REG_CASE) case TMC_GET_##REG_CASE: print_hex_long(st.REG_CASE(), ':'); break
  908. #if HAS_TMCX1X0
  909. static void tmc_get_ic_registers(TMC2130Stepper &st, const TMC_get_registers_enum i) {
  910. switch (i) {
  911. PRINT_TMC_REGISTER(TCOOLTHRS);
  912. PRINT_TMC_REGISTER(THIGH);
  913. PRINT_TMC_REGISTER(COOLCONF);
  914. default: SERIAL_CHAR('\t'); break;
  915. }
  916. }
  917. #endif
  918. #if HAS_TMC220x
  919. static void tmc_get_ic_registers(TMC2208Stepper, const TMC_get_registers_enum) { SERIAL_CHAR('\t'); }
  920. #endif
  921. #if HAS_TRINAMIC_CONFIG
  922. template<class TMC>
  923. static void tmc_get_registers(TMC &st, const TMC_get_registers_enum i) {
  924. switch (i) {
  925. case TMC_AXIS_CODES: SERIAL_CHAR('\t'); st.printLabel(); break;
  926. PRINT_TMC_REGISTER(GCONF);
  927. PRINT_TMC_REGISTER(IHOLD_IRUN);
  928. PRINT_TMC_REGISTER(GSTAT);
  929. PRINT_TMC_REGISTER(IOIN);
  930. PRINT_TMC_REGISTER(TPOWERDOWN);
  931. PRINT_TMC_REGISTER(TSTEP);
  932. PRINT_TMC_REGISTER(TPWMTHRS);
  933. PRINT_TMC_REGISTER(CHOPCONF);
  934. PRINT_TMC_REGISTER(PWMCONF);
  935. PRINT_TMC_REGISTER(PWM_SCALE);
  936. PRINT_TMC_REGISTER(DRV_STATUS);
  937. default: tmc_get_ic_registers(st, i); break;
  938. }
  939. SERIAL_CHAR('\t');
  940. }
  941. #endif
  942. #if HAS_DRIVER(TMC2660)
  943. template <char AXIS_LETTER, char DRIVER_ID, AxisEnum AXIS_ID>
  944. static void tmc_get_registers(TMCMarlin<TMC2660Stepper, AXIS_LETTER, DRIVER_ID, AXIS_ID> &st, const TMC_get_registers_enum i) {
  945. switch (i) {
  946. case TMC_AXIS_CODES: SERIAL_CHAR('\t'); st.printLabel(); break;
  947. PRINT_TMC_REGISTER(DRVCONF);
  948. PRINT_TMC_REGISTER(DRVCTRL);
  949. PRINT_TMC_REGISTER(CHOPCONF);
  950. PRINT_TMC_REGISTER(DRVSTATUS);
  951. PRINT_TMC_REGISTER(SGCSCONF);
  952. PRINT_TMC_REGISTER(SMARTEN);
  953. default: SERIAL_CHAR('\t'); break;
  954. }
  955. SERIAL_CHAR('\t');
  956. }
  957. #endif
  958. static void tmc_get_registers(TMC_get_registers_enum n, LOGICAL_AXIS_ARGS(const bool)) {
  959. if (x) {
  960. #if AXIS_IS_TMC(X)
  961. tmc_get_registers(stepperX, n);
  962. #endif
  963. #if AXIS_IS_TMC(X2)
  964. tmc_get_registers(stepperX2, n);
  965. #endif
  966. }
  967. if (TERN0(HAS_Y_AXIS, y)) {
  968. #if AXIS_IS_TMC(Y)
  969. tmc_get_registers(stepperY, n);
  970. #endif
  971. #if AXIS_IS_TMC(Y2)
  972. tmc_get_registers(stepperY2, n);
  973. #endif
  974. }
  975. if (TERN0(HAS_Z_AXIS, z)) {
  976. #if AXIS_IS_TMC(Z)
  977. tmc_get_registers(stepperZ, n);
  978. #endif
  979. #if AXIS_IS_TMC(Z2)
  980. tmc_get_registers(stepperZ2, n);
  981. #endif
  982. #if AXIS_IS_TMC(Z3)
  983. tmc_get_registers(stepperZ3, n);
  984. #endif
  985. #if AXIS_IS_TMC(Z4)
  986. tmc_get_registers(stepperZ4, n);
  987. #endif
  988. }
  989. #if AXIS_IS_TMC(I)
  990. if (i) tmc_get_registers(stepperI, n);
  991. #endif
  992. #if AXIS_IS_TMC(J)
  993. if (j) tmc_get_registers(stepperJ, n);
  994. #endif
  995. #if AXIS_IS_TMC(K)
  996. if (k) tmc_get_registers(stepperK, n);
  997. #endif
  998. if (TERN0(HAS_EXTRUDERS, e)) {
  999. #if AXIS_IS_TMC(E0)
  1000. tmc_get_registers(stepperE0, n);
  1001. #endif
  1002. #if AXIS_IS_TMC(E1)
  1003. tmc_get_registers(stepperE1, n);
  1004. #endif
  1005. #if AXIS_IS_TMC(E2)
  1006. tmc_get_registers(stepperE2, n);
  1007. #endif
  1008. #if AXIS_IS_TMC(E3)
  1009. tmc_get_registers(stepperE3, n);
  1010. #endif
  1011. #if AXIS_IS_TMC(E4)
  1012. tmc_get_registers(stepperE4, n);
  1013. #endif
  1014. #if AXIS_IS_TMC(E5)
  1015. tmc_get_registers(stepperE5, n);
  1016. #endif
  1017. #if AXIS_IS_TMC(E6)
  1018. tmc_get_registers(stepperE6, n);
  1019. #endif
  1020. #if AXIS_IS_TMC(E7)
  1021. tmc_get_registers(stepperE7, n);
  1022. #endif
  1023. }
  1024. SERIAL_EOL();
  1025. }
  1026. void tmc_get_registers(LOGICAL_AXIS_ARGS(bool)) {
  1027. #define _TMC_GET_REG(LABEL, ITEM) do{ SERIAL_ECHOPGM(LABEL); tmc_get_registers(ITEM, LOGICAL_AXIS_ARGS()); }while(0)
  1028. #define TMC_GET_REG(NAME, TABS) _TMC_GET_REG(STRINGIFY(NAME) TABS, TMC_GET_##NAME)
  1029. _TMC_GET_REG("\t", TMC_AXIS_CODES);
  1030. TMC_GET_REG(GCONF, "\t\t");
  1031. TMC_GET_REG(IHOLD_IRUN, "\t");
  1032. TMC_GET_REG(GSTAT, "\t\t");
  1033. TMC_GET_REG(IOIN, "\t\t");
  1034. TMC_GET_REG(TPOWERDOWN, "\t");
  1035. TMC_GET_REG(TSTEP, "\t\t");
  1036. TMC_GET_REG(TPWMTHRS, "\t");
  1037. TMC_GET_REG(TCOOLTHRS, "\t");
  1038. TMC_GET_REG(THIGH, "\t\t");
  1039. TMC_GET_REG(CHOPCONF, "\t");
  1040. TMC_GET_REG(COOLCONF, "\t");
  1041. TMC_GET_REG(PWMCONF, "\t");
  1042. TMC_GET_REG(PWM_SCALE, "\t");
  1043. TMC_GET_REG(DRV_STATUS, "\t");
  1044. }
  1045. #endif // TMC_DEBUG
  1046. #if USE_SENSORLESS
  1047. bool tmc_enable_stallguard(TMC2130Stepper &st) {
  1048. const bool stealthchop_was_enabled = st.en_pwm_mode();
  1049. st.TCOOLTHRS(0xFFFFF);
  1050. st.en_pwm_mode(false);
  1051. st.diag1_stall(true);
  1052. return stealthchop_was_enabled;
  1053. }
  1054. void tmc_disable_stallguard(TMC2130Stepper &st, const bool restore_stealth) {
  1055. st.TCOOLTHRS(0);
  1056. st.en_pwm_mode(restore_stealth);
  1057. st.diag1_stall(false);
  1058. }
  1059. bool tmc_enable_stallguard(TMC2209Stepper &st) {
  1060. const bool stealthchop_was_enabled = !st.en_spreadCycle();
  1061. st.TCOOLTHRS(0xFFFFF);
  1062. st.en_spreadCycle(false);
  1063. return stealthchop_was_enabled;
  1064. }
  1065. void tmc_disable_stallguard(TMC2209Stepper &st, const bool restore_stealth) {
  1066. st.en_spreadCycle(!restore_stealth);
  1067. st.TCOOLTHRS(0);
  1068. }
  1069. bool tmc_enable_stallguard(TMC2660Stepper) {
  1070. // TODO
  1071. return false;
  1072. }
  1073. void tmc_disable_stallguard(TMC2660Stepper, const bool) {};
  1074. #endif // USE_SENSORLESS
  1075. #if HAS_TMC_SPI
  1076. #define SET_CS_PIN(st) OUT_WRITE(st##_CS_PIN, HIGH)
  1077. void tmc_init_cs_pins() {
  1078. #if AXIS_HAS_SPI(X)
  1079. SET_CS_PIN(X);
  1080. #endif
  1081. #if AXIS_HAS_SPI(Y)
  1082. SET_CS_PIN(Y);
  1083. #endif
  1084. #if AXIS_HAS_SPI(Z)
  1085. SET_CS_PIN(Z);
  1086. #endif
  1087. #if AXIS_HAS_SPI(X2)
  1088. SET_CS_PIN(X2);
  1089. #endif
  1090. #if AXIS_HAS_SPI(Y2)
  1091. SET_CS_PIN(Y2);
  1092. #endif
  1093. #if AXIS_HAS_SPI(Z2)
  1094. SET_CS_PIN(Z2);
  1095. #endif
  1096. #if AXIS_HAS_SPI(Z3)
  1097. SET_CS_PIN(Z3);
  1098. #endif
  1099. #if AXIS_HAS_SPI(Z4)
  1100. SET_CS_PIN(Z4);
  1101. #endif
  1102. #if AXIS_HAS_SPI(I)
  1103. SET_CS_PIN(I);
  1104. #endif
  1105. #if AXIS_HAS_SPI(J)
  1106. SET_CS_PIN(J);
  1107. #endif
  1108. #if AXIS_HAS_SPI(K)
  1109. SET_CS_PIN(K);
  1110. #endif
  1111. #if AXIS_HAS_SPI(E0)
  1112. SET_CS_PIN(E0);
  1113. #endif
  1114. #if AXIS_HAS_SPI(E1)
  1115. SET_CS_PIN(E1);
  1116. #endif
  1117. #if AXIS_HAS_SPI(E2)
  1118. SET_CS_PIN(E2);
  1119. #endif
  1120. #if AXIS_HAS_SPI(E3)
  1121. SET_CS_PIN(E3);
  1122. #endif
  1123. #if AXIS_HAS_SPI(E4)
  1124. SET_CS_PIN(E4);
  1125. #endif
  1126. #if AXIS_HAS_SPI(E5)
  1127. SET_CS_PIN(E5);
  1128. #endif
  1129. #if AXIS_HAS_SPI(E6)
  1130. SET_CS_PIN(E6);
  1131. #endif
  1132. #if AXIS_HAS_SPI(E7)
  1133. SET_CS_PIN(E7);
  1134. #endif
  1135. }
  1136. #endif // HAS_TMC_SPI
  1137. template<typename TMC>
  1138. static bool test_connection(TMC &st) {
  1139. SERIAL_ECHOPGM("Testing ");
  1140. st.printLabel();
  1141. SERIAL_ECHOPGM(" connection... ");
  1142. const uint8_t test_result = st.test_connection();
  1143. if (test_result > 0) SERIAL_ECHOPGM("Error: All ");
  1144. FSTR_P stat;
  1145. switch (test_result) {
  1146. default:
  1147. case 0: stat = F("OK"); break;
  1148. case 1: stat = F("HIGH"); break;
  1149. case 2: stat = F("LOW"); break;
  1150. }
  1151. SERIAL_ECHOLNF(stat);
  1152. return test_result;
  1153. }
  1154. void test_tmc_connection(LOGICAL_AXIS_ARGS(const bool)) {
  1155. uint8_t axis_connection = 0;
  1156. if (x) {
  1157. #if AXIS_IS_TMC(X)
  1158. axis_connection += test_connection(stepperX);
  1159. #endif
  1160. #if AXIS_IS_TMC(X2)
  1161. axis_connection += test_connection(stepperX2);
  1162. #endif
  1163. }
  1164. if (TERN0(HAS_Y_AXIS, y)) {
  1165. #if AXIS_IS_TMC(Y)
  1166. axis_connection += test_connection(stepperY);
  1167. #endif
  1168. #if AXIS_IS_TMC(Y2)
  1169. axis_connection += test_connection(stepperY2);
  1170. #endif
  1171. }
  1172. if (TERN0(HAS_Z_AXIS, z)) {
  1173. #if AXIS_IS_TMC(Z)
  1174. axis_connection += test_connection(stepperZ);
  1175. #endif
  1176. #if AXIS_IS_TMC(Z2)
  1177. axis_connection += test_connection(stepperZ2);
  1178. #endif
  1179. #if AXIS_IS_TMC(Z3)
  1180. axis_connection += test_connection(stepperZ3);
  1181. #endif
  1182. #if AXIS_IS_TMC(Z4)
  1183. axis_connection += test_connection(stepperZ4);
  1184. #endif
  1185. }
  1186. #if AXIS_IS_TMC(I)
  1187. if (i) axis_connection += test_connection(stepperI);
  1188. #endif
  1189. #if AXIS_IS_TMC(J)
  1190. if (j) axis_connection += test_connection(stepperJ);
  1191. #endif
  1192. #if AXIS_IS_TMC(K)
  1193. if (k) axis_connection += test_connection(stepperK);
  1194. #endif
  1195. if (TERN0(HAS_EXTRUDERS, e)) {
  1196. #if AXIS_IS_TMC(E0)
  1197. axis_connection += test_connection(stepperE0);
  1198. #endif
  1199. #if AXIS_IS_TMC(E1)
  1200. axis_connection += test_connection(stepperE1);
  1201. #endif
  1202. #if AXIS_IS_TMC(E2)
  1203. axis_connection += test_connection(stepperE2);
  1204. #endif
  1205. #if AXIS_IS_TMC(E3)
  1206. axis_connection += test_connection(stepperE3);
  1207. #endif
  1208. #if AXIS_IS_TMC(E4)
  1209. axis_connection += test_connection(stepperE4);
  1210. #endif
  1211. #if AXIS_IS_TMC(E5)
  1212. axis_connection += test_connection(stepperE5);
  1213. #endif
  1214. #if AXIS_IS_TMC(E6)
  1215. axis_connection += test_connection(stepperE6);
  1216. #endif
  1217. #if AXIS_IS_TMC(E7)
  1218. axis_connection += test_connection(stepperE7);
  1219. #endif
  1220. }
  1221. if (axis_connection) LCD_MESSAGE(MSG_ERROR_TMC);
  1222. }
  1223. #endif // HAS_TRINAMIC_CONFIG