Skip to contentSkip to conversation

SPI: Introduce initial EEPROM driver mode support

PATCH New Loureiro, Joao 4 participants 19 messages Dec 4, 2024 – Sep 17

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 SPI: Introduce initial EEPROM driver mode support

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

---
 configs/sandbox_defconfig |   1 +
 drivers/misc/Kconfig      |   5 +
 drivers/misc/Makefile     |   1 +
 drivers/misc/spi_eeprom.c | 254 ++++++++++++++++++++++++++++++++++++++
 include/dm/uclass-id.h    |   1 +
 include/spi_eeprom.h      |  88 +++++++++++++
 6 files changed, 350 insertions(+)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 include/spi_eeprom.h
configs/sandbox_defconfig +1 -0
index 718e4a8283..e03ac16197 100644
@@ -233,6 +233,7 @@ CONFIG_SYS_NAND_USE_FLASH_BBT=y
 CONFIG_NAND_SANDBOX=y
 CONFIG_SYS_NAND_ONFI_DETECTION=y
 CONFIG_SYS_NAND_PAGE_SIZE=0x200
+CONFIG_SPI_EEPROM=y
 CONFIG_SPI_FLASH_SANDBOX=y
 CONFIG_BOOTDEV_SPI_FLASH=y
 CONFIG_SPI_FLASH_ATMEL=y
drivers/misc/Kconfig +5 -0
index 6009d55f40..22e46c92fa 100644
@@ -578,6 +578,11 @@ config I2C_EEPROM
        help
          Enable a generic driver for EEPROMs attached via I2C.
 
+config SPI_EEPROM
+       bool "Enable driver for generic SPI-attached EEPROMs"
+       depends on MISC
+       help
+         Enable a generic driver for EEPROMs attached via SPI.
 
 config SPL_I2C_EEPROM
        bool "Enable driver for generic I2C-attached EEPROMs for SPL"
drivers/misc/Makefile +1 -0
index dac805e4cd..def79d6ec9 100644
@@ -45,6 +45,7 @@ obj-$(CONFIG_GDSYS_SOC) += gdsys_soc.o
 obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(XPL_)I2C_EEPROM) += i2c_eeprom.o
