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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_spi_master.h"
52 #include "spi_specifics.h"
53 
74 #define CLOCKGEN6_DIGIPOT_POSITION_MAX 255
75 #define CLOCKGEN6_DIGIPOT_POSITION_MIN 0
76 
85 #define CLOCKGEN6_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
86 #define CLOCKGEN6_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
87  // clockgen6_set
89 
104 #define CLOCKGEN6_MAP_MIKROBUS( cfg, mikrobus ) \
105  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
106  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
107  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
108  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
109  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST );
110  // clockgen6_map // clockgen6
113 
118 typedef struct
119 {
120  digital_out_t en;
122  // Modules
123  spi_master_t spi;
125  pin_name_t chip_select;
127 } clockgen6_t;
128 
133 typedef struct
134 {
135  // Communication gpio pins
136  pin_name_t miso;
137  pin_name_t mosi;
138  pin_name_t sck;
139  pin_name_t cs;
140  pin_name_t en;
142  // static variable
143  uint32_t spi_speed;
144  spi_master_mode_t spi_mode;
145  spi_master_chip_select_polarity_t cs_polarity;
148 
153 typedef enum
154 {
156  CLOCKGEN6_ERROR = -1
157 
159 
176 
192 
206 
218 err_t clockgen6_set_digipot ( clockgen6_t *ctx, uint8_t position );
219 
229 
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 #endif // CLOCKGEN6_H
244  // clockgen6
246 
247 // ------------------------------------------------------------------------ END
CLOCKGEN6_OK
@ CLOCKGEN6_OK
Definition: clockgen6.h:155
clockgen6_cfg_t::sck
pin_name_t sck
Definition: clockgen6.h:138
clockgen6_t::en
digital_out_t en
Definition: clockgen6.h:120
clockgen6_cfg_t::mosi
pin_name_t mosi
Definition: clockgen6.h:137
clockgen6_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: clockgen6.h:144
clockgen6_cfg_t::spi_speed
uint32_t spi_speed
Definition: clockgen6.h:143
spi_specifics.h
This file contains SPI specific macros, functions, etc.
clockgen6_t::spi
spi_master_t spi
Definition: clockgen6.h:123
clockgen6_enable_output
void clockgen6_enable_output(clockgen6_t *ctx)
Clock Gen 6 enable output function.
clockgen6_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: clockgen6.h:145
clockgen6_cfg_t::en
pin_name_t en
Definition: clockgen6.h:140
clockgen6_t::chip_select
pin_name_t chip_select
Definition: clockgen6.h:125
clockgen6_cfg_setup
void clockgen6_cfg_setup(clockgen6_cfg_t *cfg)
Clock Gen 6 configuration object setup function.
clockgen6_cfg_t::cs
pin_name_t cs
Definition: clockgen6.h:139
clockgen6_init
err_t clockgen6_init(clockgen6_t *ctx, clockgen6_cfg_t *cfg)
Clock Gen 6 initialization function.
clockgen6_default_cfg
err_t clockgen6_default_cfg(clockgen6_t *ctx)
Clock Gen 6 default configuration function.
CLOCKGEN6_ERROR
@ CLOCKGEN6_ERROR
Definition: clockgen6.h:156
clockgen6_return_value_t
clockgen6_return_value_t
Clock Gen 6 Click return value data.
Definition: clockgen6.h:154
clockgen6_t
Clock Gen 6 Click context object.
Definition: clockgen6.h:119
clockgen6_disable_output
void clockgen6_disable_output(clockgen6_t *ctx)
Clock Gen 6 disable output function.
clockgen6_set_digipot
err_t clockgen6_set_digipot(clockgen6_t *ctx, uint8_t position)
Clock Gen 6 set digipot function.
clockgen6_cfg_t::miso
pin_name_t miso
Definition: clockgen6.h:136
clockgen6_cfg_t
Clock Gen 6 Click configuration object.
Definition: clockgen6.h:134