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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_uart.h"
38
59#define CANISOLATOR3_PIN_STATE_HIGH 0x01
60#define CANISOLATOR3_PIN_STATE_LOW 0x00
61
67#define CANISOLATOR3_TX_DRV_BUFFER_SIZE 100
68#define CANISOLATOR3_RX_DRV_BUFFER_SIZE 300
69 // canisolator3_cmd
71
86#define CANISOLATOR3_MAP_MIKROBUS( cfg, mikrobus ) \
87 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
88 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
89 cfg.pol = MIKROBUS( mikrobus, MIKROBUS_PWM )
90 // canisolator3_map // canisolator3
93
98typedef struct
99{
100 // Output pins
101 digital_out_t pol;
103 // Modules
104 uart_t uart;
106 // Buffers
107 uint8_t uart_rx_buffer[ CANISOLATOR3_RX_DRV_BUFFER_SIZE ];
108 uint8_t uart_tx_buffer[ CANISOLATOR3_TX_DRV_BUFFER_SIZE ];
111
116typedef struct
117{
118 // Communication gpio pins
119 pin_name_t rx_pin;
120 pin_name_t tx_pin;
122 // Additional gpio pins
123 pin_name_t pol;
125 // Static variable
126 uint32_t baud_rate;
128 uart_data_bits_t data_bit;
129 uart_parity_t parity_bit;
130 uart_stop_bits_t stop_bit;
133
138typedef enum
139{
142
144
161
176
188
201err_t canisolator3_generic_write ( canisolator3_t *ctx, uint8_t *data_in, uint16_t len );
202
215err_t canisolator3_generic_read ( canisolator3_t *ctx, uint8_t *data_out, uint16_t len );
216
226void canisolator3_set_pol_pin ( canisolator3_t *ctx, uint8_t pin_state );
227
228#ifdef __cplusplus
229}
230#endif
231#endif // CANISOLATOR3_H
232 // canisolator3
234
235// ------------------------------------------------------------------------ END
canisolator3_return_value_t
CAN Isolator 3 Click return value data.
Definition: canisolator3.h:139
@ CANISOLATOR3_ERROR
Definition: canisolator3.h:141
@ CANISOLATOR3_OK
Definition: canisolator3.h:140
#define CANISOLATOR3_RX_DRV_BUFFER_SIZE
Definition: canisolator3.h:68
#define CANISOLATOR3_TX_DRV_BUFFER_SIZE
CAN Isolator 3 driver buffer size.
Definition: canisolator3.h:67
void canisolator3_set_pol_pin(canisolator3_t *ctx, uint8_t pin_state)
CAN Isolator 3 set polarity function.
void canisolator3_cfg_setup(canisolator3_cfg_t *cfg)
CAN Isolator 3 configuration object setup function.
err_t canisolator3_generic_read(canisolator3_t *ctx, uint8_t *data_out, uint16_t len)
CAN Isolator 3 data reading function.
void canisolator3_default_cfg(canisolator3_t *ctx)
CAN Isolator 3 default configuration function.
err_t canisolator3_generic_write(canisolator3_t *ctx, uint8_t *data_in, uint16_t len)
CAN Isolator 3 data writing function.
err_t canisolator3_init(canisolator3_t *ctx, canisolator3_cfg_t *cfg)
CAN Isolator 3 initialization function.
CAN Isolator 3 Click configuration object.
Definition: canisolator3.h:117
uint32_t baud_rate
Definition: canisolator3.h:126
pin_name_t pol
Definition: canisolator3.h:123
bool uart_blocking
Definition: canisolator3.h:127
uart_data_bits_t data_bit
Definition: canisolator3.h:128
pin_name_t tx_pin
Definition: canisolator3.h:120
pin_name_t rx_pin
Definition: canisolator3.h:119
uart_stop_bits_t stop_bit
Definition: canisolator3.h:130
uart_parity_t parity_bit
Definition: canisolator3.h:129
CAN Isolator 3 Click context object.
Definition: canisolator3.h:99
uart_t uart
Definition: canisolator3.h:104
digital_out_t pol
Definition: canisolator3.h:101