c1wirei2c  2.1.0.0
c1wirei2c.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 C1WIREI2C_H
29 #define C1WIREI2C_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_one_wire.h"
48 
69 #define C1WIREI2C_CMD_WRITE_DATA_WITH_STOP 0x4B
70 #define C1WIREI2C_CMD_WRITE_DATA_NO_STOP 0x5A
71 #define C1WIREI2C_CMD_WRITE_DATA_ONLY 0x69
72 #define C1WIREI2C_CMD_WRITE_DATA_ONLY_WITH_STOP 0x78
73 #define C1WIREI2C_CMD_READ_DATA_WITH_STOP 0x87
74 #define C1WIREI2C_CMD_WRITE_READ_DATA_WITH_STOP 0x2D
75 #define C1WIREI2C_CMD_WRITE_CONFIGURATION 0xD2
76 #define C1WIREI2C_CMD_READ_CONFIGURATION 0xE1
77 #define C1WIREI2C_CMD_ENABLE_SLEEP_MODE 0x1E
78 #define C1WIREI2C_CMD_READ_DEVICE_REVISION 0xC3
79  // c1wirei2c_cmd
81 
96 #define C1WIREI2C_CONFIGURATION_SPD_100KHZ 0x00
97 #define C1WIREI2C_CONFIGURATION_SPD_400KHZ 0x01
98 #define C1WIREI2C_CONFIGURATION_SPD_900KHZ 0x02
99 #define C1WIREI2C_CONFIGURATION_SPD_MASK 0x03
100 
105 #define C1WIREI2C_FAMILY_CODE 0x19
106 
111 #define C1WIREI2C_ADDRESS_0 0x00
112 #define C1WIREI2C_ADDRESS_ALL 0xFF
113  // c1wirei2c_set
115 
130 #define C1WIREI2C_MAP_MIKROBUS( cfg, mikrobus ) \
131  cfg.ow2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
132  cfg.ow1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
133  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
134  // c1wirei2c_map // c1wirei2c
137 
142 typedef enum
143 {
148 
153 typedef struct
154 {
155  // Output pins
156  digital_out_t rst;
158  // Modules
159  one_wire_t ow;
161  one_wire_rom_address_t rom_addr;
162  uint8_t address;
164 } c1wirei2c_t;
165 
170 typedef struct
171 {
172  // Communication gpio pins
173  pin_name_t ow1;
174  pin_name_t ow2;
176  // Additional gpio pins
177  pin_name_t rst;
182 
187 typedef enum
188 {
190  C1WIREI2C_ERROR = -1
191 
193 
210 
226 
241 
255 
268 
281 
295 err_t c1wirei2c_write_data_stop ( c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t len );
296 
312 err_t c1wirei2c_write_data ( c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t len );
313 
328 err_t c1wirei2c_write_data_only ( c1wirei2c_t *ctx, uint8_t *data_in, uint8_t len );
329 
343 err_t c1wirei2c_write_data_only_stop ( c1wirei2c_t *ctx, uint8_t *data_in, uint8_t len );
344 
358 err_t c1wirei2c_read_data_stop ( c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_out, uint8_t len );
359 
376 err_t c1wirei2c_write_read_data_stop ( c1wirei2c_t *ctx, uint8_t slave_addr,
377  uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len );
378 
390 err_t c1wirei2c_write_configuration ( c1wirei2c_t *ctx, uint8_t config );
391 
403 err_t c1wirei2c_read_configuration ( c1wirei2c_t *ctx, uint8_t *config );
404 
416 
429 err_t c1wirei2c_read_device_revision ( c1wirei2c_t *ctx, uint8_t *revision );
430 
440 void c1wirei2c_set_rst_pin ( c1wirei2c_t *ctx, uint8_t state );
441 
451 
452 #ifdef __cplusplus
453 }
454 #endif
455 #endif // C1WIREI2C_H
456  // c1wirei2c
458 
459 // ------------------------------------------------------------------------ END
c1wirei2c_init
err_t c1wirei2c_init(c1wirei2c_t *ctx, c1wirei2c_cfg_t *cfg)
1-Wire I2C initialization function.
c1wirei2c_t::ow
one_wire_t ow
Definition: c1wirei2c.h:159
c1wirei2c_read_configuration
err_t c1wirei2c_read_configuration(c1wirei2c_t *ctx, uint8_t *config)
1-Wire I2C read configuration function.
c1wirei2c_set_rst_pin
void c1wirei2c_set_rst_pin(c1wirei2c_t *ctx, uint8_t state)
1-Wire I2C set rst pin function.
C1WIREI2C_GPIO_OW2
@ C1WIREI2C_GPIO_OW2
Definition: c1wirei2c.h:145
c1wirei2c_write_data_only
err_t c1wirei2c_write_data_only(c1wirei2c_t *ctx, uint8_t *data_in, uint8_t len)
1-Wire I2C write data only function.
c1wirei2c_t::address
uint8_t address
Definition: c1wirei2c.h:162
c1wirei2c_read_data_stop
err_t c1wirei2c_read_data_stop(c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_out, uint8_t len)
1-Wire I2C read data stop function.
c1wirei2c_read_device_revision
err_t c1wirei2c_read_device_revision(c1wirei2c_t *ctx, uint8_t *revision)
1-Wire I2C read device revision function.
c1wirei2c_cfg_t
1-Wire I2C Click configuration object.
Definition: c1wirei2c.h:171
c1wirei2c_t
1-Wire I2C Click context object.
Definition: c1wirei2c.h:154
c1wirei2c_write_data
err_t c1wirei2c_write_data(c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t len)
1-Wire I2C write data function.
c1wirei2c_write_configuration
err_t c1wirei2c_write_configuration(c1wirei2c_t *ctx, uint8_t config)
1-Wire I2C write configuration function.
C1WIREI2C_GPIO_OW1
@ C1WIREI2C_GPIO_OW1
Definition: c1wirei2c.h:144
c1wirei2c_t::rom_addr
one_wire_rom_address_t rom_addr
Definition: c1wirei2c.h:161
C1WIREI2C_ERROR
@ C1WIREI2C_ERROR
Definition: c1wirei2c.h:190
c1wirei2c_write_read_data_stop
err_t c1wirei2c_write_read_data_stop(c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len)
1-Wire I2C write read data stop function.
c1wirei2c_cfg_t::gpio_sel
c1wirei2c_gpio_sel_t gpio_sel
Definition: c1wirei2c.h:179
c1wirei2c_check_communication
err_t c1wirei2c_check_communication(c1wirei2c_t *ctx)
1-Wire I2C check communication function.
c1wirei2c_cfg_t::ow2
pin_name_t ow2
Definition: c1wirei2c.h:174
c1wirei2c_cfg_setup
void c1wirei2c_cfg_setup(c1wirei2c_cfg_t *cfg)
1-Wire I2C configuration object setup function.
C1WIREI2C_OK
@ C1WIREI2C_OK
Definition: c1wirei2c.h:189
c1wirei2c_reset_device
void c1wirei2c_reset_device(c1wirei2c_t *ctx)
1-Wire I2C reset device function.
c1wirei2c_cfg_t::rst
pin_name_t rst
Definition: c1wirei2c.h:177
c1wirei2c_return_value_t
c1wirei2c_return_value_t
1-Wire I2C Click return value data.
Definition: c1wirei2c.h:188
c1wirei2c_write_data_only_stop
err_t c1wirei2c_write_data_only_stop(c1wirei2c_t *ctx, uint8_t *data_in, uint8_t len)
1-Wire I2C write data only stop function.
c1wirei2c_write_data_stop
err_t c1wirei2c_write_data_stop(c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t len)
1-Wire I2C write data stop function.
c1wirei2c_cfg_t::ow1
pin_name_t ow1
Definition: c1wirei2c.h:173
c1wirei2c_default_cfg
err_t c1wirei2c_default_cfg(c1wirei2c_t *ctx)
1-Wire I2C default configuration function.
c1wirei2c_gpio_selection
void c1wirei2c_gpio_selection(c1wirei2c_cfg_t *cfg, c1wirei2c_gpio_sel_t gpio_sel)
1-Wire I2C driver interface setup function.
c1wirei2c_gpio_sel_t
c1wirei2c_gpio_sel_t
1-Wire I2C Click gpio selector.
Definition: c1wirei2c.h:143
c1wirei2c_t::rst
digital_out_t rst
Definition: c1wirei2c.h:156
c1wirei2c_select_device
err_t c1wirei2c_select_device(c1wirei2c_t *ctx)
1-Wire I2C select device function.
c1wirei2c_enable_sleep_mode
err_t c1wirei2c_enable_sleep_mode(c1wirei2c_t *ctx)
1-Wire I2C enable sleep mode function.