rs4857.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 RS4857_H
#define RS4857_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_uart.h"
 
#define RS4857_TX_DRV_BUFFER_SIZE    100
#define RS4857_RX_DRV_BUFFER_SIZE    300
 
 // rs4857_cmd
 
#define RS4857_MAP_MIKROBUS( cfg, mikrobus )         \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.de = MIKROBUS( mikrobus, MIKROBUS_AN );      \
    cfg.re = MIKROBUS( mikrobus, MIKROBUS_RST );     \
    cfg.ret = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.tet = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rs4857_map
 // rs4857
 
typedef struct
{
    // Output pins
    digital_out_t de;     
    digital_out_t re;     
    digital_out_t ret;    
    digital_out_t tet;    
    // Modules
    uart_t uart;          
    // Buffers
    char uart_rx_buffer[ RS4857_RX_DRV_BUFFER_SIZE ];    
    char uart_tx_buffer[ RS4857_TX_DRV_BUFFER_SIZE ];    
} rs4857_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                 
    pin_name_t tx_pin;                 
    // Additional gpio pins
    pin_name_t de;                     
    pin_name_t re;                     
    pin_name_t ret;                    
    pin_name_t tet;                    
    // 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;         
} rs4857_cfg_t;
 
typedef enum
{
    RS4857_OK = 0,
    RS4857_ERROR = -1
 
} rs4857_return_value_t;
 
void rs4857_cfg_setup ( rs4857_cfg_t *cfg );
 
err_t rs4857_init ( rs4857_t *ctx, rs4857_cfg_t *cfg );
 
err_t rs4857_generic_write ( rs4857_t *ctx, char *data_in, uint16_t len );
 
err_t rs4857_generic_read ( rs4857_t *ctx, char *data_out, uint16_t len );
 
void rs4857_receiver_enable ( rs4857_t *ctx );
 
void rs4857_receiver_disable ( rs4857_t *ctx );
 
void rs4857_driver_enable ( rs4857_t *ctx );
 
void rs4857_driver_disable ( rs4857_t *ctx );
 
void rs4857_termination_xy_enable ( rs4857_t *ctx );
 
void rs4857_termination_xy_disable ( rs4857_t *ctx );
 
void rs4857_termination_ab_enable ( rs4857_t *ctx );
 
void rs4857_termination_ab_disable ( rs4857_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // RS4857_H
 
 // rs4857
 
// ------------------------------------------------------------------------ END