stepdown12  2.1.0.0
stepdown12.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 STEPDOWN12_H
29 #define STEPDOWN12_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 STEPDOWN12_DIGIPOT_MAX_VALUE 100000ul
74 #define STEPDOWN12_DIGIPOT_MIN_VALUE 0
75 #define STEPDOWN12_DIGIPOT_RESOLUTION 256
76 #define STEPDOWN12_ROUND_TO_NEAREST_INT 0.5
77 #define STEPDOWN12_WIPER_RESISTANCE 75
78 
83 #define STEPDOWN12_R1 82000ul
84 #define STEPDOWN12_R2 10000ul
85 #define STEPDOWN12_VFB 0.6f
86 #define STEPDOWN12_VOUT_MIN 1.05f
87 #define STEPDOWN12_VOUT_MAX 5.5f
88 
94 #define STEPDOWN12_ADDR_A2A1A0_000 0x28
95 #define STEPDOWN12_ADDR_A2A1A0_001 0x29
96 #define STEPDOWN12_ADDR_A2A1A0_010 0x2A
97 #define STEPDOWN12_ADDR_A2A1A0_011 0x2B
98 #define STEPDOWN12_ADDR_A2A1A0_100 0x2C
99 #define STEPDOWN12_ADDR_A2A1A0_101 0x2D
100 #define STEPDOWN12_ADDR_A2A1A0_110 0x2E
101 #define STEPDOWN12_ADDR_A2A1A0_111 0x2F
102  // stepdown12_set
104 
119 #define STEPDOWN12_MAP_MIKROBUS( cfg, mikrobus ) \
120  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
121  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
122  cfg.mode = MIKROBUS( mikrobus, MIKROBUS_RST ); \
123  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
124  cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
125  // stepdown12_map // stepdown12
128 
133 typedef struct
134 {
135  // Output pins
136  digital_out_t mode;
137  digital_out_t en;
139  // Input pins
140  digital_in_t pg;
142  // Modules
143  i2c_master_t i2c;
145  // I2C slave address
146  uint8_t slave_address;
148 } stepdown12_t;
149 
154 typedef struct
155 {
156  pin_name_t scl;
157  pin_name_t sda;
159  pin_name_t mode;
160  pin_name_t en;
161  pin_name_t pg;
163  uint32_t i2c_speed;
164  uint8_t i2c_address;
167 
172 typedef enum
173 {
175  STEPDOWN12_ERROR = -1
176 
178 
195 
210 
222 
234 err_t stepdown12_set_resistance ( stepdown12_t *ctx, uint32_t res_ohm );
235 
247 err_t stepdown12_set_vout ( stepdown12_t *ctx, float vout );
248 
258 
268 
278 
288 
298 
299 #ifdef __cplusplus
300 }
301 #endif
302 #endif // STEPDOWN12_H
303  // stepdown12
305 
306 // ------------------------------------------------------------------------ END
stepdown12_default_cfg
void stepdown12_default_cfg(stepdown12_t *ctx)
Step Down 12 default configuration function.
stepdown12_t::mode
digital_out_t mode
Definition: stepdown12.h:136
stepdown12_cfg_t::scl
pin_name_t scl
Definition: stepdown12.h:156
stepdown12_set_resistance
err_t stepdown12_set_resistance(stepdown12_t *ctx, uint32_t res_ohm)
Step Down 12 set resistance function.
stepdown12_disable_device
void stepdown12_disable_device(stepdown12_t *ctx)
Step Down 12 disable device function.
stepdown12_enable_device
void stepdown12_enable_device(stepdown12_t *ctx)
Step Down 12 enable device function.
STEPDOWN12_OK
@ STEPDOWN12_OK
Definition: stepdown12.h:174
stepdown12_cfg_setup
void stepdown12_cfg_setup(stepdown12_cfg_t *cfg)
Step Down 12 configuration object setup function.
stepdown12_return_value_t
stepdown12_return_value_t
Step Down 12 Click return value data.
Definition: stepdown12.h:173
stepdown12_cfg_t::pg
pin_name_t pg
Definition: stepdown12.h:161
stepdown12_t::pg
digital_in_t pg
Definition: stepdown12.h:140
stepdown12_cfg_t
Step Down 12 Click configuration object.
Definition: stepdown12.h:155
stepdown12_cfg_t::en
pin_name_t en
Definition: stepdown12.h:160
stepdown12_t
Step Down 12 Click context object.
Definition: stepdown12.h:134
stepdown12_cfg_t::i2c_address
uint8_t i2c_address
Definition: stepdown12.h:164
stepdown12_cfg_t::mode
pin_name_t mode
Definition: stepdown12.h:159
stepdown12_mode_auto_pwm
void stepdown12_mode_auto_pwm(stepdown12_t *ctx)
Step Down 12 mode auto pwm function.
STEPDOWN12_ERROR
@ STEPDOWN12_ERROR
Definition: stepdown12.h:175
stepdown12_set_vout
err_t stepdown12_set_vout(stepdown12_t *ctx, float vout)
Step Down 12 set vout function.
stepdown12_t::slave_address
uint8_t slave_address
Definition: stepdown12.h:146
stepdown12_cfg_t::sda
pin_name_t sda
Definition: stepdown12.h:157
stepdown12_t::i2c
i2c_master_t i2c
Definition: stepdown12.h:143
stepdown12_init
err_t stepdown12_init(stepdown12_t *ctx, stepdown12_cfg_t *cfg)
Step Down 12 initialization function.
stepdown12_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: stepdown12.h:163
stepdown12_t::en
digital_out_t en
Definition: stepdown12.h:137
stepdown12_mode_forced_pwm
void stepdown12_mode_forced_pwm(stepdown12_t *ctx)
Step Down 12 mode forced pwm function.
stepdown12_get_pg_pin
uint8_t stepdown12_get_pg_pin(stepdown12_t *ctx)
Step Down 12 get pg pin function.