hbridge12  2.1.0.0
hbridge12.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 HBRIDGE12_H
29 #define HBRIDGE12_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define HBRIDGE12_ADDR_AB 0x00
61 #define HBRIDGE12_ADDR_CD 0x01
62  // hbridge12_reg
64 
79 #define HBRIDGE12_CURRENT_SCALE_20_PER 0x00
80 #define HBRIDGE12_CURRENT_SCALE_38_PER 0x04
81 #define HBRIDGE12_CURRENT_SCALE_56_PER 0x02
82 #define HBRIDGE12_CURRENT_SCALE_71_PER 0x06
83 #define HBRIDGE12_CURRENT_SCALE_83_PER 0x01
84 #define HBRIDGE12_CURRENT_SCALE_92_PER 0x05
85 #define HBRIDGE12_CURRENT_SCALE_98_PER 0x03
86 #define HBRIDGE12_CURRENT_SCALE_100_PER 0x07
87 
92 #define HBRIDGE12_PHASE_OUT1_H_OUT2_L 0x01
93 #define HBRIDGE12_PHASE_OUT1_L_OUT2_H 0x00
94 
99 #define HBRIDGE12_ENABLE_BRIDGE_OUTPUT 0x01
100 #define HBRIDGE12_DISABLE_BRIDGE_OUTPUT 0x00
101 
106 #define HBRIDGE12_AB_BRIDGE_SEL 0x00
107 #define HBRIDGE12_CD_BRIDGE_SEL 0x01
108 
113 #define HBRIDGE12_PIN_STATE_LOW 0x00
114 #define HBRIDGE12_PIN_STATE_HIGH 0x01
115 
124 #define HBRIDGE12_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
125 #define HBRIDGE12_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
126  // hbridge12_set
128 
143 #define HBRIDGE12_MAP_MIKROBUS( cfg, mikrobus ) \
144  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
145  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
146  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
147  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
148  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
149  cfg.slp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
150  cfg.stb = MIKROBUS( mikrobus, MIKROBUS_AN )
151  // hbridge12_map // hbridge12
154 
159 typedef struct
160 {
161  uint8_t addr;
162  uint8_t ch1_en;
163  uint8_t ch1_phase;
164  uint8_t ch1_cur_scale;
165  uint8_t ch1_decay;
166  uint8_t ch2_en;
167  uint8_t ch2_phase;
168  uint8_t ch2_cur_scale;
169  uint8_t ch2_decay;
172 
177 typedef struct
178 {
179  // Output pins
180  digital_out_t rst;
181  digital_out_t slp;
182  digital_out_t stb;
184  // Configuration structures
188  // Modules
189  spi_master_t spi;
191  pin_name_t chip_select;
193 } hbridge12_t;
194 
199 typedef struct
200 {
201  // Communication gpio pins
202  pin_name_t miso;
203  pin_name_t mosi;
204  pin_name_t sck;
205  pin_name_t cs;
207  // Additional gpio pins
208  pin_name_t rst;
209  pin_name_t slp;
210  pin_name_t stb;
212  // static variable
213  uint32_t spi_speed;
214  spi_master_mode_t spi_mode;
215  spi_master_chip_select_polarity_t cs_polarity;
218 
223 typedef enum
224 {
226  HBRIDGE12_ERROR = -1
227 
229 
246 
261 
275 
285 void hbridge12_set_rst ( hbridge12_t *ctx, uint8_t pin_state );
286 
296 void hbridge12_set_slp ( hbridge12_t *ctx, uint8_t pin_state );
297 
307 void hbridge12_set_strobe ( hbridge12_t *ctx, uint8_t pin_state );
308 
318 
329 void hbridge12_get_settings ( hbridge12_t *ctx, uint8_t channel_sel, hbridge12_config_t *config_data );
330 
342 void hbridge12_set_settings ( hbridge12_t *ctx, uint8_t channel_sel, hbridge12_config_t config_data );
343 
344 
358 
371 void hbridge12_set_current_scale ( hbridge12_t *ctx, uint8_t channel_sel, uint8_t out1_curr_scale,
372  uint8_t out2_curr_scale );
373 
386 void hbridge12_set_decay ( hbridge12_t *ctx, uint8_t channel_sel, uint8_t out1_decay,
387  uint8_t out2_decay );
388 
400 err_t hbridge12_turn_clockwise ( hbridge12_t *ctx, uint8_t channel_sel );
401 
413 err_t hbridge12_turn_counterclockwise ( hbridge12_t *ctx, uint8_t channel_sel );
414 
426 err_t hbridge12_turn_brake_on ( hbridge12_t *ctx, uint8_t channel_sel );
427 
439 err_t hbridge12_freewheeling_on ( hbridge12_t *ctx, uint8_t channel_sel );
440 
441 #ifdef __cplusplus
442 }
443 #endif
444 #endif // HBRIDGE12_H
445  // hbridge12
447 
448 // ------------------------------------------------------------------------ END
hbridge12_cfg_setup
void hbridge12_cfg_setup(hbridge12_cfg_t *cfg)
H-Bridge 12 configuration object setup function.
hbridge12_config_t::ch2_en
uint8_t ch2_en
Definition: hbridge12.h:166
hbridge12_cfg_t::stb
pin_name_t stb
Definition: hbridge12.h:210
hbridge12_set_rst
void hbridge12_set_rst(hbridge12_t *ctx, uint8_t pin_state)
H-Bridge 12 set RST pin state function.
hbridge12_cfg_t::miso
pin_name_t miso
Definition: hbridge12.h:202
hbridge12_cfg_t::rst
pin_name_t rst
Definition: hbridge12.h:208
spi_specifics.h
This file contains SPI specific macros, functions, etc.
hbridge12_set_strobe
void hbridge12_set_strobe(hbridge12_t *ctx, uint8_t pin_state)
H-Bridge 12 set STB pin state function.
hbridge12_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: hbridge12.h:215
HBRIDGE12_OK
@ HBRIDGE12_OK
Definition: hbridge12.h:225
hbridge12_cfg_t::spi_speed
uint32_t spi_speed
Definition: hbridge12.h:213
hbridge12_cfg_t
H-Bridge 12 Click configuration object.
Definition: hbridge12.h:200
hbridge12_set_decay
void hbridge12_set_decay(hbridge12_t *ctx, uint8_t channel_sel, uint8_t out1_decay, uint8_t out2_decay)
H-Bridge 12 set decay function.
hbridge12_turn_counterclockwise
err_t hbridge12_turn_counterclockwise(hbridge12_t *ctx, uint8_t channel_sel)
H-Bridge 12 turn motor counterclockwise function.
hbridge12_cfg_t::mosi
pin_name_t mosi
Definition: hbridge12.h:203
hbridge12_config_t::addr
uint8_t addr
Definition: hbridge12.h:161
hbridge12_set_current_scale
void hbridge12_set_current_scale(hbridge12_t *ctx, uint8_t channel_sel, uint8_t out1_curr_scale, uint8_t out2_curr_scale)
H-Bridge 12 set current scale function.
hbridge12_cfg_t::cs
pin_name_t cs
Definition: hbridge12.h:205
hbridge12_t
H-Bridge 12 Click context object.
Definition: hbridge12.h:178
hbridge12_turn_clockwise
err_t hbridge12_turn_clockwise(hbridge12_t *ctx, uint8_t channel_sel)
H-Bridge 12 turn motor clockwise function.
hbridge12_return_value_t
hbridge12_return_value_t
H-Bridge 12 Click return value data.
Definition: hbridge12.h:224
hbridge12_default_cfg
err_t hbridge12_default_cfg(hbridge12_t *ctx)
H-Bridge 12 default configuration function.
hbridge12_t::cd_config_data
hbridge12_config_t cd_config_data
Definition: hbridge12.h:186
hbridge12_init
err_t hbridge12_init(hbridge12_t *ctx, hbridge12_cfg_t *cfg)
H-Bridge 12 initialization function.
hbridge12_generate_strobe
void hbridge12_generate_strobe(hbridge12_t *ctx)
H-Bridge 12 generate strobe signal function.
hbridge12_freewheeling_on
err_t hbridge12_freewheeling_on(hbridge12_t *ctx, uint8_t channel_sel)
H-Bridge 12 set motor into freewheeling mode function.
hbridge12_t::slp
digital_out_t slp
Definition: hbridge12.h:181
hbridge12_config_t::ch2_decay
uint8_t ch2_decay
Definition: hbridge12.h:169
hbridge12_config_t::ch2_phase
uint8_t ch2_phase
Definition: hbridge12.h:167
hbridge12_set_settings
void hbridge12_set_settings(hbridge12_t *ctx, uint8_t channel_sel, hbridge12_config_t config_data)
H-Bridge 12 set settings function.
hbridge12_set_slp
void hbridge12_set_slp(hbridge12_t *ctx, uint8_t pin_state)
H-Bridge 12 set SLP pin state function.
hbridge12_config_t::ch1_phase
uint8_t ch1_phase
Definition: hbridge12.h:163
hbridge12_write_config
err_t hbridge12_write_config(hbridge12_t *ctx, hbridge12_config_t config_data)
H-Bridge 12 write settings function.
hbridge12_config_t::ch2_cur_scale
uint8_t ch2_cur_scale
Definition: hbridge12.h:168
hbridge12_cfg_t::sck
pin_name_t sck
Definition: hbridge12.h:204
hbridge12_t::stb
digital_out_t stb
Definition: hbridge12.h:182
hbridge12_config_t::ch1_cur_scale
uint8_t ch1_cur_scale
Definition: hbridge12.h:164
hbridge12_t::ab_config_data
hbridge12_config_t ab_config_data
Definition: hbridge12.h:185
hbridge12_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: hbridge12.h:214
hbridge12_get_settings
void hbridge12_get_settings(hbridge12_t *ctx, uint8_t channel_sel, hbridge12_config_t *config_data)
H-Bridge 12 get settings function.
hbridge12_config_t::ch1_decay
uint8_t ch1_decay
Definition: hbridge12.h:165
hbridge12_cfg_t::slp
pin_name_t slp
Definition: hbridge12.h:209
HBRIDGE12_ERROR
@ HBRIDGE12_ERROR
Definition: hbridge12.h:226
hbridge12_config_t::ch1_en
uint8_t ch1_en
Definition: hbridge12.h:162
hbridge12_turn_brake_on
err_t hbridge12_turn_brake_on(hbridge12_t *ctx, uint8_t channel_sel)
H-Bridge 12 turn motor brake on function.
hbridge12_t::spi
spi_master_t spi
Definition: hbridge12.h:189
hbridge12_config_t
H-Bridge 12 Click configuration structure.
Definition: hbridge12.h:160
hbridge12_t::rst
digital_out_t rst
Definition: hbridge12.h:180
hbridge12_t::chip_select
pin_name_t chip_select
Definition: hbridge12.h:191