drivers: video: emul-imager: use the emulated I2C bus

Replace the ad-hoc register emulation by the dedicated I2C emulator,
making it usable with the same APIs as every other image sensors.

Signed-off-by: Josuah Demangeon <[email protected]>

Author: josuah

drivers/video/Kconfig.emul_imager

@@ -5,6 +5,7 @@ config VIDEO_EMUL_IMAGER
 	bool "Software implementation of an imager"
 	depends on DT_HAS_ZEPHYR_VIDEO_EMUL_IMAGER_ENABLED
 	default y
+	depends on EMUL
 	help
 	  Enable driver for the emulated Imager. A line buffer contains
 	  the color pattern within the imager data struct, at the first

drivers/video/video_emul_imager.c

@@ -15,30 +15,28 @@
 #include <zephyr/drivers/video.h>
 #include <zephyr/drivers/video-controls.h>
 #include <zephyr/drivers/i2c.h>
+#include <zephyr/drivers/i2c_emul.h>
 #include <zephyr/logging/log.h>
 
 LOG_MODULE_REGISTER(video_emul_imager, CONFIG_VIDEO_LOG_LEVEL);
 
-#define EMUL_IMAGER_REG_SENSOR_ID 0x0000
+#define EMUL_IMAGER_REG_SENSOR_ID 0x00
 #define EMUL_IMAGER_SENSOR_ID     0x99
-#define EMUL_IMAGER_REG_CTRL      0x0001
-#define EMUL_IMAGER_REG_INIT1     0x0002
-#define EMUL_IMAGER_REG_INIT2     0x0003
-#define EMUL_IMAGER_REG_TIMING1   0x0004
-#define EMUL_IMAGER_REG_TIMING2   0x0005
-#define EMUL_IMAGER_REG_TIMING3   0x0006
-#define EMUL_IMAGER_REG_CUSTOM    0x0007
-#define EMUL_IMAGER_REG_FORMAT    0x000a
+#define EMUL_IMAGER_REG_CTRL      0x01
+#define EMUL_IMAGER_REG_INIT1     0x02
+#define EMUL_IMAGER_REG_INIT2     0x03
+#define EMUL_IMAGER_REG_TIMING1   0x04
+#define EMUL_IMAGER_REG_TIMING2   0x05
+#define EMUL_IMAGER_REG_TIMING3   0x06
+#define EMUL_IMAGER_REG_CUSTOM    0x07
+#define EMUL_IMAGER_REG_FORMAT    0x0a
 #define EMUL_IMAGER_PATTERN_OFF   0x00
 #define EMUL_IMAGER_PATTERN_BARS1 0x01
 #define EMUL_IMAGER_PATTERN_BARS2 0x02
 
 /* Custom control that is just an I2C write for example and test purpose */
 #define EMUL_IMAGER_CID_CUSTOM (VIDEO_CID_PRIVATE_BASE + 0x01)
 
