dac11 2.0.0.0
dac11.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 DAC11_H
29#define DAC11_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_spi_master.h"
38#include "spi_specifics.h"
39
60#define DAC11_CMD_CHANNEL_A 0x00
61#define DAC11_CMD_CHANNEL_B 0x01
62#define DAC11_CMD_CHANNEL_C 0x02
63#define DAC11_CMD_CHANNEL_D 0x03
64#define DAC11_CMD_CHANNEL_E 0x04
65#define DAC11_CMD_CHANNEL_F 0x05
66#define DAC11_CMD_CHANNEL_G 0x06
67#define DAC11_CMD_CHANNEL_H 0x07
68#define DAC11_CMD_WRM 0x08
69#define DAC11_CMD_WTM 0x09
70#define DAC11_CMD_UPDATE_SELECT 0x0A
71#define DAC11_CMD_CHANNEL_A_WRITE 0x0B
72#define DAC11_CMD_BROADCAST 0x0C
73#define DAC11_CMD_PD_HIGH_Z 0x0D
74#define DAC11_CMD_PD_100KOHM 0x0E
75#define DAC11_CMD_PD_2p5KOHM 0x0F
76 // dac11_reg
78
93#define DAC11_SELECT_CHANNEL_A 0x01
94#define DAC11_SELECT_CHANNEL_B 0x02
95#define DAC11_SELECT_CHANNEL_C 0x04
96#define DAC11_SELECT_CHANNEL_D 0x08
97#define DAC11_SELECT_CHANNEL_E 0x10
98#define DAC11_SELECT_CHANNEL_F 0x20
99#define DAC11_SELECT_CHANNEL_G 0x40
100#define DAC11_SELECT_CHANNEL_H 0x80
101#define DAC11_SELECT_ALL_CHANNELS 0xFF
102
107#define DAC11_MIN_DAC_VALUE 0x0000
108#define DAC11_MAX_DAC_VALUE 0x0FFF
109
114#define DAC11_VREF_3V3 3.3
115#define DAC11_VREF_5V 5
116
125#define DAC11_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
126#define DAC11_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
127 // dac11_set
129
144#define DAC11_MAP_MIKROBUS( cfg, mikrobus ) \
145 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
146 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
147 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
148 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
149 // dac11_map // dac11
152
157typedef struct
158{
159 // Modules
160 spi_master_t spi;
162 pin_name_t chip_select;
164} dac11_t;
165
170typedef struct
171{
172 // Communication gpio pins
173 pin_name_t miso;
174 pin_name_t mosi;
175 pin_name_t sck;
176 pin_name_t cs;
178 // static variable
179 uint32_t spi_speed;
180 spi_master_mode_t spi_mode;
181 spi_master_chip_select_polarity_t cs_polarity;
184
189typedef enum
190{
192 DAC11_ERROR = -1
193
195
212
227err_t dac11_init ( dac11_t *ctx, dac11_cfg_t *cfg );
228
243
257err_t dac11_generic_write ( dac11_t *ctx, uint16_t *data_in, uint8_t len );
258
272err_t dac11_write_control_reg( dac11_t *ctx, uint8_t cmd, uint16_t data_in );
273
286err_t dac11_set_all_ch_value( dac11_t *ctx, uint16_t dac_value );
287
302err_t dac11_set_all_ch_voltage( dac11_t *ctx, float vref, float voltage );
303
317err_t dac11_set_specific_ch_value( dac11_t *ctx, uint8_t channel, uint16_t dac_value );
318
334err_t dac11_set_specific_ch_voltage( dac11_t *ctx, uint8_t channel, float vref, float voltage );
335
336#ifdef __cplusplus
337}
338#endif
339#endif // DAC11_H
340 // dac11
342
343// ------------------------------------------------------------------------ END
dac11_return_value_t
DAC 11 Click return value data.
Definition: dac11.h:190
@ DAC11_ERROR
Definition: dac11.h:192
@ DAC11_OK
Definition: dac11.h:191
err_t dac11_set_all_ch_voltage(dac11_t *ctx, float vref, float voltage)
DAC 11 set all channels voltage function.
void dac11_cfg_setup(dac11_cfg_t *cfg)
DAC 11 configuration object setup function.
err_t dac11_default_cfg(dac11_t *ctx)
DAC 11 default configuration function.
err_t dac11_generic_write(dac11_t *ctx, uint16_t *data_in, uint8_t len)
DAC 11 generic write function.
err_t dac11_set_all_ch_value(dac11_t *ctx, uint16_t dac_value)
DAC 11 set all channels value function.
err_t dac11_init(dac11_t *ctx, dac11_cfg_t *cfg)
DAC 11 initialization function.
err_t dac11_set_specific_ch_value(dac11_t *ctx, uint8_t channel, uint16_t dac_value)
DAC 11 set specific channels value function.
err_t dac11_set_specific_ch_voltage(dac11_t *ctx, uint8_t channel, float vref, float voltage)
DAC 11 set specific channels voltage function.
err_t dac11_write_control_reg(dac11_t *ctx, uint8_t cmd, uint16_t data_in)
DAC 11 write control register function.
This file contains SPI specific macros, functions, etc.
DAC 11 Click configuration object.
Definition: dac11.h:171
spi_master_chip_select_polarity_t cs_polarity
Definition: dac11.h:181
pin_name_t sck
Definition: dac11.h:175
spi_master_mode_t spi_mode
Definition: dac11.h:180
pin_name_t mosi
Definition: dac11.h:174
uint32_t spi_speed
Definition: dac11.h:179
pin_name_t miso
Definition: dac11.h:173
pin_name_t cs
Definition: dac11.h:176
DAC 11 Click context object.
Definition: dac11.h:158
spi_master_t spi
Definition: dac11.h:160
pin_name_t chip_select
Definition: dac11.h:162