gsr  2.0.0.0
gsr.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 GSR_H
36 #define GSR_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define GSR_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
68 
74 #define GSR_RETVAL uint8_t
75 
76 #define GSR_OK 0x00
77 #define GSR_INIT_ERROR 0xFF
78  // End group macro
81 // --------------------------------------------------------------- PUBLIC TYPES
90 typedef struct
91 {
92  digital_out_t cs;
93  // Modules
94 
95  spi_master_t spi;
96  pin_name_t chip_select;
97 
98 } gsr_t;
99 
103 typedef struct
104 {
105  // Communication gpio pins
106 
107  pin_name_t miso;
108  pin_name_t mosi;
109  pin_name_t sck;
110  pin_name_t cs;
111 
112  // static variable
113 
114  uint32_t spi_speed;
115  spi_master_mode_t spi_mode;
116  spi_master_chip_select_polarity_t cs_polarity;
117 
118 } gsr_cfg_t;
119  // End types group
121 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
122 
127 #ifdef __cplusplus
128 extern "C"{
129 #endif
130 
139 void gsr_cfg_setup ( gsr_cfg_t *cfg );
140 
149 
159 (
160  gsr_t *ctx,
161  uint8_t *wr_buf,
162  uint16_t wr_len,
163  uint8_t *rd_buf,
164  uint16_t rd_len
165 );
166 
174 uint16_t gsr_read_value ( gsr_t *ctx );
175 
176 #ifdef __cplusplus
177 }
178 #endif
179 #endif // _GSR_H_
180  // End public_function group
183 
184 // ------------------------------------------------------------------------- END
gsr_t
Click ctx object definition.
Definition: gsr.h:91
gsr_t::spi
spi_master_t spi
Definition: gsr.h:95
gsr_cfg_t::spi_speed
uint32_t spi_speed
Definition: gsr.h:114
gsr_cfg_t::cs
pin_name_t cs
Definition: gsr.h:110
gsr_init
GSR_RETVAL gsr_init(gsr_t *ctx, gsr_cfg_t *cfg)
Initialization function.
gsr_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: gsr.h:116
gsr_cfg_setup
void gsr_cfg_setup(gsr_cfg_t *cfg)
Config Object Initialization function.
gsr_cfg_t::miso
pin_name_t miso
Definition: gsr.h:107
gsr_cfg_t::sck
pin_name_t sck
Definition: gsr.h:109
gsr_cfg_t
Click configuration structure definition.
Definition: gsr.h:104
gsr_t::cs
digital_out_t cs
Definition: gsr.h:92
gsr_cfg_t::mosi
pin_name_t mosi
Definition: gsr.h:108
GSR_RETVAL
#define GSR_RETVAL
Definition: gsr.h:74
gsr_read_value
uint16_t gsr_read_value(gsr_t *ctx)
Read Analog Value.
gsr_generic_transfer
void gsr_generic_transfer(gsr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
gsr_t::chip_select
pin_name_t chip_select
Definition: gsr.h:96
gsr_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gsr.h:115