spiisolator2  2.0.0.0
spiisolator2.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 SPIISOLATOR2_H
29 #define SPIISOLATOR2_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 
64 #define SPIISOLATOR2_EEPROM5_CMD_WREN 0x06
65 #define SPIISOLATOR2_EEPROM5_CMD_WRDI 0x04
66 #define SPIISOLATOR2_EEPROM5_CMD_RDSR 0x05
67 #define SPIISOLATOR2_EEPROM5_CMD_WRSR 0x01
68 #define SPIISOLATOR2_EEPROM5_CMD_READ 0x03
69 #define SPIISOLATOR2_EEPROM5_CMD_WRITE 0x02
70 #define SPIISOLATOR2_EEPROM5_CMD_READ_ID 0x83
71 #define SPIISOLATOR2_EEPROM5_CMD_WRITE_ID 0x82
72 #define SPIISOLATOR2_EEPROM5_CMD_READ_LOCK_STATUS 0x83
73 #define SPIISOLATOR2_EEPROM5_CMD_LOCK_ID 0x82
74 
75 #define SPIISOLATOR2_OUT_DISABLE 0x00
76 #define SPIISOLATOR2_OUT_ENABLE 0x01
77 
78 #define SPIISOLATOR2_DUMMY 0x00
79  // spiisolator2_set
81 
96 #define SPIISOLATOR2_MAP_MIKROBUS( cfg, mikrobus ) \
97  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
98  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
99  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
100  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
101  cfg.en1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
102 
103  // spiisolator2_map // spiisolator2
105 
110 typedef struct
111 {
112  // Output pins
113  digital_out_t en1;
115  // Modules
116  spi_master_t spi;
118  pin_name_t chip_select;
121 
126 typedef struct
127 {
128  // Communication gpio pins
129  pin_name_t miso;
130  pin_name_t mosi;
131  pin_name_t sck;
132  pin_name_t cs;
134  // Additional gpio pins
135  pin_name_t en1;
137  // static variable
138  uint32_t spi_speed;
139  spi_master_mode_t spi_mode;
140  spi_master_chip_select_polarity_t cs_polarity;
143 
148 typedef enum
149 {
151  SPIISOLATOR2_ERROR = -1
152 
154 
171 
186 
201 err_t spiisolator2_generic_write ( spiisolator2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
202 
217 err_t spiisolator2_generic_read ( spiisolator2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
218 
229 void spiisolator2_output_enable( spiisolator2_t *ctx, uint8_t en_out );
230 
241 void spiisolator2_set_cmd ( spiisolator2_t *ctx, uint8_t cmd );
242 
255 void spiisolator2_write_byte ( spiisolator2_t *ctx, uint8_t reg, uint8_t tx_data );
256 
268 uint8_t spiisolator2_read_byte ( spiisolator2_t *ctx, uint8_t reg );
269 
283 void spiisolator2_burst_write ( spiisolator2_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes );
284 
298 void spiisolator2_burst_read ( spiisolator2_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes );
299 
314 void spiisolator2_multi_write ( spiisolator2_t *ctx, uint32_t addr, uint8_t addr_n_bytes,
315  uint8_t *p_tx_data, uint8_t tx_data_n_bytes );
316 
331 void spiisolator2_multi_read ( spiisolator2_t *ctx, uint32_t addr, uint8_t addr_n_bytes,
332  uint8_t *p_rx_data, uint8_t tx_data_n_bytes );
333 
334 #ifdef __cplusplus
335 }
336 #endif
337 #endif // SPIISOLATOR2_H
338  // spiisolator2
340 
341 // ------------------------------------------------------------------------ END
spiisolator2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: spiisolator2.h:140
spiisolator2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: spiisolator2.h:139
spiisolator2_init
err_t spiisolator2_init(spiisolator2_t *ctx, spiisolator2_cfg_t *cfg)
SPI Isolator 2 initialization function.
spiisolator2_burst_write
void spiisolator2_burst_write(spiisolator2_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes)
SPI Isolator 2 burst write function.
spiisolator2_cfg_t
SPI Isolator 2 Click configuration object.
Definition: spiisolator2.h:127
spiisolator2_burst_read
void spiisolator2_burst_read(spiisolator2_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes)
SPI Isolator 2 burst read function.
SPIISOLATOR2_OK
@ SPIISOLATOR2_OK
Definition: spiisolator2.h:150
SPIISOLATOR2_ERROR
@ SPIISOLATOR2_ERROR
Definition: spiisolator2.h:151
spiisolator2_multi_write
void spiisolator2_multi_write(spiisolator2_t *ctx, uint32_t addr, uint8_t addr_n_bytes, uint8_t *p_tx_data, uint8_t tx_data_n_bytes)
SPI Isolator 2 multi write function.
spiisolator2_set_cmd
void spiisolator2_set_cmd(spiisolator2_t *ctx, uint8_t cmd)
SPI Isolator 2 send command function.
spiisolator2_cfg_t::miso
pin_name_t miso
Definition: spiisolator2.h:129
spiisolator2_cfg_t::sck
pin_name_t sck
Definition: spiisolator2.h:131
spiisolator2_return_value_t
spiisolator2_return_value_t
SPI Isolator 2 Click return value data.
Definition: spiisolator2.h:149
spiisolator2_t::spi
spi_master_t spi
Definition: spiisolator2.h:116
spiisolator2_t::chip_select
pin_name_t chip_select
Definition: spiisolator2.h:118
spiisolator2_write_byte
void spiisolator2_write_byte(spiisolator2_t *ctx, uint8_t reg, uint8_t tx_data)
SPI Isolator 2 write the byte of data function.
spiisolator2_multi_read
void spiisolator2_multi_read(spiisolator2_t *ctx, uint32_t addr, uint8_t addr_n_bytes, uint8_t *p_rx_data, uint8_t tx_data_n_bytes)
SPI Isolator 2 multi read function.
spiisolator2_t
SPI Isolator 2 Click context object.
Definition: spiisolator2.h:111
spiisolator2_cfg_t::cs
pin_name_t cs
Definition: spiisolator2.h:132
spiisolator2_generic_read
err_t spiisolator2_generic_read(spiisolator2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
SPI Isolator 2 data reading function.
spiisolator2_cfg_t::mosi
pin_name_t mosi
Definition: spiisolator2.h:130
spiisolator2_read_byte
uint8_t spiisolator2_read_byte(spiisolator2_t *ctx, uint8_t reg)
SPI Isolator 2 read the byte of data function.
spiisolator2_cfg_setup
void spiisolator2_cfg_setup(spiisolator2_cfg_t *cfg)
SPI Isolator 2 configuration object setup function.
spiisolator2_t::en1
digital_out_t en1
Definition: spiisolator2.h:113
spiisolator2_output_enable
void spiisolator2_output_enable(spiisolator2_t *ctx, uint8_t en_out)
SPI Isolator 2 output enable function.
spiisolator2_cfg_t::spi_speed
uint32_t spi_speed
Definition: spiisolator2.h:138
spiisolator2_generic_write
err_t spiisolator2_generic_write(spiisolator2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
SPI Isolator 2 data writing function.
spiisolator2_cfg_t::en1
pin_name_t en1
Definition: spiisolator2.h:135