serializer  2.0.0.0
serializer.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef SERIALIZER_H
29 #define SERIALIZER_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_spi_master.h"
48 #include "spi_specifics.h"
49 
70 #define SERIALIZER_STATUS_OVERTEMPERATURE 0x01
71 #define SERIALIZER_STATUS_UNDERVOLTAGE 0x02
72 
81 #define SERIALIZER_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
82 #define SERIALIZER_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
83  // serializer_set
85 
100 #define SERIALIZER_MAP_MIKROBUS( cfg, mikrobus ) \
101  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
102  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
103  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
104  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
105  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
106  // serializer_map // serializer
109 
114 typedef struct
115 {
116  // Input pins
117  digital_in_t flt;
119  // Modules
120  spi_master_t spi;
122  pin_name_t chip_select;
124 } serializer_t;
125 
130 typedef struct
131 {
132  // Communication gpio pins
133  pin_name_t miso;
134  pin_name_t mosi;
135  pin_name_t sck;
136  pin_name_t cs;
138  // Additional gpio pins
139  pin_name_t flt;
141  // static variable
142  uint32_t spi_speed;
143  spi_master_mode_t spi_mode;
144  spi_master_chip_select_polarity_t cs_polarity;
147 
152 typedef enum
153 {
155  SERIALIZER_ERROR = -1
156 
158 
175 
191 
201 
215 err_t serializer_read_input ( serializer_t *ctx, uint8_t *data_out );
216 
217 #ifdef __cplusplus
218 }
219 #endif
220 #endif // SERIALIZER_H
221  // serializer
223 
224 // ------------------------------------------------------------------------ END
serializer_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: serializer.h:143
serializer_return_value_t
serializer_return_value_t
Serializer Click return value data.
Definition: serializer.h:153
serializer_t::chip_select
pin_name_t chip_select
Definition: serializer.h:122
serializer_cfg_setup
void serializer_cfg_setup(serializer_cfg_t *cfg)
Serializer configuration object setup function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
serializer_init
err_t serializer_init(serializer_t *ctx, serializer_cfg_t *cfg)
Serializer initialization function.
SERIALIZER_ERROR
@ SERIALIZER_ERROR
Definition: serializer.h:155
serializer_cfg_t
Serializer Click configuration object.
Definition: serializer.h:131
serializer_cfg_t::miso
pin_name_t miso
Definition: serializer.h:133
serializer_get_flt_pin
uint8_t serializer_get_flt_pin(serializer_t *ctx)
Serializer get FLT pin function.
serializer_cfg_t::sck
pin_name_t sck
Definition: serializer.h:135
serializer_cfg_t::flt
pin_name_t flt
Definition: serializer.h:139
serializer_t::flt
digital_in_t flt
Definition: serializer.h:117
serializer_t::spi
spi_master_t spi
Definition: serializer.h:120
serializer_t
Serializer Click context object.
Definition: serializer.h:115
serializer_cfg_t::spi_speed
uint32_t spi_speed
Definition: serializer.h:142
serializer_cfg_t::cs
pin_name_t cs
Definition: serializer.h:136
serializer_cfg_t::mosi
pin_name_t mosi
Definition: serializer.h:134
SERIALIZER_OK
@ SERIALIZER_OK
Definition: serializer.h:154
serializer_read_input
err_t serializer_read_input(serializer_t *ctx, uint8_t *data_out)
Serializer read input function.
serializer_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: serializer.h:144