charger11 2.0.0.0
charger11.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 CHARGER11_H
29#define CHARGER11_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#include "drv_spi_master.h"
39#include "spi_specifics.h"
40
61#define CHARGER11_SPI_VOLATILE_WIPER_0 0x00
62#define CHARGER11_SPI_VOLATILE_WIPER_1 0x01
63#define CHARGER11_SPI_NON_VOLATILE_WIPER_0 0x02
64#define CHARGER11_SPI_NON_VOLATILE_WIPER_1 0x03
65#define CHARGER11_SPI_VOLATILE_TCON 0x04
66#define CHARGER11_SPI_STATUS_REGISTER 0x05
67#define CHARGER11_SPI_DATA_EEPROM_0 0x06
68#define CHARGER11_SPI_DATA_EEPROM_1 0x07
69#define CHARGER11_SPI_DATA_EEPROM_2 0x08
70#define CHARGER11_SPI_DATA_EEPROM_3 0x09
71#define CHARGER11_SPI_DATA_EEPROM_4 0x0A
72#define CHARGER11_SPI_DATA_EEPROM_5 0x0B
73#define CHARGER11_SPI_DATA_EEPROM_6 0x0C
74#define CHARGER11_SPI_DATA_EEPROM_7 0x0D
75#define CHARGER11_SPI_DATA_EEPROM_8 0x0E
76#define CHARGER11_SPI_DATA_EEPROM_9 0x0F
77 // charger11_reg
79
94#define CHARGER11_PIN_ENABE 0x01
95#define CHARGER11_PIN_DISABLE 0x00
96
102#define CHARGER11_SET_DEV_ADDR 0x4D
103
112#define CHARGER11_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
113#define CHARGER11_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
114 // charger11_set
116
131#define CHARGER11_MAP_MIKROBUS( cfg, mikrobus ) \
132 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
133 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
134 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
135 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
136 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
137 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
138 cfg.lr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
139 cfg.lg = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
140 cfg.st = MIKROBUS( mikrobus, MIKROBUS_INT )
141 // charger11_map // charger11
144
149typedef struct charger11_s
150{
151 digital_out_t lr;
152 digital_out_t lg;
154 digital_in_t st;
156 i2c_master_t i2c;
157 spi_master_t spi;
160 pin_name_t chip_select;
163
168typedef struct
169{
170 pin_name_t scl;
171 pin_name_t sda;
172 pin_name_t miso;
173 pin_name_t mosi;
174 pin_name_t sck;
175 pin_name_t cs;
176 pin_name_t lr;
177 pin_name_t lg;
178 pin_name_t st;
180 uint32_t i2c_speed;
181 uint8_t i2c_address;
183 uint32_t spi_speed;
184 spi_master_mode_t spi_mode;
185 spi_master_chip_select_polarity_t cs_polarity;
188
193typedef enum
194{
196 CHARGER11_ERROR = -1
197
199
216
231
246err_t charger11_i2c_write ( charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
247
262err_t charger11_i2c_read ( charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
263
278err_t charger11_spi_write ( charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
279
294err_t charger11_spi_read ( charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
295
304
313void charger11_lr_set( charger11_t *ctx, uint8_t pin_state );
314
323void charger11_lg_set( charger11_t *ctx, uint8_t pin_state );
324
335void charger11_spi_transfer( charger11_t *ctx, uint8_t *data_in, uint8_t *data_out,
336 uint8_t len );
337
347void charger11_spi_set_register( charger11_t *ctx, uint8_t register_address,
348 uint16_t register_value );
349
359void charger11_spi_get_register( charger11_t *ctx, uint8_t register_address,
360 uint16_t * register_value );
361
370
379
388
397
408float charger11_i2c_get_volt( charger11_t *ctx, float reference_voltage );
409
410#ifdef __cplusplus
411}
412#endif
413#endif // CHARGER11_H
414 // charger11
416
417// ------------------------------------------------------------------------ END
struct charger11_s charger11_t
Charger 11 Click context object.
charger11_return_value_t
Charger 11 Click return value data.
Definition: charger11.h:194
@ CHARGER11_ERROR
Definition: charger11.h:196
@ CHARGER11_OK
Definition: charger11.h:195
uint8_t charger11_spi_get_wiper_position(charger11_t *ctx)
Charger 11 getting wiper position.
void charger11_lr_set(charger11_t *ctx, uint8_t pin_state)
Charger 11 setting AN pin state.
err_t charger11_i2c_read(charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Charger 11 I2C reading function.
void charger11_cfg_setup(charger11_cfg_t *cfg)
Charger 11 configuration object setup function.
void charger11_lg_set(charger11_t *ctx, uint8_t pin_state)
Charger 11 Setting PWM pin state.
void charger11_spi_decrement_wiper(charger11_t *ctx)
Charger 11 decrementing wiper position.
uint16_t charger11_i2c_get_raw_data(charger11_t *ctx)
Charger 11 getting raw ADC data.
void charger11_spi_increment_wiper(charger11_t *ctx)
Charger 11 incrementing wiper position.
err_t charger11_spi_write(charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Charger 11 SPI writing function.
float charger11_i2c_get_volt(charger11_t *ctx, float reference_voltage)
Charger 11 getting output voltage.
err_t charger11_init(charger11_t *ctx, charger11_cfg_t *cfg)
Charger 11 initialization function.
uint8_t charger11_get_int(charger11_t *ctx)
Charger 11 getting INT pin state.
void charger11_spi_set_register(charger11_t *ctx, uint8_t register_address, uint16_t register_value)
Charger 11 setting register.
err_t charger11_spi_read(charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Charger 11 SPI reading function.
void charger11_spi_transfer(charger11_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len)
Charger 11 transfering bytes via SPI.
err_t charger11_i2c_write(charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Charger 11 I2C writing function.
void charger11_spi_get_register(charger11_t *ctx, uint8_t register_address, uint16_t *register_value)
Charger 11 getting register value.
This file contains SPI specific macros, functions, etc.
Charger 11 Click configuration object.
Definition: charger11.h:169
pin_name_t st
Definition: charger11.h:178
uint32_t i2c_speed
Definition: charger11.h:180
pin_name_t lg
Definition: charger11.h:177
spi_master_chip_select_polarity_t cs_polarity
Definition: charger11.h:185
pin_name_t sck
Definition: charger11.h:174
spi_master_mode_t spi_mode
Definition: charger11.h:184
pin_name_t lr
Definition: charger11.h:176
pin_name_t mosi
Definition: charger11.h:173
uint32_t spi_speed
Definition: charger11.h:183
pin_name_t scl
Definition: charger11.h:170
pin_name_t miso
Definition: charger11.h:172
pin_name_t sda
Definition: charger11.h:171
pin_name_t cs
Definition: charger11.h:175
uint8_t i2c_address
Definition: charger11.h:181
Charger 11 Click context object.
Definition: charger11.h:150
spi_master_t spi
Definition: charger11.h:157
digital_in_t st
Definition: charger11.h:154
digital_out_t lg
Definition: charger11.h:152
i2c_master_t i2c
Definition: charger11.h:156
digital_out_t lr
Definition: charger11.h:151
uint8_t slave_address
Definition: charger11.h:159
pin_name_t chip_select
Definition: charger11.h:160