mic24055  2.0.0.0
mic24055.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 MIC24055_H
36 #define MIC24055_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 MIC24055_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.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
61  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
62 
68 #define MIC24055_RETVAL uint8_t
69 
70 #define MIC24055_OK 0x00
71 #define MIC24055_INIT_ERROR 0xFF
72  // End group macro
75 // --------------------------------------------------------------- PUBLIC TYPES
84 typedef struct
85 {
86  // Output pins
87 
88  digital_out_t en;
89  digital_out_t int_pin;
90  digital_out_t cs;
91 
92  // Input pins
93 
94  digital_in_t an;
95 
96  // Modules
97 
98  spi_master_t spi;
99  pin_name_t chip_select;
100 
101 
102 } mic24055_t;
103 
107 typedef struct
108 {
109  // Communication gpio pins
110 
111  pin_name_t miso;
112  pin_name_t mosi;
113  pin_name_t sck;
114  pin_name_t cs;
115 
116  // Additional gpio pins
117 
118  pin_name_t an;
119  pin_name_t en;
120  //pin_name_t pwm;
121  pin_name_t int_pin;
122 
123  // static variable
124 
125  uint32_t spi_speed;
126  spi_master_mode_t spi_mode;
127  spi_master_chip_select_polarity_t cs_polarity;
128 
130  // End types group
132 
133 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
134 
139 #ifdef __cplusplus
140 extern "C"{
141 #endif
142 
151 void mic24055_cfg_setup ( mic24055_cfg_t *cfg );
152 
161 
174 (
175  mic24055_t *ctx,
176  uint8_t *wr_buf,
177  uint16_t wr_len,
178  uint8_t *rd_buf,
179  uint16_t rd_len
180 );
181 
190 void mic24055_dac_output ( mic24055_t *ctx, uint16_t value_dac );
191 
200 void mic24055_set_vout ( mic24055_t *ctx, uint16_t voltage );
201 
202 #ifdef __cplusplus
203 }
204 #endif
205 #endif // _MIC24055_H_
206  // End public_function group
209 
210 // ------------------------------------------------------------------------- END
mic24055_t::an
digital_in_t an
Definition: mic24055.h:94
mic24055_generic_transfer
void mic24055_generic_transfer(mic24055_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
mic24055_cfg_t
Click configuration structure definition.
Definition: mic24055.h:107
mic24055_t::cs
digital_out_t cs
Definition: mic24055.h:90
mic24055_cfg_t::spi_speed
uint32_t spi_speed
Definition: mic24055.h:125
mic24055_dac_output
void mic24055_dac_output(mic24055_t *ctx, uint16_t value_dac)
Generic transfer function.
mic24055_cfg_setup
void mic24055_cfg_setup(mic24055_cfg_t *cfg)
Config Object Initialization function.
mic24055_t::spi
spi_master_t spi
Definition: mic24055.h:98
mic24055_set_vout
void mic24055_set_vout(mic24055_t *ctx, uint16_t voltage)
Set output voltage.
MIC24055_RETVAL
#define MIC24055_RETVAL
Definition: mic24055.h:68
mic24055_t::int_pin
digital_out_t int_pin
Definition: mic24055.h:89
mic24055_init
MIC24055_RETVAL mic24055_init(mic24055_t *ctx, mic24055_cfg_t *cfg)
Initialization function.
mic24055_t
Click ctx object definition.
Definition: mic24055.h:84
mic24055_t::chip_select
pin_name_t chip_select
Definition: mic24055.h:99
mic24055_cfg_t::cs
pin_name_t cs
Definition: mic24055.h:114
mic24055_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: mic24055.h:127
mic24055_cfg_t::miso
pin_name_t miso
Definition: mic24055.h:111
mic24055_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: mic24055.h:126
mic24055_cfg_t::int_pin
pin_name_t int_pin
Definition: mic24055.h:121
mic24055_cfg_t::mosi
pin_name_t mosi
Definition: mic24055.h:112
mic24055_cfg_t::sck
pin_name_t sck
Definition: mic24055.h:113
mic24055_cfg_t::en
pin_name_t en
Definition: mic24055.h:119
mic24055_t::en
digital_out_t en
Definition: mic24055.h:88
mic24055_cfg_t::an
pin_name_t an
Definition: mic24055.h:118