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