i2ctospi  2.0.0.0
i2ctospi.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef I2CTOSPI_H
36 #define I2CTOSPI_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define I2CTOSPI_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
66  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
67  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
68 
74 #define I2CTOSPI_RETVAL uint8_t
75 
76 #define I2CTOSPI_OK 0x00
77 #define I2CTOSPI_INIT_ERROR 0xFF
78 
84 #define I2CTOSPI_I2C_SLAVE_ADDRESS_0 0x28
85 #define I2CTOSPI_I2C_SLAVE_ADDRESS_1 0x29
86 #define I2CTOSPI_I2C_SLAVE_ADDRESS_2 0x2A
87 #define I2CTOSPI_I2C_SLAVE_ADDRESS_3 0x2B
88 #define I2CTOSPI_I2C_SLAVE_ADDRESS_4 0x2C
89 #define I2CTOSPI_I2C_SLAVE_ADDRESS_5 0x2D
90 #define I2CTOSPI_I2C_SLAVE_ADDRESS_6 0x2E
91 #define I2CTOSPI_I2C_SLAVE_ADDRESS_7 0x2F
92 
98 #define I2CTOSPI_CONFIGURE_SPI 0xF0
99 #define I2CTOSPI_CLEAR_INTERRUPT 0xF1
100 #define I2CTOSPI_IDLE_MODE 0xF2
101 #define I2CTOSPI_GPIO_WRITE 0xF4
102 #define I2CTOSPI_GPIO_READ 0xF5
103 #define I2CTOSPI_GPIO_ENABLE 0xF6
104 #define I2CTOSPI_GPIO_CONFIGURATION 0xF7
105 
111 #define I2CTOSPI_CONFIGURE_SPI_ORDER_MSB_FIRST 0x00
112 #define I2CTOSPI_CONFIGURE_SPI_ORDER_LSB_FIRST 0x20
113 #define I2CTOSPI_CONFIGURE_SPI_MODE_SPICLK_LOW_LEADING_EDGE 0x00
114 #define I2CTOSPI_CONFIGURE_SPI_MODE_SPICLK_LOW_TRAILING_EDGE 0x04
115 #define I2CTOSPI_CONFIGURE_SPI_MODE_SPICLK_HIGH_LEADING_EDGE 0x08
116 #define I2CTOSPI_CONFIGURE_SPI_MODE_SPICLK_HIGH_TRAILING_EDGE 0x0C
117 #define I2CTOSPI_CONFIGURE_SPI_CLOCK_RATE_1843kHz 0x00
118 #define I2CTOSPI_CONFIGURE_SPI_CLOCK_RATE_461kHz 0x01
119 #define I2CTOSPI_CONFIGURE_SPI_CLOCK_RATE_115kHz 0x02
120 #define I2CTOSPI_CONFIGURE_SPI_CLOCK_RATE_58kHz 0x03
121 
127 #define I2CTOSPI_CONFIGURE_GPIO_WRITE_PORT_ENABLE_SS0 0x01
128 #define I2CTOSPI_CONFIGURE_GPIO_WRITE_PORT_ENABLE_SS1 0x02
129 #define I2CTOSPI_CONFIGURE_GPIO_WRITE_PORT_ENABLE_SS2 0x04
130 #define I2CTOSPI_CONFIGURE_GPIO_WRITE_PORT_ENABLE_SS3 0x08
131 
137 #define I2CTOSPI_CONFIGURE_GPIO_READ_PORT_ENABLE_SS0 0x01
138 #define I2CTOSPI_CONFIGURE_GPIO_READ_PORT_ENABLE_SS1 0x02
139 #define I2CTOSPI_CONFIGURE_GPIO_READ_PORT_ENABLE_SS2 0x04
140 #define I2CTOSPI_CONFIGURE_GPIO_READ_PORT_ENABLE_SS3 0x08
141 
147 #define I2CTOSPI_CONFIGURE_GPIO_BIDIRECTIONAL_PORT_ENABLE_SS0 0x01
148 #define I2CTOSPI_CONFIGURE_GPIO_BIDIRECTIONAL_PORT_ENABLE_SS1 0x02
149 #define I2CTOSPI_CONFIGURE_GPIO_BIDIRECTIONAL_PORT_ENABLE_SS2 0x04
150 #define I2CTOSPI_CONFIGURE_GPIO_BIDIRECTIONAL_PORT_ENABLE_SS3 0x08
151 
157 #define I2CTOSPI_CONFIGURE_GPIO_QUASI_BIDIRECTIONAL_SS0 0x00
158 #define I2CTOSPI_CONFIGURE_GPIO_PUSH_PULL_SS0 0x01
159 #define I2CTOSPI_CONFIGURE_GPIO_INPUT_ONLY_SS0 0x02
160 #define I2CTOSPI_CONFIGURE_GPIO_OPEN_DRAIN_SS0 0x03
161 #define I2CTOSPI_CONFIGURE_GPIO_QUASI_BIDIRECTIONAL_SS1 0x00
162 #define I2CTOSPI_CONFIGURE_GPIO_PUSH_PULL_SS1 0x04
163 #define I2CTOSPI_CONFIGURE_GPIO_INPUT_ONLY_SS1 0x08
164 #define I2CTOSPI_CONFIGURE_GPIO_OPEN_DRAIN_SS1 0x0C
165 #define I2CTOSPI_CONFIGURE_GPIO_QUASI_BIDIRECTIONAL_SS2 0x00
166 #define I2CTOSPI_CONFIGURE_GPIO_PUSH_PULL_SS2 0x10
167 #define I2CTOSPI_CONFIGURE_GPIO_INPUT_ONLY_SS2 0x20
168 #define I2CTOSPI_CONFIGURE_GPIO_OPEN_DRAIN_SS2 0x30
169 #define I2CTOSPI_CONFIGURE_GPIO_QUASI_BIDIRECTIONAL_SS3 0x00
170 #define I2CTOSPI_CONFIGURE_GPIO_PUSH_PULL_SS3 0x40
171 #define I2CTOSPI_CONFIGURE_GPIO_INPUT_ONLY_SS3 0x80
172 #define I2CTOSPI_CONFIGURE_GPIO_OPEN_DRAIN_SS3 0xC0
173 
174 #define I2CTOSPI_SLAVEDEVICE_SS0 0x01
175 #define I2CTOSPI_SLAVEDEVICE_SS1 0x02
176 #define I2CTOSPI_SLAVEDEVICE_SS2 0x04
177 #define I2CTOSPI_SLAVEDEVICE_SS3 0x08
178 
179 #define I2CTOSPI_RTC5_COMMAND_WRITE 0x12
180 #define I2CTOSPI_RTC5_COMMAND_READ 0x13
181 
182 #define I2CTOSPI_RTC5_REG_TIME_HUN_OF_SEC 0x00
183 #define I2CTOSPI_RTC5_REG_TIME_SEC 0x01
184 #define I2CTOSPI_RTC5_REG_TIME_MIN 0x02
185 #define I2CTOSPI_RTC5_REG_TIME_HOUR 0x03
186 #define I2CTOSPI_RTC5_REG_TIME_DAY_OF_THE_WEEK 0x04
187 #define I2CTOSPI_RTC5_REG_TIME_DATE_DAY 0x05
188 #define I2CTOSPI_RTC5_REG_TIME_DATE_MONTH 0x06
189 #define I2CTOSPI_RTC5_REG_TIME_DATE_YEAR 0x07
190 #define I2CTOSPI_RTC5_REG_CONFIG 0x08
191 #define I2CTOSPI_RTC5_REG_CALIBRATION 0x09
192 
193 #define I2CTOSPI_RTC5_COMMAND_CLEAR 0x54
194 #define I2CTOSPI_RTC5_COMMAND_ENABLE_COUNTING 0x80
195  // End group macro
197 // --------------------------------------------------------------- PUBLIC TYPES
206 typedef struct
207 {
208  // Output pins
209 
210  digital_out_t rst;
211  digital_out_t cs;
212 
213  // Input pins
214 
215  digital_in_t int_pin;
216 
217  // Modules
218 
219  i2c_master_t i2c;
220 
221  // ctx variable
222 
223  uint8_t slave_address;
224 
225 } i2ctospi_t;
226 
230 typedef struct
231 {
232  // Communication gpio pins
233 
234  pin_name_t scl;
235  pin_name_t sda;
236 
237  // Additional gpio pins
238 
239  pin_name_t rst;
240  pin_name_t cs;
241  pin_name_t int_pin;
242 
243  // static variable
244 
245  uint32_t i2c_speed;
246  uint8_t i2c_address;
247 
249 
253 typedef struct
254 {
255  // Variable
256  uint8_t slave_device;
257  uint8_t function_id;
258  uint8_t reg_addr;
259  uint8_t n_bytes;
260 
262 
266 typedef struct
267 {
268  // Variable
269  uint8_t ss3_val;
270  uint8_t ss2_val;
271  uint8_t ss1_val;
272  uint8_t ss0_val;
273 
275  // End types group
277 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
278 
284 #ifdef __cplusplus
285 extern "C"{
286 #endif
287 
297 
307 
316 
327 void i2ctospi_generic_write ( i2ctospi_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
328 
339 void i2ctospi_generic_read ( i2ctospi_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
340 
353 
364 
381 void i2ctospi_spi_write_byte ( i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t write_data );
382 
401 
419 void i2ctospi_spi_burst_write ( i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t *write_data );
420 
439 void i2ctospi_spi_burst_read ( i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t *read_data );
440 
457 void i2ctospi_read_buffer_bytes ( i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t *read_data );
458 
474 void i2ctospi_write_command ( i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t command_data );
475 
491 void i2ctospi_write_enable ( i2ctospi_t *ctx, uint8_t ss_pin_data );
492 
521 void i2ctospi_config_spi ( i2ctospi_t *ctx, uint8_t config_data );
522 
537 
548 
568 void i2ctospi_set_write_state_of_gpio ( i2ctospi_t *ctx, uint8_t gpio_state );
569 
587 void i2ctospi_set_read_state_of_gpio ( i2ctospi_t *ctx, uint8_t gpio_state );
588 
606 void i2ctospi_enable_gpio ( i2ctospi_t *ctx, uint8_t ss_pin_number );
607 
643 
644 #ifdef __cplusplus
645 }
646 #endif
647 #endif // _I2CTOSPI_H_
648  // End public_function group
651 
652 // ------------------------------------------------------------------------- END
i2ctospi_gpio_t::ss3_val
uint8_t ss3_val
Definition: i2ctospi.h:269
i2ctospi_write_command
void i2ctospi_write_command(i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t command_data)
Generic write command byte of data function.
i2ctospi_spi_t::n_bytes
uint8_t n_bytes
Definition: i2ctospi.h:259
i2ctospi_clear_interrupt
void i2ctospi_clear_interrupt(i2ctospi_t *ctx)
Clear interrupt function.
i2ctospi_get_interrupt
uint8_t i2ctospi_get_interrupt(i2ctospi_t *ctx)
Gets state of the interrupt function.
i2ctospi_t::int_pin
digital_in_t int_pin
Definition: i2ctospi.h:215
i2ctospi_cfg_t::cs
pin_name_t cs
Definition: i2ctospi.h:240
i2ctospi_t::slave_address
uint8_t slave_address
Definition: i2ctospi.h:223
i2ctospi_cfg_t::scl
pin_name_t scl
Definition: i2ctospi.h:234
i2ctospi_t::rst
digital_out_t rst
Definition: i2ctospi.h:210
i2ctospi_gpio_t
Click gpio object definition.
Definition: i2ctospi.h:267
i2ctospi_types_gpio
void i2ctospi_types_gpio(i2ctospi_t *ctx, i2ctospi_gpio_t *gpio)
Enable the pins defined as GPIO function.
i2ctospi_t::cs
digital_out_t cs
Definition: i2ctospi.h:211
i2ctospi_set_idle_mode
void i2ctospi_set_idle_mode(i2ctospi_t *ctx)
Set Idle mode function.
i2ctospi_spi_t::slave_device
uint8_t slave_device
Definition: i2ctospi.h:256
i2ctospi_gpio_t::ss1_val
uint8_t ss1_val
Definition: i2ctospi.h:271
i2ctospi_write_enable
void i2ctospi_write_enable(i2ctospi_t *ctx, uint8_t ss_pin_data)
SPI EEPROM wite enable function.
i2ctospi_spi_t::reg_addr
uint8_t reg_addr
Definition: i2ctospi.h:258
i2ctospi_default_cfg
void i2ctospi_default_cfg(i2ctospi_t *ctx)
Click Default Configuration function.
i2ctospi_hw_reset
void i2ctospi_hw_reset(i2ctospi_t *ctx)
Hardware reset function.
I2CTOSPI_RETVAL
#define I2CTOSPI_RETVAL
Definition: i2ctospi.h:74
i2ctospi_cfg_t
Click configuration structure definition.
Definition: i2ctospi.h:231
i2ctospi_gpio_t::ss2_val
uint8_t ss2_val
Definition: i2ctospi.h:270
i2ctospi_generic_read
void i2ctospi_generic_read(i2ctospi_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
i2ctospi_t::i2c
i2c_master_t i2c
Definition: i2ctospi.h:219
i2ctospi_init
I2CTOSPI_RETVAL i2ctospi_init(i2ctospi_t *ctx, i2ctospi_cfg_t *cfg)
Initialization function.
i2ctospi_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2ctospi.h:245
i2ctospi_spi_burst_read
void i2ctospi_spi_burst_read(i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t *read_data)
Generic SPI read - single address burst read function.
i2ctospi_read_buffer_bytes
void i2ctospi_read_buffer_bytes(i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t *read_data)
Generic sequential read from the data buffer function.
i2ctospi_set_read_state_of_gpio
void i2ctospi_set_read_state_of_gpio(i2ctospi_t *ctx, uint8_t gpio_state)
Set state of the pins defined as GPIO read function.
i2ctospi_cfg_t::sda
pin_name_t sda
Definition: i2ctospi.h:235
i2ctospi_generic_write
void i2ctospi_generic_write(i2ctospi_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
i2ctospi_cfg_t::int_pin
pin_name_t int_pin
Definition: i2ctospi.h:241
i2ctospi_spi_read_byte
uint8_t i2ctospi_spi_read_byte(i2ctospi_t *ctx, i2ctospi_spi_t *spi)
Generic SPI read the byte of data from data buffer function.
i2ctospi_t
Click ctx object definition.
Definition: i2ctospi.h:207
i2ctospi_spi_t::function_id
uint8_t function_id
Definition: i2ctospi.h:257
i2ctospi_gpio_t::ss0_val
uint8_t ss0_val
Definition: i2ctospi.h:272
i2ctospi_config_spi
void i2ctospi_config_spi(i2ctospi_t *ctx, uint8_t config_data)
Configure SPI Interface function.
i2ctospi_spi_write_byte
void i2ctospi_spi_write_byte(i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t write_data)
Generic SPI write the byte of data to data buffer function.
i2ctospi_spi_burst_write
void i2ctospi_spi_burst_write(i2ctospi_t *ctx, i2ctospi_spi_t *spi, uint8_t *write_data)
Generic SPI write - single address burst write function.
i2ctospi_set_write_state_of_gpio
void i2ctospi_set_write_state_of_gpio(i2ctospi_t *ctx, uint8_t gpio_state)
Set state of the pins defined as GPIO write function.
i2ctospi_cfg_t::rst
pin_name_t rst
Definition: i2ctospi.h:239
i2ctospi_cfg_setup
void i2ctospi_cfg_setup(i2ctospi_cfg_t *cfg)
Config Object Initialization function.
i2ctospi_enable_gpio
void i2ctospi_enable_gpio(i2ctospi_t *ctx, uint8_t ss_pin_number)
Enable the pins defined as GPIO function.
i2ctospi_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2ctospi.h:246
i2ctospi_spi_t
Click spi object definition.
Definition: i2ctospi.h:254