I2C это последовательный, синхронный, полудуплексный коммуникационный протокол, который позволяет существовать на одной шине несколько устройств master и slave. Шина I2C содержит 2 сигнала: последовательные данные (serial data line, SDA) и последовательные такты (serial clock, SCL). Оба сигнала подтянуты к лог. 1 верхними нагрузочными резисторами (pull-up).

У ESP32 есть два контроллера I2C (у ESP32-C3 контроллер I2C только один), которые отвечают за обработку обмена данными по шине I2C. Один контроллер I2C может работать либо как master, либо как slave. Однако не у всех чипов семейства ESP32 контроллер I2C может работать в режиме slave (например так у ESP32-C2).

В составе инструментария разработчика ESP-IDF [2] есть драйвер I2C, который обслуживает коммуникации по шине I2C. Драйвер поддерживает следующие функции:

● Чтение и запись байт в режиме Master.
● Режим Slave.
● Чтение и запись в регистров, которые в свою очередь считываются/записываются устройством master.

[Использование драйвера I2C]

В последующем описании описываются типовые шаги конфигурирования и разработки драйвера I2C.

1. Конфигурация - на этом шаге устанавливаются инициализационные параметры - режим master или slave, ножки GPIO для сигналов SDA и SCL, тактовая частота, и т. д.

2. Установка драйвера - активация драйвера на одном из двух контроллеров I2C в качестве устройства master или slave.

3. В зависимости от того, как конфигурируется драйвер - если сконфигурирован master, то управление коммуникациями. Если slave - ответ на сообщения от master.

4. Обработка прерываний - конфигурирование и обслуживание прерываний I2C.

5. Опционально дополнительная пользовательская настройка I2C - подстройка параметров по умолчанию (тайминги, порядок бит, и т. п.).

6. Обработка ошибок - как распознать и обработать ошибки конфигурации драйвера и ошибки коммуникации.

7. Удаление драйвера - освобождение ресурсов, используемых драйвером I2C, когда коммуникации завершены.

[Конфигурация]

Для установки обмена по шине I2C начинают с конфигурирования драйвера. Это делается путем установки параметров структуры i2c_config_t:

● Установка режима master или slave (значение перечисления i2c_mode_t).
● Конфигурирование ножек GPIO для SDA и SCL, установка при необходимости внутренней подтяжки pull-up.
● Установка скорости обмена (только для режима master).
● Только для режима slave - разрешение или нет 10-битного режима адресации, установка адреса.

После этого производится инициализация вызовом функции i2c_param_config() с передачей ей в качестве параметров номера контроллера I2C и структуры i2c_config_t.

Пример конфигурации для master:

int i2c_master_port = 0;

i2c_config_t conf = {
   .mode = I2C_MODE_MASTER,
   .sda_io_num = CONFIG_I2C_MASTER_SDA_IO,
   .sda_pullup_en = GPIO_PULLUP_ENABLE,
   .scl_io_num = CONFIG_I2C_MASTER_SCL_IO,
   .scl_pullup_en = GPIO_PULLUP_ENABLE,
   .master.clk_speed = CONFIG_I2C_MASTER_FREQ_HZ,
   // Здесь можно использовать флаги I2C_SCLK_SRC_FLAG_* для выбора
   // источника тактирования I2C:
   .clk_flags = 0,
};

Пример конфигурации для slave:

int i2c_slave_port = I2C_SLAVE_NUM;

i2c_config_t conf_slave = {
   .sda_io_num = CONFIG_I2C_SLAVE_SDA_IO,
   .sda_pullup_en = GPIO_PULLUP_ENABLE,
   .scl_io_num = CONFIG_I2C_SLAVE_SCL_IO,
   .scl_pullup_en = GPIO_PULLUP_ENABLE,
   .mode = I2C_MODE_SLAVE,
   .slave.addr_10bit_en = 0,
   .slave.slave_addr = CONFIG_ESP_SLAVE_ADDR,
   .clk_flags = 0,
};

На этом шаге i2c_param_config() также установит некоторые параметры конфигурации I2C в значения по умолчанию, которые определены спецификацией I2C. Подробнее об этом см. далее врезку "Дополнительная пользовательская настройка I2C".

