digipot5  2.0.0.0
digipot5.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef _DIGIPOT5_H_
36 #define _DIGIPOT5_H_
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_spi_master.h"
49 
50 // -------------------------------------------------------------- PUBLIC MACROS
60 #define DIGIPOT5_RETVAL uint8_t
61 
62 #define DIGIPOT5_OK 0x00
63 #define DIGIPOT5_INIT_ERROR 0xFF
64 
70 #define DIGIPOT5_RES_ZEROSCALE 0x00
71 #define DIGIPOT5_RES_1KOHM 0x1A
72 #define DIGIPOT5_RES_2KOHM 0x34
73 #define DIGIPOT5_RES_3KOHM 0x4E
74 #define DIGIPOT5_RES_5KOHM_HALFSCALE 0x80
75 #define DIGIPOT5_RES_7KOHM 0xB6
76 #define DIGIPOT5_RES_8KOHM 0xD0
77 #define DIGIPOT5_RES_10KOHM_FULLSCALE 0x100
78 
84 #define DIGIPOT5_MAP_MIKROBUS( cfg, mikrobus ) \
85  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
86  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
87  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
88  cfg.sdo = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
89  cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI )
90  // End macros group
93 // --------------------------------------------------------------- PUBLIC TYPES
102 typedef enum
103 {
108 
110 
114 typedef enum
115 {
132 
134 
138 typedef struct
139 {
140  digital_out_t cs;
141 
142  // Reset control pin.
143  digital_out_t rst;
144 
145  // Modules.
146  spi_master_t spi;
147  pin_name_t chip_select;
148 
149 } digipot5_t;
150 
154 typedef struct
155 {
156  // Communication gpio pins.
157  pin_name_t cs;
158  pin_name_t sck;
159  pin_name_t sdo;
160  pin_name_t sdi;
161 
162  // Additional gpio pin.
163  pin_name_t rst;
164 
165  // SPI config variables.
166  uint32_t spi_speed;
167  spi_master_mode_t spi_mode;
168  spi_master_chip_select_polarity_t cs_polarity;
169 
171  // End types group
173 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
179 #ifdef __cplusplus
180 extern "C"{
181 #endif
182 
192 void
194 
209 
218 void
220 
229 void
231 
247  uint16_t data_in );
248 
263  uint16_t *data_out );
264 
279 
294 
295 #ifdef __cplusplus
296 }
297 #endif
298 #endif // _DIGIPOT5_H_
299  // End public_function group
302 
303 // ------------------------------------------------------------------------ END
digipot5_generic_read
digipot5_err_t digipot5_generic_read(digipot5_t *ctx, digipot5_reg_t reg_addr, uint16_t *data_out)
Generic Read function.
digipot5_init
digipot5_err_t digipot5_init(digipot5_t *ctx, digipot5_cfg_t *cfg)
Click Initialization function.
digipot5_increment_wiper
digipot5_reg_t digipot5_increment_wiper(digipot5_t *ctx, digipot5_reg_t reg_addr)
Increment Wiper function.
digipot5_cfg_t::sdo
pin_name_t sdo
Definition: digipot5.h:159
digipot5_reset
void digipot5_reset(digipot5_t *ctx)
Reset function.
DIGIPOT5_ERROR_REG_ADDR
@ DIGIPOT5_ERROR_REG_ADDR
Definition: digipot5.h:107
DIGIPOT5_REG_EEPROM2_NONVOL
@ DIGIPOT5_REG_EEPROM2_NONVOL
Definition: digipot5.h:129
DIGIPOT5_REG_WIPER0_NONVOL
@ DIGIPOT5_REG_WIPER0_NONVOL
Definition: digipot5.h:118
digipot5_cfg_t::sdi
pin_name_t sdi
Definition: digipot5.h:160
DIGIPOT5_ERROR_INIT_DRV
@ DIGIPOT5_ERROR_INIT_DRV
Definition: digipot5.h:106
DIGIPOT5_REG_WIPER1_NONVOL
@ DIGIPOT5_REG_WIPER1_NONVOL
Definition: digipot5.h:119
digipot5_cfg_t
Click configuration structure definition.
Definition: digipot5.h:155
digipot5_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: digipot5.h:168
DIGIPOT5_REG_EEPROM0_NONVOL
@ DIGIPOT5_REG_EEPROM0_NONVOL
Definition: digipot5.h:127
DIGIPOT5_REG_WIPER0_VOL
@ DIGIPOT5_REG_WIPER0_VOL
Definition: digipot5.h:116
digipot5_cfg_t::rst
pin_name_t rst
Definition: digipot5.h:163
digipot5_t::cs
digital_out_t cs
Definition: digipot5.h:140
digipot5_t
Click context object definition.
Definition: digipot5.h:139
digipot5_err_t
digipot5_err_t
Click error code definition.
Definition: digipot5.h:103
DIGIPOT5_REG_EEPROM1_NONVOL
@ DIGIPOT5_REG_EEPROM1_NONVOL
Definition: digipot5.h:128
DIGIPOT5_REG_WIPER1_VOL
@ DIGIPOT5_REG_WIPER1_VOL
Definition: digipot5.h:117
DIGIPOT5_REG_WIPER3_NONVOL
@ DIGIPOT5_REG_WIPER3_NONVOL
Definition: digipot5.h:125
digipot5_t::spi
spi_master_t spi
Definition: digipot5.h:146
digipot5_cfg_setup
void digipot5_cfg_setup(digipot5_cfg_t *cfg)
Configuration Object Setup function.
DIGIPOT5_REG_WIPER3_VOL
@ DIGIPOT5_REG_WIPER3_VOL
Definition: digipot5.h:123
DIGIPOT5_REG_EEPROM4_NONVOL
@ DIGIPOT5_REG_EEPROM4_NONVOL
Definition: digipot5.h:131
DIGIPOT5_REG_TCON1_VOL
@ DIGIPOT5_REG_TCON1_VOL
Definition: digipot5.h:126
digipot5_generic_write
digipot5_err_t digipot5_generic_write(digipot5_t *ctx, digipot5_reg_t reg_addr, uint16_t data_in)
Generic Write function.
DIGIPOT5_REG_WIPER2_NONVOL
@ DIGIPOT5_REG_WIPER2_NONVOL
Definition: digipot5.h:124
DIGIPOT5_REG_EEPROM3_NONVOL
@ DIGIPOT5_REG_EEPROM3_NONVOL
Definition: digipot5.h:130
digipot5_t::chip_select
pin_name_t chip_select
Definition: digipot5.h:147
DIGIPOT5_REG_STATUS_VOL
@ DIGIPOT5_REG_STATUS_VOL
Definition: digipot5.h:121
DIGIPOT5_REG_TCON0_VOL
@ DIGIPOT5_REG_TCON0_VOL
Definition: digipot5.h:120
digipot5_t::rst
digital_out_t rst
Definition: digipot5.h:143
digipot5_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: digipot5.h:167
digipot5_default_cfg
void digipot5_default_cfg(digipot5_t *ctx)
Click Default Configuration function.
DIGIPOT5_STATUS_OK
@ DIGIPOT5_STATUS_OK
Definition: digipot5.h:104
digipot5_decrement_wiper
digipot5_reg_t digipot5_decrement_wiper(digipot5_t *ctx, digipot5_reg_t reg_addr)
Decrement Wiper function.
digipot5_reg_t
digipot5_reg_t
Click register address definition.
Definition: digipot5.h:115
digipot5_cfg_t::sck
pin_name_t sck
Definition: digipot5.h:158
DIGIPOT5_ERROR_CMD
@ DIGIPOT5_ERROR_CMD
Definition: digipot5.h:105
DIGIPOT5_REG_WIPER2_VOL
@ DIGIPOT5_REG_WIPER2_VOL
Definition: digipot5.h:122
digipot5_cfg_t::spi_speed
uint32_t spi_speed
Definition: digipot5.h:166
digipot5_cfg_t::cs
pin_name_t cs
Definition: digipot5.h:157