Merge pull request #20430 from cogip/native_i2c_mock

cpu/native: introduce periph_i2c_mock

Author: crasbe

cpu/native/Makefile.dep

@@ -4,13 +4,19 @@ ifeq ($(OS),Linux)
       USEMODULE += periph_gpio_linux
     endif
   endif
+  ifneq (,$(filter periph_i2c,$(USEMODULE)))
+    USEMODULE += periph_i2c_mock
+  endif
   ifneq (,$(filter periph_spi,$(USEMODULE)))
     USEMODULE += periph_spidev_linux
   endif
 else
   ifneq (,$(filter periph_gpio,$(USEMODULE)))
     USEMODULE += periph_gpio_mock
   endif
+  ifneq (,$(filter periph_i2c,$(USEMODULE)))
+    USEMODULE += periph_i2c_mock
+  endif
 endif
 
 ifneq (,$(filter stdio_default,$(USEMODULE)))

cpu/native/Makefile.features

@@ -14,6 +14,7 @@ FEATURES_PROVIDED += periph_eeprom
 FEATURES_PROVIDED += periph_flashpage
 FEATURES_PROVIDED += periph_flashpage_pagewise
 FEATURES_PROVIDED += periph_hwrng
+FEATURES_PROVIDED += periph_i2c
 FEATURES_PROVIDED += periph_pm
 FEATURES_PROVIDED += periph_pwm
 FEATURES_PROVIDED += periph_timer_periodic

cpu/native/include/periph_conf.h

