digipot  2.0.0.0
digipot.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 DIGIPOT_H
29 #define DIGIPOT_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_spi_master.h"
51 
72 #define DIGIPOT_MAP_MIKROBUS( cfg, mikrobus ) \
73  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
74  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
75  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
76  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
77  // digipot_map
79 
94 #define DIGIPOT_DATA_EEPROM_6 0x06
95 #define DIGIPOT_DATA_EEPROM_7 0x07
96 #define DIGIPOT_DATA_EEPROM_8 0x08
97 #define DIGIPOT_DATA_EEPROM_9 0x09
98 #define DIGIPOT_DATA_EEPROM_A 0x0A
99 #define DIGIPOT_DATA_EEPROM_B 0x0B
100 #define DIGIPOT_DATA_EEPROM_C 0x0C
101 #define DIGIPOT_DATA_EEPROM_D 0x0D
102 #define DIGIPOT_DATA_EEPROM_E 0x0E
103 #define DIGIPOT_DATA_EEPROM_F 0x0F
104 #define DIGIPOT_DATA_WRITE_CMD 0x20
105 
110 #define DIGIPOT_VOLATILE_WIPER_0 0x00
111 #define DIGIPOT_VOLATILE_WIPER_1 0x01
112 #define DIGIPOT_NON_VOLATILE_WIPER_0 0x02
113 #define DIGIPOT_NON_VOLATILE_WIPER_1 0x03
114 #define DIGIPOT_VOLATILE_TCON_REGISTER 0x04
115 #define DIGIPOT_STATUS_REGISTER 0x05
116  // digipot_macros // digipot
119 
124 typedef struct
125 {
126  // Output pins
127 
128  digital_out_t cs;
129 
130  // Modules
131  spi_master_t spi;
133  pin_name_t chip_select;
135 } digipot_t;
136 
141 typedef struct
142 {
143  // Communication gpio pins
144  pin_name_t miso;
145  pin_name_t mosi;
146  pin_name_t sck;
147  pin_name_t cs;
149  // static variable
150 
151  uint32_t spi_speed;
152  spi_master_mode_t spi_mode;
153  spi_master_chip_select_polarity_t cs_polarity;
155 } digipot_cfg_t;
156 
161 typedef enum
162 {
164  DIGIPOT_ERROR = -1
165 
167 
184 
199 err_t digipot_init ( digipot_t *ctx, digipot_cfg_t *cfg );
200 
213 void digipot_generic_transfer ( digipot_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
214 
225 
235 float digipot_convert_output ( uint16_t adc_val, float v_ref );
236 
237 #ifdef __cplusplus
238 }
239 #endif
240 #endif // DIGIPOT_H
241  // digipot
243 
244 // ------------------------------------------------------------------------ END
digipot_set_wiper_positions
void digipot_set_wiper_positions(digipot_t *ctx, uint8_t wiper_pos)
Set wiper position.
digipot_t::spi
spi_master_t spi
Definition: digipot.h:131
digipot_cfg_t::cs
pin_name_t cs
Definition: digipot.h:147
digipot_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: digipot.h:153
digipot_t
DIGI POT Click context object.
Definition: digipot.h:125
digipot_generic_transfer
void digipot_generic_transfer(digipot_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
digipot_t::cs
digital_out_t cs
Definition: digipot.h:128
digipot_cfg_setup
void digipot_cfg_setup(digipot_cfg_t *cfg)
DIGI POT configuration object setup function.
wiper_pos
uint8_t wiper_pos
Definition: main.c:28
digipot_init
err_t digipot_init(digipot_t *ctx, digipot_cfg_t *cfg)
DIGI POT initialization function.
DIGIPOT_ERROR
@ DIGIPOT_ERROR
Definition: digipot.h:164
digipot_cfg_t::miso
pin_name_t miso
Definition: digipot.h:144
digipot_convert_output
float digipot_convert_output(uint16_t adc_val, float v_ref)
Convert ADC value to volatage.
digipot_cfg_t::mosi
pin_name_t mosi
Definition: digipot.h:145
DIGIPOT_OK
@ DIGIPOT_OK
Definition: digipot.h:163
digipot_return_value_t
digipot_return_value_t
DIGI POT Click return value data.
Definition: digipot.h:162
digipot_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: digipot.h:152
digipot_t::chip_select
pin_name_t chip_select
Definition: digipot.h:133
digipot_cfg_t::sck
pin_name_t sck
Definition: digipot.h:146
digipot_cfg_t
DIGI POT Click configuration object.
Definition: digipot.h:142
digipot_cfg_t::spi_speed
uint32_t spi_speed
Definition: digipot.h:151