drivers/spi/kirkwood_spi.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2009
   4  * Marvell Semiconductor <www.marvell.com>
   5  * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
   6  *
   7  * Derived from drivers/spi/mpc8xxx_spi.c
   8  */
   9
  10 #include <common.h>
  11 #include <dm.h>
  12 #include <log.h>
  13 #include <malloc.h>
  14 #include <spi.h>
  15 #include <asm/io.h>
  16 #include <asm/arch/soc.h>
  17 #ifdef CONFIG_ARCH_KIRKWOOD
  18 #include <asm/arch/mpp.h>
  19 #endif
  20 #include <asm/arch-mvebu/spi.h>
  21
  22 struct mvebu_spi_dev {
  23         bool                    is_errata_50mhz_ac;
  24 };
  25
  26 struct mvebu_spi_plat {
  27         struct kwspi_registers *spireg;
  28         bool is_errata_50mhz_ac;
  29 };
  30
  31 struct mvebu_spi_priv {
  32         struct kwspi_registers *spireg;
  33 };
  34
  35 static void _spi_cs_activate(struct kwspi_registers *reg)
  36 {
  37         setbits_le32(&reg->ctrl, KWSPI_CSN_ACT);
  38 }
  39
  40 static void _spi_cs_deactivate(struct kwspi_registers *reg)
  41 {
  42         clrbits_le32(&reg->ctrl, KWSPI_CSN_ACT);
  43 }
  44
  45 static int _spi_xfer(struct kwspi_registers *reg, unsigned int bitlen,
  46                      const void *dout, void *din, unsigned long flags)
  47 {
  48         unsigned int tmpdout, tmpdin;
  49         int tm, isread = 0;
  50
  51         debug("spi_xfer: dout %p din %p bitlen %u\n", dout, din, bitlen);
  52
  53         if (flags & SPI_XFER_BEGIN)
  54                 _spi_cs_activate(reg);
  55
  56         /*
  57          * handle data in 8-bit chunks
  58          * TBD: 2byte xfer mode to be enabled
  59          */
  60         clrsetbits_le32(&reg->cfg, KWSPI_XFERLEN_MASK, KWSPI_XFERLEN_1BYTE);
  61
  62         while (bitlen > 4) {
  63                 debug("loopstart bitlen %d\n", bitlen);
  64                 tmpdout = 0;
  65
  66                 /* Shift data so it's msb-justified */
  67                 if (dout)
  68                         tmpdout = *(u32 *)dout & 0xff;
  69
  70                 clrbits_le32(&reg->irq_cause, KWSPI_SMEMRDIRQ);
  71                 writel(tmpdout, &reg->dout);    /* Write the data out */
  72                 debug("*** spi_xfer: ... %08x written, bitlen %d\n",
  73                       tmpdout, bitlen);
  74
  75                 /*
  76                  * Wait for SPI transmit to get out
  77                  * or time out (1 second = 1000 ms)
  78                  * The NE event must be read and cleared first
  79                  */
  80                 for (tm = 0, isread = 0; tm < KWSPI_TIMEOUT; ++tm) {
  81                         if (readl(&reg->irq_cause) & KWSPI_SMEMRDIRQ) {
  82                                 isread = 1;
  83                                 tmpdin = readl(&reg->din);
  84                                 debug("spi_xfer: din %p..%08x read\n",
  85                                       din, tmpdin);
  86
  87                                 if (din) {
  88                                         *((u8 *)din) = (u8)tmpdin;
  89                                         din += 1;
  90                                 }
  91                                 if (dout)
  92                                         dout += 1;
  93                                 bitlen -= 8;
  94                         }
  95                         if (isread)
  96                                 break;
  97                 }
  98                 if (tm >= KWSPI_TIMEOUT)
  99                         printf("*** spi_xfer: Time out during SPI transfer\n");
 100
 101                 debug("loopend bitlen %d\n", bitlen);
 102         }
 103
 104         if (flags & SPI_XFER_END)
 105                 _spi_cs_deactivate(reg);
 106
 107         return 0;
 108 }
 109
 110 static int mvebu_spi_set_speed(struct udevice *bus, uint hz)
 111 {
 112         struct mvebu_spi_plat *plat = dev_get_plat(bus);
 113         struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
 114         struct kwspi_registers *reg = plat->spireg;
 115         u32 data, divider;
 116         unsigned int spr, sppr;
 117
 118         if (spi->max_hz && (hz > spi->max_hz)) {
 119                 debug("%s: limit speed to the max_hz of the bus %d\n",
 120                       __func__, spi->max_hz);
 121                 hz = spi->max_hz;
 122         }
 123
 124         /*
 125          * Calculate spi clock prescaller using max_hz.
 126          * SPPR is SPI Baud Rate Pre-selection, it holds bits 5 and 7:6 in
 127          * SPI Interface Configuration Register;
 128          * SPR is SPI Baud Rate Selection, it holds bits 3:0 in SPI Interface
 129          * Configuration Register.
 130          * The SPR together with the SPPR define the SPI CLK frequency as
 131          * follows:
 132          * SPI actual frequency = core_clk / (SPR * (2 ^ SPPR))
 133          */
 134         divider = DIV_ROUND_UP(CFG_SYS_TCLK, hz);
 135         if (divider < 16) {
 136                 /* This is the easy case, divider is less than 16 */
 137                 spr = divider;
 138                 sppr = 0;
 139
 140         } else {
 141                 unsigned int two_pow_sppr;
 142                 /*
 143                  * Find the highest bit set in divider. This and the
 144                  * three next bits define SPR (apart from rounding).
 145                  * SPPR is then the number of zero bits that must be
 146                  * appended:
 147                  */
 148                 sppr = fls(divider) - 4;
 149
 150                 /*
 151                  * As SPR only has 4 bits, we have to round divider up
 152                  * to the next multiple of 2 ** sppr.
 153                  */
 154                 two_pow_sppr = 1 << sppr;
 155                 divider = (divider + two_pow_sppr - 1) & -two_pow_sppr;
 156
 157                 /*
 158                  * recalculate sppr as rounding up divider might have
 159                  * increased it enough to change the position of the
 160                  * highest set bit. In this case the bit that now
 161                  * doesn't make it into SPR is 0, so there is no need to
 162                  * round again.
 163                  */
 164                 sppr = fls(divider) - 4;
 165                 spr = divider >> sppr;
 166
 167                 /*
 168                  * Now do range checking. SPR is constructed to have a
 169                  * width of 4 bits, so this is fine for sure. So we
 170                  * still need to check for sppr to fit into 3 bits:
 171                  */
 172                 if (sppr > 7)
 173                         return -EINVAL;
 174         }
 175
 176         data = ((sppr & 0x6) << 5) | ((sppr & 0x1) << 4) | spr;
 177
 178         /* program spi clock prescaler using max_hz */
 179         writel(KWSPI_ADRLEN_3BYTE | data, &reg->cfg);
 180         debug("data = 0x%08x\n", data);
 181
 182         return 0;
 183 }
 184
 185 static void mvebu_spi_50mhz_ac_timing_erratum(struct udevice *bus, uint mode)
 186 {
 187         struct mvebu_spi_plat *plat = dev_get_plat(bus);
 188         struct kwspi_registers *reg = plat->spireg;
 189         u32 data;
 190
 191         /*
 192          * Erratum description: (Erratum NO. FE-9144572) The device
 193          * SPI interface supports frequencies of up to 50 MHz.
 194          * However, due to this erratum, when the device core clock is
 195          * 250 MHz and the SPI interfaces is configured for 50MHz SPI
 196          * clock and CPOL=CPHA=1 there might occur data corruption on
 197          * reads from the SPI device.
 198          * Erratum Workaround:
 199          * Work in one of the following configurations:
 200          * 1. Set CPOL=CPHA=0 in "SPI Interface Configuration
 201          * Register".
 202          * 2. Set TMISO_SAMPLE value to 0x2 in "SPI Timing Parameters 1
 203          * Register" before setting the interface.
 204          */
 205         data = readl(&reg->timing1);
 206         data &= ~KW_SPI_TMISO_SAMPLE_MASK;
 207
 208         if (CFG_SYS_TCLK == 250000000 &&
 209             mode & SPI_CPOL &&
 210             mode & SPI_CPHA)
 211                 data |= KW_SPI_TMISO_SAMPLE_2;
 212         else
 213                 data |= KW_SPI_TMISO_SAMPLE_1;
 214
 215         writel(data, &reg->timing1);
 216 }
 217
 218 static int mvebu_spi_set_mode(struct udevice *bus, uint mode)
 219 {
 220         struct mvebu_spi_plat *plat = dev_get_plat(bus);
 221         struct kwspi_registers *reg = plat->spireg;
 222         u32 data = readl(&reg->cfg);
 223
 224         data &= ~(KWSPI_CPHA | KWSPI_CPOL | KWSPI_RXLSBF | KWSPI_TXLSBF);
 225
 226         if (mode & SPI_CPHA)
 227                 data |= KWSPI_CPHA;
 228         if (mode & SPI_CPOL)
 229                 data |= KWSPI_CPOL;
 230         if (mode & SPI_LSB_FIRST)
 231                 data |= (KWSPI_RXLSBF | KWSPI_TXLSBF);
 232
 233         writel(data, &reg->cfg);
 234
 235         if (plat->is_errata_50mhz_ac)
 236                 mvebu_spi_50mhz_ac_timing_erratum(bus, mode);
 237
 238         return 0;
 239 }
 240
 241 static int mvebu_spi_xfer(struct udevice *dev, unsigned int bitlen,
 242                           const void *dout, void *din, unsigned long flags)
 243 {
 244         struct udevice *bus = dev->parent;
 245         struct mvebu_spi_plat *plat = dev_get_plat(bus);
 246
 247         return _spi_xfer(plat->spireg, bitlen, dout, din, flags);
 248 }
 249
 250 __attribute__((weak)) int mvebu_board_spi_claim_bus(struct udevice *dev)
 251 {
 252         return 0;
 253 }
 254
 255 static int mvebu_spi_claim_bus(struct udevice *dev)
 256 {
 257         struct udevice *bus = dev->parent;
 258         struct mvebu_spi_plat *plat = dev_get_plat(bus);
 259
 260         /* Configure the chip-select in the CTRL register */
 261         clrsetbits_le32(&plat->spireg->ctrl,
 262                         KWSPI_CS_MASK << KWSPI_CS_SHIFT,
 263                         spi_chip_select(dev) << KWSPI_CS_SHIFT);
 264
 265         return mvebu_board_spi_claim_bus(dev);
 266 }
 267
 268 __attribute__((weak)) int mvebu_board_spi_release_bus(struct udevice *dev)
 269 {
 270         return 0;
 271 }
 272
 273 static int mvebu_spi_release_bus(struct udevice *dev)
 274 {
 275         return mvebu_board_spi_release_bus(dev);
 276 }
 277
 278 static int mvebu_spi_probe(struct udevice *bus)
 279 {
 280         struct mvebu_spi_plat *plat = dev_get_plat(bus);
 281         struct kwspi_registers *reg = plat->spireg;
 282
 283         writel(KWSPI_SMEMRDY, &reg->ctrl);
 284         writel(KWSPI_SMEMRDIRQ, &reg->irq_cause);
 285         writel(KWSPI_IRQMASK, &reg->irq_mask);
 286
 287         return 0;
 288 }
 289
 290 static int mvebu_spi_of_to_plat(struct udevice *bus)
 291 {
 292         struct mvebu_spi_plat *plat = dev_get_plat(bus);
 293         const struct mvebu_spi_dev *drvdata =
 294                 (struct mvebu_spi_dev *)dev_get_driver_data(bus);
 295
 296         plat->spireg = dev_read_addr_ptr(bus);
 297         plat->is_errata_50mhz_ac = drvdata->is_errata_50mhz_ac;
 298
 299         return 0;
 300 }
 301
 302 static const struct dm_spi_ops mvebu_spi_ops = {
 303         .claim_bus      = mvebu_spi_claim_bus,
 304         .release_bus    = mvebu_spi_release_bus,
 305         .xfer           = mvebu_spi_xfer,
 306         .set_speed      = mvebu_spi_set_speed,
 307         .set_mode       = mvebu_spi_set_mode,
 308         /*
 309          * cs_info is not needed, since we require all chip selects to be
 310          * in the device tree explicitly
 311          */
 312 };
 313
 314 static const struct mvebu_spi_dev armada_spi_dev_data = {
 315         .is_errata_50mhz_ac = false,
 316 };
 317
 318 static const struct mvebu_spi_dev armada_xp_spi_dev_data = {
 319         .is_errata_50mhz_ac = false,
 320 };
 321
 322 static const struct mvebu_spi_dev armada_375_spi_dev_data = {
 323         .is_errata_50mhz_ac = false,
 324 };
 325
 326 static const struct mvebu_spi_dev armada_380_spi_dev_data = {
 327         .is_errata_50mhz_ac = true,
 328 };
 329
 330 static const struct udevice_id mvebu_spi_ids[] = {
 331         {
 332                 .compatible = "marvell,orion-spi",
 333                 .data = (ulong)&armada_spi_dev_data,
 334         },
 335         {
 336                 .compatible = "marvell,armada-375-spi",
 337                 .data = (ulong)&armada_375_spi_dev_data
 338         },
 339         {
 340                 .compatible = "marvell,armada-380-spi",
 341                 .data = (ulong)&armada_380_spi_dev_data
 342         },
 343         {
 344                 .compatible = "marvell,armada-xp-spi",
 345                 .data = (ulong)&armada_xp_spi_dev_data
 346         },
 347         { }
 348 };
 349
 350 U_BOOT_DRIVER(mvebu_spi) = {
 351         .name = "mvebu_spi",
 352         .id = UCLASS_SPI,
 353         .of_match = mvebu_spi_ids,
 354         .ops = &mvebu_spi_ops,
 355         .of_to_plat = mvebu_spi_of_to_plat,
 356         .plat_auto      = sizeof(struct mvebu_spi_plat),
 357         .priv_auto      = sizeof(struct mvebu_spi_priv),
 358         .probe = mvebu_spi_probe,
 359 };