barcode2  2.0.0.0
barcode2.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef BARCODE2_H
36 #define BARCODE2_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define BARCODE2_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
65  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
66  cfg.trg = MIKROBUS( mikrobus, MIKROBUS_PWM )
67 
73 #define BARCODE2_RETVAL uint8_t
74 
75 #define BARCODE2_OK 0x00
76 #define BARCODE2_INIT_ERROR 0xFF
77 
83 #define BARCODE2_DISABLE 0x01
84 #define BARCODE2_ENABLE 0x00
85 
91 #define DRV_RX_BUFFER_SIZE 600
92 #define DRV_TX_BUFFER_SIZE 50
93  // End group macro
96 // --------------------------------------------------------------- PUBLIC TYPES
104 typedef struct
105 {
106  // Output pins
107 
108  digital_out_t rst;
109  digital_out_t trg;
110 
111  // Modules
112 
113  uart_t uart;
114 
115  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
116  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
117 
118 } barcode2_t;
119 
123 typedef struct
124 {
125  // Communication gpio pins
126 
127  pin_name_t rx_pin;
128  pin_name_t tx_pin;
129 
130  // Additional gpio pins
131 
132  pin_name_t rst;
133  pin_name_t trg;
134 
135  // static variable
136 
137  uint32_t baud_rate; // Clock speed.
139  uart_data_bits_t data_bit; // Data bits.
140  uart_parity_t parity_bit; // Parity bit.
141  uart_stop_bits_t stop_bit; // Stop bits.
142 
144 
148 typedef uint8_t barcode2_error_t;
149  // End types group
151 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
152 
158 #ifdef __cplusplus
159 extern "C"{
160 #endif
161 
171 
181 
191 void barcode2_generic_write ( barcode2_t *ctx, char *data_buf, uint16_t len );
192 
203 int32_t barcode2_generic_read ( barcode2_t *ctx, char *data_buf, uint16_t max_len );
204 
218 void barcode2_enable_scaning ( barcode2_t *ctx, uint8_t en_state );
219 
233 void barcode2_enable_reset ( barcode2_t *ctx, uint8_t en_state );
234 
235 
236 #ifdef __cplusplus
237 }
238 #endif
239 #endif // _BARCODE2_H_
240  // End public_function group
243 
244 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: barcode2.h:91
barcode2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: barcode2.h:141
barcode2_generic_write
void barcode2_generic_write(barcode2_t *ctx, char *data_buf, uint16_t len)
Generic write function.
barcode2_t
Click ctx object definition.
Definition: barcode2.h:105
barcode2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: barcode2.h:139
barcode2_cfg_t
Click configuration structure definition.
Definition: barcode2.h:124
barcode2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: barcode2.h:140
BARCODE2_RETVAL
#define BARCODE2_RETVAL
Definition: barcode2.h:73
barcode2_cfg_t::trg
pin_name_t trg
Definition: barcode2.h:133
barcode2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: barcode2.h:128
barcode2_init
BARCODE2_RETVAL barcode2_init(barcode2_t *ctx, barcode2_cfg_t *cfg)
Initialization function.
barcode2_t::trg
digital_out_t trg
Definition: barcode2.h:109
barcode2_t::rst
digital_out_t rst
Definition: barcode2.h:108
barcode2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: barcode2.h:127
barcode2_cfg_setup
void barcode2_cfg_setup(barcode2_cfg_t *cfg)
Config Object Initialization function.
barcode2_cfg_t::rst
pin_name_t rst
Definition: barcode2.h:132
barcode2_cfg_t::baud_rate
uint32_t baud_rate
Definition: barcode2.h:137
barcode2_cfg_t::uart_blocking
bool uart_blocking
Definition: barcode2.h:138
barcode2_enable_reset
void barcode2_enable_reset(barcode2_t *ctx, uint8_t en_state)
Enable reset function.
barcode2_t::uart
uart_t uart
Definition: barcode2.h:113
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: barcode2.h:92
barcode2_error_t
uint8_t barcode2_error_t
Error type.
Definition: barcode2.h:148
barcode2_generic_read
int32_t barcode2_generic_read(barcode2_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
barcode2_enable_scaning
void barcode2_enable_scaning(barcode2_t *ctx, uint8_t en_state)
Enable scaning function.