spiisolator8  2.1.0.0
spiisolator8.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 SPIISOLATOR8_H
29 #define SPIISOLATOR8_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 
59 #define SPIISOLATOR8_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
60 #define SPIISOLATOR8_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
61  // spiisolator8_set
63 
78 #define SPIISOLATOR8_MAP_MIKROBUS( cfg, mikrobus ) \
79  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
80  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
81  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
82  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
83  cfg.enc = MIKROBUS( mikrobus, MIKROBUS_AN ); \
84  cfg.enp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
85  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
86  // spiisolator8_map // spiisolator8
89 
94 typedef struct
95 {
96  // Output pins
97  digital_out_t enc;
98  digital_out_t enp;
100  // Input pins
101  digital_in_t flt;
103  // Modules
104  spi_master_t spi;
106  pin_name_t chip_select;
109 
114 typedef struct
115 {
116  // Communication gpio pins
117  pin_name_t miso;
118  pin_name_t mosi;
119  pin_name_t sck;
120  pin_name_t cs;
122  // Additional gpio pins
123  pin_name_t enc;
124  pin_name_t enp;
125  pin_name_t flt;
127  // static variable
128  uint32_t spi_speed;
129  spi_master_mode_t spi_mode;
130  spi_master_chip_select_polarity_t cs_polarity;
133 
138 typedef enum
139 {
141  SPIISOLATOR8_ERROR = -1
142 
144 
161 
176 
188 
201 
214 
227 
240 
255 
269 err_t spiisolator8_write ( spiisolator8_t *ctx, uint8_t *data_in, uint8_t len );
270 
284 err_t spiisolator8_read ( spiisolator8_t *ctx, uint8_t *data_out, uint8_t len_out );
285 
301 err_t spiisolator8_write_then_read ( spiisolator8_t *ctx, uint8_t *data_in, uint8_t len_in,
302  uint8_t *data_out, uint8_t len_out );
303 
318 err_t spiisolator8_transfer ( spiisolator8_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len );
319 
320 #ifdef __cplusplus
321 }
322 #endif
323 #endif // SPIISOLATOR8_H
324  // spiisolator8
326 
327 // ------------------------------------------------------------------------ END
spiisolator8_return_value_t
spiisolator8_return_value_t
SPI Isolator 8 Click return value data.
Definition: spiisolator8.h:139
spiisolator8_default_cfg
void spiisolator8_default_cfg(spiisolator8_t *ctx)
SPI Isolator 8 default configuration function.
spiisolator8_init
err_t spiisolator8_init(spiisolator8_t *ctx, spiisolator8_cfg_t *cfg)
SPI Isolator 8 initialization function.
spiisolator8_cfg_t
SPI Isolator 8 Click configuration object.
Definition: spiisolator8.h:115
spiisolator8_cfg_t::spi_speed
uint32_t spi_speed
Definition: spiisolator8.h:128
spi_specifics.h
This file contains SPI specific macros, functions, etc.
spiisolator8_transfer
err_t spiisolator8_transfer(spiisolator8_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len)
SPI Isolator 8 data transfer function.
spiisolator8_cfg_t::flt
pin_name_t flt
Definition: spiisolator8.h:125
spiisolator8_write_then_read
err_t spiisolator8_write_then_read(spiisolator8_t *ctx, uint8_t *data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out)
SPI Isolator 8 write then read function.
spiisolator8_cfg_t::miso
pin_name_t miso
Definition: spiisolator8.h:117
spiisolator8_t
SPI Isolator 8 Click context object.
Definition: spiisolator8.h:95
spiisolator8_enp_enable
void spiisolator8_enp_enable(spiisolator8_t *ctx)
SPI Isolator 8 enable side 2 function.
spiisolator8_cfg_t::enc
pin_name_t enc
Definition: spiisolator8.h:123
spiisolator8_get_fault
uint8_t spiisolator8_get_fault(spiisolator8_t *ctx)
SPI Isolator 8 get fault function.
spiisolator8_cfg_t::enp
pin_name_t enp
Definition: spiisolator8.h:124
spiisolator8_cfg_t::mosi
pin_name_t mosi
Definition: spiisolator8.h:118
spiisolator8_t::flt
digital_in_t flt
Definition: spiisolator8.h:101
spiisolator8_cfg_t::sck
pin_name_t sck
Definition: spiisolator8.h:119
spiisolator8_enc_enable
void spiisolator8_enc_enable(spiisolator8_t *ctx)
SPI Isolator 8 enable side 1 function.
spiisolator8_enp_disable
void spiisolator8_enp_disable(spiisolator8_t *ctx)
SPI Isolator 8 disable side 2 function.
spiisolator8_t::enp
digital_out_t enp
Definition: spiisolator8.h:98
spiisolator8_cfg_setup
void spiisolator8_cfg_setup(spiisolator8_cfg_t *cfg)
SPI Isolator 8 configuration object setup function.
spiisolator8_t::chip_select
pin_name_t chip_select
Definition: spiisolator8.h:106
spiisolator8_read
err_t spiisolator8_read(spiisolator8_t *ctx, uint8_t *data_out, uint8_t len_out)
SPI Isolator 8 data reading function.
SPIISOLATOR8_OK
@ SPIISOLATOR8_OK
Definition: spiisolator8.h:140
spiisolator8_cfg_t::cs
pin_name_t cs
Definition: spiisolator8.h:120
spiisolator8_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: spiisolator8.h:129
spiisolator8_t::enc
digital_out_t enc
Definition: spiisolator8.h:97
spiisolator8_enc_disable
void spiisolator8_enc_disable(spiisolator8_t *ctx)
SPI Isolator 8 disable side 1 function.
spiisolator8_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: spiisolator8.h:130
spiisolator8_t::spi
spi_master_t spi
Definition: spiisolator8.h:104
spiisolator8_write
err_t spiisolator8_write(spiisolator8_t *ctx, uint8_t *data_in, uint8_t len)
SPI Isolator 8 data writing function.
SPIISOLATOR8_ERROR
@ SPIISOLATOR8_ERROR
Definition: spiisolator8.h:141