ata663211  2.0.0.0
ata663211.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 ATA663211_H
36 #define ATA663211_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_uart.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define ATA663211_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
69  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
70  cfg.inh = MIKROBUS( mikrobus, MIKROBUS_AN ); \
71  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
72 
79 #define ATA663211_OK 0
80 #define ATA663211_ERROR -1
81 
87 #define ATA663211_TX_DRV_BUFFER_SIZE 100
88 #define ATA663211_RX_DRV_BUFFER_SIZE 300
89  // End group macro
92 // --------------------------------------------------------------- PUBLIC TYPES
102 typedef struct
103 {
104  // Output pins
105  digital_out_t en;
106 
107  // Input pins
108  digital_in_t inh;
109 
110  // Modules
111  uart_t uart;
112 
113  uint8_t uart_rx_buffer[ ATA663211_RX_DRV_BUFFER_SIZE ];
114  uint8_t uart_tx_buffer[ ATA663211_TX_DRV_BUFFER_SIZE ];
115 
116 } ata663211_t;
117 
121 typedef struct
122 {
123  // Communication gpio pins
124  pin_name_t rx_pin;
125  pin_name_t tx_pin;
126 
127  // Additional gpio pins
128  pin_name_t inh;
129  pin_name_t en;
130 
131  // static variable
132  uint32_t baud_rate; // Clock speed.
134  uart_data_bits_t data_bit; // Data bits.
135  uart_parity_t parity_bit; // Parity bit.
136  uart_stop_bits_t stop_bit; // Stop bits.
137 
139  // End types group
141 
142 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
143 
149 #ifdef __cplusplus
150 extern "C"{
151 #endif
152 
162 
171 
183 err_t ata663211_generic_write ( ata663211_t *ctx, uint8_t *data_buf, uint16_t len );
184 
196 err_t ata663211_generic_read ( ata663211_t *ctx, uint8_t *data_buf, uint16_t len );
197 
206 
215 
226 
227 #ifdef __cplusplus
228 }
229 #endif
230 #endif // _ATA663211_H_
231  // End public_function group
234 
235 // ------------------------------------------------------------------------- END
ata663211_t
Click ctx object definition.
Definition: ata663211.h:103
ata663211_generic_read
err_t ata663211_generic_read(ata663211_t *ctx, uint8_t *data_buf, uint16_t len)
Generic read function.
ata663211_cfg_t::baud_rate
uint32_t baud_rate
Definition: ata663211.h:132
ata663211_t::inh
digital_in_t inh
Definition: ata663211.h:108
ata663211_cfg_t
Click configuration structure definition.
Definition: ata663211.h:122
ata663211_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ata663211.h:135
ata663211_init
err_t ata663211_init(ata663211_t *ctx, ata663211_cfg_t *cfg)
Initialization function.
ata663211_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ata663211.h:136
ata663211_cfg_t::en
pin_name_t en
Definition: ata663211.h:129
ATA663211_RX_DRV_BUFFER_SIZE
#define ATA663211_RX_DRV_BUFFER_SIZE
Definition: ata663211.h:88
ata663211_cfg_t::uart_blocking
bool uart_blocking
Definition: ata663211.h:133
ata663211_generic_write
err_t ata663211_generic_write(ata663211_t *ctx, uint8_t *data_buf, uint16_t len)
Generic write function.
ata663211_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ata663211.h:125
ATA663211_TX_DRV_BUFFER_SIZE
#define ATA663211_TX_DRV_BUFFER_SIZE
Definition: ata663211.h:87
ata663211_cfg_setup
void ata663211_cfg_setup(ata663211_cfg_t *cfg)
Config Object Initialization function.
ata663211_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ata663211.h:124
ata663211_sleep_mode
void ata663211_sleep_mode(ata663211_t *ctx)
Sleep mode function.
ata663211_wake_up_device
void ata663211_wake_up_device(ata663211_t *ctx)
Wake-up device function.
ata663211_t::en
digital_out_t en
Definition: ata663211.h:105
ata663211_t::uart
uart_t uart
Definition: ata663211.h:111
ata663211_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ata663211.h:134
ata663211_check_inh
uint8_t ata663211_check_inh(ata663211_t *ctx)
Check inhibit pin state function.
ata663211_cfg_t::inh
pin_name_t inh
Definition: ata663211.h:128