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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 
39 
40 
62 #define SPIISOLATOR3_PIN_STATE_LOW 0
63 #define SPIISOLATOR3_PIN_STATE_HIGH 1
64  // spiisolator3_set
66 
81 #define SPIISOLATOR3_MAP_MIKROBUS( cfg, mikrobus ) \
82  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
83  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
84  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
85  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
86  cfg.saa = MIKROBUS( mikrobus, MIKROBUS_AN ); \
87  cfg.oen = MIKROBUS( mikrobus, MIKROBUS_RST ); \
88  cfg.aux = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
89  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
90  // spiisolator3_map // spiisolator3
93 
98 typedef struct
99 {
100  // Output pins
101 
102  digital_out_t saa;
103  digital_out_t oen;
104  digital_out_t aux;
106  // Input pins
107 
108  digital_in_t flt;
110  // Modules
111 
112  spi_master_t spi;
114  pin_name_t chip_select;
117 
122 typedef struct
123 {
124  // Communication gpio pins
125 
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 
133  pin_name_t saa;
134  pin_name_t oen;
135  pin_name_t aux;
136  pin_name_t flt;
138  // static variable
139 
140  uint32_t spi_speed;
141  spi_master_mode_t spi_mode;
142  spi_master_chip_select_polarity_t cs_polarity;
145 
150 typedef enum
151 {
153  SPIISOLATOR3_ERROR = -1
154 
156 
173 
189 
204 
220 err_t spiisolator3_generic_write ( spiisolator3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
221 
237 err_t spiisolator3_generic_read ( spiisolator3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
238 
250 void spiisolator3_set_side_a_active ( spiisolator3_t *ctx, uint8_t saa_state );
251 
263 void spiisolator3_set_sdo_enable ( spiisolator3_t *ctx, uint8_t sdo_state );
264 
276 void spiisolator3_set_aux ( spiisolator3_t *ctx, uint8_t aux_state );
277 
290 
291 #ifdef __cplusplus
292 }
293 #endif
294 #endif // SPIISOLATOR3_H
295  // spiisolator3
297 
298 // ------------------------------------------------------------------------ END
spiisolator3_t::aux
digital_out_t aux
Definition: spiisolator3.h:104
spiisolator3_t
SPI Isolator 3 Click context object.
Definition: spiisolator3.h:99
spiisolator3_t::spi
spi_master_t spi
Definition: spiisolator3.h:112
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:151
spiisolator3_cfg_t::mosi
pin_name_t mosi
Definition: spiisolator3.h:127
spiisolator3_cfg_t::oen
pin_name_t oen
Definition: spiisolator3.h:134
spiisolator3_t::oen
digital_out_t oen
Definition: spiisolator3.h:103
spiisolator3_cfg_t::aux
pin_name_t aux
Definition: spiisolator3.h:135
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:142
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:123
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:136
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:114
spiisolator3_t::flt
digital_in_t flt
Definition: spiisolator3.h:108
spiisolator3_cfg_t::cs
pin_name_t cs
Definition: spiisolator3.h:129
spiisolator3_cfg_t::miso
pin_name_t miso
Definition: spiisolator3.h:126
spiisolator3_cfg_t::saa
pin_name_t saa
Definition: spiisolator3.h:133
SPIISOLATOR3_OK
@ SPIISOLATOR3_OK
Definition: spiisolator3.h:152
spiisolator3_cfg_t::sck
pin_name_t sck
Definition: spiisolator3.h:128
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:141
spiisolator3_cfg_t::spi_speed
uint32_t spi_speed
Definition: spiisolator3.h:140
spiisolator3_t::saa
digital_out_t saa
Definition: spiisolator3.h:102
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:153