i2c1wire2 2.1.0.0
i2c1wire2.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 I2C1WIRE2_H
29#define I2C1WIRE2_H
30
31#ifdef __cplusplus
32extern "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
46#include "drv_digital_out.h"
47#include "drv_digital_in.h"
48#include "drv_i2c_master.h"
49
70#define I2C1WIRE2_REG_MASTER_CFG 0x00
71#define I2C1WIRE2_REG_STD_SPEED_TRSTL 0x01
72#define I2C1WIRE2_REG_STD_SPEED_TMSI 0x02
73#define I2C1WIRE2_REG_STD_SPEED_TMSP 0x03
74#define I2C1WIRE2_REG_STD_SPEED_TRTH 0x04
75#define I2C1WIRE2_REG_STD_SPEED_TW0L 0x05
76#define I2C1WIRE2_REG_STD_SPEED_TW1L 0x06
77#define I2C1WIRE2_REG_STD_SPEED_TMSR 0x07
78#define I2C1WIRE2_REG_STD_SPEED_TREC 0x08
79#define I2C1WIRE2_REG_OVER_SPEED_TRSTL 0x09
80#define I2C1WIRE2_REG_OVER_SPEED_TMSI 0x0A
81#define I2C1WIRE2_REG_OVER_SPEED_TMSP 0x0B
82#define I2C1WIRE2_REG_OVER_SPEED_TRTH 0x0C
83#define I2C1WIRE2_REG_OVER_SPEED_TW0L 0x0D
84#define I2C1WIRE2_REG_OVER_SPEED_TW1L 0x0E
85#define I2C1WIRE2_REG_OVER_SPEED_TMSR 0x0F
86#define I2C1WIRE2_REG_OVER_SPEED_TREC 0x10
87#define I2C1WIRE2_REG_PRUP_BUFF 0x11
88#define I2C1WIRE2_REG_PDSLEW 0x12
89
94#define I2C1WIRE2_CMD_WRITE_MEMORY 0x96
95#define I2C1WIRE2_CMD_READ_MEMORY 0x44
96#define I2C1WIRE2_CMD_SET_PAGE_PROTECTION 0xC3
97#define I2C1WIRE2_CMD_READ_STATUS 0xAA
98#define I2C1WIRE2_CMD_READ_1WIRE_PORT_CFG 0x52
99#define I2C1WIRE2_CMD_WRITE_1WIRE_PORT_CFG 0x99
100#define I2C1WIRE2_CMD_MASTER_RESET 0x62
101#define I2C1WIRE2_CMD_1WIRE_SCRIPT 0x88
102#define I2C1WIRE2_CMD_1WIRE_BLOCK 0xAB
103#define I2C1WIRE2_CMD_1WIRE_READ_BLOCK 0x50
104#define I2C1WIRE2_CMD_1WIRE_WRITE_BLOCK 0x68
105#define I2C1WIRE2_CMD_1WIRE_SEARCH 0x11
106#define I2C1WIRE2_CMD_FULL_COMMAND_SEQUENCE 0x57
107#define I2C1WIRE2_CMD_COMPUTE_CRC16 0xCC
108
109
110
111 // i2c1wire2_reg
113
128#define I2C1WIRE2_CUSTOM_VAL 0x80
129#define I2C1WIRE2_RWPU_EXT 0x00
130#define I2C1WIRE2_RWPU_500 0x01
131#define I2C1WIRE2_RWPU_1000 0x02
132#define I2C1WIRE2_RWPU_333 0x03
133#define I2C1WIRE2_VIAPO_LOW 0x00
134#define I2C1WIRE2_VIAPO_MEDIUM 0x04
135#define I2C1WIRE2_VIAPO_HIGH 0x08
136#define I2C1WIRE2_VIAPO_OFF 0x0C
137#define I2C1WIRE2_VTH_LOW 0x00
138#define I2C1WIRE2_VTH_MEDIUM 0x01
139#define I2C1WIRE2_VTH_HIGH 0x02
140#define I2C1WIRE2_VTH_OFF 0x03
141
146#define I2C1WIRE2_SEARCH_1WIRE_RESET 0x01
147#define I2C1WIRE2_SEARCH_IGNORE_PULSE 0x02
148#define I2C1WIRE2_SEARCH_RESET 0x04
149
154#define I2C1WIRE2_RESULT_BYTE_OK 0xAA
155#define I2C1WIRE2_RESULT_BYTE_ERROR 0x55
156#define I2C1WIRE2_NO_PRESENCE_PULS 0x33
157#define I2C1WIRE2_NO_DEVICE_DETECTED 0x00
158#define I2C1WIRE2_RESULT_BYTE_ERROR_INVALID_PARAMS 0x77
159#define I2C1WIRE2_RESULT_BYTE_ERROR_RESET_FAIL 0x22
160
166#define I2C1WIRE2_DEVICE_ADDRESS 0x40
167 // i2c1wire2_set
169
184#define I2C1WIRE2_MAP_MIKROBUS( cfg, mikrobus ) \
185 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
186 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
187 // i2c1wire2_map // i2c1wire2
190
195typedef struct
196{
197 // Modules
198 i2c_master_t i2c;
200 // I2C slave address
204
209typedef struct
210{
211 pin_name_t scl;
212 pin_name_t sda;
214 uint32_t i2c_speed;
215 uint8_t i2c_address;
218
223typedef enum
224{
226 I2C1WIRE2_ERROR = -1
227
229
246
261
275
290err_t i2c1wire2_generic_write ( i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
291
306err_t i2c1wire2_generic_read ( i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
307
319
332err_t i2c1wire2_read_port_cfg ( i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_out );
333
346err_t i2c1wire2_write_port_cfg ( i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_in );
347
363err_t i2c1wire2_search ( i2c1wire2_t *ctx, uint8_t *flag, uint8_t *rom_id, uint8_t *last_flag, uint8_t param_data, uint8_t command_code );
364
365#ifdef __cplusplus
366}
367#endif
368#endif // I2C1WIRE2_H
369 // i2c1wire2
371
372// ------------------------------------------------------------------------ END
err_t i2c1wire2_write_port_cfg(i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_in)
I2C 1-Wire 2 write port configuration function.
err_t i2c1wire2_read_port_cfg(i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_out)
I2C 1-Wire 2 read port configuration function.
void i2c1wire2_cfg_setup(i2c1wire2_cfg_t *cfg)
I2C 1-Wire 2 configuration object setup function.
err_t i2c1wire2_generic_read(i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
I2C 1-Wire 2 I2C reading function.
err_t i2c1wire2_init(i2c1wire2_t *ctx, i2c1wire2_cfg_t *cfg)
I2C 1-Wire 2 initialization function.
err_t i2c1wire2_default_cfg(i2c1wire2_t *ctx)
I2C 1-Wire 2 default configuration function.
err_t i2c1wire2_generic_write(i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
I2C 1-Wire 2 I2C writing function.
err_t i2c1wire2_master_reset(i2c1wire2_t *ctx)
I2C 1-Wire 2 master reset function.
err_t i2c1wire2_search(i2c1wire2_t *ctx, uint8_t *flag, uint8_t *rom_id, uint8_t *last_flag, uint8_t param_data, uint8_t command_code)
I2C 1-Wire 2 search function.
i2c1wire2_return_value_t
I2C 1-Wire 2 Click return value data.
Definition: i2c1wire2.h:224
@ I2C1WIRE2_OK
Definition: i2c1wire2.h:225
@ I2C1WIRE2_ERROR
Definition: i2c1wire2.h:226
I2C 1-Wire 2 Click configuration object.
Definition: i2c1wire2.h:210
uint32_t i2c_speed
Definition: i2c1wire2.h:214
pin_name_t scl
Definition: i2c1wire2.h:211
pin_name_t sda
Definition: i2c1wire2.h:212
uint8_t i2c_address
Definition: i2c1wire2.h:215
I2C 1-Wire 2 Click context object.
Definition: i2c1wire2.h:196
i2c_master_t i2c
Definition: i2c1wire2.h:198
uint8_t slave_address
Definition: i2c1wire2.h:201