charger12 2.0.0.0
charger12.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 CHARGER12_H
36#define CHARGER12_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_spi_master.h"
41
42
43// -------------------------------------------------------------- PUBLIC MACROS
54#define CHARGER12_MAP_MIKROBUS( cfg, mikrobus ) \
55 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59 cfg.che = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60 cfg.mod = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
61 cfg.vok = MIKROBUS( mikrobus, MIKROBUS_INT )
68#define CHARGER12_RETVAL uint8_t
69
70#define CHARGER12_OK 0x00
71#define CHARGER12_INIT_ERROR 0xFF
78#define CHARGER12_SPI_VOLATILE_WIPER_0 0x00
79#define CHARGER12_SPI_VOLATILE_WIPER_1 0x01
80#define CHARGER12_SPI_NON_VOLATILE_WIPER_0 0x02
81#define CHARGER12_SPI_NON_VOLATILE_WIPER_1 0x03
82#define CHARGER12_SPI_VOLATILE_TCON 0x04
83#define CHARGER12_SPI_STATUS_REGISTER 0x05
84#define CHARGER12_SPI_DATA_EEPROM_0 0x06
85#define CHARGER12_SPI_DATA_EEPROM_1 0x07
86#define CHARGER12_SPI_DATA_EEPROM_2 0x08
87#define CHARGER12_SPI_DATA_EEPROM_3 0x09
88#define CHARGER12_SPI_DATA_EEPROM_4 0x0A
89#define CHARGER12_SPI_DATA_EEPROM_5 0x0B
90#define CHARGER12_SPI_DATA_EEPROM_6 0x0C
91#define CHARGER12_SPI_DATA_EEPROM_7 0x0D
92#define CHARGER12_SPI_DATA_EEPROM_8 0x0E
93#define CHARGER12_SPI_DATA_EEPROM_9 0x0F
100#define CHARGER12_MODE_Li 0
101#define CHARGER12_MODE_NiMh_NiCd 1
102#define CHARGER12_MODE_DISABLE 2
103#define CHARGER12_MODE_NO_BATTERY 3 // End group macro
107// --------------------------------------------------------------- PUBLIC TYPES
116typedef struct
117{
118 // Output pins
119
120 digital_out_t cs;
121 digital_out_t che;
122 digital_out_t mod;
123
124 // Input pins
125
126 digital_in_t vok;
127
128 // Modules
129
130 spi_master_t spi;
131 pin_name_t chip_select;
132
134
138typedef struct
139{
140 // Communication gpio pins
141
142 pin_name_t miso;
143 pin_name_t mosi;
144 pin_name_t sck;
145 pin_name_t cs;
146
147 // Additional gpio pins
148
149 pin_name_t che;
150 pin_name_t mod;
151 pin_name_t vok;
152
153 // static variable
154
155 uint32_t spi_speed;
156 spi_master_mode_t spi_mode;
157 spi_master_chip_select_polarity_t cs_polarity;
158
160 // End types group
162// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
163
168#ifdef __cplusplus
169extern "C"{
170#endif
171
181
191
203void charger12_generic_transfer ( charger12_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t tx_len, uint8_t rx_len );
204uint8_t charger12_int_get ( charger12_t *ctx );
212void charger12_pwm_set ( charger12_t *ctx, uint8_t pin_state );
221void charger12_rst_set ( charger12_t *ctx, uint8_t pin_state );
230void charger12_cs_set ( charger12_t *ctx, uint8_t pin_state );
239uint8_t charger12_mode_select ( charger12_t *ctx, uint8_t mode_select );
248void charger12_spi_set_register( charger12_t *ctx, uint8_t register_address, uint16_t register_value );
274
275
276
277#ifdef __cplusplus
278}
279#endif
280#endif // _CHARGER12_H_
281 // End public_function group
284
285// ------------------------------------------------------------------------- END
#define CHARGER12_RETVAL
Definition: charger12.h:68
void charger12_generic_transfer(charger12_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t tx_len, uint8_t rx_len)
Generic transfer function.
void charger12_rst_set(charger12_t *ctx, uint8_t pin_state)
Setting RST pin state.
void charger12_spi_decrement_wiper(charger12_t *ctx)
Decrementing wiper position.
void charger12_spi_increment_wiper(charger12_t *ctx)
Incrementing wiper position.
void charger12_spi_set_register(charger12_t *ctx, uint8_t register_address, uint16_t register_value)
Setting register.
uint8_t charger12_mode_select(charger12_t *ctx, uint8_t mode_select)
Selecting device operation mode.
void charger12_cs_set(charger12_t *ctx, uint8_t pin_state)
Setting CS pin state.
uint8_t charger12_int_get(charger12_t *ctx)
Getting INT pin state.
void charger12_pwm_set(charger12_t *ctx, uint8_t pin_state)
Setting PWM pin state.
CHARGER12_RETVAL charger12_init(charger12_t *ctx, charger12_cfg_t *cfg)
Initialization function.
void charger12_cfg_setup(charger12_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition: charger12.h:139
spi_master_chip_select_polarity_t cs_polarity
Definition: charger12.h:157
pin_name_t vok
Definition: charger12.h:151
pin_name_t sck
Definition: charger12.h:144
spi_master_mode_t spi_mode
Definition: charger12.h:156
pin_name_t mod
Definition: charger12.h:150
pin_name_t mosi
Definition: charger12.h:143
uint32_t spi_speed
Definition: charger12.h:155
pin_name_t che
Definition: charger12.h:149
pin_name_t miso
Definition: charger12.h:142
pin_name_t cs
Definition: charger12.h:145
Click ctx object definition.
Definition: charger12.h:117
digital_out_t cs
Definition: charger12.h:120
digital_out_t mod
Definition: charger12.h:122
spi_master_t spi
Definition: charger12.h:130
digital_in_t vok
Definition: charger12.h:126
pin_name_t chip_select
Definition: charger12.h:131
digital_out_t che
Definition: charger12.h:121