wip:

README.md

@@ -1,36 +1,7 @@
-# FreeRTOS based AVR library for I2C bus
+# zh_avr_i2c
 
-## Features
+AVR library for I2C bus.
 
-1. Simple read and write data.
-
-## Dependencies
-
-1. [zh_avr_free_rtos](http://git.zh.com.ru/avr_libraries/zh_avr_free_rtos)
-2. [zh_avr_common](http://git.zh.com.ru/avr_libraries/zh_avr_common)
-
-## Using
-
-In an existing project, run the following command to install the component:
-
-```text
-cd ../your_project/lib
-git clone http://git.zh.com.ru/avr_libraries/zh_avr_free_rtos
-git clone http://git.zh.com.ru/avr_libraries/zh_avr_i2c
-git clone http://git.zh.com.ru/avr_libraries/zh_avr_common
-```
-
-In the application, add the component:
-
-```c
-#include "zh_avr_i2c.h"
-```
-
-## Example
-
-Master read and write data:
-
-```c
 #include "avr/io.h"
 #include "stdio.h"
 #include "zh_avr_i2c.h"
@@ -94,4 +65,3 @@ int main(void)
 	vTaskStartScheduler();
 	return 0;
 }
-```

include/zh_avr_i2c.h

@@ -5,14 +5,30 @@
 #include "avr/io.h"
 #include "avr/interrupt.h"
 #include "stdbool.h"
-#include "avr_err.h"
-#include "avr_bit_defs.h"
 
 #ifdef __cplusplus
 extern "C"
 {
 #endif
 
+	typedef enum
+	{
+		AVR_FAIL = -1,
+		AVR_OK,
+		AVR_ERR_NO_MEM,
+		AVR_ERR_INVALID_ARG,
+		AVR_ERR_INVALID_STATE,
+		AVR_ERR_INVALID_SIZE,
+		AVR_ERR_NOT_FOUND,
+		AVR_ERR_NOT_SUPPORTED,
+		AVR_ERR_TIMEOUT,
+		AVR_ERR_INVALID_RESPONSE,
+		AVR_ERR_INVALID_CRC,
+		AVR_ERR_INVALID_VERSION,
+		AVR_ERR_NOT_FINISHED,
+		AVR_ERR_NOT_ALLOWED
+	} avr_err_t;
+
 	/**
 	 * @brief Initialize I2C bus.
 	 *
@@ -23,37 +39,15 @@ extern "C"
 	avr_err_t zh_avr_i2c_master_init(const bool pullup);
 
 	/**
-	 * @brief Probe I2C address.
+	 * @brief Probe I2C address, if address is correct and ACK is received, this function will return AVR_OK.
 	 *
-	 * @param[in] addr Address I2C device.
+	 * @param[in] addr Address I2C device address that you want to probe.
 	 * @param[in] xTicksToWait Wait timeout in FreeRTOS ticks.
 	 *
 	 * @return AVR_OK if success or an error code otherwise.
 	 */
 	avr_err_t zh_avr_i2c_master_probe(const uint8_t addr, TickType_t xTicksToWait);
-
-	/**
-	 * @brief Send data to I2C address.
-	 *
-	 * @param[in] addr Address I2C device.
-	 * @param[in] data Pointer to data for send.
-	 * @param[in] size Data size.
-	 * @param[in] xTicksToWait Wait timeout in FreeRTOS ticks.
-	 *
-	 * @return AVR_OK if success or an error code otherwise.
-	 */
 	avr_err_t zh_avr_i2c_master_transmit(const uint8_t addr, uint8_t *data, uint8_t size, TickType_t xTicksToWait);
-
-	/**
-	 * @brief Read data from I2C address.
-	 *
-	 * @param[in] addr Address I2C device.
-	 * @param[out] data Pointer to buffer for read.
-	 * @param[in] size Data size.
-	 * @param[in] xTicksToWait Wait timeout in FreeRTOS ticks.
-	 *
-	 * @return AVR_OK if success or an error code otherwise.
-	 */
 	avr_err_t zh_avr_i2c_master_receive(const uint8_t addr, uint8_t *data, uint8_t size, TickType_t xTicksToWait);
 
 	avr_err_t zh_avr_i2c_master_transmit_register(const uint8_t addr, uint16_t *reg, uint8_t *data, uint8_t size, TickType_t xTicksToWait); // To Do

version.txt

@@ -1 +1 @@
-1.1.0
+1.0.0

zh_avr_i2c.c

@@ -1,9 +1,15 @@
 #include "zh_avr_i2c.h"
 
-#define I2C_OK AVR_BIT0
+#define ZH_ERROR_CHECK(cond, err, ...) \
-#define I2C_NACK AVR_BIT1
+	if (!(cond))                       \
-#define I2C_COLLISION AVR_BIT2
+	{                                  \
-#define I2C_BUS_FAIL AVR_BIT3
+		return err;                    \
+	}
+
+#define I2C_OK 0x01
+#define I2C_NACK 0x02
+#define I2C_COLLISION 0x04
+#define I2C_BUS_FAIL 0x08
 
 #define I2C_START ((1 << TWINT) | (1 << TWEN) | (1 << TWIE))
 #define I2C_MASTER_READ 1