canfd7  2.1.0.0
canfd7.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 CANFD7_H
29 #define CANFD7_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define CANFD7_STANDBY_ON 0x01
70 #define CANFD7_STANDBY_OFF 0x00
71 
77 #define CANFD7_TX_DRV_BUFFER_SIZE 100
78 #define CANFD7_RX_DRV_BUFFER_SIZE 300
79  // canfd7_cmd
81 
96 #define CANFD7_MAP_MIKROBUS( cfg, mikrobus ) \
97  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
98  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
99  cfg.stb = MIKROBUS( mikrobus, MIKROBUS_RST )
100  // canfd7_map // canfd7
103 
108 typedef struct
109 {
110  // Output pins
111  digital_out_t stb;
113  // Modules
114  uart_t uart;
116  // Buffers
117  uint8_t uart_rx_buffer[ CANFD7_RX_DRV_BUFFER_SIZE ];
118  uint8_t uart_tx_buffer[ CANFD7_TX_DRV_BUFFER_SIZE ];
120 } canfd7_t;
121 
126 typedef struct
127 {
128  // Communication gpio pins
129  pin_name_t rx_pin;
130  pin_name_t tx_pin;
132  // Additional gpio pins
133  pin_name_t stb;
135  // Static variable
136  uint32_t baud_rate;
138  uart_data_bits_t data_bit;
139  uart_parity_t parity_bit;
140  uart_stop_bits_t stop_bit;
142 } canfd7_cfg_t;
143 
148 typedef enum
149 {
151  CANFD7_ERROR = -1
152 
154 
171 
185 err_t canfd7_init ( canfd7_t *ctx, canfd7_cfg_t *cfg );
186 
198 
211 err_t canfd7_generic_write ( canfd7_t *ctx, uint8_t *data_in, uint16_t len );
212 
225 err_t canfd7_generic_read ( canfd7_t *ctx, uint8_t *data_out, uint16_t len );
226 
236 void canfd7_set_stb_pin ( canfd7_t *ctx, uint8_t pin_state );
237 
238 #ifdef __cplusplus
239 }
240 #endif
241 #endif // CANFD7_H
242  // canfd7
244 
245 // ------------------------------------------------------------------------ END
canfd7_cfg_t::baud_rate
uint32_t baud_rate
Definition: canfd7.h:136
canfd7_cfg_setup
void canfd7_cfg_setup(canfd7_cfg_t *cfg)
CAN FD 7 configuration object setup function.
canfd7_t::uart
uart_t uart
Definition: canfd7.h:114
CANFD7_OK
@ CANFD7_OK
Definition: canfd7.h:150
canfd7_set_stb_pin
void canfd7_set_stb_pin(canfd7_t *ctx, uint8_t pin_state)
CAN FD 7 set STB pin function.
canfd7_default_cfg
void canfd7_default_cfg(canfd7_t *ctx)
CAN FD 7 default configuration function.
canfd7_cfg_t::tx_pin
pin_name_t tx_pin
Definition: canfd7.h:130
CANFD7_ERROR
@ CANFD7_ERROR
Definition: canfd7.h:151
canfd7_generic_write
err_t canfd7_generic_write(canfd7_t *ctx, uint8_t *data_in, uint16_t len)
CAN FD 7 data writing function.
canfd7_return_value_t
canfd7_return_value_t
CAN FD 7 Click return value data.
Definition: canfd7.h:149
canfd7_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: canfd7.h:138
CANFD7_TX_DRV_BUFFER_SIZE
#define CANFD7_TX_DRV_BUFFER_SIZE
CAN FD 7 driver buffer size.
Definition: canfd7.h:77
canfd7_cfg_t
CAN FD 7 Click configuration object.
Definition: canfd7.h:127
canfd7_t::stb
digital_out_t stb
Definition: canfd7.h:111
canfd7_cfg_t::stb
pin_name_t stb
Definition: canfd7.h:133
canfd7_cfg_t::rx_pin
pin_name_t rx_pin
Definition: canfd7.h:129
CANFD7_RX_DRV_BUFFER_SIZE
#define CANFD7_RX_DRV_BUFFER_SIZE
Definition: canfd7.h:78
canfd7_t
CAN FD 7 Click context object.
Definition: canfd7.h:109
canfd7_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: canfd7.h:139
canfd7_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: canfd7.h:140
canfd7_cfg_t::uart_blocking
bool uart_blocking
Definition: canfd7.h:137
canfd7_generic_read
err_t canfd7_generic_read(canfd7_t *ctx, uint8_t *data_out, uint16_t len)
CAN FD 7 data reading function.
canfd7_init
err_t canfd7_init(canfd7_t *ctx, canfd7_cfg_t *cfg)
CAN FD 7 initialization function.