irda4 2.1.0.0
irda4.h File Reference

This file contains API for IrDA 4 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  irda4_t
 IrDA 4 Click context object. More...
 
struct  irda4_cfg_t
 IrDA 4 Click configuration object. More...
 

Macros

#define IRDA4_SHUTDOWN_DISABLED   0x00
 IrDA 4 control commands.
 
#define IRDA4_SHUTDOWN_ENABLED   0x01
 
#define IRDA4_RESET_DISABLED   0x00
 IrDA 4 reset pin state commands.
 
#define IRDA4_RESET_ENABLED   0x01
 
#define IRDA4_DRV_BUFFER_SIZE   300
 IrDA 4 driver buffer size.
 
#define IRDA4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  irda4_return_value_t { IRDA4_OK = 0 , IRDA4_ERROR = -1 }
 IrDA 4 Click return value data. More...
 

Functions

void irda4_cfg_setup (irda4_cfg_t *cfg)
 IrDA 4 configuration object setup function.
 
err_t irda4_init (irda4_t *ctx, irda4_cfg_t *cfg)
 IrDA 4 initialization function.
 
err_t irda4_generic_write (irda4_t *ctx, uint8_t *data_in, uint16_t len)
 IrDA 4 data writing function.
 
err_t irda4_generic_read (irda4_t *ctx, uint8_t *data_out, uint16_t len)
 IrDA 4 data reading function.
 
void irda4_set_tx_shutdown (irda4_t *ctx, uint8_t sd_state)
 IrDA 4 TX shutdown function.
 
void irda4_set_reset_state (irda4_t *ctx, uint8_t rst_state)
 IrDA 4 set reset pin state function.
 
void irda_hw_reset (irda4_t *ctx)
 IrDA 4 hardware reset function.
 

Detailed Description

This file contains API for IrDA 4 Click Driver.

Enumeration Type Documentation

◆ irda4_return_value_t

IrDA 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
IRDA4_OK 
IRDA4_ERROR