drivers/spi/xilinx_spi.c

   1 /*
   2  * Xilinx SPI driver
   3  *
   4  * Supports 8 bit SPI transfers only, with or w/o FIFO
   5  *
   6  * Based on bfin_spi.c, by way of altera_spi.c
   7  * Copyright (c) 2015 Jagan Teki <jteki@openedev.com>
   8  * Copyright (c) 2012 Stephan Linz <linz@li-pro.net>
   9  * Copyright (c) 2010 Graeme Smecher <graeme.smecher@mail.mcgill.ca>
  10  * Copyright (c) 2010 Thomas Chou <thomas@wytron.com.tw>
  11  * Copyright (c) 2005-2008 Analog Devices Inc.
  12  *
  13  * SPDX-License-Identifier:     GPL-2.0+
  14  */
  15
  16 #include <config.h>
  17 #include <common.h>
  18 #include <dm.h>
  19 #include <errno.h>
  20 #include <malloc.h>
  21 #include <spi.h>
  22 #include <asm/io.h>
  23
  24 /*
  25  * [0]: http://www.xilinx.com/support/documentation
  26  *
  27  * Xilinx SPI Register Definitions
  28  * [1]: [0]/ip_documentation/xps_spi.pdf
  29  *      page 8, Register Descriptions
  30  * [2]: [0]/ip_documentation/axi_spi_ds742.pdf
  31  *      page 7, Register Overview Table
  32  */
  33
  34 /* SPI Control Register (spicr), [1] p9, [2] p8 */
  35 #define SPICR_LSB_FIRST         BIT(9)
  36 #define SPICR_MASTER_INHIBIT    BIT(8)
  37 #define SPICR_MANUAL_SS         BIT(7)
  38 #define SPICR_RXFIFO_RESEST     BIT(6)
  39 #define SPICR_TXFIFO_RESEST     BIT(5)
  40 #define SPICR_CPHA              BIT(4)
  41 #define SPICR_CPOL              BIT(3)
  42 #define SPICR_MASTER_MODE       BIT(2)
  43 #define SPICR_SPE               BIT(1)
  44 #define SPICR_LOOP              BIT(0)
  45
  46 /* SPI Status Register (spisr), [1] p11, [2] p10 */
  47 #define SPISR_SLAVE_MODE_SELECT BIT(5)
  48 #define SPISR_MODF              BIT(4)
  49 #define SPISR_TX_FULL           BIT(3)
  50 #define SPISR_TX_EMPTY          BIT(2)
  51 #define SPISR_RX_FULL           BIT(1)
  52 #define SPISR_RX_EMPTY          BIT(0)
  53
  54 /* SPI Data Transmit Register (spidtr), [1] p12, [2] p12 */
  55 #define SPIDTR_8BIT_MASK        GENMASK(7, 0)
  56 #define SPIDTR_16BIT_MASK       GENMASK(15, 0)
  57 #define SPIDTR_32BIT_MASK       GENMASK(31, 0)
  58
  59 /* SPI Data Receive Register (spidrr), [1] p12, [2] p12 */
  60 #define SPIDRR_8BIT_MASK        GENMASK(7, 0)
  61 #define SPIDRR_16BIT_MASK       GENMASK(15, 0)
  62 #define SPIDRR_32BIT_MASK       GENMASK(31, 0)
  63
  64 /* SPI Slave Select Register (spissr), [1] p13, [2] p13 */
  65 #define SPISSR_MASK(cs)         (1 << (cs))
  66 #define SPISSR_ACT(cs)          ~SPISSR_MASK(cs)
  67 #define SPISSR_OFF              ~0UL
  68
  69 /* SPI Software Reset Register (ssr) */
  70 #define SPISSR_RESET_VALUE      0x0a
  71
  72 #define XILSPI_MAX_XFER_BITS    8
  73 #define XILSPI_SPICR_DFLT_ON    (SPICR_MANUAL_SS | SPICR_MASTER_MODE | \
  74                                 SPICR_SPE)
  75 #define XILSPI_SPICR_DFLT_OFF   (SPICR_MASTER_INHIBIT | SPICR_MANUAL_SS)
  76
  77 #ifndef CONFIG_XILINX_SPI_IDLE_VAL
  78 #define CONFIG_XILINX_SPI_IDLE_VAL      GENMASK(7, 0)
  79 #endif
  80
  81 #ifndef CONFIG_SYS_XILINX_SPI_LIST
  82 #define CONFIG_SYS_XILINX_SPI_LIST      { CONFIG_SYS_SPI_BASE }
  83 #endif
  84
  85 /* xilinx spi register set */
  86 struct xilinx_spi_regs {
  87         u32 __space0__[7];
  88         u32 dgier;      /* Device Global Interrupt Enable Register (DGIER) */
  89         u32 ipisr;      /* IP Interrupt Status Register (IPISR) */
  90         u32 __space1__;
  91         u32 ipier;      /* IP Interrupt Enable Register (IPIER) */
  92         u32 __space2__[5];
  93         u32 srr;        /* Softare Reset Register (SRR) */
  94         u32 __space3__[7];
  95         u32 spicr;      /* SPI Control Register (SPICR) */
  96         u32 spisr;      /* SPI Status Register (SPISR) */
  97         u32 spidtr;     /* SPI Data Transmit Register (SPIDTR) */
  98         u32 spidrr;     /* SPI Data Receive Register (SPIDRR) */
  99         u32 spissr;     /* SPI Slave Select Register (SPISSR) */
 100         u32 spitfor;    /* SPI Transmit FIFO Occupancy Register (SPITFOR) */
 101         u32 spirfor;    /* SPI Receive FIFO Occupancy Register (SPIRFOR) */
 102 };
 103
 104 /* xilinx spi priv */
 105 struct xilinx_spi_priv {
 106         struct xilinx_spi_regs *regs;
 107         unsigned int freq;
 108         unsigned int mode;
 109 };
 110
 111 static unsigned long xilinx_spi_base_list[] = CONFIG_SYS_XILINX_SPI_LIST;
 112 static int xilinx_spi_probe(struct udevice *bus)
 113 {
 114         struct xilinx_spi_priv *priv = dev_get_priv(bus);
 115         struct xilinx_spi_regs *regs = priv->regs;
 116
 117         priv->regs = (struct xilinx_spi_regs *)xilinx_spi_base_list[bus->seq];
 118
 119         writel(SPISSR_RESET_VALUE, &regs->srr);
 120
 121         return 0;
 122 }
 123
 124 static void spi_cs_activate(struct udevice *dev, uint cs)
 125 {
 126         struct udevice *bus = dev_get_parent(dev);
 127         struct xilinx_spi_priv *priv = dev_get_priv(bus);
 128         struct xilinx_spi_regs *regs = priv->regs;
 129
 130         writel(SPISSR_ACT(cs), &regs->spissr);
 131 }
 132
 133 static void spi_cs_deactivate(struct udevice *dev)
 134 {
 135         struct udevice *bus = dev_get_parent(dev);
 136         struct xilinx_spi_priv *priv = dev_get_priv(bus);
 137         struct xilinx_spi_regs *regs = priv->regs;
 138
 139         writel(SPISSR_OFF, &regs->spissr);
 140 }
 141
 142 static int xilinx_spi_claim_bus(struct udevice *dev)
 143 {
 144         struct udevice *bus = dev_get_parent(dev);
 145         struct xilinx_spi_priv *priv = dev_get_priv(bus);
 146         struct xilinx_spi_regs *regs = priv->regs;
 147
 148         writel(SPISSR_OFF, &regs->spissr);
 149         writel(XILSPI_SPICR_DFLT_ON, &regs->spicr);
 150
 151         return 0;
 152 }
 153
 154 static int xilinx_spi_release_bus(struct udevice *dev)
 155 {
 156         struct udevice *bus = dev_get_parent(dev);
 157         struct xilinx_spi_priv *priv = dev_get_priv(bus);
 158         struct xilinx_spi_regs *regs = priv->regs;
 159
 160         writel(SPISSR_OFF, &regs->spissr);
 161         writel(XILSPI_SPICR_DFLT_OFF, &regs->spicr);
 162
 163         return 0;
 164 }
 165
 166 static int xilinx_spi_xfer(struct udevice *dev, unsigned int bitlen,
 167                             const void *dout, void *din, unsigned long flags)
 168 {
 169         struct udevice *bus = dev_get_parent(dev);
 170         struct xilinx_spi_priv *priv = dev_get_priv(bus);
 171         struct xilinx_spi_regs *regs = priv->regs;
 172         struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
 173         /* assume spi core configured to do 8 bit transfers */
 174         unsigned int bytes = bitlen / XILSPI_MAX_XFER_BITS;
 175         const unsigned char *txp = dout;
 176         unsigned char *rxp = din;
 177         unsigned rxecount = 17; /* max. 16 elements in FIFO, leftover 1 */
 178         unsigned global_timeout;
 179
 180         debug("spi_xfer: bus:%i cs:%i bitlen:%i bytes:%i flags:%lx\n",
 181               bus->seq, slave_plat->cs, bitlen, bytes, flags);
 182
 183         if (bitlen == 0)
 184                 goto done;
 185
 186         if (bitlen % XILSPI_MAX_XFER_BITS) {
 187                 printf("XILSPI warning: Not a multiple of %d bits\n",
 188                        XILSPI_MAX_XFER_BITS);
 189                 flags |= SPI_XFER_END;
 190                 goto done;
 191         }
 192
 193         /* empty read buffer */
 194         while (rxecount && !(readl(&regs->spisr) & SPISR_RX_EMPTY)) {
 195                 readl(&regs->spidrr);
 196                 rxecount--;
 197         }
 198
 199         if (!rxecount) {
 200                 printf("XILSPI error: Rx buffer not empty\n");
 201                 return -1;
 202         }
 203
 204         if (flags & SPI_XFER_BEGIN)
 205                 spi_cs_activate(dev, slave_plat->cs);
 206
 207         /* at least 1usec or greater, leftover 1 */
 208         global_timeout = priv->freq > XILSPI_MAX_XFER_BITS * 1000000 ? 2 :
 209                         (XILSPI_MAX_XFER_BITS * 1000000 / priv->freq) + 1;
 210
 211         while (bytes--) {
 212                 unsigned timeout = global_timeout;
 213                 /* get Tx element from data out buffer and count up */
 214                 unsigned char d = txp ? *txp++ : CONFIG_XILINX_SPI_IDLE_VAL;
 215                 debug("spi_xfer: tx:%x ", d);
 216
 217                 /* write out and wait for processing (receive data) */
 218                 writel(d & SPIDTR_8BIT_MASK, &regs->spidtr);
 219                 while (timeout && readl(&regs->spisr)
 220                                                 & SPISR_RX_EMPTY) {
 221                         timeout--;
 222                         udelay(1);
 223                 }
 224
 225                 if (!timeout) {
 226                         printf("XILSPI error: Xfer timeout\n");
 227                         return -1;
 228                 }
 229
 230                 /* read Rx element and push into data in buffer */
 231                 d = readl(&regs->spidrr) & SPIDRR_8BIT_MASK;
 232                 if (rxp)
 233                         *rxp++ = d;
 234                 debug("spi_xfer: rx:%x\n", d);
 235         }
 236
 237  done:
 238         if (flags & SPI_XFER_END)
 239                 spi_cs_deactivate(dev);
 240
 241         return 0;
 242 }
 243
 244 static int xilinx_spi_set_speed(struct udevice *bus, uint speed)
 245 {
 246         struct xilinx_spi_priv *priv = dev_get_priv(bus);
 247
 248         priv->freq = speed;
 249
 250         debug("xilinx_spi_set_speed: regs=%p, speed=%d\n", priv->regs,
 251               priv->freq);
 252
 253         return 0;
 254 }
 255
 256 static int xilinx_spi_set_mode(struct udevice *bus, uint mode)
 257 {
 258         struct xilinx_spi_priv *priv = dev_get_priv(bus);
 259         struct xilinx_spi_regs *regs = priv->regs;
 260         uint32_t spicr;
 261
 262         spicr = readl(&regs->spicr);
 263         if (mode & SPI_LSB_FIRST)
 264                 spicr |= SPICR_LSB_FIRST;
 265         if (mode & SPI_CPHA)
 266                 spicr |= SPICR_CPHA;
 267         if (mode & SPI_CPOL)
 268                 spicr |= SPICR_CPOL;
 269         if (mode & SPI_LOOP)
 270                 spicr |= SPICR_LOOP;
 271
 272         writel(spicr, &regs->spicr);
 273         priv->mode = mode;
 274
 275         debug("xilinx_spi_set_mode: regs=%p, mode=%d\n", priv->regs,
 276               priv->mode);
 277
 278         return 0;
 279 }
 280
 281 static const struct dm_spi_ops xilinx_spi_ops = {
 282         .claim_bus      = xilinx_spi_claim_bus,
 283         .release_bus    = xilinx_spi_release_bus,
 284         .xfer           = xilinx_spi_xfer,
 285         .set_speed      = xilinx_spi_set_speed,
 286         .set_mode       = xilinx_spi_set_mode,
 287 };
 288
 289 static const struct udevice_id xilinx_spi_ids[] = {
 290         { .compatible = "xlnx,xilinx-spi" },
 291         { }
 292 };
 293
 294 U_BOOT_DRIVER(xilinx_spi) = {
 295         .name   = "xilinx_spi",
 296         .id     = UCLASS_SPI,
 297         .of_match = xilinx_spi_ids,
 298         .ops    = &xilinx_spi_ops,
 299         .priv_auto_alloc_size = sizeof(struct xilinx_spi_priv),
 300         .probe  = xilinx_spi_probe,
 301 };