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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define ATA663211_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.inh = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
58 
65 #define ATA663211_RETVAL uint8_t
66 
67 #define ATA663211_OK 0x00
68 #define ATA663211_INIT_ERROR 0xFF
69 
75 #define DRV_RX_BUFFER_SIZE 500
76  // End group macro
79 // --------------------------------------------------------------- PUBLIC TYPES
89 typedef struct
90 {
91  // Output pins
92 
93  digital_out_t en;
94 
95  // Input pins
96 
97  digital_in_t inh;
98 
99  // Modules
100 
101  uart_t uart;
102 
103  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
104  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
105 
106 } ata663211_t;
107 
111 typedef struct
112 {
113  // Communication gpio pins
114 
115  pin_name_t rx_pin;
116  pin_name_t tx_pin;
117 
118  // Additional gpio pins
119 
120  pin_name_t inh;
121  pin_name_t en;
122 
123 
124  // static variable
125 
126  uint32_t baud_rate; // Clock speed.
128  uart_data_bits_t data_bit; // Data bits.
129  uart_parity_t parity_bit; // Parity bit.
130  uart_stop_bits_t stop_bit; // Stop bits.
131 
133  // End types group
135 
136 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
137 
143 #ifdef __cplusplus
144 extern "C"{
145 #endif
146 
156 
165 
175 void ata663211_generic_multi_write ( ata663211_t *ctx, char *data_buf, uint8_t len );
176 
186 void ata663211_generic_multi_read ( ata663211_t *ctx, char *data_buf, uint8_t len );
187 
188 
198 
207 void ata663211_generic_single_write ( ata663211_t *ctx, char tx_data );
208 
217 
225 void ata663211_sleep_mode ( ata663211_t *ctx );
226 
236 uint8_t ata663211_check_inh ( ata663211_t *ctx );
237 
238 #ifdef __cplusplus
239 }
240 #endif
241 #endif // _ATA663211_H_
242  // End public_function group
245 
246 // ------------------------------------------------------------------------- END
ata663211_t
Click ctx object definition.
Definition: ata663211.h:89
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: ata663211.h:75
ata663211_generic_multi_read
void ata663211_generic_multi_read(ata663211_t *ctx, char *data_buf, uint8_t len)
Generic multi read function.
ata663211_generic_multi_write
void ata663211_generic_multi_write(ata663211_t *ctx, char *data_buf, uint8_t len)
Generic multi write function.
ata663211_cfg_t::baud_rate
uint32_t baud_rate
Definition: ata663211.h:126
ata663211_t::inh
digital_in_t inh
Definition: ata663211.h:97
ata663211_cfg_t
Click configuration structure definition.
Definition: ata663211.h:111
ata663211_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ata663211.h:129
ata663211_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ata663211.h:130
ata663211_generic_single_read
char ata663211_generic_single_read(ata663211_t *ctx)
Generic single read function.
ATA663211_RETVAL
#define ATA663211_RETVAL
Definition: ata663211.h:65
ata663211_generic_single_write
void ata663211_generic_single_write(ata663211_t *ctx, char tx_data)
Generic single write function.
ata663211_cfg_t::en
pin_name_t en
Definition: ata663211.h:121
ata663211_cfg_t::uart_blocking
bool uart_blocking
Definition: ata663211.h:127
ata663211_init
ATA663211_RETVAL ata663211_init(ata663211_t *ctx, ata663211_cfg_t *cfg)
Initialization function.
ata663211_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ata663211.h:116
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:115
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:93
ata663211_t::uart
uart_t uart
Definition: ata663211.h:101
ata663211_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ata663211.h:128
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:120