i2c1wire  2.0.0.0
i2c1wire.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 I2C1WIRE_H
36 #define I2C1WIRE_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define I2C1WIRE_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
61 #define I2C1WIRE_RETVAL uint8_t
62 
63 #define I2C1WIRE_OK 0x00
64 #define I2C1WIRE_INIT_ERROR 0xFF
65 
71 #define I2CONEWIRE_RESULT_ERROR 0x00
72 #define I2CONEWIRE_RESULT_OK 0x01
73 #define I2CONEWIRE_WIRE_RESULT_OK 0xFF
74 
75 #define I2CONEWIRE_I2C_ADDRESS_0 0x18
76 #define I2CONEWIRE_I2C_ADDRESS_1 0x19
77 #define I2CONEWIRE_I2C_ADDRESS_2 0x1A
78 #define I2CONEWIRE_I2C_ADDRESS_3 0x1B
79 #define I2CONEWIRE_I2C_ADDRESS_4 0x1C
80 #define I2CONEWIRE_I2C_ADDRESS_5 0x1D
81 #define I2CONEWIRE_I2C_ADDRESS_6 0x1E
82 #define I2CONEWIRE_I2C_ADDRESS_7 0x1F
83 
84 #define I2CONEWIRE_COMMAND_RESET 0xF0
85 #define I2CONEWIRE_COMMAND_SRP 0xE1
86 #define I2CONEWIRE_POINTER_STATUS 0xF0
87 #define I2CONEWIRE_STATUS_BUSY 0x01
88 #define I2CONEWIRE_STATUS_PPD 0x02
89 #define I2CONEWIRE_STATUS_SD 0x04
90 #define I2CONEWIRE_STATUS_LL 0x08
91 #define I2CONEWIRE_STATUS_RST 0x10
92 #define I2CONEWIRE_STATUS_SBR 0x20
93 #define I2CONEWIRE_STATUS_TSB 0x40
94 #define I2CONEWIRE_STATUS_DIR 0x80
95 #define I2CONEWIRE_POINTER_DATA 0xE1
96 #define I2CONEWIRE_POINTER_CONFIG 0xC3
97 #define I2CONEWIRE_CONFIG_APU_HIGH 0x30
98 #define I2CONEWIRE_CONFIG_APU_LOW 0x01
99 #define I2CONEWIRE_CONFIG_SPU_HIGH 0x60
100 #define I2CONEWIRE_CONFIG_SPU_LOW 0x04
101 #define I2CONEWIRE_CONFIG_1WS_HIGH 0xA0
102 #define I2CONEWIRE_CONFIG_1WS_LOW 0x08
103 #define I2CONEWIRE_COMMAND_WRITECONFIG 0xD2
104 #define I2CONEWIRE_COMMAND_RESETWIRE 0xB4
105 #define I2CONEWIRE_COMMAND_WRITEBYTE 0xA5
106 #define I2CONEWIRE_COMMAND_READBYTE 0x96
107 #define I2CONEWIRE_COMMAND_SINGLEBIT 0x87
108 #define I2CONEWIRE_COMMAND_TRIPLET 0x78
109 #define I2CONEWIRE_WIRE_COMMAND_SKIP 0xCC
110 #define I2CONEWIRE_WIRE_COMMAND_SELECT 0x55
111 #define I2CONEWIRE_WIRE_COMMAND_READ_ROM 0x33
112 #define I2CONEWIRE_WIRE_COMMAND_SEARCH 0xF0
113 #define I2CONEWIRE_ERROR_TIMEOUT 0x01
114 #define I2CONEWIRE_ERROR_SHORT 0x02
115 #define I2CONEWIRE_ERROR_CONFIG 0x04
116 #define I2CONEWIRE_CMD_CHSL 0xC3
117 #define I2CONEWIRE_CH_IO0 0xF0
118 #define I2CONEWIRE_CH_IO1 0xE1
119 #define I2CONEWIRE_CH_IO2 0xD2
120 #define I2CONEWIRE_CH_IO3 0xC3
121 #define I2CONEWIRE_CH_IO4 0xB4
122 #define I2CONEWIRE_CH_IO5 0xA5
123 #define I2CONEWIRE_CH_IO6 0x96
124 #define I2CONEWIRE_CH_IO7 0x87
125 #define I2CONEWIRE_RCH_IO0 0xB8
126 #define I2CONEWIRE_RCH_IO1 0xB1
127 #define I2CONEWIRE_RCH_IO2 0xAA
128 #define I2CONEWIRE_RCH_IO3 0xA3
129 #define I2CONEWIRE_RCH_IO4 0x9C
130 #define I2CONEWIRE_RCH_IO5 0x95
131 #define I2CONEWIRE_RCH_IO6 0x8E
132 #define I2CONEWIRE_RCH_IO7 0x87
133  // End group macro
136 // --------------------------------------------------------------- PUBLIC TYPES
145 typedef struct
146 {
147  // Modules
148 
149  i2c_master_t i2c;
150 
151  // ctx variable
152 
153  uint8_t slave_address;
154 
155 } i2c1wire_t;
156 
160 typedef struct
161 {
162  // Communication gpio pins
163 
164  pin_name_t scl;
165  pin_name_t sda;
166 
167  // static variable
168 
169  uint32_t i2c_speed;
170  uint8_t i2c_address;
171 
173  // End types group
175 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
176 
182 #ifdef __cplusplus
183 extern "C"{
184 #endif
185 
194 void i2c1wire_cfg_setup ( i2c1wire_cfg_t *cfg );
195 
205 
216 void i2c1wire_generic_write ( i2c1wire_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
217 
228 void i2c1wire_generic_read ( i2c1wire_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
229 
237 void i2c1wire_soft_reset ( i2c1wire_t *ctx );
238 
247 uint8_t i2c1wire_set_config ( i2c1wire_t *ctx, uint8_t cfg );
248 
257 uint8_t i2c1wire_set_channel ( i2c1wire_t *ctx, uint8_t chan );
258 
267 void i2c1wire_set_read_pointer ( i2c1wire_t *ctx, uint8_t ptr );
268 
276 void i2c1wire_one_wire_reset ( i2c1wire_t *ctx );
277 
286 void i2c1wire_write_byte_one_wire ( i2c1wire_t *ctx, uint8_t input );
287 
295 uint8_t i2c1wire_read_byte_one_wire ( i2c1wire_t *ctx );
296 
297 #ifdef __cplusplus
298 }
299 #endif
300 #endif // _I2C1WIRE_H_
301  // End public_function group
304 
305 // ------------------------------------------------------------------------- END
i2c1wire_t::i2c
i2c_master_t i2c
Definition: i2c1wire.h:149
i2c1wire_generic_read
void i2c1wire_generic_read(i2c1wire_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
i2c1wire_set_read_pointer
void i2c1wire_set_read_pointer(i2c1wire_t *ctx, uint8_t ptr)
Set read pointer function.
i2c1wire_set_channel
uint8_t i2c1wire_set_channel(i2c1wire_t *ctx, uint8_t chan)
Set channel function.
i2c1wire_generic_write
void i2c1wire_generic_write(i2c1wire_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
i2c1wire_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2c1wire.h:170
i2c1wire_cfg_setup
void i2c1wire_cfg_setup(i2c1wire_cfg_t *cfg)
Config Object Initialization function.
i2c1wire_one_wire_reset
void i2c1wire_one_wire_reset(i2c1wire_t *ctx)
Reset function.
i2c1wire_cfg_t
Click configuration structure definition.
Definition: i2c1wire.h:160
i2c1wire_soft_reset
void i2c1wire_soft_reset(i2c1wire_t *ctx)
Software reset function.
i2c1wire_t
Click ctx object definition.
Definition: i2c1wire.h:145
i2c1wire_cfg_t::sda
pin_name_t sda
Definition: i2c1wire.h:165
i2c1wire_write_byte_one_wire
void i2c1wire_write_byte_one_wire(i2c1wire_t *ctx, uint8_t input)
Write byte function.
i2c1wire_read_byte_one_wire
uint8_t i2c1wire_read_byte_one_wire(i2c1wire_t *ctx)
Read byte function.
i2c1wire_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2c1wire.h:169
i2c1wire_set_config
uint8_t i2c1wire_set_config(i2c1wire_t *ctx, uint8_t cfg)
Set configuration function.
i2c1wire_init
I2C1WIRE_RETVAL i2c1wire_init(i2c1wire_t *ctx, i2c1wire_cfg_t *cfg)
Initialization function.
i2c1wire_t::slave_address
uint8_t slave_address
Definition: i2c1wire.h:153
i2c1wire_cfg_t::scl
pin_name_t scl
Definition: i2c1wire.h:164
I2C1WIRE_RETVAL
#define I2C1WIRE_RETVAL
Definition: i2c1wire.h:61