clockgen6  2.0.0.0
clockgen6.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 CLOCKGEN6_H
29 #define CLOCKGEN6_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define CLOCKGEN6_MAP_MIKROBUS( cfg, mikrobus ) \
59  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );
60  // clockgen6_map // clockgen6
63 
68 typedef struct
69 {
70  digital_out_t en;
72 } clockgen6_t;
73 
78 typedef struct
79 {
80  pin_name_t en;
83 
88 typedef enum
89 {
91  CLOCKGEN6_ERROR = -1
92 
94 
111 
127 
137 
147 
148 #ifdef __cplusplus
149 }
150 #endif
151 #endif // CLOCKGEN6_H
152  // clockgen6
154 
155 // ------------------------------------------------------------------------ END
CLOCKGEN6_OK
@ CLOCKGEN6_OK
Definition: clockgen6.h:90
clockgen6_t::en
digital_out_t en
Definition: clockgen6.h:70
clockgen6_enable_output
void clockgen6_enable_output(clockgen6_t *ctx)
Clock Gen 6 enable output function.
clockgen6_cfg_t::en
pin_name_t en
Definition: clockgen6.h:80
clockgen6_cfg_setup
void clockgen6_cfg_setup(clockgen6_cfg_t *cfg)
Clock Gen 6 configuration object setup function.
clockgen6_init
err_t clockgen6_init(clockgen6_t *ctx, clockgen6_cfg_t *cfg)
Clock Gen 6 initialization function.
CLOCKGEN6_ERROR
@ CLOCKGEN6_ERROR
Definition: clockgen6.h:91
clockgen6_return_value_t
clockgen6_return_value_t
Clock Gen 6 Click return value data.
Definition: clockgen6.h:89
clockgen6_t
Clock Gen 6 Click context object.
Definition: clockgen6.h:69
clockgen6_disable_output
void clockgen6_disable_output(clockgen6_t *ctx)
Clock Gen 6 disable output function.
clockgen6_cfg_t
Clock Gen 6 Click configuration object.
Definition: clockgen6.h:79