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 "drv_digital_out.h"
39 
40 // -------------------------------------------------------------- PUBLIC MACROS
50 #define OPTO4_MAP_MIKROBUS( cfg, mikrobus ) \
51  cfg.cs= MIKROBUS( mikrobus, MIKROBUS_CS ); \
52 
58 #define OPTO4_RETVAL uint8_t
59 
60 #define OPTO4_OK 0x00
61 #define OPTO4_INIT_ERROR 0xFF
62 
68 #define OPTO4_OUTPUT_ENABLE 0x01
69 #define OPTO4_OUTPUT_DISABLE 0x00
70  // End group macro
73 // --------------------------------------------------------------- PUBLIC TYPES
82 typedef struct
83 {
84  // Output pins
85 
86  digital_out_t cs;
87 
88 } opto4_t;
89 
93 typedef struct
94 {
95  // Additional gpio pins
96 
97  pin_name_t cs;
98 
99 } opto4_cfg_t;
100  // End types group
102 
103 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
104 
110 #ifdef __cplusplus
111 extern "C"{
112 #endif
113 
123 
132 
141 
150 void opto4_output_enable ( opto4_t *ctx, uint8_t enable );
151 
152 #ifdef __cplusplus
153 }
154 #endif
155 #endif // _OPTO4_H_
156  // End public_function group
159 
160 // ------------------------------------------------------------------------- END
opto4_init
OPTO4_RETVAL opto4_init(opto4_t *ctx, opto4_cfg_t *cfg)
Initialization function.
OPTO4_RETVAL
#define OPTO4_RETVAL
Definition: opto4.h:58
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:86
opto4_t
Click ctx object definition.
Definition: opto4.h:83
opto4_cfg_t
Click configuration structure definition.
Definition: opto4.h:94
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:97
opto4_default_cfg
void opto4_default_cfg(opto4_t *ctx)
Click Default Configuration function.