c3gsara  2.0.0.0
c3gsara.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 C3GSARA_H
36 #define C3GSARA_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 C3GSARA_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
55  cfg.stat = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define C3GSARA_RETVAL uint8_t
67 
68 #define C3GSARA_OK 0x00
69 #define C3GSARA_INIT_ERROR 0xFF
70 
76 #define DRV_RX_BUFFER_SIZE 500
77  // End group macro
80 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90  // Output pins
91 
92  digital_out_t pwr;
93  digital_out_t rts;
94 
95  // Input pins
96 
97  digital_in_t stat;
98  digital_in_t ri;
99  digital_in_t cts;
100 
101  // Modules
102 
103  uart_t uart;
104 
105  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
106  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
107 
108 } c3gsara_t;
109 
113 typedef struct
114 {
115  // Communication gpio pins
116 
117  pin_name_t rx_pin;
118  pin_name_t tx_pin;
119 
120  // Additional gpio pins
121 
122  pin_name_t stat;
123  pin_name_t pwr;
124  pin_name_t rts;
125  pin_name_t ri;
126  pin_name_t cts;
127 
128  // static variable
129 
130  uint32_t baud_rate; // Clock speed.
132  uart_data_bits_t data_bit; // Data bits.
133  uart_parity_t parity_bit; // Parity bit.
134  uart_stop_bits_t stop_bit; // Stop bits.
135 
136 } c3gsara_cfg_t;
137 
141 typedef uint8_t c3gsara_error_t;
142  // End types group
144 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
145 
151 #ifdef __cplusplus
152 extern "C"{
153 #endif
154 
163 void c3gsara_cfg_setup ( c3gsara_cfg_t *cfg );
164 
173 
180 void c3gsara_module_power( c3gsara_t *ctx, uint8_t power_state );
181 
188 void c3gsara_generic_write ( c3gsara_t *ctx, char *data_buf, uint16_t len );
189 
197 int32_t c3gsara_generic_read ( c3gsara_t *ctx, char *data_buf, uint16_t max_len );
198 
205 void c3gsara_send_command ( c3gsara_t *ctx, char *command );
206 
207 #ifdef __cplusplus
208 }
209 #endif
210 #endif // _C3GSARA_H_
211  // End public_function group
214 
215 // ------------------------------------------------------------------------- END
digital_in_t cts
Definition: c3gsara.h:99
void c3gsara_module_power(c3gsara_t *ctx, uint8_t power_state)
Power module.
pin_name_t rx_pin
Definition: c3gsara.h:117
Click configuration structure definition.
Definition: c3gsara.h:113
uart_parity_t parity_bit
Definition: c3gsara.h:133
digital_in_t stat
Definition: c3gsara.h:97
void c3gsara_generic_write(c3gsara_t *ctx, char *data_buf, uint16_t len)
Generic write function.
uart_data_bits_t data_bit
Definition: c3gsara.h:132
pin_name_t pwr
Definition: c3gsara.h:123
pin_name_t rts
Definition: c3gsara.h:124
uint32_t baud_rate
Definition: c3gsara.h:130
digital_in_t ri
Definition: c3gsara.h:98
#define DRV_RX_BUFFER_SIZE
Definition: c3gsara.h:76
pin_name_t ri
Definition: c3gsara.h:125
pin_name_t tx_pin
Definition: c3gsara.h:118
digital_out_t pwr
Definition: c3gsara.h:92
#define C3GSARA_RETVAL
Definition: c3gsara.h:66
uart_t uart
Definition: c3gsara.h:103
pin_name_t cts
Definition: c3gsara.h:126
C3GSARA_RETVAL c3gsara_init(c3gsara_t *ctx, c3gsara_cfg_t *cfg)
Initialization function.
int32_t c3gsara_generic_read(c3gsara_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
pin_name_t stat
Definition: c3gsara.h:122
bool uart_blocking
Definition: c3gsara.h:131
digital_out_t rts
Definition: c3gsara.h:93
void c3gsara_cfg_setup(c3gsara_cfg_t *cfg)
Config Object Initialization function.
uart_stop_bits_t stop_bit
Definition: c3gsara.h:134
uint8_t c3gsara_error_t
Error type.
Definition: c3gsara.h:141
Click ctx object definition.
Definition: c3gsara.h:88
void c3gsara_send_command(c3gsara_t *ctx, char *command)
Send command.