mcp16331inv  2.0.0.0
mcp16331inv.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 MCP16331INV_H
36 #define MCP16331INV_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_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define MCP16331INV_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
66  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
67  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
68  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
69  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
70  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
71 
77 #define MCP16331INV_RETVAL uint8_t
78 
79 #define MCP16331INV_OK 0x00
80 #define MCP16331INV_INIT_ERROR 0xFF
81 
88 #define MCP16331INV_ENABLE_VIN_PULL_UP 1
89 #define MCP16331INV_DISABLE_VIN_PULL_UP 0
90 
96 #define MCP16331INV_GAIN_1X_VREF 1
97 #define MCP16331INV_GAIN_2X_VREF 0
98 
104 #define MCP16331INV_ACTIVE_MODE 1
105 #define MCP16331INV_SHUTDOWN_MODE 0
106 
112 #define MCP16331INV_MIN_2715_MV_1X_GAIN 0x0000
113 #define MCP16331INV_2900_MV_1X_GAIN 0x00F5
114 #define MCP16331INV_3000_MV_1X_GAIN 0x017A
115 #define MCP16331INV_3100_MV_1X_GAIN 0x01FE
116 #define MCP16331INV_3300_MV_1X_GAIN 0x02FE
117 #define MCP16331INV_3500_MV_1X_GAIN 0x03FF
118 #define MCP16331INV_3700_MV_1X_GAIN 0x04FF
119 #define MCP16331INV_3900_MV_1X_GAIN 0x05FF
120 #define MCP16331INV_4000_MV_1X_GAIN 0x0690
121 #define MCP16331INV_4300_MV_1X_GAIN 0x0810
122 #define MCP16331INV_5000_MV_1X_GAIN 0x0BAE
123 #define MCP16331INV_5200_MV_1X_GAIN 0x0CAF
124 #define MCP16331INV_5300_MV_1X_GAIN 0x0D3F
125 #define MCP16331INV_MAX_5400_MV_1X_GAIN 0x0FFF
126 
132 #define MCP16331INV_MIN_2715_MV_2X_GAIN 0x0000
133 #define MCP16331INV_3000_MV_2X_GAIN 0x00B8
134 #define MCP16331INV_3500_MV_2X_GAIN 0x01FF
135 #define MCP16331INV_3900_MV_2X_GAIN 0x02FF
136 #define MCP16331INV_4400_MV_2X_GAIN 0x044F
137 #define MCP16331INV_4800_MV_2X_GAIN 0x0558
138 #define MCP16331INV_4900_MV_2X_GAIN 0x0590
139 #define MCP16331INV_5000_MV_2X_GAIN 0x05D0
140 #define MCP16331INV_5300_MV_2X_GAIN 0x0690
141 #define MCP16331INV_MAX_5400_MV_2X_GAIN 0x0FFF
142  // End group macro
144 // --------------------------------------------------------------- PUBLIC TYPES
153 typedef struct
154 {
155  // Output pins
156 
157  digital_out_t rst;
158  digital_out_t cs;
159 
160  // Input pins
161 
162  digital_in_t an;
163 
164  // Modules
165 
166  spi_master_t spi;
167  pin_name_t chip_select;
168 
169 } mcp16331inv_t;
170 
174 typedef struct
175 {
176  // Communication gpio pins
177 
178  pin_name_t miso;
179  pin_name_t mosi;
180  pin_name_t sck;
181  pin_name_t cs;
182 
183  // Additional gpio pins
184 
185  pin_name_t an;
186  pin_name_t rst;
187 
188  // static variable
189 
190  uint32_t spi_speed;
191  uint8_t spi_mode;
192  spi_master_chip_select_polarity_t cs_polarity;
193 
195  // End types group
197 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
198 
203 #ifdef __cplusplus
204 extern "C"{
205 #endif
206 
216 
225 
238 (
239  mcp16331inv_t *ctx,
240  uint8_t *wr_buf,
241  uint16_t wr_len,
242  uint8_t *rd_buf,
243  uint16_t rd_len
244 );
245 
257 void mcp16331inv_set_dac_vout ( mcp16331inv_t *ctx, uint16_t dac_value, uint8_t gain_value, uint8_t mode );
258 
267 void mcp16331inv_enable_vin ( mcp16331inv_t *ctx, uint8_t state );
268 
269 #ifdef __cplusplus
270 }
271 #endif
272 #endif // _MCP16331INV_H_
273  // End public_function group
276 
277 // ------------------------------------------------------------------------- END
mcp16331inv_cfg_t::miso
pin_name_t miso
Definition: mcp16331inv.h:178
mcp16331inv_init
MCP16331INV_RETVAL mcp16331inv_init(mcp16331inv_t *ctx, mcp16331inv_cfg_t *cfg)
Initialization function.
mcp16331inv_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: mcp16331inv.h:192
mcp16331inv_cfg_t::mosi
pin_name_t mosi
Definition: mcp16331inv.h:179
mcp16331inv_cfg_t
Click configuration structure definition.
Definition: mcp16331inv.h:175
mcp16331inv_enable_vin
void mcp16331inv_enable_vin(mcp16331inv_t *ctx, uint8_t state)
VIN Pull Up enable function.
mcp16331inv_t::cs
digital_out_t cs
Definition: mcp16331inv.h:158
mcp16331inv_t
Click ctx object definition.
Definition: mcp16331inv.h:154
mcp16331inv_set_dac_vout
void mcp16331inv_set_dac_vout(mcp16331inv_t *ctx, uint16_t dac_value, uint8_t gain_value, uint8_t mode)
DAC output voltage set function.
mcp16331inv_cfg_t::spi_mode
uint8_t spi_mode
Definition: mcp16331inv.h:191
mcp16331inv_t::an
digital_in_t an
Definition: mcp16331inv.h:162
mcp16331inv_t::rst
digital_out_t rst
Definition: mcp16331inv.h:157
mcp16331inv_cfg_t::rst
pin_name_t rst
Definition: mcp16331inv.h:186
mcp16331inv_t::chip_select
pin_name_t chip_select
Definition: mcp16331inv.h:167
mcp16331inv_t::spi
spi_master_t spi
Definition: mcp16331inv.h:166
mcp16331inv_cfg_setup
void mcp16331inv_cfg_setup(mcp16331inv_cfg_t *cfg)
Config Object Initialization function.
mcp16331inv_cfg_t::spi_speed
uint32_t spi_speed
Definition: mcp16331inv.h:190
mcp16331inv_generic_transfer
void mcp16331inv_generic_transfer(mcp16331inv_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
mcp16331inv_cfg_t::sck
pin_name_t sck
Definition: mcp16331inv.h:180
mcp16331inv_cfg_t::cs
pin_name_t cs
Definition: mcp16331inv.h:181
MCP16331INV_RETVAL
#define MCP16331INV_RETVAL
Definition: mcp16331inv.h:77
mcp16331inv_cfg_t::an
pin_name_t an
Definition: mcp16331inv.h:185