charger12  2.0.0.0
charger12.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * 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 )
62 
68 #define CHARGER12_RETVAL uint8_t
69 
70 #define CHARGER12_OK 0x00
71 #define CHARGER12_INIT_ERROR 0xFF
72 
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
94 
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
104  // End group macro
107 // --------------------------------------------------------------- PUBLIC TYPES
116 typedef 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 
132 } charger12_t;
133 
137 typedef struct
138 {
139  // Communication gpio pins
140 
141  pin_name_t miso;
142  pin_name_t mosi;
143  pin_name_t sck;
144  pin_name_t cs;
145 
146  // Additional gpio pins
147 
148  pin_name_t che;
149  pin_name_t mod;
150  pin_name_t vok;
151 
152  // static variable
153 
154  hal_spi_speed_t spi_speed;
155  hal_spi_mode_t spi_mode;
156 
158  // End types group
160 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
161 
166 #ifdef __cplusplus
167 extern "C"{
168 #endif
169 
179 
188 
200 void charger12_generic_transfer ( charger12_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t tx_len, uint8_t rx_len );
201 uint8_t charger12_int_get ( charger12_t *ctx );
209 void charger12_pwm_set ( charger12_t *ctx, uint8_t pin_state );
218 void charger12_rst_set ( charger12_t *ctx, uint8_t pin_state );
227 void charger12_cs_set ( charger12_t *ctx, uint8_t pin_state );
236 uint8_t charger12_mode_select ( charger12_t *ctx, uint8_t mode_select );
245 void charger12_spi_set_register( charger12_t *ctx, uint8_t register_address, uint16_t register_value );
271 
272 
273 
274 #ifdef __cplusplus
275 }
276 #endif
277 #endif // _CHARGER12_H_
278  // End public_function group
281 
282 // ------------------------------------------------------------------------- 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:141
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_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:144
charger12_cfg_t::mod
pin_name_t mod
Definition: charger12.h:149
charger12_cfg_t::vok
pin_name_t vok
Definition: charger12.h:150
charger12_t::spi
spi_master_t spi
Definition: charger12.h:130
charger12_t::che
digital_out_t che
Definition: charger12.h:121
charger12_cfg_t::mosi
pin_name_t mosi
Definition: charger12.h:142
charger12_cfg_t::sck
pin_name_t sck
Definition: charger12.h:143
charger12_cfg_t::spi_speed
hal_spi_speed_t spi_speed
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_cfg_t::spi_mode
hal_spi_mode_t spi_mode
Definition: charger12.h:155
charger12_rst_set
void charger12_rst_set(charger12_t *ctx, uint8_t pin_state)
Setting RST pin state.
charger12_t::mod
digital_out_t mod
Definition: charger12.h:122
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:126
charger12_t
Click ctx object definition.
Definition: charger12.h:116
CHARGER12_RETVAL
#define CHARGER12_RETVAL
Definition: charger12.h:68
charger12_t::cs
digital_out_t cs
Definition: charger12.h:120
charger12_cfg_t::che
pin_name_t che
Definition: charger12.h:148
charger12_cfg_t
Click configuration structure definition.
Definition: charger12.h:137
charger12_init
CHARGER12_RETVAL charger12_init(charger12_t *ctx, charger12_cfg_t *cfg)
Initialization function.