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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define MCP16331INV_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
60  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
61 
67 #define MCP16331INV_RETVAL uint8_t
68 
69 #define MCP16331INV_OK 0x00
70 #define MCP16331INV_INIT_ERROR 0xFF
71 
78 #define MCP16331INV_ENABLE_VIN_PULL_UP 1
79 #define MCP16331INV_DISABLE_VIN_PULL_UP 0
80 
86 #define MCP16331INV_GAIN_1X_VREF 1
87 #define MCP16331INV_GAIN_2X_VREF 0
88 
94 #define MCP16331INV_ACTIVE_MODE 1
95 #define MCP16331INV_SHUTDOWN_MODE 0
96 
102 #define MCP16331INV_MIN_2715_MV_1X_GAIN 0x0000
103 #define MCP16331INV_2900_MV_1X_GAIN 0x00F5
104 #define MCP16331INV_3000_MV_1X_GAIN 0x017A
105 #define MCP16331INV_3100_MV_1X_GAIN 0x01FE
106 #define MCP16331INV_3300_MV_1X_GAIN 0x02FE
107 #define MCP16331INV_3500_MV_1X_GAIN 0x03FF
108 #define MCP16331INV_3700_MV_1X_GAIN 0x04FF
109 #define MCP16331INV_3900_MV_1X_GAIN 0x05FF
110 #define MCP16331INV_4000_MV_1X_GAIN 0x0690
111 #define MCP16331INV_4300_MV_1X_GAIN 0x0810
112 #define MCP16331INV_5000_MV_1X_GAIN 0x0BAE
113 #define MCP16331INV_5200_MV_1X_GAIN 0x0CAF
114 #define MCP16331INV_5300_MV_1X_GAIN 0x0D3F
115 #define MCP16331INV_MAX_5400_MV_1X_GAIN 0x0FFF
116 
122 #define MCP16331INV_MIN_2715_MV_2X_GAIN 0x0000
123 #define MCP16331INV_3000_MV_2X_GAIN 0x00B8
124 #define MCP16331INV_3500_MV_2X_GAIN 0x01FF
125 #define MCP16331INV_3900_MV_2X_GAIN 0x02FF
126 #define MCP16331INV_4400_MV_2X_GAIN 0x044F
127 #define MCP16331INV_4800_MV_2X_GAIN 0x0558
128 #define MCP16331INV_4900_MV_2X_GAIN 0x0590
129 #define MCP16331INV_5000_MV_2X_GAIN 0x05D0
130 #define MCP16331INV_5300_MV_2X_GAIN 0x0690
131 #define MCP16331INV_MAX_5400_MV_2X_GAIN 0x0FFF
132  // End group macro
134 // --------------------------------------------------------------- PUBLIC TYPES
143 typedef struct
144 {
145  // Output pins
146 
147  digital_out_t rst;
148  digital_out_t cs;
149 
150  // Input pins
151 
152  digital_in_t an;
153 
154  // Modules
155 
156  spi_master_t spi;
157  pin_name_t chip_select;
158 
159 } mcp16331inv_t;
160 
164 typedef struct
165 {
166  // Communication gpio pins
167 
168  pin_name_t miso;
169  pin_name_t mosi;
170  pin_name_t sck;
171  pin_name_t cs;
172 
173  // Additional gpio pins
174 
175  pin_name_t an;
176  pin_name_t rst;
177 
178  // static variable
179 
180  uint32_t spi_speed;
181  uint8_t spi_mode;
182  spi_master_chip_select_polarity_t cs_polarity;
183 
185  // End types group
187 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
188 
193 #ifdef __cplusplus
194 extern "C"{
195 #endif
196 
206 
215 
228 (
229  mcp16331inv_t *ctx,
230  uint8_t *wr_buf,
231  uint16_t wr_len,
232  uint8_t *rd_buf,
233  uint16_t rd_len
234 );
235 
247 void mcp16331inv_set_dac_vout ( mcp16331inv_t *ctx, uint16_t dac_value, uint8_t gain_value, uint8_t mode );
248 
257 void mcp16331inv_enable_vin ( mcp16331inv_t *ctx, uint8_t state );
258 
259 #ifdef __cplusplus
260 }
261 #endif
262 #endif // _MCP16331INV_H_
263  // End public_function group
266 
267 // ------------------------------------------------------------------------- END
mcp16331inv_cfg_t::miso
pin_name_t miso
Definition: mcp16331inv.h:168
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:182
mcp16331inv_cfg_t::mosi
pin_name_t mosi
Definition: mcp16331inv.h:169
mcp16331inv_cfg_t
Click configuration structure definition.
Definition: mcp16331inv.h:165
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:148
mcp16331inv_t
Click ctx object definition.
Definition: mcp16331inv.h:144
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:181
mcp16331inv_t::an
digital_in_t an
Definition: mcp16331inv.h:152
mcp16331inv_t::rst
digital_out_t rst
Definition: mcp16331inv.h:147
mcp16331inv_cfg_t::rst
pin_name_t rst
Definition: mcp16331inv.h:176
mcp16331inv_t::chip_select
pin_name_t chip_select
Definition: mcp16331inv.h:157
mcp16331inv_t::spi
spi_master_t spi
Definition: mcp16331inv.h:156
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:180
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:170
mcp16331inv_cfg_t::cs
pin_name_t cs
Definition: mcp16331inv.h:171
MCP16331INV_RETVAL
#define MCP16331INV_RETVAL
Definition: mcp16331inv.h:67
mcp16331inv_cfg_t::an
pin_name_t an
Definition: mcp16331inv.h:175