feat(core): third step of ArduinoCore-API migration – Wire (I2C)

Signed-off-by: Aymane Bahssain <aymane.bahssain@st.com>

Author: Aymane-ST

CI/build/examples/BareMinimum/BareMinimum.ino

@@ -5,6 +5,7 @@
  */
 
 #include <SoftwareSerial.h>
+#include <Wire.h>
 
 #ifndef USER_BTN
 #define USER_BTN 2
@@ -48,9 +49,35 @@ void setup() {
   }
   swSerial.end();
 
+    // Wire
+  Wire.setSCL(PIN_WIRE_SCL);
+  Wire.setSDA(digitalPinToPinName(PIN_WIRE_SDA));
+  Wire.setClock(400000);
+  Wire.begin(4);
+  Wire.onRequest(requestEvent);
+  Wire.onReceive(receiveEvent);
+  Wire.beginTransmission(4);
+  Wire.endTransmission();
+  Wire.requestFrom(2, 1);
+  Wire.end();
+
 }
 
 void loop() {
 }
 
+// Wire
+// function that executes whenever data is received from master
+// this function is registered as an event, see setup()
+void receiveEvent(int) {
+  while (1 < Wire.available()) {
+    Wire.read();
+  }
+}
+// function that executes whenever data is requested by master
+// this function is registered as an event, see setup()
+void requestEvent() {
+  Wire.write("x");
+}
+
 

CI/build/examples/BareMinimum/CMakeLists.txt

@@ -7,7 +7,6 @@ cmake_minimum_required(VERSION 3.21)
 # STEP 1: set up bases of environment
 # -----------------------------------------------------------------------------
 
-add_definitions(-DEXTENDED_PIN_MODE -DARDUINO_CORE_STM32)
 
 file(REAL_PATH "../../../../" CORE_PATH EXPAND_TILDE)
 file(TO_CMAKE_PATH "${CORE_PATH}" CORE_PATH)
@@ -49,5 +48,5 @@ build_sketch(TARGET "BareMinimum"
   # Servo
   SoftwareSerial
   # SPI
-  # Wire
+  Wire
 )

cmake/set_base_arduino_config.cmake

