drivers/mtd/spi/sf_probe.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * SPI flash probing
   4  *
   5  * Copyright (C) 2008 Atmel Corporation
   6  * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
   7  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
   8  */
   9
  10 #include <common.h>
  11 #include <dm.h>
  12 #include <errno.h>
  13 #include <log.h>
  14 #include <malloc.h>
  15 #include <spi.h>
  16 #include <spi_flash.h>
  17
  18 #include "sf_internal.h"
  19
  20 /**
  21  * spi_flash_probe_slave() - Probe for a SPI flash device on a bus
  22  *
  23  * @flashp: Pointer to place to put flash info, which may be NULL if the
  24  * space should be allocated
  25  */
  26 static int spi_flash_probe_slave(struct spi_flash *flash)
  27 {
  28         struct spi_slave *spi = flash->spi;
  29         int ret;
  30
  31         /* Setup spi_slave */
  32         if (!spi) {
  33                 printf("SF: Failed to set up slave\n");
  34                 return -ENODEV;
  35         }
  36
  37         /* Claim spi bus */
  38         ret = spi_claim_bus(spi);
  39         if (ret) {
  40                 debug("SF: Failed to claim SPI bus: %d\n", ret);
  41                 return ret;
  42         }
  43
  44         ret = spi_nor_scan(flash);
  45         if (ret)
  46                 goto err_read_id;
  47
  48 #if CONFIG_IS_ENABLED(SPI_FLASH_MTD)
  49         ret = spi_flash_mtd_register(flash);
  50 #endif
  51
  52 err_read_id:
  53         spi_release_bus(spi);
  54         return ret;
  55 }
  56
  57 #ifndef CONFIG_DM_SPI_FLASH
  58 struct spi_flash *spi_flash_probe(unsigned int busnum, unsigned int cs,
  59                                   unsigned int max_hz, unsigned int spi_mode)
  60 {
  61         struct spi_slave *bus;
  62         struct spi_flash *flash;
  63
  64         bus = spi_setup_slave(busnum, cs, max_hz, spi_mode);
  65         if (!bus)
  66                 return NULL;
  67
  68         /* Allocate space if needed (not used by sf-uclass */
  69         flash = calloc(1, sizeof(*flash));
  70         if (!flash) {
  71                 debug("SF: Failed to allocate spi_flash\n");
  72                 return NULL;
  73         }
  74
  75         flash->spi = bus;
  76         if (spi_flash_probe_slave(flash)) {
  77                 spi_free_slave(bus);
  78                 free(flash);
  79                 return NULL;
  80         }
  81
  82         return flash;
  83 }
  84
  85 void spi_flash_free(struct spi_flash *flash)
  86 {
  87 #if CONFIG_IS_ENABLED(SPI_FLASH_MTD)
  88         spi_flash_mtd_unregister();
  89 #endif
  90         spi_free_slave(flash->spi);
  91         free(flash);
  92 }
  93
  94 #else /* defined CONFIG_DM_SPI_FLASH */
  95
  96 static int spi_flash_std_read(struct udevice *dev, u32 offset, size_t len,
  97                               void *buf)
  98 {
  99         struct spi_flash *flash = dev_get_uclass_priv(dev);
 100         struct mtd_info *mtd = &flash->mtd;
 101         size_t retlen;
 102
 103         return log_ret(mtd->_read(mtd, offset, len, &retlen, buf));
 104 }
 105
 106 static int spi_flash_std_write(struct udevice *dev, u32 offset, size_t len,
 107                                const void *buf)
 108 {
 109         struct spi_flash *flash = dev_get_uclass_priv(dev);
 110         struct mtd_info *mtd = &flash->mtd;
 111         size_t retlen;
 112
 113         return mtd->_write(mtd, offset, len, &retlen, buf);
 114 }
 115
 116 static int spi_flash_std_erase(struct udevice *dev, u32 offset, size_t len)
 117 {
 118         struct spi_flash *flash = dev_get_uclass_priv(dev);
 119         struct mtd_info *mtd = &flash->mtd;
 120         struct erase_info instr;
 121
 122         if (offset % mtd->erasesize || len % mtd->erasesize) {
 123                 printf("SF: Erase offset/length not multiple of erase size\n");
 124                 return -EINVAL;
 125         }
 126
 127         memset(&instr, 0, sizeof(instr));
 128         instr.addr = offset;
 129         instr.len = len;
 130
 131         return mtd->_erase(mtd, &instr);
 132 }
 133
 134 static int spi_flash_std_get_sw_write_prot(struct udevice *dev)
 135 {
 136         struct spi_flash *flash = dev_get_uclass_priv(dev);
 137
 138         return spi_flash_cmd_get_sw_write_prot(flash);
 139 }
 140
 141 int spi_flash_std_probe(struct udevice *dev)
 142 {
 143         struct spi_slave *slave = dev_get_parent_priv(dev);
 144         struct dm_spi_slave_platdata *plat = dev_get_parent_platdata(dev);
 145         struct spi_flash *flash;
 146
 147         flash = dev_get_uclass_priv(dev);
 148         flash->dev = dev;
 149         flash->spi = slave;
 150         debug("%s: slave=%p, cs=%d\n", __func__, slave, plat->cs);
 151         return spi_flash_probe_slave(flash);
 152 }
 153
 154 static int spi_flash_std_remove(struct udevice *dev)
 155 {
 156 #if CONFIG_IS_ENABLED(SPI_FLASH_MTD)
 157         spi_flash_mtd_unregister();
 158 #endif
 159         return 0;
 160 }
 161
 162 static const struct dm_spi_flash_ops spi_flash_std_ops = {
 163         .read = spi_flash_std_read,
 164         .write = spi_flash_std_write,
 165         .erase = spi_flash_std_erase,
 166         .get_sw_write_prot = spi_flash_std_get_sw_write_prot,
 167 };
 168
 169 static const struct udevice_id spi_flash_std_ids[] = {
 170         { .compatible = "jedec,spi-nor" },
 171         { }
 172 };
 173
 174 U_BOOT_DRIVER(spi_flash_std) = {
 175         .name           = "spi_flash_std",
 176         .id             = UCLASS_SPI_FLASH,
 177         .of_match       = spi_flash_std_ids,
 178         .probe          = spi_flash_std_probe,
 179         .remove         = spi_flash_std_remove,
 180         .priv_auto_alloc_size = sizeof(struct spi_flash),
 181         .ops            = &spi_flash_std_ops,
 182 };
 183
 184 #endif /* CONFIG_DM_SPI_FLASH */