singlecell  2.0.0.0
singlecell.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 SINGLECELL_H
36 #define SINGLECELL_H
37 
38 #include "drv_digital_out.h"
39 
40 // -------------------------------------------------------------- PUBLIC MACROS
50 #define SINGLECELL_MAP_MIKROBUS( cfg, mikrobus ) \
51  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS );
52 
59 #define SINGLECELL_RETVAL uint8_t
60 
61 #define SINGLECELL_OK 0x00
62 #define SINGLECELL_INIT_ERROR 0xFF
63 
69 #define SINGLECELL_DISABLE 0x00
70 #define SINGLECELL_ENABLE 0x01
71  // End group macro
74 // --------------------------------------------------------------- PUBLIC TYPES
83 typedef struct
84 {
85  // Output pins
86 
87  digital_out_t en;
88 
89 } singlecell_t;
90 
94 typedef struct
95 {
96  // Additional gpio pins
97 
98  pin_name_t en;
99 
101  // End types group
103 // ------------------------------------------------------------------ CONSTANTS // End constants group
112 // ------------------------------------------------------------------ VARIABLES // End variable group
120 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
121 
127 #ifdef __cplusplus
128 extern "C"{
129 #endif
130 
140 
149 
159 
169 void singlecell_set_power_mode ( singlecell_t *ctx, uint8_t en_mode );
170 
171 #ifdef __cplusplus
172 }
173 #endif
174 #endif // _SINGLECELL_H_
175  // End public_function group
178 
179 // ------------------------------------------------------------------------- END
singlecell_set_power_mode
void singlecell_set_power_mode(singlecell_t *ctx, uint8_t en_mode)
Set power mode function.
singlecell_t
Click ctx object definition.
Definition: singlecell.h:83
singlecell_cfg_t::en
pin_name_t en
Definition: singlecell.h:98
singlecell_cfg_t
Click configuration structure definition.
Definition: singlecell.h:94
singlecell_default_cfg
void singlecell_default_cfg(singlecell_t *ctx)
Click Default Configuration function.
SINGLECELL_RETVAL
#define SINGLECELL_RETVAL
Definition: singlecell.h:59
singlecell_t::en
digital_out_t en
Definition: singlecell.h:87
singlecell_init
SINGLECELL_RETVAL singlecell_init(singlecell_t *ctx, singlecell_cfg_t *cfg)
Initialization function.
singlecell_cfg_setup
void singlecell_cfg_setup(singlecell_cfg_t *cfg)
Config Object Initialization function.