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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define MUX_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.a0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
53  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
54  cfg.a1 = MIKROBUS( mikrobus, MIKROBUS_PWM );
55 
61 #define MUX_RETVAL uint8_t
62 
63 #define MUX_OK 0x00
64 #define MUX_INIT_ERROR 0xFF
65 
71 #define MUX_CHANNEL_1A_AND_1B 0x01
72 #define MUX_CHANNEL_2A_AND_2B 0x02
73 #define MUX_CHANNEL_3A_AND_3B 0x03
74 #define MUX_CHANNEL_4A_AND_4B 0x04
75 #define MUX_CHANNEL_END 0x05
76  // End group macro
79 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90  // Output pins
91 
92  digital_out_t a0;
93  digital_out_t en;
94  digital_out_t a1;
95 
96 } mux_t;
97 
101 typedef struct
102 {
103  // Additional gpio pins
104 
105  pin_name_t a0;
106  pin_name_t en;
107  pin_name_t a1;
108 
109 } mux_cfg_t;
110  // End types group
112 
113 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
114 
120 #ifdef __cplusplus
121 extern "C"{
122 #endif
123 
132 void mux_cfg_setup ( mux_cfg_t *cfg );
133 
141 MUX_RETVAL mux_init ( mux_t *ctx, mux_cfg_t *cfg );
142 
150 void mux_device_enable ( mux_t *ctx );
151 
159 void mux_device_disable ( mux_t *ctx );
160 
185 void mux_active_mux_channel ( mux_t *ctx, uint8_t sel_ch );
186 
187 #ifdef __cplusplus
188 }
189 #endif
190 #endif // _MUX_H_
191  // End public_function group
194 
195 // ------------------------------------------------------------------------- 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:93
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:105
mux_t::a0
digital_out_t a0
Definition: mux.h:92
MUX_RETVAL
#define MUX_RETVAL
Definition: mux.h:61
mux_cfg_t::a1
pin_name_t a1
Definition: mux.h:107
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:106
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:94
mux_t
Click ctx object definition.
Definition: mux.h:88
mux_cfg_t
Click configuration structure definition.
Definition: mux.h:101