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 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define CLOCKGEN6_DIGIPOT_POSITION_MAX 255
61 #define CLOCKGEN6_DIGIPOT_POSITION_MIN 0
62 
71 #define CLOCKGEN6_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
72 #define CLOCKGEN6_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
73  // clockgen6_set
75 
90 #define CLOCKGEN6_MAP_MIKROBUS( cfg, mikrobus ) \
91  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
92  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
93  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
94  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
95  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST );
96  // clockgen6_map // clockgen6
99 
104 typedef struct
105 {
106  digital_out_t en;
108  // Modules
109  spi_master_t spi;
111  pin_name_t chip_select;
113 } clockgen6_t;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t miso;
123  pin_name_t mosi;
124  pin_name_t sck;
125  pin_name_t cs;
126  pin_name_t en;
128  // static variable
129  uint32_t spi_speed;
130  spi_master_mode_t spi_mode;
131  spi_master_chip_select_polarity_t cs_polarity;
134 
139 typedef enum
140 {
142  CLOCKGEN6_ERROR = -1
143 
145 
162 
178 
192 
204 err_t clockgen6_set_digipot ( clockgen6_t *ctx, uint8_t position );
205 
215 
225 
226 #ifdef __cplusplus
227 }
228 #endif
229 #endif // CLOCKGEN6_H
230  // clockgen6
232 
233 // ------------------------------------------------------------------------ END
CLOCKGEN6_OK
@ CLOCKGEN6_OK
Definition: clockgen6.h:141
clockgen6_cfg_t::sck
pin_name_t sck
Definition: clockgen6.h:124
clockgen6_t::en
digital_out_t en
Definition: clockgen6.h:106
clockgen6_cfg_t::mosi
pin_name_t mosi
Definition: clockgen6.h:123
clockgen6_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: clockgen6.h:130
clockgen6_cfg_t::spi_speed
uint32_t spi_speed
Definition: clockgen6.h:129
spi_specifics.h
This file contains SPI specific macros, functions, etc.
clockgen6_t::spi
spi_master_t spi
Definition: clockgen6.h:109
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:131
clockgen6_cfg_t::en
pin_name_t en
Definition: clockgen6.h:126
clockgen6_t::chip_select
pin_name_t chip_select
Definition: clockgen6.h:111
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:125
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:142
clockgen6_return_value_t
clockgen6_return_value_t
Clock Gen 6 Click return value data.
Definition: clockgen6.h:140
clockgen6_t
Clock Gen 6 Click context object.
Definition: clockgen6.h:105
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:122
clockgen6_cfg_t
Clock Gen 6 Click configuration object.
Definition: clockgen6.h:120