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 
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 // -------------------------------------------------------------- PUBLIC MACROS
67 #define GSR_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
69  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
70  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
71  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
72 
78 #define GSR_RETVAL uint8_t
79 
80 #define GSR_OK 0x00
81 #define GSR_INIT_ERROR 0xFF
82  // End group macro
85 // --------------------------------------------------------------- PUBLIC TYPES
94 typedef struct
95 {
96  digital_out_t cs;
97  // Modules
98 
99  spi_master_t spi;
100  pin_name_t chip_select;
101 
102 } gsr_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  // static variable
117 
118  uint32_t spi_speed;
119  spi_master_mode_t spi_mode;
120  spi_master_chip_select_polarity_t cs_polarity;
121 
122 } gsr_cfg_t;
123  // End types group
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
131 #ifdef __cplusplus
132 extern "C"{
133 #endif
134 
143 void gsr_cfg_setup ( gsr_cfg_t *cfg );
144 
153 
163 (
164  gsr_t *ctx,
165  uint8_t *wr_buf,
166  uint16_t wr_len,
167  uint8_t *rd_buf,
168  uint16_t rd_len
169 );
170 
178 uint16_t gsr_read_value ( gsr_t *ctx );
179 
180 #ifdef __cplusplus
181 }
182 #endif
183 #endif // _GSR_H_
184  // End public_function group
187 
188 // ------------------------------------------------------------------------- END
gsr_t
Click ctx object definition.
Definition: gsr.h:95
gsr_t::spi
spi_master_t spi
Definition: gsr.h:99
gsr_cfg_t::spi_speed
uint32_t spi_speed
Definition: gsr.h:118
gsr_cfg_t::cs
pin_name_t cs
Definition: gsr.h:114
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:120
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:111
gsr_cfg_t::sck
pin_name_t sck
Definition: gsr.h:113
gsr_cfg_t
Click configuration structure definition.
Definition: gsr.h:108
gsr_t::cs
digital_out_t cs
Definition: gsr.h:96
gsr_cfg_t::mosi
pin_name_t mosi
Definition: gsr.h:112
GSR_RETVAL
#define GSR_RETVAL
Definition: gsr.h:78
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:100
gsr_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gsr.h:119