tmc2130.cpp 20 KB

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