-/* Emulated register bank */
-uint8_t emul_imager_fake_regs[10];
-
 enum emul_imager_fmt_id {
 	RGB565_320x240,
 	YUYV_320x240,
@@ -152,21 +150,15 @@ static const struct video_format_cap fmts[] = {
 /* Emulated I2C register interface, to replace with actual I2C calls for real hardware */
 static int emul_imager_read_reg(const struct device *const dev, uint8_t reg_addr, uint8_t *value)
 {
-	LOG_DBG("Placeholder for I2C read from 0x%02x", reg_addr);
-	switch (reg_addr) {
-	case EMUL_IMAGER_REG_SENSOR_ID:
-		*value = EMUL_IMAGER_SENSOR_ID;
-		break;
-	default:
-		*value = emul_imager_fake_regs[reg_addr];
-	}
-	return 0;
+	const struct emul_imager_config *cfg = dev->config;
+
+	return i2c_write_read_dt(&cfg->i2c, &reg_addr, 1, value, 1);
 }
 
 /* Helper to read a full integer directly from a register */
 static int emul_imager_read_int(const struct device *const dev, uint8_t reg_addr, int *value)
 {
-	uint8_t val8;
+	uint8_t val8 = 0;
 	int ret;
 
 	ret = emul_imager_read_reg(dev, reg_addr, &val8);
@@ -177,9 +169,10 @@ static int emul_imager_read_int(const struct device *const dev, uint8_t reg_addr
 /* Some sensors will need reg8 or reg16 variants. */
 static int emul_imager_write_reg(const struct device *const dev, uint8_t reg_addr, uint8_t value)
 {
-	LOG_DBG("Placeholder for I2C write 0x%08x to 0x%02x", value, reg_addr);
-	emul_imager_fake_regs[reg_addr] = value;
-	return 0;
+	const struct emul_imager_config *cfg = dev->config;
+	uint8_t buf_w[] = {reg_addr, value};
+
+	return i2c_write_dt(&cfg->i2c, buf_w, 2);
 }
 
 static int emul_imager_write_multi(const struct device *const dev,
@@ -383,12 +376,13 @@ static DEVICE_API(video, emul_imager_driver_api) = {
 
 int emul_imager_init(const struct device *dev)
 {
+	const struct emul_imager_config *cfg = dev->config;
 	struct video_format fmt;
 	uint8_t sensor_id;
 	int ret;
 
-	if (/* !i2c_is_ready_dt(&cfg->i2c) */ false) {
-		/* LOG_ERR("Bus %s is not ready", cfg->i2c.bus->name); */
+	if (!i2c_is_ready_dt(&cfg->i2c)) {
+		LOG_ERR("Bus %s is not ready", cfg->i2c.bus->name);
 		return -ENODEV;
 	}
 
@@ -422,11 +416,58 @@ int emul_imager_init(const struct device *dev)
 	static struct emul_imager_data emul_imager_data_##inst;                                    \
                                                                                                    \
 	static const struct emul_imager_config emul_imager_cfg_##inst = {                          \
-		.i2c = /* I2C_DT_SPEC_INST_GET(inst) */ {0},                                       \
+		.i2c = I2C_DT_SPEC_INST_GET(inst),                                                 \
 	};                                                                                         \
                                                                                                    \
 	DEVICE_DT_INST_DEFINE(inst, &emul_imager_init, NULL, &emul_imager_data_##inst,             \
 			      &emul_imager_cfg_##inst, POST_KERNEL, CONFIG_VIDEO_INIT_PRIORITY,    \
 			      &emul_imager_driver_api);
 
 DT_INST_FOREACH_STATUS_OKAY(EMUL_IMAGER_DEFINE)
+
+/* Simulated I2C bus */
+
+static int emul_imager_transfer_i2c(const struct emul *target, struct i2c_msg msgs[], int num_msgs,
+				    int addr)
+{
+	static uint8_t fake_regs[10] = {
+		[EMUL_IMAGER_REG_SENSOR_ID] = EMUL_IMAGER_SENSOR_ID,
+	};
+
+	if (num_msgs == 0) {
+		CODE_UNREACHABLE;
+	} else if (num_msgs == 1 &&
+		   msgs[0].len == 2 && (msgs[0].flags & I2C_MSG_READ) == 0) {
+		/* Register write */
+		fake_regs[msgs[0].buf[0]] =  msgs[0].buf[1];
+	} else if (num_msgs == 2 &&
+		   msgs[0].len == 1 && (msgs[0].flags & I2C_MSG_READ) == 0 &&
+		   msgs[1].len == 1 && (msgs[1].flags & I2C_MSG_READ) == 0) {
+		/* Register write */
+		fake_regs[msgs[0].buf[0]] =  msgs[1].buf[0];
+	} else if (num_msgs == 2 &&
+		   msgs[0].len == 1 && (msgs[0].flags & I2C_MSG_READ) == 0 &&
+		   msgs[1].len == 1 && (msgs[1].flags & I2C_MSG_READ) != 0) {
+		/* Register read */
+		msgs[1].buf[0] = fake_regs[msgs[0].buf[0]];
+	} else {
+		LOG_ERR("Unsupported I2C operation of %u messages", num_msgs);
+		return -EIO;
+	}
+
+	return 0;
+}
+
+static const struct i2c_emul_api emul_imager_i2c_api = {
+	.transfer = emul_imager_transfer_i2c,
+};
+
+static int emul_imager_init_i2c(const struct emul *target, const struct device *dev)
+{
+	return 0;
+}
+
+#define EMUL_I2C_DEFINE(inst)                                                                      \
+	EMUL_DT_INST_DEFINE(inst, &emul_imager_init_i2c, NULL, NULL, &emul_imager_i2c_api, NULL);
+
+DT_INST_FOREACH_STATUS_OKAY(EMUL_I2C_DEFINE)

tests/drivers/video/api/app.overlay

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 tinyVision.ai Inc.
+ * Copyright (c) 2024-2025 tinyVision.ai Inc.
  * SPDX-License-Identifier: Apache-2.0
  */
 
@@ -8,31 +8,9 @@
 		#address-cells = <1>;
 		#size-cells = <1>;
 
-		test_i2c: i2c@10002000 {
-			#address-cells = <1>;
-			#size-cells = <0>;
-			compatible = "vnd,i2c";
-			reg = <0x10002000 0x1000>;
-			clock-frequency = <100000>;
-			status = "okay";
-
-			test_video_emul_imager: video_emul_imager@6 {
-				compatible = "zephyr,video-emul-imager";
-				status = "okay";
-				reg = <0x6>;
-
-				port {
-					test_video_emul_imager_ep_out: endpoint {
-						remote-endpoint-label = "test_video_emul_rx_ep_in";
-					};
-				};
-			};
-		};
-
 		test_video_emul_rx: video_emul_rx@10003000 {
 			compatible = "zephyr,video-emul-rx";
 			reg = <0x10003000 0x1000>;
-			status = "okay";
 
 			port {
 				#address-cells = <1>;
@@ -51,3 +29,18 @@
 		};
 	};
 };
+
+&i2c0 {
+	status = "okay";
+
+	test_video_emul_imager: video_emul_imager@6 {
+		compatible = "zephyr,video-emul-imager";
+		reg = <0x6>;
+
+		port {
+			test_video_emul_imager_ep_out: endpoint {
+				remote-endpoint-label = "test_video_emul_rx_ep_in";
+			};
+		};
+	};
+};

tests/drivers/video/api/prj.conf

@@ -9,3 +9,5 @@ CONFIG_VIDEO_BUFFER_POOL_NUM_MAX=1
 CONFIG_SYS_HEAP_BIG_ONLY=y
 
 CONFIG_VIDEO_LOG_LEVEL_DBG=y
+CONFIG_EMUL=y
+CONFIG_I2C=y