silentstep2  2.1.0.0
silentstep2.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef SILENTSTEP2_H
29 #define SILENTSTEP2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 #include "drv_spi_master.h"
49 #include "spi_specifics.h"
50 
71 #define SILENTSTEP2_REG_GCONF 0x00
72 #define SILENTSTEP2_REG_GSTAT 0x01
73 #define SILENTSTEP2_REG_IOIN 0x04
74 #define SILENTSTEP2_REG_IHOLD_IRUN 0x10
75 #define SILENTSTEP2_REG_TPOWERDOWN 0x11
76 #define SILENTSTEP2_REG_TSTEP 0x12
77 #define SILENTSTEP2_REG_TPWMTHRS 0x13
78 #define SILENTSTEP2_REG_TCOOLTHRS 0x14
79 #define SILENTSTEP2_REG_THIGH 0x15
80 #define SILENTSTEP2_REG_XDIRECT 0x2D
81 #define SILENTSTEP2_REG_VDCMIN 0x33
82 #define SILENTSTEP2_REG_MSLUT0 0x60
83 #define SILENTSTEP2_REG_MSLUT1 0x61
84 #define SILENTSTEP2_REG_MSLUT2 0x62
85 #define SILENTSTEP2_REG_MSLUT3 0x63
86 #define SILENTSTEP2_REG_MSLUT4 0x64
87 #define SILENTSTEP2_REG_MSLUT5 0x65
88 #define SILENTSTEP2_REG_MSLUT6 0x66
89 #define SILENTSTEP2_REG_MSLUT7 0x67
90 #define SILENTSTEP2_REG_MSLUTSEL 0x68
91 #define SILENTSTEP2_REG_MSLUTSTART 0x69
92 #define SILENTSTEP2_REG_MSCNT 0x6A
93 #define SILENTSTEP2_REG_MSCURACT 0x6B
94 #define SILENTSTEP2_REG_CHOPCONF 0x6C
95 #define SILENTSTEP2_REG_COOLCONF 0x6D
96 #define SILENTSTEP2_REG_DCCTRL 0x6E
97 #define SILENTSTEP2_REG_DRV_STATUS 0x6F
98 #define SILENTSTEP2_REG_PWMCONF 0x70
99 #define SILENTSTEP2_REG_PWM_SCALE 0x71
100 #define SILENTSTEP2_REG_ENCM_CTRL 0x72
101 #define SILENTSTEP2_REG_LOST_STEPS 0x73
102 #define SILENTSTEP2_REG_EXP_IN_PORT 0x00
103 #define SILENTSTEP2_REG_EXP_OUT_PORT 0x01
104 #define SILENTSTEP2_REG_EXP_POL_INV 0x02
105 #define SILENTSTEP2_REG_EXP_CONFIG 0x03
106  // silentstep2_reg
108 
123 #define SILENTSTEP2_GSTAT_RESET 0x00000001ul
124 #define SILENTSTEP2_GSTAT_DRV_ERR 0x00000002ul
125 #define SILENTSTEP2_GSTAT_UV_CP 0x00000004ul
126 
131 #define SILENTSTEP2_GCONF_I_SC_AN_OP_NORMAL 0x00
132 #define SILENTSTEP2_GCONF_I_SC_AN_AIN 0x01
133 #define SILENTSTEP2_GCONF_INT_RSE_OP_NORMAL 0x00
134 #define SILENTSTEP2_GCONF_INT_RSE_INT_RSE 0x01
135 #define SILENTSTEP2_GCONF_DISABLE 0x00
136 #define SILENTSTEP2_GCONF_ENABLE 0x01
137 
142 #define SILENTSTEP2_THIGH_DEFAULT 0x00000300ul
143 #define SILENTSTEP2_THIGH_MAX 0x000FFFFFul
144 
151 #define SILENTSTEP2_TCOOLTHRS_DEFAULT 0x00002700ul
152 #define SILENTSTEP2_TCOOLTHRS_MAX 0x000FFFFFul
153 
160 #define SILENTSTEP2_CHOPCONF_SEMIN_0 0x00
161 #define SILENTSTEP2_CHOPCONF_SEMIN_BIT_MASK 0x0F
162 #define SILENTSTEP2_CHOPCONF_SEUP_1 0x00
163 #define SILENTSTEP2_CHOPCONF_SEUP_2 0x01
164 #define SILENTSTEP2_CHOPCONF_SEUP_3 0x02
165 #define SILENTSTEP2_CHOPCONF_SEUP_8 0x03
166 #define SILENTSTEP2_CHOPCONF_SEMAX_0 0x00
167 #define SILENTSTEP2_CHOPCONF_SEMAX_BIT_MASK 0x0F
168 #define SILENTSTEP2_CHOPCONF_SEDN_32 0x00
169 #define SILENTSTEP2_CHOPCONF_SEDN_8 0x01
170 #define SILENTSTEP2_CHOPCONF_SEDN_2 0x02
171 #define SILENTSTEP2_CHOPCONF_SEDN_1 0x03
172 #define SILENTSTEP2_CHOPCONF_SEIMIN_1_2 0x00
173 #define SILENTSTEP2_CHOPCONF_SEIMIN_1_4 0x01
174 #define SILENTSTEP2_CHOPCONF_SGT_M64 0x00
175 #define SILENTSTEP2_CHOPCONF_SGT_P64 0x7F
176 #define SILENTSTEP2_CHOPCONF_SFILT_MODE_STD 0x00
177 #define SILENTSTEP2_CHOPCONF_SFILT_MODE_FLTR 0x01
178 
185 #define SILENTSTEP2_IHOLD_10_32 0x0A
186 #define SILENTSTEP2_IHOLD_BIT_MASK 0x1F
187 #define SILENTSTEP2_IRUN_10_32 0x0A
188 #define SILENTSTEP2_IRUN_BIT_MASK 0x1F
189 #define SILENTSTEP2_IHOLDDELAY_PWR_DOWN 0x00
190 #define SILENTSTEP2_IHOLDDELAY_32 0x05
191 #define SILENTSTEP2_IHOLDDELAY_BIT_MASK 0x0F
192 
197 #define SILENTSTEP2_TOFF_DIS 0x00
198 #define SILENTSTEP2_TOFF_NCLK_140 0x04
199 #define SILENTSTEP2_TOFF_BIT_MASK 0x0F
200 
205 #define SILENTSTEP2_STEP_SPEED_MIN 1
206 #define SILENTSTEP2_STEP_SPEED_MAX 100
207 #define SILENTSTEP2_ANGLE_360_DEGREES 360.0f
208 
213 #define SILENTSTEP2_CHOPCONF_CHM_MODE_STND 0x00
214 #define SILENTSTEP2_CHOPCONF_CHM_CONST_OFF_TIME 0x01
215 #define SILENTSTEP2_CHOPCONF_CHM_BIT_MASK 0x00004000ul
216 #define SILENTSTEP2_CHOPCONF_HE_OS_M3 0x00
217 #define SILENTSTEP2_CHOPCONF_HE_OS_M2 0x01
218 #define SILENTSTEP2_CHOPCONF_HE_OS_M1 0x02
219 #define SILENTSTEP2_CHOPCONF_HE_OS_0 0x03
220 #define SILENTSTEP2_CHOPCONF_HE_OS_1 0x04
221 #define SILENTSTEP2_CHOPCONF_HE_OS_2 0x05
222 #define SILENTSTEP2_CHOPCONF_HE_OS_3 0x06
223 #define SILENTSTEP2_CHOPCONF_HE_OS_4 0x07
224 #define SILENTSTEP2_CHOPCONF_HE_OS_5 0x08
225 #define SILENTSTEP2_CHOPCONF_HE_OS_6 0x09
226 #define SILENTSTEP2_CHOPCONF_HE_OS_7 0x0A
227 #define SILENTSTEP2_CHOPCONF_HE_OS_8 0x0B
228 #define SILENTSTEP2_CHOPCONF_HE_OS_9 0x0C
229 #define SILENTSTEP2_CHOPCONF_HE_OS_10 0x0D
230 #define SILENTSTEP2_CHOPCONF_HE_OS_11 0x0E
231 #define SILENTSTEP2_CHOPCONF_HE_OS_12 0x0F
232 #define SILENTSTEP2_CHOPCONF_HE_OS_BIT_MASK 0x00000780ul
233 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_0 0x00
234 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_1 0x01
235 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_2 0x02
236 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_3 0x03
237 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_4 0x04
238 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_5 0x05
239 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_6 0x06
240 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_7 0x07
241 #define SILENTSTEP2_CHOPCONF_HSTRT_TFD_BIT_MASK 0x00000070ul
242 
247 #define SILENTSTEP2_MSLUT_SEL_0 0x00
248 #define SILENTSTEP2_MSLUT_SEL_1 0x01
249 #define SILENTSTEP2_MSLUT_SEL_2 0x02
250 #define SILENTSTEP2_MSLUT_SEL_3 0x03
251 #define SILENTSTEP2_MSLUT_SEL_4 0x04
252 #define SILENTSTEP2_MSLUT_SEL_5 0x05
253 #define SILENTSTEP2_MSLUT_SEL_6 0x06
254 #define SILENTSTEP2_MSLUT_SEL_7 0x07
255 #define SILENTSTEP2_MSLUTSEL_WIDTH_BIT_MASK 0x000000FFul
256 #define SILENTSTEP2_MSLUTSEL_SEG_BIT_MASK 0x00FFFFFFul
257 
262 #define SILENTSTEP2_MSLUTSTART_SIN_BIT_MASK 0x000000FFul
263 #define SILENTSTEP2_MSLUTSTART_SIN90_BIT_MASK 0x000000FFul
264 
269 #define SILENTSTEP2_CHOPCONF_MRES_BIT_MASK 0xF0FFFFFFul
270 #define SILENTSTEP2_CHOPCONF_DEDGE_BIT_MASK 0xDFFFFFFFul
271 #define SILENTSTEP2_CHOPCONF_INTPOL_BIT_MASK 0xEFFFFFFFul
272 #define SILENTSTEP2_CHOPCONF_TBL_BIT_MASK 0xFFFE7FFFul
273 #define SILENTSTEP2_CHOPCONF_TOFF_BIT_MASK 0xFFFFFFF0ul
274 
279 #define SILENTSTEP2_PIN_NONE 0x00
280 #define SILENTSTEP2_PIN_EN 0x01
281 #define SILENTSTEP2_PIN_FT1 0x02
282 #define SILENTSTEP2_PIN_FT2 0x04
283 #define SILENTSTEP2_PIN_ALL 0x07
284 
289 #define SILENTSTEP2_DIRECTION_COUNTERCLOCKWISE 0
290 #define SILENTSTEP2_DIRECTION_CLOCKWISE 1
291 
296 #define SILENTSTEP2_STEP_DELAY_DEFAULT_100US 100ul
297 
303 #define SILENTSTEP2_DEVICE_ADDRESS_0 0x70
304 #define SILENTSTEP2_DEVICE_ADDRESS_1 0x72
305 #define SILENTSTEP2_DEVICE_ADDRESS_2 0x74
306 #define SILENTSTEP2_DEVICE_ADDRESS_3 0x76
307 
316 #define SILENTSTEP2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
317 #define SILENTSTEP2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
318  // silentstep2_set
320 
335 #define SILENTSTEP2_MAP_MIKROBUS( cfg, mikrobus ) \
336  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
337  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
338  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
339  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
340  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
341  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
342  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
343  cfg.stp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
344  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
345  // silentstep2_map // silentstep2
348 
353 typedef enum
354 {
359 
364 typedef struct
365 {
366  digital_out_t dir;
367  digital_out_t stp;
369  digital_in_t int_pin;
371  i2c_master_t i2c;
372  spi_master_t spi;
374  uint8_t slave_address;
375  pin_name_t chip_select;
377  uint32_t step_delay;
379 } silentstep2_t;
380 
385 typedef struct
386 {
387  pin_name_t scl;
388  pin_name_t sda;
389  pin_name_t miso;
390  pin_name_t mosi;
391  pin_name_t sck;
392  pin_name_t cs;
393  pin_name_t dir;
394  pin_name_t stp;
395  pin_name_t int_pin;
397  uint32_t step_delay;
399  uint32_t i2c_speed;
400  uint8_t i2c_address;
402  uint32_t spi_speed;
403  spi_master_mode_t spi_mode;
404  spi_master_chip_select_polarity_t cs_polarity;
407 
412 typedef struct
413 {
414  uint8_t i_scale_analog;
415  uint8_t internal_rsense;
416  uint8_t en_pwm_mode;
417  uint8_t enc_commutation;
418  uint8_t shaft;
419  uint8_t diag0_error;
420  uint8_t diag0_otpw;
421  uint8_t diag0_stall;
422  uint8_t diag1_stall;
423  uint8_t diag1_index;
424  uint8_t diag1_onstate;
427  uint8_t diag1_pushpull;
429  uint8_t stop_enable;
430  uint8_t direct_mode;
433 
438 typedef struct
439 {
440  uint8_t semin;
441  uint8_t seup;
442  uint8_t semax;
443  uint8_t sedn;
444  uint8_t seimin;
445  uint8_t sgt;
446  uint8_t sfilt;
449 
454 typedef struct
455 {
456  uint8_t pwm_ampl;
457  uint8_t pwm_grad;
458  uint8_t pwm_freq;
459  uint8_t pwm_autoscale;
460  uint8_t pwm_symmetric;
461  uint8_t freewheel;
464 
469 typedef struct
470 {
471  uint16_t sg_result;
472  uint8_t fsactive;
473  uint8_t cs_actual;
474  uint8_t stall_guard;
475  uint8_t ot;
476  uint8_t otpw;
477  uint8_t s2ga;
478  uint8_t s2gb;
479  uint8_t ola;
480  uint8_t olb;
481  uint8_t stst;
484 
489 typedef enum
490 {
492  SILENTSTEP2_ERROR = -1
493 
495 
500 typedef enum
501 {
511 
513 
518 typedef enum
519 {
524 
526 
543 
558 
572 
587 err_t silentstep2_reg_write ( silentstep2_t *ctx, uint8_t reg, uint32_t data_in );
588 
603 err_t silentstep2_reg_read ( silentstep2_t *ctx, uint8_t reg, uint32_t *data_in );
604 
620 
634 err_t silentstep2_get_gstat ( silentstep2_t *ctx, uint32_t *gstat );
635 
651 err_t silentstep2_set_ihold_irun ( silentstep2_t *ctx, uint8_t ihold, uint8_t irun, uint8_t ihold_delay );
652 
667 err_t silentstep2_set_tcoolthrs ( silentstep2_t *ctx, uint32_t tcoolthrs );
668 
683 err_t silentstep2_set_thigh ( silentstep2_t *ctx, uint32_t thigh );
684 
700 err_t silentstep2_set_mslut ( silentstep2_t *ctx, uint8_t mslut_sel, uint32_t mslut );
701 
717 err_t silentstep2_set_mslutsel ( silentstep2_t *ctx, uint32_t lut_seg_str, uint32_t lut_width_sel );
718 
733 err_t silentstep2_set_mslutstart ( silentstep2_t *ctx, uint32_t start_sin, uint32_t start_sin90 );
734 
750 
765 err_t silentstep2_set_dedge ( silentstep2_t *ctx, uint8_t dedge_en );
766 
781 err_t silentstep2_set_intpol ( silentstep2_t *ctx, uint8_t intpol_en );
782 
799 
816 err_t silentstep2_set_h_end_strt ( silentstep2_t *ctx, uint8_t chm, uint8_t h_end_offset, uint8_t hstrt_tfd );
817 
831 err_t silentstep2_set_toff ( silentstep2_t *ctx, uint8_t off_time );
832 
849 
865 
881 
896 err_t silentstep2_port_exp_write ( silentstep2_t *ctx, uint8_t reg, uint8_t data_in );
897 
912 err_t silentstep2_port_exp_read ( silentstep2_t *ctx, uint8_t reg, uint8_t *data_out );
913 
928 err_t silentstep2_set_pins ( silentstep2_t *ctx, uint8_t set_mask, uint8_t clr_mask );
929 
943 err_t silentstep2_get_diag0 ( silentstep2_t *ctx, uint8_t *diag0 );
944 
958 err_t silentstep2_get_diag1 ( silentstep2_t *ctx, uint8_t *diag1 );
959 
973 
987 
999 void silentstep2_set_direction ( silentstep2_t *ctx, uint8_t dir );
1000 
1012 void silentstep2_set_step ( silentstep2_t *ctx, uint8_t step );
1013 
1027 err_t silentstep2_make_one_step ( silentstep2_t *ctx, uint8_t step_speed );
1028 
1044 err_t silentstep2_rotate_by_angle ( silentstep2_t *ctx, uint8_t step_speed, float angle, uint16_t res_360 );
1045 
1059 
1060 #ifdef __cplusplus
1061 }
1062 #endif
1063 #endif // SILENTSTEP2_H
1064  // silentstep2
1066 
1067 // ------------------------------------------------------------------------ END
SILENTSTEP2_MRES_16
@ SILENTSTEP2_MRES_16
Definition: silentstep2.h:506
silentstep2_drv_status_t::olb
uint8_t olb
Definition: silentstep2.h:480
SILENTSTEP2_ERROR
@ SILENTSTEP2_ERROR
Definition: silentstep2.h:492
silentstep2_drv_status_t::s2gb
uint8_t s2gb
Definition: silentstep2.h:478
silentstep2_drv_status_t::sg_result
uint16_t sg_result
Definition: silentstep2.h:471
silentstep2_t::stp
digital_out_t stp
Definition: silentstep2.h:367
silentstep2_set_mslutstart
err_t silentstep2_set_mslutstart(silentstep2_t *ctx, uint32_t start_sin, uint32_t start_sin90)
Silent Step 2 sets the absolute current microstep table function.
silentstep2_drv_t
silentstep2_drv_t
Silent Step 2 Click driver selector.
Definition: silentstep2.h:354
SILENTSTEP2_TBL_CLOCKS_36
@ SILENTSTEP2_TBL_CLOCKS_36
Definition: silentstep2.h:522
silentstep2_t::i2c
i2c_master_t i2c
Definition: silentstep2.h:371
silentstep2_cfg_t::stp
pin_name_t stp
Definition: silentstep2.h:394
silentstep2_rotate_by_angle
err_t silentstep2_rotate_by_angle(silentstep2_t *ctx, uint8_t step_speed, float angle, uint16_t res_360)
Silent Step 2 rotates the shaft through a desired angle function.
silentstep2_drv_status_t::cs_actual
uint8_t cs_actual
Definition: silentstep2.h:473
silentstep2_gconf_t::diag0_error
uint8_t diag0_error
Definition: silentstep2.h:419
silentstep2_pwmconf_t::pwm_autoscale
uint8_t pwm_autoscale
Definition: silentstep2.h:459
silentstep2_gconf_t::enc_commutation
uint8_t enc_commutation
Definition: silentstep2.h:417
silentstep2_gconf_t::small_hysteresis
uint8_t small_hysteresis
Definition: silentstep2.h:428
silentstep2_set_h_end_strt
err_t silentstep2_set_h_end_strt(silentstep2_t *ctx, uint8_t chm, uint8_t h_end_offset, uint8_t hstrt_tfd)
Silent Step 2 sets the chopper mode config function.
SILENTSTEP2_MRES_2
@ SILENTSTEP2_MRES_2
Definition: silentstep2.h:509
silentstep2_set_direction
void silentstep2_set_direction(silentstep2_t *ctx, uint8_t dir)
Silent Step 2 sets the clockwise or counterclockwise direction movement function.
SILENTSTEP2_TBL_CLOCKS_24
@ SILENTSTEP2_TBL_CLOCKS_24
Definition: silentstep2.h:521
silentstep2_drv_status_t::stall_guard
uint8_t stall_guard
Definition: silentstep2.h:474
silentstep2_drv_status_t::s2ga
uint8_t s2ga
Definition: silentstep2.h:477
spi_specifics.h
This file contains SPI specific macros, functions, etc.
silentstep2_gconf_t::stop_enable
uint8_t stop_enable
Definition: silentstep2.h:429
silentstep2_cfg_t
Silent Step 2 Click configuration object.
Definition: silentstep2.h:386
silentstep2_set_mslut
err_t silentstep2_set_mslut(silentstep2_t *ctx, uint8_t mslut_sel, uint32_t mslut)
Silent Step 2 sets the microstep table entries function.
silentstep2_coolconf_t::seimin
uint8_t seimin
Definition: silentstep2.h:444
silentstep2_gconf_t::i_scale_analog
uint8_t i_scale_analog
Definition: silentstep2.h:414
silentstep2_mres_t
silentstep2_mres_t
Silent Step 2 Click reduced microstep resolution value data.
Definition: silentstep2.h:501
silentstep2_cfg_t::mosi
pin_name_t mosi
Definition: silentstep2.h:390
silentstep2_get_gstat
err_t silentstep2_get_gstat(silentstep2_t *ctx, uint32_t *gstat)
Silent Step 2 get global status function.
silentstep2_coolconf_t::seup
uint8_t seup
Definition: silentstep2.h:441
SILENTSTEP2_MRES_NATIVE
@ SILENTSTEP2_MRES_NATIVE
Definition: silentstep2.h:510
silentstep2_drv_status_t::stst
uint8_t stst
Definition: silentstep2.h:481
SILENTSTEP2_MRES_4
@ SILENTSTEP2_MRES_4
Definition: silentstep2.h:508
silentstep2_init
err_t silentstep2_init(silentstep2_t *ctx, silentstep2_cfg_t *cfg)
Silent Step 2 initialization function.
silentstep2_pwmconf_t
Silent Step 2 Click voltage mode pwm stealthChop object.
Definition: silentstep2.h:455
silentstep2_pwmconf_t::freewheel
uint8_t freewheel
Definition: silentstep2.h:461
silentstep2_cfg_t::step_delay
uint32_t step_delay
Definition: silentstep2.h:397
silentstep2_gconf_t::en_pwm_mode
uint8_t en_pwm_mode
Definition: silentstep2.h:416
silentstep2_t::spi
spi_master_t spi
Definition: silentstep2.h:372
silentstep2_get_drv_status
err_t silentstep2_get_drv_status(silentstep2_t *ctx, silentstep2_drv_status_t *drv_status)
Silent Step 2 get driver status error flags function.
silentstep2_gconf_t::diag1_index
uint8_t diag1_index
Definition: silentstep2.h:423
silentstep2_reg_read
err_t silentstep2_reg_read(silentstep2_t *ctx, uint8_t reg, uint32_t *data_in)
Silent Step 2 data reading function.
silentstep2_t
Silent Step 2 Click context object.
Definition: silentstep2.h:365
silentstep2_drv_status_t::ot
uint8_t ot
Definition: silentstep2.h:475
silentstep2_set_dedge
err_t silentstep2_set_dedge(silentstep2_t *ctx, uint8_t dedge_en)
Silent Step 2 sets the step impulsen function.
silentstep2_gconf_t::diag0_otpw
uint8_t diag0_otpw
Definition: silentstep2.h:420
silentstep2_t::int_pin
digital_in_t int_pin
Definition: silentstep2.h:369
silentstep2_gconf_t::diag1_onstate
uint8_t diag1_onstate
Definition: silentstep2.h:424
silentstep2_set_tbl_blank_time
err_t silentstep2_set_tbl_blank_time(silentstep2_t *ctx, silentstep2_tbl_t tbl)
Silent Step 2 enable the blank time select function.
SILENTSTEP2_MRES_8
@ SILENTSTEP2_MRES_8
Definition: silentstep2.h:507
silentstep2_gconf_t::diag1_steps_skipped
uint8_t diag1_steps_skipped
Definition: silentstep2.h:425
silentstep2_t::step_delay
uint32_t step_delay
Definition: silentstep2.h:377
silentstep2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: silentstep2.h:404
silentstep2_set_mstep_res
err_t silentstep2_set_mstep_res(silentstep2_t *ctx, silentstep2_mres_t step_width)
Silent Step 2 sets the micro step resolution function.
silentstep2_get_diag1
err_t silentstep2_get_diag1(silentstep2_t *ctx, uint8_t *diag1)
Silent Step 2 get the diagnostics output DIAG1 function.
SILENTSTEP2_TBL_CLOCKS_54
@ SILENTSTEP2_TBL_CLOCKS_54
Definition: silentstep2.h:523
silentstep2_reg_write
err_t silentstep2_reg_write(silentstep2_t *ctx, uint8_t reg, uint32_t data_in)
Silent Step 2 data writing function.
silentstep2_drv_status_t::ola
uint8_t ola
Definition: silentstep2.h:479
silentstep2_gconf_t::direct_mode
uint8_t direct_mode
Definition: silentstep2.h:430
silentstep2_cfg_t::sda
pin_name_t sda
Definition: silentstep2.h:388
SILENTSTEP2_MRES_32
@ SILENTSTEP2_MRES_32
Definition: silentstep2.h:505
silentstep2_default_cfg
err_t silentstep2_default_cfg(silentstep2_t *ctx)
Silent Step 2 default configuration function.
silentstep2_input_enable
err_t silentstep2_input_enable(silentstep2_t *ctx)
Silent Step 2 enable input function.
silentstep2_gconf_t::shaft
uint8_t shaft
Definition: silentstep2.h:418
silentstep2_t::chip_select
pin_name_t chip_select
Definition: silentstep2.h:375
SILENTSTEP2_OK
@ SILENTSTEP2_OK
Definition: silentstep2.h:491
silentstep2_t::slave_address
uint8_t slave_address
Definition: silentstep2.h:374
silentstep2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: silentstep2.h:399
silentstep2_return_value_t
silentstep2_return_value_t
Silent Step 2 Click return value data.
Definition: silentstep2.h:490
silentstep2_set_tcoolthrs
err_t silentstep2_set_tcoolthrs(silentstep2_t *ctx, uint32_t tcoolthrs)
Silent Step 2 sets lower threshold velocity for switching on smart energy function.
silentstep2_gconf_t::diag0_int_pushpull
uint8_t diag0_int_pushpull
Definition: silentstep2.h:426
silentstep2_cfg_t::int_pin
pin_name_t int_pin
Definition: silentstep2.h:395
silentstep2_coolconf_t
Silent Step 2 Click smart energy control coolStep and stallGuard2 object.
Definition: silentstep2.h:439
silentstep2_coolconf_t::semax
uint8_t semax
Definition: silentstep2.h:442
silentstep2_port_exp_write
err_t silentstep2_port_exp_write(silentstep2_t *ctx, uint8_t reg, uint8_t data_in)
Silent Step 2 port expander data writing function.
silentstep2_gconf_t::internal_rsense
uint8_t internal_rsense
Definition: silentstep2.h:415
silentstep2_make_one_step
err_t silentstep2_make_one_step(silentstep2_t *ctx, uint8_t step_speed)
Silent Step 2 make the one step function.
silentstep2_drv_status_t::otpw
uint8_t otpw
Definition: silentstep2.h:476
silentstep2_t::dir
digital_out_t dir
Definition: silentstep2.h:366
silentstep2_set_ihold_irun
err_t silentstep2_set_ihold_irun(silentstep2_t *ctx, uint8_t ihold, uint8_t irun, uint8_t ihold_delay)
Silent Step 2 sets driver current control function.
silentstep2_pwmconf_t::pwm_ampl
uint8_t pwm_ampl
Definition: silentstep2.h:456
silentstep2_coolconf_t::sgt
uint8_t sgt
Definition: silentstep2.h:445
silentstep2_get_interrupt
uint8_t silentstep2_get_interrupt(silentstep2_t *ctx)
Silent Step 2 get the interrupt function.
silentstep2_get_diag0
err_t silentstep2_get_diag0(silentstep2_t *ctx, uint8_t *diag0)
Silent Step 2 get the diagnostics output DIAG0 function.
silentstep2_cfg_t::dir
pin_name_t dir
Definition: silentstep2.h:393
silentstep2_cfg_t::i2c_address
uint8_t i2c_address
Definition: silentstep2.h:400
silentstep2_cfg_t::cs
pin_name_t cs
Definition: silentstep2.h:392
silentstep2_cfg_t::sck
pin_name_t sck
Definition: silentstep2.h:391
silentstep2_drv_status_t
Silent Step 2 Click stallGuard2 value and driver error flags object.
Definition: silentstep2.h:470
silentstep2_switch_off
err_t silentstep2_switch_off(silentstep2_t *ctx)
Silent Step 2 sets the power OFF function.
silentstep2_set_gconf
err_t silentstep2_set_gconf(silentstep2_t *ctx, silentstep2_gconf_t gconf)
Silent Step 2 sets global configuration function.
silentstep2_set_toff
err_t silentstep2_set_toff(silentstep2_t *ctx, uint8_t off_time)
Silent Step 2 sets the off time and driver enable function.
silentstep2_cfg_setup
void silentstep2_cfg_setup(silentstep2_cfg_t *cfg)
Silent Step 2 configuration object setup function.
silentstep2_drv_status_t::fsactive
uint8_t fsactive
Definition: silentstep2.h:472
SILENTSTEP2_MRES_256
@ SILENTSTEP2_MRES_256
Definition: silentstep2.h:502
silentstep2_gconf_t::diag1_pushpull
uint8_t diag1_pushpull
Definition: silentstep2.h:427
SILENTSTEP2_DRV_SEL_SPI
@ SILENTSTEP2_DRV_SEL_SPI
Definition: silentstep2.h:355
silentstep2_set_pwmconf
err_t silentstep2_set_pwmconf(silentstep2_t *ctx, silentstep2_pwmconf_t pwmconf)
Silent Step 2 sets the voltage PWM Mode stealthChop function.
silentstep2_pwmconf_t::pwm_symmetric
uint8_t pwm_symmetric
Definition: silentstep2.h:460
silentstep2_cfg_t::miso
pin_name_t miso
Definition: silentstep2.h:389
silentstep2_coolconf_t::semin
uint8_t semin
Definition: silentstep2.h:440
SILENTSTEP2_MRES_128
@ SILENTSTEP2_MRES_128
Definition: silentstep2.h:503
silentstep2_set_intpol
err_t silentstep2_set_intpol(silentstep2_t *ctx, uint8_t intpol_en)
Silent Step 2 enable the actual microstep resolution function.
silentstep2_gconf_t
Silent Step 2 Click global configuration object.
Definition: silentstep2.h:413
silentstep2_set_thigh
err_t silentstep2_set_thigh(silentstep2_t *ctx, uint32_t thigh)
Silent Step 2 sets the velocity setting function.
silentstep2_set_coolconf
err_t silentstep2_set_coolconf(silentstep2_t *ctx, silentstep2_coolconf_t coolconf)
Silent Step 2 sets the coolStep smart current control function.
silentstep2_gconf_t::diag0_stall
uint8_t diag0_stall
Definition: silentstep2.h:421
silentstep2_tbl_t
silentstep2_tbl_t
Silent Step 2 Click comparator blank time value data.
Definition: silentstep2.h:519
silentstep2_pwmconf_t::pwm_grad
uint8_t pwm_grad
Definition: silentstep2.h:457
SILENTSTEP2_TBL_CLOCKS_16
@ SILENTSTEP2_TBL_CLOCKS_16
Definition: silentstep2.h:520
SILENTSTEP2_DRV_SEL_I2C
@ SILENTSTEP2_DRV_SEL_I2C
Definition: silentstep2.h:356
silentstep2_coolconf_t::sedn
uint8_t sedn
Definition: silentstep2.h:443
silentstep2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: silentstep2.h:403
silentstep2_set_mslutsel
err_t silentstep2_set_mslutsel(silentstep2_t *ctx, uint32_t lut_seg_str, uint32_t lut_width_sel)
Silent Step 2 sets the microstep segments function.
silentstep2_port_exp_read
err_t silentstep2_port_exp_read(silentstep2_t *ctx, uint8_t reg, uint8_t *data_out)
Silent Step 2 port expander data reading function.
silentstep2_cfg_t::spi_speed
uint32_t spi_speed
Definition: silentstep2.h:402
SILENTSTEP2_MRES_64
@ SILENTSTEP2_MRES_64
Definition: silentstep2.h:504
silentstep2_gconf_t::diag1_stall
uint8_t diag1_stall
Definition: silentstep2.h:422
silentstep2_set_pins
err_t silentstep2_set_pins(silentstep2_t *ctx, uint8_t set_mask, uint8_t clr_mask)
Silent Step 2 sets the pin states function.
silentstep2_cfg_t::scl
pin_name_t scl
Definition: silentstep2.h:387
silentstep2_coolconf_t::sfilt
uint8_t sfilt
Definition: silentstep2.h:446
silentstep2_set_step
void silentstep2_set_step(silentstep2_t *ctx, uint8_t step)
Silent Step 2 set the step pin state function.
silentstep2_pwmconf_t::pwm_freq
uint8_t pwm_freq
Definition: silentstep2.h:458