@@ -71,7 +71,21 @@ extern "C" {
 #  define QDEC_NUMOF (8U)
 #endif
 
-/* MARK: - SPI configuration (Linux host only) */
+/* MARK: - I2C configuration (mock implementation) */
+/**
+ * @name I2C configuration (mock implementation)
+ * @{
+ */
+#if !defined(I2C_NUMOF) || defined(DOXYGEN)
+/**
+ * @brief Amount of I2C devices
+ *
+ * Can be overridden during compile time with `CFLAGS+=-DI2C_NUMOF=n`.
+ */
+#  define I2C_NUMOF   1
+#endif
+/** @} */
+
 /**
  * @name SPI configuration (Linux host only)
  * @{

cpu/native/include/periph_cpu.h

@@ -68,13 +68,21 @@ extern "C" {
  * @brief Pull-down
  */
 #  if !defined(GPIOHANDLE_REQUEST_PULL_DOWN) || defined(DOXYGEN)
-#    define GPIOHANDLE_REQUEST_PULL_DOWN    (0xFF)
+#    if defined(GPIOHANDLE_REQUEST_BIAS_PULL_DOWN)
+#      define GPIOHANDLE_REQUEST_PULL_DOWN    GPIOHANDLE_REQUEST_BIAS_PULL_DOWN
+#    else
+#      define GPIOHANDLE_REQUEST_PULL_DOWN    (0xFF)
+#    endif
 #  endif
 /**
  * @brief Pull-up
  */
 #  if !defined(GPIOHANDLE_REQUEST_PULL_UP) || defined(DOXYGEN)
-#   define GPIOHANDLE_REQUEST_PULL_UP      (0xFF)
+#    if defined(GPIOHANDLE_REQUEST_BIAS_PULL_UP)
+#      define GPIOHANDLE_REQUEST_PULL_UP      GPIOHANDLE_REQUEST_BIAS_PULL_UP
+#    else
+#      define GPIOHANDLE_REQUEST_PULL_UP      (0xFF)
+#    endif
 #  endif
 
 /**
@@ -170,6 +178,27 @@ typedef gpio_mock_t* gpio_t;
 #define PROVIDES_PM_SET_LOWEST
 /** @} */
 
+/**
+ * @name I2C Configuration
+ *
+ * The common I2C implementation is requested to provide the default implementations of the
+ * `i2c_{read,write}_{reg,regs}` functions.
+ */
+
+#define PERIPH_I2C_NEED_READ_REG
+#define PERIPH_I2C_NEED_READ_REGS
+#define PERIPH_I2C_NEED_WRITE_REG
+#define PERIPH_I2C_NEED_WRITE_REGS
+
+#if defined(MODULE_PERIPH_I2C_MOCK) || defined(DOXYGEN)
+/**
+ * @brief   I2C configuration structure type
+ */
+typedef struct {
+    void *dummy;    /**< dummy attribute */
+} i2c_conf_t;
+#endif
+
 /* Configuration for the wrapper around the Linux SPI API (periph_spidev_linux)
  *
  * Needs to go here, otherwise the SPI_NEEDS_ are defined after inclusion of

cpu/native/periph/i2c_mock.c

@@ -0,0 +1,67 @@
+/*
+ * SPDX-FileCopyrightText: 2024 COGIP Robotics Association
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+
+/**
+ * @ingroup     cpu_native
+ * @ingroup     drivers_periph_i2c
+ * @{
+ *
+ * @file
+ * @brief       Pluggable no-op I2C implementation
+ *
+ * By default, operations on this bus will always succeed (without actually performing any
+ * action). Reads will produce zeros.
+ *
+ * To provide mocks of a particular connected device, application authors can provide any
+ * of the functions themselves, because all the I2C functions in this implementation are
+ * weak symbols. There is per-bus or per-address dispatch. That means that if multiple
+ * buses or devices are to be mocked with non-zero implementations, the application needs
+ * to provide a single implementation that fans out to the respective mocked device.
+ *
+ * @author      Gilles DOFFE <[email protected]>
+ */
+
+#include <string.h>
+
+#include "periph/i2c.h"
+
+__attribute__((weak)) void i2c_init(i2c_t dev)
+{
+    (void)dev;
+}
+
+__attribute__((weak)) void i2c_acquire(i2c_t dev)
+{
+    (void)dev;
+}
+
+__attribute__((weak)) void i2c_release(i2c_t dev)
+{
+    (void)dev;
+}
+
+__attribute__((weak)) int i2c_read_bytes(i2c_t dev, uint16_t addr,
+                   void *data, size_t len, uint8_t flags)
+{
+    (void)dev;
+    (void)addr;
+    memset(data, 0, len);
+    (void)len;
+    (void)flags;
+
+    return 0;
+}
+
+__attribute__((weak)) int i2c_write_bytes(i2c_t dev, uint16_t addr, const void *data,
+                    size_t len, uint8_t flags)
+{
+    (void)dev;
+    (void)addr;
+    (void)data;
+    (void)len;
+    (void)flags;
+
+    return 0;
+}

drivers/at24mac/at24mac.c

@@ -19,6 +19,8 @@
  */
 
 #include <errno.h>
+#include <stdbool.h>
+
 #include "kernel_defines.h"
 
 #include "at24mac.h"

drivers/bmx280/include/bmx280_params.h

@@ -24,6 +24,7 @@
 
 #include "board.h"
 #include "bmx280.h"
+#include "kernel_defines.h"
 #include "saul_reg.h"
 
 #ifdef __cplusplus

drivers/include/hm330x.h

@@ -32,6 +32,7 @@
  * @author      Francisco Molina <[email protected]>
  */
 
+#include "modules.h"
 #include "periph/i2c.h"
 #include "periph/gpio.h"
 

drivers/include/mcp23x17.h

@@ -346,6 +346,7 @@
 extern "C" {
 #endif
 
+#include "modules.h"
 #include "periph/gpio.h"
 #include "periph/i2c.h"
 #include "periph/spi.h"

drivers/include/vl6180x.h

@@ -400,6 +400,7 @@ extern "C"
 #include <stdbool.h>
 #include <stdint.h>
 
+#include "modules.h"
 #include "periph/gpio.h"
 #include "periph/i2c.h"