canbus 2.0.0.0
canbus.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 CANBUS_H
29#define CANBUS_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
60#define DRV_BUFFER_SIZE 200
61 // canbus_set
63
78#define CANBUS_MAP_MIKROBUS( cfg, mikrobus ) \
79 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
80 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
81 cfg.stb = MIKROBUS( mikrobus, MIKROBUS_AN )
82 // canbus_map // canbus
85
90typedef struct
91{
92 // Output pins
93
94 digital_out_t stb;
96 // Modules
97
98 uart_t uart;
100 // Buffers
101
102 char uart_rx_buffer[ DRV_BUFFER_SIZE ];
103 char uart_tx_buffer[ DRV_BUFFER_SIZE ];
105} canbus_t;
106
111typedef struct
112{
113 // Communication gpio pins
114
115 pin_name_t rx_pin;
116 pin_name_t tx_pin;
118 // Additional gpio pins
119
120 pin_name_t stb;
124 // Static variable
125
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{
141 CANBUS_ERROR = -1
142
144
161
176err_t canbus_init ( canbus_t *ctx, canbus_cfg_t *cfg );
177
192
206err_t canbus_generic_write ( canbus_t *ctx, char *data_buf, uint16_t len );
207
221err_t canbus_generic_read ( canbus_t *ctx, char *data_buf, uint16_t max_len );
222
237
252
265err_t canbus_send_data ( canbus_t *ctx, char *tx_data );
266
267#ifdef __cplusplus
268}
269#endif
270#endif // CANBUS_H
271 // canbus
273
274// ------------------------------------------------------------------------ END
canbus_return_value_t
CAN Bus Click return value data.
Definition: canbus.h:139
@ CANBUS_ERROR
Definition: canbus.h:141
@ CANBUS_OK
Definition: canbus.h:140
#define DRV_BUFFER_SIZE
CAN Bus driver buffer size.
Definition: canbus.h:60
void canbus_cfg_setup(canbus_cfg_t *cfg)
CAN Bus configuration object setup function.
err_t canbus_generic_read(canbus_t *ctx, char *data_buf, uint16_t max_len)
CAN Bus data reading function.
err_t canbus_send_data(canbus_t *ctx, char *tx_data)
CAN Bus send data function.
err_t canbus_default_cfg(canbus_t *ctx)
CAN Bus default configuration function.
err_t canbus_set_high_speed_mode(canbus_t *ctx)
CAN Bus high speed mode function.
err_t canbus_init(canbus_t *ctx, canbus_cfg_t *cfg)
CAN Bus initialization function.
err_t canbus_set_low_current_standby_mode(canbus_t *ctx)
CAN Bus low current standby mode function.
err_t canbus_generic_write(canbus_t *ctx, char *data_buf, uint16_t len)
CAN Bus data writing function.
CAN Bus Click configuration object.
Definition: canbus.h:112
uint32_t baud_rate
Definition: canbus.h:126
bool uart_blocking
Definition: canbus.h:127
uart_data_bits_t data_bit
Definition: canbus.h:128
pin_name_t tx_pin
Definition: canbus.h:116
pin_name_t rx_pin
Definition: canbus.h:115
uart_stop_bits_t stop_bit
Definition: canbus.h:130
uart_parity_t parity_bit
Definition: canbus.h:129
pin_name_t stb
Definition: canbus.h:120
CAN Bus Click context object.
Definition: canbus.h:91
digital_out_t stb
Definition: canbus.h:94
uart_t uart
Definition: canbus.h:98