canisolator3  2.1.0.0
canisolator3.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef CANISOLATOR3_H
29 #define CANISOLATOR3_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define CANISOLATOR3_PIN_STATE_HIGH 0x01
74 #define CANISOLATOR3_PIN_STATE_LOW 0x00
75 
81 #define CANISOLATOR3_TX_DRV_BUFFER_SIZE 100
82 #define CANISOLATOR3_RX_DRV_BUFFER_SIZE 300
83  // canisolator3_cmd
85 
100 #define CANISOLATOR3_MAP_MIKROBUS( cfg, mikrobus ) \
101  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
102  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
103  cfg.pol = MIKROBUS( mikrobus, MIKROBUS_PWM )
104  // canisolator3_map // canisolator3
107 
112 typedef struct
113 {
114  // Output pins
115  digital_out_t pol;
117  // Modules
118  uart_t uart;
120  // Buffers
121  uint8_t uart_rx_buffer[ CANISOLATOR3_RX_DRV_BUFFER_SIZE ];
122  uint8_t uart_tx_buffer[ CANISOLATOR3_TX_DRV_BUFFER_SIZE ];
125 
130 typedef struct
131 {
132  // Communication gpio pins
133  pin_name_t rx_pin;
134  pin_name_t tx_pin;
136  // Additional gpio pins
137  pin_name_t pol;
139  // Static variable
140  uint32_t baud_rate;
142  uart_data_bits_t data_bit;
143  uart_parity_t parity_bit;
144  uart_stop_bits_t stop_bit;
147 
152 typedef enum
153 {
155  CANISOLATOR3_ERROR = -1
156 
158 
175 
190 
202 
215 err_t canisolator3_generic_write ( canisolator3_t *ctx, uint8_t *data_in, uint16_t len );
216 
229 err_t canisolator3_generic_read ( canisolator3_t *ctx, uint8_t *data_out, uint16_t len );
230 
240 void canisolator3_set_pol_pin ( canisolator3_t *ctx, uint8_t pin_state );
241 
242 #ifdef __cplusplus
243 }
244 #endif
245 #endif // CANISOLATOR3_H
246  // canisolator3
248 
249 // ------------------------------------------------------------------------ END
CANISOLATOR3_OK
@ CANISOLATOR3_OK
Definition: canisolator3.h:154
CANISOLATOR3_ERROR
@ CANISOLATOR3_ERROR
Definition: canisolator3.h:155
canisolator3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: canisolator3.h:143
canisolator3_cfg_t::uart_blocking
bool uart_blocking
Definition: canisolator3.h:141
CANISOLATOR3_RX_DRV_BUFFER_SIZE
#define CANISOLATOR3_RX_DRV_BUFFER_SIZE
Definition: canisolator3.h:82
canisolator3_generic_write
err_t canisolator3_generic_write(canisolator3_t *ctx, uint8_t *data_in, uint16_t len)
CAN Isolator 3 data writing function.
canisolator3_t::pol
digital_out_t pol
Definition: canisolator3.h:115
canisolator3_cfg_t
CAN Isolator 3 Click configuration object.
Definition: canisolator3.h:131
canisolator3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: canisolator3.h:144
canisolator3_t
CAN Isolator 3 Click context object.
Definition: canisolator3.h:113
canisolator3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: canisolator3.h:133
CANISOLATOR3_TX_DRV_BUFFER_SIZE
#define CANISOLATOR3_TX_DRV_BUFFER_SIZE
CAN Isolator 3 driver buffer size.
Definition: canisolator3.h:81
canisolator3_cfg_t::baud_rate
uint32_t baud_rate
Definition: canisolator3.h:140
canisolator3_generic_read
err_t canisolator3_generic_read(canisolator3_t *ctx, uint8_t *data_out, uint16_t len)
CAN Isolator 3 data reading function.
canisolator3_return_value_t
canisolator3_return_value_t
CAN Isolator 3 Click return value data.
Definition: canisolator3.h:153
canisolator3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: canisolator3.h:134
canisolator3_default_cfg
void canisolator3_default_cfg(canisolator3_t *ctx)
CAN Isolator 3 default configuration function.
canisolator3_cfg_t::pol
pin_name_t pol
Definition: canisolator3.h:137
canisolator3_init
err_t canisolator3_init(canisolator3_t *ctx, canisolator3_cfg_t *cfg)
CAN Isolator 3 initialization function.
canisolator3_cfg_setup
void canisolator3_cfg_setup(canisolator3_cfg_t *cfg)
CAN Isolator 3 configuration object setup function.
canisolator3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: canisolator3.h:142
canisolator3_t::uart
uart_t uart
Definition: canisolator3.h:118
canisolator3_set_pol_pin
void canisolator3_set_pol_pin(canisolator3_t *ctx, uint8_t pin_state)
CAN Isolator 3 set polarity function.