ipd2  2.1.0.0
ipd2.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 IPD2_H
29 #define IPD2_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 IPD2_MAP_MIKROBUS( cfg, mikrobus ) \
73  cfg.st2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
74  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
75  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
76  cfg.st1 = MIKROBUS( mikrobus, MIKROBUS_INT )
77  // ipd2_map // ipd2
80 
85 typedef struct
86 {
87  digital_out_t in2;
88  digital_out_t in1;
90  digital_in_t st2;
91  digital_in_t st1;
93 } ipd2_t;
94 
99 typedef struct
100 {
101  pin_name_t st2;
102  pin_name_t in2;
103  pin_name_t in1;
104  pin_name_t st1;
106 } ipd2_cfg_t;
107 
112 typedef enum
113 {
114  IPD2_OK = 0,
115  IPD2_ERROR = -1
116 
118 
135 
149 err_t ipd2_init ( ipd2_t *ctx, ipd2_cfg_t *cfg );
150 
159 void ipd2_enable_out1 ( ipd2_t *ctx );
160 
169 void ipd2_disable_out1 ( ipd2_t *ctx );
170 
179 void ipd2_enable_out2 ( ipd2_t *ctx );
180 
189 void ipd2_disable_out2 ( ipd2_t *ctx );
190 
199 uint8_t ipd2_get_st1_pin ( ipd2_t *ctx );
200 
209 uint8_t ipd2_get_st2_pin ( ipd2_t *ctx );
210 
211 #ifdef __cplusplus
212 }
213 #endif
214 #endif // IPD2_H
215  // ipd2
217 
218 // ------------------------------------------------------------------------ END
ipd2_get_st1_pin
uint8_t ipd2_get_st1_pin(ipd2_t *ctx)
IPD 2 get ST1 pin function.
ipd2_init
err_t ipd2_init(ipd2_t *ctx, ipd2_cfg_t *cfg)
IPD 2 initialization function.
ipd2_cfg_t::st1
pin_name_t st1
Definition: ipd2.h:104
ipd2_t::in1
digital_out_t in1
Definition: ipd2.h:88
IPD2_ERROR
@ IPD2_ERROR
Definition: ipd2.h:115
ipd2_t::in2
digital_out_t in2
Definition: ipd2.h:87
ipd2_cfg_t
IPD 2 Click configuration object.
Definition: ipd2.h:100
ipd2_t::st1
digital_in_t st1
Definition: ipd2.h:91
ipd2_enable_out2
void ipd2_enable_out2(ipd2_t *ctx)
IPD 2 enable OUT2 function.
ipd2_t::st2
digital_in_t st2
Definition: ipd2.h:90
ipd2_cfg_t::in2
pin_name_t in2
Definition: ipd2.h:102
ipd2_enable_out1
void ipd2_enable_out1(ipd2_t *ctx)
IPD 2 enable OUT1 function.
ipd2_get_st2_pin
uint8_t ipd2_get_st2_pin(ipd2_t *ctx)
IPD 2 get ST2 pin function.
ipd2_return_value_t
ipd2_return_value_t
IPD 2 Click return value data.
Definition: ipd2.h:113
IPD2_OK
@ IPD2_OK
Definition: ipd2.h:114
ipd2_disable_out2
void ipd2_disable_out2(ipd2_t *ctx)
IPD 2 disable OUT2 function.
ipd2_cfg_t::in1
pin_name_t in1
Definition: ipd2.h:103
ipd2_cfg_t::st2
pin_name_t st2
Definition: ipd2.h:101
ipd2_cfg_setup
void ipd2_cfg_setup(ipd2_cfg_t *cfg)
IPD 2 configuration object setup function.
ipd2_t
IPD 2 Click context object.
Definition: ipd2.h:86
ipd2_disable_out1
void ipd2_disable_out1(ipd2_t *ctx)
IPD 2 disable OUT1 function.