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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_spi_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
68 #define MCP16331_MAP_MIKROBUS( cfg, mikrobus ) \
69  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
70  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
71  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
72  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
73  cfg.adc_out = MIKROBUS( mikrobus, MIKROBUS_AN ); \
74  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
75 
81 #define MCP16331_RETVAL uint8_t
82 
83 #define MCP16331_OK 0x00
84 #define MCP16331_INIT_ERROR 0xFF
85  // End group macro
88 // --------------------------------------------------------------- PUBLIC TYPES
97 typedef struct
98 {
99  // Output pins
100 
101  digital_out_t cs;
102  digital_out_t en;
103 
104  // Input pins
105 
106  digital_in_t adc_out;
107 
108  // Modules
109 
110  spi_master_t spi;
111  pin_name_t chip_select;
112 
113 } mcp16331_t;
114 
118 typedef struct
119 {
120  // Communication gpio pins
121 
122  pin_name_t miso;
123  pin_name_t mosi;
124  pin_name_t sck;
125  pin_name_t cs;
126 
127  // Additional gpio pins
128 
129  pin_name_t adc_out;
130  pin_name_t en;
131 
132  // static variable
133 
134  uint32_t spi_speed;
135  uint8_t spi_mode;
136  spi_master_chip_select_polarity_t cs_polarity;
137 
139  // End types group
141 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
142 
147 #ifdef __cplusplus
148 extern "C"{
149 #endif
150 
160 
169 
182 (
183  mcp16331_t *ctx,
184  uint8_t *wr_buf,
185  uint16_t wr_len,
186  uint8_t *rd_buf,
187  uint16_t rd_len
188 );
189 
198 void mcp16331_set_vout ( mcp16331_t *ctx, uint16_t millivolts_vout );
199 
200 #ifdef __cplusplus
201 }
202 #endif
203 #endif // _MCP16331_H_
204  // End public_function group
207 
208 // ------------------------------------------------------------------------- END
mcp16331_t::cs
digital_out_t cs
Definition: mcp16331.h:101
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:136
mcp16331_cfg_t::mosi
pin_name_t mosi
Definition: mcp16331.h:123
mcp16331_cfg_t::sck
pin_name_t sck
Definition: mcp16331.h:124
mcp16331_t
Click ctx object definition.
Definition: mcp16331.h:98
mcp16331_t::en
digital_out_t en
Definition: mcp16331.h:102
mcp16331_cfg_t::adc_out
pin_name_t adc_out
Definition: mcp16331.h:129
MCP16331_RETVAL
#define MCP16331_RETVAL
Definition: mcp16331.h:81
mcp16331_cfg_t::miso
pin_name_t miso
Definition: mcp16331.h:122
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:125
mcp16331_t::chip_select
pin_name_t chip_select
Definition: mcp16331.h:111
mcp16331_t::adc_out
digital_in_t adc_out
Definition: mcp16331.h:106
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:135
mcp16331_t::spi
spi_master_t spi
Definition: mcp16331.h:110
mcp16331_cfg_t
Click configuration structure definition.
Definition: mcp16331.h:119
mcp16331_cfg_t::en
pin_name_t en
Definition: mcp16331.h:130
mcp16331_cfg_t::spi_speed
uint32_t spi_speed
Definition: mcp16331.h:134