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 
35 #include "drv_digital_out.h"
36 #include "drv_spi_master.h"
37 
58 #define DIGIPOT_MAP_MIKROBUS( cfg, mikrobus ) \
59  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
60  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
61  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
62  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
63  // digipot_map
65 
80 #define DIGIPOT_DATA_EEPROM_6 0x06
81 #define DIGIPOT_DATA_EEPROM_7 0x07
82 #define DIGIPOT_DATA_EEPROM_8 0x08
83 #define DIGIPOT_DATA_EEPROM_9 0x09
84 #define DIGIPOT_DATA_EEPROM_A 0x0A
85 #define DIGIPOT_DATA_EEPROM_B 0x0B
86 #define DIGIPOT_DATA_EEPROM_C 0x0C
87 #define DIGIPOT_DATA_EEPROM_D 0x0D
88 #define DIGIPOT_DATA_EEPROM_E 0x0E
89 #define DIGIPOT_DATA_EEPROM_F 0x0F
90 #define DIGIPOT_DATA_WRITE_CMD 0x20
91 
96 #define DIGIPOT_VOLATILE_WIPER_0 0x00
97 #define DIGIPOT_VOLATILE_WIPER_1 0x01
98 #define DIGIPOT_NON_VOLATILE_WIPER_0 0x02
99 #define DIGIPOT_NON_VOLATILE_WIPER_1 0x03
100 #define DIGIPOT_VOLATILE_TCON_REGISTER 0x04
101 #define DIGIPOT_STATUS_REGISTER 0x05
102  // digipot_macros // digipot
105 
110 typedef struct
111 {
112  // Output pins
113 
114  digital_out_t cs;
115 
116  // Modules
117  spi_master_t spi;
119  pin_name_t chip_select;
121 } digipot_t;
122 
127 typedef struct
128 {
129  // Communication gpio pins
130  pin_name_t miso;
131  pin_name_t mosi;
132  pin_name_t sck;
133  pin_name_t cs;
135  // static variable
136 
137  uint32_t spi_speed;
138  spi_master_mode_t spi_mode;
139  spi_master_chip_select_polarity_t cs_polarity;
141 } digipot_cfg_t;
142 
147 typedef enum
148 {
150  DIGIPOT_ERROR = -1
151 
153 
170 
185 err_t digipot_init ( digipot_t *ctx, digipot_cfg_t *cfg );
186 
199 void digipot_generic_transfer ( digipot_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
200 
211 
221 float digipot_convert_output ( uint16_t adc_val, float v_ref );
222 
223 #ifdef __cplusplus
224 }
225 #endif
226 #endif // DIGIPOT_H
227  // digipot
229 
230 // ------------------------------------------------------------------------ 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:117
digipot_cfg_t::cs
pin_name_t cs
Definition: digipot.h:133
digipot_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: digipot.h:139
digipot_t
DIGI POT Click context object.
Definition: digipot.h:111
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:114
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:150
digipot_cfg_t::miso
pin_name_t miso
Definition: digipot.h:130
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:131
DIGIPOT_OK
@ DIGIPOT_OK
Definition: digipot.h:149
digipot_return_value_t
digipot_return_value_t
DIGI POT Click return value data.
Definition: digipot.h:148
digipot_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: digipot.h:138
digipot_t::chip_select
pin_name_t chip_select
Definition: digipot.h:119
digipot_cfg_t::sck
pin_name_t sck
Definition: digipot.h:132
digipot_cfg_t
DIGI POT Click configuration object.
Definition: digipot.h:128
digipot_cfg_t::spi_speed
uint32_t spi_speed
Definition: digipot.h:137