spiisolator3  2.0.0.0
spiisolator3.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 SPIISOLATOR3_H
29 #define SPIISOLATOR3_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 
49 
50 
72 #define SPIISOLATOR3_PIN_STATE_LOW 0
73 #define SPIISOLATOR3_PIN_STATE_HIGH 1
74  // spiisolator3_set
76 
91 #define SPIISOLATOR3_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
93  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
94  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
95  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
96  cfg.saa = MIKROBUS( mikrobus, MIKROBUS_AN ); \
97  cfg.oen = MIKROBUS( mikrobus, MIKROBUS_RST ); \
98  cfg.aux = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
99  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
100  // spiisolator3_map // spiisolator3
103 
108 typedef struct
109 {
110  // Output pins
111 
112  digital_out_t saa;
113  digital_out_t oen;
114  digital_out_t aux;
116  // Input pins
117 
118  digital_in_t flt;
120  // Modules
121 
122  spi_master_t spi;
124  pin_name_t chip_select;
127 
132 typedef struct
133 {
134  // Communication gpio pins
135 
136  pin_name_t miso;
137  pin_name_t mosi;
138  pin_name_t sck;
139  pin_name_t cs;
141  // Additional gpio pins
142 
143  pin_name_t saa;
144  pin_name_t oen;
145  pin_name_t aux;
146  pin_name_t flt;
148  // static variable
149 
150  uint32_t spi_speed;
151  spi_master_mode_t spi_mode;
152  spi_master_chip_select_polarity_t cs_polarity;
155 
160 typedef enum
161 {
163  SPIISOLATOR3_ERROR = -1
164 
166 
183 
199 
214 
230 err_t spiisolator3_generic_write ( spiisolator3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
231 
247 err_t spiisolator3_generic_read ( spiisolator3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
248 
260 void spiisolator3_set_side_a_active ( spiisolator3_t *ctx, uint8_t saa_state );
261 
273 void spiisolator3_set_sdo_enable ( spiisolator3_t *ctx, uint8_t sdo_state );
274 
286 void spiisolator3_set_aux ( spiisolator3_t *ctx, uint8_t aux_state );
287 
300 
301 #ifdef __cplusplus
302 }
303 #endif
304 #endif // SPIISOLATOR3_H
305  // spiisolator3
307 
308 // ------------------------------------------------------------------------ END
spiisolator3_t::aux
digital_out_t aux
Definition: spiisolator3.h:114
spiisolator3_t
SPI Isolator 3 Click context object.
Definition: spiisolator3.h:109
spiisolator3_t::spi
spi_master_t spi
Definition: spiisolator3.h:122
spiisolator3_generic_write
err_t spiisolator3_generic_write(spiisolator3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
SPI Isolator 3 data writing function.
spiisolator3_return_value_t
spiisolator3_return_value_t
SPI Isolator 3 Click return value data.
Definition: spiisolator3.h:161
spiisolator3_cfg_t::mosi
pin_name_t mosi
Definition: spiisolator3.h:137
spiisolator3_cfg_t::oen
pin_name_t oen
Definition: spiisolator3.h:144
spiisolator3_t::oen
digital_out_t oen
Definition: spiisolator3.h:113
spiisolator3_cfg_t::aux
pin_name_t aux
Definition: spiisolator3.h:145
spiisolator3_generic_read
err_t spiisolator3_generic_read(spiisolator3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
SPI Isolator 3 data reading function.
spiisolator3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: spiisolator3.h:152
spiisolator3_set_sdo_enable
void spiisolator3_set_sdo_enable(spiisolator3_t *ctx, uint8_t sdo_state)
SPI Isolator 3 set SDO enable function.
spiisolator3_cfg_t
SPI Isolator 3 Click configuration object.
Definition: spiisolator3.h:133
spiisolator3_init
err_t spiisolator3_init(spiisolator3_t *ctx, spiisolator3_cfg_t *cfg)
SPI Isolator 3 initialization function.
spiisolator3_cfg_t::flt
pin_name_t flt
Definition: spiisolator3.h:146
spiisolator3_default_cfg
err_t spiisolator3_default_cfg(spiisolator3_t *ctx)
SPI Isolator 3 default configuration function.
spiisolator3_set_aux
void spiisolator3_set_aux(spiisolator3_t *ctx, uint8_t aux_state)
SPI Isolator 3 set AUX function.
spiisolator3_t::chip_select
pin_name_t chip_select
Definition: spiisolator3.h:124
spiisolator3_t::flt
digital_in_t flt
Definition: spiisolator3.h:118
spiisolator3_cfg_t::cs
pin_name_t cs
Definition: spiisolator3.h:139
spiisolator3_cfg_t::miso
pin_name_t miso
Definition: spiisolator3.h:136
spiisolator3_cfg_t::saa
pin_name_t saa
Definition: spiisolator3.h:143
SPIISOLATOR3_OK
@ SPIISOLATOR3_OK
Definition: spiisolator3.h:162
spiisolator3_cfg_t::sck
pin_name_t sck
Definition: spiisolator3.h:138
spiisolator3_set_side_a_active
void spiisolator3_set_side_a_active(spiisolator3_t *ctx, uint8_t saa_state)
SPI Isolator 3 set side A active function.
spiisolator3_cfg_setup
void spiisolator3_cfg_setup(spiisolator3_cfg_t *cfg)
SPI Isolator 3 configuration object setup function.
spiisolator3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: spiisolator3.h:151
spiisolator3_cfg_t::spi_speed
uint32_t spi_speed
Definition: spiisolator3.h:150
spiisolator3_t::saa
digital_out_t saa
Definition: spiisolator3.h:112
spiisolator3_get_fault
uint8_t spiisolator3_get_fault(spiisolator3_t *ctx)
SPI Isolator 3 get fault state function.
SPIISOLATOR3_ERROR
@ SPIISOLATOR3_ERROR
Definition: spiisolator3.h:163