stepdown10  2.1.0.0
stepdown10.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 STEPDOWN10_H
29 #define STEPDOWN10_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define STEPDOWN10_PFM_PWM_MODE 0x00
74 #define STEPDOWN10_FORCED_PWM_MODE 0x01
75 #define STEPDOWN10_R1_RPROG_ADDRESS 0x00
76  // stepdown10_reg
78 
93 #define STEPDOWN10_R1_VALUE 100000ul
94 #define STEPDOWN10_DIGIPOT_MAX_VALUE 100000ul
95 #define STEPDOWN10_DIGIPOT_RESOLUTION 257
96 #define STEPDOWN10_ROUND_TO_NEAREST_INT 0.5
97 #define STEPDOWN10_R13_VALUE 1000u
98 #define STEPDOWN10_MAX_OUTPUT 20
99 #define STEPDOWN10_MIN_OUTPUT 2
100 
105 #define STEPDOWN10_PIN_STATE_HIGH 0x01
106 #define STEPDOWN10_PIN_STATE_LOW 0x00
107 
113 #define STEPDOWN10_ADDR_A2A1A0_000 0x28
114 #define STEPDOWN10_ADDR_A2A1A0_001 0x29
115 #define STEPDOWN10_ADDR_A2A1A0_010 0x2A
116 #define STEPDOWN10_ADDR_A2A1A0_011 0x2B
117 #define STEPDOWN10_ADDR_A2A1A0_100 0x2C
118 #define STEPDOWN10_ADDR_A2A1A0_101 0x2D
119 #define STEPDOWN10_ADDR_A2A1A0_110 0x2E
120 #define STEPDOWN10_ADDR_A2A1A0_111 0x2F
121  // stepdown10_set
123 
138 #define STEPDOWN10_MAP_MIKROBUS( cfg, mikrobus ) \
139  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
140  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
141  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
142  cfg.md = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
143  cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
144  // stepdown10_map // stepdown10
147 
152 typedef struct
153 {
154  // Output pins
155  digital_out_t en;
156  digital_out_t md;
158  // Input pins
159  digital_in_t pg;
161  // Modules
162  i2c_master_t i2c;
164  // I2C slave address
165  uint8_t slave_address;
167 } stepdown10_t;
168 
173 typedef struct
174 {
175  pin_name_t scl;
176  pin_name_t sda;
178  pin_name_t en;
179  pin_name_t md;
180  pin_name_t pg;
182  uint32_t i2c_speed;
183  uint8_t i2c_address;
186 
191 typedef enum
192 {
194  STEPDOWN10_ERROR = -1
195 
197 
214 
229 
243 
258 err_t stepdown10_generic_write ( stepdown10_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
259 
274 err_t stepdown10_generic_read ( stepdown10_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
275 
285 void stepdown10_set_en_pin ( stepdown10_t *ctx, uint8_t pin_state );
286 
296 void stepdown10_set_md ( stepdown10_t *ctx, uint8_t mode );
297 
307 
319 err_t stepdown10_set_wiper_pos ( stepdown10_t *ctx, uint16_t wiper_pos );
320 
332 err_t stepdown10_set_r2_resistance ( stepdown10_t *ctx, uint32_t resistance );
333 
345 err_t stepdown10_set_output ( stepdown10_t *ctx, float voltage );
346 
347 #ifdef __cplusplus
348 }
349 #endif
350 #endif // STEPDOWN10_H
351  // stepdown10
353 
354 // ------------------------------------------------------------------------ END
stepdown10_set_md
void stepdown10_set_md(stepdown10_t *ctx, uint8_t mode)
Step Down 10 mode selection function.
stepdown10_cfg_t::en
pin_name_t en
Definition: stepdown10.h:178
stepdown10_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: stepdown10.h:182
stepdown10_t::pg
digital_in_t pg
Definition: stepdown10.h:159
stepdown10_default_cfg
err_t stepdown10_default_cfg(stepdown10_t *ctx)
Step Down 10 default configuration function.
stepdown10_cfg_t::md
pin_name_t md
Definition: stepdown10.h:179
stepdown10_t::md
digital_out_t md
Definition: stepdown10.h:156
stepdown10_cfg_t::sda
pin_name_t sda
Definition: stepdown10.h:176
stepdown10_cfg_t
Step Down 10 Click configuration object.
Definition: stepdown10.h:174
stepdown10_return_value_t
stepdown10_return_value_t
Step Down 10 Click return value data.
Definition: stepdown10.h:192
stepdown10_set_wiper_pos
err_t stepdown10_set_wiper_pos(stepdown10_t *ctx, uint16_t wiper_pos)
Step Down 10 set wiper position.
stepdown10_get_pg_state
uint8_t stepdown10_get_pg_state(stepdown10_t *ctx)
Step Down 10 get PG pin state function.
stepdown10_t
Step Down 10 Click context object.
Definition: stepdown10.h:153
stepdown10_set_output
err_t stepdown10_set_output(stepdown10_t *ctx, float voltage)
Step Down 10 set output voltage.
STEPDOWN10_OK
@ STEPDOWN10_OK
Definition: stepdown10.h:193
stepdown10_t::slave_address
uint8_t slave_address
Definition: stepdown10.h:165
stepdown10_generic_read
err_t stepdown10_generic_read(stepdown10_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Step Down 10 I2C reading function.
STEPDOWN10_ERROR
@ STEPDOWN10_ERROR
Definition: stepdown10.h:194
stepdown10_set_r2_resistance
err_t stepdown10_set_r2_resistance(stepdown10_t *ctx, uint32_t resistance)
Step Down 10 set potentiometer resistance.
stepdown10_cfg_t::pg
pin_name_t pg
Definition: stepdown10.h:180
stepdown10_cfg_t::scl
pin_name_t scl
Definition: stepdown10.h:175
stepdown10_init
err_t stepdown10_init(stepdown10_t *ctx, stepdown10_cfg_t *cfg)
Step Down 10 initialization function.
stepdown10_set_en_pin
void stepdown10_set_en_pin(stepdown10_t *ctx, uint8_t pin_state)
Step Down 10 set EN pin state function.
stepdown10_generic_write
err_t stepdown10_generic_write(stepdown10_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Step Down 10 I2C writing function.
stepdown10_cfg_t::i2c_address
uint8_t i2c_address
Definition: stepdown10.h:183
stepdown10_t::en
digital_out_t en
Definition: stepdown10.h:155
stepdown10_cfg_setup
void stepdown10_cfg_setup(stepdown10_cfg_t *cfg)
Step Down 10 configuration object setup function.
stepdown10_t::i2c
i2c_master_t i2c
Definition: stepdown10.h:162