slider  2.0.0.0
slider.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 SLIDER_H
36 #define SLIDER_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 SLIDER_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.oe = MIKROBUS( mikrobus, MIKROBUS_AN ); \
60  cfg.csl = MIKROBUS( mikrobus, MIKROBUS_RST )
61 
67 #define SLIDER_RETVAL uint8_t
68 
69 #define SLIDER_OK 0x00
70 #define SLIDER_INIT_ERROR 0xFF
71  // End group macro
74 // --------------------------------------------------------------- PUBLIC TYPES
83 typedef struct
84 {
85  // Output pins
86 
87  digital_out_t oe;
88  digital_out_t csl;
89  digital_in_t miso;
90  digital_out_t cs;
91 
92  // Modules
93 
94  spi_master_t spi;
95  pin_name_t chip_select;
96 
97 } slider_t;
98 
102 typedef struct
103 {
104  // Communication gpio pins
105 
106  pin_name_t miso;
107  pin_name_t mosi;
108  pin_name_t sck;
109  pin_name_t cs;
110 
111  // Additional gpio pins
112 
113  pin_name_t oe;
114  pin_name_t csl;
115 
116  // static variable
117 
118  uint32_t spi_speed;
119  uint8_t spi_mode;
120  spi_master_chip_select_polarity_t cs_polarity;
121 
122 } slider_cfg_t;
123  // End types group
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
131 #ifdef __cplusplus
132 extern "C"{
133 #endif
134 
144 
153 
162 
175 (
176  slider_t *ctx,
177  uint8_t *wr_buf,
178  uint16_t wr_len,
179  uint8_t *rd_buf,
180  uint16_t rd_len
181 );
182 
191 uint32_t slider_read_adc ( slider_t *ctx );
192 
203 
213 void slider_enable_led_output ( slider_t *ctx, uint8_t state );
214 
224 void slider_enable_output_laches ( slider_t *ctx, uint8_t state );
225 
235 uint32_t slider_write_output ( slider_t *ctx);
236 
237 
238 #ifdef __cplusplus
239 }
240 #endif
241 #endif // _SLIDER_H_
242  // End public_function group
245 
246 // ------------------------------------------------------------------------- END
slider_cfg_t::miso
pin_name_t miso
Definition: slider.h:106
slider_cfg_t
Click configuration structure definition.
Definition: slider.h:103
slider_cfg_t::mosi
pin_name_t mosi
Definition: slider.h:107
slider_t::cs
digital_out_t cs
Definition: slider.h:90
SLIDER_RETVAL
#define SLIDER_RETVAL
Definition: slider.h:67
slider_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: slider.h:120
slider_cfg_t::csl
pin_name_t csl
Definition: slider.h:114
slider_cfg_t::cs
pin_name_t cs
Definition: slider.h:109
slider_cfg_t::oe
pin_name_t oe
Definition: slider.h:113
slider_t::miso
digital_in_t miso
Definition: slider.h:89
slider_t::spi
spi_master_t spi
Definition: slider.h:94
slider_t::chip_select
pin_name_t chip_select
Definition: slider.h:95
slider_t::csl
digital_out_t csl
Definition: slider.h:88
slider_enable_led_output
void slider_enable_led_output(slider_t *ctx, uint8_t state)
Output enable function.
slider_cfg_setup
void slider_cfg_setup(slider_cfg_t *cfg)
Config Object Initialization function.
slider_t::oe
digital_out_t oe
Definition: slider.h:87
slider_read_adc
uint32_t slider_read_adc(slider_t *ctx)
ADC read function.
slider_init
SLIDER_RETVAL slider_init(slider_t *ctx, slider_cfg_t *cfg)
Initialization function.
slider_cfg_t::spi_speed
uint32_t spi_speed
Definition: slider.h:118
slider_t
Click ctx object definition.
Definition: slider.h:84
slider_default_cfg
void slider_default_cfg(slider_t *ctx)
Click Default Configuration function.
slider_cfg_t::sck
pin_name_t sck
Definition: slider.h:108
slider_cfg_t::spi_mode
uint8_t spi_mode
Definition: slider.h:119
slider_read_adc_and_ready
uint32_t slider_read_adc_and_ready(slider_t *ctx)
ADC and READY read function.
slider_enable_output_laches
void slider_enable_output_laches(slider_t *ctx, uint8_t state)
Output laches enable function.
slider_write_output
uint32_t slider_write_output(slider_t *ctx)
Output write function.
slider_generic_transfer
void slider_generic_transfer(slider_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.