Конфигурация источника тактирования. Добавляется clock allocator для поддержки различных источников тактирования. Он будет выбирать один из источников тактов, который удовлетворит всем требованиям по частоте и возможностям (как запрашивалось в i2c_config_t::clk_flags).

Когда поле i2c_config_t::clk_flags равно 0, clock allocator выберет только соответствие с желаемой частотой. Если нет необходимости в специальных возможностях, таких как APB, то вы можете конфигурировать clock allocator для выбора источника тактов только в соответствии с желаемой частотой. Для этого установите i2c_config_t::clk_flags в 0. Для характеристик тактов см. таблицу ниже.

Примечание: установленные такты недопустимы, если не соответствуют запрошенным возможностям, т. е. любой бит запрошенных возможностей (clk_flags) равен 0.

Таблица 1. Характеристики источников тактов ESP32.

Флаги i2c_config_t::clk_flags имеют следующее значение:

I2C_SCLK_SRC_FLAG_AWARE_DFS: скорость тактов I2C не меняется, когда меняется частота тактов APB.
I2C_SCLK_SRC_FLAG_LIGHT_SLEEP: поддерживается режим пониженного энергопотребления Light-sleep, в котором такты APB не работают.

Некоторые флаги могут не поддерживаться на ESP32, поэтому перед их использованием ознакомьтесь с техническим руководством.

Частота тактов SCL в режиме master не должна быть больше максимальной частоты для SCL, упомянутой в таблице выше.

(Максимальная) частота тактов SCL будет зависеть от номинала резисторов pull-up и емкости сигналов шины (или от емкости всех подключенных к шине устройств). Таким образом, пользователям следует выбрать корректный номинал резисторов pull-up, чтобы шина работала на нужной частоте. Обычно для протокола I2C выбирают резисторы pull-up в диапазоне от 1 кОм до 10 кОм, однако для разных частот могут понадобиться разные номиналы резисторов. В общем, чем выше выбранная частота, тем меньше должен быть номинал резисторов (но не меньше 1 кОм). Причина в том, что слишком большой резистор будет сильно ограничивать ток, приводя к увеличению времени нарастания уровня сигнала и уменьшению рабочей частоты шины. Обычно рекомендуется использовать резисторы в интервале 2 .. 5 кОм, однако может понадобиться уточнение номиналов, чтобы подогнать их под требования реального приложения.

[Инсталляция драйвера]

После того, как драйвер I2C был сконфигурирован, установите его путем вызова функции i2c_driver_install() со следующими параметрами:

● Номер порта (контроллера) I2C, тип i2c_port_t.
● Режим master или slave, выбранный из i2c_mode_t.
● (Только для режима slave) размер выделяемых буферов для передачи и приема данных. Поскольку принцип работы шины I2C ориентирован на устройство master, данные могут передаваться от slave к master только по запросу master. Таким образом, устройство slave должно иметь буфер отправки, кода приложение slave записывает данные. Данные остаются в буфере отправки, чтобы их мог прочитать master по своему усмотрению.
● Флаги для выделения прерывания (см. значения ESP_INTR_FLAG_* в esp_hw_support/include/esp_intr_alloc.h).

[Обмен в режиме master]

После установки I2C-драйвера ESP32 готов к обмену с другими устройствами I2C.

Контроллер I2C, работающий в режиме master, отвечает за установку обмена данными с устройствами I2C slave и отправку команд, приводящих в действие slave - например, для проведения измерения температуры и отправки считанных данных обратно к master.

Для улучшения организации этого процесса драйвер предоставляет контейнер, так называемый "command link", он должен быть заполнены последовательностью команд, и затем передан для выполнения контроллеру I2C.

Master Write. Пример ниже показывает, как строится command link для I2C master, чтобы отправить n байт устройству slave.

Рис. 1. I2C command link - пример записи master.

Следующее описание показывает, как работает command link для "master write", как он устанавливается, и что происходит внутри:

1. Создается command link вызовом функции i2c_cmd_link_create(). Затем command link заполняется последовательностью данных для отправки в slave:

(a) Start bit - вызовом i2c_master_start().
(b) Slave address - вызовом i2c_master_write_byte(). В качестве аргумента этой функции предоставляется один байт адреса.
(c) Data - один или большее количество байт в качестве аргумента i2c_master_write().
(d) Stop bit - вызовом i2c_master_stop().

