drivers: video: emul_imager: switch to the CCI library for I2C

Use the newly introduced CCI library instead of local implementation of
I2C read/write commands. Modify the emulated imager registers to make
the need for the CCI library appear.

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

Author: josuah

drivers/video/video_emul_imager.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 tinyVision.ai Inc.
+ * Copyright (c) 2024-2025 tinyVision.ai Inc.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -18,36 +18,39 @@
 #include <zephyr/drivers/i2c_emul.h>
 #include <zephyr/logging/log.h>
 
+#include "video_common.h"
 #include "video_ctrls.h"
 #include "video_device.h"
 
 LOG_MODULE_REGISTER(video_emul_imager, CONFIG_VIDEO_LOG_LEVEL);
 
-#define EMUL_IMAGER_REG_SENSOR_ID 0x00
-#define EMUL_IMAGER_SENSOR_ID     0x99
-#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
+#define EMUL_IMAGER_REG8(addr) ((addr) | VIDEO_REG_ADDR8_DATA8)
+#define EMUL_IMAGER_REG16(addr) ((addr) | VIDEO_REG_ADDR8_DATA16_BE)
+#define EMUL_IMAGER_REG24(addr) ((addr) | VIDEO_REG_ADDR8_DATA24_BE)
+
+#define EMUL_IMAGER_REG_SENSOR_ID EMUL_IMAGER_REG16(0x00)
+#define EMUL_IMAGER_SENSOR_ID     0x2025
+#define EMUL_IMAGER_REG_CTRL      EMUL_IMAGER_REG8(0x02)
+#define EMUL_IMAGER_REG_TIMING1   EMUL_IMAGER_REG16(0x04)
+#define EMUL_IMAGER_REG_TIMING2   EMUL_IMAGER_REG16(0x06)
+#define EMUL_IMAGER_REG_TIMING3   EMUL_IMAGER_REG16(0x08)
+#define EMUL_IMAGER_REG_CUSTOM    EMUL_IMAGER_REG24(0x10)
+#define EMUL_IMAGER_REG_FORMAT    EMUL_IMAGER_REG8(0x20)
 
 /* Custom control that is just an I2C write for example and test purpose */
 #define EMUL_IMAGER_CID_CUSTOM (VIDEO_CID_PRIVATE_BASE + 0x01)
 
+/* Helper to avoid repetition */
+#define EMUL_IMAGER_REG_LIST(array) {.regs = (array), .size = ARRAY_SIZE(array)}
+
 enum emul_imager_fmt_id {
 	RGB565_320x240,
 	YUYV_320x240,
 };
 
