boostinv 2.0.0.0
boostinv.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
33// ----------------------------------------------------------------------------
34
35#ifndef BOOSTINV_H
36#define BOOSTINV_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41
42
43// -------------------------------------------------------------- PUBLIC MACROS
53#define BOOSTINV_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56 cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST );
63#define BOOSTINV_RETVAL uint8_t
64
65#define BOOSTINV_OK 0x00
66#define BOOSTINV_INIT_ERROR 0xFF
73#define BOOSTINV_I2C_SLAVE_ADDRESS_GND 0x30
74#define BOOSTINV_I2C_SLAVE_ADDRESS_VCC 0x31
81#define BOOSTINV_REG_POSITIVE_VOUT 0x00
82#define BOOSTINV_REG_NEGATIVE_VOUT 0x01
83#define BOOSTINV_REG_CONFIG 0x02
84#define BOOSTINV_REG_COMMAND 0x04
85#define BOOSTINV_REG_OTP0 0x00
86#define BOOSTINV_REG_OTP1 0x01
87#define BOOSTINV_REG_OTP2 0x02
94#define BOOSTINV_CFG_LOCKOUT_BIT_ENABLE 0x40
95#define BOOSTINV_CFG_LOCKOUT_BIT_DISABLE 0x00
96#define BOOSTINV_CFG_VPLUS_ENABLE 0x20
97#define BOOSTINV_CFG_VPLUS_DISABLE 0x00
98#define BOOSTINV_CFG_IRAMP_1uA 0x00
99#define BOOSTINV_CFG_IRAMP_2uA 0x08
100#define BOOSTINV_CFG_IRAMP_4uA 0x10
101#define BOOSTINV_CFG_IRAMP_8uA 0x18
102#define BOOSTINV_CFG_PDDIS_ENABLE 0x04
103#define BOOSTINV_CFG_PDDIS_DISABLE 0x00
104#define BOOSTINV_CFG_PUSEQ_OUTPUTS_DISABLED 0x00
105#define BOOSTINV_CFG_PUSEQ_VOUTN_RAMP_1ST 0x01
106#define BOOSTINV_CFG_PUSEQ_VOUTP_RAMP_1ST 0x02
107#define BOOSTINV_CFG_PUSEQ_BOTH_RAMP_TOGETHER 0x03
114#define BOOSTINV_CMD_WRITE_OTP_MEMORY 0x80
115#define BOOSTINV_CMD_CLEAR_OTP_FAULT 0x40
116#define BOOSTINV_CMD_RESET 0x20
117#define BOOSTINV_CMD_SWITCHES_OFF 0x10
118#define BOOSTINV_CMD_REGISTER_SELECT_POS_VOUT 0x04
119#define BOOSTINV_CMD_REGISTER_SELECT_NEG_VOUT 0x02
120#define BOOSTINV_CMD_REGISTER_SELECT_CONFIG 0x01
121#define BOOSTINV_CMD_REGISTER_SELECT_OTP2 0x00
122#define BOOSTINV_CMD_REGISTER_SELECT_OTP1 0x00
123#define BOOSTINV_CMD_REGISTER_SELECT_OTP0 0x00
130#define BOOSTINV_VOLTAGE_POSITIVE_3200_mV 3200
131#define BOOSTINV_VOLTAGE_POSITIVE_7750_mV 7750
132#define BOOSTINV_VOLTAGE_POSITIVE_12000_mV 12000
133#define BOOSTINV_VOLTAGE_NEGATIVE_1450_mV -1450
134#define BOOSTINV_VOLTAGE_NEGATIVE_6700_mV -6700
135#define BOOSTINV_VOLTAGE_NEGATIVE_11050_mV -11050 // End group macro
139// --------------------------------------------------------------- PUBLIC TYPES
148typedef struct
149{
150 // Output pins
151
152 digital_out_t en;
153
154 // Modules
155
156 i2c_master_t i2c;
157
158 // ctx variable
159
161
162} boostinv_t;
163
167typedef struct
168{
169 // Communication gpio pins
170
171 pin_name_t scl;
172 pin_name_t sda;
173
174 // Additional gpio pins
175
176 pin_name_t en;
177
178 // static variable
179
180 uint32_t i2c_speed;
181 uint8_t i2c_address;
182
184 // End types group
186
187// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
188
194#ifdef __cplusplus
195extern "C"{
196#endif
197
207
216
250
260void boostinv_generic_write ( boostinv_t *ctx, uint8_t reg_addr, uint8_t tx_data );
261
272uint8_t boostinv_generic_read ( boostinv_t *ctx, uint8_t reg_addr );
273
282
292void boostinv_set_positive_voltage ( boostinv_t *ctx, uint16_t voltage );
293
303void boostinv_set_negative_voltage ( boostinv_t *ctx, int16_t voltage );
304
305#ifdef __cplusplus
306}
307#endif
308#endif // _BOOSTINV_H_
309 // End public_function group
312
313// ------------------------------------------------------------------------- END
#define BOOSTINV_RETVAL
Definition: boostinv.h:63
BOOSTINV_RETVAL boostinv_init(boostinv_t *ctx, boostinv_cfg_t *cfg)
Initialization function.
void boostinv_generic_write(boostinv_t *ctx, uint8_t reg_addr, uint8_t tx_data)
Functions for write one byte in register.
void boostinv_cfg_setup(boostinv_cfg_t *cfg)
Config Object Initialization function.
uint8_t boostinv_generic_read(boostinv_t *ctx, uint8_t reg_addr)
Generic read function.
void boostinv_default_cfg(boostinv_t *ctx)
Click Default Configuration function.
void boostinv_set_positive_voltage(boostinv_t *ctx, uint16_t voltage)
Functions for set positive output voltage.
void boostinv_set_negative_voltage(boostinv_t *ctx, int16_t voltage)
Functions for set negative output voltage.
void boostinv_enable(boostinv_t *ctx)
Functions for enable chip.
Click configuration structure definition.
Definition: boostinv.h:168
uint32_t i2c_speed
Definition: boostinv.h:180
pin_name_t scl
Definition: boostinv.h:171
pin_name_t en
Definition: boostinv.h:176
pin_name_t sda
Definition: boostinv.h:172
uint8_t i2c_address
Definition: boostinv.h:181
Click ctx object definition.
Definition: boostinv.h:149
i2c_master_t i2c
Definition: boostinv.h:156
digital_out_t en
Definition: boostinv.h:152
uint8_t slave_address
Definition: boostinv.h:160