powermux  2.0.0.0
powermux.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef POWERMUX_H
29 #define POWERMUX_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
72 #define POWERMUX_INPUT_CHANNEL_1_ON 0
73 #define POWERMUX_INPUT_CHANNEL_2_ON 1
74 #define POWERMUX_INPUT_CHANNEL_OFF 2
75 #define POWERMUX_INPUT_CHANNEL_AUTO 3
76  // powermux_set
78 
93 #define POWERMUX_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.d0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
95  cfg.d1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
96  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
97  // powermux_map // powermux
100 
105 typedef struct
106 {
107  digital_out_t d0;
108  digital_out_t d1;
110  digital_in_t int_pin;
112 } powermux_t;
113 
118 typedef struct
119 {
120  pin_name_t d0;
121  pin_name_t d1;
122  pin_name_t int_pin;
125 
130 typedef enum
131 {
133  POWERMUX_ERROR = -1
134 
136 
153 
168 
182 
193 
202 void powermux_set_mode ( powermux_t *ctx, uint8_t mode );
203 
204 #ifdef __cplusplus
205 }
206 #endif
207 #endif // POWERMUX_H
208  // powermux
210 
211 // ------------------------------------------------------------------------ END
powermux_set_mode
void powermux_set_mode(powermux_t *ctx, uint8_t mode)
Power MUX mode set function.
powermux_default_cfg
void powermux_default_cfg(powermux_t *ctx)
Power MUX default configuration function.
POWERMUX_ERROR
@ POWERMUX_ERROR
Definition: powermux.h:133
powermux_cfg_t::d0
pin_name_t d0
Definition: powermux.h:120
powermux_cfg_setup
void powermux_cfg_setup(powermux_cfg_t *cfg)
Power MUX configuration object setup function.
powermux_t::d0
digital_out_t d0
Definition: powermux.h:107
powermux_init
err_t powermux_init(powermux_t *ctx, powermux_cfg_t *cfg)
Power MUX initialization function.
powermux_cfg_t::int_pin
pin_name_t int_pin
Definition: powermux.h:122
powermux_t::d1
digital_out_t d1
Definition: powermux.h:108
powermux_cfg_t::d1
pin_name_t d1
Definition: powermux.h:121
powermux_int_pin_read
uint8_t powermux_int_pin_read(powermux_t *ctx)
Power MUX pin reading function.
powermux_t::int_pin
digital_in_t int_pin
Definition: powermux.h:110
powermux_t
Power MUX Click context object.
Definition: powermux.h:106
powermux_return_value_t
powermux_return_value_t
Power MUX Click return value data.
Definition: powermux.h:131
powermux_cfg_t
Power MUX Click configuration object.
Definition: powermux.h:119
POWERMUX_OK
@ POWERMUX_OK
Definition: powermux.h:132