tmc2130.cpp 20 KB

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