digipot14  2.1.0.0
digipot14.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 DIGIPOT14_H
29 #define DIGIPOT14_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define DIGIPOT14_VOLATILE_REG_WRA 0x00
70 #define DIGIPOT14_VOLATILE_REG_WRB 0x01
71 #define DIGIPOT14_VOLATILE_REG_ACR 0x10
72 #define DIGIPOT14_NON_VOLATILE_REG_IVRA 0x00
73 #define DIGIPOT14_NON_VOLATILE_REG_IVRB 0x01
74  // digipot14_reg
76 
91 #define DIGIPOT14_VOLATILE_REG_WRITE 0x80
92 #define DIGIPOT14_NON_VOLATILE_REG_WRITE 0x00
93 #define DIGIPOT14_DISABLE_SHUT_DOWN 0x40
94 #define DIGIPOT14_ENABLE_SHUT_DOWN 0x00
95 #define DIGIPOT14_NON_VOLATILE_WR_IN_PROGRESS 0x20
96 #define DIGIPOT14_NON_VOLATILE_WR_NOT_IN_PROGRESS 0x00
97 
98 #define DIGIPOT14_MAX_RESISTANCE_KOHM 100.0
99 #define DIGIPOT14_MAX_POSITION 255
100 #define DIGIPOT14_MAX_POSITION_NUM 256.0
101 #define DIGIPOT14_MIN_POSITION 0
102 
108 #define DIGIPOT14_DEVICE_ADDRESS_000 0x50
109 #define DIGIPOT14_DEVICE_ADDRESS_001 0x51
110 #define DIGIPOT14_DEVICE_ADDRESS_010 0x52
111 #define DIGIPOT14_DEVICE_ADDRESS_011 0x53
112 #define DIGIPOT14_DEVICE_ADDRESS_100 0x54
113 #define DIGIPOT14_DEVICE_ADDRESS_101 0x55
114 #define DIGIPOT14_DEVICE_ADDRESS_110 0x56
115 #define DIGIPOT14_DEVICE_ADDRESS_111 0x57
116  // digipot14_set
118 
133 #define DIGIPOT14_MAP_MIKROBUS( cfg, mikrobus ) \
134  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
135  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
136  // digipot14_map // digipot14
139 
144 typedef struct
145 {
146  // Modules
147  i2c_master_t i2c;
149  // I2C slave address
150  uint8_t slave_address;
152 } digipot14_t;
153 
158 typedef struct
159 {
160  pin_name_t scl;
161  pin_name_t sda;
163  uint32_t i2c_speed;
164  uint8_t i2c_address;
167 
172 typedef enum
173 {
175  DIGIPOT14_ERROR = -1
176 
178 
195 
210 
224 
239 err_t digipot14_generic_write ( digipot14_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
240 
255 err_t digipot14_generic_read ( digipot14_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
256 
270 err_t digipot14_reg_write ( digipot14_t *ctx, uint8_t reg, uint8_t data_in );
271 
285 err_t digipot14_reg_read ( digipot14_t *ctx, uint8_t reg, uint8_t *data_out );
286 
300 err_t digipot14_set_pot_a_wiper ( digipot14_t *ctx, uint8_t wiper_pos );
301 
315 err_t digipot14_set_pot_b_wiper ( digipot14_t *ctx, uint8_t wiper_pos );
316 
317 #ifdef __cplusplus
318 }
319 #endif
320 #endif // DIGIPOT14_H
321  // digipot14
323 
324 // ------------------------------------------------------------------------ END
digipot14_cfg_setup
void digipot14_cfg_setup(digipot14_cfg_t *cfg)
DIGI POT 14 configuration object setup function.
digipot14_generic_read
err_t digipot14_generic_read(digipot14_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
DIGI POT 14 I2C reading function.
digipot14_return_value_t
digipot14_return_value_t
DIGI POT 14 Click return value data.
Definition: digipot14.h:173
digipot14_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: digipot14.h:163
digipot14_generic_write
err_t digipot14_generic_write(digipot14_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
DIGI POT 14 I2C writing function.
digipot14_default_cfg
err_t digipot14_default_cfg(digipot14_t *ctx)
DIGI POT 14 default configuration function.
digipot14_t
DIGI POT 14 Click context object.
Definition: digipot14.h:145
digipot14_cfg_t::i2c_address
uint8_t i2c_address
Definition: digipot14.h:164
digipot14_t::i2c
i2c_master_t i2c
Definition: digipot14.h:147
digipot14_cfg_t::scl
pin_name_t scl
Definition: digipot14.h:160
digipot14_set_pot_b_wiper
err_t digipot14_set_pot_b_wiper(digipot14_t *ctx, uint8_t wiper_pos)
DIGI POT 14 set the wiper position of potentiometer B function.
digipot14_t::slave_address
uint8_t slave_address
Definition: digipot14.h:150
digipot14_set_pot_a_wiper
err_t digipot14_set_pot_a_wiper(digipot14_t *ctx, uint8_t wiper_pos)
DIGI POT 14 set the wiper position of potentiometer A function.
digipot14_cfg_t::sda
pin_name_t sda
Definition: digipot14.h:161
digipot14_reg_write
err_t digipot14_reg_write(digipot14_t *ctx, uint8_t reg, uint8_t data_in)
DIGI POT 14 register write function.
digipot14_reg_read
err_t digipot14_reg_read(digipot14_t *ctx, uint8_t reg, uint8_t *data_out)
DIGI POT 14 register reading function.
digipot14_cfg_t
DIGI POT 14 Click configuration object.
Definition: digipot14.h:159
DIGIPOT14_OK
@ DIGIPOT14_OK
Definition: digipot14.h:174
digipot14_init
err_t digipot14_init(digipot14_t *ctx, digipot14_cfg_t *cfg)
DIGI POT 14 initialization function.
DIGIPOT14_ERROR
@ DIGIPOT14_ERROR
Definition: digipot14.h:175