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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37
58#define EFUSE_MAP_MIKROBUS( cfg, mikrobus ) \
59 cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
61 // efuse_map // efuse
64
69typedef struct
70{
71 digital_out_t en;
72 digital_out_t pwm;
74} efuse_t;
75
80typedef struct
81{
82 pin_name_t en;
83 pin_name_t pwm;
86
91typedef enum
92{
94 EFUSE_ERROR = -1
95
97
114
129err_t efuse_init ( efuse_t *ctx, efuse_cfg_t *cfg );
130
145
156
167
178
189
190#ifdef __cplusplus
191}
192#endif
193#endif // EFUSE_H
194 // efuse
196
197// ------------------------------------------------------------------------ END
efuse_return_value_t
eFuse Click return value data.
Definition: efuse.h:92
@ EFUSE_OK
Definition: efuse.h:93
@ EFUSE_ERROR
Definition: efuse.h:94
void efuse_disable_pwm(efuse_t *ctx)
eFuse disable the device function.
void efuse_enable_pwm(efuse_t *ctx)
eFuse enable PWM function.
void efuse_cfg_setup(efuse_cfg_t *cfg)
eFuse configuration object setup function.
err_t efuse_default_cfg(efuse_t *ctx)
eFuse default configuration function.
err_t efuse_init(efuse_t *ctx, efuse_cfg_t *cfg)
eFuse initialization function.
void efuse_enable_device(efuse_t *ctx)
eFuse enable the device function.
void efuse_disable_device(efuse_t *ctx)
eFuse disable the device function.
eFuse Click configuration object.
Definition: efuse.h:81
pin_name_t en
Definition: efuse.h:82
pin_name_t pwm
Definition: efuse.h:83
eFuse Click context object.
Definition: efuse.h:70
digital_out_t pwm
Definition: efuse.h:72
digital_out_t en
Definition: efuse.h:71