stepdown2  2.0.0.0
stepdown2.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 STEPDOWN2_H
36 #define STEPDOWN2_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 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define STEPDOWN2_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.err = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
68 
74 #define STEPDOWN2_RETVAL uint8_t
75 
76 #define STEPDOWN2_OK 0x00
77 #define STEPDOWN2_INIT_ERROR 0xFF
78  // End group macro
81 // --------------------------------------------------------------- PUBLIC TYPES
90 typedef struct
91 {
92  // Output pins
93 
94  digital_out_t en;
95 
96  // Input pins
97 
98  digital_in_t err;
99 
100 } stepdown2_t;
101 
105 typedef struct
106 {
107  // Additional gpio pins
108 
109  pin_name_t err;
110  pin_name_t en;
111 
113  // End types group
115 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
116 
122 #ifdef __cplusplus
123 extern "C"{
124 #endif
125 
135 
144 
153 
162 void stepdown2_digital_write_cs ( stepdown2_t *ctx, uint8_t signal );
163 
164 #ifdef __cplusplus
165 }
166 #endif
167 #endif // _STEPDOWN2_H_
168  // End public_function group
171 
172 // ------------------------------------------------------------------------- END
stepdown2_cfg_t::err
pin_name_t err
Definition: stepdown2.h:109
stepdown2_cfg_setup
void stepdown2_cfg_setup(stepdown2_cfg_t *cfg)
Config Object Initialization function.
stepdown2_t
Click ctx object definition.
Definition: stepdown2.h:91
stepdown2_digital_read_rst
uint8_t stepdown2_digital_read_rst(stepdown2_t *ctx)
Digital read reset function.
STEPDOWN2_RETVAL
#define STEPDOWN2_RETVAL
Definition: stepdown2.h:74
stepdown2_cfg_t
Click configuration structure definition.
Definition: stepdown2.h:106
stepdown2_t::en
digital_out_t en
Definition: stepdown2.h:94
stepdown2_t::err
digital_in_t err
Definition: stepdown2.h:98
stepdown2_cfg_t::en
pin_name_t en
Definition: stepdown2.h:110
stepdown2_init
STEPDOWN2_RETVAL stepdown2_init(stepdown2_t *ctx, stepdown2_cfg_t *cfg)
Initialization function.
stepdown2_digital_write_cs
void stepdown2_digital_write_cs(stepdown2_t *ctx, uint8_t signal)
Digital write chip select function.