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
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define RS232TOI2C_CMD_WRITE_EEPROM 0x00
60 #define RS232TOI2C_CMD_READ_EEPROM 0x01
61 #define RS232TOI2C_CMD_WRITE_CURRENT_EEPROM 0x02
62 #define RS232TOI2C_CMD_READ_CURRENT_EEPROM 0x03
63 #define RS232TOI2C_CMD_ERASE_EEPROM_PAGE 0x04
64 #define RS232TOI2C_CMD_SET_GPIO_OUT 0x06
65 #define RS232TOI2C_CMD_GET_GPIO_IN 0x07
66 #define RS232TOI2C_CMD_WRITE_GPIO_CFG 0x08
67 #define RS232TOI2C_CMD_READ_GPIO_CFG 0x09
68 #define RS232TOI2C_CMD_READ_GPIO_INT_STATUS 0x0F
69 #define RS232TOI2C_CMD_READ_UART_STATUS 0x21
70 #define RS232TOI2C_CMD_ENABLE_INT 0x22
71 #define RS232TOI2C_CMD_INT_STATUS 0x23
72 #define RS232TOI2C_CMD_WRITE_TX_FIFO 0x24
73 #define RS232TOI2C_CMD_READ_RX_FIFO 0x25
74 #define RS232TOI2C_CMD_WRITE_BAUD_RATE 0x26
75 #define RS232TOI2C_CMD_READ_BAUD_RATE 0x27
76 #define RS232TOI2C_CMD_WRITE_UART_CFG 0x28
77 #define RS232TOI2C_CMD_READ_UART_CFG 0x29
78 #define RS232TOI2C_CMD_WRITE_TRANSMIT_WATERMARK 0x2A
79 #define RS232TOI2C_CMD_READ_TRANSMIT_WATERMARK 0x2B
80 #define RS232TOI2C_CMD_WRITE_RECEIVE_WATERMARK 0x2C
81 #define RS232TOI2C_CMD_READ_RECIEVE_WATERMARK 0x2D
82 #define RS232TOI2C_CMD_ENABLE_UART 0x2E
83 #define RS232TOI2C_CMD_READ_RX_TX_FIFO_LEVEL 0x31
84 #define RS232TOI2C_CMD_READ_SYSTEM_STATUS 0xE1
85 #define RS232TOI2C_CMD_READ_LAST_OP_RESULT 0xE3
86 #define RS232TOI2C_CMD_READ_SYSTEM_VERSION 0xE5
87 #define RS232TOI2C_CMD_READ_INT_SOURCE 0xEF
88  // rs232toi2c_reg
90 
105 #define RS232TOI2C_GPIO_SUB_CMD_DIR 0x01
106 #define RS232TOI2C_GPIO_SUB_CMD_PULL_UP 0x02
107 #define RS232TOI2C_GPIO_SUB_CMD_OPEN_DRAIN 0x03
108 #define RS232TOI2C_GPIO_SUB_CMD_DEBOUNCE 0x04
109 #define RS232TOI2C_GPIO_SUB_CMD_INTERRUPT 0x05
110 #define RS232TOI2C_GPIO_SUB_CMD_RESET_DEFAULT 0x0A
111 
116 #define RS232TOI2C_GPIO_MASK_NONE 0x00
117 #define RS232TOI2C_GPIO_0_MASK 0x01
118 #define RS232TOI2C_GPIO_1_MASK 0x02
119 #define RS232TOI2C_GPIO_2_MASK 0x04
120 #define RS232TOI2C_GPIO_MASK_ALL 0x07
121 
126 #define RS232TOI2C_UART_SUB_CMD_DATABITS 0x01
127 #define RS232TOI2C_UART_SUB_CMD_PARITY 0x02
128 #define RS232TOI2C_UART_SUB_CMD_STOP_BITS 0x03
129 #define RS232TOI2C_UART_SUB_CMD_FLOW_CONTROL 0x04
130 #define RS232TOI2C_UART_SUB_CMD_RESET_FIFO 0x06
131 #define RS232TOI2C_UART_SUB_CMD_LOOPBACK 0x08
132 #define RS232TOI2C_UART_SUB_CMD_RESET_DEFAULT 0x0A
133 
138 #define RS232TOI2C_UART_DATABITS_5 0x00
139 #define RS232TOI2C_UART_DATABITS_6 0x01
140 #define RS232TOI2C_UART_DATABITS_7 0x02
141 #define RS232TOI2C_UART_DATABITS_8 0x03
142 #define RS232TOI2C_UART_DATABITS_9 0x07
143 
148 #define RS232TOI2C_UART_PARITY_NONE 0x00
149 #define RS232TOI2C_UART_PARITY_ODD 0x03
150 #define RS232TOI2C_UART_PARITY_EVEN 0x02
151 
156 #define RS232TOI2C_UART_STOP_BIT_1 0x00
157 #define RS232TOI2C_UART_STOP_BIT_2 0x01
158 
163 #define RS232TOI2C_UART_FLOW_CONTROL_NONE 0x00
164 #define RS232TOI2C_UART_FLOW_CONTROL_HARDWARE 0x01
165 #define RS232TOI2C_UART_FLOW_CONTROL_SOFTWARE 0x02
166 
171 #define RS232TOI2C_UART_RESET_TX_FIFO 0x01
172 #define RS232TOI2C_UART_RESET_RX_FIFO 0x02
173 
178 #define RS232TOI2C_UART_LOOPBACK_OFF 0x00
179 #define RS232TOI2C_UART_LOOPBACK_ON 0x01
180 
185 #define RS232TOI2C_UART_DISABLE_RX_TX 0x00
186 #define RS232TOI2C_UART_ENABLE_RX 0x01
187 #define RS232TOI2C_UART_ENABLE_TX 0x02
188 #define RS232TOI2C_UART_ENABLE_RX_TX 0x03
189 
194 #define RS232TOI2C_UART_STATUS_PARITY_ERROR 0x01
195 #define RS232TOI2C_UART_STATUS_FRAME_ERROR 0x02
196 #define RS232TOI2C_UART_STATUS_OVERRUN_ERROR 0x04
197 #define RS232TOI2C_UART_STATUS_BREAK_RECEIVED 0x08
198 #define RS232TOI2C_UART_STATUS_RX_EMPTY 0x20
199 #define RS232TOI2C_UART_STATUS_TX_FULL 0x40
200 #define RS232TOI2C_UART_STATUS_TX_EMPTY 0x80
201 
206 #define RS232TOI2C_INTERRUPT_TX_RX_ERROR 0x01
207 #define RS232TOI2C_INTERRUPT_RX_FULL 0x02
208 #define RS232TOI2C_INTERRUPT_RX_WATERMARK 0x04
209 #define RS232TOI2C_INTERRUPT_RX_DATA 0x08
210 #define RS232TOI2C_INTERRUPT_TX_FULL 0x20
211 #define RS232TOI2C_INTERRUPT_TX_WATERMARK 0x40
212 #define RS232TOI2C_INTERRUPT_TX_EMPTY 0x80
213 
218 #define RS232TOI2C_EEPROM_PAGE_SIZE 32
219 #define RS232TOI2C_EEPROM_PAGE_NUM 16
220 #define RS232TOI2C_EEPROM_SIZE 512
221 
226 #define RS232TOI2C_CMD_ACCESS_BIT 0x08
227 
233 #define RS232TOI2C_SET_DEV_ADDR_A2_GND 0x53
234 #define RS232TOI2C_SET_DEV_ADDR_A2_VCC 0x57
235  // rs232toi2c_set
237 
252 #define RS232TOI2C_MAP_MIKROBUS( cfg, mikrobus ) \
253  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
254  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
255  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_CS ); \
256  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
257  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
258  // rs232toi2c_map // rs232toi2c
261 
266 typedef struct
267 {
268  // Output pins
269  digital_out_t wp;
270  digital_out_t rst;
272  // Input pins
273  digital_in_t int_pin;
275  // Modules
276  i2c_master_t i2c;
278  // I2C slave address
279  uint8_t slave_address;
281 } rs232toi2c_t;
282 
287 typedef struct
288 {
289  pin_name_t scl;
290  pin_name_t sda;
292  pin_name_t wp;
293  pin_name_t rst;
294  pin_name_t int_pin;
296  uint32_t i2c_speed;
297  uint8_t i2c_address;
300 
305 typedef enum
306 {
308  RS232TOI2C_ERROR = -1
309 
311 
328 
343 
357 
372 err_t rs232toi2c_write_command ( rs232toi2c_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t data_len );
373 
388 err_t rs232toi2c_read_command ( rs232toi2c_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t data_len );
389 
404 err_t rs232toi2c_write_eeprom ( rs232toi2c_t *ctx, uint16_t address, uint8_t *data_in, uint8_t data_len );
405 
420 err_t rs232toi2c_read_eeprom ( rs232toi2c_t *ctx, uint16_t address, uint8_t *data_out, uint8_t data_len );
421 
433 err_t rs232toi2c_erase_eeprom_page ( rs232toi2c_t *ctx, uint8_t page_num );
434 
447 err_t rs232toi2c_set_gpio_out ( rs232toi2c_t *ctx, uint8_t mask, uint8_t state );
448 
460 err_t rs232toi2c_get_gpio_in ( rs232toi2c_t *ctx, uint8_t *state );
461 
475 err_t rs232toi2c_write_gpio_config ( rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t mask, uint8_t config );
476 
489 err_t rs232toi2c_read_gpio_config ( rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t *config );
490 
503 err_t rs232toi2c_write_uart_config ( rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t config );
504 
516 err_t rs232toi2c_read_uart_config ( rs232toi2c_t *ctx, uint8_t *config );
517 
532 err_t rs232toi2c_enable_uart ( rs232toi2c_t *ctx, uint8_t state );
533 
545 err_t rs232toi2c_set_baud_rate ( rs232toi2c_t *ctx, uint32_t baud_rate );
546 
558 err_t rs232toi2c_get_baud_rate ( rs232toi2c_t *ctx, uint32_t *baud_rate );
559 
571 err_t rs232toi2c_enable_interrupts ( rs232toi2c_t *ctx, uint8_t int_mask );
572 
584 err_t rs232toi2c_get_interrupt_status ( rs232toi2c_t *ctx, uint8_t *int_status );
585 
597 err_t rs232toi2c_get_uart_status ( rs232toi2c_t *ctx, uint8_t *uart_status );
598 
610 err_t rs232toi2c_get_gpio_status ( rs232toi2c_t *ctx, uint8_t *gpio_status );
611 
624 err_t rs232toi2c_write_tx_fifo ( rs232toi2c_t *ctx, uint8_t *data_in, uint8_t data_len );
625 
638 err_t rs232toi2c_read_rx_fifo ( rs232toi2c_t *ctx, uint8_t *data_out, uint8_t *data_len );
639 
651 err_t rs232toi2c_read_system_version ( rs232toi2c_t *ctx, uint32_t *system_version );
652 
662 void rs232toi2c_set_rst_pin ( rs232toi2c_t *ctx, uint8_t state );
663 
673 void rs232toi2c_set_wp_pin ( rs232toi2c_t *ctx, uint8_t state );
674 
684 
694 
695 #ifdef __cplusplus
696 }
697 #endif
698 #endif // RS232TOI2C_H
699  // rs232toi2c
701 
702 // ------------------------------------------------------------------------ END
rs232toi2c_get_gpio_status
err_t rs232toi2c_get_gpio_status(rs232toi2c_t *ctx, uint8_t *gpio_status)
RS232 to I2C get gpio status function.
rs232toi2c_set_baud_rate
err_t rs232toi2c_set_baud_rate(rs232toi2c_t *ctx, uint32_t baud_rate)
RS232 to I2C set baud rate function.
rs232toi2c_init
err_t rs232toi2c_init(rs232toi2c_t *ctx, rs232toi2c_cfg_t *cfg)
RS232 to I2C initialization function.
rs232toi2c_cfg_t
RS232 to I2C Click configuration object.
Definition: rs232toi2c.h:288
rs232toi2c_cfg_t::wp
pin_name_t wp
Definition: rs232toi2c.h:292
rs232toi2c_write_uart_config
err_t rs232toi2c_write_uart_config(rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t config)
RS232 to I2C write uart config function.
rs232toi2c_enable_interrupts
err_t rs232toi2c_enable_interrupts(rs232toi2c_t *ctx, uint8_t int_mask)
RS232 to I2C enable interrupts function.
rs232toi2c_t::slave_address
uint8_t slave_address
Definition: rs232toi2c.h:279
rs232toi2c_erase_eeprom_page
err_t rs232toi2c_erase_eeprom_page(rs232toi2c_t *ctx, uint8_t page_num)
RS232 to I2C erase eeprom page function.
rs232toi2c_t
RS232 to I2C Click context object.
Definition: rs232toi2c.h:267
rs232toi2c_cfg_t::sda
pin_name_t sda
Definition: rs232toi2c.h:290
rs232toi2c_cfg_t::rst
pin_name_t rst
Definition: rs232toi2c.h:293
RS232TOI2C_ERROR
@ RS232TOI2C_ERROR
Definition: rs232toi2c.h:308
rs232toi2c_reset_device
void rs232toi2c_reset_device(rs232toi2c_t *ctx)
RS232 to I2C reset device function.
rs232toi2c_t::int_pin
digital_in_t int_pin
Definition: rs232toi2c.h:273
rs232toi2c_write_tx_fifo
err_t rs232toi2c_write_tx_fifo(rs232toi2c_t *ctx, uint8_t *data_in, uint8_t data_len)
RS232 to I2C write tx fifo function.
rs232toi2c_read_system_version
err_t rs232toi2c_read_system_version(rs232toi2c_t *ctx, uint32_t *system_version)
RS232 to I2C read system version function.
rs232toi2c_read_rx_fifo
err_t rs232toi2c_read_rx_fifo(rs232toi2c_t *ctx, uint8_t *data_out, uint8_t *data_len)
RS232 to I2C read rx fifo function.
rs232toi2c_read_gpio_config
err_t rs232toi2c_read_gpio_config(rs232toi2c_t *ctx, uint8_t sub_cmd, uint8_t *config)
RS232 to I2C read gpio config function.
rs232toi2c_get_gpio_in
err_t rs232toi2c_get_gpio_in(rs232toi2c_t *ctx, uint8_t *state)
RS232 to I2C get gpio in function.
RS232TOI2C_OK
@ RS232TOI2C_OK
Definition: rs232toi2c.h:307
rs232toi2c_set_rst_pin
void rs232toi2c_set_rst_pin(rs232toi2c_t *ctx, uint8_t state)
RS232 to I2C set rst pin function.
rs232toi2c_enable_uart
err_t rs232toi2c_enable_uart(rs232toi2c_t *ctx, uint8_t state)
RS232 to I2C enable uart function.
rs232toi2c_set_gpio_out
err_t rs232toi2c_set_gpio_out(rs232toi2c_t *ctx, uint8_t mask, uint8_t state)
RS232 to I2C set gpio out function.
rs232toi2c_t::wp
digital_out_t wp
Definition: rs232toi2c.h:269
rs232toi2c_set_wp_pin
void rs232toi2c_set_wp_pin(rs232toi2c_t *ctx, uint8_t state)
RS232 to I2C set wp pin function.
rs232toi2c_get_interrupt_status
err_t rs232toi2c_get_interrupt_status(rs232toi2c_t *ctx, uint8_t *int_status)
RS232 to I2C get interrupt status function.
rs232toi2c_write_eeprom
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_write_command
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.
rs232toi2c_write_gpio_config
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.
rs232toi2c_t::i2c
i2c_master_t i2c
Definition: rs232toi2c.h:276
rs232toi2c_return_value_t
rs232toi2c_return_value_t
RS232 to I2C Click return value data.
Definition: rs232toi2c.h:306
rs232toi2c_cfg_t::i2c_address
uint8_t i2c_address
Definition: rs232toi2c.h:297
rs232toi2c_cfg_setup
void rs232toi2c_cfg_setup(rs232toi2c_cfg_t *cfg)
RS232 to I2C configuration object setup function.
rs232toi2c_cfg_t::scl
pin_name_t scl
Definition: rs232toi2c.h:289
rs232toi2c_get_baud_rate
err_t rs232toi2c_get_baud_rate(rs232toi2c_t *ctx, uint32_t *baud_rate)
RS232 to I2C get baud rate function.
rs232toi2c_get_int_pin
uint8_t rs232toi2c_get_int_pin(rs232toi2c_t *ctx)
RS232 to I2C get int pin function.
rs232toi2c_default_cfg
err_t rs232toi2c_default_cfg(rs232toi2c_t *ctx)
RS232 to I2C default configuration function.
rs232toi2c_read_command
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.
rs232toi2c_read_uart_config
err_t rs232toi2c_read_uart_config(rs232toi2c_t *ctx, uint8_t *config)
RS232 to I2C read uart config function.
rs232toi2c_cfg_t::int_pin
pin_name_t int_pin
Definition: rs232toi2c.h:294
rs232toi2c_get_uart_status
err_t rs232toi2c_get_uart_status(rs232toi2c_t *ctx, uint8_t *uart_status)
RS232 to I2C get uart status function.
rs232toi2c_read_eeprom
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.
rs232toi2c_t::rst
digital_out_t rst
Definition: rs232toi2c.h:270
rs232toi2c_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: rs232toi2c.h:296