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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define SERIALIZER_STATUS_OVERTEMPERATURE 0x01
61 #define SERIALIZER_STATUS_UNDERVOLTAGE 0x02
62 
71 #define SERIALIZER_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
72 #define SERIALIZER_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
73  // serializer_set
75 
90 #define SERIALIZER_MAP_MIKROBUS( cfg, mikrobus ) \
91  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
92  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
93  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
94  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
95  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
96  // serializer_map // serializer
99 
104 typedef struct
105 {
106  // Input pins
107  digital_in_t flt;
109  // Modules
110  spi_master_t spi;
112  pin_name_t chip_select;
114 } serializer_t;
115 
120 typedef struct
121 {
122  // Communication gpio pins
123  pin_name_t miso;
124  pin_name_t mosi;
125  pin_name_t sck;
126  pin_name_t cs;
128  // Additional gpio pins
129  pin_name_t flt;
131  // static variable
132  uint32_t spi_speed;
133  spi_master_mode_t spi_mode;
134  spi_master_chip_select_polarity_t cs_polarity;
137 
142 typedef enum
143 {
145  SERIALIZER_ERROR = -1
146 
148 
165 
181 
191 
205 err_t serializer_read_input ( serializer_t *ctx, uint8_t *data_out );
206 
207 #ifdef __cplusplus
208 }
209 #endif
210 #endif // SERIALIZER_H
211  // serializer
213 
214 // ------------------------------------------------------------------------ END
serializer_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: serializer.h:133
serializer_return_value_t
serializer_return_value_t
Serializer Click return value data.
Definition: serializer.h:143
serializer_t::chip_select
pin_name_t chip_select
Definition: serializer.h:112
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:145
serializer_cfg_t
Serializer Click configuration object.
Definition: serializer.h:121
serializer_cfg_t::miso
pin_name_t miso
Definition: serializer.h:123
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:125
serializer_cfg_t::flt
pin_name_t flt
Definition: serializer.h:129
serializer_t::flt
digital_in_t flt
Definition: serializer.h:107
serializer_t::spi
spi_master_t spi
Definition: serializer.h:110
serializer_t
Serializer Click context object.
Definition: serializer.h:105
serializer_cfg_t::spi_speed
uint32_t spi_speed
Definition: serializer.h:132
serializer_cfg_t::cs
pin_name_t cs
Definition: serializer.h:126
serializer_cfg_t::mosi
pin_name_t mosi
Definition: serializer.h:124
SERIALIZER_OK
@ SERIALIZER_OK
Definition: serializer.h:144
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:134