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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define STEPDOWN5_PFM_PWM_MODE 0x00
60#define STEPDOWN5_FORCED_PWM_MODE 0x01
61#define STEPDOWN5_R1_RPROG_ADDRESS 0x00
62#define STEPDOWN5_R2_RPROG_ADDRESS 0x10
63
68#define STEPDOWN5_DIGIPOT_MAX_VALUE 100000ul
69#define STEPDOWN5_DIGIPOT_RESOLUTION 257
70#define STEPDOWN5_ROUND_TO_NEAREST_INT 0.5
71
76#define STEPDOWN5_OUTPUT_0V6 1
77#define STEPDOWN5_OUTPUT_1V5 2
78#define STEPDOWN5_OUTPUT_2V5 3
79#define STEPDOWN5_OUTPUT_3V3 4
80#define STEPDOWN5_OUTPUT_5V 5
81
87#define STEPDOWN5_ADDR_A2A1A0_000 0x28
88#define STEPDOWN5_ADDR_A2A1A0_001 0x29
89#define STEPDOWN5_ADDR_A2A1A0_010 0x2A
90#define STEPDOWN5_ADDR_A2A1A0_011 0x2B
91#define STEPDOWN5_ADDR_A2A1A0_100 0x2C
92#define STEPDOWN5_ADDR_A2A1A0_101 0x2D
93#define STEPDOWN5_ADDR_A2A1A0_110 0x2E
94#define STEPDOWN5_ADDR_A2A1A0_111 0x2F
95 // stepdown5_set
97
112#define STEPDOWN5_MAP_MIKROBUS( cfg, mikrobus ) \
113 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
114 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
115 cfg.md = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
116 cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
117 // stepdown5_map // stepdown5
120
125typedef struct
126{
127 // Output pins
128 digital_out_t md;
130 // Input pins
131 digital_in_t pg;
133 // Modules
134 i2c_master_t i2c;
136 // I2C slave address
140
145typedef struct
146{
147 pin_name_t scl;
148 pin_name_t sda;
150 pin_name_t md;
151 pin_name_t pg;
153 uint32_t i2c_speed;
154 uint8_t i2c_address;
157
162typedef enum
163{
165 STEPDOWN5_ERROR = -1
166
168
185
200
214
229err_t stepdown5_generic_write ( stepdown5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
230
245err_t stepdown5_generic_read ( stepdown5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
246
256void stepdown5_set_mode ( stepdown5_t *ctx, uint8_t mode );
257
267
279err_t stepdown5_set_wiper_0_pos ( stepdown5_t *ctx, uint16_t wiper_0_pos );
280
292err_t stepdown5_set_wiper_1_pos ( stepdown5_t *ctx, uint16_t wiper_1_pos );
293
305err_t stepdown5_set_r1_resistance ( stepdown5_t *ctx, uint32_t resistance );
306
318err_t stepdown5_set_r2_resistance ( stepdown5_t *ctx, uint32_t resistance );
319
331err_t stepdown5_set_output ( stepdown5_t *ctx, uint8_t voltage );
332
333#ifdef __cplusplus
334}
335#endif
336#endif // STEPDOWN5_H
337 // stepdown5
339
340// ------------------------------------------------------------------------ END
err_t stepdown5_set_wiper_1_pos(stepdown5_t *ctx, uint16_t wiper_1_pos)
Step Down 5 set wiper 1 position.
err_t stepdown5_generic_read(stepdown5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Step Down 5 I2C reading function.
err_t stepdown5_set_r2_resistance(stepdown5_t *ctx, uint32_t resistance)
Step Down 5 set potentiometer 1 resistance.
void stepdown5_cfg_setup(stepdown5_cfg_t *cfg)
Step Down 5 configuration object setup function.
err_t stepdown5_generic_write(stepdown5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Step Down 5 I2C writing function.
err_t stepdown5_set_r1_resistance(stepdown5_t *ctx, uint32_t resistance)
Step Down 5 set potentiometer 0 resistance.
err_t stepdown5_set_output(stepdown5_t *ctx, uint8_t voltage)
Step Down 5 set output voltage.
uint8_t stepdown5_get_pg_state(stepdown5_t *ctx)
Step Down 5 get PG pin state function.
err_t stepdown5_init(stepdown5_t *ctx, stepdown5_cfg_t *cfg)
Step Down 5 initialization function.
void stepdown5_set_mode(stepdown5_t *ctx, uint8_t mode)
Step Down 5 mode selection function.
err_t stepdown5_default_cfg(stepdown5_t *ctx)
Step Down 5 default configuration function.
err_t stepdown5_set_wiper_0_pos(stepdown5_t *ctx, uint16_t wiper_0_pos)
Step Down 5 set wiper 0 position.
stepdown5_return_value_t
Step Down 5 Click return value data.
Definition: stepdown5.h:163
@ STEPDOWN5_OK
Definition: stepdown5.h:164
@ STEPDOWN5_ERROR
Definition: stepdown5.h:165
Step Down 5 Click configuration object.
Definition: stepdown5.h:146
uint32_t i2c_speed
Definition: stepdown5.h:153
pin_name_t md
Definition: stepdown5.h:150
pin_name_t scl
Definition: stepdown5.h:147
pin_name_t sda
Definition: stepdown5.h:148
pin_name_t pg
Definition: stepdown5.h:151
uint8_t i2c_address
Definition: stepdown5.h:154
Step Down 5 Click context object.
Definition: stepdown5.h:126
digital_out_t md
Definition: stepdown5.h:128
i2c_master_t i2c
Definition: stepdown5.h:134
uint8_t slave_address
Definition: stepdown5.h:137
digital_in_t pg
Definition: stepdown5.h:131