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 "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 
74 #define SPIISOLATOR5_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
75 #define SPIISOLATOR5_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
76  // spiisolator5_set
78 
93 #define SPIISOLATOR5_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
95  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
96  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
97  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
98  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
99  // spiisolator5_map // spiisolator5
102 
107 typedef struct
108 {
109  // Output pins
110  digital_out_t en;
112  // Modules
113  spi_master_t spi;
115  pin_name_t chip_select;
118 
123 typedef struct
124 {
125  // Communication gpio pins
126  pin_name_t miso;
127  pin_name_t mosi;
128  pin_name_t sck;
129  pin_name_t cs;
131  // Additional gpio pins
132  pin_name_t en;
134  // static variable
135  uint32_t spi_speed;
136  spi_master_mode_t spi_mode;
137  spi_master_chip_select_polarity_t cs_polarity;
140 
145 typedef enum
146 {
148  SPIISOLATOR5_ERROR = -1
149 
151 
168 
183 
195 
207 
221 err_t spiisolator5_write ( spiisolator5_t *ctx, uint8_t *data_in, uint8_t len );
222 
236 err_t spiisolator5_read ( spiisolator5_t *ctx, uint8_t *data_out, uint8_t len_out );
237 
253 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 );
254 
269 err_t spiisolator5_transfer ( spiisolator5_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len );
270 
271 #ifdef __cplusplus
272 }
273 #endif
274 #endif // SPIISOLATOR5_H
275  // spiisolator5
277 
278 // ------------------------------------------------------------------------ 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:124
spiisolator5_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: spiisolator5.h:136
SPIISOLATOR5_ERROR
@ SPIISOLATOR5_ERROR
Definition: spiisolator5.h:148
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:113
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:135
spiisolator5_t
SPI Isolator 5 Click context object.
Definition: spiisolator5.h:108
spiisolator5_t::chip_select
pin_name_t chip_select
Definition: spiisolator5.h:115
spiisolator5_return_value_t
spiisolator5_return_value_t
SPI Isolator 5 Click return value data.
Definition: spiisolator5.h:146
spiisolator5_cfg_t::miso
pin_name_t miso
Definition: spiisolator5.h:126
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:147
spiisolator5_cfg_t::cs
pin_name_t cs
Definition: spiisolator5.h:129
spiisolator5_cfg_t::sck
pin_name_t sck
Definition: spiisolator5.h:128
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:110
spiisolator5_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: spiisolator5.h:137
spiisolator5_cfg_t::en
pin_name_t en
Definition: spiisolator5.h:132
spiisolator5_disable
void spiisolator5_disable(spiisolator5_t *ctx)
SPI Isolator 5 disable function.
spiisolator5_cfg_t::mosi
pin_name_t mosi
Definition: spiisolator5.h:127