mux  2.0.0.0
mux.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 MUX_H
36 #define MUX_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 MUX_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.a0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.a1 = MIKROBUS( mikrobus, MIKROBUS_PWM );
69 
75 #define MUX_RETVAL uint8_t
76 
77 #define MUX_OK 0x00
78 #define MUX_INIT_ERROR 0xFF
79 
85 #define MUX_CHANNEL_1A_AND_1B 0x01
86 #define MUX_CHANNEL_2A_AND_2B 0x02
87 #define MUX_CHANNEL_3A_AND_3B 0x03
88 #define MUX_CHANNEL_4A_AND_4B 0x04
89 #define MUX_CHANNEL_END 0x05
90  // End group macro
93 // --------------------------------------------------------------- PUBLIC TYPES
102 typedef struct
103 {
104  // Output pins
105 
106  digital_out_t a0;
107  digital_out_t en;
108  digital_out_t a1;
109 
110 } mux_t;
111 
115 typedef struct
116 {
117  // Additional gpio pins
118 
119  pin_name_t a0;
120  pin_name_t en;
121  pin_name_t a1;
122 
123 } mux_cfg_t;
124  // End types group
126 
127 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
128 
134 #ifdef __cplusplus
135 extern "C"{
136 #endif
137 
146 void mux_cfg_setup ( mux_cfg_t *cfg );
147 
156 
164 void mux_device_enable ( mux_t *ctx );
165 
173 void mux_device_disable ( mux_t *ctx );
174 
199 void mux_active_mux_channel ( mux_t *ctx, uint8_t sel_ch );
200 
201 #ifdef __cplusplus
202 }
203 #endif
204 #endif // _MUX_H_
205  // End public_function group
208 
209 // ------------------------------------------------------------------------- END
mux_active_mux_channel
void mux_active_mux_channel(mux_t *ctx, uint8_t sel_ch)
Seelect active MUX channel.
mux_t::en
digital_out_t en
Definition: mux.h:107
mux_device_disable
void mux_device_disable(mux_t *ctx)
Disable MUX device function.
mux_device_enable
void mux_device_enable(mux_t *ctx)
Enable MUX device function.
mux_cfg_t::a0
pin_name_t a0
Definition: mux.h:119
mux_t::a0
digital_out_t a0
Definition: mux.h:106
MUX_RETVAL
#define MUX_RETVAL
Definition: mux.h:75
mux_cfg_t::a1
pin_name_t a1
Definition: mux.h:121
mux_cfg_setup
void mux_cfg_setup(mux_cfg_t *cfg)
Config Object Initialization function.
mux_cfg_t::en
pin_name_t en
Definition: mux.h:120
mux_init
MUX_RETVAL mux_init(mux_t *ctx, mux_cfg_t *cfg)
Initialization function.
mux_t::a1
digital_out_t a1
Definition: mux.h:108
mux_t
Click ctx object definition.
Definition: mux.h:103
mux_cfg_t
Click configuration structure definition.
Definition: mux.h:116