From patchwork Thu May 14 18:09:40 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jagan Teki X-Patchwork-Id: 245827 List-Id: U-Boot discussion From: jagan at amarulasolutions.com (Jagan Teki) Date: Thu, 14 May 2020 23:39:40 +0530 Subject: [PATCH 1/2] mtd: spi: Separate dm vs nodm SF code Message-ID: <20200514180941.21542-1-jagan@amarulasolutions.com> Right now, the sf have common driver to handle both dm and nodm code, where nondm has spi_flash probe and dm has U_BOOT_DRIVER for dm spi flash. Having a common code base for dm and nodm with ifdef make it difficult to extend functionalities and also difficult to read. So, keep them separate and give scope to dm code for further enhancements. Cc: Simon Glass Cc: Vignesh R Cc: Daniel Schwierzeck Signed-off-by: Jagan Teki --- drivers/mtd/spi/Makefile | 8 ++- drivers/mtd/spi/sf-nodm.c | 76 +++++++++++++++++++++ drivers/mtd/spi/sf-uclass.c | 128 ++++++++++++++++++++++++++++++++++++ 3 files changed, 210 insertions(+), 2 deletions(-) create mode 100644 drivers/mtd/spi/sf-nodm.c diff --git a/drivers/mtd/spi/Makefile b/drivers/mtd/spi/Makefile index b5dfa300de..b3ae74dbe8 100644 --- a/drivers/mtd/spi/Makefile +++ b/drivers/mtd/spi/Makefile @@ -3,8 +3,12 @@ # (C) Copyright 2006 # Wolfgang Denk, DENX Software Engineering, wd at denx.de. -obj-$(CONFIG_DM_SPI_FLASH) += sf-uclass.o -spi-nor-y := sf_probe.o spi-nor-ids.o +ifdef CONFIG_DM_SPI_FLASH +spi-nor-y += sf-uclass.o +else +spi-nor-y += sf-nodm.o +endif +spi-nor-y += spi-nor-ids.o ifdef CONFIG_SPL_BUILD obj-$(CONFIG_SPL_SPI_BOOT) += fsl_espi_spl.o diff --git a/drivers/mtd/spi/sf-nodm.c b/drivers/mtd/spi/sf-nodm.c new file mode 100644 index 0000000000..b23014c2a8 --- /dev/null +++ b/drivers/mtd/spi/sf-nodm.c @@ -0,0 +1,76 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * SPI flash probing + * + * Copyright (C) 2008 Atmel Corporation + * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik + * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc. + */ + +#include +#include +#include +#include +#include +#include + +#include "sf_internal.h" + +struct spi_flash *spi_flash_probe(unsigned int busnum, unsigned int cs, + unsigned int max_hz, unsigned int spi_mode) +{ + struct spi_slave *bus; + struct spi_flash *flash; + int ret; + + /* Allocate space if needed (not used by sf-uclass) */ + flash = calloc(1, sizeof(*flash)); + if (!flash) { + debug("SF: Failed to allocate spi_flash\n"); + return NULL; + } + + bus = spi_setup_slave(busnum, cs, max_hz, spi_mode); + if (!bus) { + printf("SF: Failed to set up slave\n"); + goto err_free; + } + + flash->spi = bus; + + /* Claim spi bus */ + ret = spi_claim_bus(bus); + if (ret) { + debug("SF: Failed to claim SPI bus: %d\n", ret); + goto err_free_slave; + } + + ret = spi_nor_scan(flash); + if (ret) + goto err_read_id; + + if (CONFIG_IS_ENABLED(SPI_FLASH_MTD)) { + ret = spi_flash_mtd_register(flash); + if (ret) + goto err_read_id; + } + + return flash; + +err_read_id: + spi_release_bus(bus); +err_free_slave: + spi_free_slave(bus); +err_free: + free(flash); + return NULL; +} + +void spi_flash_free(struct spi_flash *flash) +{ + if (CONFIG_IS_ENABLED(SPI_FLASH_MTD)) + spi_flash_mtd_unregister(); + + spi_free_slave(flash->spi); + free(flash); +} diff --git a/drivers/mtd/spi/sf-uclass.c b/drivers/mtd/spi/sf-uclass.c index 5a42ab83c8..97a3f5d2c7 100644 --- a/drivers/mtd/spi/sf-uclass.c +++ b/drivers/mtd/spi/sf-uclass.c @@ -95,6 +95,134 @@ static int spi_flash_post_bind(struct udevice *dev) return 0; } +static int spi_flash_std_read(struct udevice *dev, u32 offset, size_t len, + void *buf) +{ + struct spi_flash *flash = dev_get_uclass_priv(dev); + struct mtd_info *mtd = &flash->mtd; + size_t retlen; + + return log_ret(mtd->_read(mtd, offset, len, &retlen, buf)); +} + +static int spi_flash_std_write(struct udevice *dev, u32 offset, size_t len, + const void *buf) +{ + struct spi_flash *flash = dev_get_uclass_priv(dev); + struct mtd_info *mtd = &flash->mtd; + size_t retlen; + + return mtd->_write(mtd, offset, len, &retlen, buf); +} + +static int spi_flash_std_erase(struct udevice *dev, u32 offset, size_t len) +{ + struct spi_flash *flash = dev_get_uclass_priv(dev); + struct mtd_info *mtd = &flash->mtd; + struct erase_info instr; + + if (offset % mtd->erasesize || len % mtd->erasesize) { + printf("SF: Erase offset/length not multiple of erase size\n"); + return -EINVAL; + } + + memset(&instr, 0, sizeof(instr)); + instr.addr = offset; + instr.len = len; + + return mtd->_erase(mtd, &instr); +} + +int spi_flash_std_probe(struct udevice *dev) +{ + struct spi_slave *slave = dev_get_parent_priv(dev); + struct spi_flash *flash; + int ret; + + if (!slave) { + printf("SF: Failed to set up slave\n"); + return -ENODEV; + } + + flash = dev_get_uclass_priv(dev); + flash->dev = dev; + flash->spi = slave; + + /* Claim spi bus */ + ret = spi_claim_bus(slave); + if (ret) { + debug("SF: Failed to claim SPI bus: %d\n", ret); + return ret; + } + + ret = spi_nor_scan(flash); + if (ret) + goto err_read_id; + + if (CONFIG_IS_ENABLED(SPI_FLASH_MTD)) + ret = spi_flash_mtd_register(flash); + +err_read_id: + spi_release_bus(slave); + return ret; +} + +static int spi_flash_std_remove(struct udevice *dev) +{ + if (CONFIG_IS_ENABLED(SPI_FLASH_MTD)) + spi_flash_mtd_unregister(); + + return 0; +} + +static const struct dm_spi_flash_ops spi_flash_std_ops = { + .read = spi_flash_std_read, + .write = spi_flash_std_write, + .erase = spi_flash_std_erase, +}; + +/* + * Manually set the parent of the SPI flash to SPI, since dtoc doesn't. We also + * need to allocate the parent_platdata since by the time this function is + * called device_bind() has already gone past that step. + */ +static int spi_flash_bind(struct udevice *dev) +{ + if (CONFIG_IS_ENABLED(OF_PLATDATA)) { + struct dm_spi_slave_platdata *plat; + struct udevice *spi; + int ret; + + ret = uclass_first_device_err(UCLASS_SPI, &spi); + if (ret) + return ret; + dev->parent = spi; + + plat = calloc(sizeof(*plat), 1); + if (!plat) + return -ENOMEM; + dev->parent_platdata = plat; + } + + return 0; +} + +static const struct udevice_id spi_flash_std_ids[] = { + { .compatible = "jedec,spi-nor" }, + { } +}; + +U_BOOT_DRIVER(spi_flash_std) = { + .name = "spi_flash_std", + .id = UCLASS_SPI_FLASH, + .of_match = spi_flash_std_ids, + .bind = spi_flash_bind, + .probe = spi_flash_std_probe, + .remove = spi_flash_std_remove, + .priv_auto_alloc_size = sizeof(struct spi_flash), + .ops = &spi_flash_std_ops, +}; + UCLASS_DRIVER(spi_flash) = { .id = UCLASS_SPI_FLASH, .name = "spi_flash", From patchwork Thu May 14 18:09:41 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jagan Teki X-Patchwork-Id: 245826 List-Id: U-Boot discussion From: jagan at amarulasolutions.com (Jagan Teki) Date: Thu, 14 May 2020 23:39:41 +0530 Subject: [PATCH 2/2] sf: Simplify probe for dm code In-Reply-To: <20200514180941.21542-1-jagan@amarulasolutions.com> References: <20200514180941.21542-1-jagan@amarulasolutions.com> Message-ID: <20200514180941.21542-2-jagan@amarulasolutions.com> Handling probing code for a particular uclass between dm vs nodm always confusing and requires additional ifdefs to handle them properly. But, having separate low-level code bases for dm and nodm can make it easy for the command level to use same function name to probe the devices. This would indeed avoid extra ifdef call in source code. So, this patch probes the spi flash in common legacy call spi_flash_probe for both dm and nodm devices and give a chance to handle on respective code bases based on the build files. Cc: Simon Glass Cc: Vignesh R Cc: Daniel Schwierzeck Signed-off-by: Jagan Teki --- cmd/sf.c | 22 --------------------- drivers/mtd/spi/sf-uclass.c | 38 +++++++++++++------------------------ drivers/net/fm/fm.c | 20 ------------------- env/sf.c | 17 +---------------- include/spi_flash.h | 20 +++++-------------- 5 files changed, 19 insertions(+), 98 deletions(-) diff --git a/cmd/sf.c b/cmd/sf.c index 302201c2b0..3835dd857d 100644 --- a/cmd/sf.c +++ b/cmd/sf.c @@ -87,12 +87,7 @@ static int do_spi_flash_probe(int argc, char * const argv[]) unsigned int speed = CONFIG_SF_DEFAULT_SPEED; unsigned int mode = CONFIG_SF_DEFAULT_MODE; char *endp; -#ifdef CONFIG_DM_SPI_FLASH - struct udevice *new, *bus_dev; - int ret; -#else struct spi_flash *new; -#endif if (argc >= 2) { cs = simple_strtoul(argv[1], &endp, 0); @@ -120,22 +115,6 @@ static int do_spi_flash_probe(int argc, char * const argv[]) return -1; } -#ifdef CONFIG_DM_SPI_FLASH - /* Remove the old device, otherwise probe will just be a nop */ - ret = spi_find_bus_and_cs(bus, cs, &bus_dev, &new); - if (!ret) { - device_remove(new, DM_REMOVE_NORMAL); - } - flash = NULL; - ret = spi_flash_probe_bus_cs(bus, cs, speed, mode, &new); - if (ret) { - printf("Failed to initialize SPI flash at %u:%u (error %d)\n", - bus, cs, ret); - return 1; - } - - flash = dev_get_uclass_priv(new); -#else if (flash) spi_flash_free(flash); @@ -145,7 +124,6 @@ static int do_spi_flash_probe(int argc, char * const argv[]) printf("Failed to initialize SPI flash at %u:%u\n", bus, cs); return 1; } -#endif return 0; } diff --git a/drivers/mtd/spi/sf-uclass.c b/drivers/mtd/spi/sf-uclass.c index 97a3f5d2c7..4993f7cd02 100644 --- a/drivers/mtd/spi/sf-uclass.c +++ b/drivers/mtd/spi/sf-uclass.c @@ -29,50 +29,38 @@ int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len) return log_ret(sf_get_ops(dev)->erase(dev, offset, len)); } -/* - * TODO(sjg at chromium.org): This is an old-style function. We should remove - * it when all SPI flash drivers use dm - */ -struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, - unsigned int max_hz, unsigned int spi_mode) -{ - struct udevice *dev; - - if (spi_flash_probe_bus_cs(bus, cs, max_hz, spi_mode, &dev)) - return NULL; - - return dev_get_uclass_priv(dev); -} - void spi_flash_free(struct spi_flash *flash) { device_remove(flash->spi->dev, DM_REMOVE_NORMAL); } -int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs, - unsigned int max_hz, unsigned int spi_mode, - struct udevice **devp) +struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, + unsigned int max_hz, unsigned int spi_mode) { struct spi_slave *slave; - struct udevice *bus; + struct udevice *new, *bus_dev; char *str; int ret; + /* Remove the old device, otherwise probe will just be a nop */ + ret = spi_find_bus_and_cs(bus, cs, &bus_dev, &new); + if (!ret) + device_remove(new, DM_REMOVE_NORMAL); + #if defined(CONFIG_SPL_BUILD) && CONFIG_IS_ENABLED(USE_TINY_PRINTF) str = "spi_flash"; #else char name[30]; - snprintf(name, sizeof(name), "spi_flash@%d:%d", busnum, cs); + snprintf(name, sizeof(name), "spi_flash@%d:%d", bus, cs); str = strdup(name); #endif - ret = spi_get_bus_and_cs(busnum, cs, max_hz, spi_mode, - "spi_flash_std", str, &bus, &slave); + ret = spi_get_bus_and_cs(bus, cs, max_hz, spi_mode, + "spi_flash_std", str, &bus_dev, &slave); if (ret) - return ret; + return NULL; - *devp = slave->dev; - return 0; + return dev_get_uclass_priv(slave->dev); } static int spi_flash_post_bind(struct udevice *dev) diff --git a/drivers/net/fm/fm.c b/drivers/net/fm/fm.c index 8ab1816395..811d1cd4fa 100644 --- a/drivers/net/fm/fm.c +++ b/drivers/net/fm/fm.c @@ -383,20 +383,10 @@ int fm_init_common(int index, struct ccsr_fman *reg) addr = malloc(CONFIG_SYS_QE_FMAN_FW_LENGTH); int ret = 0; -#ifdef CONFIG_DM_SPI_FLASH - struct udevice *new; - - /* speed and mode will be read from DT */ - ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, - CONFIG_ENV_SPI_CS, 0, 0, &new); - - ucode_flash = dev_get_uclass_priv(new); -#else ucode_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS, CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE); -#endif if (!ucode_flash) { printf("SF: probe for ucode failed\n"); } else { @@ -470,18 +460,8 @@ int fm_init_common(int index, struct ccsr_fman *reg) void *addr = malloc(CONFIG_SYS_QE_FMAN_FW_LENGTH); int ret = 0; -#ifdef CONFIG_DM_SPI_FLASH - struct udevice *new; - - /* speed and mode will be read from DT */ - ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS, - 0, 0, &new); - - ucode_flash = dev_get_uclass_priv(new); -#else ucode_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS, CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE); -#endif if (!ucode_flash) printf("SF: probe for ucode failed\n"); else { diff --git a/env/sf.c b/env/sf.c index af59c8375c..253f467832 100644 --- a/env/sf.c +++ b/env/sf.c @@ -35,21 +35,6 @@ static struct spi_flash *env_flash; static int setup_flash_device(void) { -#ifdef CONFIG_DM_SPI_FLASH - struct udevice *new; - int ret; - - /* speed and mode will be read from DT */ - ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS, - CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE, - &new); - if (ret) { - env_set_default("spi_flash_probe_bus_cs() failed", 0); - return ret; - } - - env_flash = dev_get_uclass_priv(new); -#else struct spi_flash *new; if (env_flash) @@ -62,7 +47,7 @@ static int setup_flash_device(void) env_set_default("spi_flash_probe() failed", 0); return -EIO; } -#endif + return 0; } diff --git a/include/spi_flash.h b/include/spi_flash.h index 3b33b970ef..c270c6eff7 100644 --- a/include/spi_flash.h +++ b/include/spi_flash.h @@ -75,17 +75,6 @@ int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, */ int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); -int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs, - unsigned int max_hz, unsigned int spi_mode, - struct udevice **devp); - -/* Compatibility function - this is the old U-Boot API */ -struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, - unsigned int max_hz, unsigned int spi_mode); - -/* Compatibility function - this is the old U-Boot API */ -void spi_flash_free(struct spi_flash *flash); - static inline int spi_flash_read(struct spi_flash *flash, u32 offset, size_t len, void *buf) { @@ -112,10 +101,6 @@ int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs, void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs); #else -struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, - unsigned int max_hz, unsigned int spi_mode); - -void spi_flash_free(struct spi_flash *flash); static inline int spi_flash_read(struct spi_flash *flash, u32 offset, size_t len, void *buf) @@ -154,6 +139,11 @@ static inline int spi_flash_erase(struct spi_flash *flash, u32 offset, } #endif +struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, + unsigned int max_hz, unsigned int spi_mode); + +void spi_flash_free(struct spi_flash *flash); + static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len, bool prot) {