-struct emul_imager_reg {
-	uint16_t addr;
-	uint8_t value;
+struct emul_imager_reg_list {
+	const struct video_reg *regs;
+	size_t size;
 };
 
 struct emul_imager_mode {
@@ -56,8 +59,7 @@ struct emul_imager_mode {
 	 * This permits to deduplicate the list of registers in case some lare sections
 	 * are repeated across modes, such as the resolution for different FPS.
 	 */
-	const struct emul_imager_reg *regs[3];
-	/* More fields can be added according to the needs of the sensor driver */
+	const struct emul_imager_reg_list lists[3];
 };
 
 struct emul_imager_config {
@@ -79,53 +81,109 @@ struct emul_imager_data {
 };
 
 /* All the I2C registers sent on various scenario */
-static const struct emul_imager_reg emul_imager_init_regs[] = {
-	{EMUL_IMAGER_REG_CTRL, 0x00},
-	{EMUL_IMAGER_REG_INIT1, 0x10},
-	{EMUL_IMAGER_REG_INIT2, 0x00},
+static const struct video_reg8 emul_imager_init_regs[] = {
 	/* Undocumented registers from the vendor */
-	{0x80, 0x01},
-	{0x84, 0x01},
-	{0x85, 0x20},
-	{0x89, 0x7f},
-	{0},
+	{0xe3, 0x60},
+	{0x9e, 0xd3},
+	{0x05, 0x5d},
+	{0x39, 0xf7},
+	{0xf0, 0xef},
+	{0xe8, 0x40},
+	{0x6d, 0x16},
+	{0x16, 0x33},
+	{0xeb, 0xa7},
+	{0xb8, 0x1f},
+	{0x45, 0xb7},
+	{0x26, 0x3a},
+	{0x6e, 0x32},
+	{0x1b, 0x9e},
+	{0xd3, 0xf7},
+	{0xd3, 0xb3},
+	{0x7b, 0x64},
+	{0xa3, 0xaf},
+	{0x3c, 0x6e},
+	{0x11, 0x2d},
+	{0x15, 0x67},
+	{0xb9, 0xc8},
+	{0x12, 0xc8},
+	{0xa6, 0x31},
+	{0x0e, 0x7c},
+	{0x7b, 0x64},
+	{0xf8, 0x5f},
+	{0x44, 0x27},
+	{0xc5, 0x9a},
+	{0x8d, 0x54},
 };
-static const struct emul_imager_reg emul_imager_rgb565[] = {
+static const struct video_reg emul_imager_rgb565[] = {
 	{EMUL_IMAGER_REG_FORMAT, 0x01},
-	{0},
 };
-static const struct emul_imager_reg emul_imager_yuyv[] = {
+static const struct video_reg emul_imager_yuyv[] = {
 	{EMUL_IMAGER_REG_FORMAT, 0x02},
-	{0},
 };
-static const struct emul_imager_reg emul_imager_320x240[] = {
-	{EMUL_IMAGER_REG_TIMING1, 0x32},
-	{EMUL_IMAGER_REG_TIMING2, 0x24},
-	{0},
+static const struct video_reg emul_imager_320x240[] = {
+	{EMUL_IMAGER_REG_TIMING1, 320},
+	{EMUL_IMAGER_REG_TIMING2, 240},
+};
+static const struct video_reg emul_imager_160x120[] = {
+	{EMUL_IMAGER_REG_TIMING1, 160},
+	{EMUL_IMAGER_REG_TIMING2, 120},
 };
-static const struct emul_imager_reg emul_imager_15fps[] = {
+static const struct video_reg emul_imager_15fps[] = {
 	{EMUL_IMAGER_REG_TIMING3, 15},
-	{0},
 };
-static const struct emul_imager_reg emul_imager_30fps[] = {
+static const struct video_reg emul_imager_30fps[] = {
 	{EMUL_IMAGER_REG_TIMING3, 30},
-	{0},
 };
-static const struct emul_imager_reg emul_imager_60fps[] = {
+static const struct video_reg emul_imager_60fps[] = {
 	{EMUL_IMAGER_REG_TIMING3, 60},
-	{0},
 };
 
 /* Description of "modes", that pick lists of registesr that will be all sentto the imager */
 struct emul_imager_mode emul_imager_rgb565_320x240_modes[] = {
-	{.fps = 15, .regs = {emul_imager_320x240, emul_imager_rgb565, emul_imager_15fps}},
-	{.fps = 30, .regs = {emul_imager_320x240, emul_imager_rgb565, emul_imager_30fps}},
-	{.fps = 60, .regs = {emul_imager_320x240, emul_imager_rgb565, emul_imager_60fps}},
+	{
+		.fps = 15,
+		.lists = {
+			EMUL_IMAGER_REG_LIST(emul_imager_320x240),
+			EMUL_IMAGER_REG_LIST(emul_imager_rgb565),
+			EMUL_IMAGER_REG_LIST(emul_imager_15fps),
+		},
+	},
+	{
+		.fps = 30,
+		.lists = {
+			EMUL_IMAGER_REG_LIST(emul_imager_320x240),
+			EMUL_IMAGER_REG_LIST(emul_imager_rgb565),
+			EMUL_IMAGER_REG_LIST(emul_imager_30fps),
+		},
+	},
+	{
+		.fps = 60,
+		.lists = {
+			EMUL_IMAGER_REG_LIST(emul_imager_320x240),
+			EMUL_IMAGER_REG_LIST(emul_imager_rgb565),
+			EMUL_IMAGER_REG_LIST(emul_imager_60fps),
+		},
+	},
 	{0},
 };
+
 struct emul_imager_mode emul_imager_yuyv_320x240_modes[] = {
-	{.fps = 15, .regs = {emul_imager_320x240, emul_imager_yuyv, emul_imager_15fps}},
-	{.fps = 30, .regs = {emul_imager_320x240, emul_imager_yuyv, emul_imager_30fps}},
+	{
+		.fps = 15,
+		.lists = {
+			EMUL_IMAGER_REG_LIST(emul_imager_320x240),
+			EMUL_IMAGER_REG_LIST(emul_imager_yuyv),
+			EMUL_IMAGER_REG_LIST(emul_imager_15fps),
+		}
+	},
+	{
+		.fps = 30,
+		.lists = {
+			EMUL_IMAGER_REG_LIST(emul_imager_320x240),
+			EMUL_IMAGER_REG_LIST(emul_imager_yuyv),
+			EMUL_IMAGER_REG_LIST(emul_imager_30fps),
+		}
+	},
 	{0},
 };
 
@@ -155,47 +213,18 @@ static const struct video_format_cap fmts[] = {
 	{0},
 };
 
-/* 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)
-{
-	const struct emul_imager_config *cfg = dev->config;
-
-	return i2c_write_read_dt(&cfg->i2c, &reg_addr, 1, value, 1);
-}
-
-/* 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)
-{
-	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,
-				   const struct emul_imager_reg *regs)
-{
-	int ret;
-
-	for (int i = 0; regs[i].addr != 0; i++) {
-		ret = emul_imager_write_reg(dev, regs[i].addr, regs[i].value);
-		if (ret < 0) {
-			return ret;
-		}
-	}
-	return 0;
-}
-
 static int emul_imager_set_ctrl(const struct device *dev, uint32_t id)
 {
+	const struct emul_imager_config *cfg = dev->config;
 	struct emul_imager_data *data = dev->data;
 
-	return emul_imager_write_reg(dev, EMUL_IMAGER_REG_CUSTOM, data->ctrls.custom.val);
+	return video_write_cci_reg(&cfg->i2c, EMUL_IMAGER_REG_CUSTOM, data->ctrls.custom.val);
 }
 
 /* Customize this function according to your "struct emul_imager_mode". */
 static int emul_imager_set_mode(const struct device *dev, const struct emul_imager_mode *mode)
 {
+	const struct emul_imager_config *cfg = dev->config;
 	struct emul_imager_data *data = dev->data;
 	int ret;
 
@@ -207,7 +236,9 @@ static int emul_imager_set_mode(const struct device *dev, const struct emul_imag
 
 	/* Apply all the configuration registers for that mode */
 	for (int i = 0; i < 2; i++) {
-		ret = emul_imager_write_multi(dev, mode->regs[i]);
+		const struct emul_imager_reg_list *list = &mode->lists[i];
+
+		ret = video_write_cci_multiregs(&cfg->i2c, list->regs, list->size);
 		if (ret < 0) {
 			goto err;
 		}
@@ -312,7 +343,9 @@ static int emul_imager_get_caps(const struct device *dev, struct video_caps *cap
 
 static int emul_imager_set_stream(const struct device *dev, bool enable, enum video_buf_type type)
 {
-	return emul_imager_write_reg(dev, EMUL_IMAGER_REG_CTRL, enable ? 1 : 0);
+	const struct emul_imager_config *cfg = dev->config;
+
+	return video_write_cci_reg(&cfg->i2c, EMUL_IMAGER_REG_CTRL, enable ? 1 : 0);
 }
 
 static DEVICE_API(video, emul_imager_driver_api) = {
@@ -339,21 +372,22 @@ int emul_imager_init(const struct device *dev)
 {
 	const struct emul_imager_config *cfg = dev->config;
 	struct video_format fmt;
-	uint8_t sensor_id;
+	uint32_t sensor_id;
 	int ret;
 
 	if (!i2c_is_ready_dt(&cfg->i2c)) {
 		LOG_ERR("Bus %s is not ready", cfg->i2c.bus->name);
 		return -ENODEV;
 	}
 
-	ret = emul_imager_read_reg(dev, EMUL_IMAGER_REG_SENSOR_ID, &sensor_id);
+	ret = video_read_cci_reg(&cfg->i2c, EMUL_IMAGER_REG_SENSOR_ID, &sensor_id);
 	if (ret < 0 || sensor_id != EMUL_IMAGER_SENSOR_ID) {
 		LOG_ERR("Failed to get a correct sensor ID 0x%x",  sensor_id);
 		return ret;
 	}
 
-	ret = emul_imager_write_multi(dev, emul_imager_init_regs);
+	ret = video_write_cci_multiregs(&cfg->i2c, emul_imager_init_regs,
+					ARRAY_SIZE(emul_imager_init_regs));
 	if (ret < 0) {
 		LOG_ERR("Could not set initial registers");
 		return ret;
@@ -395,7 +429,9 @@ static int emul_imager_transfer_i2c(const struct emul *target, struct i2c_msg ms
 				    int addr)
 {
 	static uint8_t fake_regs[UINT8_MAX] = {
-		[EMUL_IMAGER_REG_SENSOR_ID] = EMUL_IMAGER_SENSOR_ID,
+		/* SENSOR_ID_LO */
+		[0x00] = EMUL_IMAGER_SENSOR_ID & 0xff,
+		[0x01] = EMUL_IMAGER_SENSOR_ID >> 8,
 	};
 
 	if (num_msgs == 0) {