i2ctocan  2.0.0.0
i2ctocan.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 I2CTOCAN_H
29 #define I2CTOCAN_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_i2c_master.h"
37 
59 #define I2CTOCAN_SET_DEV_ADDR 0x00
60  // i2ctocan_set
62 
77 #define I2CTOCAN_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
79  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
80  cfg.shd = MIKROBUS( mikrobus, MIKROBUS_CS )
81  // i2ctocan_map // i2ctocan
84 
89 typedef struct
90 {
91  // Output pins
92 
93  digital_out_t shd;
95  // Modules
96 
97  i2c_master_t i2c;
99  // I2C slave address
100 
101  uint8_t slave_address;
103 } i2ctocan_t;
104 
109 typedef struct
110 {
111  pin_name_t scl;
112  pin_name_t sda;
114  pin_name_t shd;
116  uint32_t i2c_speed;
117  uint8_t i2c_address;
120 
125 typedef enum
126 {
128  I2CTOCAN_ERROR = -1
129 
131 
150 
168 
185 
201 
217 
233 err_t i2ctocan_set_slave_address ( i2ctocan_t *ctx, uint8_t slave_addr );
234 
252 err_t i2ctocan_generic_write ( i2ctocan_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
253 
271 err_t i2ctocan_generic_read ( i2ctocan_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
272 
273 #ifdef __cplusplus
274 }
275 #endif
276 #endif // I2CTOCAN_H
277  // i2ctocan
279 
280 // ------------------------------------------------------------------------ END
i2ctocan_cfg_setup
void i2ctocan_cfg_setup(i2ctocan_cfg_t *cfg)
I2C to CAN configuration object setup function.
i2ctocan_t::i2c
i2c_master_t i2c
Definition: i2ctocan.h:97
i2ctocan_t::shd
digital_out_t shd
Definition: i2ctocan.h:93
i2ctocan_default_cfg
err_t i2ctocan_default_cfg(i2ctocan_t *ctx)
I2C to CAN default configuration function.
i2ctocan_t
I2C to CAN Click context object.
Definition: i2ctocan.h:90
i2ctocan_shutdown
err_t i2ctocan_shutdown(i2ctocan_t *ctx)
I2C to CAN shutdown the device function.
i2ctocan_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2ctocan.h:116
i2ctocan_t::slave_address
uint8_t slave_address
Definition: i2ctocan.h:101
i2ctocan_set_slave_address
err_t i2ctocan_set_slave_address(i2ctocan_t *ctx, uint8_t slave_addr)
Set I2C Slave address function.
i2ctocan_cfg_t::sda
pin_name_t sda
Definition: i2ctocan.h:112
i2ctocan_generic_read
err_t i2ctocan_generic_read(i2ctocan_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
I2C to CAN I2C reading function.
i2ctocan_init
err_t i2ctocan_init(i2ctocan_t *ctx, i2ctocan_cfg_t *cfg)
I2C to CAN initialization function.
i2ctocan_cfg_t
I2C to CAN Click configuration object.
Definition: i2ctocan.h:110
i2ctocan_cfg_t::shd
pin_name_t shd
Definition: i2ctocan.h:114
i2ctocan_cfg_t::scl
pin_name_t scl
Definition: i2ctocan.h:111
I2CTOCAN_ERROR
@ I2CTOCAN_ERROR
Definition: i2ctocan.h:128
i2ctocan_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2ctocan.h:117
I2CTOCAN_OK
@ I2CTOCAN_OK
Definition: i2ctocan.h:127
i2ctocan_generic_write
err_t i2ctocan_generic_write(i2ctocan_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
I2C to CAN I2C writing function.
i2ctocan_return_value_t
i2ctocan_return_value_t
I2C to CAN Click return value data.
Definition: i2ctocan.h:126
i2ctocan_enable_device
err_t i2ctocan_enable_device(i2ctocan_t *ctx)
I2C to CAN enable the device function.