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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define CHARGER12_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
66  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
67  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
68  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
69  cfg.che = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.mod = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
71  cfg.vok = MIKROBUS( mikrobus, MIKROBUS_INT )
72 
78 #define CHARGER12_RETVAL uint8_t
79 
80 #define CHARGER12_OK 0x00
81 #define CHARGER12_INIT_ERROR 0xFF
82 
88 #define CHARGER12_SPI_VOLATILE_WIPER_0 0x00
89 #define CHARGER12_SPI_VOLATILE_WIPER_1 0x01
90 #define CHARGER12_SPI_NON_VOLATILE_WIPER_0 0x02
91 #define CHARGER12_SPI_NON_VOLATILE_WIPER_1 0x03
92 #define CHARGER12_SPI_VOLATILE_TCON 0x04
93 #define CHARGER12_SPI_STATUS_REGISTER 0x05
94 #define CHARGER12_SPI_DATA_EEPROM_0 0x06
95 #define CHARGER12_SPI_DATA_EEPROM_1 0x07
96 #define CHARGER12_SPI_DATA_EEPROM_2 0x08
97 #define CHARGER12_SPI_DATA_EEPROM_3 0x09
98 #define CHARGER12_SPI_DATA_EEPROM_4 0x0A
99 #define CHARGER12_SPI_DATA_EEPROM_5 0x0B
100 #define CHARGER12_SPI_DATA_EEPROM_6 0x0C
101 #define CHARGER12_SPI_DATA_EEPROM_7 0x0D
102 #define CHARGER12_SPI_DATA_EEPROM_8 0x0E
103 #define CHARGER12_SPI_DATA_EEPROM_9 0x0F
104 
110 #define CHARGER12_MODE_Li 0
111 #define CHARGER12_MODE_NiMh_NiCd 1
112 #define CHARGER12_MODE_DISABLE 2
113 #define CHARGER12_MODE_NO_BATTERY 3
114  // End group macro
117 // --------------------------------------------------------------- PUBLIC TYPES
126 typedef struct
127 {
128  // Output pins
129 
130  digital_out_t cs;
131  digital_out_t che;
132  digital_out_t mod;
133 
134  // Input pins
135 
136  digital_in_t vok;
137 
138  // Modules
139 
140  spi_master_t spi;
141  pin_name_t chip_select;
142 
143 } charger12_t;
144 
148 typedef struct
149 {
150  // Communication gpio pins
151 
152  pin_name_t miso;
153  pin_name_t mosi;
154  pin_name_t sck;
155  pin_name_t cs;
156 
157  // Additional gpio pins
158 
159  pin_name_t che;
160  pin_name_t mod;
161  pin_name_t vok;
162 
163  // static variable
164 
165  uint32_t spi_speed;
166  spi_master_mode_t spi_mode;
167  spi_master_chip_select_polarity_t cs_polarity;
168 
170  // End types group
172 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
173 
178 #ifdef __cplusplus
179 extern "C"{
180 #endif
181 
191 
201 
213 void charger12_generic_transfer ( charger12_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t tx_len, uint8_t rx_len );
214 uint8_t charger12_int_get ( charger12_t *ctx );
222 void charger12_pwm_set ( charger12_t *ctx, uint8_t pin_state );
231 void charger12_rst_set ( charger12_t *ctx, uint8_t pin_state );
240 void charger12_cs_set ( charger12_t *ctx, uint8_t pin_state );
249 uint8_t charger12_mode_select ( charger12_t *ctx, uint8_t mode_select );
258 void charger12_spi_set_register( charger12_t *ctx, uint8_t register_address, uint16_t register_value );
284 
285 
286 
287 #ifdef __cplusplus
288 }
289 #endif
290 #endif // _CHARGER12_H_
291  // End public_function group
294 
295 // ------------------------------------------------------------------------- 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:152
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:141
charger12_cfg_t::spi_speed
uint32_t spi_speed
Definition: charger12.h:165
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:155
charger12_cfg_t::mod
pin_name_t mod
Definition: charger12.h:160
charger12_cfg_t::vok
pin_name_t vok
Definition: charger12.h:161
charger12_t::spi
spi_master_t spi
Definition: charger12.h:140
charger12_t::che
digital_out_t che
Definition: charger12.h:131
charger12_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: charger12.h:167
charger12_cfg_t::mosi
pin_name_t mosi
Definition: charger12.h:153
charger12_cfg_t::sck
pin_name_t sck
Definition: charger12.h:154
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:166
charger12_t::mod
digital_out_t mod
Definition: charger12.h:132
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:136
charger12_t
Click ctx object definition.
Definition: charger12.h:127
CHARGER12_RETVAL
#define CHARGER12_RETVAL
Definition: charger12.h:78
charger12_t::cs
digital_out_t cs
Definition: charger12.h:130
charger12_cfg_t::che
pin_name_t che
Definition: charger12.h:159
charger12_cfg_t
Click configuration structure definition.
Definition: charger12.h:149
charger12_init
CHARGER12_RETVAL charger12_init(charger12_t *ctx, charger12_cfg_t *cfg)
Initialization function.