rstransceiver.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 RSTRANSCEIVER_H
#define RSTRANSCEIVER_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_i2c_master.h"
#include "drv_uart.h"
 
#define RSTRANSCEIVER_REG_INPUT_PORT             0x00
#define RSTRANSCEIVER_REG_OUTPUT_PORT            0x01
#define RSTRANSCEIVER_REG_POLARITY_INV           0x02
#define RSTRANSCEIVER_REG_CONFIG                 0x03
#define RSTRANSCEIVER_REG_SPECIAL_FUNC           0x50
 
 // rstransceiver_reg
 
#define RSTRANSCEIVER_NO_PIN_BIT_MASK            0x00
#define RSTRANSCEIVER_PIN_0_BIT_MASK             0x01
#define RSTRANSCEIVER_PIN_1_BIT_MASK             0x02
#define RSTRANSCEIVER_PIN_2_BIT_MASK             0x04
#define RSTRANSCEIVER_PIN_3_BIT_MASK             0x08
#define RSTRANSCEIVER_ALL_PINS_BIT_MASK          0x0F
 
#define RSTRANSCEIVER_OUTPUT_DIRECTION           0x00
#define RSTRANSCEIVER_INPUT_DIRECTION            0x01
 
#define RSTRANSCEIVER_SPECIAL_FUNC_P3_AS_INT     0x80
#define RSTRANSCEIVER_SPECIAL_FUNC_PU_DISABLED   0x40
 
#define RSTRANSCEIVER_SLEW_DISABLE               0x00
#define RSTRANSCEIVER_SLEW_ENABLE                0x01
 
#define RSTRANSCEIVER_OP_MODE_LOOPBACK           0x00
#define RSTRANSCEIVER_OP_MODE_RS232              0x01
#define RSTRANSCEIVER_OP_MODE_HALF_DUPLEX        0x02
#define RSTRANSCEIVER_OP_MODE_FULL_DUPLEX        0x03
#define RSTRANSCEIVER_OP_MODE_PIN_BIT_MASK       0x09
 
#define RSTRANSCEIVER_DIR_DISABLE                0x00
#define RSTRANSCEIVER_DIR_T1_EN                  0x01
#define RSTRANSCEIVER_DIR_T1_EN_R1_DIS           0x01
#define RSTRANSCEIVER_DIR_PIN_BIT_MASK           0x0E
 
#define RSTRANSCEIVER_TERM_DISABLE               0x00
#define RSTRANSCEIVER_TERM_ENABLE                0x01
#define RSTRANSCEIVER_TERM_DIS_PIN_BIT_MASK      0x07
#define RSTRANSCEIVER_TERM_EN_PIN_BIT_MASK       0x08
 
#define RSTRANSCEIVER_TX_DRV_BUFFER_SIZE         100
#define RSTRANSCEIVER_RX_DRV_BUFFER_SIZE         300
 
#define RSTRANSCEIVER_DEVICE_ADDRESS              0x41
 
 // rstransceiver_set
 
#define RSTRANSCEIVER_MAP_MIKROBUS( cfg, mikrobus )  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );    \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );    \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );      \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );    \
    cfg.slw = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.cst = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rstransceiver_map
 // rstransceiver
 
typedef struct
{
    // Output pins
    digital_out_t cs;     
    digital_out_t rst;    
    digital_out_t slw;    
    // Input pins
    digital_in_t cst;    
    // Modules
    i2c_master_t i2c;    
    uart_t uart;         
    // I2C slave address
    uint8_t slave_address;    
    // Buffers
    char uart_rx_buffer[ RSTRANSCEIVER_RX_DRV_BUFFER_SIZE ];    
    char uart_tx_buffer[ RSTRANSCEIVER_TX_DRV_BUFFER_SIZE ];    
} rstransceiver_t;
 
typedef struct
{
    pin_name_t scl;       
    pin_name_t sda;       
    pin_name_t rx_pin;    
    pin_name_t tx_pin;    
    pin_name_t cs;     
    pin_name_t rst;    
    pin_name_t slw;    
    pin_name_t cst;    
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
    // 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;         
} rstransceiver_cfg_t;
 
typedef enum
{
    RSTRANSCEIVER_OK = 0,
    RSTRANSCEIVER_ERROR = -1
 
} rstransceiver_return_value_t;
 
void rstransceiver_cfg_setup ( rstransceiver_cfg_t *cfg );
 
err_t rstransceiver_init ( rstransceiver_t *ctx, rstransceiver_cfg_t *cfg );
 
err_t rstransceiver_default_cfg ( rstransceiver_t *ctx );
 
void rstransceiver_device_enable ( rstransceiver_t *ctx );
 
void rstransceiver_device_disable ( rstransceiver_t *ctx );
 
void rstransceiver_set_slew ( rstransceiver_t *ctx, uint8_t slew );
 
void rstransceiver_set_rts ( rstransceiver_t *ctx, uint8_t rts );
 
uint8_t rstransceiver_get_cts ( rstransceiver_t *ctx );
 
err_t rstransceiver_set_op_mode ( rstransceiver_t *ctx, uint8_t op_mode );
 
err_t rstransceiver_mode_loopback ( rstransceiver_t *ctx );
 
err_t rstransceiver_mode_rs232 ( rstransceiver_t *ctx, uint8_t slew );
 
err_t rstransceiver_mode_half_duplex ( rstransceiver_t *ctx, uint8_t slew, uint8_t dir1, uint8_t term );
 
err_t rstransceiver_mode_full_duplex ( rstransceiver_t *ctx, uint8_t slew, uint8_t dir1, uint8_t term );
 
err_t rstransceiver_set_dir1 ( rstransceiver_t *ctx, uint8_t dir1 );
 
err_t rstransceiver_term_enable ( rstransceiver_t *ctx );
 
err_t rstransceiver_term_disable ( rstransceiver_t *ctx );
 
err_t rstransceiver_generic_write ( rstransceiver_t *ctx, char *data_in, uint16_t len );
 
err_t rstransceiver_generic_read ( rstransceiver_t *ctx, char *data_out, uint16_t len );
 
#ifdef __cplusplus
}
#endif
#endif // RSTRANSCEIVER_H
 
 // rstransceiver
 
// ------------------------------------------------------------------------ END