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 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define STEPDOWN12_DIGIPOT_MAX_VALUE 100000ul
70 #define STEPDOWN12_DIGIPOT_MIN_VALUE 0
71 #define STEPDOWN12_DIGIPOT_RESOLUTION 256
72 #define STEPDOWN12_ROUND_TO_NEAREST_INT 0.5
73 #define STEPDOWN12_WIPER_RESISTANCE 75
74 
79 #define STEPDOWN12_R1 82000ul
80 #define STEPDOWN12_R2 10000ul
81 #define STEPDOWN12_VFB 0.6f
82 #define STEPDOWN12_VOUT_MIN 1.05f
83 #define STEPDOWN12_VOUT_MAX 5.5f
84 
90 #define STEPDOWN12_ADDR_A2A1A0_000 0x28
91 #define STEPDOWN12_ADDR_A2A1A0_001 0x29
92 #define STEPDOWN12_ADDR_A2A1A0_010 0x2A
93 #define STEPDOWN12_ADDR_A2A1A0_011 0x2B
94 #define STEPDOWN12_ADDR_A2A1A0_100 0x2C
95 #define STEPDOWN12_ADDR_A2A1A0_101 0x2D
96 #define STEPDOWN12_ADDR_A2A1A0_110 0x2E
97 #define STEPDOWN12_ADDR_A2A1A0_111 0x2F
98  // stepdown12_set
100 
115 #define STEPDOWN12_MAP_MIKROBUS( cfg, mikrobus ) \
116  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
117  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
118  cfg.mode = MIKROBUS( mikrobus, MIKROBUS_RST ); \
119  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
120  cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
121  // stepdown12_map // stepdown12
124 
129 typedef struct
130 {
131  // Output pins
132  digital_out_t mode;
133  digital_out_t en;
135  // Input pins
136  digital_in_t pg;
138  // Modules
139  i2c_master_t i2c;
141  // I2C slave address
142  uint8_t slave_address;
144 } stepdown12_t;
145 
150 typedef struct
151 {
152  pin_name_t scl;
153  pin_name_t sda;
155  pin_name_t mode;
156  pin_name_t en;
157  pin_name_t pg;
159  uint32_t i2c_speed;
160  uint8_t i2c_address;
163 
168 typedef enum
169 {
171  STEPDOWN12_ERROR = -1
172 
174 
191 
206 
218 
230 err_t stepdown12_set_resistance ( stepdown12_t *ctx, uint32_t res_ohm );
231 
243 err_t stepdown12_set_vout ( stepdown12_t *ctx, float vout );
244 
254 
264 
274 
284 
294 
295 #ifdef __cplusplus
296 }
297 #endif
298 #endif // STEPDOWN12_H
299  // stepdown12
301 
302 // ------------------------------------------------------------------------ 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:132
stepdown12_cfg_t::scl
pin_name_t scl
Definition: stepdown12.h:152
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:170
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:169
stepdown12_cfg_t::pg
pin_name_t pg
Definition: stepdown12.h:157
stepdown12_t::pg
digital_in_t pg
Definition: stepdown12.h:136
stepdown12_cfg_t
Step Down 12 Click configuration object.
Definition: stepdown12.h:151
stepdown12_cfg_t::en
pin_name_t en
Definition: stepdown12.h:156
stepdown12_t
Step Down 12 Click context object.
Definition: stepdown12.h:130
stepdown12_cfg_t::i2c_address
uint8_t i2c_address
Definition: stepdown12.h:160
stepdown12_cfg_t::mode
pin_name_t mode
Definition: stepdown12.h:155
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:171
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:142
stepdown12_cfg_t::sda
pin_name_t sda
Definition: stepdown12.h:153
stepdown12_t::i2c
i2c_master_t i2c
Definition: stepdown12.h:139
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:159
stepdown12_t::en
digital_out_t en
Definition: stepdown12.h:133
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.