mcp16331  2.0.0.0
mcp16331.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 MCP16331_H
36 #define MCP16331_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 MCP16331_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.adc_out = MIKROBUS( mikrobus, MIKROBUS_AN ); \
60  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
61 
67 #define MCP16331_RETVAL uint8_t
68 
69 #define MCP16331_OK 0x00
70 #define MCP16331_INIT_ERROR 0xFF
71  // End group macro
74 // --------------------------------------------------------------- PUBLIC TYPES
83 typedef struct
84 {
85  // Output pins
86 
87  digital_out_t cs;
88  digital_out_t en;
89 
90  // Input pins
91 
92  digital_in_t adc_out;
93 
94  // Modules
95 
96  spi_master_t spi;
97  pin_name_t chip_select;
98 
99 } mcp16331_t;
100 
104 typedef struct
105 {
106  // Communication gpio pins
107 
108  pin_name_t miso;
109  pin_name_t mosi;
110  pin_name_t sck;
111  pin_name_t cs;
112 
113  // Additional gpio pins
114 
115  pin_name_t adc_out;
116  pin_name_t en;
117 
118  // static variable
119 
120  uint32_t spi_speed;
121  uint8_t spi_mode;
122  spi_master_chip_select_polarity_t cs_polarity;
123 
125  // End types group
127 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
128 
133 #ifdef __cplusplus
134 extern "C"{
135 #endif
136 
145 void mcp16331_cfg_setup ( mcp16331_cfg_t *cfg );
146 
155 
168 (
169  mcp16331_t *ctx,
170  uint8_t *wr_buf,
171  uint16_t wr_len,
172  uint8_t *rd_buf,
173  uint16_t rd_len
174 );
175 
184 void mcp16331_set_vout ( mcp16331_t *ctx, uint16_t millivolts_vout );
185 
186 #ifdef __cplusplus
187 }
188 #endif
189 #endif // _MCP16331_H_
190  // End public_function group
193 
194 // ------------------------------------------------------------------------- END
mcp16331_t::cs
digital_out_t cs
Definition: mcp16331.h:87
mcp16331_cfg_setup
void mcp16331_cfg_setup(mcp16331_cfg_t *cfg)
Config Object Initialization function.
mcp16331_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: mcp16331.h:122
mcp16331_cfg_t::mosi
pin_name_t mosi
Definition: mcp16331.h:109
mcp16331_cfg_t::sck
pin_name_t sck
Definition: mcp16331.h:110
mcp16331_t
Click ctx object definition.
Definition: mcp16331.h:83
mcp16331_t::en
digital_out_t en
Definition: mcp16331.h:88
mcp16331_cfg_t::adc_out
pin_name_t adc_out
Definition: mcp16331.h:115
MCP16331_RETVAL
#define MCP16331_RETVAL
Definition: mcp16331.h:67
mcp16331_cfg_t::miso
pin_name_t miso
Definition: mcp16331.h:108
mcp16331_set_vout
void mcp16331_set_vout(mcp16331_t *ctx, uint16_t millivolts_vout)
mcp16331 set vout
mcp16331_cfg_t::cs
pin_name_t cs
Definition: mcp16331.h:111
mcp16331_t::chip_select
pin_name_t chip_select
Definition: mcp16331.h:97
mcp16331_t::adc_out
digital_in_t adc_out
Definition: mcp16331.h:92
mcp16331_generic_transfer
void mcp16331_generic_transfer(mcp16331_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
mcp16331_init
MCP16331_RETVAL mcp16331_init(mcp16331_t *ctx, mcp16331_cfg_t *cfg)
Initialization function.
mcp16331_cfg_t::spi_mode
uint8_t spi_mode
Definition: mcp16331.h:121
mcp16331_t::spi
spi_master_t spi
Definition: mcp16331.h:96
mcp16331_cfg_t
Click configuration structure definition.
Definition: mcp16331.h:104
mcp16331_cfg_t::en
pin_name_t en
Definition: mcp16331.h:116
mcp16331_cfg_t::spi_speed
uint32_t spi_speed
Definition: mcp16331.h:120