uartmux2.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 UARTMUX2_H
#define UARTMUX2_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"
 
// TODO -- dodati makroe koji definisu adrese registara
 
 // uartmux2_reg
 
#define DRV_BUFFER_SIZE              200
 
 // uartmux2_set
 
#define UARTMUX2_SUCCESS               0
#define UARTMUX2_ERROR                -1
 
 
 // status
 
#define UARTMUX2_OP_MODE_NORMAL        0x00
#define UARTMUX2_OP_MODE_POWER_DOWN    0x01
 
 
 // op_mode
 
#define UARTMUX2_CHANNEL_0            0
#define UARTMUX2_CHANNEL_1            1
#define UARTMUX2_CHANNEL_2            2
#define UARTMUX2_CHANNEL_3            3
 
 
 // mux_ch
 
#define UARTMUX2_MAP_MIKROBUS( cfg, mikrobus )       \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.off = MIKROBUS( mikrobus, MIKROBUS_AN );     \
    cfg.a1 = MIKROBUS( mikrobus, MIKROBUS_RST );     \
    cfg.a0 = MIKROBUS( mikrobus, MIKROBUS_CS );      \
    cfg.on = MIKROBUS( mikrobus, MIKROBUS_PWM );     \
    cfg.inv = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // uartmux2_map
 // uartmux2
 
typedef struct
{
    // Output pins
 
    digital_out_t off;    
    digital_out_t a1;     
    digital_out_t a0;     
    digital_out_t on;     
    // Input pins
 
    digital_in_t inv;       
    // Modules
 
    uart_t uart;                                    
    // Buffers
 
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];         
} uartmux2_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // Additional gpio pins
 
    pin_name_t off;       
    pin_name_t a1;        
    pin_name_t a0;        
    pin_name_t on;        
    pin_name_t inv;       
    // 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;                         
} uartmux2_cfg_t;
 
void uartmux2_cfg_setup ( uartmux2_cfg_t *cfg );
 
err_t uartmux2_init ( uartmux2_t *ctx, uartmux2_cfg_t *cfg );
 
void uartmux2_default_cfg ( uartmux2_t *ctx );
 
err_t uartmux2_generic_write ( uartmux2_t *ctx, char *data_buf, uint16_t len );
 
err_t uartmux2_generic_read ( uartmux2_t *ctx, char *data_buf, uint16_t max_len );
 
err_t uartmux2_set_operation_mode ( uartmux2_t *ctx, uint8_t op_mode );
 
err_t uartmux2_set_channel ( uartmux2_t *ctx, uint8_t mux_ch );
 
err_t uartmux2_send_data ( uartmux2_t *ctx, char *tx_data );
 
uint8_t uartmux2_get_inv_status ( uartmux2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // UARTMUX2_H
 
 // uartmux2
 
// ------------------------------------------------------------------------ END