irda3.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 IRDA3_H
#define IRDA3_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 DRV_BUFFER_SIZE                       500
 
 // irda3_set
 
#define IRDA3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.mod = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
 
 // irda3_map
 // irda3
 
typedef struct
{
    // Output pins
    
    digital_out_t mod;      
    digital_out_t rst;      
    digital_out_t en;       
    // Modules
    
    uart_t uart;                                    
    // Buffers
    
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];         
} irda3_t;
 
typedef struct
{
    // Communication gpio pins
    
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // Additional gpio pins
    
    pin_name_t mod;          
    pin_name_t rst;        
    pin_name_t en;          
    // 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;                         
} irda3_cfg_t;
 
typedef enum
{
   IRDA3_OK = 0,
   IRDA3_ERROR = -1
 
} irda3_return_value_t;
 
typedef enum
{
    IRDA3_MODE_CMD = 0,
    IRDA3_MODE_DATA
 
} irda3_mode_t;
 
typedef enum
{
    IRDA3_PWR_OFF = 0,
    IRDA3_PWR_ON
 
} irda3_pwr_t;
 
void irda3_cfg_setup ( irda3_cfg_t *cfg );
 
err_t irda3_init ( irda3_t *ctx, irda3_cfg_t *cfg );
 
void irda3_default_cfg ( irda3_t *ctx );
 
void irda3_mode_setup( irda3_t *ctx, irda3_mode_t state );
 
void irda3_pwr_setup( irda3_t *ctx, irda3_pwr_t state );
 
void irda3_reset( irda3_t *ctx );
 
void irda3_generic_multiple_send( irda3_t *ctx, char *tx_data );
 
void irda3_generic_multiple_receive( irda3_t *ctx, char *rx_data, char termination_char );
 
void irda3_generic_single_send( irda3_t *ctx, char tx_data );
 
char irda3_generic_single_receive( irda3_t *ctx );
#ifdef __cplusplus
}
#endif
#endif // IRDA3_H
 
 // irda3