Fixes Arduino Wire::begin overload #7000

SuGlider · 2022-07-16T22:03:49Z

Description of Change

There some issues with Wire::begin() overload.
This PR fixes most issues and makes Wire API fully compatible with Arduino Mainstream.

Tests scenarios

#include <Wire.h>

#if CONFIG_IDF_TARGET_ESP32
  #define SDA_1 14
  #define SCL_1 15
#else
  #define SDA_1 10
  #define SCL_1 11
#endif
#define SLV_ADDR 0x21

void setup() {
  Serial.begin(115200);
  Serial.println("\nFor better results, turn Core Debug Level to Verbose.\n");

  // I2C MASTER Test Cases
  Serial.println("\nUC 1.1 - Master - default SDA/SCL pins, default 100KHz bus");
  Wire.end(); Wire.begin();

  Serial.println("\nUC 1.2 - Master - default SDA/SCL pins, default 100KHz bus");
  Wire.end(); Wire.begin(-1, -1);
  
  Serial.println("\nUC 1.3 - Master - default SDA/SCL pins, 1KHz bus");
  Wire.end(); Wire.begin(-1, -1, 1000);
  
  Serial.println("\nUC 1.4 - Master - default SDA, SCL pin 2, 2KHz bus");
  Wire.end(); Wire.begin(-1, 2, 2000);

  Serial.println("\nUC 1.5 - Master - default SDA/SCL pins, 400KHz bus");
  Wire.end(); Wire.begin(SDA, SCL, 400000);

#if CONFIG_IDF_TARGET_ESP32
  // Pins 6-11 are on ESP32 connected to SPI-FLASH and cannot be used for I2C, otherwise, it would lead to WDT
  Serial.println("\nUC 1.6 - Master default SDA pin 12, SCL pin 13, 800KHz bus");
  Wire.end(); Wire.begin(12, 13, 800000);

  Serial.println("\nUC 1.7 - Master - SDA pin 12, SCL pin 13, default 100KHz bus");
  Wire.end(); Wire.begin(12,13);

  Serial.println("\nUC 1.8 - Master - SDA pin 14, SCL pin 15, 200KHz bus");
  Wire.end(); Wire.begin(SDA_1, SCL_1, 200000);
#else
  Serial.println("\nUC 1.6 - Master default SDA pin 8, SCL pin 9, 800KHz bus");
  Wire.end(); Wire.begin(8, 9, 800000);
  
  Serial.println("\nUC 1.7 - Master - SDA pin 8, SCL pin 9, default 100KHz bus");
  Wire.end(); Wire.begin(8,9);
  
  Serial.println("\nUC 1.8 - Master - SDA pin 10, SCL pin 11, 200KHz bus");
  Wire.end(); Wire.begin(SDA_1, SCL_1, 200000);
#endif
  Serial.println("\nUC 1.9 - Master - default SDA/SCL pins, default 100KHz bus");
  Wire.end(); Wire.begin(SDA, SCL);
  
  Serial.println("\nUC 1.10 - Master - default SDA/SCL pins, 4KHz bus");
  Wire.end(); Wire.begin(-1, -1, 4000);
  
  Serial.println("\nUC 1.11 - Master - default SDA/SCL pins, default 100KHz bus");
  Wire.end(); Wire.begin((int) SDA , (int) SCL);

  // I2C SLAVE Test Cases
  Serial.println("\nUC 2.1 - Slave - ADDR 0x28 - default SDA/SCL pins, default 100KHz bus");
  Wire.end(); Wire.begin(0x28);
  
  Serial.println("\nUC 2.2 - Slave - ADDR 0x21 - default SDA/SCL pins, default 100KHz bus");
  Wire.end(); Wire.begin(SLV_ADDR);
  
  Serial.println("\nUC 2.3 - Slave - ADDR 0x21 - default SDA/SCL pins, 4KHz bus");
  Wire.end(); Wire.begin(SLV_ADDR, -1, -1, 4000);
  
  Serial.println("\nUC 2.4 - Slave - ADDR 0x38 - SDA 10, SCL 11, default 100KHz bus");
  Wire.end(); Wire.begin(0x38, SDA_1, SCL_1, 0);
  
  Serial.println("\nUC 2.5 - Slave - ADDR 0x38 - default SDA/SCL pins, 4KHz bus");
  Wire.end(); Wire.begin(0x38, -1, SCL, 4000);

}

void loop() {
}

Debug Output on C3

