spiisolator6  2.0.0.0
spiisolator6.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 SPIISOLATOR6_H
29 #define SPIISOLATOR6_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 SPIISOLATOR6_SPI_CLOCK_SPEED 100000
71 #define SPIISOLATOR6_SPI_MODE SPI_MASTER_MODE_0
72 #define SPIISOLATOR6_SPI_CS_POLARITY SPI_MASTER_CHIP_SELECT_POLARITY_ACTIVE_LOW
73 #define SPIISOLATOR6_SPI_DUMMY_BYTE 0x00
74 
83 #define SPIISOLATOR6_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
84 #define SPIISOLATOR6_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
85  // spiisolator6_set
87 
102 #define SPIISOLATOR6_MAP_MIKROBUS( cfg, mikrobus ) \
103  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
104  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
105  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
106  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
107  // spiisolator6_map // spiisolator6
110 
115 typedef struct
116 {
117  // Modules
118  spi_master_t spi;
120  pin_name_t chip_select;
123 
128 typedef struct
129 {
130  // Communication gpio pins
131  pin_name_t miso;
132  pin_name_t mosi;
133  pin_name_t sck;
134  pin_name_t cs;
136  // static variable
137  uint32_t spi_speed;
138  spi_master_mode_t spi_mode;
139  spi_master_chip_select_polarity_t cs_polarity;
142 
147 typedef enum
148 {
150  SPIISOLATOR6_ERROR = -1
151 
153 
170 
185 
198 err_t spiisolator6_generic_write ( spiisolator6_t *ctx, uint8_t *data_in, uint8_t in_len );
199 
214 err_t spiisolator6_generic_read ( spiisolator6_t *ctx, uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len );
215 
216 #ifdef __cplusplus
217 }
218 #endif
219 #endif // SPIISOLATOR6_H
220  // spiisolator6
222 
223 // ------------------------------------------------------------------------ END
spiisolator6_cfg_t::spi_speed
uint32_t spi_speed
Definition: spiisolator6.h:137
spiisolator6_t::chip_select
pin_name_t chip_select
Definition: spiisolator6.h:120
spiisolator6_cfg_t
SPI Isolator 6 Click configuration object.
Definition: spiisolator6.h:129
spiisolator6_cfg_t::cs
pin_name_t cs
Definition: spiisolator6.h:134
spiisolator6_generic_read
err_t spiisolator6_generic_read(spiisolator6_t *ctx, uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len)
SPI Isolator 6 data reading function.
spiisolator6_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: spiisolator6.h:139
spi_specifics.h
This file contains SPI specific macros, functions, etc.
spiisolator6_t
SPI Isolator 6 Click context object.
Definition: spiisolator6.h:116
spiisolator6_t::spi
spi_master_t spi
Definition: spiisolator6.h:118
spiisolator6_return_value_t
spiisolator6_return_value_t
SPI Isolator 6 Click return value data.
Definition: spiisolator6.h:148
spiisolator6_generic_write
err_t spiisolator6_generic_write(spiisolator6_t *ctx, uint8_t *data_in, uint8_t in_len)
SPI Isolator 6 data writing function.
spiisolator6_cfg_t::miso
pin_name_t miso
Definition: spiisolator6.h:131
spiisolator6_cfg_t::mosi
pin_name_t mosi
Definition: spiisolator6.h:132
SPIISOLATOR6_OK
@ SPIISOLATOR6_OK
Definition: spiisolator6.h:149
spiisolator6_init
err_t spiisolator6_init(spiisolator6_t *ctx, spiisolator6_cfg_t *cfg)
SPI Isolator 6 initialization function.
spiisolator6_cfg_t::sck
pin_name_t sck
Definition: spiisolator6.h:133
spiisolator6_cfg_setup
void spiisolator6_cfg_setup(spiisolator6_cfg_t *cfg)
SPI Isolator 6 configuration object setup function.
spiisolator6_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: spiisolator6.h:138
SPIISOLATOR6_ERROR
@ SPIISOLATOR6_ERROR
Definition: spiisolator6.h:150