stepdown5  2.1.0.0
stepdown5.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 STEPDOWN5_H
29 #define STEPDOWN5_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 STEPDOWN5_PFM_PWM_MODE 0x00
74 #define STEPDOWN5_FORCED_PWM_MODE 0x01
75 #define STEPDOWN5_R1_RPROG_ADDRESS 0x00
76 #define STEPDOWN5_R2_RPROG_ADDRESS 0x10
77 
82 #define STEPDOWN5_DIGIPOT_MAX_VALUE 100000ul
83 #define STEPDOWN5_DIGIPOT_RESOLUTION 257
84 #define STEPDOWN5_ROUND_TO_NEAREST_INT 0.5
85 
90 #define STEPDOWN5_OUTPUT_0V6 1
91 #define STEPDOWN5_OUTPUT_1V5 2
92 #define STEPDOWN5_OUTPUT_2V5 3
93 #define STEPDOWN5_OUTPUT_3V3 4
94 #define STEPDOWN5_OUTPUT_5V 5
95 
101 #define STEPDOWN5_ADDR_A2A1A0_000 0x28
102 #define STEPDOWN5_ADDR_A2A1A0_001 0x29
103 #define STEPDOWN5_ADDR_A2A1A0_010 0x2A
104 #define STEPDOWN5_ADDR_A2A1A0_011 0x2B
105 #define STEPDOWN5_ADDR_A2A1A0_100 0x2C
106 #define STEPDOWN5_ADDR_A2A1A0_101 0x2D
107 #define STEPDOWN5_ADDR_A2A1A0_110 0x2E
108 #define STEPDOWN5_ADDR_A2A1A0_111 0x2F
109  // stepdown5_set
111 
126 #define STEPDOWN5_MAP_MIKROBUS( cfg, mikrobus ) \
127  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
128  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
129  cfg.md = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
130  cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
131  // stepdown5_map // stepdown5
134 
139 typedef struct
140 {
141  // Output pins
142  digital_out_t md;
144  // Input pins
145  digital_in_t pg;
147  // Modules
148  i2c_master_t i2c;
150  // I2C slave address
151  uint8_t slave_address;
153 } stepdown5_t;
154 
159 typedef struct
160 {
161  pin_name_t scl;
162  pin_name_t sda;
164  pin_name_t md;
165  pin_name_t pg;
167  uint32_t i2c_speed;
168  uint8_t i2c_address;
171 
176 typedef enum
177 {
179  STEPDOWN5_ERROR = -1
180 
182 
199 
214 
228 
243 err_t stepdown5_generic_write ( stepdown5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
244 
259 err_t stepdown5_generic_read ( stepdown5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
260 
270 void stepdown5_set_mode ( stepdown5_t *ctx, uint8_t mode );
271 
281 
293 err_t stepdown5_set_wiper_0_pos ( stepdown5_t *ctx, uint16_t wiper_0_pos );
294 
306 err_t stepdown5_set_wiper_1_pos ( stepdown5_t *ctx, uint16_t wiper_1_pos );
307 
319 err_t stepdown5_set_r1_resistance ( stepdown5_t *ctx, uint32_t resistance );
320 
332 err_t stepdown5_set_r2_resistance ( stepdown5_t *ctx, uint32_t resistance );
333 
345 err_t stepdown5_set_output ( stepdown5_t *ctx, uint8_t voltage );
346 
347 #ifdef __cplusplus
348 }
349 #endif
350 #endif // STEPDOWN5_H
351  // stepdown5
353 
354 // ------------------------------------------------------------------------ END
stepdown5_cfg_t::md
pin_name_t md
Definition: stepdown5.h:164
STEPDOWN5_ERROR
@ STEPDOWN5_ERROR
Definition: stepdown5.h:179
stepdown5_generic_read
err_t stepdown5_generic_read(stepdown5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Step Down 5 I2C reading function.
stepdown5_set_r2_resistance
err_t stepdown5_set_r2_resistance(stepdown5_t *ctx, uint32_t resistance)
Step Down 5 set potentiometer 1 resistance.
stepdown5_t::md
digital_out_t md
Definition: stepdown5.h:142
stepdown5_cfg_t::sda
pin_name_t sda
Definition: stepdown5.h:162
stepdown5_cfg_t::scl
pin_name_t scl
Definition: stepdown5.h:161
stepdown5_get_pg_state
uint8_t stepdown5_get_pg_state(stepdown5_t *ctx)
Step Down 5 get PG pin state function.
stepdown5_cfg_t
Step Down 5 Click configuration object.
Definition: stepdown5.h:160
stepdown5_generic_write
err_t stepdown5_generic_write(stepdown5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Step Down 5 I2C writing function.
stepdown5_cfg_t::pg
pin_name_t pg
Definition: stepdown5.h:165
stepdown5_return_value_t
stepdown5_return_value_t
Step Down 5 Click return value data.
Definition: stepdown5.h:177
STEPDOWN5_OK
@ STEPDOWN5_OK
Definition: stepdown5.h:178
stepdown5_init
err_t stepdown5_init(stepdown5_t *ctx, stepdown5_cfg_t *cfg)
Step Down 5 initialization function.
stepdown5_cfg_setup
void stepdown5_cfg_setup(stepdown5_cfg_t *cfg)
Step Down 5 configuration object setup function.
stepdown5_set_mode
void stepdown5_set_mode(stepdown5_t *ctx, uint8_t mode)
Step Down 5 mode selection function.
stepdown5_set_r1_resistance
err_t stepdown5_set_r1_resistance(stepdown5_t *ctx, uint32_t resistance)
Step Down 5 set potentiometer 0 resistance.
stepdown5_set_wiper_0_pos
err_t stepdown5_set_wiper_0_pos(stepdown5_t *ctx, uint16_t wiper_0_pos)
Step Down 5 set wiper 0 position.
stepdown5_t::slave_address
uint8_t slave_address
Definition: stepdown5.h:151
stepdown5_set_wiper_1_pos
err_t stepdown5_set_wiper_1_pos(stepdown5_t *ctx, uint16_t wiper_1_pos)
Step Down 5 set wiper 1 position.
stepdown5_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: stepdown5.h:167
stepdown5_t
Step Down 5 Click context object.
Definition: stepdown5.h:140
stepdown5_t::i2c
i2c_master_t i2c
Definition: stepdown5.h:148
stepdown5_cfg_t::i2c_address
uint8_t i2c_address
Definition: stepdown5.h:168
stepdown5_set_output
err_t stepdown5_set_output(stepdown5_t *ctx, uint8_t voltage)
Step Down 5 set output voltage.
stepdown5_default_cfg
err_t stepdown5_default_cfg(stepdown5_t *ctx)
Step Down 5 default configuration function.
stepdown5_t::pg
digital_in_t pg
Definition: stepdown5.h:145