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
42
#ifdef PREINIT_SUPPORTED
43
#include "preinit.h"
44
#endif
45
46
#ifdef MikroCCoreVersion
47
#if MikroCCoreVersion >= 1
48
#include "delays.h"
49
#endif
50
#endif
51
52
#include "drv_digital_out.h"
53
#include "drv_digital_in.h"
54
55
// -------------------------------------------------------------- PUBLIC MACROS
65
#define FLICKER_MAP_MIKROBUS( cfg, mikrobus ) \
66
cfg.fon= MIKROBUS( mikrobus, MIKROBUS_RST );
67
73
#define FLICKER_RETVAL uint8_t
74
75
#define FLICKER_OK 0x00
76
#define FLICKER_INIT_ERROR 0xFF
77
// End group macro
80
// --------------------------------------------------------------- PUBLIC TYPES
89
typedef
struct
90
{
91
// Output pins
92
93
digital_out_t
fon
;
94
95
}
flicker_t
;
96
100
typedef
struct
101
{
102
// Additional gpio pins
103
104
pin_name_t
fon
;
105
106
}
flicker_cfg_t
;
107
// End types group
109
110
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
111
117
#ifdef __cplusplus
118
extern
"C"
{
119
#endif
120
128
void
flicker_cfg_setup
(
flicker_cfg_t
*cfg );
129
137
FLICKER_RETVAL
flicker_init
(
flicker_t
*ctx,
flicker_cfg_t
*cfg );
138
146
void
flicker_engage
(
flicker_t
*ctx );
147
148
#ifdef __cplusplus
149
}
150
#endif
151
#endif // _FLICKER_H_
152
// End public_function group
155
156
// ------------------------------------------------------------------------- END
flicker_cfg_t
Click configuration structure definition.
Definition:
flicker.h:101
FLICKER_RETVAL
#define FLICKER_RETVAL
Definition:
flicker.h:73
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:104
flicker_t::fon
digital_out_t fon
Definition:
flicker.h:93
flicker_cfg_setup
void flicker_cfg_setup(flicker_cfg_t *cfg)
Config Object Initialization function..
flicker_t
Click ctx object definition.
Definition:
flicker.h:90
Generated by
1.8.20