irda3 2.0.0.0
irda3.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef IRDA3_H
29#define IRDA3_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_uart.h"
38
60#define DRV_BUFFER_SIZE 500
61 // irda3_set
63
78#define IRDA3_MAP_MIKROBUS( cfg, mikrobus ) \
79 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
80 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
81 cfg.mod = MIKROBUS( mikrobus, MIKROBUS_AN ); \
82 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
83 cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
84 // irda3_map // irda3
87
92typedef struct
93{
94 // Output pins
95
96 digital_out_t mod;
97 digital_out_t rst;
98 digital_out_t en;
100 // Modules
101
102 uart_t uart;
104 // Buffers
105
106 char uart_rx_buffer[ DRV_BUFFER_SIZE ];
107 char uart_tx_buffer[ DRV_BUFFER_SIZE ];
109} irda3_t;
110
115typedef struct
116{
117 // Communication gpio pins
118
119 pin_name_t rx_pin;
120 pin_name_t tx_pin;
122 // Additional gpio pins
123
124 pin_name_t mod;
125 pin_name_t rst;
126 pin_name_t en;
128 // Static variable
129
130 uint32_t baud_rate;
132 uart_data_bits_t data_bit;
133 uart_parity_t parity_bit;
134 uart_stop_bits_t stop_bit;
137
142typedef enum
143{
145 IRDA3_ERROR = -1
146
148
152typedef enum
153{
156
158
162typedef enum
163{
166
168
185
200err_t irda3_init ( irda3_t *ctx, irda3_cfg_t *cfg );
201
216
227
238
248void irda3_reset( irda3_t *ctx );
249
259void irda3_generic_multiple_send( irda3_t *ctx, char *tx_data );
260
273void irda3_generic_multiple_receive( irda3_t *ctx, char *rx_data, char termination_char );
274
284void irda3_generic_single_send( irda3_t *ctx, char tx_data );
285
296#ifdef __cplusplus
297}
298#endif
299#endif // IRDA3_H
300 // irda3
#define DRV_BUFFER_SIZE
IrDA 3 driver buffer size.
Definition: irda3.h:60
void irda3_cfg_setup(irda3_cfg_t *cfg)
IrDA 3 configuration object setup function.
void irda3_generic_multiple_send(irda3_t *ctx, char *tx_data)
Generic Multiple Send function.
void irda3_mode_setup(irda3_t *ctx, irda3_mode_t state)
Mode Setup function.
void irda3_generic_single_send(irda3_t *ctx, char tx_data)
Generic Single Send function.
void irda3_default_cfg(irda3_t *ctx)
IrDA 3 default configuration function.
char irda3_generic_single_receive(irda3_t *ctx)
Generic Single Receive function.
void irda3_generic_multiple_receive(irda3_t *ctx, char *rx_data, char termination_char)
Generic Multiple Receive function.
void irda3_reset(irda3_t *ctx)
Reset function.
void irda3_pwr_setup(irda3_t *ctx, irda3_pwr_t state)
Power Setup function.
err_t irda3_init(irda3_t *ctx, irda3_cfg_t *cfg)
IrDA 3 initialization function.
irda3_mode_t
Click mode settings.
Definition: irda3.h:153
@ IRDA3_MODE_DATA
Definition: irda3.h:155
@ IRDA3_MODE_CMD
Definition: irda3.h:154
irda3_return_value_t
IrDA 3 Click return value data.
Definition: irda3.h:143
@ IRDA3_OK
Definition: irda3.h:144
@ IRDA3_ERROR
Definition: irda3.h:145
irda3_pwr_t
Click power mode settings.
Definition: irda3.h:163
@ IRDA3_PWR_ON
Definition: irda3.h:165
@ IRDA3_PWR_OFF
Definition: irda3.h:164
IrDA 3 Click configuration object.
Definition: irda3.h:116
uint32_t baud_rate
Definition: irda3.h:130
bool uart_blocking
Definition: irda3.h:131
uart_data_bits_t data_bit
Definition: irda3.h:132
pin_name_t mod
Definition: irda3.h:124
pin_name_t tx_pin
Definition: irda3.h:120
pin_name_t rx_pin
Definition: irda3.h:119
uart_stop_bits_t stop_bit
Definition: irda3.h:134
pin_name_t en
Definition: irda3.h:126
uart_parity_t parity_bit
Definition: irda3.h:133
pin_name_t rst
Definition: irda3.h:125
IrDA 3 Click context object.
Definition: irda3.h:93
digital_out_t mod
Definition: irda3.h:96
uart_t uart
Definition: irda3.h:102
digital_out_t en
Definition: irda3.h:98
digital_out_t rst
Definition: irda3.h:97