Compare commits

17 Commits

Author SHA1 Message Date
56a61b6163 wip: 2025-08-10 12:31:38 +03:00
fd7969779d wip: 2025-08-10 12:06:34 +03:00
e5303e4090 wip: 2025-08-10 11:53:57 +03:00
700848f9b2 wip: 2025-08-10 11:41:36 +03:00
74408d8f32 wip: 2025-08-10 11:19:30 +03:00
a0873bbe36 wip: 2025-08-10 09:12:30 +03:00
0b6e04a1c0 wip: 2025-08-10 08:53:45 +03:00
aae08f710a wip: 2025-08-10 08:11:55 +03:00
3e31aa3683 wip: 2025-08-09 12:50:30 +03:00
1284e245cc wip: 2025-08-09 12:30:20 +03:00
4547f6f510 wip: 2025-08-09 12:28:35 +03:00
851605cae3 wip: 2025-08-09 11:30:34 +03:00
9976c50da0 wip: 2025-08-08 15:02:24 +03:00
57c19ada39 wip: 2025-08-08 14:34:00 +03:00
b75fc68c80 wip: 2025-08-08 14:33:05 +03:00
5ef69ec6c7 wip: 2025-08-08 07:48:16 +03:00
13d46a62ef wip: 2025-08-04 12:44:34 +03:00
9 changed files with 79 additions and 109 deletions

2
.gitignore vendored
View File

@@ -1 +1 @@
.DS_Store .DS_Store

124
README.md
View File

@@ -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 "avr/io.h"
#include "stdio.h" #include "stdio.h"
#include "zh_avr_i2c.h" #include "zh_avr_i2c.h"
@@ -40,58 +11,57 @@ Master read and write data:
int usart(char byte, FILE *stream) int usart(char byte, FILE *stream)
{ {
while ((UCSR0A & (1 << UDRE0)) == 0) while ((UCSR0A & (1 << UDRE0)) == 0)
{ {
} }
UDR0 = byte; UDR0 = byte;
return 0; return 0;
} }
FILE uart = FDEV_SETUP_STREAM(usart, NULL, _FDEV_SETUP_WRITE); FILE uart = FDEV_SETUP_STREAM(usart, NULL, _FDEV_SETUP_WRITE);
void i2c_example_task(void *pvParameters) void i2c_example_task(void *pvParameters)
{ {
zh_avr_i2c_master_init(false); zh_avr_i2c_master_init(false);
for (;;) for (;;)
{ {
avr_err_t err = zh_avr_i2c_master_probe(0x38, 100 / portTICK_PERIOD_MS); avr_err_t err = zh_avr_i2c_master_probe(0x38, 100 / portTICK_PERIOD_MS);
if (err == AVR_OK) if (err == AVR_OK)
{ {
uint8_t data_send = 111; uint8_t data_send = 111;
uint8_t data_read = 0; uint8_t data_read = 0;
printf("Data Send %d.\n", data_send); printf("Data Send %d.\n", data_send);
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS); zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS); zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
printf("Data Read %d.\n", data_read); printf("Data Read %d.\n", data_read);
data_send = 55; data_send = 55;
printf("Data Send %d.\n", data_send); printf("Data Send %d.\n", data_send);
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS); zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS); zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
printf("Data Read %d.\n", data_read); printf("Data Read %d.\n", data_read);
data_send = 14; data_send = 14;
printf("Data Send %d.\n", data_send); printf("Data Send %d.\n", data_send);
zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS); zh_avr_i2c_master_transmit(0x38, (uint8_t *)&data_send, sizeof(data_send), 100 / portTICK_PERIOD_MS);
zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS); zh_avr_i2c_master_receive(0x38, (uint8_t *)&data_read, sizeof(data_read), 100 / portTICK_PERIOD_MS);
printf("Data Read %d.\n", data_read); printf("Data Read %d.\n", data_read);
} }
else else
{ {
printf("Device Not Found.\n"); printf("Device Not Found.\n");
} }
printf("Task Remaining Stack Size %d.\n", uxTaskGetStackHighWaterMark(NULL)); printf("Task Remaining Stack Size %d.\n", uxTaskGetStackHighWaterMark(NULL));
vTaskDelay(5000 / portTICK_PERIOD_MS); vTaskDelay(5000 / portTICK_PERIOD_MS);
} }
vTaskDelete(NULL); vTaskDelete(NULL);
} }
int main(void) int main(void)
{ {
UBRR0H = (BAUD_PRESCALE >> 8); UBRR0H = (BAUD_PRESCALE >> 8);
UBRR0L = BAUD_PRESCALE; UBRR0L = BAUD_PRESCALE;
UCSR0B = (1 << RXEN0) | (1 << TXEN0); UCSR0B = (1 << RXEN0) | (1 << TXEN0);
UCSR0C = (1 << UCSZ01) | (1 << UCSZ00); UCSR0C = (1 << UCSZ01) | (1 << UCSZ00);
stdout = &uart; stdout = &uart;
xTaskCreate(i2c_example_task, "i2c example task", 110, NULL, tskIDLE_PRIORITY, NULL); xTaskCreate(i2c_example_task, "i2c example task", 110, NULL, tskIDLE_PRIORITY, NULL);
vTaskStartScheduler(); vTaskStartScheduler();
return 0; return 0;
} }
```

View File

@@ -5,14 +5,30 @@
#include "avr/io.h" #include "avr/io.h"
#include "avr/interrupt.h" #include "avr/interrupt.h"
#include "stdbool.h" #include "stdbool.h"
#include "avr_err.h"
#include "avr_bit_defs.h"
#ifdef __cplusplus #ifdef __cplusplus
extern "C" extern "C"
{ {
#endif #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. * @brief Initialize I2C bus.
* *
@@ -23,37 +39,15 @@ extern "C"
avr_err_t zh_avr_i2c_master_init(const bool pullup); 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. * @param[in] xTicksToWait Wait timeout in FreeRTOS ticks.
* *
* @return AVR_OK if success or an error code otherwise. * @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); 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); 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_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 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

View File

@@ -1 +1 @@
1.1.0 1.0.0

View File

@@ -1,9 +1,15 @@
#include "zh_avr_i2c.h" #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_START ((1 << TWINT) | (1 << TWEN) | (1 << TWIE))
#define I2C_MASTER_READ 1 #define I2C_MASTER_READ 1

Binary file not shown.