rs232toi2c 2.0.0.0
rs232toi2c.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 RS232TOI2C_H
29#define RS232TOI2C_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51#include "drv_i2c_master.h"
52
73#define RS232TOI2C_CMD_WRITE_EEPROM 0x00
74#define RS232TOI2C_CMD_READ_EEPROM 0x01
75#define RS232TOI2C_CMD_WRITE_CURRENT_EEPROM 0x02
76#define RS232TOI2C_CMD_READ_CURRENT_EEPROM 0x03
77#define RS232TOI2C_CMD_ERASE_EEPROM_PAGE 0x04
78#define RS232TOI2C_CMD_SET_GPIO_OUT 0x06
79#define RS232TOI2C_CMD_GET_GPIO_IN 0x07
80#define RS232TOI2C_CMD_WRITE_GPIO_CFG 0x08
81#define RS232TOI2C_CMD_READ_GPIO_CFG 0x09
82#define RS232TOI2C_CMD_READ_GPIO_INT_STATUS 0x0F
83#define RS232TOI2C_CMD_READ_UART_STATUS 0x21
84#define RS232TOI2C_CMD_ENABLE_INT 0x22
85#define RS232TOI2C_CMD_INT_STATUS 0x23
86#define RS232TOI2C_CMD_WRITE_TX_FIFO 0x24
87#define RS232TOI2C_CMD_READ_RX_FIFO 0x25
88#define RS232TOI2C_CMD_WRITE_BAUD_RATE 0x26
89#define RS232TOI2C_CMD_READ_BAUD_RATE 0x27
90#define RS232TOI2C_CMD_WRITE_UART_CFG 0x28
91#define RS232TOI2C_CMD_READ_UART_CFG 0x29
92#define RS232TOI2C_CMD_WRITE_TRANSMIT_WATERMARK 0x2A
93#define RS232TOI2C_CMD_READ_TRANSMIT_WATERMARK 0x2B
94#define RS232TOI2C_CMD_WRITE_RECEIVE_WATERMARK 0x2C
95#define RS232TOI2C_CMD_READ_RECIEVE_WATERMARK 0x2D
96#define RS232TOI2C_CMD_ENABLE_UART 0x2E
97#define RS232TOI2C_CMD_READ_RX_TX_FIFO_LEVEL 0x31
98#define RS232TOI2C_CMD_READ_SYSTEM_STATUS 0xE1
99#define RS232TOI2C_CMD_READ_LAST_OP_RESULT 0xE3
100#define RS232TOI2C_CMD_READ_SYSTEM_VERSION 0xE5
101#define RS232TOI2C_CMD_READ_INT_SOURCE 0xEF
102
103 // rs232toi2c_reg
104
119#define RS232TOI2C_GPIO_SUB_CMD_DIR 0x01
120#define RS232TOI2C_GPIO_SUB_CMD_PULL_UP 0x02
121#define RS232TOI2C_GPIO_SUB_CMD_OPEN_DRAIN 0x03
122#define RS232TOI2C_GPIO_SUB_CMD_DEBOUNCE 0x04
123#define RS232TOI2C_GPIO_SUB_CMD_INTERRUPT 0x05
124#define RS232TOI2C_GPIO_SUB_CMD_RESET_DEFAULT 0x0A
125
130#define RS232TOI2C_GPIO_MASK_NONE 0x00
131#define RS232TOI2C_GPIO_0_MASK 0x01
132#define RS232TOI2C_GPIO_1_MASK 0x02
133#define RS232TOI2C_GPIO_2_MASK 0x04
134#define RS232TOI2C_GPIO_MASK_ALL 0x07
135
140#define RS232TOI2C_UART_SUB_CMD_DATABITS 0x01
141#define RS232TOI2C_UART_SUB_CMD_PARITY 0x02
142#define RS232TOI2C_UART_SUB_CMD_STOP_BITS 0x03
143#define RS232TOI2C_UART_SUB_CMD_FLOW_CONTROL 0x04
144#define RS232TOI2C_UART_SUB_CMD_RESET_FIFO 0x06
145#define RS232TOI2C_UART_SUB_CMD_LOOPBACK 0x08
146#define RS232TOI2C_UART_SUB_CMD_RESET_DEFAULT 0x0A
147
152#define RS232TOI2C_UART_DATABITS_5 0x00
153#define RS232TOI2C_UART_DATABITS_6 0x01
154#define RS232TOI2C_UART_DATABITS_7 0x02
155#define RS232TOI2C_UART_DATABITS_8 0x03
156#define RS232TOI2C_UART_DATABITS_9 0x07
157
162#define RS232TOI2C_UART_PARITY_NONE 0x00
163#define RS232TOI2C_UART_PARITY_ODD 0x03
164#define RS232TOI2C_UART_PARITY_EVEN 0x02
165
170#define RS232TOI2C_UART_STOP_BIT_1 0x00
171#define RS232TOI2C_UART_STOP_BIT_2 0x01
172
177#define RS232TOI2C_UART_FLOW_CONTROL_NONE 0x00
178#define RS232TOI2C_UART_FLOW_CONTROL_HARDWARE 0x01
179#define RS232TOI2C_UART_FLOW_CONTROL_SOFTWARE 0x02
180
185#define RS232TOI2C_UART_RESET_TX_FIFO 0x01
186#define RS232TOI2C_UART_RESET_RX_FIFO 0x02
187
192#define RS232TOI2C_UART_LOOPBACK_OFF 0x00
193#define RS232TOI2C_UART_LOOPBACK_ON 0x01
194
199#define RS232TOI2C_UART_DISABLE_RX_TX 0x00
200#define RS232TOI2C_UART_ENABLE_RX 0x01
201#define RS232TOI2C_UART_ENABLE_TX 0x02
202#define RS232TOI2C_UART_ENABLE_RX_TX 0x03
203
208#define RS232TOI2C_UART_STATUS_PARITY_ERROR 0x01
209#define RS232TOI2C_UART_STATUS_FRAME_ERROR 0x02
210#define RS232TOI2C_UART_STATUS_OVERRUN_ERROR 0x04
211#define RS232TOI2C_UART_STATUS_BREAK_RECEIVED 0x08
212#define RS232TOI2C_UART_STATUS_RX_EMPTY 0x20
213#define RS232TOI2C_UART_STATUS_TX_FULL 0x40
214#define RS232TOI2C_UART_STATUS_TX_EMPTY 0x80
215
220#define RS232TOI2C_INTERRUPT_TX_RX_ERROR 0x01
221#define RS232TOI2C_INTERRUPT_RX_FULL 0x02
222#define RS232TOI2C_INTERRUPT_RX_WATERMARK 0x04
223#define RS232TOI2C_INTERRUPT_RX_DATA 0x08
224#define RS232TOI2C_INTERRUPT_TX_FULL 0x20
225#define RS232TOI2C_INTERRUPT_TX_WATERMARK 0x40
226#define RS232TOI2C_INTERRUPT_TX_EMPTY 0x80
227
232#define RS232TOI2C_EEPROM_PAGE_SIZE 32
233#define RS232TOI2C_EEPROM_PAGE_NUM 16
234#define RS232TOI2C_EEPROM_SIZE 512
235
240#define RS232TOI2C_CMD_ACCESS_BIT 0x08
241
247#define RS232TOI2C_SET_DEV_ADDR_A2_GND 0x53
248#define RS232TOI2C_SET_DEV_ADDR_A2_VCC 0x57
249
250 // rs232toi2c_set
251
266#define RS232TOI2C_MAP_MIKROBUS( cfg, mikrobus ) \
267 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
268 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
269 cfg.wp = MIKROBUS( mikrobus, MIKROBUS_CS ); \
270 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
271 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
272
273 // rs232toi2c_map
274 // rs232toi2c
275
280typedef struct
281{
282 // Output pins
283 digital_out_t wp;
284 digital_out_t rst;
286 // Input pins
287 digital_in_t int_pin;
289 // Modules
290 i2c_master_t i2c;
292 // I2C slave address
296
301typedef struct
302{
303 pin_name_t scl;
304 pin_name_t sda;
306 pin_name_t wp;
307 pin_name_t rst;
308 pin_name_t int_pin;
310 uint32_t i2c_speed;
311 uint8_t i2c_address;
314
325
342
357
371
386err_t rs232toi2c_write_command ( rs232toi2c_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t data_len );
387
402err_t rs232toi2c_read_command ( rs232toi2c_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t data_len );
403
418err_t rs232toi2c_write_eeprom ( rs232toi2c_t *ctx, uint16_t address, uint8_t *data_in, uint8_t data_len );
419
434err_t rs232toi2c_read_eeprom ( rs232toi2c_t *ctx, uint16_t address, uint8_t *data_out, uint8_t data_len );
435
447err_t rs232toi2c_erase_eeprom_page ( rs232toi2c_t *ctx, uint8_t page_num );
448
461err_t rs232toi2c_set_gpio_out ( rs232toi2c_t *ctx, uint8_t mask, uint8_t state );
462
474err_t rs232toi2c_get_gpio_in ( rs232toi2c_t *ctx, uint8_t *state );
475
489err_t rs232toi2c_write_gpio_config ( rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t mask, uint8_t config );
490
503err_t rs232toi2c_read_gpio_config ( rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t *config );
504
517err_t rs232toi2c_write_uart_config ( rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t config );
518
530err_t rs232toi2c_read_uart_config ( rs232toi2c_t *ctx, uint8_t *config );
531
546err_t rs232toi2c_enable_uart ( rs232toi2c_t *ctx, uint8_t state );
547
559err_t rs232toi2c_set_baud_rate ( rs232toi2c_t *ctx, uint32_t baud_rate );
560
572err_t rs232toi2c_get_baud_rate ( rs232toi2c_t *ctx, uint32_t *baud_rate );
573
585err_t rs232toi2c_enable_interrupts ( rs232toi2c_t *ctx, uint8_t int_mask );
586
598err_t rs232toi2c_get_interrupt_status ( rs232toi2c_t *ctx, uint8_t *int_status );
599
611err_t rs232toi2c_get_uart_status ( rs232toi2c_t *ctx, uint8_t *uart_status );
612
624err_t rs232toi2c_get_gpio_status ( rs232toi2c_t *ctx, uint8_t *gpio_status );
625
638err_t rs232toi2c_write_tx_fifo ( rs232toi2c_t *ctx, uint8_t *data_in, uint8_t data_len );
639
652err_t rs232toi2c_read_rx_fifo ( rs232toi2c_t *ctx, uint8_t *data_out, uint8_t *data_len );
653
665err_t rs232toi2c_read_system_version ( rs232toi2c_t *ctx, uint32_t *system_version );
666
676void rs232toi2c_set_rst_pin ( rs232toi2c_t *ctx, uint8_t state );
677
687void rs232toi2c_set_wp_pin ( rs232toi2c_t *ctx, uint8_t state );
688
698
708
709#ifdef __cplusplus
710}
711#endif
712#endif // RS232TOI2C_H
713
714 // rs232toi2c
715
716// ------------------------------------------------------------------------ END
void rs232toi2c_set_wp_pin(rs232toi2c_t *ctx, uint8_t state)
RS232 to I2C set wp pin function.
err_t rs232toi2c_read_system_version(rs232toi2c_t *ctx, uint32_t *system_version)
RS232 to I2C read system version function.
err_t rs232toi2c_read_rx_fifo(rs232toi2c_t *ctx, uint8_t *data_out, uint8_t *data_len)
RS232 to I2C read rx fifo function.
err_t rs232toi2c_default_cfg(rs232toi2c_t *ctx)
RS232 to I2C default configuration function.
err_t rs232toi2c_erase_eeprom_page(rs232toi2c_t *ctx, uint8_t page_num)
RS232 to I2C erase eeprom page function.
err_t rs232toi2c_write_gpio_config(rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t mask, uint8_t config)
RS232 to I2C write gpio config function.
err_t rs232toi2c_set_baud_rate(rs232toi2c_t *ctx, uint32_t baud_rate)
RS232 to I2C set baud rate function.
void rs232toi2c_reset_device(rs232toi2c_t *ctx)
RS232 to I2C reset device function.
err_t rs232toi2c_write_command(rs232toi2c_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t data_len)
RS232 to I2C write command function.
err_t rs232toi2c_get_gpio_in(rs232toi2c_t *ctx, uint8_t *state)
RS232 to I2C get gpio in function.
err_t rs232toi2c_enable_interrupts(rs232toi2c_t *ctx, uint8_t int_mask)
RS232 to I2C enable interrupts function.
err_t rs232toi2c_read_uart_config(rs232toi2c_t *ctx, uint8_t *config)
RS232 to I2C read uart config function.
err_t rs232toi2c_write_tx_fifo(rs232toi2c_t *ctx, uint8_t *data_in, uint8_t data_len)
RS232 to I2C write tx fifo function.
err_t rs232toi2c_get_interrupt_status(rs232toi2c_t *ctx, uint8_t *int_status)
RS232 to I2C get interrupt status function.
err_t rs232toi2c_set_gpio_out(rs232toi2c_t *ctx, uint8_t mask, uint8_t state)
RS232 to I2C set gpio out function.
void rs232toi2c_cfg_setup(rs232toi2c_cfg_t *cfg)
RS232 to I2C configuration object setup function.
err_t rs232toi2c_write_uart_config(rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t config)
RS232 to I2C write uart config function.
err_t rs232toi2c_get_uart_status(rs232toi2c_t *ctx, uint8_t *uart_status)
RS232 to I2C get uart status function.
err_t rs232toi2c_read_command(rs232toi2c_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t data_len)
RS232 to I2C read command function.
err_t rs232toi2c_read_gpio_config(rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t *config)
RS232 to I2C read gpio config function.
err_t rs232toi2c_read_eeprom(rs232toi2c_t *ctx, uint16_t address, uint8_t *data_out, uint8_t data_len)
RS232 to I2C read eeprom function.
err_t rs232toi2c_init(rs232toi2c_t *ctx, rs232toi2c_cfg_t *cfg)
RS232 to I2C initialization function.
uint8_t rs232toi2c_get_int_pin(rs232toi2c_t *ctx)
RS232 to I2C get int pin function.
err_t rs232toi2c_get_baud_rate(rs232toi2c_t *ctx, uint32_t *baud_rate)
RS232 to I2C get baud rate function.
err_t rs232toi2c_enable_uart(rs232toi2c_t *ctx, uint8_t state)
RS232 to I2C enable uart function.
err_t rs232toi2c_get_gpio_status(rs232toi2c_t *ctx, uint8_t *gpio_status)
RS232 to I2C get gpio status function.
void rs232toi2c_set_rst_pin(rs232toi2c_t *ctx, uint8_t state)
RS232 to I2C set rst pin function.
err_t rs232toi2c_write_eeprom(rs232toi2c_t *ctx, uint16_t address, uint8_t *data_in, uint8_t data_len)
RS232 to I2C write eeprom function.
rs232toi2c_return_value_t
RS232 to I2C Click return value data.
Definition rs232toi2c.h:320
@ RS232TOI2C_OK
Definition rs232toi2c.h:321
@ RS232TOI2C_ERROR
Definition rs232toi2c.h:322
RS232 to I2C Click configuration object.
Definition rs232toi2c.h:302
uint32_t i2c_speed
Definition rs232toi2c.h:310
pin_name_t wp
Definition rs232toi2c.h:306
pin_name_t scl
Definition rs232toi2c.h:303
pin_name_t int_pin
Definition rs232toi2c.h:308
pin_name_t sda
Definition rs232toi2c.h:304
pin_name_t rst
Definition rs232toi2c.h:307
uint8_t i2c_address
Definition rs232toi2c.h:311
RS232 to I2C Click context object.
Definition rs232toi2c.h:281
digital_in_t int_pin
Definition rs232toi2c.h:287
i2c_master_t i2c
Definition rs232toi2c.h:290
digital_out_t rst
Definition rs232toi2c.h:284
uint8_t slave_address
Definition rs232toi2c.h:293
digital_out_t wp
Definition rs232toi2c.h:283