waveform2 2.0.0.0
waveform2.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 WAVEFORM2_H
29#define WAVEFORM2_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38#include "drv_spi_master.h"
39#include "spi_specifics.h"
40
61#define WAVEFORM2_CFG_B28_MSK 0x2000
62#define WAVEFORM2_CFG_HLB_MSK 0x1000
63#define WAVEFORM2_CFG_FSEL_MSK 0x0800
64#define WAVEFORM2_CFG_PSEK_MSK 0x0400
65#define WAVEFORM2_CFG_PIN_SW_MSK 0x0200
66#define WAVEFORM2_CFG_RESET_MSK 0x0100
67#define WAVEFORM2_CFG_SLEEP1_MSK 0x0080
68#define WAVEFORM2_CFG_SLEEP12_MSK 0x0040
69#define WAVEFORM2_CFG_OPBITEN_MSK 0x0020
70#define WAVEFORM2_CFG_SIGN_PIB_MSK 0x0010
71#define WAVEFORM2_CFG_DIV2_MSK 0x0008
72#define WAVEFORM2_CFG_MODE_MSK 0x0002
73
74#define OUTPUT_TRIANGLE 0x01
75#define OUTPUT_SINUSOID 0x00
76
82#define WAVEFORM2_DEVICE_SLAVE_ADDR_GND 0x50
83#define WAVEFORM2_DEVICE_SLAVE_ADDR_VCC 0x51
84
93#define WAVEFORM2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
94#define WAVEFORM2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
95 // waveform2_set
97
112#define WAVEFORM2_MAP_MIKROBUS( cfg, mikrobus ) \
113 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
114 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
115 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
116 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
117 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
118 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
119 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
120 cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
121 // waveform2_map // waveform2
124
129typedef struct waveform2_s
130{
131 digital_out_t rst;
132 digital_out_t en;
134 i2c_master_t i2c;
135 spi_master_t spi;
138 pin_name_t chip_select;
140 uint8_t mode_output;
141
143
148typedef struct
149{
150 pin_name_t scl;
151 pin_name_t sda;
152 pin_name_t miso;
153 pin_name_t mosi;
154 pin_name_t sck;
155 pin_name_t cs;
156 pin_name_t rst;
157 pin_name_t en;
159 uint32_t i2c_speed;
160 uint8_t i2c_address;
162 uint32_t spi_speed;
163 spi_master_mode_t spi_mode;
164 spi_master_chip_select_polarity_t cs_polarity;
167
172typedef enum
173{
175 WAVEFORM2_ERROR = -1
176
178
195
210
225
240err_t waveform2_i2c_write ( waveform2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
241
256err_t waveform2_i2c_read ( waveform2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
257
272err_t waveform2_spi_write ( waveform2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
273
288err_t waveform2_spi_read ( waveform2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
289
298uint8_t waveform2_eeprom_read_byte ( waveform2_t *ctx, uint16_t addr );
299
308uint16_t waveform2_eeprom_read_word ( waveform2_t *ctx, uint16_t addr );
309
318uint32_t waveform2_eeprom_read_long ( waveform2_t *ctx, uint16_t addr );
319
330void waveform2_eeprom_read_string ( waveform2_t *ctx, uint16_t addr, uint8_t *data_buf, uint16_t len );
331
341void waveform2_eeprom_write_byte ( waveform2_t *ctx, uint16_t addr, uint8_t tx_data );
342
352void waveform2_eeprom_write_word ( waveform2_t *ctx, uint16_t addr, uint16_t tx_data );
353
363void waveform2_eeprom_write_long ( waveform2_t *ctx, uint16_t addr, uint32_t tx_data );
364
375void waveform2_eeprom_write_string ( waveform2_t *ctx, uint16_t addr, uint8_t *data_buf, uint16_t len );
376
385
394
403
412void waveform2_set_freq ( waveform2_t *ctx, uint32_t freq );
413
422void waveform2_configuration ( waveform2_t *ctx, uint16_t cfg );
423
432
441
450
451#ifdef __cplusplus
452}
453#endif
454#endif // WAVEFORM2_H
455 // waveform2
457
458// ------------------------------------------------------------------------ END
void waveform2_triangle_output(waveform2_t *ctx)
Waveform 2 set triangle output function.
void waveform2_set_freq(waveform2_t *ctx, uint32_t freq)
Waveform 2 set frequency function.
err_t waveform2_spi_read(waveform2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Waveform 2 SPI reading function.
void waveform2_eeprom_read_string(waveform2_t *ctx, uint16_t addr, uint8_t *data_buf, uint16_t len)
Waveform 2 read string function.
void waveform2_output_off(waveform2_t *ctx)
Waveform 2 disable output function.
void waveform2_eeprom_write_word(waveform2_t *ctx, uint16_t addr, uint16_t tx_data)
Waveform 2 write word function.
err_t waveform2_i2c_write(waveform2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Waveform 2 I2C writing function.
void waveform2_mclk_enable(waveform2_t *ctx)
Waveform 2 enable oscilator function.
err_t waveform2_i2c_read(waveform2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Waveform 2 I2C reading function.
void waveform2_eeprom_write_string(waveform2_t *ctx, uint16_t addr, uint8_t *data_buf, uint16_t len)
Waveform 2 write string function.
err_t waveform2_spi_write(waveform2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Waveform 2 SPI writing function.
uint32_t waveform2_eeprom_read_long(waveform2_t *ctx, uint16_t addr)
Waveform 2 read long function.
void waveform2_eeprom_write_byte(waveform2_t *ctx, uint16_t addr, uint8_t tx_data)
Waveform 2 write bute function.
err_t waveform2_init(waveform2_t *ctx, waveform2_cfg_t *cfg)
Waveform 2 initialization function.
void waveform2_eeprom_write_long(waveform2_t *ctx, uint16_t addr, uint32_t tx_data)
Waveform 2 write long function.
uint8_t waveform2_eeprom_read_byte(waveform2_t *ctx, uint16_t addr)
Waveform 2 read byte function.
void waveform2_mclk_disable(waveform2_t *ctx)
Waveform 2 disable oscilator function.
uint16_t waveform2_eeprom_read_word(waveform2_t *ctx, uint16_t addr)
Waveform 2 read word function.
void waveform2_sine_output(waveform2_t *ctx)
Waveform 2 set sine output function.
err_t waveform2_default_cfg(waveform2_t *ctx)
Waveform 2 default configuration function.
void waveform2_cfg_setup(waveform2_cfg_t *cfg)
Waveform 2 configuration object setup function.
void waveform2_configuration(waveform2_t *ctx, uint16_t cfg)
Waveform 2 configuration function.
void waveform2_hw_reset(waveform2_t *ctx)
Waveform 2 hardware reset function.
This file contains SPI specific macros, functions, etc.
Waveform 2 Click configuration object.
Definition: waveform2.h:149
uint32_t i2c_speed
Definition: waveform2.h:159
spi_master_chip_select_polarity_t cs_polarity
Definition: waveform2.h:164
pin_name_t sck
Definition: waveform2.h:154
spi_master_mode_t spi_mode
Definition: waveform2.h:163
pin_name_t mosi
Definition: waveform2.h:153
uint32_t spi_speed
Definition: waveform2.h:162
pin_name_t scl
Definition: waveform2.h:150
pin_name_t en
Definition: waveform2.h:157
pin_name_t miso
Definition: waveform2.h:152
pin_name_t sda
Definition: waveform2.h:151
pin_name_t rst
Definition: waveform2.h:156
pin_name_t cs
Definition: waveform2.h:155
uint8_t i2c_address
Definition: waveform2.h:160
Waveform 2 Click context object.
Definition: waveform2.h:130
spi_master_t spi
Definition: waveform2.h:135
uint8_t mode_output
Definition: waveform2.h:140
i2c_master_t i2c
Definition: waveform2.h:134
digital_out_t en
Definition: waveform2.h:132
digital_out_t rst
Definition: waveform2.h:131
uint8_t slave_address
Definition: waveform2.h:137
pin_name_t chip_select
Definition: waveform2.h:138
waveform2_return_value_t
Waveform 2 Click return value data.
Definition: waveform2.h:173
@ WAVEFORM2_OK
Definition: waveform2.h:174
@ WAVEFORM2_ERROR
Definition: waveform2.h:175
struct waveform2_s waveform2_t
Waveform 2 Click context object.