canfd  2.0.0.0
canfd.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 CANFD_H
36 #define CANFD_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_uart.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define CANFD_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
69  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
70  cfg.stb = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
72  cfg.wke = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
73  cfg.err = MIKROBUS( mikrobus, MIKROBUS_INT )
74 
80 #define CANFD_RETVAL uint8_t
81 
82 #define CANFD_OK 0x00
83 #define CANFD_INIT_ERROR 0xFF
84 
90 #define CANFD_PIN_STATE_ENABLE 0x01
91 #define CANFD_PIN_STATE_DISABLE 0x00
92 #define CANFD_NULL 0x00
93 
99 #define CANFD_OPERATING_MODE_NORMAL 0
100 #define CANFD_OPERATING_MODE_RECEIVE 1
101 #define CANFD_OPERATING_MODE_STAND_BY 2
102 #define CANFD_OPERATING_MODE_SLEEP 3
103 
109 #define DRV_RX_BUFFER_SIZE 500
110  // End group macro
113 // --------------------------------------------------------------- PUBLIC TYPES
121 typedef struct
122 {
123  // Output pins
124 
125  digital_out_t stb;
126  digital_out_t en;
127 
128  // Input pins
129 
130  digital_in_t wke;
131  digital_in_t err;
132 
133  // Modules
134 
135  uart_t uart;
136 
137  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
138  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
139 
140 } canfd_t;
141 
145 typedef struct
146 {
147  // Communication gpio pins
148 
149  pin_name_t rx_pin;
150  pin_name_t tx_pin;
151 
152  // Additional gpio pins
153 
154  pin_name_t stb;
155  pin_name_t en;
156  pin_name_t wke;
157  pin_name_t err;
158 
159  // static variable
160 
161  uint32_t baud_rate; // Clock speed.
163  uart_data_bits_t data_bit; // Data bits.
164  uart_parity_t parity_bit; // Parity bit.
165  uart_stop_bits_t stop_bit; // Stop bits.
166 
167 } canfd_cfg_t;
168 
172 typedef uint8_t canfd_error_t;
173  // End types group
175 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
176 
182 #ifdef __cplusplus
183 extern "C"{
184 #endif
185 
195 
204 
211 void canfd_set_wke_pin ( canfd_t *ctx, uint8_t state );
212 
218 void canfd_set_stb_pin ( canfd_t *ctx, uint8_t state );
219 
226 uint8_t canfd_get_err_pin ( canfd_t *ctx );
227 
234 void canfd_set_stand_by_stb_pin ( canfd_t *ctx, uint8_t stb_state );
235 
242 void canfd_set_mode_en_pin ( canfd_t *ctx, uint8_t en_state );
243 
250 void canfd_generic_write ( canfd_t *ctx, char *data_buf, uint16_t len );
251 
259 int32_t canfd_generic_read ( canfd_t *ctx, char *data_buf, uint16_t max_len );
260 
267 void canfd_set_operating_mode ( canfd_t *ctx, uint8_t op_mode );
268 
269 #ifdef __cplusplus
270 }
271 #endif
272 #endif // _CANFD_H_
273  // End public_function group
276 
277 // ------------------------------------------------------------------------- END
canfd_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: canfd.h:164
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: canfd.h:109
canfd_cfg_t::err
pin_name_t err
Definition: canfd.h:157
canfd_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: canfd.h:163
canfd_init
CANFD_RETVAL canfd_init(canfd_t *ctx, canfd_cfg_t *cfg)
Initialization function.
canfd_cfg_setup
void canfd_cfg_setup(canfd_cfg_t *cfg)
Config Object Initialization function.
canfd_set_mode_en_pin
void canfd_set_mode_en_pin(canfd_t *ctx, uint8_t en_state)
Set EN ( CS ) pin state.
CANFD_RETVAL
#define CANFD_RETVAL
Definition: canfd.h:80
canfd_t::stb
digital_out_t stb
Definition: canfd.h:125
canfd_set_stand_by_stb_pin
void canfd_set_stand_by_stb_pin(canfd_t *ctx, uint8_t stb_state)
Set STB ( RST ) pin state.
canfd_set_stb_pin
void canfd_set_stb_pin(canfd_t *ctx, uint8_t state)
Set RST ( reset ) pin state.
canfd_cfg_t::en
pin_name_t en
Definition: canfd.h:155
canfd_set_wke_pin
void canfd_set_wke_pin(canfd_t *ctx, uint8_t state)
Set WKE ( wake-up ) pin state.
canfd_set_operating_mode
void canfd_set_operating_mode(canfd_t *ctx, uint8_t op_mode)
Operation mode.
canfd_t::en
digital_out_t en
Definition: canfd.h:126
canfd_cfg_t::wke
pin_name_t wke
Definition: canfd.h:156
canfd_cfg_t::rx_pin
pin_name_t rx_pin
Definition: canfd.h:149
canfd_cfg_t
Click configuration structure definition.
Definition: canfd.h:146
canfd_error_t
uint8_t canfd_error_t
Error type.
Definition: canfd.h:172
canfd_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: canfd.h:165
canfd_get_err_pin
uint8_t canfd_get_err_pin(canfd_t *ctx)
Set ERR ( INT ) pin state.
canfd_generic_read
int32_t canfd_generic_read(canfd_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
canfd_t::wke
digital_in_t wke
Definition: canfd.h:130
canfd_generic_write
void canfd_generic_write(canfd_t *ctx, char *data_buf, uint16_t len)
Generic write function.
canfd_t
Click ctx object definition.
Definition: canfd.h:122
canfd_cfg_t::baud_rate
uint32_t baud_rate
Definition: canfd.h:161
canfd_cfg_t::tx_pin
pin_name_t tx_pin
Definition: canfd.h:150
canfd_t::uart
uart_t uart
Definition: canfd.h:135
canfd_cfg_t::stb
pin_name_t stb
Definition: canfd.h:154
canfd_cfg_t::uart_blocking
bool uart_blocking
Definition: canfd.h:162
canfd_t::err
digital_in_t err
Definition: canfd.h:131