spiisolator5  2.1.0.0
spiisolator5.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 SPIISOLATOR5_H
29 #define SPIISOLATOR5_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 
64 #define SPIISOLATOR5_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
65 #define SPIISOLATOR5_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
66  // spiisolator5_set
68 
83 #define SPIISOLATOR5_MAP_MIKROBUS( cfg, mikrobus ) \
84  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
85  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
86  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
87  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
88  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
89  // spiisolator5_map // spiisolator5
92 
97 typedef struct
98 {
99  // Output pins
100  digital_out_t en;
102  // Modules
103  spi_master_t spi;
105  pin_name_t chip_select;
108 
113 typedef struct
114 {
115  // Communication gpio pins
116  pin_name_t miso;
117  pin_name_t mosi;
118  pin_name_t sck;
119  pin_name_t cs;
121  // Additional gpio pins
122  pin_name_t en;
124  // static variable
125  uint32_t spi_speed;
126  spi_master_mode_t spi_mode;
127  spi_master_chip_select_polarity_t cs_polarity;
130 
135 typedef enum
136 {
138  SPIISOLATOR5_ERROR = -1
139 
141 
158 
173 
185 
197 
211 err_t spiisolator5_write ( spiisolator5_t *ctx, uint8_t *data_in, uint8_t len );
212 
226 err_t spiisolator5_read ( spiisolator5_t *ctx, uint8_t *data_out, uint8_t len_out );
227 
243 err_t spiisolator5_write_then_read ( spiisolator5_t *ctx, uint8_t *data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out );
244 
259 err_t spiisolator5_transfer ( spiisolator5_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len );
260 
261 #ifdef __cplusplus
262 }
263 #endif
264 #endif // SPIISOLATOR5_H
265  // spiisolator5
267 
268 // ------------------------------------------------------------------------ END
spiisolator5_cfg_setup
void spiisolator5_cfg_setup(spiisolator5_cfg_t *cfg)
SPI Isolator 5 configuration object setup function.
spiisolator5_cfg_t
SPI Isolator 5 Click configuration object.
Definition: spiisolator5.h:114
spiisolator5_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: spiisolator5.h:126
SPIISOLATOR5_ERROR
@ SPIISOLATOR5_ERROR
Definition: spiisolator5.h:138
spi_specifics.h
This file contains SPI specific macros, functions, etc.
spiisolator5_transfer
err_t spiisolator5_transfer(spiisolator5_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len)
SPI Isolator 5 transfer function.
spiisolator5_t::spi
spi_master_t spi
Definition: spiisolator5.h:103
spiisolator5_write_then_read
err_t spiisolator5_write_then_read(spiisolator5_t *ctx, uint8_t *data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out)
SPI Isolator 5 write then read function.
spiisolator5_cfg_t::spi_speed
uint32_t spi_speed
Definition: spiisolator5.h:125
spiisolator5_t
SPI Isolator 5 Click context object.
Definition: spiisolator5.h:98
spiisolator5_t::chip_select
pin_name_t chip_select
Definition: spiisolator5.h:105
spiisolator5_return_value_t
spiisolator5_return_value_t
SPI Isolator 5 Click return value data.
Definition: spiisolator5.h:136
spiisolator5_cfg_t::miso
pin_name_t miso
Definition: spiisolator5.h:116
spiisolator5_read
err_t spiisolator5_read(spiisolator5_t *ctx, uint8_t *data_out, uint8_t len_out)
SPI Isolator 5 data reading function.
SPIISOLATOR5_OK
@ SPIISOLATOR5_OK
Definition: spiisolator5.h:137
spiisolator5_cfg_t::cs
pin_name_t cs
Definition: spiisolator5.h:119
spiisolator5_cfg_t::sck
pin_name_t sck
Definition: spiisolator5.h:118
spiisolator5_enable
void spiisolator5_enable(spiisolator5_t *ctx)
SPI Isolator 5 enable function.
spiisolator5_write
err_t spiisolator5_write(spiisolator5_t *ctx, uint8_t *data_in, uint8_t len)
SPI Isolator 5 data writing function.
spiisolator5_init
err_t spiisolator5_init(spiisolator5_t *ctx, spiisolator5_cfg_t *cfg)
SPI Isolator 5 initialization function.
spiisolator5_t::en
digital_out_t en
Definition: spiisolator5.h:100
spiisolator5_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: spiisolator5.h:127
spiisolator5_cfg_t::en
pin_name_t en
Definition: spiisolator5.h:122
spiisolator5_disable
void spiisolator5_disable(spiisolator5_t *ctx)
SPI Isolator 5 disable function.
spiisolator5_cfg_t::mosi
pin_name_t mosi
Definition: spiisolator5.h:117