singlewirecan  2.0.0.0
singlewirecan.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 SINGLEWIRECAN_H
36 #define SINGLEWIRECAN_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 SINGLEWIRECAN_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.md0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.md1 = MIKROBUS( mikrobus, MIKROBUS_CS )
58 
64 #define SINGLEWIRECAN_RETVAL uint8_t
65 
66 #define SINGLEWIRECAN_OK 0x00
67 #define SINGLEWIRECAN_INIT_ERROR 0xFF
68 
74 #define SINGLEWIRECAN_OPERATING_MODE_SLEEP 0x00
75 #define SINGLEWIRECAN_OPERATING_MODE_HIGH_SPEED 0x01
76 #define SINGLEWIRECAN_OPERATING_MODE_HIGH_VOLTAGE_WAKE_UP 0x02
77 #define SINGLEWIRECAN_OPERATING_MODE_NORMAL 0x03
78 
84 #define SINGLEWIRECAN_PIN_STATE_LOW 0x00
85 #define SINGLEWIRECAN_PIN_STATE_HIGH 0x01
86 
92 #define SINGLEWIRECAN_END_BUFF 0x00
93 
99 #define DRV_RX_BUFFER_SIZE 500
100  // End group macro
103 // --------------------------------------------------------------- PUBLIC TYPES
111 typedef struct
112 {
113  // Output pins
114 
115  digital_out_t md0;
116  digital_out_t md1;
117 
118  // Modules
119 
120  uart_t uart;
121 
122  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
123  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
124 
126 
130 typedef struct
131 {
132  // Communication gpio pins
133 
134  pin_name_t rx_pin;
135  pin_name_t tx_pin;
136 
137  // Additional gpio pins
138 
139  pin_name_t md0;
140  pin_name_t md1;
141 
142  // static variable
143 
144  uint32_t baud_rate; // Clock speed.
146  uart_data_bits_t data_bit; // Data bits.
147  uart_parity_t parity_bit; // Parity bit.
148  uart_stop_bits_t stop_bit; // Stop bits.
149 
151  // End types group
153 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
154 
160 #ifdef __cplusplus
161 extern "C"{
162 #endif
163 
174 
184 
194 void singlewirecan_generic_write ( singlewirecan_t *ctx, char *data_buf, uint16_t len );
195 
207 int32_t singlewirecan_generic_read ( singlewirecan_t *ctx, char *data_buf, uint16_t max_len );
208 
217 void singlewirecan_set_md_0_pin_state ( singlewirecan_t *ctx, uint8_t rst_state );
218 
227 void singlewirecan_set_md_1_pin_state ( singlewirecan_t *ctx, uint8_t cs_state );
228 
244 void singlewirecan_set_operating_mode ( singlewirecan_t *ctx, uint8_t op_mode );
245 
246 #ifdef __cplusplus
247 }
248 #endif
249 #endif // _SINGLEWIRECAN_H_
250  // End public_function group
253 
254 // ------------------------------------------------------------------------- END
singlewirecan_cfg_t::uart_blocking
bool uart_blocking
Definition: singlewirecan.h:145
singlewirecan_cfg_t
Click configuration structure definition.
Definition: singlewirecan.h:130
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: singlewirecan.h:99
singlewirecan_cfg_t::baud_rate
uint32_t baud_rate
Definition: singlewirecan.h:144
singlewirecan_t
Click ctx object definition.
Definition: singlewirecan.h:111
SINGLEWIRECAN_RETVAL
#define SINGLEWIRECAN_RETVAL
Definition: singlewirecan.h:64
singlewirecan_cfg_t::tx_pin
pin_name_t tx_pin
Definition: singlewirecan.h:135
singlewirecan_cfg_t::md0
pin_name_t md0
Definition: singlewirecan.h:139
singlewirecan_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: singlewirecan.h:147
singlewirecan_generic_write
void singlewirecan_generic_write(singlewirecan_t *ctx, char *data_buf, uint16_t len)
Generic write function.
singlewirecan_set_operating_mode
void singlewirecan_set_operating_mode(singlewirecan_t *ctx, uint8_t op_mode)
Set operating mode function.
singlewirecan_t::uart
uart_t uart
Definition: singlewirecan.h:120
singlewirecan_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: singlewirecan.h:146
singlewirecan_generic_read
int32_t singlewirecan_generic_read(singlewirecan_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
singlewirecan_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: singlewirecan.h:148
singlewirecan_cfg_t::rx_pin
pin_name_t rx_pin
Definition: singlewirecan.h:134
singlewirecan_set_md_0_pin_state
void singlewirecan_set_md_0_pin_state(singlewirecan_t *ctx, uint8_t rst_state)
Sets MD0 pin state.
singlewirecan_t::md0
digital_out_t md0
Definition: singlewirecan.h:115
singlewirecan_t::md1
digital_out_t md1
Definition: singlewirecan.h:116
singlewirecan_set_md_1_pin_state
void singlewirecan_set_md_1_pin_state(singlewirecan_t *ctx, uint8_t cs_state)
Sets MD1 pin state.
singlewirecan_cfg_t::md1
pin_name_t md1
Definition: singlewirecan.h:140
singlewirecan_init
SINGLEWIRECAN_RETVAL singlewirecan_init(singlewirecan_t *ctx, singlewirecan_cfg_t *cfg)
Initialization function.
singlewirecan_cfg_setup
void singlewirecan_cfg_setup(singlewirecan_cfg_t *cfg)
Config Object Initialization function.