hbridge10  2.0.0.0
hbridge10.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 HBRIDGE10_H
29 #define HBRIDGE10_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 #include "drv_analog_in.h"
40 
61 #define HBRIDGE10_IN_STATUS_RESET 0x8000
62 #define HBRIDGE10_IN_OUT_LS1_ON 0x1000
63 #define HBRIDGE10_IN_OUT_HS1_ON 0x0800
64 #define HBRIDGE10_IN_OUT_LS2_ON 0x0100
65 #define HBRIDGE10_IN_OUT_HS2_ON 0x0080
66 #define HBRIDGE10_IN_OUT_LS3_ON 0x0010
67 #define HBRIDGE10_IN_OUT_HS3_ON 0x0008
68 #define HBRIDGE10_IN_OPEN_LOAD_OFF 0x0004
69 #define HBRIDGE10_IN_SHORT_SD_DELAY_12MS 0x0002
70 #define HBRIDGE10_IN_SHORT_SD_DELAY_1p5MS 0x0000
71 #define HBRIDGE10_IN_SOFT_ENABLE 0x0001
72 
77 #define HBRIDGE10_OUT_OVER_TEMP_SD 0xFFFF
78 #define HBRIDGE10_OUT_OVER_TEMP_WARNING 0x8000
79 #define HBRIDGE10_OUT_STATUS_LS1_ON 0x1000
80 #define HBRIDGE10_OUT_STATUS_HS1_ON 0x0800
81 #define HBRIDGE10_OUT_STATUS_LS2_ON 0x0100
82 #define HBRIDGE10_OUT_STATUS_HS2_ON 0x0080
83 #define HBRIDGE10_OUT_STATUS_LS3_ON 0x0010
84 #define HBRIDGE10_OUT_STATUS_HS3_ON 0x0008
85 #define HBRIDGE10_OUT_SHORT_CIRCUIT_DETECTED 0x0004
86 #define HBRIDGE10_OUT_NORMAL_OPERATION 0x0002
87 #define HBRIDGE10_OUT_VS_UNDER_VOLTAGE 0x0001
88 
93 #define HBRIDGE10_CHANNEL_OUT1 1
94 #define HBRIDGE10_CHANNEL_OUT2 2
95 #define HBRIDGE10_CHANNEL_OUT3 3
96 #define HBRIDGE10_OUT_OFF 0
97 #define HBRIDGE10_OUT_HIGH 1
98 #define HBRIDGE10_OUT_LOW 2
99 #define HBRIDGE10_OUT_MASK 3u
100 
105 #define HBRIDGE10_ADC_VREF 3.3
106 
115 #define HBRIDGE10_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
116 #define HBRIDGE10_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
117  // hbridge10_set
119 
134 #define HBRIDGE10_MAP_MIKROBUS( cfg, mikrobus ) \
135  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
136  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
137  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
138  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
139  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
140  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
141  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
142  // hbridge10_map // hbridge10
145 
150 typedef struct
151 {
152  // Output pins
153  digital_out_t en;
155  // Input pins
156  digital_in_t flt;
158  // Modules
159  analog_in_t adc;
160  spi_master_t spi;
162  pin_name_t chip_select;
164  uint16_t input_data;
166 } hbridge10_t;
167 
172 typedef struct
173 {
174  // Communication gpio pins
175  pin_name_t miso;
176  pin_name_t mosi;
177  pin_name_t sck;
178  pin_name_t cs;
180  // Additional gpio pins
181  pin_name_t an;
182  pin_name_t en;
183  pin_name_t flt;
185  // static variable
186  uint32_t spi_speed;
187  spi_master_mode_t spi_mode;
188  spi_master_chip_select_polarity_t cs_polarity;
190  analog_in_resolution_t resolution;
191  float vref;
194 
199 typedef enum
200 {
202  HBRIDGE10_ERROR = -1
203 
205 
222 
237 
251 
265 err_t hbridge10_transfer_data ( hbridge10_t *ctx, uint16_t data_in, uint16_t *data_out );
266 
281 err_t hbridge10_set_output_state ( hbridge10_t *ctx, uint8_t channel, uint8_t state );
282 
294 err_t hbridge10_get_status ( hbridge10_t *ctx, uint16_t *status );
295 
307 err_t hbridge10_read_an_pin_value ( hbridge10_t *ctx, uint16_t *data_out );
308 
322 err_t hbridge10_read_an_pin_voltage ( hbridge10_t *ctx, float *data_out );
323 
333 
343 
353 
354 #ifdef __cplusplus
355 }
356 #endif
357 #endif // HBRIDGE10_H
358  // hbridge10
360 
361 // ------------------------------------------------------------------------ END
hbridge10_cfg_t::flt
pin_name_t flt
Definition: hbridge10.h:183
hbridge10_cfg_setup
void hbridge10_cfg_setup(hbridge10_cfg_t *cfg)
H-Bridge 10 configuration object setup function.
hbridge10_disable_device
void hbridge10_disable_device(hbridge10_t *ctx)
H-Bridge 10 disable device function.
hbridge10_t::en
digital_out_t en
Definition: hbridge10.h:153
hbridge10_get_fault_pin
uint8_t hbridge10_get_fault_pin(hbridge10_t *ctx)
H-Bridge 10 get fault function.
hbridge10_cfg_t::cs
pin_name_t cs
Definition: hbridge10.h:178
spi_specifics.h
This file contains SPI specific macros, functions, etc.
hbridge10_t::input_data
uint16_t input_data
Definition: hbridge10.h:164
hbridge10_cfg_t::miso
pin_name_t miso
Definition: hbridge10.h:175
hbridge10_cfg_t
H-Bridge 10 Click configuration object.
Definition: hbridge10.h:173
hbridge10_cfg_t::an
pin_name_t an
Definition: hbridge10.h:181
hbridge10_read_an_pin_voltage
err_t hbridge10_read_an_pin_voltage(hbridge10_t *ctx, float *data_out)
H-Bridge 10 read AN pin voltage level function.
hbridge10_cfg_t::spi_speed
uint32_t spi_speed
Definition: hbridge10.h:186
hbridge10_cfg_t::sck
pin_name_t sck
Definition: hbridge10.h:177
hbridge10_t::spi
spi_master_t spi
Definition: hbridge10.h:160
HBRIDGE10_OK
@ HBRIDGE10_OK
Definition: hbridge10.h:201
hbridge10_t::chip_select
pin_name_t chip_select
Definition: hbridge10.h:162
hbridge10_t
H-Bridge 10 Click context object.
Definition: hbridge10.h:151
hbridge10_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: hbridge10.h:188
hbridge10_set_output_state
err_t hbridge10_set_output_state(hbridge10_t *ctx, uint8_t channel, uint8_t state)
H-Bridge 10 set output state function.
hbridge10_return_value_t
hbridge10_return_value_t
H-Bridge 10 Click return value data.
Definition: hbridge10.h:200
hbridge10_read_an_pin_value
err_t hbridge10_read_an_pin_value(hbridge10_t *ctx, uint16_t *data_out)
H-Bridge 10 read AN pin value function.
hbridge10_cfg_t::en
pin_name_t en
Definition: hbridge10.h:182
hbridge10_t::adc
analog_in_t adc
Definition: hbridge10.h:159
hbridge10_t::flt
digital_in_t flt
Definition: hbridge10.h:156
hbridge10_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: hbridge10.h:187
hbridge10_cfg_t::mosi
pin_name_t mosi
Definition: hbridge10.h:176
hbridge10_cfg_t::resolution
analog_in_resolution_t resolution
Definition: hbridge10.h:190
HBRIDGE10_ERROR
@ HBRIDGE10_ERROR
Definition: hbridge10.h:202
hbridge10_get_status
err_t hbridge10_get_status(hbridge10_t *ctx, uint16_t *status)
H-Bridge 10 get status function.
hbridge10_default_cfg
err_t hbridge10_default_cfg(hbridge10_t *ctx)
H-Bridge 10 default configuration function.
hbridge10_cfg_t::vref
float vref
Definition: hbridge10.h:191
hbridge10_init
err_t hbridge10_init(hbridge10_t *ctx, hbridge10_cfg_t *cfg)
H-Bridge 10 initialization function.
hbridge10_enable_device
void hbridge10_enable_device(hbridge10_t *ctx)
H-Bridge 10 enable device function.
hbridge10_transfer_data
err_t hbridge10_transfer_data(hbridge10_t *ctx, uint16_t data_in, uint16_t *data_out)
H-Bridge 10 transfer data function.