irda2  2.0.0.0
irda2.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 IRDA2_H
29 #define IRDA2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
70 #define IRDA2_TX_DRV_BUFFER_SIZE 100
71 #define IRDA2_RX_DRV_BUFFER_SIZE 300
72  // irda2_set
74 
89 #define IRDA2_MAP_MIKROBUS( cfg, mikrobus ) \
90  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
91  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
92  cfg.mod = MIKROBUS( mikrobus, MIKROBUS_AN ); \
93  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
94  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
95 
96  // irda2_map // irda2
98 
103 typedef struct
104 {
105  // Output pins
106  digital_out_t mod;
107  digital_out_t rst;
108  digital_out_t en;
110  // Modules
111  uart_t uart;
113  // Buffers
114  uint8_t uart_rx_buffer[ IRDA2_RX_DRV_BUFFER_SIZE ];
115  uint8_t uart_tx_buffer[ IRDA2_TX_DRV_BUFFER_SIZE ];
117 } irda2_t;
118 
123 typedef struct
124 {
125  // Communication gpio pins
126  pin_name_t rx_pin;
127  pin_name_t tx_pin;
129  // Additional gpio pins
130  pin_name_t mod;
131  pin_name_t rst;
132  pin_name_t en;
134  // Static variable
135  uint32_t baud_rate;
137  uart_data_bits_t data_bit;
138  uart_parity_t parity_bit;
139  uart_stop_bits_t stop_bit;
141 } irda2_cfg_t;
142 
147 typedef enum
148 {
149  IRDA2_OK = 0,
150  IRDA2_ERROR = -1
151 
153 
157 typedef enum
158 {
161 
163 
167 typedef enum
168 {
171 
173 
190 
204 err_t irda2_init ( irda2_t *ctx, irda2_cfg_t *cfg );
205 
219 
230 
240 void irda2_pwr_setup( irda2_t *ctx, irda2_pwr_t state );
241 
250 void irda2_reset( irda2_t *ctx );
251 
264 err_t irda2_generic_write ( irda2_t *ctx, uint8_t *data_in, uint16_t len );
265 
278 err_t irda2_generic_read ( irda2_t *ctx, uint8_t *data_out, uint16_t len );
279 
280 #ifdef __cplusplus
281 }
282 #endif
283 #endif // IRDA2_H
284  // irda2
286 
287 // ------------------------------------------------------------------------ END
irda2_mode_t
irda2_mode_t
Click mode settings.
Definition: irda2.h:158
irda2_reset
void irda2_reset(irda2_t *ctx)
Reset function.
irda2_init
err_t irda2_init(irda2_t *ctx, irda2_cfg_t *cfg)
IrDA 2 initialization function.
irda2_pwr_t
irda2_pwr_t
Click power mode settings.
Definition: irda2.h:168
irda2_generic_write
err_t irda2_generic_write(irda2_t *ctx, uint8_t *data_in, uint16_t len)
IrDA 2 data writing function.
IRDA2_PWR_ON
@ IRDA2_PWR_ON
Definition: irda2.h:170
irda2_return_value_t
irda2_return_value_t
IrDA 2 Click return value data.
Definition: irda2.h:148
irda2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: irda2.h:139
IRDA2_ERROR
@ IRDA2_ERROR
Definition: irda2.h:150
irda2_cfg_t::rst
pin_name_t rst
Definition: irda2.h:131
irda2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: irda2.h:138
irda2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: irda2.h:137
IRDA2_RX_DRV_BUFFER_SIZE
#define IRDA2_RX_DRV_BUFFER_SIZE
Definition: irda2.h:71
irda2_t::rst
digital_out_t rst
Definition: irda2.h:107
IRDA2_TX_DRV_BUFFER_SIZE
#define IRDA2_TX_DRV_BUFFER_SIZE
IrDA 2 driver buffer size.
Definition: irda2.h:70
irda2_mode_setup
void irda2_mode_setup(irda2_t *ctx, irda2_mode_t state)
Mode Setup function.
IRDA2_MODE_CMD
@ IRDA2_MODE_CMD
Definition: irda2.h:159
irda2_default_cfg
void irda2_default_cfg(irda2_t *ctx)
IrDA 2 default configuration function.
irda2_t::mod
digital_out_t mod
Definition: irda2.h:106
irda2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: irda2.h:127
irda2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: irda2.h:126
irda2_cfg_t::mod
pin_name_t mod
Definition: irda2.h:130
irda2_t::uart
uart_t uart
Definition: irda2.h:111
irda2_t
IrDA 2 Click context object.
Definition: irda2.h:104
irda2_cfg_t::uart_blocking
bool uart_blocking
Definition: irda2.h:136
irda2_cfg_setup
void irda2_cfg_setup(irda2_cfg_t *cfg)
IrDA 2 configuration object setup function.
IRDA2_OK
@ IRDA2_OK
Definition: irda2.h:149
irda2_cfg_t
IrDA 2 Click configuration object.
Definition: irda2.h:124
irda2_cfg_t::en
pin_name_t en
Definition: irda2.h:132
IRDA2_MODE_DATA
@ IRDA2_MODE_DATA
Definition: irda2.h:160
irda2_generic_read
err_t irda2_generic_read(irda2_t *ctx, uint8_t *data_out, uint16_t len)
IrDA 2 data reading function.
IRDA2_PWR_OFF
@ IRDA2_PWR_OFF
Definition: irda2.h:169
irda2_t::en
digital_out_t en
Definition: irda2.h:108
irda2_cfg_t::baud_rate
uint32_t baud_rate
Definition: irda2.h:135
irda2_pwr_setup
void irda2_pwr_setup(irda2_t *ctx, irda2_pwr_t state)
Power Setup function.