monarchadapter  2.0.0.0
monarchadapter.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 MONARCHADAPTER_H
36 #define MONARCHADAPTER_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 MONARCHADAPTER_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
65  cfg.rng = MIKROBUS( mikrobus, MIKROBUS_AN ); \
66  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
69 
75 #define MONARCHADAPTER_RETVAL uint8_t
76 
77 #define MONARCHADAPTER_OK 0x00
78 #define MONARCHADAPTER_INIT_ERROR 0xFF
79 
85 #define DRV_RX_BUFFER_SIZE 600
86 #define DRV_TX_BUFFER_SIZE 100
87  // End group macro
90 // --------------------------------------------------------------- PUBLIC TYPES
98 typedef struct
99 {
100  // Output pins
101 
102  digital_out_t rst;
103  digital_out_t rts;
104 
105  // Input pins
106 
107  digital_in_t rng;
108  digital_in_t int_pin;
109 
110  // Modules
111 
112  uart_t uart;
113 
114  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
115  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
116 
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 rng;
132  pin_name_t rst;
133  pin_name_t rts;
134  pin_name_t int_pin;
135 
136  // static variable
137 
138  uint32_t baud_rate; // Clock speed.
140  uart_data_bits_t data_bit; // Data bits.
141  uart_parity_t parity_bit; // Parity bit.
142  uart_stop_bits_t stop_bit; // Stop bits.
143 
145 
149 typedef uint8_t monarchadapter_error_t;
150  // End types group
152 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
153 
159 #ifdef __cplusplus
160 extern "C"{
161 #endif
162 
172 
181 
190 
197 void monarchadapter_set_rst_pin ( monarchadapter_t *ctx, uint8_t state );
198 
205 void monarchadapter_set_rts_pin ( monarchadapter_t *ctx, uint8_t state );
206 
215 
224 
231 void monarchadapter_generic_write ( monarchadapter_t *ctx, char *data_buf, uint16_t len );
232 
240 int32_t monarchadapter_generic_read ( monarchadapter_t *ctx, char *data_buf, uint16_t max_len );
241 
248 void monarchadapter_send_command ( monarchadapter_t *ctx, char *command );
249 
250 #ifdef __cplusplus
251 }
252 #endif
253 #endif // _MONARCHADAPTER_H_
254  // End public_function group
257 
258 // ------------------------------------------------------------------------- END
monarchadapter_cfg_t::rts
pin_name_t rts
Definition: monarchadapter.h:133
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: monarchadapter.h:85
monarchadapter_get_int_pin
uint8_t monarchadapter_get_int_pin(monarchadapter_t *ctx)
Get INT pin state.
monarchadapter_cfg_t::rx_pin
pin_name_t rx_pin
Definition: monarchadapter.h:126
monarchadapter_generic_write
void monarchadapter_generic_write(monarchadapter_t *ctx, char *data_buf, uint16_t len)
Generic write function.
monarchadapter_send_command
void monarchadapter_send_command(monarchadapter_t *ctx, char *command)
Function for send command.
monarchadapter_t::rst
digital_out_t rst
Definition: monarchadapter.h:102
monarchadapter_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: monarchadapter.h:141
monarchadapter_cfg_t
Click configuration structure definition.
Definition: monarchadapter.h:123
monarchadapter_cfg_setup
void monarchadapter_cfg_setup(monarchadapter_cfg_t *cfg)
Config Object Initialization function.
monarchadapter_t
Click ctx object definition.
Definition: monarchadapter.h:99
monarchadapter_generic_read
int32_t monarchadapter_generic_read(monarchadapter_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
monarchadapter_t::int_pin
digital_in_t int_pin
Definition: monarchadapter.h:108
monarchadapter_t::uart
uart_t uart
Definition: monarchadapter.h:112
monarchadapter_t::rng
digital_in_t rng
Definition: monarchadapter.h:107
monarchadapter_get_rng_pin
uint8_t monarchadapter_get_rng_pin(monarchadapter_t *ctx)
Get RNG ( an ) pin state.
monarchadapter_error_t
uint8_t monarchadapter_error_t
Error type.
Definition: monarchadapter.h:149
monarchadapter_cfg_t::rng
pin_name_t rng
Definition: monarchadapter.h:131
monarchadapter_init
MONARCHADAPTER_RETVAL monarchadapter_init(monarchadapter_t *ctx, monarchadapter_cfg_t *cfg)
Initialization function.
monarchadapter_t::rts
digital_out_t rts
Definition: monarchadapter.h:103
monarchadapter_cfg_t::baud_rate
uint32_t baud_rate
Definition: monarchadapter.h:138
monarchadapter_set_rst_pin
void monarchadapter_set_rst_pin(monarchadapter_t *ctx, uint8_t state)
Set RST ( reset ) pin state.
monarchadapter_cfg_t::int_pin
pin_name_t int_pin
Definition: monarchadapter.h:134
monarchadapter_cfg_t::rst
pin_name_t rst
Definition: monarchadapter.h:132
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: monarchadapter.h:86
MONARCHADAPTER_RETVAL
#define MONARCHADAPTER_RETVAL
Definition: monarchadapter.h:75
monarchadapter_cfg_t::uart_blocking
bool uart_blocking
Definition: monarchadapter.h:139
monarchadapter_cfg_t::tx_pin
pin_name_t tx_pin
Definition: monarchadapter.h:127
monarchadapter_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: monarchadapter.h:142
monarchadapter_set_rts_pin
void monarchadapter_set_rts_pin(monarchadapter_t *ctx, uint8_t state)
Set RTS ( cs ) pin state.
monarchadapter_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: monarchadapter.h:140
monarchadapter_power_on
void monarchadapter_power_on(monarchadapter_t *ctx)
Monarch Adapter power on.