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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_spi_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
68 #define CHARGER12_MAP_MIKROBUS( cfg, mikrobus ) \
69  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
70  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
71  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
72  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
73  cfg.che = MIKROBUS( mikrobus, MIKROBUS_RST ); \
74  cfg.mod = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
75  cfg.vok = MIKROBUS( mikrobus, MIKROBUS_INT )
76 
82 #define CHARGER12_RETVAL uint8_t
83 
84 #define CHARGER12_OK 0x00
85 #define CHARGER12_INIT_ERROR 0xFF
86 
92 #define CHARGER12_SPI_VOLATILE_WIPER_0 0x00
93 #define CHARGER12_SPI_VOLATILE_WIPER_1 0x01
94 #define CHARGER12_SPI_NON_VOLATILE_WIPER_0 0x02
95 #define CHARGER12_SPI_NON_VOLATILE_WIPER_1 0x03
96 #define CHARGER12_SPI_VOLATILE_TCON 0x04
97 #define CHARGER12_SPI_STATUS_REGISTER 0x05
98 #define CHARGER12_SPI_DATA_EEPROM_0 0x06
99 #define CHARGER12_SPI_DATA_EEPROM_1 0x07
100 #define CHARGER12_SPI_DATA_EEPROM_2 0x08
101 #define CHARGER12_SPI_DATA_EEPROM_3 0x09
102 #define CHARGER12_SPI_DATA_EEPROM_4 0x0A
103 #define CHARGER12_SPI_DATA_EEPROM_5 0x0B
104 #define CHARGER12_SPI_DATA_EEPROM_6 0x0C
105 #define CHARGER12_SPI_DATA_EEPROM_7 0x0D
106 #define CHARGER12_SPI_DATA_EEPROM_8 0x0E
107 #define CHARGER12_SPI_DATA_EEPROM_9 0x0F
108 
114 #define CHARGER12_MODE_Li 0
115 #define CHARGER12_MODE_NiMh_NiCd 1
116 #define CHARGER12_MODE_DISABLE 2
117 #define CHARGER12_MODE_NO_BATTERY 3
118  // End group macro
121 // --------------------------------------------------------------- PUBLIC TYPES
130 typedef struct
131 {
132  // Output pins
133 
134  digital_out_t cs;
135  digital_out_t che;
136  digital_out_t mod;
137 
138  // Input pins
139 
140  digital_in_t vok;
141 
142  // Modules
143 
144  spi_master_t spi;
145  pin_name_t chip_select;
146 
147 } charger12_t;
148 
152 typedef struct
153 {
154  // Communication gpio pins
155 
156  pin_name_t miso;
157  pin_name_t mosi;
158  pin_name_t sck;
159  pin_name_t cs;
160 
161  // Additional gpio pins
162 
163  pin_name_t che;
164  pin_name_t mod;
165  pin_name_t vok;
166 
167  // static variable
168 
169  uint32_t spi_speed;
170  spi_master_mode_t spi_mode;
171  spi_master_chip_select_polarity_t cs_polarity;
172 
174  // End types group
176 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
177 
182 #ifdef __cplusplus
183 extern "C"{
184 #endif
185 
195 
205 
217 void charger12_generic_transfer ( charger12_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t tx_len, uint8_t rx_len );
218 uint8_t charger12_int_get ( charger12_t *ctx );
226 void charger12_pwm_set ( charger12_t *ctx, uint8_t pin_state );
235 void charger12_rst_set ( charger12_t *ctx, uint8_t pin_state );
244 void charger12_cs_set ( charger12_t *ctx, uint8_t pin_state );
253 uint8_t charger12_mode_select ( charger12_t *ctx, uint8_t mode_select );
262 void charger12_spi_set_register( charger12_t *ctx, uint8_t register_address, uint16_t register_value );
288 
289 
290 
291 #ifdef __cplusplus
292 }
293 #endif
294 #endif // _CHARGER12_H_
295  // End public_function group
298 
299 // ------------------------------------------------------------------------- END
charger12_spi_decrement_wiper
void charger12_spi_decrement_wiper(charger12_t *ctx)
Decrementing wiper position.
charger12_cfg_t::miso
pin_name_t miso
Definition: charger12.h:156
charger12_cs_set
void charger12_cs_set(charger12_t *ctx, uint8_t pin_state)
Setting CS pin state.
charger12_spi_increment_wiper
void charger12_spi_increment_wiper(charger12_t *ctx)
Incrementing wiper position.
charger12_pwm_set
void charger12_pwm_set(charger12_t *ctx, uint8_t pin_state)
Setting PWM pin state.
charger12_t::chip_select
pin_name_t chip_select
Definition: charger12.h:145
charger12_cfg_t::spi_speed
uint32_t spi_speed
Definition: charger12.h:169
charger12_spi_set_register
void charger12_spi_set_register(charger12_t *ctx, uint8_t register_address, uint16_t register_value)
Setting register.
charger12_cfg_t::cs
pin_name_t cs
Definition: charger12.h:159
charger12_cfg_t::mod
pin_name_t mod
Definition: charger12.h:164
charger12_cfg_t::vok
pin_name_t vok
Definition: charger12.h:165
charger12_t::spi
spi_master_t spi
Definition: charger12.h:144
charger12_t::che
digital_out_t che
Definition: charger12.h:135
charger12_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: charger12.h:171
charger12_cfg_t::mosi
pin_name_t mosi
Definition: charger12.h:157
charger12_cfg_t::sck
pin_name_t sck
Definition: charger12.h:158
charger12_mode_select
uint8_t charger12_mode_select(charger12_t *ctx, uint8_t mode_select)
Selecting device operation mode.
charger12_int_get
uint8_t charger12_int_get(charger12_t *ctx)
Getting INT pin state.
charger12_rst_set
void charger12_rst_set(charger12_t *ctx, uint8_t pin_state)
Setting RST pin state.
charger12_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: charger12.h:170
charger12_t::mod
digital_out_t mod
Definition: charger12.h:136
charger12_cfg_setup
void charger12_cfg_setup(charger12_cfg_t *cfg)
Config Object Initialization function.
charger12_generic_transfer
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.
charger12_t::vok
digital_in_t vok
Definition: charger12.h:140
charger12_t
Click ctx object definition.
Definition: charger12.h:131
CHARGER12_RETVAL
#define CHARGER12_RETVAL
Definition: charger12.h:82
charger12_t::cs
digital_out_t cs
Definition: charger12.h:134
charger12_cfg_t::che
pin_name_t che
Definition: charger12.h:163
charger12_cfg_t
Click configuration structure definition.
Definition: charger12.h:153
charger12_init
CHARGER12_RETVAL charger12_init(charger12_t *ctx, charger12_cfg_t *cfg)
Initialization function.