У обоих функций i2c_master_write_byte() и i2c_master_write() есть дополнительный аргумент, указывающий, должен ли master убедиться, что получил бит ACK.

2. Запускается выполнение command link контроллером I2C путем вызова i2c_master_cmd_begin(). Как только выполнение началось, command link не может быть изменен.

3. После передачи команд освобождаются ресурсы, используемые для command link, путем вызова i2c_cmd_link_delete().

Master Read. Пример ниже показывает, как построить command link для I2C master, чтобы прочитать n байт из устройства slave.

Рис. 2. I2C command link - пример чтения master.

В сравнении с записью данных, command link заполняется на шаге 4 не вызовом функций i2c_master_write..., а i2c_master_read_byte() и/или i2c_master_read(). Также последнее чтение на шаге 5 конфигурируется так, что master не предоставляет бит ACK.

Индикация Write или Read. После отправки адреса slave-устройства (шаг 3 на обоих диаграммах рис. 1 и рис. 2), устройство master либо записывает в устройство slave, либо читает из него. Информация о том, какая из этих операций происходит, скрыта в самом младшем бите адреса slave-устройства.

По этой причине command link, посылаемый устройством master для записи данных в slave, содержит адрес (ESP_SLAVE_ADDR << 1) | I2C_MASTER_WRITE, и это выглядит следующим образом:

i2c_master_write_byte(cmd, (ESP_SLAVE_ADDR << 1) | I2C_MASTER_WRITE, ACK_EN);

Для чтения из slave вызов будет выглядеть так:

i2c_master_write_byte(cmd, (ESP_SLAVE_ADDR << 1) | I2C_MASTER_READ, ACK_EN);

[Обмен в режиме slave]

После инсталляции I2C-драйвера ESP32 готов к обмену с другими устройствами I2C. Для режима slave предоставляются следующие API-функции:

i2c_slave_read_buffer(). Всякий раз, когда master записывает данные в устройство slave, slave будет автоматически сохранять записанные данные в буфер приема. Это позволяет приложению slave вызвать функцию i2c_slave_read_buffer(), когда это необходимо. У этой функции также есть параметр, указывающий время блокировки, если в буфере приема нет данных. Это позволяет приложению slave ждать в течение указанного таймаута момента поступления данных в буфер.

i2c_slave_write_buffer(). Буфер отправки используется для хранения данных, которые устройство slave хочет отправить устройству master, в порядке следования FIFO. Данные остаются здесь, пока master не запросит их. У функции i2c_slave_write_buffer() есть параметр для указания времени блокировки, если буфер отправки уже заполнен. Это позволит приложению slave application ждать в течение указанного таймаута появления в буфере отправки адекватного пространства.

Пример кода, где показано использование этих функций, можно найти в $ESPIDF_PATH/examples/peripherals/i2c.

Обработка прерываний. Во время инсталляции драйвера по умолчанию также устанавливается обработчик прерывания I2C.

[Обработка ошибок]

Основные функции драйвера I2C либо возвратят ESP_OK при успешном завершении, либо определенный код ошибки в случае неудачи. Хорошая практика - всегда проверять возвращаемые из функций значения и предусмотреть обработку ошибок. Драйвер также печатает в лог сообщения, которые детализируют ошибку, например при проверке допустимости введенной конфигурации. Для подробностей см. файл driver/i2c.c и определения с суффиксом _ERR_STR.

Используйте выделенные прерывания для захвата отказов коммуникаций. Например, если slave растягивает сигнал тактов на слишком большое время, когда подготавливает отправку данных обратно к master, сработает прерывание I2C_TIME_OUT_INT.

В случае ошибки обмена вы можете сбросить внутренние аппаратные буферы вызовом функций i2c_reset_tx_fifo() и i2c_reset_rx_fifo() для буферов отправки и приема соответственно.

[Пример приложения]

См. $ESPIDF_PATH/examples/peripherals/i2c.

Ниже в таблице приведено общее описание функций. Полное описание функций, типов данных и определений см. в документации [1].

Примечание: не все функции Espressif поддерживают режим slave, например ESP32C2. Функции с корнем _master_ должны вызваться только в режиме I2C master, функции с корнем _slave_ должны вызываться только в режиме I2C slave.

[Ссылки]

1. ESP32 Inter-Integrated Circuit (I2C) site:espressif.com.
2. Установка среды разработки ESP-IDF для ESP32.