efuse  2.0.0.0
efuse.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 EFUSE_H
29 #define EFUSE_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
68 #define EFUSE_MAP_MIKROBUS( cfg, mikrobus ) \
69  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
71  // efuse_map // efuse
74 
79 typedef struct
80 {
81  digital_out_t en;
82  digital_out_t pwm;
84 } efuse_t;
85 
90 typedef struct
91 {
92  pin_name_t en;
93  pin_name_t pwm;
95 } efuse_cfg_t;
96 
101 typedef enum
102 {
103  EFUSE_OK = 0,
104  EFUSE_ERROR = -1
105 
107 
124 
139 err_t efuse_init ( efuse_t *ctx, efuse_cfg_t *cfg );
140 
154 err_t efuse_default_cfg ( efuse_t *ctx );
155 
166 
177 
187 void efuse_enable_pwm ( efuse_t *ctx );
188 
199 
200 #ifdef __cplusplus
201 }
202 #endif
203 #endif // EFUSE_H
204  // efuse
206 
207 // ------------------------------------------------------------------------ END
efuse_t::en
digital_out_t en
Definition: efuse.h:81
efuse_t
eFuse Click context object.
Definition: efuse.h:80
efuse_t::pwm
digital_out_t pwm
Definition: efuse.h:82
efuse_init
err_t efuse_init(efuse_t *ctx, efuse_cfg_t *cfg)
eFuse initialization function.
efuse_cfg_t::en
pin_name_t en
Definition: efuse.h:92
efuse_enable_pwm
void efuse_enable_pwm(efuse_t *ctx)
eFuse enable PWM function.
efuse_return_value_t
efuse_return_value_t
eFuse Click return value data.
Definition: efuse.h:102
efuse_cfg_t::pwm
pin_name_t pwm
Definition: efuse.h:93
EFUSE_ERROR
@ EFUSE_ERROR
Definition: efuse.h:104
efuse_disable_pwm
void efuse_disable_pwm(efuse_t *ctx)
eFuse disable the device function.
efuse_cfg_t
eFuse Click configuration object.
Definition: efuse.h:91
efuse_disable_device
void efuse_disable_device(efuse_t *ctx)
eFuse disable the device function.
efuse_default_cfg
err_t efuse_default_cfg(efuse_t *ctx)
eFuse default configuration function.
efuse_cfg_setup
void efuse_cfg_setup(efuse_cfg_t *cfg)
eFuse configuration object setup function.
EFUSE_OK
@ EFUSE_OK
Definition: efuse.h:103
efuse_enable_device
void efuse_enable_device(efuse_t *ctx)
eFuse enable the device function.