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
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 #include "drv_spi_master.h"
49 #include "spi_specifics.h"
50 
71 #define CHARGER11_SPI_VOLATILE_WIPER_0 0x00
72 #define CHARGER11_SPI_VOLATILE_WIPER_1 0x01
73 #define CHARGER11_SPI_NON_VOLATILE_WIPER_0 0x02
74 #define CHARGER11_SPI_NON_VOLATILE_WIPER_1 0x03
75 #define CHARGER11_SPI_VOLATILE_TCON 0x04
76 #define CHARGER11_SPI_STATUS_REGISTER 0x05
77 #define CHARGER11_SPI_DATA_EEPROM_0 0x06
78 #define CHARGER11_SPI_DATA_EEPROM_1 0x07
79 #define CHARGER11_SPI_DATA_EEPROM_2 0x08
80 #define CHARGER11_SPI_DATA_EEPROM_3 0x09
81 #define CHARGER11_SPI_DATA_EEPROM_4 0x0A
82 #define CHARGER11_SPI_DATA_EEPROM_5 0x0B
83 #define CHARGER11_SPI_DATA_EEPROM_6 0x0C
84 #define CHARGER11_SPI_DATA_EEPROM_7 0x0D
85 #define CHARGER11_SPI_DATA_EEPROM_8 0x0E
86 #define CHARGER11_SPI_DATA_EEPROM_9 0x0F
87  // charger11_reg
89 
104 #define CHARGER11_PIN_ENABE 0x01
105 #define CHARGER11_PIN_DISABLE 0x00
106 
112 #define CHARGER11_SET_DEV_ADDR 0x4D
113 
122 #define CHARGER11_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
123 #define CHARGER11_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
124  // charger11_set
126 
141 #define CHARGER11_MAP_MIKROBUS( cfg, mikrobus ) \
142  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
143  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
144  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
145  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
146  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
147  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
148  cfg.lr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
149  cfg.lg = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
150  cfg.st = MIKROBUS( mikrobus, MIKROBUS_INT )
151  // charger11_map // charger11
154 
159 typedef struct charger11_s
160 {
161  digital_out_t lr;
162  digital_out_t lg;
164  digital_in_t st;
166  i2c_master_t i2c;
167  spi_master_t spi;
169  uint8_t slave_address;
170  pin_name_t chip_select;
173 
178 typedef struct
179 {
180  pin_name_t scl;
181  pin_name_t sda;
182  pin_name_t miso;
183  pin_name_t mosi;
184  pin_name_t sck;
185  pin_name_t cs;
186  pin_name_t lr;
187  pin_name_t lg;
188  pin_name_t st;
190  uint32_t i2c_speed;
191  uint8_t i2c_address;
193  uint32_t spi_speed;
194  spi_master_mode_t spi_mode;
195  spi_master_chip_select_polarity_t cs_polarity;
198 
203 typedef enum
204 {
206  CHARGER11_ERROR = -1
207 
209 
226 
241 
256 err_t charger11_i2c_write ( charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
257 
272 err_t charger11_i2c_read ( charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
273 
288 err_t charger11_spi_write ( charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
289 
304 err_t charger11_spi_read ( charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
305 
314 
323 void charger11_lr_set( charger11_t *ctx, uint8_t pin_state );
324 
333 void charger11_lg_set( charger11_t *ctx, uint8_t pin_state );
334 
345 void charger11_spi_transfer( charger11_t *ctx, uint8_t *data_in, uint8_t *data_out,
346  uint8_t len );
347 
357 void charger11_spi_set_register( charger11_t *ctx, uint8_t register_address,
358  uint16_t register_value );
359 
369 void charger11_spi_get_register( charger11_t *ctx, uint8_t register_address,
370  uint16_t * register_value );
371 
380 
389 
398 
407 
418 float charger11_i2c_get_volt( charger11_t *ctx, float reference_voltage );
419 
420 #ifdef __cplusplus
421 }
422 #endif
423 #endif // CHARGER11_H
424  // charger11
426 
427 // ------------------------------------------------------------------------ END
charger11_spi_write
err_t charger11_spi_write(charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Charger 11 SPI writing function.
charger11_s::chip_select
pin_name_t chip_select
Definition: charger11.h:170
charger11_cfg_t::st
pin_name_t st
Definition: charger11.h:188
charger11_lg_set
void charger11_lg_set(charger11_t *ctx, uint8_t pin_state)
Charger 11 Setting PWM pin state.
charger11_cfg_t::scl
pin_name_t scl
Definition: charger11.h:180
charger11_lr_set
void charger11_lr_set(charger11_t *ctx, uint8_t pin_state)
Charger 11 setting AN pin state.
charger11_spi_get_wiper_position
uint8_t charger11_spi_get_wiper_position(charger11_t *ctx)
Charger 11 getting wiper position.
charger11_spi_decrement_wiper
void charger11_spi_decrement_wiper(charger11_t *ctx)
Charger 11 decrementing wiper position.
charger11_s::st
digital_in_t st
Definition: charger11.h:164
spi_specifics.h
This file contains SPI specific macros, functions, etc.
charger11_i2c_write
err_t charger11_i2c_write(charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Charger 11 I2C writing function.
charger11_spi_get_register
void charger11_spi_get_register(charger11_t *ctx, uint8_t register_address, uint16_t *register_value)
Charger 11 getting register value.
charger11_cfg_setup
void charger11_cfg_setup(charger11_cfg_t *cfg)
Charger 11 configuration object setup function.
charger11_return_value_t
charger11_return_value_t
Charger 11 Click return value data.
Definition: charger11.h:204
charger11_cfg_t::lr
pin_name_t lr
Definition: charger11.h:186
charger11_s::lr
digital_out_t lr
Definition: charger11.h:161
charger11_i2c_get_volt
float charger11_i2c_get_volt(charger11_t *ctx, float reference_voltage)
Charger 11 getting output voltage.
charger11_cfg_t::cs
pin_name_t cs
Definition: charger11.h:185
charger11_s::lg
digital_out_t lg
Definition: charger11.h:162
charger11_spi_increment_wiper
void charger11_spi_increment_wiper(charger11_t *ctx)
Charger 11 incrementing wiper position.
charger11_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: charger11.h:195
CHARGER11_ERROR
@ CHARGER11_ERROR
Definition: charger11.h:206
charger11_spi_read
err_t charger11_spi_read(charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Charger 11 SPI reading function.
charger11_cfg_t::lg
pin_name_t lg
Definition: charger11.h:187
charger11_s::slave_address
uint8_t slave_address
Definition: charger11.h:169
charger11_cfg_t::i2c_address
uint8_t i2c_address
Definition: charger11.h:191
CHARGER11_OK
@ CHARGER11_OK
Definition: charger11.h:205
charger11_cfg_t::spi_speed
uint32_t spi_speed
Definition: charger11.h:193
charger11_s::i2c
i2c_master_t i2c
Definition: charger11.h:166
charger11_t
struct charger11_s charger11_t
Charger 11 Click context object.
charger11_spi_set_register
void charger11_spi_set_register(charger11_t *ctx, uint8_t register_address, uint16_t register_value)
Charger 11 setting register.
charger11_cfg_t::sda
pin_name_t sda
Definition: charger11.h:181
charger11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: charger11.h:190
charger11_cfg_t::mosi
pin_name_t mosi
Definition: charger11.h:183
charger11_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: charger11.h:194
charger11_s
Charger 11 Click context object.
Definition: charger11.h:160
charger11_get_int
uint8_t charger11_get_int(charger11_t *ctx)
Charger 11 getting INT pin state.
charger11_i2c_get_raw_data
uint16_t charger11_i2c_get_raw_data(charger11_t *ctx)
Charger 11 getting raw ADC data.
charger11_i2c_read
err_t charger11_i2c_read(charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Charger 11 I2C reading function.
charger11_cfg_t::sck
pin_name_t sck
Definition: charger11.h:184
charger11_cfg_t
Charger 11 Click configuration object.
Definition: charger11.h:179
charger11_spi_transfer
void charger11_spi_transfer(charger11_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len)
Charger 11 transfering bytes via SPI.
charger11_s::spi
spi_master_t spi
Definition: charger11.h:167
charger11_init
err_t charger11_init(charger11_t *ctx, charger11_cfg_t *cfg)
Charger 11 initialization function.
charger11_cfg_t::miso
pin_name_t miso
Definition: charger11.h:182