ESP-ROM:esp32c3-api1-20210207
Build:Feb  7 2021
rst:0x1 (POWERON),boot:0xc (SPI_FAST_FLASH_BOOT)
SPIWP:0xee
mode:DIO, clock div:1
load:0x3fcd6100,len:0x438
load:0x403ce000,len:0x918
load:0x403d0000,len:0x24e4
SHA-256 comparison failed:
Calculated: 080c5cb68a075ced55f248b97bca965e3e5bd5da80a64e34e6a1638f89d6f64e
Expected: ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
Attempting to boot anyway...
entry 0x403ce000

For better results, turn Core Debug Level to Verbose.


UC 1.1 - Master - default SDA/SCL pins, default 100KHz bus
[   102][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=100000

UC 1.2 - Master - default SDA/SCL pins, default 100KHz bus
[   119][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=100000

UC 1.3 - Master - default SDA/SCL pins, 1KHz bus
[   132][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=1000

UC 1.4 - Master - default SDA, SCL pin 2, 2KHz bus
[   145][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=2 freq=2000

UC 1.5 - Master - default SDA/SCL pins, 400KHz bus
[   157][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=400000

UC 1.6 - Master default SDA pin 8, SCL pin 9, 800KHz bus
[   170][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=800000

UC 1.7 - Master - SDA pin 8, SCL pin 9, default 100KHz bus
[   183][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=100000

UC 1.8 - Master - SDA pin 10, SCL pin 11, 200KHz bus
[   196][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=10 scl=11 freq=200000

UC 1.9 - Master - default SDA/SCL pins, default 100KHz bus
[   209][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=100000

UC 1.10 - Master - default SDA/SCL pins, 4KHz bus
[   223][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=4000

UC 1.11 - Master - default SDA/SCL pins, default 100KHz bus
[   235][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=100000

UC 2.1 - Slave - ADDR 0x28 - default SDA/SCL pins, default 100KHz bus
[   249][I][esp32-hal-i2c-slave.c:234] i2cSlaveInit(): Initialising I2C Slave: sda=8 scl=9 freq=100000, addr=0x28
[   255][D][esp32-hal-i2c-slave.c:486] i2c_slave_set_frequency(): Fifo thresholds: rx_fifo_full = 28, tx_fifo_empty = 4

UC 2.2 - Slave - ADDR 0x21 - default SDA/SCL pins, default 100KHz bus
[   276][I][esp32-hal-i2c-slave.c:234] i2cSlaveInit(): Initialising I2C Slave: sda=8 scl=9 freq=100000, addr=0x21
[   281][D][esp32-hal-i2c-slave.c:486] i2c_slave_set_frequency(): Fifo thresholds: rx_fifo_full = 28, tx_fifo_empty = 4

UC 2.3 - Slave - ADDR 0x21 - default SDA/SCL pins, 4KHz bus
[   302][I][esp32-hal-i2c-slave.c:234] i2cSlaveInit(): Initialising I2C Slave: sda=8 scl=9 freq=4000, addr=0x21
[   307][D][esp32-hal-i2c-slave.c:486] i2c_slave_set_frequency(): Fifo thresholds: rx_fifo_full = 30, tx_fifo_empty = 2

UC 2.4 - Slave - ADDR 0x38 - SDA 10, SCL 11, default 100KHz bus
[   328][I][esp32-hal-i2c-slave.c:234] i2cSlaveInit(): Initialising I2C Slave: sda=10 scl=11 freq=100000, addr=0x38
[   333][D][esp32-hal-i2c-slave.c:486] i2c_slave_set_frequency(): Fifo thresholds: rx_fifo_full = 28, tx_fifo_empty = 4

UC 2.5 - Slave - ADDR 0x38 - default SDA/SCL pins, 4KHz bus
[   354][I][esp32-hal-i2c-slave.c:234] i2cSlaveInit(): Initialising I2C Slave: sda=10 scl=9 freq=4000, addr=0x38
[   359][D][esp32-hal-i2c-slave.c:486] i2c_slave_set_frequency(): Fifo thresholds: rx_fifo_full = 30, tx_fifo_empty = 2

Related links

Fixes #6616

P-R-O-C-H-Y · 2022-07-18T11:02:35Z

@SuGlider Tested on C3 and gets same result, ~~but when tested on ESP32 I got only this output and then it gets reset by TG1WDT_SYS_RESET~~

For better results, turn Core Debug Level to Verbose.

UC 1.1 - Master - default SDA/SCL pins, default 100KHz bus
[    11][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=21 scl=22 freq=100000

UC 1.2 - Master - default SDA/SCL pins, default 100KHz bus
[    29][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=21 scl=22 freq=100000

UC 1.3 - Master - default SDA/SCL pins, 1KHz bus
[    42][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=21 scl=22 freq=1000

UC 1.4 - Master - default SDA, SCL pin 2, 2KHz bus
[    55][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=21 scl=2 freq=2000

UC 1.5 - Master - default SDA/SCL pins, 400KHz bus
[    67][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=21 scl=22 freq=400000

UC 1.6 - Master default SDA pin 8, SCL pin 9, 800KHz bus
[    80][I][esp32-hal-i2c.c:75] i2cInit(): Initialising I2C Master: sda=8 scl=9 freq=800000

rst:0x8 (TG1WDT_SYS_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)

====
EDIT:

Working as expected too on ESP32, just have to change the pins to test your sketch.

P-R-O-C-H-Y

LGMT :) Everything looks great

PilnyTomas · 2022-07-21T13:50:14Z

Sorry for the delay.
Tested on ESP32, C3, and S2.
C3 and S2 seem to be ok, but ESP32 is failing on 1.6 - after i2cInit() is triggered Watch Dog.

Attaching logs:
C3.log
S2.log

P-R-O-C-H-Y · 2022-07-21T14:58:19Z

Sorry for the delay.
Tested on ESP32, C3, and S2.
C3 and S2 seem to be ok, but ESP32 is failing on 1.6 - after i2cInit() is triggered Watch Dog.

Attaching logs:
C3.log
S2.log

Have you changed pins for ESP32?

PilnyTomas · 2022-07-21T15:23:24Z

Nope :D what is the problem with them?

SuGlider · 2022-07-21T16:22:34Z

Nope :D what is the problem with them?

on ESP32 pins 8 and 9 are used for Flash.
WDT is expected. In that case, it is necessary to change the pins in the sketch.

PilnyTomas · 2022-07-25T06:38:07Z

I have updated your test with #if CONFIG_IDF_TARGET_ESP32 and changed the pins for ESP32, now it should pass all chips without manual change.

PilnyTomas

OK

Fixes Arduino Wire::begin overload

c3192f5

SuGlider added this to the 2.0.5 milestone Jul 16, 2022

SuGlider self-assigned this Jul 16, 2022

This was referenced Jul 16, 2022

Fix for confusing overload of Wire::begin #6984

Closed

Confusing overload of Wire::begin #6616

Closed

SuGlider requested review from me-no-dev, P-R-O-C-H-Y and PilnyTomas July 16, 2022 22:12

P-R-O-C-H-Y approved these changes Jul 18, 2022

View reviewed changes

SuGlider added 2 commits July 18, 2022 19:05

Merge branch 'master' into wireBegin

5c625d2

Merge branch 'master' into wireBegin

d148c94

Merge branch 'master' into wireBegin

5dc4807

PilnyTomas approved these changes Jul 25, 2022

View reviewed changes

VojtechBartoska added the Status: Pending Merge Pull Request is ready to be merged label Jul 25, 2022

Merge branch 'master' into wireBegin

e91f303

SuGlider merged commit 45f4bef into espressif:master Jul 26, 2022

SuGlider deleted the wireBegin branch July 26, 2022 09:54

SuGlider mentioned this pull request Jul 26, 2022

Missing setDefaultFrequency() for Wire.begin() cleanup #5518

Closed

japhillips87 mentioned this pull request Sep 10, 2022

Problem with ESP32 wire RobTillaart/PCA9635#17

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes Arduino Wire::begin overload #7000

Fixes Arduino Wire::begin overload #7000

SuGlider commented Jul 16, 2022 •

edited by PilnyTomas

Loading

P-R-O-C-H-Y commented Jul 18, 2022 •

edited

Loading

P-R-O-C-H-Y left a comment

PilnyTomas commented Jul 21, 2022

P-R-O-C-H-Y commented Jul 21, 2022

PilnyTomas commented Jul 21, 2022

SuGlider commented Jul 21, 2022 •

edited

Loading

PilnyTomas commented Jul 25, 2022

PilnyTomas left a comment

Fixes Arduino Wire::begin overload #7000

Fixes Arduino Wire::begin overload #7000

Conversation

SuGlider commented Jul 16, 2022 • edited by PilnyTomas Loading

Description of Change

Tests scenarios

Debug Output on C3

Related links

P-R-O-C-H-Y commented Jul 18, 2022 • edited Loading

P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

PilnyTomas commented Jul 21, 2022

P-R-O-C-H-Y commented Jul 21, 2022

PilnyTomas commented Jul 21, 2022

SuGlider commented Jul 21, 2022 • edited Loading

PilnyTomas commented Jul 25, 2022

PilnyTomas left a comment

Choose a reason for hiding this comment

SuGlider commented Jul 16, 2022 •

edited by PilnyTomas

Loading

P-R-O-C-H-Y commented Jul 18, 2022 •

edited

Loading

SuGlider commented Jul 21, 2022 •

edited

Loading