ata663254  2.0.0.0
ata663254.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 ATA663254_H
36 #define ATA663254_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 ATA663254_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );
58 
64 #define ATA663254_RETVAL uint8_t
65 
66 #define ATA663254_OK 0x00
67 #define ATA663254_INIT_ERROR 0xFF
68 
74 #define DRV_RX_BUFFER_SIZE 500
75  // End group macro
78 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90  // Output pins
91  digital_out_t en;
92 
93  // Input pins
94  digital_in_t rst;
95 
96  // Modules
97 
98  uart_t uart;
99 
100  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
101  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
102 
103 } ata663254_t;
104 
108 typedef struct
109 {
110  // Communication gpio pins
111 
112  pin_name_t rx_pin;
113  pin_name_t tx_pin;
114 
115  // Additional gpio pins
116 
117  //pin_name_t an;
118  pin_name_t rst;
119  pin_name_t en;
120 
121  // static variable
122 
123  uint32_t baud_rate; // Clock speed.
125  uart_data_bits_t data_bit; // Data bits.
126  uart_parity_t parity_bit; // Parity bit.
127  uart_stop_bits_t stop_bit; // Stop bits.
128 
130  // End types group
132 // ------------------------------------------------------------------ CONSTANTS // End constants group
141 // ------------------------------------------------------------------ VARIABLES // End variable group
149 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
150 
156 #ifdef __cplusplus
157 extern "C"{
158 #endif
159 
169 
178 
188 void ata663254_generic_write ( ata663254_t *ctx, char *data_buf, uint16_t len );
189 
199 int32_t ata663254_generic_read ( ata663254_t *ctx, char *data_buf, uint16_t len );
200 
209 void ata663254_enable ( ata663254_t *ctx, uint8_t state );
210 
220 uint8_t ata663254_get_rst_state ( ata663254_t *ctx );
221 
222 #ifdef __cplusplus
223 }
224 #endif
225 #endif // _ATA663254_H_
226  // End public_function group
229 
230 // ------------------------------------------------------------------------- END
ata663254_cfg_t::baud_rate
uint32_t baud_rate
Definition: ata663254.h:123
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: ata663254.h:74
ata663254_get_rst_state
uint8_t ata663254_get_rst_state(ata663254_t *ctx)
Undervoltage detect function.
ata663254_t::en
digital_out_t en
Definition: ata663254.h:91
ata663254_t::uart
uart_t uart
Definition: ata663254.h:98
ata663254_generic_write
void ata663254_generic_write(ata663254_t *ctx, char *data_buf, uint16_t len)
Generic multi write function.
cfg
ata663254_cfg_setup & cfg
Definition: main.c:58
ata663254_generic_read
int32_t ata663254_generic_read(ata663254_t *ctx, char *data_buf, uint16_t len)
Generic multi read function.
ata663254_cfg_t::en
pin_name_t en
Definition: ata663254.h:119
ata663254_enable
void ata663254_enable(ata663254_t *ctx, uint8_t state)
Chip enable function.
ata663254_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ata663254.h:112
ATA663254_RETVAL
#define ATA663254_RETVAL
Definition: ata663254.h:64
ata663254_t
Click ctx object definition.
Definition: ata663254.h:88
ata663254_cfg_t::rst
pin_name_t rst
Definition: ata663254.h:118
ata663254_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ata663254.h:127
ata663254_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ata663254.h:125
ata663254_cfg_t
Click configuration structure definition.
Definition: ata663254.h:108
ata663254_cfg_t::uart_blocking
bool uart_blocking
Definition: ata663254.h:124
ata663254_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ata663254.h:126
ata663254_t::rst
digital_in_t rst
Definition: ata663254.h:94
ata663254_cfg_setup
void ata663254_cfg_setup(ata663254_cfg_t *cfg)
Config Object Initialization function.
ata663254_init
ATA663254_RETVAL ata663254_init(ata663254_t *ctx, ata663254_cfg_t *cfg)
Initialization function.
ata663254_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ata663254.h:113