opto4  2.0.0.0
opto4.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 OPTO4_H
36 #define OPTO4_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 
50 // -------------------------------------------------------------- PUBLIC MACROS
60 #define OPTO4_MAP_MIKROBUS( cfg, mikrobus ) \
61  cfg.cs= MIKROBUS( mikrobus, MIKROBUS_CS ); \
62 
68 #define OPTO4_RETVAL uint8_t
69 
70 #define OPTO4_OK 0x00
71 #define OPTO4_INIT_ERROR 0xFF
72 
78 #define OPTO4_OUTPUT_ENABLE 0x01
79 #define OPTO4_OUTPUT_DISABLE 0x00
80  // End group macro
83 // --------------------------------------------------------------- PUBLIC TYPES
92 typedef struct
93 {
94  // Output pins
95 
96  digital_out_t cs;
97 
98 } opto4_t;
99 
103 typedef struct
104 {
105  // Additional gpio pins
106 
107  pin_name_t cs;
108 
109 } opto4_cfg_t;
110  // End types group
112 
113 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
114 
120 #ifdef __cplusplus
121 extern "C"{
122 #endif
123 
133 
142 
151 
160 void opto4_output_enable ( opto4_t *ctx, uint8_t enable );
161 
162 #ifdef __cplusplus
163 }
164 #endif
165 #endif // _OPTO4_H_
166  // End public_function group
169 
170 // ------------------------------------------------------------------------- END
opto4_init
OPTO4_RETVAL opto4_init(opto4_t *ctx, opto4_cfg_t *cfg)
Initialization function.
OPTO4_RETVAL
#define OPTO4_RETVAL
Definition: opto4.h:68
opto4_cfg_setup
void opto4_cfg_setup(opto4_cfg_t *cfg)
Config Object Initialization function.
opto4_t::cs
digital_out_t cs
Definition: opto4.h:96
opto4_t
Click ctx object definition.
Definition: opto4.h:93
opto4_cfg_t
Click configuration structure definition.
Definition: opto4.h:104
opto4_output_enable
void opto4_output_enable(opto4_t *ctx, uint8_t enable)
Function for output enable or disable.
opto4_cfg_t::cs
pin_name_t cs
Definition: opto4.h:107
opto4_default_cfg
void opto4_default_cfg(opto4_t *ctx)
Click Default Configuration function.