tmc2130.cpp 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709
  1. #include "Marlin.h"
  2. #ifdef TMC2130
  3. #include "tmc2130.h"
  4. #include <SPI.h>
  5. #include "LiquidCrystal.h"
  6. #include "ultralcd.h"
  7. extern LiquidCrystal lcd;
  8. #define TMC2130_GCONF_NORMAL 0x00000000 // spreadCycle
  9. #define TMC2130_GCONF_SGSENS 0x00003180 // spreadCycle with stallguard (stall activates DIAG0 and DIAG1 [pushpull])
  10. #define TMC2130_GCONF_SILENT 0x00000004 // stealthChop
  11. //externals for debuging
  12. extern float current_position[4];
  13. extern void st_get_position_xy(long &x, long &y);
  14. extern long st_get_position(uint8_t axis);
  15. extern void crashdet_stop_and_save_print();
  16. extern void crashdet_stop_and_save_print2();
  17. //chipselect pins
  18. uint8_t tmc2130_cs[4] = { X_TMC2130_CS, Y_TMC2130_CS, Z_TMC2130_CS, E0_TMC2130_CS };
  19. //diag pins
  20. uint8_t tmc2130_diag[4] = { X_TMC2130_DIAG, Y_TMC2130_DIAG, Z_TMC2130_DIAG, E0_TMC2130_DIAG };
  21. //mode
  22. uint8_t tmc2130_mode = TMC2130_MODE_NORMAL;
  23. //holding currents
  24. uint8_t tmc2130_current_h[4] = TMC2130_CURRENTS_H;
  25. //running currents
  26. uint8_t tmc2130_current_r[4] = TMC2130_CURRENTS_R;
  27. //axis stalled flags
  28. uint8_t tmc2130_axis_stalled[4] = {0, 0, 0, 0};
  29. //running currents for homing
  30. uint8_t tmc2130_current_r_home[4] = {10, 10, 20, 10};
  31. //pwm_ampl
  32. uint8_t tmc2130_pwm_ampl[2] = {TMC2130_PWM_AMPL_X, TMC2130_PWM_AMPL_Y};
  33. //pwm_grad
  34. uint8_t tmc2130_pwm_grad[2] = {TMC2130_PWM_GRAD_X, TMC2130_PWM_GRAD_Y};
  35. //pwm_auto
  36. uint8_t tmc2130_pwm_auto[2] = {TMC2130_PWM_AUTO_X, TMC2130_PWM_AUTO_Y};
  37. //pwm_freq
  38. uint8_t tmc2130_pwm_freq[2] = {TMC2130_PWM_FREQ_X, TMC2130_PWM_FREQ_Y};
  39. uint8_t tmc2130_mres[4] = {0, 0, 0, 0}; //will be filed at begin of init
  40. uint8_t tmc2130_sg_thr[4] = {TMC2130_SG_THRS_X, TMC2130_SG_THRS_Y, TMC2130_SG_THRS_Z, TMC2130_SG_THRS_E};
  41. uint8_t tmc2130_sg_thr_home[4] = {3, 3, TMC2130_SG_THRS_Z, TMC2130_SG_THRS_E};
  42. uint32_t tmc2130_sg_pos[4] = {0, 0, 0, 0};
  43. uint8_t sg_homing_axes_mask = 0x00;
  44. bool tmc2130_sg_stop_on_crash = false;
  45. bool tmc2130_sg_crash = false;
  46. uint8_t tmc2130_diag_mask = 0x00;
  47. uint16_t tmc2130_sg_err[4] = {0, 0, 0, 0};
  48. uint16_t tmc2130_sg_cnt[4] = {0, 0, 0, 0};
  49. bool tmc2130_sg_change = false;
  50. bool skip_debug_msg = false;
  51. //TMC2130 registers
  52. #define TMC2130_REG_GCONF 0x00 // 17 bits
  53. #define TMC2130_REG_GSTAT 0x01 // 3 bits
  54. #define TMC2130_REG_IOIN 0x04 // 8+8 bits
  55. #define TMC2130_REG_IHOLD_IRUN 0x10 // 5+5+4 bits
  56. #define TMC2130_REG_TPOWERDOWN 0x11 // 8 bits
  57. #define TMC2130_REG_TSTEP 0x12 // 20 bits
  58. #define TMC2130_REG_TPWMTHRS 0x13 // 20 bits
  59. #define TMC2130_REG_TCOOLTHRS 0x14 // 20 bits
  60. #define TMC2130_REG_THIGH 0x15 // 20 bits
  61. #define TMC2130_REG_XDIRECT 0x2d // 32 bits
  62. #define TMC2130_REG_VDCMIN 0x33 // 23 bits
  63. #define TMC2130_REG_MSLUT0 0x60 // 32 bits
  64. #define TMC2130_REG_MSLUT1 0x61 // 32 bits
  65. #define TMC2130_REG_MSLUT2 0x62 // 32 bits
  66. #define TMC2130_REG_MSLUT3 0x63 // 32 bits
  67. #define TMC2130_REG_MSLUT4 0x64 // 32 bits
  68. #define TMC2130_REG_MSLUT5 0x65 // 32 bits
  69. #define TMC2130_REG_MSLUT6 0x66 // 32 bits
  70. #define TMC2130_REG_MSLUT7 0x67 // 32 bits
  71. #define TMC2130_REG_MSLUTSEL 0x68 // 32 bits
  72. #define TMC2130_REG_MSLUTSTART 0x69 // 8+8 bits
  73. #define TMC2130_REG_MSCNT 0x6a // 10 bits
  74. #define TMC2130_REG_MSCURACT 0x6b // 9+9 bits
  75. #define TMC2130_REG_CHOPCONF 0x6c // 32 bits
  76. #define TMC2130_REG_COOLCONF 0x6d // 25 bits
  77. #define TMC2130_REG_DCCTRL 0x6e // 24 bits
  78. #define TMC2130_REG_DRV_STATUS 0x6f // 32 bits
  79. #define TMC2130_REG_PWMCONF 0x70 // 22 bits
  80. #define TMC2130_REG_PWM_SCALE 0x71 // 8 bits
  81. #define TMC2130_REG_ENCM_CTRL 0x72 // 2 bits
  82. #define TMC2130_REG_LOST_STEPS 0x73 // 20 bits
  83. uint16_t tmc2130_rd_TSTEP(uint8_t cs);
  84. uint16_t tmc2130_rd_MSCNT(uint8_t cs);
  85. uint16_t tmc2130_rd_DRV_STATUS(uint8_t cs);
  86. void tmc2130_wr_CHOPCONF(uint8_t cs, uint8_t toff = 3, uint8_t hstrt = 4, uint8_t hend = 1, uint8_t fd3 = 0, uint8_t disfdcc = 0, uint8_t rndtf = 0, uint8_t chm = 0, uint8_t tbl = 2, uint8_t vsense = 0, uint8_t vhighfs = 0, uint8_t vhighchm = 0, uint8_t sync = 0, uint8_t mres = 0b0100, uint8_t intpol = 1, uint8_t dedge = 0, uint8_t diss2g = 0);
  87. void tmc2130_wr_PWMCONF(uint8_t cs, uint8_t pwm_ampl, uint8_t pwm_grad, uint8_t pwm_freq, uint8_t pwm_auto, uint8_t pwm_symm, uint8_t freewheel);
  88. void tmc2130_wr_TPWMTHRS(uint8_t cs, uint32_t val32);
  89. void tmc2130_wr_THIGH(uint8_t cs, uint32_t val32);
  90. uint8_t tmc2130_axis_by_cs(uint8_t cs);
  91. uint8_t tmc2130_calc_mres(uint16_t microstep_resolution);
  92. uint8_t tmc2130_wr(uint8_t cs, uint8_t addr, uint32_t wval);
  93. uint8_t tmc2130_rd(uint8_t cs, uint8_t addr, uint32_t* rval);
  94. uint8_t tmc2130_txrx(uint8_t cs, uint8_t addr, uint32_t wval, uint32_t* rval);
  95. void tmc2130_setup_chopper(uint8_t axis, uint8_t mres, uint8_t current_h, uint8_t current_r);
  96. void tmc2130_init()
  97. {
  98. tmc2130_mres[0] = tmc2130_calc_mres(TMC2130_USTEPS_XY);
  99. tmc2130_mres[1] = tmc2130_calc_mres(TMC2130_USTEPS_XY);
  100. tmc2130_mres[2] = tmc2130_calc_mres(TMC2130_USTEPS_Z);
  101. tmc2130_mres[3] = tmc2130_calc_mres(TMC2130_USTEPS_E);
  102. MYSERIAL.print("tmc2130_init mode=");
  103. MYSERIAL.println(tmc2130_mode, DEC);
  104. WRITE(X_TMC2130_CS, HIGH);
  105. WRITE(Y_TMC2130_CS, HIGH);
  106. WRITE(Z_TMC2130_CS, HIGH);
  107. WRITE(E0_TMC2130_CS, HIGH);
  108. SET_OUTPUT(X_TMC2130_CS);
  109. SET_OUTPUT(Y_TMC2130_CS);
  110. SET_OUTPUT(Z_TMC2130_CS);
  111. SET_OUTPUT(E0_TMC2130_CS);
  112. SET_INPUT(X_TMC2130_DIAG);
  113. SET_INPUT(Y_TMC2130_DIAG);
  114. SET_INPUT(Z_TMC2130_DIAG);
  115. SET_INPUT(E0_TMC2130_DIAG);
  116. SPI.begin();
  117. for (int axis = 0; axis < 2; axis++) // X Y axes
  118. {
  119. /* if (tmc2130_current_r[axis] <= 31)
  120. {
  121. tmc2130_wr_CHOPCONF(tmc2130_cs[axis], 3, 5, 1, 0, 0, 0, 0, 2, 1, 0, 0, 0, mres, TMC2130_INTPOL_XY, 0, 0);
  122. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_IHOLD_IRUN, 0x000f0000 | ((tmc2130_current_r[axis] & 0x1f) << 8) | (tmc2130_current_h[axis] & 0x1f));
  123. }
  124. else
  125. {
  126. tmc2130_wr_CHOPCONF(tmc2130_cs[axis], 3, 5, 1, 0, 0, 0, 0, 2, 0, 0, 0, 0, mres, TMC2130_INTPOL_XY, 0, 0);
  127. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_IHOLD_IRUN, 0x000f0000 | (((tmc2130_current_r[axis] >> 1) & 0x1f) << 8) | ((tmc2130_current_h[axis] >> 1) & 0x1f));
  128. }*/
  129. tmc2130_setup_chopper(axis, tmc2130_mres[axis], tmc2130_current_h[axis], tmc2130_current_r[axis]);
  130. // tmc2130_wr_CHOPCONF(tmc2130_cs[axis], 3, 5, 1, 0, 0, 0, 0, 2, 1, 0, 0, 0, mres, TMC2130_INTPOL_XY, 0, 0);
  131. // tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_IHOLD_IRUN, 0x000f0000 | ((tmc2130_current_r[axis] & 0x1f) << 8) | (tmc2130_current_h[axis] & 0x1f));
  132. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_TPOWERDOWN, 0x00000000);
  133. // tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_COOLCONF, (((uint32_t)tmc2130_sg_thr[axis]) << 16) | ((uint32_t)1 << 24));
  134. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_COOLCONF, (((uint32_t)tmc2130_sg_thr[axis]) << 16));
  135. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_TCOOLTHRS, (tmc2130_mode == TMC2130_MODE_SILENT)?0:((axis==X_AXIS)?TMC2130_TCOOLTHRS_X:TMC2130_TCOOLTHRS_Y));
  136. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, (tmc2130_mode == TMC2130_MODE_SILENT)?TMC2130_GCONF_SILENT:TMC2130_GCONF_SGSENS);
  137. tmc2130_wr_PWMCONF(tmc2130_cs[axis], tmc2130_pwm_ampl[axis], tmc2130_pwm_grad[axis], tmc2130_pwm_freq[axis], tmc2130_pwm_auto[axis], 0, 0);
  138. tmc2130_wr_TPWMTHRS(tmc2130_cs[axis], TMC2130_TPWMTHRS);
  139. //tmc2130_wr_THIGH(tmc2130_cs[axis], TMC2130_THIGH);
  140. }
  141. for (int axis = 2; axis < 3; axis++) // Z axis
  142. {
  143. // uint8_t mres = tmc2130_mres(TMC2130_USTEPS_Z);
  144. /* if (tmc2130_current_r[axis] <= 31)
  145. {
  146. tmc2130_wr_CHOPCONF(tmc2130_cs[axis], 3, 5, 1, 0, 0, 0, 0, 2, 1, 0, 0, 0, mres, TMC2130_INTPOL_Z, 0, 0);
  147. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_IHOLD_IRUN, 0x000f0000 | ((tmc2130_current_r[axis] & 0x1f) << 8) | (tmc2130_current_h[axis] & 0x1f));
  148. }
  149. else
  150. {
  151. tmc2130_wr_CHOPCONF(tmc2130_cs[axis], 3, 5, 1, 0, 0, 0, 0, 2, 0, 0, 0, 0, mres, TMC2130_INTPOL_Z, 0, 0);
  152. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_IHOLD_IRUN, 0x000f0000 | (((tmc2130_current_r[axis] >> 1) & 0x1f) << 8) | ((tmc2130_current_h[axis] >> 1) & 0x1f));
  153. }*/
  154. tmc2130_setup_chopper(axis, tmc2130_mres[axis], tmc2130_current_h[axis], tmc2130_current_r[axis]);
  155. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_TPOWERDOWN, 0x00000000);
  156. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, TMC2130_GCONF_SGSENS);
  157. }
  158. for (int axis = 3; axis < 4; axis++) // E axis
  159. {
  160. // uint8_t mres = tmc2130_mres(TMC2130_USTEPS_E);
  161. tmc2130_setup_chopper(axis, tmc2130_mres[axis], tmc2130_current_h[axis], tmc2130_current_r[axis]);
  162. // tmc2130_wr_CHOPCONF(tmc2130_cs[axis], 3, 5, 1, 0, 0, 0, 0, 2, 1, 0, 0, 0, mres, TMC2130_INTPOL_E, 0, 0);
  163. // tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_IHOLD_IRUN, 0x000f0000 | ((tmc2130_current_r[axis] & 0x1f) << 8) | (tmc2130_current_h[axis] & 0x1f));
  164. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_TPOWERDOWN, 0x00000000);
  165. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, TMC2130_GCONF_SGSENS);
  166. }
  167. tmc2130_sg_err[0] = 0;
  168. tmc2130_sg_err[1] = 0;
  169. tmc2130_sg_err[2] = 0;
  170. tmc2130_sg_err[3] = 0;
  171. tmc2130_sg_cnt[0] = 0;
  172. tmc2130_sg_cnt[1] = 0;
  173. tmc2130_sg_cnt[2] = 0;
  174. tmc2130_sg_cnt[3] = 0;
  175. }
  176. uint8_t tmc2130_sample_diag()
  177. {
  178. uint8_t mask = 0;
  179. if (READ(X_TMC2130_DIAG)) mask |= X_AXIS_MASK;
  180. if (READ(Y_TMC2130_DIAG)) mask |= Y_AXIS_MASK;
  181. if (READ(Z_TMC2130_DIAG)) mask |= Z_AXIS_MASK;
  182. if (READ(E0_TMC2130_DIAG)) mask |= E_AXIS_MASK;
  183. return mask;
  184. }
  185. void tmc2130_st_isr(uint8_t last_step_mask)
  186. {
  187. if (tmc2130_mode == TMC2130_MODE_SILENT) return;
  188. bool crash = false;
  189. uint8_t diag_mask = tmc2130_sample_diag();
  190. for (uint8_t axis = X_AXIS; axis <= E_AXIS; axis++)
  191. {
  192. uint8_t mask = (X_AXIS_MASK << axis);
  193. if (diag_mask & mask) tmc2130_sg_err[axis]++;
  194. else
  195. if (tmc2130_sg_err[axis] > 0) tmc2130_sg_err[axis]--;
  196. if (tmc2130_sg_cnt[axis] < tmc2130_sg_err[axis])
  197. {
  198. tmc2130_sg_cnt[axis] = tmc2130_sg_err[axis];
  199. tmc2130_sg_change = true;
  200. if (tmc2130_sg_err[axis] >= 64)
  201. {
  202. tmc2130_sg_err[axis] = 0;
  203. crash = true;
  204. }
  205. }
  206. // if ((diag_mask & mask)/* && !(tmc2130_diag_mask & mask)*/)
  207. // crash = true;
  208. }
  209. tmc2130_diag_mask = diag_mask;
  210. if (sg_homing_axes_mask == 0)
  211. {
  212. /* if (crash)
  213. {
  214. if (diag_mask & 0x01) tmc2130_sg_cnt[0]++;
  215. if (diag_mask & 0x02) tmc2130_sg_cnt[1]++;
  216. if (diag_mask & 0x04) tmc2130_sg_cnt[2]++;
  217. if (diag_mask & 0x08) tmc2130_sg_cnt[3]++;
  218. }*/
  219. if (tmc2130_sg_stop_on_crash && crash)
  220. {
  221. tmc2130_sg_crash = true;
  222. tmc2130_sg_stop_on_crash = false;
  223. crashdet_stop_and_save_print();
  224. }
  225. }
  226. }
  227. void tmc2130_update_sg_axis(uint8_t axis)
  228. {
  229. if (!tmc2130_axis_stalled[axis])
  230. {
  231. uint8_t cs = tmc2130_cs[axis];
  232. uint16_t tstep = tmc2130_rd_TSTEP(cs);
  233. if (tstep < TMC2130_TCOOLTHRS_Z)
  234. {
  235. long pos = st_get_position(axis);
  236. if (abs(pos - tmc2130_sg_pos[axis]) > TMC2130_SG_DELTA)
  237. {
  238. uint16_t sg = tmc2130_rd_DRV_STATUS(cs) & 0x3ff;
  239. if (sg == 0)
  240. tmc2130_axis_stalled[axis] = true;
  241. }
  242. }
  243. }
  244. }
  245. bool tmc2130_update_sg()
  246. {
  247. // uint16_t tstep = tmc2130_rd_TSTEP(tmc2130_cs[0]);
  248. // MYSERIAL.print("TSTEP_X=");
  249. // MYSERIAL.println((int)tstep);
  250. #ifdef TMC2130_SG_HOMING_SW_XY
  251. if (sg_homing_axes_mask & X_AXIS_MASK) tmc2130_update_sg_axis(X_AXIS);
  252. if (sg_homing_axes_mask & Y_AXIS_MASK) tmc2130_update_sg_axis(Y_AXIS);
  253. #endif //TMC2130_SG_HOMING_SW_XY
  254. #ifdef TMC2130_SG_HOMING_SW_Z
  255. if (sg_homing_axes_mask & Z_AXIS_MASK) tmc2130_update_sg_axis(Z_AXIS);
  256. #endif //TMC2130_SG_HOMING_SW_Z
  257. #if (defined(TMC2130_SG_HOMING) && defined(TMC2130_SG_HOMING_SW_XY))
  258. if (sg_homing_axes_mask == 0) return false;
  259. #ifdef TMC2130_DEBUG
  260. MYSERIAL.print("tmc2130_update_sg mask=0x");
  261. MYSERIAL.print((int)sg_homing_axes_mask, 16);
  262. MYSERIAL.print(" stalledX=");
  263. MYSERIAL.print((int)tmc2130_axis_stalled[0]);
  264. MYSERIAL.print(" stalledY=");
  265. MYSERIAL.println((int)tmc2130_axis_stalled[1]);
  266. #endif //TMC2130_DEBUG
  267. for (uint8_t axis = X_AXIS; axis <= Y_AXIS; axis++) //only X and Y axes
  268. {
  269. uint8_t mask = (X_AXIS_MASK << axis);
  270. if (sg_homing_axes_mask & mask)
  271. {
  272. if (!tmc2130_axis_stalled[axis])
  273. {
  274. uint8_t cs = tmc2130_cs[axis];
  275. uint16_t tstep = tmc2130_rd_TSTEP(cs);
  276. if (tstep < TMC2130_TCOOLTHRS)
  277. {
  278. long pos = st_get_position(axis);
  279. if (abs(pos - tmc2130_sg_pos[axis]) > TMC2130_SG_DELTA)
  280. {
  281. uint16_t sg = tmc2130_rd_DRV_STATUS(cs) & 0x3ff;
  282. if (sg == 0)
  283. {
  284. tmc2130_axis_stalled[axis] = true;
  285. #ifdef TMC2130_DEBUG
  286. MYSERIAL.print("tmc2130_update_sg AXIS STALLED ");
  287. MYSERIAL.println((int)axis);
  288. #endif //TMC2130_DEBUG
  289. }
  290. }
  291. }
  292. }
  293. }
  294. }
  295. return true;
  296. #endif
  297. return false;
  298. }
  299. void tmc2130_home_enter(uint8_t axes_mask)
  300. {
  301. #ifdef TMC2130_DEBUG
  302. MYSERIAL.print("tmc2130_home_enter mask=0x");
  303. MYSERIAL.println((int)axes_mask, 16);
  304. #endif //TMC2130_DEBUG
  305. #ifdef TMC2130_SG_HOMING
  306. for (uint8_t axis = X_AXIS; axis <= Z_AXIS; axis++) //X Y and Z axes
  307. {
  308. uint8_t mask = (X_AXIS_MASK << axis);
  309. uint8_t cs = tmc2130_cs[axis];
  310. if (axes_mask & mask)
  311. {
  312. sg_homing_axes_mask |= mask;
  313. tmc2130_sg_pos[axis] = st_get_position(axis);
  314. tmc2130_axis_stalled[axis] = false;
  315. //Configuration to spreadCycle
  316. tmc2130_wr(cs, TMC2130_REG_GCONF, TMC2130_GCONF_NORMAL);
  317. tmc2130_wr(cs, TMC2130_REG_COOLCONF, (((uint32_t)tmc2130_sg_thr_home[axis]) << 16));
  318. // tmc2130_wr(cs, TMC2130_REG_COOLCONF, (((uint32_t)tmc2130_sg_thr[axis]) << 16) | ((uint32_t)1 << 24));
  319. tmc2130_wr(cs, TMC2130_REG_TCOOLTHRS, (axis==X_AXIS)?TMC2130_TCOOLTHRS_X:TMC2130_TCOOLTHRS_Y);
  320. tmc2130_setup_chopper(axis, tmc2130_mres[axis], tmc2130_current_h[axis], tmc2130_current_r_home[axis]);
  321. #ifndef TMC2130_SG_HOMING_SW_XY
  322. if (mask & (X_AXIS_MASK | Y_AXIS_MASK))
  323. tmc2130_wr(cs, TMC2130_REG_GCONF, TMC2130_GCONF_SGSENS); //stallguard output DIAG1, DIAG1 = pushpull
  324. #endif //TMC2130_SG_HOMING_SW_XY
  325. }
  326. }
  327. #endif //TMC2130_SG_HOMING
  328. }
  329. void tmc2130_home_exit()
  330. {
  331. #ifdef TMC2130_DEBUG
  332. MYSERIAL.print("tmc2130_home_exit mask=0x");
  333. MYSERIAL.println((int)sg_homing_axes_mask, 16);
  334. #endif //TMC2130_DEBUG
  335. #ifdef TMC2130_SG_HOMING
  336. if (sg_homing_axes_mask)
  337. {
  338. for (uint8_t axis = X_AXIS; axis <= Z_AXIS; axis++) //X Y and Z axes
  339. {
  340. uint8_t mask = (X_AXIS_MASK << axis);
  341. if (sg_homing_axes_mask & mask & (X_AXIS_MASK | Y_AXIS_MASK))
  342. {
  343. if (tmc2130_mode == TMC2130_MODE_SILENT)
  344. {
  345. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, TMC2130_GCONF_SILENT); // Configuration back to stealthChop
  346. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_TCOOLTHRS, 0);
  347. // tmc2130_wr_PWMCONF(tmc2130_cs[i], tmc2130_pwm_ampl[i], tmc2130_pwm_grad[i], tmc2130_pwm_freq[i], tmc2130_pwm_auto[i], 0, 0);
  348. }
  349. else
  350. {
  351. #ifdef TMC2130_SG_HOMING_SW_XY
  352. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, TMC2130_GCONF_NORMAL);
  353. #else //TMC2130_SG_HOMING_SW_XY
  354. // tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, TMC2130_GCONF_NORMAL);
  355. tmc2130_setup_chopper(axis, tmc2130_mres[axis], tmc2130_current_h[axis], tmc2130_current_r[axis]);
  356. // tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_COOLCONF, (((uint32_t)tmc2130_sg_thr[axis]) << 16) | ((uint32_t)1 << 24));
  357. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_COOLCONF, (((uint32_t)tmc2130_sg_thr[axis]) << 16));
  358. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_TCOOLTHRS, (tmc2130_mode == TMC2130_MODE_SILENT)?0:((axis==X_AXIS)?TMC2130_TCOOLTHRS_X:TMC2130_TCOOLTHRS_Y));
  359. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, TMC2130_GCONF_SGSENS);
  360. #endif //TMC2130_SG_HOMING_SW_XY
  361. }
  362. }
  363. tmc2130_axis_stalled[axis] = false;
  364. }
  365. sg_homing_axes_mask = 0x00;
  366. }
  367. #endif
  368. }
  369. void tmc2130_home_pause(uint8_t axis)
  370. {
  371. if (tmc2130_mode == TMC2130_MODE_NORMAL)
  372. {
  373. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, TMC2130_GCONF_NORMAL);
  374. }
  375. }
  376. void tmc2130_home_resume(uint8_t axis)
  377. {
  378. if (tmc2130_mode == TMC2130_MODE_NORMAL)
  379. {
  380. tmc2130_wr(tmc2130_cs[axis], TMC2130_REG_GCONF, TMC2130_GCONF_SGSENS);
  381. }
  382. }
  383. void tmc2130_home_restart(uint8_t axis)
  384. {
  385. tmc2130_sg_pos[axis] = st_get_position(axis);
  386. tmc2130_axis_stalled[axis] = false;
  387. }
  388. void tmc2130_check_overtemp()
  389. {
  390. const static char TMC_OVERTEMP_MSG[] PROGMEM = "TMC DRIVER OVERTEMP ";
  391. static uint32_t checktime = 0;
  392. if (millis() - checktime > 1000 )
  393. {
  394. for (int i = 0; i < 4; i++)
  395. {
  396. uint32_t drv_status = 0;
  397. skip_debug_msg = true;
  398. tmc2130_rd(tmc2130_cs[i], TMC2130_REG_DRV_STATUS, &drv_status);
  399. if (drv_status & ((uint32_t)1 << 26))
  400. { // BIT 26 - over temp prewarning ~120C (+-20C)
  401. SERIAL_ERRORRPGM(TMC_OVERTEMP_MSG);
  402. SERIAL_ECHOLN(i);
  403. for (int j = 0; j < 4; j++)
  404. tmc2130_wr(tmc2130_cs[j], TMC2130_REG_CHOPCONF, 0x00010000);
  405. kill(TMC_OVERTEMP_MSG);
  406. }
  407. }
  408. checktime = millis();
  409. tmc2130_sg_change = true;
  410. }
  411. if (tmc2130_sg_change)
  412. {
  413. for (int i = 0; i < 4; i++)
  414. {
  415. tmc2130_sg_change = false;
  416. lcd.setCursor(0 + i*4, 3);
  417. lcd.print(itostr3(tmc2130_sg_cnt[i]));
  418. lcd.print(' ');
  419. }
  420. }
  421. }
  422. void tmc2130_setup_chopper(uint8_t axis, uint8_t mres, uint8_t current_h, uint8_t current_r)
  423. {
  424. uint8_t cs = tmc2130_cs[axis];
  425. uint8_t intpol = 1;
  426. if (current_r <= 31)
  427. {
  428. tmc2130_wr_CHOPCONF(cs, 3, 5, 1, 0, 0, 0, 0, 2, 1, 0, 0, 0, mres, intpol, 0, 0);
  429. tmc2130_wr(cs, TMC2130_REG_IHOLD_IRUN, 0x000f0000 | ((current_r & 0x1f) << 8) | (current_h & 0x1f));
  430. }
  431. else
  432. {
  433. tmc2130_wr_CHOPCONF(cs, 3, 5, 1, 0, 0, 0, 0, 2, 0, 0, 0, 0, mres, intpol, 0, 0);
  434. tmc2130_wr(cs, TMC2130_REG_IHOLD_IRUN, 0x000f0000 | (((current_r >> 1) & 0x1f) << 8) | ((current_h >> 1) & 0x1f));
  435. }
  436. }
  437. void tmc2130_set_current_h(uint8_t axis, uint8_t current)
  438. {
  439. MYSERIAL.print("tmc2130_set_current_h ");
  440. MYSERIAL.print((int)axis);
  441. MYSERIAL.print(" ");
  442. MYSERIAL.println((int)current);
  443. tmc2130_current_h[axis] = current;
  444. tmc2130_setup_chopper(axis, tmc2130_mres[axis], tmc2130_current_h[axis], tmc2130_current_r[axis]);
  445. }
  446. void tmc2130_set_current_r(uint8_t axis, uint8_t current)
  447. {
  448. MYSERIAL.print("tmc2130_set_current_r ");
  449. MYSERIAL.print((int)axis);
  450. MYSERIAL.print(" ");
  451. MYSERIAL.println((int)current);
  452. tmc2130_current_r[axis] = current;
  453. tmc2130_setup_chopper(axis, tmc2130_mres[axis], tmc2130_current_h[axis], tmc2130_current_r[axis]);
  454. }
  455. void tmc2130_print_currents()
  456. {
  457. MYSERIAL.println("tmc2130_print_currents");
  458. MYSERIAL.println("\tH\rR");
  459. MYSERIAL.print("X\t");
  460. MYSERIAL.print((int)tmc2130_current_h[0]);
  461. MYSERIAL.print("\t");
  462. MYSERIAL.println((int)tmc2130_current_r[0]);
  463. MYSERIAL.print("Y\t");
  464. MYSERIAL.print((int)tmc2130_current_h[1]);
  465. MYSERIAL.print("\t");
  466. MYSERIAL.println((int)tmc2130_current_r[1]);
  467. MYSERIAL.print("Z\t");
  468. MYSERIAL.print((int)tmc2130_current_h[2]);
  469. MYSERIAL.print("\t");
  470. MYSERIAL.println((int)tmc2130_current_r[2]);
  471. MYSERIAL.print("E\t");
  472. MYSERIAL.print((int)tmc2130_current_h[3]);
  473. MYSERIAL.print("\t");
  474. MYSERIAL.println((int)tmc2130_current_r[3]);
  475. }
  476. void tmc2130_set_pwm_ampl(uint8_t axis, uint8_t pwm_ampl)
  477. {
  478. MYSERIAL.print("tmc2130_set_pwm_ampl ");
  479. MYSERIAL.print((int)axis);
  480. MYSERIAL.print(" ");
  481. MYSERIAL.println((int)pwm_ampl);
  482. tmc2130_pwm_ampl[axis] = pwm_ampl;
  483. if (((axis == 0) || (axis == 1)) && (tmc2130_mode == TMC2130_MODE_SILENT))
  484. tmc2130_wr_PWMCONF(tmc2130_cs[axis], tmc2130_pwm_ampl[axis], tmc2130_pwm_grad[axis], tmc2130_pwm_freq[axis], tmc2130_pwm_auto[axis], 0, 0);
  485. }
  486. void tmc2130_set_pwm_grad(uint8_t axis, uint8_t pwm_grad)
  487. {
  488. MYSERIAL.print("tmc2130_set_pwm_grad ");
  489. MYSERIAL.print((int)axis);
  490. MYSERIAL.print(" ");
  491. MYSERIAL.println((int)pwm_grad);
  492. tmc2130_pwm_grad[axis] = pwm_grad;
  493. if (((axis == 0) || (axis == 1)) && (tmc2130_mode == TMC2130_MODE_SILENT))
  494. tmc2130_wr_PWMCONF(tmc2130_cs[axis], tmc2130_pwm_ampl[axis], tmc2130_pwm_grad[axis], tmc2130_pwm_freq[axis], tmc2130_pwm_auto[axis], 0, 0);
  495. }
  496. uint16_t tmc2130_rd_TSTEP(uint8_t cs)
  497. {
  498. uint32_t val32 = 0;
  499. tmc2130_rd(cs, TMC2130_REG_TSTEP, &val32);
  500. if (val32 & 0x000f0000) return 0xffff;
  501. return val32 & 0xffff;
  502. }
  503. uint16_t tmc2130_rd_MSCNT(uint8_t cs)
  504. {
  505. uint32_t val32 = 0;
  506. tmc2130_rd(cs, TMC2130_REG_MSCNT, &val32);
  507. return val32 & 0x3ff;
  508. }
  509. uint16_t tmc2130_rd_DRV_STATUS(uint8_t cs)
  510. {
  511. uint32_t val32 = 0;
  512. tmc2130_rd(cs, TMC2130_REG_DRV_STATUS, &val32);
  513. return val32;
  514. }
  515. void tmc2130_wr_CHOPCONF(uint8_t cs, uint8_t toff, uint8_t hstrt, uint8_t hend, uint8_t fd3, uint8_t disfdcc, uint8_t rndtf, uint8_t chm, uint8_t tbl, uint8_t vsense, uint8_t vhighfs, uint8_t vhighchm, uint8_t sync, uint8_t mres, uint8_t intpol, uint8_t dedge, uint8_t diss2g)
  516. {
  517. uint32_t val = 0;
  518. val |= (uint32_t)(toff & 15);
  519. val |= (uint32_t)(hstrt & 7) << 4;
  520. val |= (uint32_t)(hend & 15) << 7;
  521. val |= (uint32_t)(fd3 & 1) << 11;
  522. val |= (uint32_t)(disfdcc & 1) << 12;
  523. val |= (uint32_t)(rndtf & 1) << 13;
  524. val |= (uint32_t)(chm & 1) << 14;
  525. val |= (uint32_t)(tbl & 3) << 15;
  526. val |= (uint32_t)(vsense & 1) << 17;
  527. val |= (uint32_t)(vhighfs & 1) << 18;
  528. val |= (uint32_t)(vhighchm & 1) << 19;
  529. val |= (uint32_t)(sync & 15) << 20;
  530. val |= (uint32_t)(mres & 15) << 24;
  531. val |= (uint32_t)(intpol & 1) << 28;
  532. val |= (uint32_t)(dedge & 1) << 29;
  533. val |= (uint32_t)(diss2g & 1) << 30;
  534. tmc2130_wr(cs, TMC2130_REG_CHOPCONF, val);
  535. }
  536. //void tmc2130_wr_PWMCONF(uint8_t cs, uint8_t PWMautoScale, uint8_t PWMfreq, uint8_t PWMgrad, uint8_t PWMampl)
  537. void tmc2130_wr_PWMCONF(uint8_t cs, uint8_t pwm_ampl, uint8_t pwm_grad, uint8_t pwm_freq, uint8_t pwm_auto, uint8_t pwm_symm, uint8_t freewheel)
  538. {
  539. uint32_t val = 0;
  540. val |= (uint32_t)(pwm_ampl & 255);
  541. val |= (uint32_t)(pwm_grad & 255) << 8;
  542. val |= (uint32_t)(pwm_freq & 3) << 16;
  543. val |= (uint32_t)(pwm_auto & 1) << 18;
  544. val |= (uint32_t)(pwm_symm & 1) << 19;
  545. val |= (uint32_t)(freewheel & 3) << 20;
  546. tmc2130_wr(cs, TMC2130_REG_PWMCONF, val);
  547. // tmc2130_wr(cs, TMC2130_REG_PWMCONF, ((uint32_t)(PWMautoScale+PWMfreq) << 16) | ((uint32_t)PWMgrad << 8) | PWMampl); // TMC LJ -> For better readability changed to 0x00 and added PWMautoScale and PWMfreq
  548. }
  549. void tmc2130_wr_TPWMTHRS(uint8_t cs, uint32_t val32)
  550. {
  551. tmc2130_wr(cs, TMC2130_REG_TPWMTHRS, val32);
  552. }
  553. void tmc2130_wr_THIGH(uint8_t cs, uint32_t val32)
  554. {
  555. tmc2130_wr(cs, TMC2130_REG_THIGH, val32);
  556. }
  557. #if defined(TMC2130_DEBUG_RD) || defined(TMC2130_DEBUG_WR)
  558. uint8_t tmc2130_axis_by_cs(uint8_t cs)
  559. {
  560. switch (cs)
  561. {
  562. case X_TMC2130_CS: return 0;
  563. case Y_TMC2130_CS: return 1;
  564. case Z_TMC2130_CS: return 2;
  565. case E0_TMC2130_CS: return 3;
  566. }
  567. return -1;
  568. }
  569. #endif //TMC2130_DEBUG
  570. uint8_t tmc2130_calc_mres(uint16_t microstep_resolution)
  571. {
  572. if (microstep_resolution == 256) return 0b0000;
  573. if (microstep_resolution == 128) return 0b0001;
  574. if (microstep_resolution == 64) return 0b0010;
  575. if (microstep_resolution == 32) return 0b0011;
  576. if (microstep_resolution == 16) return 0b0100;
  577. if (microstep_resolution == 8) return 0b0101;
  578. if (microstep_resolution == 4) return 0b0110;
  579. if (microstep_resolution == 2) return 0b0111;
  580. if (microstep_resolution == 1) return 0b1000;
  581. return 0;
  582. }
  583. uint8_t tmc2130_wr(uint8_t cs, uint8_t addr, uint32_t wval)
  584. {
  585. uint8_t stat = tmc2130_txrx(cs, addr | 0x80, wval, 0);
  586. #ifdef TMC2130_DEBUG_WR
  587. MYSERIAL.print("tmc2130_wr(");
  588. MYSERIAL.print((unsigned char)tmc2130_axis_by_cs(cs), DEC);
  589. MYSERIAL.print(", 0x");
  590. MYSERIAL.print((unsigned char)addr, HEX);
  591. MYSERIAL.print(", 0x");
  592. MYSERIAL.print((unsigned long)wval, HEX);
  593. MYSERIAL.print(")=0x");
  594. MYSERIAL.println((unsigned char)stat, HEX);
  595. #endif //TMC2130_DEBUG_WR
  596. return stat;
  597. }
  598. uint8_t tmc2130_rd(uint8_t cs, uint8_t addr, uint32_t* rval)
  599. {
  600. uint32_t val32 = 0;
  601. uint8_t stat = tmc2130_txrx(cs, addr, 0x00000000, &val32);
  602. if (rval != 0) *rval = val32;
  603. #ifdef TMC2130_DEBUG_RD
  604. if (!skip_debug_msg)
  605. {
  606. MYSERIAL.print("tmc2130_rd(");
  607. MYSERIAL.print((unsigned char)tmc2130_axis_by_cs(cs), DEC);
  608. MYSERIAL.print(", 0x");
  609. MYSERIAL.print((unsigned char)addr, HEX);
  610. MYSERIAL.print(", 0x");
  611. MYSERIAL.print((unsigned long)val32, HEX);
  612. MYSERIAL.print(")=0x");
  613. MYSERIAL.println((unsigned char)stat, HEX);
  614. }
  615. skip_debug_msg = false;
  616. #endif //TMC2130_DEBUG_RD
  617. return stat;
  618. }
  619. uint8_t tmc2130_txrx(uint8_t cs, uint8_t addr, uint32_t wval, uint32_t* rval)
  620. {
  621. //datagram1 - request
  622. SPI.beginTransaction(SPISettings(4000000, MSBFIRST, SPI_MODE3));
  623. digitalWrite(cs, LOW);
  624. SPI.transfer(addr); // address
  625. SPI.transfer((wval >> 24) & 0xff); // MSB
  626. SPI.transfer((wval >> 16) & 0xff);
  627. SPI.transfer((wval >> 8) & 0xff);
  628. SPI.transfer(wval & 0xff); // LSB
  629. digitalWrite(cs, HIGH);
  630. SPI.endTransaction();
  631. //datagram2 - response
  632. SPI.beginTransaction(SPISettings(4000000, MSBFIRST, SPI_MODE3));
  633. digitalWrite(cs, LOW);
  634. uint8_t stat = SPI.transfer(0); // status
  635. uint32_t val32 = 0;
  636. val32 = SPI.transfer(0); // MSB
  637. val32 = (val32 << 8) | SPI.transfer(0);
  638. val32 = (val32 << 8) | SPI.transfer(0);
  639. val32 = (val32 << 8) | SPI.transfer(0); // LSB
  640. digitalWrite(cs, HIGH);
  641. SPI.endTransaction();
  642. if (rval != 0) *rval = val32;
  643. return stat;
  644. }
  645. #endif //TMC2130