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 0x06000000
65 #define SPIISOLATOR2_EEPROM5_CMD_WRDI 0x04000000
66 #define SPIISOLATOR2_EEPROM5_CMD_RDSR 0x05000000
67 #define SPIISOLATOR2_EEPROM5_CMD_WRSR 0x01000000
68 #define SPIISOLATOR2_EEPROM5_CMD_READ 0x03000000
69 #define SPIISOLATOR2_EEPROM5_CMD_WRITE 0x02000000
70 #define SPIISOLATOR2_EEPROM5_CMD_READ_ID 0x83000000
71 #define SPIISOLATOR2_EEPROM5_CMD_WRITE_ID 0x82000000
72 #define SPIISOLATOR2_EEPROM5_CMD_READ_LOCK_STATUS 0x83000000
73 #define SPIISOLATOR2_EEPROM5_CMD_LOCK_ID 0x82000000
74 #define SPIISOLATOR2_EEPROM5_CMD_WRITE_ENABLE 0x06
75 
76 #define SPIISOLATOR2_OUT_DISABLE 0x00
77 #define SPIISOLATOR2_OUT_ENABLE 0x01
78 
79 #define SPIISOLATOR2_DUMMY 0x00
80  // spiisolator2_set
82 
97 #define SPIISOLATOR2_MAP_MIKROBUS( cfg, mikrobus ) \
98  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
99  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
100  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
101  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
102  cfg.en1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
103 
104  // spiisolator2_map // spiisolator2
106 
111 typedef struct
112 {
113  // Output pins
114 
115  digital_out_t en1;
117  // Modules
118 
119  spi_master_t spi;
121  pin_name_t chip_select;
124 
129 typedef struct
130 {
131  // Communication gpio pins
132 
133  pin_name_t miso;
134  pin_name_t mosi;
135  pin_name_t sck;
136  pin_name_t cs;
138  // Additional gpio pins
139 
140  pin_name_t en1;
142  // static variable
143 
144  uint32_t spi_speed;
145  spi_master_mode_t spi_mode;
146  spi_master_chip_select_polarity_t cs_polarity;
149 
154 typedef enum
155 {
157  SPIISOLATOR2_ERROR = -1
158 
160 
177 
193 
209 err_t spiisolator2_generic_write ( spiisolator2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
210 
226 err_t spiisolator2_generic_read ( spiisolator2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
227 
238 void spiisolator2_output_enable( spiisolator2_t *ctx, uint8_t en_out );
239 
250 void spiisolator2_set_cmd ( spiisolator2_t *ctx, uint8_t cmd );
251 
264 void spiisolator2_write_byte ( spiisolator2_t *ctx, uint8_t reg, uint8_t tx_data );
265 
277 uint8_t spiisolator2_read_byte ( spiisolator2_t *ctx, uint8_t reg );
278 
292 void spiisolator2_burst_write ( spiisolator2_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes );
293 
307 void spiisolator2_burst_read ( spiisolator2_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes );
308 
323 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 );
324 
339 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 );
340 
341 #ifdef __cplusplus
342 }
343 #endif
344 #endif // SPIISOLATOR2_H
345  // spiisolator2
347 
348 // ------------------------------------------------------------------------ END
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:128
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
Definition: spiisolator2.h:155
SPIISOLATOR2_ERROR
Definition: spiisolator2.h:156
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_return_value_t
spiisolator2_return_value_t
SPI Isolator 2 Click return value data.
Definition: spiisolator2.h:153
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:110
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_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_output_enable
void spiisolator2_output_enable(spiisolator2_t *ctx, uint8_t en_out)
SPI Isolator 2 output enable function.
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.