drivers/spi/soft_spi.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2014 Google, Inc
   4  *
   5  * (C) Copyright 2002
   6  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
   7  *
   8  * Influenced by code from:
   9  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  10  */
  11
  12 #include <common.h>
  13 #include <dm.h>
  14 #include <errno.h>
  15 #include <fdtdec.h>
  16 #include <log.h>
  17 #include <malloc.h>
  18 #include <spi.h>
  19 #include <asm/gpio.h>
  20 #include <linux/bitops.h>
  21 #include <linux/delay.h>
  22
  23 DECLARE_GLOBAL_DATA_PTR;
  24
  25 struct soft_spi_platdata {
  26         struct gpio_desc cs;
  27         struct gpio_desc sclk;
  28         struct gpio_desc mosi;
  29         struct gpio_desc miso;
  30         int spi_delay_us;
  31         int flags;
  32 };
  33
  34 #define SPI_MASTER_NO_RX        BIT(0)
  35 #define SPI_MASTER_NO_TX        BIT(1)
  36
  37 struct soft_spi_priv {
  38         unsigned int mode;
  39 };
  40
  41 static int soft_spi_scl(struct udevice *dev, int bit)
  42 {
  43         struct udevice *bus = dev_get_parent(dev);
  44         struct soft_spi_platdata *plat = dev_get_platdata(bus);
  45
  46         dm_gpio_set_value(&plat->sclk, bit);
  47
  48         return 0;
  49 }
  50
  51 static int soft_spi_sda(struct udevice *dev, int bit)
  52 {
  53         struct udevice *bus = dev_get_parent(dev);
  54         struct soft_spi_platdata *plat = dev_get_platdata(bus);
  55
  56         dm_gpio_set_value(&plat->mosi, bit);
  57
  58         return 0;
  59 }
  60
  61 static int soft_spi_cs_activate(struct udevice *dev)
  62 {
  63         struct udevice *bus = dev_get_parent(dev);
  64         struct soft_spi_platdata *plat = dev_get_platdata(bus);
  65
  66         dm_gpio_set_value(&plat->cs, 0);
  67         dm_gpio_set_value(&plat->sclk, 0);
  68         dm_gpio_set_value(&plat->cs, 1);
  69
  70         return 0;
  71 }
  72
  73 static int soft_spi_cs_deactivate(struct udevice *dev)
  74 {
  75         struct udevice *bus = dev_get_parent(dev);
  76         struct soft_spi_platdata *plat = dev_get_platdata(bus);
  77
  78         dm_gpio_set_value(&plat->cs, 0);
  79
  80         return 0;
  81 }
  82
  83 static int soft_spi_claim_bus(struct udevice *dev)
  84 {
  85         /*
  86          * Make sure the SPI clock is in idle state as defined for
  87          * this slave.
  88          */
  89         return soft_spi_scl(dev, 0);
  90 }
  91
  92 static int soft_spi_release_bus(struct udevice *dev)
  93 {
  94         /* Nothing to do */
  95         return 0;
  96 }
  97
  98 /*-----------------------------------------------------------------------
  99  * SPI transfer
 100  *
 101  * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks
 102  * "bitlen" bits in the SPI MISO port.  That's just the way SPI works.
 103  *
 104  * The source of the outgoing bits is the "dout" parameter and the
 105  * destination of the input bits is the "din" parameter.  Note that "dout"
 106  * and "din" can point to the same memory location, in which case the
 107  * input data overwrites the output data (since both are buffered by
 108  * temporary variables, this is OK).
 109  */
 110 static int soft_spi_xfer(struct udevice *dev, unsigned int bitlen,
 111                          const void *dout, void *din, unsigned long flags)
 112 {
 113         struct udevice *bus = dev_get_parent(dev);
 114         struct soft_spi_priv *priv = dev_get_priv(bus);
 115         struct soft_spi_platdata *plat = dev_get_platdata(bus);
 116         uchar           tmpdin  = 0;
 117         uchar           tmpdout = 0;
 118         const u8        *txd = dout;
 119         u8              *rxd = din;
 120         int             cpha = priv->mode & SPI_CPHA;
 121         unsigned int    j;
 122
 123         debug("spi_xfer: slave %s:%s dout %08X din %08X bitlen %u\n",
 124               dev->parent->name, dev->name, *(uint *)txd, *(uint *)rxd,
 125               bitlen);
 126
 127         if (flags & SPI_XFER_BEGIN)
 128                 soft_spi_cs_activate(dev);
 129
 130         for (j = 0; j < bitlen; j++) {
 131                 /*
 132                  * Check if it is time to work on a new byte.
 133                  */
 134                 if ((j % 8) == 0) {
 135                         if (txd)
 136                                 tmpdout = *txd++;
 137                         else
 138                                 tmpdout = 0;
 139                         if (j != 0) {
 140                                 if (rxd)
 141                                         *rxd++ = tmpdin;
 142                         }
 143                         tmpdin  = 0;
 144                 }
 145
 146                 if (!cpha)
 147                         soft_spi_scl(dev, 0);
 148                 if ((plat->flags & SPI_MASTER_NO_TX) == 0)
 149                         soft_spi_sda(dev, !!(tmpdout & 0x80));
 150                 udelay(plat->spi_delay_us);
 151                 if (cpha)
 152                         soft_spi_scl(dev, 0);
 153                 else
 154                         soft_spi_scl(dev, 1);
 155                 tmpdin  <<= 1;
 156                 if ((plat->flags & SPI_MASTER_NO_RX) == 0)
 157                         tmpdin  |= dm_gpio_get_value(&plat->miso);
 158                 tmpdout <<= 1;
 159                 udelay(plat->spi_delay_us);
 160                 if (cpha)
 161                         soft_spi_scl(dev, 1);
 162         }
 163         /*
 164          * If the number of bits isn't a multiple of 8, shift the last
 165          * bits over to left-justify them.  Then store the last byte
 166          * read in.
 167          */
 168         if (rxd) {
 169                 if ((bitlen % 8) != 0)
 170                         tmpdin <<= 8 - (bitlen % 8);
 171                 *rxd++ = tmpdin;
 172         }
 173
 174         if (flags & SPI_XFER_END)
 175                 soft_spi_cs_deactivate(dev);
 176
 177         return 0;
 178 }
 179
 180 static int soft_spi_set_speed(struct udevice *dev, unsigned int speed)
 181 {
 182         /* Accept any speed */
 183         return 0;
 184 }
 185
 186 static int soft_spi_set_mode(struct udevice *dev, unsigned int mode)
 187 {
 188         struct soft_spi_priv *priv = dev_get_priv(dev);
 189
 190         priv->mode = mode;
 191
 192         return 0;
 193 }
 194
 195 static const struct dm_spi_ops soft_spi_ops = {
 196         .claim_bus      = soft_spi_claim_bus,
 197         .release_bus    = soft_spi_release_bus,
 198         .xfer           = soft_spi_xfer,
 199         .set_speed      = soft_spi_set_speed,
 200         .set_mode       = soft_spi_set_mode,
 201 };
 202
 203 static int soft_spi_ofdata_to_platdata(struct udevice *dev)
 204 {
 205         struct soft_spi_platdata *plat = dev->platdata;
 206         const void *blob = gd->fdt_blob;
 207         int node = dev_of_offset(dev);
 208
 209         plat->spi_delay_us = fdtdec_get_int(blob, node, "spi-delay-us", 0);
 210
 211         return 0;
 212 }
 213
 214 static int soft_spi_probe(struct udevice *dev)
 215 {
 216         struct spi_slave *slave = dev_get_parent_priv(dev);
 217         struct soft_spi_platdata *plat = dev->platdata;
 218         int cs_flags, clk_flags;
 219         int ret;
 220
 221         cs_flags = (slave && slave->mode & SPI_CS_HIGH) ? 0 : GPIOD_ACTIVE_LOW;
 222         clk_flags = (slave && slave->mode & SPI_CPOL) ? GPIOD_ACTIVE_LOW : 0;
 223
 224         if (gpio_request_by_name(dev, "cs-gpios", 0, &plat->cs,
 225                                  GPIOD_IS_OUT | cs_flags) ||
 226             gpio_request_by_name(dev, "gpio-sck", 0, &plat->sclk,
 227                                  GPIOD_IS_OUT | clk_flags))
 228                 return -EINVAL;
 229
 230         ret = gpio_request_by_name(dev, "gpio-mosi", 0, &plat->mosi,
 231                                    GPIOD_IS_OUT | GPIOD_IS_OUT_ACTIVE);
 232         if (ret)
 233                 plat->flags |= SPI_MASTER_NO_TX;
 234
 235         ret = gpio_request_by_name(dev, "gpio-miso", 0, &plat->miso,
 236                                    GPIOD_IS_IN);
 237         if (ret)
 238                 plat->flags |= SPI_MASTER_NO_RX;
 239
 240         if ((plat->flags & (SPI_MASTER_NO_RX | SPI_MASTER_NO_TX)) ==
 241             (SPI_MASTER_NO_RX | SPI_MASTER_NO_TX))
 242                 return -EINVAL;
 243
 244         return 0;
 245 }
 246
 247 static const struct udevice_id soft_spi_ids[] = {
 248         { .compatible = "spi-gpio" },
 249         { }
 250 };
 251
 252 U_BOOT_DRIVER(soft_spi) = {
 253         .name   = "soft_spi",
 254         .id     = UCLASS_SPI,
 255         .of_match = soft_spi_ids,
 256         .ops    = &soft_spi_ops,
 257         .ofdata_to_platdata = soft_spi_ofdata_to_platdata,
 258         .platdata_auto_alloc_size = sizeof(struct soft_spi_platdata),
 259         .priv_auto_alloc_size = sizeof(struct soft_spi_priv),
 260         .probe  = soft_spi_probe,
 261 };