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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define POWERMUX_INPUT_CHANNEL_1_ON 0x01
59 #define POWERMUX_INPUT_CHANNEL_2_ON 0x02
60 #define POWERMUX_INPUT_CHANNEL_OFF 0x03
61 #define POWERMUX_INPUT_CHANNEL_AUTO 0x04
62  // powermux_set
64 
79 #define POWERMUX_MAP_MIKROBUS( cfg, mikrobus ) \
80  cfg.d0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
81  cfg.d1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
82  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
83  // powermux_map // powermux
86 
91 typedef struct
92 {
93  digital_out_t d0;
94  digital_out_t d1;
96  digital_in_t int_pin;
98 } powermux_t;
99 
104 typedef struct
105 {
106  pin_name_t d0;
107  pin_name_t d1;
108  pin_name_t int_pin;
111 
116 typedef enum
117 {
119  POWERMUX_ERROR = -1
120 
122 
138 void powermux_cfg_setup ( powermux_cfg_t *cfg );
139 
154 err_t powermux_init ( powermux_t *ctx, powermux_cfg_t *cfg );
155 
169 void powermux_default_cfg ( powermux_t *ctx );
170 
180 uint8_t powermux_int_pin_read ( powermux_t *ctx );
181 
190 void powermux_set_mode ( powermux_t *ctx, uint8_t mode );
191 
192 #ifdef __cplusplus
193 }
194 #endif
195 #endif // POWERMUX_H
196  // powermux
198 
199 // ------------------------------------------------------------------------ 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
Definition: powermux.h:118
powermux_cfg_setup
void powermux_cfg_setup(powermux_cfg_t *cfg)
Power MUX configuration object setup function.
powermux_init
err_t powermux_init(powermux_t *ctx, powermux_cfg_t *cfg)
Power MUX initialization function.
powermux_int_pin_read
uint8_t powermux_int_pin_read(powermux_t *ctx)
Power MUX pin reading function.
powermux_t
Power MUX Click context object.
Definition: powermux.h:90
powermux_return_value_t
powermux_return_value_t
Power MUX Click return value data.
Definition: powermux.h:115
powermux_cfg_t
Power MUX Click configuration object.
Definition: powermux.h:103
POWERMUX_OK
Definition: powermux.h:117