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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define MONARCHADAPTER_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
55  cfg.rng = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
59 
65 #define MONARCHADAPTER_RETVAL uint8_t
66 
67 #define MONARCHADAPTER_OK 0x00
68 #define MONARCHADAPTER_INIT_ERROR 0xFF
69 
75 #define DRV_RX_BUFFER_SIZE 600
76 #define DRV_TX_BUFFER_SIZE 100
77  // End group macro
80 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90  // Output pins
91 
92  digital_out_t rst;
93  digital_out_t rts;
94 
95  // Input pins
96 
97  digital_in_t rng;
98  digital_in_t int_pin;
99 
100  // Modules
101 
102  uart_t uart;
103 
104  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
105  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
106 
108 
112 typedef struct
113 {
114  // Communication gpio pins
115 
116  pin_name_t rx_pin;
117  pin_name_t tx_pin;
118 
119  // Additional gpio pins
120 
121  pin_name_t rng;
122  pin_name_t rst;
123  pin_name_t rts;
124  pin_name_t int_pin;
125 
126  // static variable
127 
128  uint32_t baud_rate; // Clock speed.
130  uart_data_bits_t data_bit; // Data bits.
131  uart_parity_t parity_bit; // Parity bit.
132  uart_stop_bits_t stop_bit; // Stop bits.
133 
135 
139 typedef uint8_t monarchadapter_error_t;
140  // End types group
142 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
143 
149 #ifdef __cplusplus
150 extern "C"{
151 #endif
152 
162 
171 
180 
187 void monarchadapter_set_rst_pin ( monarchadapter_t *ctx, uint8_t state );
188 
195 void monarchadapter_set_rts_pin ( monarchadapter_t *ctx, uint8_t state );
196 
205 
214 
221 void monarchadapter_generic_write ( monarchadapter_t *ctx, char *data_buf, uint16_t len );
222 
230 int32_t monarchadapter_generic_read ( monarchadapter_t *ctx, char *data_buf, uint16_t max_len );
231 
238 void monarchadapter_send_command ( monarchadapter_t *ctx, char *command );
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 #endif // _MONARCHADAPTER_H_
244  // End public_function group
247 
248 // ------------------------------------------------------------------------- END
monarchadapter_cfg_t::rts
pin_name_t rts
Definition: monarchadapter.h:123
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: monarchadapter.h:75
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:116
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:92
monarchadapter_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: monarchadapter.h:131
monarchadapter_cfg_t
Click configuration structure definition.
Definition: monarchadapter.h:112
monarchadapter_cfg_setup
void monarchadapter_cfg_setup(monarchadapter_cfg_t *cfg)
Config Object Initialization function.
monarchadapter_t
Click ctx object definition.
Definition: monarchadapter.h:88
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:98
monarchadapter_t::uart
uart_t uart
Definition: monarchadapter.h:102
monarchadapter_t::rng
digital_in_t rng
Definition: monarchadapter.h:97
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:139
monarchadapter_cfg_t::rng
pin_name_t rng
Definition: monarchadapter.h:121
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:93
monarchadapter_cfg_t::baud_rate
uint32_t baud_rate
Definition: monarchadapter.h:128
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:124
monarchadapter_cfg_t::rst
pin_name_t rst
Definition: monarchadapter.h:122
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: monarchadapter.h:76
MONARCHADAPTER_RETVAL
#define MONARCHADAPTER_RETVAL
Definition: monarchadapter.h:65
monarchadapter_cfg_t::uart_blocking
bool uart_blocking
Definition: monarchadapter.h:129
monarchadapter_cfg_t::tx_pin
pin_name_t tx_pin
Definition: monarchadapter.h:117
monarchadapter_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: monarchadapter.h:132
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:130
monarchadapter_power_on
void monarchadapter_power_on(monarchadapter_t *ctx)
Monarch Adapter power on.