uarttoi2c.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef UARTTOI2C_H
#define UARTTOI2C_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define UARTTOI2C_CMD_START             'S'
#define UARTTOI2C_CMD_STOP              'P'
#define UARTTOI2C_CMD_READ_REG          'R'
#define UARTTOI2C_CMD_WRITE_REG         'W'
#define UARTTOI2C_CMD_READ_GPIO         'I'
#define UARTTOI2C_CMD_WRITE_GPIO        'O'
#define UARTTOI2C_CMD_READ_VERSION      'V'
#define UARTTOI2C_CMD_POWER_DOWN        'Z'
 
#define UARTTOI2C_REG_BRG0              0x00
#define UARTTOI2C_REG_BRG1              0x01
#define UARTTOI2C_REG_PORT_CONF_1       0x02
#define UARTTOI2C_REG_PORT_CONF_2       0x03
#define UARTTOI2C_REG_IO_STATE          0x04
#define UARTTOI2C_REG_RESERVED          0x05
#define UARTTOI2C_REG_I2C_ADR           0x06
#define UARTTOI2C_REG_I2C_CLK_L         0x07
#define UARTTOI2C_REG_I2C_CLK_H         0x08
#define UARTTOI2C_REG_I2C_TO            0x09
#define UARTTOI2C_REG_I2C_STAT          0x0A
 
#define UARTTOI2C_TIMEOUT_MS            3000
 
#define UARTTOI2C_POWER_UP_BYTE_0       0x4F
#define UARTTOI2C_POWER_UP_BYTE_1       0x4B
 
#define UARTTOI2C_NO_PIN_MASK           0x00
#define UARTTOI2C_PIN_0_MASK            0x01
#define UARTTOI2C_PIN_1_MASK            0x02
#define UARTTOI2C_PIN_2_MASK            0x04
#define UARTTOI2C_PIN_3_MASK            0x08
#define UARTTOI2C_PIN_4_MASK            0x10
#define UARTTOI2C_PIN_5_MASK            0x20
#define UARTTOI2C_PIN_6_MASK            0x40
#define UARTTOI2C_PIN_7_MASK            0x80
#define UARTTOI2C_ALL_PINS_MASK         0xFF
 
#define UARTTOI2C_PIN_DIR_INPUT         0x00
#define UARTTOI2C_PIN_DIR_OUTPUT_PP     0x02
#define UARTTOI2C_PIN_DIR_OUTPUT_OD     0x03
#define UARTTOI2C_PIN_DIR_OUTPUT_MASK   0x03
 
#define UARTTOI2C_TX_DRV_BUFFER_SIZE    100
#define UARTTOI2C_RX_DRV_BUFFER_SIZE    300
 
 // uarttoi2c_cmd
 
#define UARTTOI2C_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // uarttoi2c_map
 // uarttoi2c
 
typedef struct
{
    // Output pins
    digital_out_t rst;                  
    // Modules
    uart_t uart;                        
    // Buffers
    char uart_rx_buffer[ UARTTOI2C_RX_DRV_BUFFER_SIZE ];    
    char uart_tx_buffer[ UARTTOI2C_TX_DRV_BUFFER_SIZE ];    
} uarttoi2c_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                  
    pin_name_t tx_pin;                  
    // Additional gpio pins
    pin_name_t rst;                     
    // Static variable
    uint32_t         baud_rate;         
    bool             uart_blocking;     
    uart_data_bits_t data_bit;          
    uart_parity_t    parity_bit;        
    uart_stop_bits_t stop_bit;          
} uarttoi2c_cfg_t;
 
typedef enum
{
    UARTTOI2C_OK = 0,
    UARTTOI2C_ERROR = -1,
    UARTTOI2C_TIMEOUT_ERROR = -2
 
} uarttoi2c_return_value_t;
 
void uarttoi2c_cfg_setup ( uarttoi2c_cfg_t *cfg );
 
err_t uarttoi2c_init ( uarttoi2c_t *ctx, uarttoi2c_cfg_t *cfg );
 
err_t uarttoi2c_default_cfg ( uarttoi2c_t *ctx );
 
err_t uarttoi2c_generic_write ( uarttoi2c_t *ctx, char *data_in, uint16_t len );
 
err_t uarttoi2c_generic_read ( uarttoi2c_t *ctx, char *data_out, uint16_t len );
 
void uarttoi2c_set_rst_pin ( uarttoi2c_t *ctx, uint8_t state );
 
err_t uarttoi2c_reset_device ( uarttoi2c_t *ctx );
 
err_t uarttoi2c_write_register ( uarttoi2c_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t uarttoi2c_read_register ( uarttoi2c_t *ctx, uint8_t reg, uint8_t *data_out );
 
void uarttoi2c_gpio_write ( uarttoi2c_t *ctx, uint8_t gpio_data );
 
err_t uarttoi2c_gpio_read ( uarttoi2c_t *ctx, uint8_t *gpio_data );
 
err_t uarttoi2c_gpio_config ( uarttoi2c_t *ctx, uint8_t direction, uint8_t pin_mask );
 
err_t uarttoi2c_read_version ( uarttoi2c_t *ctx, uint8_t *version );
 
err_t uarttoi2c_i2c_write ( uarttoi2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t len );
 
err_t uarttoi2c_i2c_read ( uarttoi2c_t *ctx, uint8_t slave_addr, uint8_t *data_out, uint8_t len );
 
err_t uarttoi2c_i2c_write_then_read ( uarttoi2c_t *ctx, uint8_t slave_addr, 
                                      uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len );
 
#ifdef __cplusplus
}
#endif
#endif // UARTTOI2C_H
 
 // uarttoi2c
 
// ------------------------------------------------------------------------ END