+obj-$(CONFIG_$(XPL_)SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom.c new file +254 -0

254 lines not on this page · raw message

include/dm/uclass-id.h +1 -0
index 270088ad94..e949b6159e 100644
@@ -133,6 +133,7 @@ enum uclass_id {
        UCLASS_SOC,             /* SOC Device */
        UCLASS_SOUND,           /* Playing simple sounds */
        UCLASS_SPI,             /* SPI bus */
+       UCLASS_SPI_EEPROM,      /* SPI EEPROM device */
        UCLASS_SPI_FLASH,       /* SPI flash */
        UCLASS_SPI_GENERIC,     /* Generic SPI flash target */
        UCLASS_SPMI,            /* System Power Management Interface bus */
include/spi_eeprom.h new file +88 -0

88 lines not on this page · raw message

--
2.43.0

________________________________
The information contained in this message may be confidential and legally protected under applicable law. The message is intended solely for the addressee(s). If you are not the intended recipient, you are hereby notified that any use, forwarding, dissemination, or reproduction of this message is strictly prohibited and may be unlawful. If you are not the intended recipient, please contact the sender by return e-mail and destroy all copies of the original message.

#1 lore raw

PATCH 1/1 spi: Introduce initial eeprom driver mode support

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

---
 configs/sandbox_defconfig |   1 +
 drivers/misc/Kconfig      |   5 +
 drivers/misc/Makefile     |   1 +
 drivers/misc/spi_eeprom.c | 254 ++++++++++++++++++++++++++++++++++++++
 include/dm/uclass-id.h    |   1 +
 include/spi_eeprom.h      |  88 +++++++++++++
 6 files changed, 350 insertions(+)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 include/spi_eeprom.h
configs/sandbox_defconfig +1 -0
index 718e4a8283..e03ac16197 100644
@@ -233,6 +233,7 @@ CONFIG_SYS_NAND_USE_FLASH_BBT=y
 CONFIG_NAND_SANDBOX=y
 CONFIG_SYS_NAND_ONFI_DETECTION=y
 CONFIG_SYS_NAND_PAGE_SIZE=0x200
+CONFIG_SPI_EEPROM=y
 CONFIG_SPI_FLASH_SANDBOX=y
 CONFIG_BOOTDEV_SPI_FLASH=y
 CONFIG_SPI_FLASH_ATMEL=y
drivers/misc/Kconfig +5 -0
index 6009d55f40..22e46c92fa 100644
@@ -578,6 +578,11 @@ config I2C_EEPROM
         help
           Enable a generic driver for EEPROMs attached via I2C.
 
+config SPI_EEPROM
+       bool "Enable driver for generic SPI-attached EEPROMs"
+       depends on MISC
+       help
+         Enable a generic driver for EEPROMs attached via SPI.
 
 config SPL_I2C_EEPROM
         bool "Enable driver for generic I2C-attached EEPROMs for SPL"
drivers/misc/Makefile +1 -0
index dac805e4cd..def79d6ec9 100644
@@ -45,6 +45,7 @@ obj-$(CONFIG_GDSYS_SOC) += gdsys_soc.o
 obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(XPL_)I2C_EEPROM) += i2c_eeprom.o
+obj-$(CONFIG_$(XPL_)SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom.c new file +254 -0

254 lines not on this page · raw message

include/dm/uclass-id.h +1 -0
index 270088ad94..e949b6159e 100644
@@ -133,6 +133,7 @@ enum uclass_id {
         UCLASS_SOC,             /* SOC Device */
         UCLASS_SOUND,           /* Playing simple sounds */
         UCLASS_SPI,             /* SPI bus */
+       UCLASS_SPI_EEPROM,      /* SPI EEPROM device */
         UCLASS_SPI_FLASH,       /* SPI flash */
         UCLASS_SPI_GENERIC,     /* Generic SPI flash target */
         UCLASS_SPMI,            /* System Power Management Interface bus */
include/spi_eeprom.h new file +88 -0

88 lines not on this page · raw message

--
2.43.0

________________________________
The information contained in this message may be confidential and legally protected under applicable law. The message is intended solely for the addressee(s). If you are not the intended recipient, you are hereby notified that any use, forwarding, dissemination, or reproduction of this message is strictly prohibited and may be unlawful. If you are not the intended recipient, please contact the sender by return e-mail and destroy all copies of the original message.

#2 lore raw

Re: [PATCH] spi: Introduce initial eeprom driver mode support

Quoted 5 lines · Joao

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

Quoted 10 lines
---
 configs/sandbox_defconfig |   1 +
 drivers/misc/Kconfig      |   5 +
 drivers/misc/Makefile     |   1 +
 drivers/misc/spi_eeprom.c | 254 ++++++++++++++++++++++++++++++++++++++
 include/dm/uclass-id.h    |   1 +
 include/spi_eeprom.h      |  88 +++++++++++++
 6 files changed, 350 insertions(+)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 include/spi_eeprom.h

In theory, this seems fine. This patch however produces a large number of checkpatch.pl warnings and errors to resolve first. Thanks!

Signature · 1 line
Tom
#3 lore raw

PATCH v2 1/1 spi: Introduce initial EEPROM driver mode support

In reply to Loureiro, Joao

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

---
Changes in v2:
- Fix checkpatch.pl issues

---
 configs/sandbox_defconfig |   1 +
 drivers/misc/Kconfig      |   5 +
 drivers/misc/Makefile     |   1 +
 drivers/misc/spi_eeprom.c | 262 ++++++++++++++++++++++++++++++++++++++
 include/dm/uclass-id.h    |   1 +
 include/spi_eeprom.h      |  88 +++++++++++++
 6 files changed, 358 insertions(+)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 include/spi_eeprom.h
configs/sandbox_defconfig +1 -0
index 7b35ad8a88f..a26b9286401 100644
@@ -234,6 +234,7 @@ CONFIG_SYS_NAND_USE_FLASH_BBT=y
 CONFIG_NAND_SANDBOX=y
 CONFIG_SYS_NAND_ONFI_DETECTION=y
 CONFIG_SYS_NAND_PAGE_SIZE=0x200
+CONFIG_SPI_EEPROM=y
 CONFIG_SPI_FLASH_SANDBOX=y
 CONFIG_BOOTDEV_SPI_FLASH=y
 CONFIG_SPI_FLASH_ATMEL=y
drivers/misc/Kconfig +5 -0
index da84b35e804..0ef5de114ad 100644
@@ -578,6 +578,11 @@ config I2C_EEPROM
        help
          Enable a generic driver for EEPROMs attached via I2C.
 
+config SPI_EEPROM
+       bool "SPI EEPROM support"
+       help
+         Enable support for SPI EEPROM devices.
+         Currently with only read access.
 
 config SPL_I2C_EEPROM
        bool "Enable driver for generic I2C-attached EEPROMs for SPL"
drivers/misc/Makefile +1 -0
index dac805e4cdd..def79d6ec92 100644
@@ -45,6 +45,7 @@ obj-$(CONFIG_GDSYS_SOC) += gdsys_soc.o
 obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(XPL_)I2C_EEPROM) += i2c_eeprom.o
+obj-$(CONFIG_$(XPL_)SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom.c new file +262 -0

262 lines not on this page · raw message

include/dm/uclass-id.h +1 -0
index 270088ad94f..e949b6159e6 100644
@@ -133,6 +133,7 @@ enum uclass_id {
        UCLASS_SOC,             /* SOC Device */
        UCLASS_SOUND,           /* Playing simple sounds */
        UCLASS_SPI,             /* SPI bus */
+       UCLASS_SPI_EEPROM,      /* SPI EEPROM device */
        UCLASS_SPI_FLASH,       /* SPI flash */
        UCLASS_SPI_GENERIC,     /* Generic SPI flash target */
        UCLASS_SPMI,            /* System Power Management Interface bus */
include/spi_eeprom.h new file +88 -0

88 lines not on this page · raw message

--
2.43.0

________________________________
The information contained in this message may be confidential and legally protected under applicable law. The message is intended solely for the addressee(s). If you are not the intended recipient, you are hereby notified that any use, forwarding, dissemination, or reproduction of this message is strictly prohibited and may be unlawful. If you are not the intended recipient, please contact the sender by return e-mail and destroy all copies of the original message.

#4 lore raw

v3 cover spi: Introduce initial EEPROM driver mode support

This series introduces an initial SPI EEPROM driver model uclass, analogous to the existing I2C EEPROM support, currently providing read-only access.

v2 was deferred mainly because of the large number of checkpatch issues. This v3 reworks the driver from scratch to be checkpatch clean, drops dead code and the misleading no-op write stub, fixes the read bounds checking, and corrects the AT25160 geometry. It is rebased on current master.

In addition, and to address the "new uclass needs a sandbox driver and a test" request, patch 2 adds a sandbox SPI EEPROM emulator and a test/dm test. To make that possible the sandbox SPI controller now lets a slave select its emulator through a "sandbox,emul" phandle (mirroring the sandbox I2C bus), while still defaulting to the SPI flash emulator so existing behaviour is unchanged.

Note: this work was originally submitted from a Philips address which I no longer have; it is resent from my personal address.

Tested on sandbox: "ut dm spi_eeprom" passes, and the existing "ut dm spi*" tests still pass.

João Loureiro (2):
spi: Introduce initial EEPROM driver mode support
sandbox: spi: Add SPI EEPROM emulator and DM test

 MAINTAINERS                    |   8 ++
 arch/sandbox/dts/test.dts      |  13 ++-
 configs/sandbox_defconfig      |   1 +
 drivers/misc/Kconfig           |   6 ++
 drivers/misc/Makefile          |   2 +
 drivers/misc/spi_eeprom.c      | 185 +++++++++++++++++++++++++++++++++
 drivers/misc/spi_eeprom_emul.c | 118 +++++++++++++++++++++
 drivers/spi/sandbox_spi.c      |  31 +++++-
 include/dm/uclass-id.h         |   1 +
 include/spi_eeprom.h           |  91 ++++++++++++++++
 test/dm/Makefile               |   1 +
 test/dm/spi_eeprom.c           |  45 ++++++++
 12 files changed, 500 insertions(+), 2 deletions(-)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 drivers/misc/spi_eeprom_emul.c
 create mode 100644 include/spi_eeprom.h
 create mode 100644 test/dm/spi_eeprom.c
Signature · 1 line
2.54.0
#5 lore raw

PATCH v3 1/2 spi: Introduce initial EEPROM driver mode support

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

---
Changes in v3:
- Resolve all checkpatch errors and warnings (the driver was previously indented with spaces instead of tabs)
- Drop the no-op write stub that silently returned success; writes now return -ENOSYS via the uclass wrapper
- Remove unused spi_eeprom_drv_data fields and the empty bind hook
- Drop the bogus spi_slave_of_to_plat() call; the SPI uclass already parses the slave platform data
- Fix the read bounds check (reject negative offset/size and overflow)
- Make probe fail only on a real transfer error instead of treating a 0xff status as "device not found"
- Correct the AT25160 geometry to 2048 bytes / 32-byte page
- Use kernel u8 types and mirror include/i2c_eeprom.h
- Add a MAINTAINERS entry
- Rebase on current master and resend from a personal address (the original Philips address is no longer reachable)

 MAINTAINERS               |   6 ++
 configs/sandbox_defconfig |   1 +
 drivers/misc/Kconfig      |   6 ++
 drivers/misc/Makefile     |   1 +
 drivers/misc/spi_eeprom.c | 185 ++++++++++++++++++++++++++++++++++++++
 include/dm/uclass-id.h    |   1 +
 include/spi_eeprom.h      |  91 +++++++++++++++++++
 7 files changed, 291 insertions(+)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 include/spi_eeprom.h
MAINTAINERS +6 -0
index 571af196465..3a99307051c 100644
@@ -1772,6 +1772,12 @@ T:	git https://source.denx.de/u-boot/custodians/u-boot-spi.git
 F:	drivers/spi/
 F:	include/spi*
 
+SPI EEPROM
+M:	João Loureiro <[email protected]>
+S:	Maintained
+F:	drivers/misc/spi_eeprom.c
+F:	include/spi_eeprom.h
+
 SPI NAND
 M:	Dario Binacchi <[email protected]>
 M:	Michael Trimarchi <[email protected]>
configs/sandbox_defconfig +1 -0
index ba800f7d19d..b13f236636f 100644
@@ -262,6 +262,7 @@ CONFIG_SYS_NAND_USE_FLASH_BBT=y
 CONFIG_NAND_SANDBOX=y
 CONFIG_SYS_NAND_ONFI_DETECTION=y
 CONFIG_SYS_NAND_PAGE_SIZE=0x200
+CONFIG_SPI_EEPROM=y
 CONFIG_SPI_FLASH_SANDBOX=y
 CONFIG_BOOTDEV_SPI_FLASH=y
 CONFIG_SPI_FLASH_ATMEL=y
drivers/misc/Kconfig +6 -0
index ea785793d18..f7336d3c7f0 100644
@@ -567,6 +567,12 @@ config I2C_EEPROM
 	help
 	  Enable a generic driver for EEPROMs attached via I2C.
 
+config SPI_EEPROM
+	bool "SPI EEPROM support"
+	depends on MISC
+	help
+	  Enable support for SPI EEPROM devices.
+	  Currently with only read access.
 
 config SPL_I2C_EEPROM
 	bool "Enable driver for generic I2C-attached EEPROMs for SPL"
drivers/misc/Makefile +1 -0
index e2170212e5a..8c9f8eb9cfa 100644
@@ -44,6 +44,7 @@ obj-$(CONFIG_GDSYS_SOC) += gdsys_soc.o
 obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(PHASE_)I2C_EEPROM) += i2c_eeprom.o
+obj-$(CONFIG_$(PHASE_)SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom.c new file +185 -0

185 lines not on this page · raw message

include/dm/uclass-id.h +1 -0
index 36b5d87c304..d24b4a1a121 100644
@@ -138,6 +138,7 @@ enum uclass_id {
 	UCLASS_SOC,		/* SOC Device */
 	UCLASS_SOUND,		/* Playing simple sounds */
 	UCLASS_SPI,		/* SPI bus */
+	UCLASS_SPI_EEPROM,	/* SPI EEPROM device */
 	UCLASS_SPI_FLASH,	/* SPI flash */
 	UCLASS_SPI_GENERIC,	/* Generic SPI flash target */
 	UCLASS_SPMI,		/* System Power Management Interface bus */
include/spi_eeprom.h new file +91 -0

91 lines not on this page · raw message

Signature · 1 line
2.54.0
#6 lore raw

PATCH v3 2/2 sandbox: spi: Add SPI EEPROM emulator and DM test

In reply to João Loureiro

Add a sandbox emulator for an AT25-style SPI EEPROM so the new SPI EEPROM uclass can be exercised without real hardware.

The sandbox SPI controller previously always bound the SPI flash emulator for every chip select. Allow a slave node to select its own emulator through a sandbox,emul phandle (mirroring the sandbox I2C bus), falling back to the SPI flash emulator when none is given so that existing behaviour is preserved.

A test EEPROM is wired up on chip select 3 of the sandbox SPI bus and a test/dm test verifies size reporting, patterned reads, out-of-bounds rejection and the unimplemented write path.

---
Changes in v3:
- New patch, added to provide sandbox coverage for the new uclass

 MAINTAINERS                    |   2 +
 arch/sandbox/dts/test.dts      |  13 +++-
 drivers/misc/Makefile          |   1 +
 drivers/misc/spi_eeprom_emul.c | 118 +++++++++++++++++++++++++++++++++
 drivers/spi/sandbox_spi.c      |  31 ++++++++-
 test/dm/Makefile               |   1 +
 test/dm/spi_eeprom.c           |  45 +++++++++++++
 7 files changed, 209 insertions(+), 2 deletions(-)
 create mode 100644 drivers/misc/spi_eeprom_emul.c
 create mode 100644 test/dm/spi_eeprom.c
MAINTAINERS +2 -0
index 3a99307051c..173f83a9cb8 100644
@@ -1776,7 +1776,9 @@ SPI EEPROM
 M:	João Loureiro <[email protected]>
 S:	Maintained
 F:	drivers/misc/spi_eeprom.c
+F:	drivers/misc/spi_eeprom_emul.c
 F:	include/spi_eeprom.h
+F:	test/dm/spi_eeprom.c
 
 SPI NAND
 M:	Dario Binacchi <[email protected]>
arch/sandbox/dts/test.dts +12 -1
index 0887de4333b..4ccb6984a68 100644
@@ -1602,7 +1602,7 @@
 		#size-cells = <0>;
 		reg = <0 1>;
 		compatible = "sandbox,spi";
-		cs-gpios = <0>, <0>, <&gpio_a 0>;
+		cs-gpios = <0>, <0>, <&gpio_a 0>, <0>;
 		pinctrl-names = "default";
 		pinctrl-0 = <&pinmux_spi0_pins>;
 
@@ -1620,6 +1620,17 @@
 			spi-cpol;
 			spi-cpha;
 		};
+		eeprom@3 {
+			reg = <3>;
+			compatible = "microchip,at25160bn";
+			spi-max-frequency = <1000000>;
+			sandbox,emul = <&spi_eeprom_emul>;
+		};
+	};
+
+	spi_eeprom_emul: spi-eeprom-emul {
+		compatible = "sandbox,spi-eeprom";
+		sandbox,size = <2048>;
 	};
 
 	syscon0: syscon@0 {
drivers/misc/Makefile +1 -0
index 8c9f8eb9cfa..8fa0fe75b53 100644
@@ -45,6 +45,7 @@ obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(PHASE_)I2C_EEPROM) += i2c_eeprom.o
 obj-$(CONFIG_$(PHASE_)SPI_EEPROM) += spi_eeprom.o
+obj-$(CONFIG_SANDBOX) += spi_eeprom_emul.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom_emul.c new file +118 -0

118 lines not on this page · raw message

drivers/spi/sandbox_spi.c +30 -1
index 3ee97d67f4a..619368243ed 100644
@@ -77,6 +77,35 @@ static int sandbox_spi_set_wordlen(struct udevice *dev, unsigned int wordlen)
 	return 0;
 }
 
+/**
+ * sandbox_spi_emul_get() - find the emulator for a SPI slave
+ *
+ * A slave can name a dedicated emulator through a "sandbox,emul" phandle (for
+ * example an SPI EEPROM). When no such phandle is present we fall back to the
+ * built-in SPI flash emulator, preserving the previous behaviour.
+ */
+static int sandbox_spi_emul_get(struct sandbox_state *state, struct udevice *bus,
+				struct udevice *slave, struct udevice **emulp)
+{
+	struct sandbox_spi_info *info;
+	int ret;
+
+	info = &state->spi[dev_seq(bus)][spi_chip_select(slave)];
+	if (info->emul) {
+		*emulp = info->emul;
+		return 0;
+	}
+
+	ret = uclass_get_device_by_phandle(UCLASS_SPI_EMUL, slave, "sandbox,emul",
+					   emulp);
+	if (!ret) {
+		info->emul = *emulp;
+		return 0;
+	}
+
+	return sandbox_spi_get_emul(state, bus, slave, emulp);
+}
+
 static int sandbox_spi_xfer(struct udevice *slave, unsigned int bitlen,
 			    const void *dout, void *din, unsigned long flags)
 {
@@ -106,7 +135,7 @@ static int sandbox_spi_xfer(struct udevice *slave, unsigned int bitlen,
 		       busnum, cs);
 		return -ENOENT;
 	}
-	ret = sandbox_spi_get_emul(state, bus, slave, &emul);
+	ret = sandbox_spi_emul_get(state, bus, slave, &emul);
 	if (ret) {
 		printf("%s: busnum=%u, cs=%u: no emulation available (err=%d)\n",
 		       __func__, busnum, cs, ret);
test/dm/Makefile +1 -0
index d69b0e08d66..df8e0c1011e 100644
@@ -117,6 +117,7 @@ obj-$(CONFIG_SMEM) += smem.o
 obj-$(CONFIG_SOC_DEVICE) += soc.o
 obj-$(CONFIG_SOUND) += sound.o
 obj-$(CONFIG_DM_SPI) += spi.o
+obj-$(CONFIG_SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_SPMI) += spmi.o
 obj-y += syscon.o
 obj-$(CONFIG_RESET_SYSCON) += syscon-reset.o
test/dm/spi_eeprom.c new file +45 -0

45 lines not on this page · raw message

Signature · 1 line
2.54.0
Reviewed-by Tested-by on v3 2/2
#7 lore raw

Re: [PATCH v3 2/2] sandbox: spi: Add SPI EEPROM emulator and DM test

Hi João,

Quoted 28 lines · João Loureiro

sandbox: spi: Add SPI EEPROM emulator and DM test

Add a sandbox emulator for an AT25-style SPI EEPROM so the new SPI EEPROM uclass can be exercised without real hardware.

The sandbox SPI controller previously always bound the SPI flash emulator for every chip select. Allow a slave node to select its own emulator through a sandbox,emul phandle (mirroring the sandbox I2C bus), falling back to the SPI flash emulator when none is given so that existing behaviour is preserved.

A test EEPROM is wired up on chip select 3 of the sandbox SPI bus and a test/dm test verifies size reporting, patterned reads, out-of-bounds rejection and the unimplemented write path.

MAINTAINERS | 2 +

 arch/sandbox/dts/test.dts      |  13 ++++-
 drivers/misc/Makefile          |   1 +
 drivers/misc/spi_eeprom_emul.c | 118 +++++++++++++++++++++++++++++++++++++++++
 drivers/spi/sandbox_spi.c      |  31 ++++++++++-
 test/dm/Makefile               |   1 +
 test/dm/spi_eeprom.c           |  45 ++++++++++++++++
 7 files changed, 209 insertions(+), 2 deletions(-)

drivers/spi/sandbox_spi.c static int sandbox_spi_set_wordlen(struct udevice *dev, unsigned int wordlen) · line 85

Quoted 9 lines
drivers/spi/sandbox_spi.c +9 -0
@@ -77,6 +77,35 @@ static int sandbox_spi_set_wordlen(struct udevice *dev, unsigned int wordlen)
+/**
+ * sandbox_spi_emul_get() - find the emulator for a SPI slave
+ *
+ * A slave can name a dedicated emulator through a 'sandbox,emul' phandle (for
+ * example an SPI EEPROM). When no such phandle is present we fall back to the
+ * built-in SPI flash emulator, preserving the previous behaviour.
+ */
+static int sandbox_spi_emul_get(struct sandbox_state *state, struct udevice *bus,
+                             struct udevice *slave, struct udevice **emulp)

Can you please add rull kerneldoc for @state, @bus, @slave, @emulp and a Return: line. Try to wrap to 80 columns.

drivers/misc/spi_eeprom_emul.c line 3

Quoted 5 lines
drivers/misc/spi_eeprom_emul.c +3 -0
@@ -0,0 +1,118 @@
+     priv->data = calloc(1, priv->size);
+     if (!priv->data)
+             return -ENOMEM;

This is never freed, so each probe/remove cycle in the tests leaks the backing store. Please can you add a remove method that frees priv->data, as sandbox_i2c_eeprom_remove() does in i2c_eeprom_emul.c

With those fixed:

Regards,
Simon

#8 lore raw

v4 cover spi: Introduce initial EEPROM driver mode support

In reply to João Loureiro

This series introduces an initial SPI EEPROM driver model uclass, analogous to the existing I2C EEPROM support, currently providing read-only access. Patch 2 adds a sandbox emulator and a test/dm test.

v4 addresses Simon Glass's review of v3: the emulator now frees its backing store in a remove() method, and sandbox_spi_emul_get() gets full kerneldoc. Patch 1 is unchanged.

João Loureiro (2):
spi: Introduce initial EEPROM driver mode support
sandbox: spi: Add SPI EEPROM emulator and DM test

 MAINTAINERS                    |   8 ++
 arch/sandbox/dts/test.dts      |  13 ++-
 configs/sandbox_defconfig      |   1 +
 drivers/misc/Kconfig           |   6 ++
 drivers/misc/Makefile          |   2 +
 drivers/misc/spi_eeprom.c      | 185 +++++++++++++++++++++++++++++++++
 drivers/misc/spi_eeprom_emul.c | 128 +++++++++++++++++++++++
 drivers/spi/sandbox_spi.c      |  37 ++++++-
 include/dm/uclass-id.h         |   1 +
 include/spi_eeprom.h           |  91 ++++++++++++++++
 test/dm/Makefile               |   1 +
 test/dm/spi_eeprom.c           |  45 ++++++++
 12 files changed, 516 insertions(+), 2 deletions(-)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 drivers/misc/spi_eeprom_emul.c
 create mode 100644 include/spi_eeprom.h
 create mode 100644 test/dm/spi_eeprom.c
Signature · 1 line
2.54.0
#9 lore raw

PATCH v4 1/2 spi: Introduce initial EEPROM driver mode support

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

---
Changes in v4:
- No change

Changes in v3:
- Resolve all checkpatch errors and warnings (the driver was previously indented with spaces instead of tabs)
- Drop the no-op write stub that silently returned success; writes now return -ENOSYS via the uclass wrapper
- Remove unused spi_eeprom_drv_data fields and the empty bind hook
- Drop the bogus spi_slave_of_to_plat() call; the SPI uclass already parses the slave platform data
- Fix the read bounds check (reject negative offset/size and overflow)
- Make probe fail only on a real transfer error instead of treating a 0xff status as "device not found"
- Correct the AT25160 geometry to 2048 bytes / 32-byte page
- Use kernel u8 types and mirror include/i2c_eeprom.h
- Add a MAINTAINERS entry
- Rebase on current master and resend from a personal address (the original Philips address is no longer reachable)

 MAINTAINERS               |   6 ++
 configs/sandbox_defconfig |   1 +
 drivers/misc/Kconfig      |   6 ++
 drivers/misc/Makefile     |   1 +
 drivers/misc/spi_eeprom.c | 185 ++++++++++++++++++++++++++++++++++++++
 include/dm/uclass-id.h    |   1 +
 include/spi_eeprom.h      |  91 +++++++++++++++++++
 7 files changed, 291 insertions(+)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 include/spi_eeprom.h
MAINTAINERS +6 -0
index 571af196465..3a99307051c 100644
@@ -1772,6 +1772,12 @@ T:	git https://source.denx.de/u-boot/custodians/u-boot-spi.git
 F:	drivers/spi/
 F:	include/spi*
 
+SPI EEPROM
+M:	João Loureiro <[email protected]>
+S:	Maintained
+F:	drivers/misc/spi_eeprom.c
+F:	include/spi_eeprom.h
+
 SPI NAND
 M:	Dario Binacchi <[email protected]>
 M:	Michael Trimarchi <[email protected]>
configs/sandbox_defconfig +1 -0
index ba800f7d19d..b13f236636f 100644
@@ -262,6 +262,7 @@ CONFIG_SYS_NAND_USE_FLASH_BBT=y
 CONFIG_NAND_SANDBOX=y
 CONFIG_SYS_NAND_ONFI_DETECTION=y
 CONFIG_SYS_NAND_PAGE_SIZE=0x200
+CONFIG_SPI_EEPROM=y
 CONFIG_SPI_FLASH_SANDBOX=y
 CONFIG_BOOTDEV_SPI_FLASH=y
 CONFIG_SPI_FLASH_ATMEL=y
drivers/misc/Kconfig +6 -0
index ea785793d18..f7336d3c7f0 100644
@@ -567,6 +567,12 @@ config I2C_EEPROM
 	help
 	  Enable a generic driver for EEPROMs attached via I2C.
 
+config SPI_EEPROM
+	bool "SPI EEPROM support"
+	depends on MISC
+	help
+	  Enable support for SPI EEPROM devices.
+	  Currently with only read access.
 
 config SPL_I2C_EEPROM
 	bool "Enable driver for generic I2C-attached EEPROMs for SPL"
drivers/misc/Makefile +1 -0
index e2170212e5a..8c9f8eb9cfa 100644
@@ -44,6 +44,7 @@ obj-$(CONFIG_GDSYS_SOC) += gdsys_soc.o
 obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(PHASE_)I2C_EEPROM) += i2c_eeprom.o
+obj-$(CONFIG_$(PHASE_)SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom.c new file +185 -0

185 lines not on this page · raw message

include/dm/uclass-id.h +1 -0
index 36b5d87c304..d24b4a1a121 100644
@@ -138,6 +138,7 @@ enum uclass_id {
 	UCLASS_SOC,		/* SOC Device */
 	UCLASS_SOUND,		/* Playing simple sounds */
 	UCLASS_SPI,		/* SPI bus */
+	UCLASS_SPI_EEPROM,	/* SPI EEPROM device */
 	UCLASS_SPI_FLASH,	/* SPI flash */
 	UCLASS_SPI_GENERIC,	/* Generic SPI flash target */
 	UCLASS_SPMI,		/* System Power Management Interface bus */
include/spi_eeprom.h new file +91 -0

91 lines not on this page · raw message

Signature · 1 line
2.54.0
#10 lore raw

Re: [PATCH v4 1/2] spi: Introduce initial EEPROM driver mode support

Hi João,

Quoted 8 lines · João Loureiro

spi: Introduce initial EEPROM driver mode support

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

Quoted 8 lines

MAINTAINERS | 6 ++

 configs/sandbox_defconfig |   1 +
 drivers/misc/Kconfig      |   6 ++
 drivers/misc/Makefile     |   1 +
 drivers/misc/spi_eeprom.c | 185 ++++++++++++++++++++++++++++++++++++++++++++++
 include/dm/uclass-id.h    |   1 +
 include/spi_eeprom.h      |  91 +++++++++++++++++++++++
 7 files changed, 291 insertions(+)

Sorry I didn't notice the earlier versions of this patch, but I do have a few comments.

Quoted 3 lines

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

'driver model', not 'driver mode' - three times. Please also use the
imperative: 'Introduce initial driver-model support for SPI EEPROMs, analogous to ...' matches the subject and U-Boot convention.

Please explain the motivation briefly (why now, what will consume it) before your current commit msg.

drivers/misc/Kconfig config I2C_EEPROM · line 572

Quoted 8 lines
drivers/misc/Kconfig +6 -0
@@ -567,6 +567,12 @@ config I2C_EEPROM
+config SPI_EEPROM
+     bool "SPI EEPROM support"
+     depends on MISC
+     help
+       Enable support for SPI EEPROM devices.
+       Currently with only read access.

Please expand the help text - mention that this provides a uclass with a small AT25-style driver, that only 16-bit-addressed parts are handled, and that only read is implemented.

Does this really need 'depends on MISC'? The driver does not use the misc uclass; it sits on its own UCLASS_SPI_EEPROM. i2c_eeprom does not depend on MISC either.

drivers/misc/spi_eeprom.c line 2

Quoted 4 lines
drivers/misc/spi_eeprom.c +2 -0
@@ -0,0 +1,185 @@
+/* 1 command byte followed by a 16-bit address */
+#define SPI_EEPROM_CMD_SIZE  3

This lives in the public header and hard-codes a 16-bit address, but the uclass is presented as generic. Anything larger than 64 KiB (AT25M02, AT25512, most 24-bit-addressed parts) will not work. Please either:

- move SPI_EEPROM_CMD_SIZE into spi_eeprom.c and derive the address
length from driver-data (an addr_len field), so growing the compatible list later does not need an ABI change; or
- state explicitly in the commit message and Kconfig help that
initial support is limited to 16-bit-addressed AT25-style parts.

I'd prefer the first.

drivers/misc/spi_eeprom.c line 111

Quoted 5 lines
drivers/misc/spi_eeprom.c +5 -0
+     if (offset < 0 || size < 0 || offset + size > priv->size) {
+             log_err("Read out of bounds (offset %d, size %d, max %lu)\n",
+                     offset, size, priv->size);
+             return -EINVAL;
+     }

offset + size is an int and can overflow before the comparison against the unsigned long priv->size. Please check the two ranges independently:

    if (offset < 0 || size < 0 || offset >= priv->size ||
        size > priv->size - offset)

drivers/misc/spi_eeprom.c line 115

Quoted 3 lines
drivers/misc/spi_eeprom.c +3 -0
+     cmd[0] = data->cmd_read_data;
+     cmd[1] = (offset >> 8) & 0xff;
+     cmd[2] = offset & 0xff;

If you keep the 16-bit assumption, please reject offsets that don't fit in 16 bits rather than silently truncating. priv->size can be overridden from DT via the 'size' property with any value.

drivers/misc/spi_eeprom.c

Quoted 8 lines
drivers/misc/spi_eeprom.c +8 -0
+static int spi_eeprom_std_of_to_plat(struct udevice *dev)
+{
+     const struct spi_eeprom_drv_data *data =
+             (const struct spi_eeprom_drv_data *)dev_get_driver_data(dev);
+     struct spi_eeprom *priv = dev_get_priv(dev);
+
+     priv->size = dev_read_u32_default(dev, 'size', data->size);
+     priv->pagesize = dev_read_u32_default(dev, 'pagesize', data->pagesize);

Two things:

'size' and 'pagesize' don't seem to be standard bindings for SPI EEPROM nodes - the size is normally determined by the compatible. Please either drop these overrides or point at a binding that documents them.

Also, this writes into priv from of_to_plat(). Per driver-model convention, of_to_plat() should populate plat data (auto_plat) and probe() should use plat or can put a few things in priv if it likes. Since there is no write path using pagesize yet, the simpler fix is to move this into spi_eeprom_std_probe()

drivers/misc/spi_eeprom.c line 170

Quoted 4 lines
drivers/misc/spi_eeprom.c +4 -0
+static const struct udevice_id spi_eeprom_std_ids[] = {
+     { .compatible = 'microchip,at25160bn', .data = (ulong)&atmel25_data },
+     { }
+};

Only one compatible for a generic driver feels thin - any reason not to add the rest of the AT25 family that shares this command set (at25010b, at25020b, at25040b, at25080b, at2532b, at25640b etc)? Each just needs a drv_data entry.

include/spi_eeprom.h line 6

Quoted 8 lines
include/spi_eeprom.h +6 -0
@@ -0,0 +1,91 @@
+/* AT25-style command set */
+#define AT25_CMD_READ_DATA   0x03    /* Read data from memory array */
+#define AT25_CMD_READ_STATUS 0x05    /* Read status register */
+
+/* 1 command byte followed by a 16-bit address */
+#define SPI_EEPROM_CMD_SIZE  3

These are only used by drivers/misc/spi_eeprom.c and drivers/misc/spi_eeprom_emul.c - implementation details rather than uclass API. Please move them into a private header shared by the driver and emulator, or duplicate the two opcodes locally.

include/spi_eeprom.h line 37

Quoted 3 lines
include/spi_eeprom.h +3 -0
+#if CONFIG_IS_ENABLED(SPI_EEPROM)
+/*
+ * spi_eeprom_read() - read bytes from an SPI EEPROM chip

Please switch to kerneldoc (/** rather than /*) - new code should carry proper kerneldoc even where i2c_eeprom.h has not been updated.

include/spi_eeprom.h line 91

Quoted 3 lines
include/spi_eeprom.h +3 -0
+#endif /* SPI_EEPROM */
+
+#endif

Please add /* __SPI_EEPROM */ after the outer #endif to match the inner one.

Regards,
Simon

#11 lore raw

Re: Re: [PATCH v4 1/2] spi: Introduce initial EEPROM driver mode support

Hi Simon,

Thank you for the detailed review of v4 — genuinely useful. I'll address the points in v5. The hard-coded 16-bit address in particular sent this somewhere better, and chasing your comment on the non-standard 'size' and 'pagesize' properties turned up the atmel,at25 binding already in tree, which now drives the whole geometry.

Thanks,
João

Quoted 158 lines · Simon Glass

Hi João,

Quoted 6 lines · João Loureiro

spi: Introduce initial EEPROM driver mode support

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

Quoted 7 lines

MAINTAINERS | 6 ++

 configs/sandbox_defconfig |   1 +
 drivers/misc/Kconfig      |   6 ++
 drivers/misc/Makefile     |   1 +
 drivers/misc/spi_eeprom.c | 185 ++++++++++++++++++++++++++++++

++++++++++++++++

Quoted 3 lines
 include/dm/uclass-id.h    |   1 +
 include/spi_eeprom.h      |  91 +++++++++++++++++++++++
 7 files changed, 291 insertions(+)

Sorry I didn't notice the earlier versions of this patch, but I do have a few comments.

Quoted 3 lines

This patch introduces the initial SPI EEPROM driver mode support analogous to the I2C EEPROM driver mode support. The SPI EEPROM driver mode support is enabled by default in the sandbox_defconfig.

'driver model', not 'driver mode' - three times. Please also use the
imperative: 'Introduce initial driver-model support for SPI EEPROMs, analogous to ...' matches the subject and U-Boot convention.

Please explain the motivation briefly (why now, what will consume it) before your current commit msg.

drivers/misc/Kconfig config I2C_EEPROM · line 572

Quoted 8 lines
drivers/misc/Kconfig +6 -0
@@ -567,6 +567,12 @@ config I2C_EEPROM
+config SPI_EEPROM
+     bool "SPI EEPROM support"
+     depends on MISC
+     help
+       Enable support for SPI EEPROM devices.
+       Currently with only read access.

Please expand the help text - mention that this provides a uclass with a small AT25-style driver, that only 16-bit-addressed parts are handled, and that only read is implemented.

Does this really need 'depends on MISC'? The driver does not use the misc uclass; it sits on its own UCLASS_SPI_EEPROM. i2c_eeprom does not depend on MISC either.

drivers/misc/spi_eeprom.c line 2

Quoted 4 lines
drivers/misc/spi_eeprom.c +2 -0
@@ -0,0 +1,185 @@
+/* 1 command byte followed by a 16-bit address */
+#define SPI_EEPROM_CMD_SIZE  3

This lives in the public header and hard-codes a 16-bit address, but the uclass is presented as generic. Anything larger than 64 KiB (AT25M02, AT25512, most 24-bit-addressed parts) will not work. Please either:

- move SPI_EEPROM_CMD_SIZE into spi_eeprom.c and derive the address
length from driver-data (an addr_len field), so growing the compatible list later does not need an ABI change; or
- state explicitly in the commit message and Kconfig help that
initial support is limited to 16-bit-addressed AT25-style parts.

I'd prefer the first.

drivers/misc/spi_eeprom.c line 4

Quoted 2 lines
drivers/misc/spi_eeprom.c +2 -0
+     if (offset < 0 || size < 0 || offset + size > priv->size) {
+             log_err("Read out of bounds (offset %d, size %d, max

%lu)\n",

drivers/misc/spi_eeprom.c line 111

Quoted 3 lines
drivers/misc/spi_eeprom.c +3 -0
+                     offset, size, priv->size);
+             return -EINVAL;
+     }

offset + size is an int and can overflow before the comparison against the unsigned long priv->size. Please check the two ranges independently:

    if (offset < 0 || size < 0 || offset >= priv->size ||
        size > priv->size - offset)

drivers/misc/spi_eeprom.c line 115

Quoted 3 lines
drivers/misc/spi_eeprom.c +3 -0
+     cmd[0] = data->cmd_read_data;
+     cmd[1] = (offset >> 8) & 0xff;
+     cmd[2] = offset & 0xff;

If you keep the 16-bit assumption, please reject offsets that don't fit in 16 bits rather than silently truncating. priv->size can be overridden from DT via the 'size' property with any value.

drivers/misc/spi_eeprom.c

Quoted 4 lines
drivers/misc/spi_eeprom.c +4 -0
+static int spi_eeprom_std_of_to_plat(struct udevice *dev)
+{
+     const struct spi_eeprom_drv_data *data =
+             (const struct spi_eeprom_drv_data

*)dev_get_driver_data(dev);

drivers/misc/spi_eeprom.c

Quoted 4 lines
drivers/misc/spi_eeprom.c +4 -0
+     struct spi_eeprom *priv = dev_get_priv(dev);
+
+     priv->size = dev_read_u32_default(dev, 'size', data->size);
+     priv->pagesize = dev_read_u32_default(dev, 'pagesize',

data->pagesize);

Two things:

'size' and 'pagesize' don't seem to be standard bindings for SPI EEPROM nodes - the size is normally determined by the compatible. Please either drop these overrides or point at a binding that documents them.

Also, this writes into priv from of_to_plat(). Per driver-model convention, of_to_plat() should populate plat data (auto_plat) and probe() should use plat or can put a few things in priv if it likes. Since there is no write path using pagesize yet, the simpler fix is to move this into spi_eeprom_std_probe()

drivers/misc/spi_eeprom.c line 20

Quoted 2 lines
drivers/misc/spi_eeprom.c +2 -0
+static const struct udevice_id spi_eeprom_std_ids[] = {
+     { .compatible = 'microchip,at25160bn', .data =

(ulong)&atmel25_data },

drivers/misc/spi_eeprom.c line 22

Quoted 2 lines
drivers/misc/spi_eeprom.c +2 -0
+     { }
+};

Only one compatible for a generic driver feels thin - any reason not to add the rest of the AT25 family that shares this command set (at25010b, at25020b, at25040b, at25080b, at2532b, at25640b etc)? Each just needs a drv_data entry.

include/spi_eeprom.h line 6

Quoted 8 lines
include/spi_eeprom.h +6 -0
@@ -0,0 +1,91 @@
+/* AT25-style command set */
+#define AT25_CMD_READ_DATA   0x03    /* Read data from memory array */
+#define AT25_CMD_READ_STATUS 0x05    /* Read status register */
+
+/* 1 command byte followed by a 16-bit address */
+#define SPI_EEPROM_CMD_SIZE  3

These are only used by drivers/misc/spi_eeprom.c and drivers/misc/spi_eeprom_emul.c - implementation details rather than uclass API. Please move them into a private header shared by the driver and emulator, or duplicate the two opcodes locally.

include/spi_eeprom.h line 37

Quoted 3 lines
include/spi_eeprom.h +3 -0
+#if CONFIG_IS_ENABLED(SPI_EEPROM)
+/*
+ * spi_eeprom_read() - read bytes from an SPI EEPROM chip

Please switch to kerneldoc (/** rather than /*) - new code should carry proper kerneldoc even where i2c_eeprom.h has not been updated.

include/spi_eeprom.h line 91

Quoted 3 lines
include/spi_eeprom.h +3 -0
+#endif /* SPI_EEPROM */
+
+#endif

Please add /* __SPI_EEPROM */ after the outer #endif to match the inner one.

Regards,
Simon

#12 lore raw

PATCH v4 2/2 sandbox: spi: Add SPI EEPROM emulator and DM test

In reply to João Loureiro

Add a sandbox emulator for an AT25-style SPI EEPROM so the new SPI EEPROM uclass can be exercised without real hardware.

The sandbox SPI controller previously always bound the SPI flash emulator for every chip select. Allow a slave node to select its own emulator through a sandbox,emul phandle (mirroring the sandbox I2C bus), falling back to the SPI flash emulator when none is given so that existing behaviour is preserved.

A test EEPROM is wired up on chip select 3 of the sandbox SPI bus and a test/dm test verifies size reporting, patterned reads, out-of-bounds rejection and the unimplemented write path.

---
Changes in v4:
- Free the emulator backing store in a remove() method (Simon Glass)
- Add full kerneldoc for sandbox_spi_emul_get() (Simon Glass)

Changes in v3:
- New patch, added to provide sandbox coverage for the new uclass

 MAINTAINERS                    |   2 +
 arch/sandbox/dts/test.dts      |  13 +++-
 drivers/misc/Makefile          |   1 +
 drivers/misc/spi_eeprom_emul.c | 128 +++++++++++++++++++++++++++++++++
 drivers/spi/sandbox_spi.c      |  37 +++++++++-
 test/dm/Makefile               |   1 +
 test/dm/spi_eeprom.c           |  45 ++++++++++++
 7 files changed, 225 insertions(+), 2 deletions(-)
 create mode 100644 drivers/misc/spi_eeprom_emul.c
 create mode 100644 test/dm/spi_eeprom.c
MAINTAINERS +2 -0
index 3a99307051c..173f83a9cb8 100644
@@ -1776,7 +1776,9 @@ SPI EEPROM
 M:	João Loureiro <[email protected]>
 S:	Maintained
 F:	drivers/misc/spi_eeprom.c
+F:	drivers/misc/spi_eeprom_emul.c
 F:	include/spi_eeprom.h
+F:	test/dm/spi_eeprom.c
 
 SPI NAND
 M:	Dario Binacchi <[email protected]>
arch/sandbox/dts/test.dts +12 -1
index 0887de4333b..4ccb6984a68 100644
@@ -1602,7 +1602,7 @@
 		#size-cells = <0>;
 		reg = <0 1>;
 		compatible = "sandbox,spi";
-		cs-gpios = <0>, <0>, <&gpio_a 0>;
+		cs-gpios = <0>, <0>, <&gpio_a 0>, <0>;
 		pinctrl-names = "default";
 		pinctrl-0 = <&pinmux_spi0_pins>;
 
@@ -1620,6 +1620,17 @@
 			spi-cpol;
 			spi-cpha;
 		};
+		eeprom@3 {
+			reg = <3>;
+			compatible = "microchip,at25160bn";
+			spi-max-frequency = <1000000>;
+			sandbox,emul = <&spi_eeprom_emul>;
+		};
+	};
+
+	spi_eeprom_emul: spi-eeprom-emul {
+		compatible = "sandbox,spi-eeprom";
+		sandbox,size = <2048>;
 	};
 
 	syscon0: syscon@0 {
drivers/misc/Makefile +1 -0
index 8c9f8eb9cfa..8fa0fe75b53 100644
@@ -45,6 +45,7 @@ obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(PHASE_)I2C_EEPROM) += i2c_eeprom.o
 obj-$(CONFIG_$(PHASE_)SPI_EEPROM) += spi_eeprom.o
+obj-$(CONFIG_SANDBOX) += spi_eeprom_emul.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom_emul.c new file +128 -0

128 lines not on this page · raw message

drivers/spi/sandbox_spi.c +36 -1
index 3ee97d67f4a..aa4edcf64b2 100644
@@ -77,6 +77,41 @@ static int sandbox_spi_set_wordlen(struct udevice *dev, unsigned int wordlen)
 	return 0;
 }
 
+/**
+ * sandbox_spi_emul_get() - find the emulator for a SPI slave
+ *
+ * A slave can name a dedicated emulator through a "sandbox,emul" phandle (for
+ * example an SPI EEPROM). When no such phandle is present we fall back to the
+ * built-in SPI flash emulator, preserving the previous behaviour.
+ *
+ * @state: Sandbox state, used to cache the bound emulator per chip select
+ * @bus: SPI bus the slave is attached to
+ * @slave: SPI slave to find the emulator for
+ * @emulp: Returns the emulator device on success
+ * Return: 0 if OK, -ve on error
+ */
+static int sandbox_spi_emul_get(struct sandbox_state *state, struct udevice *bus,
+				struct udevice *slave, struct udevice **emulp)
+{
+	struct sandbox_spi_info *info;
+	int ret;
+
+	info = &state->spi[dev_seq(bus)][spi_chip_select(slave)];
+	if (info->emul) {
+		*emulp = info->emul;
+		return 0;
+	}
+
+	ret = uclass_get_device_by_phandle(UCLASS_SPI_EMUL, slave, "sandbox,emul",
+					   emulp);
+	if (!ret) {
+		info->emul = *emulp;
+		return 0;
+	}
+
+	return sandbox_spi_get_emul(state, bus, slave, emulp);
+}
+
 static int sandbox_spi_xfer(struct udevice *slave, unsigned int bitlen,
 			    const void *dout, void *din, unsigned long flags)
 {
@@ -106,7 +141,7 @@ static int sandbox_spi_xfer(struct udevice *slave, unsigned int bitlen,
 		       busnum, cs);
 		return -ENOENT;
 	}
-	ret = sandbox_spi_get_emul(state, bus, slave, &emul);
+	ret = sandbox_spi_emul_get(state, bus, slave, &emul);
 	if (ret) {
 		printf("%s: busnum=%u, cs=%u: no emulation available (err=%d)\n",
 		       __func__, busnum, cs, ret);
test/dm/Makefile +1 -0
index d69b0e08d66..df8e0c1011e 100644
@@ -117,6 +117,7 @@ obj-$(CONFIG_SMEM) += smem.o
 obj-$(CONFIG_SOC_DEVICE) += soc.o
 obj-$(CONFIG_SOUND) += sound.o
 obj-$(CONFIG_DM_SPI) += spi.o
+obj-$(CONFIG_SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_SPMI) += spmi.o
 obj-y += syscon.o
 obj-$(CONFIG_RESET_SYSCON) += syscon-reset.o
test/dm/spi_eeprom.c new file +45 -0

45 lines not on this page · raw message

Signature · 1 line
2.54.0
#13 lore raw

v5 cover spi: Introduce driver-model support for SPI EEPROMs

In reply to João Loureiro

This series adds a UCLASS_SPI_EEPROM uclass, a driver for AT25-style parts, a sandbox emulator and a DM test.

Simon, thank you for the detailed review of v4 - it was a genuinely useful read. The point about the hard-coded 16-bit address in particular sent this somewhere better than where I had it, and chasing your comment about the non-standard 'size' and 'pagesize' properties is what turned up the atmel,at25 binding already sitting in the tree, which now drives the whole geometry.

v5 addresses that review. The main change is that the driver is no longer hard-wired to a single 16-bit-addressed part: the address length now comes from driver data and can be overridden from the device tree, so 8-, 16- and 24-bit addressed devices all work.

It also fixes a crash that v3 and v4 both had, and that I only spotted while re-testing this round. Adding the EEPROM emulator to test.dts makes "ut dm" segfault in dm_test_spi_flash: that test picks up its emulator with uclass_first_device_err(UCLASS_SPI_EMUL), assuming the sandbox SPI flash emulator is the only one. The flash emulator is bound lazily on first transfer, so a second emulator described in the device tree is bound during the devicetree scan and lands first in the uclass. sandbox_sf_set_block_protect() then casts a struct sandbox_spi_eeprom to struct sandbox_spi_flash and writes past the end of it, which trips the dlmalloc heap check. Sorry for shipping that in v3/v4 - my testing had been running "ut dm spi_eeprom" rather than the whole suite. New patch 1 fixes the test; with it, "ut dm" on sandbox reports the same 28 failures as an unpatched v2026.10-rc3 tree here (all fixture-related), plus the new spi_eeprom test passing.

Changes in v5:

- New patch 1: test/dm/sf.c now asks for the emulator attached to its own slave rather than the first one in UCLASS_SPI_EMUL, fixing the segfault described above.

- Commit message on patch 2 reworded: imperative mood, "driver model" rather than "driver mode", and it now explains the motivation - what these EEPROMs are used for and why the uclass is wanted.

- SPI_EEPROM_CMD_SIZE is gone. Address length is an addr_len field in driver data, overridable from the device tree, so parts larger than 64 KiB are handled and adding one later does not need an API change.

- The AT25_CMD_* opcodes have moved out of include/spi_eeprom.h into a new private header, drivers/misc/spi_eeprom_priv.h, shared by the driver and the emulator.

- The read path no longer computes "offset + size", which could overflow; the two ranges are checked independently as suggested. probe() additionally rejects a "size" that does not fit the configured address width, so an offset can no longer be silently truncated.

- of_to_plat() dropped; the geometry is read in probe() instead.

- "size" and "pagesize" are kept, and "address-width" added, because they are documented -- and in fact required for non-FRAM parts -- by the atmel,at25 binding in dts/upstream/Bindings/eeprom/at25.yaml, which is already in tree. The commit message and Kconfig help now point at it.

- Compatible list expanded, taking the strings from that binding rather than inventing them: microchip,25aa010a, microchip,at25160bn, atmel,at25256B, st,m95640, st,m95256 and st,m95m02, plus the generic "atmel,at25" fallback the binding requires every node to carry. A node matching only the fallback is fully described by its device tree. The at25010b/020b/040b/080b/640b strings suggested in review are not part of the binding so I left them out, and microchip,25lc040 is in the binding but uses 9-bit addressing, which this driver does not implement yet.

- Kconfig: "depends on MISC" dropped -- the misc uclass really is not used here. (For the record, I2C_EEPROM in tree does still carry it.) The help text now describes the uclass, the AT25 driver, the supported address widths and the read-only limitation.

- include/spi_eeprom.h converted to kerneldoc, and the outer #endif is now commented.

- The sandbox EEPROM node in test.dts follows the binding: it carries the "atmel,at25" fallback compatible and the required size, pagesize and address-width properties.

- Added my own copyright line alongside the existing Philips one on the new files. The first version of this series was posted while I worked at Philips; the rework since is my own.

Patch 3 (the emulator and test) is otherwise unchanged, and I have kept Simon's Reviewed-by and Tested-by on it.

Simon - please do re-test rather than let those tags stand. The tree you tested for v4 segfaulted on a full "ut dm"; only "ut dm spi_eeprom" on its own passes, which I assume is what we both ran. New patch 1 is what makes the full suite pass again. Patch 3 has also changed since
v4: its DT node now follows the atmel,at25 binding, and the emulator includes the new private header instead of the uclass one. Happy to drop the tags if you would rather re-review from scratch.

Changes in v4:
- Emulator frees its backing store in a remove() method.
- Full kerneldoc for sandbox_spi_emul_get().

Changes in v3:
- Reindented with tabs; the series is now checkpatch-clean.
- Dropped the no-op write stub in favour of returning -ENOSYS.
- Removed dead code, fixed the read bounds check, corrected the AT25160 geometry, switched to u8 types and added a MAINTAINERS entry.
- Added the sandbox emulator and the DM test (patch 2).

João Loureiro (3):
test: dm: sf: Get the emulator attached to the flash slave
spi: Introduce initial driver-model support for SPI EEPROMs
sandbox: spi: Add SPI EEPROM emulator and DM test

 MAINTAINERS                    |   9 ++
 arch/sandbox/dts/test.dts      |  16 +-
 configs/sandbox_defconfig      |   1 +
 drivers/misc/Kconfig           |  15 ++
 drivers/misc/Makefile          |   2 +
 drivers/misc/spi_eeprom.c      | 267 +++++++++++++++++++++++++++++++++
 drivers/misc/spi_eeprom_emul.c | 130 ++++++++++++++++
 drivers/misc/spi_eeprom_priv.h |  18 +++
 drivers/spi/sandbox_spi.c      |  37 ++++-
 include/dm/uclass-id.h         |   1 +
 include/spi_eeprom.h           |  95 ++++++++++++
 test/dm/Makefile               |   1 +
 test/dm/sf.c                   |   9 +-
 test/dm/spi_eeprom.c           |  46 ++++++
 14 files changed, 643 insertions(+), 4 deletions(-)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 drivers/misc/spi_eeprom_emul.c
 create mode 100644 drivers/misc/spi_eeprom_priv.h
 create mode 100644 include/spi_eeprom.h
 create mode 100644 test/dm/spi_eeprom.c
Signature · 1 line
2.55.0
#14 lore raw

Re: [PATCH v5 0/3] spi: Introduce driver-model support for SPI EEPROMs

Hi João,

Quoted 92 lines · João Loureiro

This series adds a UCLASS_SPI_EEPROM uclass, a driver for AT25-style parts, a sandbox emulator and a DM test.

Simon, thank you for the detailed review of v4 - it was a genuinely useful read. The point about the hard-coded 16-bit address in particular sent this somewhere better than where I had it, and chasing your comment about the non-standard 'size' and 'pagesize' properties is what turned up the atmel,at25 binding already sitting in the tree, which now drives the whole geometry.

v5 addresses that review. The main change is that the driver is no longer hard-wired to a single 16-bit-addressed part: the address length now comes from driver data and can be overridden from the device tree, so 8-, 16- and 24-bit addressed devices all work.

It also fixes a crash that v3 and v4 both had, and that I only spotted while re-testing this round. Adding the EEPROM emulator to test.dts makes "ut dm" segfault in dm_test_spi_flash: that test picks up its emulator with uclass_first_device_err(UCLASS_SPI_EMUL), assuming the sandbox SPI flash emulator is the only one. The flash emulator is bound lazily on first transfer, so a second emulator described in the device tree is bound during the devicetree scan and lands first in the uclass. sandbox_sf_set_block_protect() then casts a struct sandbox_spi_eeprom to struct sandbox_spi_flash and writes past the end of it, which trips the dlmalloc heap check. Sorry for shipping that in v3/v4 - my testing had been running "ut dm spi_eeprom" rather than the whole suite. New patch 1 fixes the test; with it, "ut dm" on sandbox reports the same 28 failures as an unpatched v2026.10-rc3 tree here (all fixture-related), plus the new spi_eeprom test passing.

Changes in v5:

- New patch 1: test/dm/sf.c now asks for the emulator attached to its own slave rather than the first one in UCLASS_SPI_EMUL, fixing the segfault described above.

- Commit message on patch 2 reworded: imperative mood, "driver model" rather than "driver mode", and it now explains the motivation - what these EEPROMs are used for and why the uclass is wanted.

- SPI_EEPROM_CMD_SIZE is gone. Address length is an addr_len field in driver data, overridable from the device tree, so parts larger than 64 KiB are handled and adding one later does not need an API change.

- The AT25_CMD_* opcodes have moved out of include/spi_eeprom.h into a new private header, drivers/misc/spi_eeprom_priv.h, shared by the driver and the emulator.

- The read path no longer computes "offset + size", which could overflow; the two ranges are checked independently as suggested. probe() additionally rejects a "size" that does not fit the configured address width, so an offset can no longer be silently truncated.

- of_to_plat() dropped; the geometry is read in probe() instead.

- "size" and "pagesize" are kept, and "address-width" added, because they are documented -- and in fact required for non-FRAM parts -- by the atmel,at25 binding in dts/upstream/Bindings/eeprom/at25.yaml, which is already in tree. The commit message and Kconfig help now point at it.

- Compatible list expanded, taking the strings from that binding rather than inventing them: microchip,25aa010a, microchip,at25160bn, atmel,at25256B, st,m95640, st,m95256 and st,m95m02, plus the generic "atmel,at25" fallback the binding requires every node to carry. A node matching only the fallback is fully described by its device tree. The at25010b/020b/040b/080b/640b strings suggested in review are not part of the binding so I left them out, and microchip,25lc040 is in the binding but uses 9-bit addressing, which this driver does not implement yet.

- Kconfig: "depends on MISC" dropped -- the misc uclass really is not used here. (For the record, I2C_EEPROM in tree does still carry it.) The help text now describes the uclass, the AT25 driver, the supported address widths and the read-only limitation.

- include/spi_eeprom.h converted to kerneldoc, and the outer #endif is now commented.

- The sandbox EEPROM node in test.dts follows the binding: it carries the "atmel,at25" fallback compatible and the required size, pagesize and address-width properties.

- Added my own copyright line alongside the existing Philips one on the new files. The first version of this series was posted while I worked at Philips; the rework since is my own.

Patch 3 (the emulator and test) is otherwise unchanged, and I have kept Simon's Reviewed-by and Tested-by on it.

Quoted 7 lines

Simon - please do re-test rather than let those tags stand. The tree you tested for v4 segfaulted on a full "ut dm"; only "ut dm spi_eeprom" on its own passes, which I assume is what we both ran. New patch 1 is what makes the full suite pass again. Patch 3 has also changed since
v4: its DT node now follows the atmel,at25 binding, and the emulator includes the new private header instead of the uclass one. Happy to drop the tags if you would rather re-review from scratch.

Thanks for the v5 - but there is something a bit odd about this series in patchwork:

https://patchwork.ozlabs.org/project/uboot/patch/[email protected]/

There are three v4 patches and then a v5. Can you please try to resend it (perhaps as v6)? There should be three patches all connected to the same cover letter.

Quoted 38 lines

Changes in v4:
- Emulator frees its backing store in a remove() method.
- Full kerneldoc for sandbox_spi_emul_get().

Changes in v3:
- Reindented with tabs; the series is now checkpatch-clean.
- Dropped the no-op write stub in favour of returning -ENOSYS.
- Removed dead code, fixed the read bounds check, corrected the AT25160 geometry, switched to u8 types and added a MAINTAINERS entry.
- Added the sandbox emulator and the DM test (patch 2).

João Loureiro (3):
test: dm: sf: Get the emulator attached to the flash slave
spi: Introduce initial driver-model support for SPI EEPROMs
sandbox: spi: Add SPI EEPROM emulator and DM test

 MAINTAINERS                    |   9 ++
 arch/sandbox/dts/test.dts      |  16 +-
 configs/sandbox_defconfig      |   1 +
 drivers/misc/Kconfig           |  15 ++
 drivers/misc/Makefile          |   2 +
 drivers/misc/spi_eeprom.c      | 267 +++++++++++++++++++++++++++++++++
 drivers/misc/spi_eeprom_emul.c | 130 ++++++++++++++++
 drivers/misc/spi_eeprom_priv.h |  18 +++
 drivers/spi/sandbox_spi.c      |  37 ++++-
 include/dm/uclass-id.h         |   1 +
 include/spi_eeprom.h           |  95 ++++++++++++
 test/dm/Makefile               |   1 +
 test/dm/sf.c                   |   9 +-
 test/dm/spi_eeprom.c           |  46 ++++++
 14 files changed, 643 insertions(+), 4 deletions(-)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 drivers/misc/spi_eeprom_emul.c
 create mode 100644 drivers/misc/spi_eeprom_priv.h
 create mode 100644 include/spi_eeprom.h
 create mode 100644 test/dm/spi_eeprom.c
Quoted 3 lines

--
2.55.0

Regards,
Simon

#15 lore raw

Re: [PATCH v5 0/3] spi: Introduce driver-model support for SPI EEPROMs

In reply to João Loureiro
Quoted 15 lines · João Loureiro

This series adds a UCLASS_SPI_EEPROM uclass, a driver for AT25-style parts, a sandbox emulator and a DM test.

Simon, thank you for the detailed review of v4 - it was a genuinely useful read. The point about the hard-coded 16-bit address in particular sent this somewhere better than where I had it, and chasing your comment about the non-standard 'size' and 'pagesize' properties is what turned up the atmel,at25 binding already sitting in the tree, which now drives the whole geometry.

v5 addresses that review. The main change is that the driver is no longer hard-wired to a single 16-bit-addressed part: the address length now comes from driver data and can be overridden from the device tree, so 8-, 16- and 24-bit addressed devices all work.

Quoted 14 lines

It also fixes a crash that v3 and v4 both had, and that I only spotted while re-testing this round. Adding the EEPROM emulator to test.dts makes "ut dm" segfault in dm_test_spi_flash: that test picks up its emulator with uclass_first_device_err(UCLASS_SPI_EMUL), assuming the sandbox SPI flash emulator is the only one. The flash emulator is bound lazily on first transfer, so a second emulator described in the device tree is bound during the devicetree scan and lands first in the uclass. sandbox_sf_set_block_protect() then casts a struct sandbox_spi_eeprom to struct sandbox_spi_flash and writes past the end of it, which trips the dlmalloc heap check. Sorry for shipping that in v3/v4 - my testing had been running "ut dm spi_eeprom" rather than the whole suite. New patch 1 fixes the test; with it, "ut dm" on sandbox reports the same 28 failures as an unpatched v2026.10-rc3 tree here (all fixture-related), plus the new spi_eeprom test passing.

This series causes sandbox_vpl to fail to run and so CI fails. There's nothing interesting in the CI log at
https://git.u-boot-project.org/u-boot/u-boot/-/jobs/95436 unfortunately.

Signature · 1 line
Tom
#16 lore raw

PATCH v5 1/3 test: dm: sf: Get the emulator attached to the flash slave

In reply to João Loureiro

dm_test_spi_flash() picks up its SPI emulator with uclass_first_device_err(UCLASS_SPI_EMUL), which assumes the sandbox SPI flash emulator is the only device in that uclass. That holds today only because the flash emulator is bound lazily, on the first transfer.

As soon as a second SPI emulator is described in the device tree it is bound during the devicetree scan and so comes first in the uclass. The test then hands a foreign device to sandbox_sf_set_block_protect(), which casts its private data to struct sandbox_spi_flash and writes past the end of it, corrupting the heap.

Ask for the emulator attached to this particular slave instead, which is what the test means, and which stays correct however many SPI emulators exist.

---
 test/dm/sf.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
test/dm/sf.c +7 -2
index 3684d021709..0ec02ac694b 100644
@@ -50,8 +50,13 @@ static int dm_test_spi_flash(struct unit_test_state *uts)
 	ut_assertok(spi_flash_read_dm(dev, 0, size, dst));
 	ut_asserteq_mem(src, dst, size);
 
-	/* Try the write-protect stuff */
-	ut_assertok(uclass_first_device_err(UCLASS_SPI_EMUL, &emul));
+	/*
+	 * Try the write-protect stuff. Ask for the emulator attached to this
+	 * particular slave rather than the first one in the uclass, since
+	 * other SPI emulators may be present.
+	 */
+	ut_assertok(sandbox_spi_get_emul(state_get_current(), dev->parent, dev,
+					 &emul));
 	ut_asserteq(0, spl_flash_get_sw_write_prot(dev));
 	sandbox_sf_set_block_protect(emul, 1);
 	ut_asserteq(1, spl_flash_get_sw_write_prot(dev));
Signature · 1 line
2.55.0
#17 lore raw

PATCH v5 2/3 spi: Introduce initial driver-model support for SPI EEPROMs

In reply to João Loureiro

U-Boot has driver-model support for EEPROMs on several buses - I2C through UCLASS_I2C_EEPROM and 1-Wire through UCLASS_W1_EEPROM - but nothing for SPI, even though SPI EEPROMs are common and are usually the faster part of the two.

These devices typically hold a board's identity: its serial number, a unique device ID and the hardware variant. U-Boot needs that early, both to decide which device tree and overlays to load for the variant it happens to be running on, and to hand the unique IDs to the system it is about to boot. Today a board that wants any of this has to open-code raw SPI transfers in board code, which is neither reusable nor testable.

Introduce a UCLASS_SPI_EEPROM uclass with read/write/size operations, analogous to the I2C EEPROM uclass, along with a driver for AT25-style parts. The chip geometry - total size, page size and address width - is taken from the device tree as described by the atmel,at25 binding in dts/upstream/Bindings/eeprom/at25.yaml, which requires those properties, falling back to per-compatible defaults held in driver data. Devices using 8-, 16- and 24-bit addressing are therefore all covered, and adding a part later is a driver-data entry rather than a change to the uclass API. The 9-bit addressing mode the binding also allows, where the ninth address bit travels in the opcode, is not implemented.

Only reading is implemented for now; spi_eeprom_write() returns -ENOSYS. Enable the uclass in sandbox_defconfig so that the emulator and DM test added by the next patch are built.

---
 MAINTAINERS                    |   7 +
 configs/sandbox_defconfig      |   1 +
 drivers/misc/Kconfig           |  15 ++
 drivers/misc/Makefile          |   1 +
 drivers/misc/spi_eeprom.c      | 267 +++++++++++++++++++++++++++++++++
 drivers/misc/spi_eeprom_priv.h |  18 +++
 include/dm/uclass-id.h         |   1 +
 include/spi_eeprom.h           |  95 ++++++++++++
 8 files changed, 405 insertions(+)
 create mode 100644 drivers/misc/spi_eeprom.c
 create mode 100644 drivers/misc/spi_eeprom_priv.h
 create mode 100644 include/spi_eeprom.h
MAINTAINERS +7 -0
index eb48eea55c5..893cf421378 100644
@@ -1708,6 +1708,13 @@ T:	git https://git.u-boot-project.org/u-boot/custodians/u-boot-spi.git
 F:	drivers/spi/
 F:	include/spi*
 
+SPI EEPROM
+M:	João Loureiro <[email protected]>
+S:	Maintained
+F:	drivers/misc/spi_eeprom.c
+F:	drivers/misc/spi_eeprom_priv.h
+F:	include/spi_eeprom.h
+
 SPI NAND
 M:	Dario Binacchi <[email protected]>
 M:	Michael Trimarchi <[email protected]>
configs/sandbox_defconfig +1 -0
index 79f46317e45..f6373af8217 100644
@@ -266,6 +266,7 @@ CONFIG_SYS_NAND_USE_FLASH_BBT=y
 CONFIG_NAND_SANDBOX=y
 CONFIG_SYS_NAND_ONFI_DETECTION=y
 CONFIG_SYS_NAND_PAGE_SIZE=0x200
+CONFIG_SPI_EEPROM=y
 CONFIG_SPI_FLASH_SANDBOX=y
 CONFIG_BOOTDEV_SPI_FLASH=y
 CONFIG_SPI_FLASH_ATMEL=y
drivers/misc/Kconfig +15 -0
index 44415f24ae1..8409635ef17 100644
@@ -567,6 +567,21 @@ config I2C_EEPROM
 	help
 	  Enable a generic driver for EEPROMs attached via I2C.
 
+config SPI_EEPROM
+	bool "Enable driver for generic SPI-attached EEPROMs"
+	help
+	  Enable a generic driver for EEPROMs attached via SPI.
+
+	  This provides the UCLASS_SPI_EEPROM uclass together with a driver
+	  for AT25-style parts, i.e. devices described by the "atmel,at25"
+	  device tree binding. The chip geometry (size, pagesize and
+	  address-width) is read from the device tree, with per-compatible
+	  defaults for the parts listed in the driver. Parts using 8-, 16-
+	  and 24-bit addressing are supported; 9-bit addressing, where the
+	  ninth address bit travels in the opcode, is not.
+
+	  Only read access is implemented at present; spi_eeprom_write()
+	  returns -ENOSYS.
 
 config SPL_I2C_EEPROM
 	bool "Enable driver for generic I2C-attached EEPROMs for SPL"
drivers/misc/Makefile +1 -0
index e2170212e5a..8c9f8eb9cfa 100644
@@ -44,6 +44,7 @@ obj-$(CONFIG_GDSYS_SOC) += gdsys_soc.o
 obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(PHASE_)I2C_EEPROM) += i2c_eeprom.o
+obj-$(CONFIG_$(PHASE_)SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom.c new file +267 -0

267 lines not on this page · raw message

drivers/misc/spi_eeprom_priv.h new file +18 -0
new file mode 100644
index 00000000000..142ffc736c7
@@ -0,0 +1,18 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+/*
+ * Command set shared by the AT25-style SPI EEPROM driver and its sandbox
+ * emulator. These opcodes are an implementation detail of the driver, not
+ * part of the UCLASS_SPI_EEPROM API.
+ *
+ * Copyright (c) 2024 Koninklijke Philips N.V.
+ * Copyright (c) 2026 João Loureiro <[email protected]>
+ */
+
+#ifndef __SPI_EEPROM_PRIV_H
+#define __SPI_EEPROM_PRIV_H
+
+/* AT25-style command set */
+#define AT25_CMD_READ_DATA	0x03	/* Read data from memory array */
+#define AT25_CMD_READ_STATUS	0x05	/* Read status register */
+
+#endif /* __SPI_EEPROM_PRIV_H */
include/dm/uclass-id.h +1 -0
index 36b5d87c304..d24b4a1a121 100644
@@ -138,6 +138,7 @@ enum uclass_id {
 	UCLASS_SOC,		/* SOC Device */
 	UCLASS_SOUND,		/* Playing simple sounds */
 	UCLASS_SPI,		/* SPI bus */
+	UCLASS_SPI_EEPROM,	/* SPI EEPROM device */
 	UCLASS_SPI_FLASH,	/* SPI flash */
 	UCLASS_SPI_GENERIC,	/* Generic SPI flash target */
 	UCLASS_SPMI,		/* System Power Management Interface bus */
include/spi_eeprom.h new file +95 -0

95 lines not on this page · raw message

Signature · 1 line
2.55.0
#18 lore raw

PATCH v5 3/3 sandbox: spi: Add SPI EEPROM emulator and DM test

In reply to João Loureiro

Add a sandbox emulator for an AT25-style SPI EEPROM so the new SPI EEPROM uclass can be exercised without real hardware.

The sandbox SPI controller previously always bound the SPI flash emulator for every chip select. Allow a slave node to select its own emulator through a sandbox,emul phandle (mirroring the sandbox I2C bus), falling back to the SPI flash emulator when none is given so that existing behaviour is preserved.

A test EEPROM is wired up on chip select 3 of the sandbox SPI bus and a test/dm test verifies size reporting, patterned reads, out-of-bounds rejection and the unimplemented write path. The node follows the atmel,at25 binding: it carries the "atmel,at25" fallback compatible and the required size, pagesize and address-width properties.

---
Simon: I have kept your Tested-by, but please do re-test rather than rely on it. The v4 tree segfaulted on a full "ut dm" - test/dm/sf.c took the first UCLASS_SPI_EMUL device as the flash emulator, which the emulator added here displaces, so sandbox_sf_set_block_protect() wrote past the end of the wrong private struct. Running "ut dm spi_eeprom" alone passes and hides it. Patch 1 fixes the test.

Also changed since v4: the DT node now carries the "atmel,at25" fallback compatible with the required size/pagesize/address-width, and the emulator includes drivers/misc/spi_eeprom_priv.h.

 MAINTAINERS                    |   2 +
 arch/sandbox/dts/test.dts      |  16 +++-
 drivers/misc/Makefile          |   1 +
 drivers/misc/spi_eeprom_emul.c | 130 +++++++++++++++++++++++++++++++++
 drivers/spi/sandbox_spi.c      |  37 +++++++++-
 test/dm/Makefile               |   1 +
 test/dm/spi_eeprom.c           |  46 ++++++++++++
 7 files changed, 231 insertions(+), 2 deletions(-)
 create mode 100644 drivers/misc/spi_eeprom_emul.c
 create mode 100644 test/dm/spi_eeprom.c
MAINTAINERS +2 -0
index 893cf421378..92e26829e1a 100644
@@ -1712,8 +1712,10 @@ SPI EEPROM
 M:	João Loureiro <[email protected]>
 S:	Maintained
 F:	drivers/misc/spi_eeprom.c
+F:	drivers/misc/spi_eeprom_emul.c
 F:	drivers/misc/spi_eeprom_priv.h
 F:	include/spi_eeprom.h
+F:	test/dm/spi_eeprom.c
 
 SPI NAND
 M:	Dario Binacchi <[email protected]>
arch/sandbox/dts/test.dts +15 -1
index d24feec5422..7d7f0376348 100644
@@ -1618,7 +1618,7 @@
 		#size-cells = <0>;
 		reg = <0 1>;
 		compatible = "sandbox,spi";
-		cs-gpios = <0>, <0>, <&gpio_a 0>;
+		cs-gpios = <0>, <0>, <&gpio_a 0>, <0>;
 		pinctrl-names = "default";
 		pinctrl-0 = <&pinmux_spi0_pins>;
 
@@ -1636,6 +1636,20 @@
 			spi-cpol;
 			spi-cpha;
 		};
+		eeprom@3 {
+			reg = <3>;
+			compatible = "microchip,at25160bn", "atmel,at25";
+			spi-max-frequency = <1000000>;
+			size = <2048>;
+			pagesize = <32>;
+			address-width = <16>;
+			sandbox,emul = <&spi_eeprom_emul>;
+		};
+	};
+
+	spi_eeprom_emul: spi-eeprom-emul {
+		compatible = "sandbox,spi-eeprom";
+		sandbox,size = <2048>;
 	};
 
 	syscon0: syscon@0 {
drivers/misc/Makefile +1 -0
index 8c9f8eb9cfa..8fa0fe75b53 100644
@@ -45,6 +45,7 @@ obj-$(CONFIG_IRQ) += irq-uclass.o
 obj-$(CONFIG_SANDBOX) += irq_sandbox.o irq_sandbox_test.o
 obj-$(CONFIG_$(PHASE_)I2C_EEPROM) += i2c_eeprom.o
 obj-$(CONFIG_$(PHASE_)SPI_EEPROM) += spi_eeprom.o
+obj-$(CONFIG_SANDBOX) += spi_eeprom_emul.o
 obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_IMX_ELE) += imx_ele/
drivers/misc/spi_eeprom_emul.c new file +130 -0

130 lines not on this page · raw message

drivers/spi/sandbox_spi.c +36 -1
index 3ee97d67f4a..aa4edcf64b2 100644
@@ -77,6 +77,41 @@ static int sandbox_spi_set_wordlen(struct udevice *dev, unsigned int wordlen)
 	return 0;
 }
 
+/**
+ * sandbox_spi_emul_get() - find the emulator for a SPI slave
+ *
+ * A slave can name a dedicated emulator through a "sandbox,emul" phandle (for
+ * example an SPI EEPROM). When no such phandle is present we fall back to the
+ * built-in SPI flash emulator, preserving the previous behaviour.
+ *
+ * @state: Sandbox state, used to cache the bound emulator per chip select
+ * @bus: SPI bus the slave is attached to
+ * @slave: SPI slave to find the emulator for
+ * @emulp: Returns the emulator device on success
+ * Return: 0 if OK, -ve on error
+ */
+static int sandbox_spi_emul_get(struct sandbox_state *state, struct udevice *bus,
+				struct udevice *slave, struct udevice **emulp)
+{
+	struct sandbox_spi_info *info;
+	int ret;
+
+	info = &state->spi[dev_seq(bus)][spi_chip_select(slave)];
+	if (info->emul) {
+		*emulp = info->emul;
+		return 0;
+	}
+
+	ret = uclass_get_device_by_phandle(UCLASS_SPI_EMUL, slave, "sandbox,emul",
+					   emulp);
+	if (!ret) {
+		info->emul = *emulp;
+		return 0;
+	}
+
+	return sandbox_spi_get_emul(state, bus, slave, emulp);
+}
+
 static int sandbox_spi_xfer(struct udevice *slave, unsigned int bitlen,
 			    const void *dout, void *din, unsigned long flags)
 {
@@ -106,7 +141,7 @@ static int sandbox_spi_xfer(struct udevice *slave, unsigned int bitlen,
 		       busnum, cs);
 		return -ENOENT;
 	}
-	ret = sandbox_spi_get_emul(state, bus, slave, &emul);
+	ret = sandbox_spi_emul_get(state, bus, slave, &emul);
 	if (ret) {
 		printf("%s: busnum=%u, cs=%u: no emulation available (err=%d)\n",
 		       __func__, busnum, cs, ret);
test/dm/Makefile +1 -0
index fb3e6a7008f..3a8599d6bc2 100644
@@ -120,6 +120,7 @@ obj-$(CONFIG_SMEM) += smem.o
 obj-$(CONFIG_SOC_DEVICE) += soc.o
 obj-$(CONFIG_SOUND) += sound.o
 obj-$(CONFIG_DM_SPI) += spi.o
+obj-$(CONFIG_SPI_EEPROM) += spi_eeprom.o
 obj-$(CONFIG_SPMI) += spmi.o
 obj-y += syscon.o
 obj-$(CONFIG_RESET_SYSCON) += syscon-reset.o
test/dm/spi_eeprom.c new file +46 -0

46 lines not on this page · raw message

Signature · 1 line
2.55.0