hbridge16 2.1.0.0
hbridge16.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 HBRIDGE16_H
29#define HBRIDGE16_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define HBRIDGE16_REG_INPUT_PORT 0x00
60#define HBRIDGE16_REG_OUTPUT_PORT 0x01
61#define HBRIDGE16_REG_POLARITY_INV 0x02
62#define HBRIDGE16_REG_CONFIG 0x03
63 // hbridge16_reg
65
80#define HBRIDGE16_NONE_PIN 0x00
81#define HBRIDGE16_IN1_PIN 0x01
82#define HBRIDGE16_IN2_PIN 0x02
83#define HBRIDGE16_IN3_PIN 0x04
84#define HBRIDGE16_IN4_PIN 0x08
85#define HBRIDGE16_DECAY_PIN 0x10
86#define HBRIDGE16_MD_PIN 0x20
87#define HBRIDGE16_OCPM_PIN 0x40
88#define HBRIDGE16_FLT_PIN 0x80
89#define HBRIDGE16_ALL_OUTPUT_PIN 0x7F
90#define HBRIDGE16_ALL_PIN 0xFF
91
96#define HBRIDGE16_DRIVE_MOTOR_REVERSE 0x00
97#define HBRIDGE16_DRIVE_MOTOR_FORWARD 0x01
98#define HBRIDGE16_DRIVE_MOTOR_FREEWHEEL 0x02
99#define HBRIDGE16_DRIVE_MOTOR_BRAKE 0x03
100
105#define HBRIDGE16_PWM_MODE 0x01
106#define HBRIDGE16_PH_EN_MODE 0x00
107
112#define HBRIDGE16_SLEEP_MODE_OFF 0x01
113#define HBRIDGE16_SLEEP_MODE_ON 0x00
114
120#define HBRIDGE16_DEVICE_ADDRESS_A1A0_00 0x70
121#define HBRIDGE16_DEVICE_ADDRESS_A1A0_01 0x71
122#define HBRIDGE16_DEVICE_ADDRESS_A1A0_10 0x72
123#define HBRIDGE16_DEVICE_ADDRESS_A1A0_11 0x73
124 // hbridge16_set
126
141#define HBRIDGE16_MAP_MIKROBUS( cfg, mikrobus ) \
142 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
143 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
144 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
145 cfg.slp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
146 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
147 // hbridge16_map // hbridge16
150
155typedef struct
156{
157 // Output pins
158 digital_out_t rst;
159 digital_out_t slp;
161 // Input pins
162 digital_in_t int_pin;
164 // Modules
165 i2c_master_t i2c;
167 // I2C slave address
171
176typedef struct
177{
178 pin_name_t scl;
179 pin_name_t sda;
181 pin_name_t rst;
182 pin_name_t slp;
183 pin_name_t int_pin;
185 uint32_t i2c_speed;
186 uint8_t i2c_address;
189
194typedef enum
195{
197 HBRIDGE16_ERROR = -1
198
200
217
232
246
261err_t hbridge16_generic_write ( hbridge16_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
262
277err_t hbridge16_generic_read ( hbridge16_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
278
279
289
300
310void hbridge16_set_slp_pin ( hbridge16_t *ctx, uint8_t pin_state );
311
325err_t hbridge16_write_reg ( hbridge16_t *ctx, uint8_t reg, uint8_t data_in );
326
339err_t hbridge16_read_reg ( hbridge16_t *ctx, uint8_t reg, uint8_t *data_out );
340
353err_t hbridge16_set_pins ( hbridge16_t *ctx, uint8_t set_mask, uint8_t clr_mask );
354
366err_t hbridge16_set_mode ( hbridge16_t *ctx, uint8_t mode_sel );
367
380err_t hbridge16_set_out_state ( hbridge16_t *ctx, uint8_t out_state );
381
382#ifdef __cplusplus
383}
384#endif
385#endif // HBRIDGE16_H
386 // hbridge16
388
389// ------------------------------------------------------------------------ END
void hbridge16_reset_port_exp(hbridge16_t *ctx)
H-Bridge 16 reset port expander function.
err_t hbridge16_write_reg(hbridge16_t *ctx, uint8_t reg, uint8_t data_in)
H-Bridge 16 write register function.
err_t hbridge16_init(hbridge16_t *ctx, hbridge16_cfg_t *cfg)
H-Bridge 16 initialization function.
err_t hbridge16_read_reg(hbridge16_t *ctx, uint8_t reg, uint8_t *data_out)
H-Bridge 16 read register function.
void hbridge16_set_slp_pin(hbridge16_t *ctx, uint8_t pin_state)
H-Bridge 15 set Sleep pin function.
err_t hbridge16_generic_write(hbridge16_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
H-Bridge 16 I2C writing function.
err_t hbridge16_set_pins(hbridge16_t *ctx, uint8_t set_mask, uint8_t clr_mask)
H-Bridge 16 set pins function.
err_t hbridge16_set_mode(hbridge16_t *ctx, uint8_t mode_sel)
H-Bridge 16 set mode function.
uint8_t hbridge16_get_int_pin(hbridge16_t *ctx)
H-Bridge 16 get Interrupt pin function.
err_t hbridge16_set_out_state(hbridge16_t *ctx, uint8_t out_state)
H-Bridge 16 set output function.
void hbridge16_cfg_setup(hbridge16_cfg_t *cfg)
H-Bridge 16 configuration object setup function.
err_t hbridge16_default_cfg(hbridge16_t *ctx)
H-Bridge 16 default configuration function.
err_t hbridge16_generic_read(hbridge16_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
H-Bridge 16 I2C reading function.
hbridge16_return_value_t
H-Bridge 16 Click return value data.
Definition: hbridge16.h:195
@ HBRIDGE16_ERROR
Definition: hbridge16.h:197
@ HBRIDGE16_OK
Definition: hbridge16.h:196
H-Bridge 16 Click configuration object.
Definition: hbridge16.h:177
pin_name_t slp
Definition: hbridge16.h:182
uint32_t i2c_speed
Definition: hbridge16.h:185
pin_name_t scl
Definition: hbridge16.h:178
pin_name_t int_pin
Definition: hbridge16.h:183
pin_name_t sda
Definition: hbridge16.h:179
pin_name_t rst
Definition: hbridge16.h:181
uint8_t i2c_address
Definition: hbridge16.h:186
H-Bridge 16 Click context object.
Definition: hbridge16.h:156
digital_out_t slp
Definition: hbridge16.h:159
digital_in_t int_pin
Definition: hbridge16.h:162
i2c_master_t i2c
Definition: hbridge16.h:165
digital_out_t rst
Definition: hbridge16.h:158
uint8_t slave_address
Definition: hbridge16.h:168