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 
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 ATA663254_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
69  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
70  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );
72 
78 #define ATA663254_RETVAL uint8_t
79 
80 #define ATA663254_OK 0x00
81 #define ATA663254_INIT_ERROR 0xFF
82 
88 #define DRV_RX_BUFFER_SIZE 500
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 rst;
109 
110  // Modules
111 
112  uart_t uart;
113 
114  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
115  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
116 
117 } ata663254_t;
118 
122 typedef struct
123 {
124  // Communication gpio pins
125 
126  pin_name_t rx_pin;
127  pin_name_t tx_pin;
128 
129  // Additional gpio pins
130 
131  //pin_name_t an;
132  pin_name_t rst;
133  pin_name_t en;
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  // End types group
146 // ------------------------------------------------------------------ CONSTANTS // End constants group
155 // ------------------------------------------------------------------ VARIABLES // End variable group
163 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
164 
170 #ifdef __cplusplus
171 extern "C"{
172 #endif
173 
183 
192 
202 void ata663254_generic_write ( ata663254_t *ctx, char *data_buf, uint16_t len );
203 
213 int32_t ata663254_generic_read ( ata663254_t *ctx, char *data_buf, uint16_t len );
214 
223 void ata663254_enable ( ata663254_t *ctx, uint8_t state );
224 
235 
236 #ifdef __cplusplus
237 }
238 #endif
239 #endif // _ATA663254_H_
240  // End public_function group
243 
244 // ------------------------------------------------------------------------- END
ata663254_cfg_t::baud_rate
uint32_t baud_rate
Definition: ata663254.h:137
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: ata663254.h:88
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:105
ata663254_t::uart
uart_t uart
Definition: ata663254.h:112
ata663254_generic_write
void ata663254_generic_write(ata663254_t *ctx, char *data_buf, uint16_t len)
Generic multi write function.
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:133
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:126
ATA663254_RETVAL
#define ATA663254_RETVAL
Definition: ata663254.h:78
ata663254_t
Click ctx object definition.
Definition: ata663254.h:103
ata663254_cfg_t::rst
pin_name_t rst
Definition: ata663254.h:132
ata663254_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ata663254.h:141
ata663254_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ata663254.h:139
ata663254_cfg_t
Click configuration structure definition.
Definition: ata663254.h:123
ata663254_cfg_t::uart_blocking
bool uart_blocking
Definition: ata663254.h:138
ata663254_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ata663254.h:140
ata663254_t::rst
digital_in_t rst
Definition: ata663254.h:108
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:127