flicker
2.0.0.0
cmake
flicker
lib_flicker
include
flicker.h
Go to the documentation of this file.
1
/*
2
* MikroSDK - MikroE Software Development Kit
3
* Copyright© 2020 MikroElektronika d.o.o.
4
*
5
* Permission is hereby granted, free of charge, to any person
6
* obtaining a copy of this software and associated documentation
7
* files (the "Software"), to deal in the Software without restriction,
8
* including without limitation the rights to use, copy, modify, merge,
9
* publish, distribute, sublicense, and/or sell copies of the Software,
10
* and to permit persons to whom the Software is furnished to do so,
11
* subject to the following conditions:
12
*
13
* The above copyright notice and this permission notice shall be
14
* included in all copies or substantial portions of the Software.
15
*
16
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22
* OR OTHER DEALINGS IN THE SOFTWARE.
23
*/
24
33
// ----------------------------------------------------------------------------
34
35
#ifndef FLICKER_H
36
#define FLICKER_H
37
38
#include "mikrosdk_version.h"
39
40
#ifdef __GNUC__
41
#if mikroSDK_GET_VERSION < 20800ul
42
#include "rcu_delays.h"
43
#else
44
#include "delays.h"
45
#endif
46
#endif
47
48
#include "drv_digital_out.h"
49
#include "drv_digital_in.h"
50
51
// -------------------------------------------------------------- PUBLIC MACROS
61
#define FLICKER_MAP_MIKROBUS( cfg, mikrobus ) \
62
cfg.fon= MIKROBUS( mikrobus, MIKROBUS_RST );
63
69
#define FLICKER_RETVAL uint8_t
70
71
#define FLICKER_OK 0x00
72
#define FLICKER_INIT_ERROR 0xFF
73
// End group macro
76
// --------------------------------------------------------------- PUBLIC TYPES
85
typedef
struct
86
{
87
// Output pins
88
89
digital_out_t
fon
;
90
91
}
flicker_t
;
92
96
typedef
struct
97
{
98
// Additional gpio pins
99
100
pin_name_t
fon
;
101
102
}
flicker_cfg_t
;
103
// End types group
105
106
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
107
113
#ifdef __cplusplus
114
extern
"C"
{
115
#endif
116
124
void
flicker_cfg_setup
(
flicker_cfg_t
*cfg );
125
133
FLICKER_RETVAL
flicker_init
(
flicker_t
*ctx,
flicker_cfg_t
*cfg );
134
142
void
flicker_engage
(
flicker_t
*ctx );
143
144
#ifdef __cplusplus
145
}
146
#endif
147
#endif // _FLICKER_H_
148
// End public_function group
151
152
// ------------------------------------------------------------------------- END
flicker_cfg_t
Click configuration structure definition.
Definition:
flicker.h:97
FLICKER_RETVAL
#define FLICKER_RETVAL
Definition:
flicker.h:69
flicker_init
FLICKER_RETVAL flicker_init(flicker_t *ctx, flicker_cfg_t *cfg)
Initialization function.
flicker_engage
void flicker_engage(flicker_t *ctx)
Flicker engage function.
flicker_cfg_t::fon
pin_name_t fon
Definition:
flicker.h:100
flicker_t::fon
digital_out_t fon
Definition:
flicker.h:89
flicker_cfg_setup
void flicker_cfg_setup(flicker_cfg_t *cfg)
Config Object Initialization function..
flicker_t
Click ctx object definition.
Definition:
flicker.h:86
Generated by
1.8.20