@@ -25,6 +25,7 @@ target_compile_definitions(base_config INTERFACE
 	USE_HAL_DRIVER
 	USE_FULL_LL_DRIVER
 	ARDUINO_ARCH_STM32
+  EXTENDED_PIN_MODE
 )
 target_compile_options(base_config INTERFACE
   -mthumb

libraries/Wire/src/Wire.cpp

@@ -33,7 +33,7 @@ static const uint8_t MASTER_ADDRESS = 0x01;
 
 // Constructors ////////////////////////////////////////////////////////////////
 
-TwoWire::TwoWire(uint32_t sda, uint32_t scl)
+TwoWire::TwoWire(pin_size_t sda, pin_size_t scl)
 {
   memset((void *)&_i2c, 0, sizeof(_i2c));
   _i2c.sda = digitalPinToPinName(sda);
@@ -56,7 +56,7 @@ TwoWire::~TwoWire()
 
 // Public Methods //////////////////////////////////////////////////////////////
 
-void TwoWire::begin(uint32_t sda, uint32_t scl)
+void TwoWire::begin(pin_size_t sda, pin_size_t scl)
 {
   _i2c.sda = digitalPinToPinName(sda);
   _i2c.scl = digitalPinToPinName(scl);
@@ -125,9 +125,9 @@ void TwoWire::end(void)
   rxBufferAllocated = 0;
 }
 
-void TwoWire::setClock(uint32_t frequency)
+void TwoWire::setClock(uint32_t freq)
 {
-  i2c_setTiming(&_i2c, frequency);
+  i2c_setTiming(&_i2c, freq);
   if (_i2c.isMaster == 0) {
     i2c_attachSlaveTxEvent(&_i2c, onRequestService);
     i2c_attachSlaveRxEvent(&_i2c, onReceiveService);
@@ -189,9 +189,9 @@ uint8_t TwoWire::requestFrom(uint8_t address, uint8_t quantity, uint8_t sendStop
   return requestFrom((uint8_t)address, (uint8_t)quantity, (uint32_t)0, (uint8_t)0, (uint8_t)sendStop);
 }
 
-uint8_t TwoWire::requestFrom(uint8_t address, size_t quantity, bool sendStop)
+size_t TwoWire::requestFrom(uint8_t address, size_t quantity, bool sendStop)
 {
-  return requestFrom((uint8_t)address, (uint8_t)quantity, (uint8_t)sendStop);
+  return (size_t)requestFrom((uint8_t)address, (uint8_t)quantity, (uint8_t)sendStop);
 }
 
 uint8_t TwoWire::requestFrom(uint8_t address, uint8_t quantity)
@@ -237,15 +237,15 @@ void TwoWire::beginTransmission(int address)
 //  no call to endTransmission(true) is made. Some I2C
 //  devices will behave oddly if they do not see a STOP.
 //
-uint8_t TwoWire::endTransmission(uint8_t sendStop)
+uint8_t TwoWire::endTransmission(bool stopBit)
 {
 #if !defined(I2C_OTHER_FRAME)
-  UNUSED(sendStop);
+  UNUSED(stopBit);
 #endif
   int8_t ret = 4;
   // check transfer options and store it in the I2C handle
 #if defined(I2C_OTHER_FRAME)
-  if (sendStop == 0) {
+  if (stopBit == 0) {
     _i2c.handle.XferOptions = I2C_OTHER_FRAME ;
   } else {
     _i2c.handle.XferOptions = I2C_OTHER_AND_LAST_FRAME;
@@ -292,7 +292,7 @@ uint8_t TwoWire::endTransmission(uint8_t sendStop)
 //
 uint8_t TwoWire::endTransmission(void)
 {
-  return endTransmission((uint8_t)true);
+  return endTransmission(true);
 }
 
 // must be called in:
@@ -454,12 +454,22 @@ void TwoWire::onReceive(cb_function_receive_t function)
   user_onReceive = function;
 }
 
+void TwoWire::onReceive(void(*function)(int))
+{
+  user_onReceive = function;
+}
+
 // sets function called on slave read
 void TwoWire::onRequest(cb_function_request_t function)
 {
   user_onRequest = function;
 }
 
+void TwoWire::onRequest(void(*function)(void))
+{
+  user_onRequest = function;
+}
+
 /**
   * @brief  Allocate the Rx/Tx buffer to the requested length if needed
   * @note   Minimum allocated size is BUFFER_LENGTH)

libraries/Wire/src/Wire.h

@@ -24,8 +24,8 @@
 
 #include <functional>
 
-#include "Stream.h"
 #include "Arduino.h"
+#include "api/HardwareI2C.h"
 extern "C" {
 #include "utility/twi.h"
 }
@@ -41,7 +41,7 @@ extern "C" {
 // WIRE_HAS_END means Wire has end()
 #define WIRE_HAS_END 1
 
-class TwoWire : public Stream {
+class TwoWire : public arduino::HardwareI2C {
   public:
     typedef std::function<void(int)> cb_function_receive_t;
     typedef std::function<void(void)> cb_function_request_t;
@@ -76,14 +76,14 @@ class TwoWire : public Stream {
     void recoverBus(void);
 
   public:
-    TwoWire(uint32_t sda = SDA, uint32_t scl = SCL);
+    TwoWire(pin_size_t sda = SDA, pin_size_t scl = SCL);
     ~TwoWire();
     // setSCL/SDA have to be called before begin()
-    void setSCL(uint32_t scl)
+    void setSCL(pin_size_t scl)
     {
       _i2c.scl = digitalPinToPinName(scl);
     };
-    void setSDA(uint32_t sda)
+    void setSDA(pin_size_t sda)
     {
       _i2c.sda = digitalPinToPinName(sda);
     };
@@ -95,31 +95,46 @@ class TwoWire : public Stream {
     {
       _i2c.sda = sda;
     };
-    void begin(bool generalCall = false);
-    void begin(uint32_t, uint32_t);
+    void begin(bool generalCall);
+    void begin(pin_size_t, pin_size_t);
     void begin(uint8_t, bool generalCall = false, bool NoStretchMode = false);
     void begin(int, bool generalCall = false, bool NoStretchMode = false);
-    void end();
-    void setClock(uint32_t);
-    void beginTransmission(uint8_t);
+    void begin() override
+    {
+      begin(false);
+    }
+    void begin(uint8_t address) override
+    {
+      begin(address, false, false);
+    }
+    void end() override;
+    void setClock(uint32_t freq) override;
+    void beginTransmission(uint8_t address) override;
     void beginTransmission(int);
-    uint8_t endTransmission(void);
-    uint8_t endTransmission(uint8_t);
+    uint8_t endTransmission(void) override;
+    uint8_t endTransmission(bool stopBit) override;
     uint8_t requestFrom(uint8_t, uint8_t);
     uint8_t requestFrom(uint8_t, uint8_t, uint8_t);
-    uint8_t requestFrom(uint8_t, size_t, bool);
+    size_t requestFrom(uint8_t address, size_t len, bool stopBit) override;
     uint8_t requestFrom(uint8_t, uint8_t, uint32_t, uint8_t, uint8_t);
     uint8_t requestFrom(int, int);
     uint8_t requestFrom(int, int, int);
-    virtual size_t write(uint8_t);
-    virtual size_t write(const uint8_t *, size_t);
-    virtual int available(void);
-    virtual int read(void);
-    virtual int peek(void);
-    virtual void flush(void);
+    size_t requestFrom(uint8_t address, size_t len) override
+    {
+      return (size_t)requestFrom(address, (uint8_t)len);
+    }
+
+    size_t write(uint8_t) override;
+    size_t write(const uint8_t *, size_t) override;
+    int available(void) override;
+    int read(void) override;
+    int peek(void) override;
+    void flush(void) override;
 
     void onReceive(cb_function_receive_t callback);
+    void onReceive(void (*)(int)) override;
     void onRequest(cb_function_request_t callback);
+    void onRequest(void (*)(void)) override;
 
     inline size_t write(unsigned long n)
     {