sys/arm/broadcom/bcm2835/bcm2835_spi.c

   1 /*-
   2  * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
   3  * Copyright (c) 2013 Luiz Otavio O Souza <loos@freebsd.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  */
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/bus.h>
  34
  35 #include <sys/kernel.h>
  36 #include <sys/module.h>
  37 #include <sys/rman.h>
  38 #include <sys/lock.h>
  39 #include <sys/mutex.h>
  40 #include <sys/sysctl.h>
  41
  42 #include <machine/bus.h>
  43 #include <machine/cpu.h>
  44 #include <machine/cpufunc.h>
  45 #include <machine/resource.h>
  46 #include <machine/fdt.h>
  47 #include <machine/intr.h>
  48
  49 #include <dev/fdt/fdt_common.h>
  50 #include <dev/ofw/ofw_bus.h>
  51 #include <dev/ofw/ofw_bus_subr.h>
  52
  53 #include <dev/spibus/spi.h>
  54 #include <dev/spibus/spibusvar.h>
  55
  56 #include <arm/broadcom/bcm2835/bcm2835_gpio.h>
  57 #include <arm/broadcom/bcm2835/bcm2835_spireg.h>
  58 #include <arm/broadcom/bcm2835/bcm2835_spivar.h>
  59
  60 #include "spibus_if.h"
  61
  62 static struct ofw_compat_data compat_data[] = {
  63         {"broadcom,bcm2835-spi",        1},
  64         {"brcm,bcm2835-spi",            1},
  65         {NULL,                          0}
  66 };
  67
  68 static void bcm_spi_intr(void *);
  69
  70 #ifdef  BCM_SPI_DEBUG
  71 static void
  72 bcm_spi_printr(device_t dev)
  73 {
  74         struct bcm_spi_softc *sc;
  75         uint32_t reg;
  76
  77         sc = device_get_softc(dev);
  78         reg = BCM_SPI_READ(sc, SPI_CS);
  79         device_printf(dev, "CS=%b\n", reg,
  80             "\20\1CS0\2CS1\3CPHA\4CPOL\7CSPOL"
  81             "\10TA\11DMAEN\12INTD\13INTR\14ADCS\15REN\16LEN"
  82             "\21DONE\22RXD\23TXD\24RXR\25RXF\26CSPOL0\27CSPOL1"
  83             "\30CSPOL2\31DMA_LEN\32LEN_LONG");
  84         reg = BCM_SPI_READ(sc, SPI_CLK) & SPI_CLK_MASK;
  85         if (reg % 2)
  86                 reg--;
  87         if (reg == 0)
  88                 reg = 65536;
  89         device_printf(dev, "CLK=%uMhz/%d=%luhz\n",
  90             SPI_CORE_CLK / 1000000, reg, SPI_CORE_CLK / reg);
  91         reg = BCM_SPI_READ(sc, SPI_DLEN) & SPI_DLEN_MASK;
  92         device_printf(dev, "DLEN=%d\n", reg);
  93         reg = BCM_SPI_READ(sc, SPI_LTOH) & SPI_LTOH_MASK;
  94         device_printf(dev, "LTOH=%d\n", reg);
  95         reg = BCM_SPI_READ(sc, SPI_DC);
  96         device_printf(dev, "DC=RPANIC=%#x RDREQ=%#x TPANIC=%#x TDREQ=%#x\n",
  97             (reg & SPI_DC_RPANIC_MASK) >> SPI_DC_RPANIC_SHIFT,
  98             (reg & SPI_DC_RDREQ_MASK) >> SPI_DC_RDREQ_SHIFT,
  99             (reg & SPI_DC_TPANIC_MASK) >> SPI_DC_TPANIC_SHIFT,
 100             (reg & SPI_DC_TDREQ_MASK) >> SPI_DC_TDREQ_SHIFT);
 101 }
 102 #endif
 103
 104 static void
 105 bcm_spi_modifyreg(struct bcm_spi_softc *sc, uint32_t off, uint32_t mask,
 106         uint32_t value)
 107 {
 108         uint32_t reg;
 109
 110         mtx_assert(&sc->sc_mtx, MA_OWNED);
 111         reg = BCM_SPI_READ(sc, off);
 112         reg &= ~mask;
 113         reg |= value;
 114         BCM_SPI_WRITE(sc, off, reg);
 115 }
 116
 117 static int
 118 bcm_spi_clock_proc(SYSCTL_HANDLER_ARGS)
 119 {
 120         struct bcm_spi_softc *sc;
 121         uint32_t clk;
 122         int error;
 123
 124         sc = (struct bcm_spi_softc *)arg1;
 125
 126         BCM_SPI_LOCK(sc);
 127         clk = BCM_SPI_READ(sc, SPI_CLK);
 128         BCM_SPI_UNLOCK(sc);
 129         clk &= 0xffff;
 130         if (clk == 0)
 131                 clk = 65536;
 132         clk = SPI_CORE_CLK / clk;
 133
 134         error = sysctl_handle_int(oidp, &clk, sizeof(clk), req);
 135         if (error != 0 || req->newptr == NULL)
 136                 return (error);
 137
 138         clk = SPI_CORE_CLK / clk;
 139         if (clk <= 1)
 140                 clk = 2;
 141         else if (clk % 2)
 142                 clk--;
 143         if (clk > 0xffff)
 144                 clk = 0;
 145         BCM_SPI_LOCK(sc);
 146         BCM_SPI_WRITE(sc, SPI_CLK, clk);
 147         BCM_SPI_UNLOCK(sc);
 148
 149         return (0);
 150 }
 151
 152 static int
 153 bcm_spi_cs_bit_proc(SYSCTL_HANDLER_ARGS, uint32_t bit)
 154 {
 155         struct bcm_spi_softc *sc;
 156         uint32_t reg;
 157         int error;
 158
 159         sc = (struct bcm_spi_softc *)arg1;
 160         BCM_SPI_LOCK(sc);
 161         reg = BCM_SPI_READ(sc, SPI_CS);
 162         BCM_SPI_UNLOCK(sc);
 163         reg = (reg & bit) ? 1 : 0;
 164
 165         error = sysctl_handle_int(oidp, &reg, sizeof(reg), req);
 166         if (error != 0 || req->newptr == NULL)
 167                 return (error);
 168
 169         if (reg)
 170                 reg = bit;
 171         BCM_SPI_LOCK(sc);
 172         bcm_spi_modifyreg(sc, SPI_CS, bit, reg);
 173         BCM_SPI_UNLOCK(sc);
 174
 175         return (0);
 176 }
 177
 178 static int
 179 bcm_spi_cpol_proc(SYSCTL_HANDLER_ARGS)
 180 {
 181
 182         return (bcm_spi_cs_bit_proc(oidp, arg1, arg2, req, SPI_CS_CPOL));
 183 }
 184
 185 static int
 186 bcm_spi_cpha_proc(SYSCTL_HANDLER_ARGS)
 187 {
 188
 189         return (bcm_spi_cs_bit_proc(oidp, arg1, arg2, req, SPI_CS_CPHA));
 190 }
 191
 192 static int
 193 bcm_spi_cspol0_proc(SYSCTL_HANDLER_ARGS)
 194 {
 195
 196         return (bcm_spi_cs_bit_proc(oidp, arg1, arg2, req, SPI_CS_CSPOL0));
 197 }
 198
 199 static int
 200 bcm_spi_cspol1_proc(SYSCTL_HANDLER_ARGS)
 201 {
 202
 203         return (bcm_spi_cs_bit_proc(oidp, arg1, arg2, req, SPI_CS_CSPOL1));
 204 }
 205
 206 static void
 207 bcm_spi_sysctl_init(struct bcm_spi_softc *sc)
 208 {
 209         struct sysctl_ctx_list *ctx;
 210         struct sysctl_oid *tree_node;
 211         struct sysctl_oid_list *tree;
 212
 213         /*
 214          * Add system sysctl tree/handlers.
 215          */
 216         ctx = device_get_sysctl_ctx(sc->sc_dev);
 217         tree_node = device_get_sysctl_tree(sc->sc_dev);
 218         tree = SYSCTL_CHILDREN(tree_node);
 219         SYSCTL_ADD_PROC(ctx, tree, OID_AUTO, "clock",
 220             CTLFLAG_RW | CTLTYPE_UINT, sc, sizeof(*sc),
 221             bcm_spi_clock_proc, "IU", "SPI BUS clock frequency");
 222         SYSCTL_ADD_PROC(ctx, tree, OID_AUTO, "cpol",
 223             CTLFLAG_RW | CTLTYPE_UINT, sc, sizeof(*sc),
 224             bcm_spi_cpol_proc, "IU", "SPI BUS clock polarity");
 225         SYSCTL_ADD_PROC(ctx, tree, OID_AUTO, "cpha",
 226             CTLFLAG_RW | CTLTYPE_UINT, sc, sizeof(*sc),
 227             bcm_spi_cpha_proc, "IU", "SPI BUS clock phase");
 228         SYSCTL_ADD_PROC(ctx, tree, OID_AUTO, "cspol0",
 229             CTLFLAG_RW | CTLTYPE_UINT, sc, sizeof(*sc),
 230             bcm_spi_cspol0_proc, "IU", "SPI BUS chip select 0 polarity");
 231         SYSCTL_ADD_PROC(ctx, tree, OID_AUTO, "cspol1",
 232             CTLFLAG_RW | CTLTYPE_UINT, sc, sizeof(*sc),
 233             bcm_spi_cspol1_proc, "IU", "SPI BUS chip select 1 polarity");
 234 }
 235
 236 static int
 237 bcm_spi_probe(device_t dev)
 238 {
 239
 240         if (!ofw_bus_status_okay(dev))
 241                 return (ENXIO);
 242
 243         if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
 244                 return (ENXIO);
 245
 246         device_set_desc(dev, "BCM2708/2835 SPI controller");
 247
 248         return (BUS_PROBE_DEFAULT);
 249 }
 250
 251 static int
 252 bcm_spi_attach(device_t dev)
 253 {
 254         struct bcm_spi_softc *sc;
 255         device_t gpio;
 256         int i, rid;
 257
 258         if (device_get_unit(dev) != 0) {
 259                 device_printf(dev, "only one SPI controller supported\n");
 260                 return (ENXIO);
 261         }
 262
 263         sc = device_get_softc(dev);
 264         sc->sc_dev = dev;
 265
 266         /* Configure the GPIO pins to ALT0 function to enable SPI the pins. */
 267         gpio = devclass_get_device(devclass_find("gpio"), 0);
 268         if (!gpio) {
 269                 device_printf(dev, "cannot find gpio0\n");
 270                 return (ENXIO);
 271         }
 272         for (i = 0; i < nitems(bcm_spi_pins); i++)
 273                 bcm_gpio_set_alternate(gpio, bcm_spi_pins[i], BCM_GPIO_ALT0);
 274
 275         rid = 0;
 276         sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 277             RF_ACTIVE);
 278         if (!sc->sc_mem_res) {
 279                 device_printf(dev, "cannot allocate memory window\n");
 280                 return (ENXIO);
 281         }
 282
 283         sc->sc_bst = rman_get_bustag(sc->sc_mem_res);
 284         sc->sc_bsh = rman_get_bushandle(sc->sc_mem_res);
 285
 286         rid = 0;
 287         sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 288             RF_ACTIVE);
 289         if (!sc->sc_irq_res) {
 290                 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
 291                 device_printf(dev, "cannot allocate interrupt\n");
 292                 return (ENXIO);
 293         }
 294
 295         /* Hook up our interrupt handler. */
 296         if (bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
 297             NULL, bcm_spi_intr, sc, &sc->sc_intrhand)) {
 298                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
 299                 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
 300                 device_printf(dev, "cannot setup the interrupt handler\n");
 301                 return (ENXIO);
 302         }
 303
 304         mtx_init(&sc->sc_mtx, "bcm_spi", NULL, MTX_DEF);
 305
 306         /* Add sysctl nodes. */
 307         bcm_spi_sysctl_init(sc);
 308
 309 #ifdef  BCM_SPI_DEBUG
 310         bcm_spi_printr(dev);
 311 #endif
 312
 313         /*
 314          * Enable the SPI controller.  Clear the rx and tx FIFO.
 315          * Defaults to SPI mode 0.
 316          */
 317         BCM_SPI_WRITE(sc, SPI_CS, SPI_CS_CLEAR_RXFIFO | SPI_CS_CLEAR_TXFIFO);
 318
 319         /* Set the SPI clock to 500Khz. */
 320         BCM_SPI_WRITE(sc, SPI_CLK, SPI_CORE_CLK / 500000);
 321
 322 #ifdef  BCM_SPI_DEBUG
 323         bcm_spi_printr(dev);
 324 #endif
 325
 326         device_add_child(dev, "spibus", -1);
 327
 328         return (bus_generic_attach(dev));
 329 }
 330
 331 static int
 332 bcm_spi_detach(device_t dev)
 333 {
 334         struct bcm_spi_softc *sc;
 335
 336         bus_generic_detach(dev);
 337
 338         sc = device_get_softc(dev);
 339         mtx_destroy(&sc->sc_mtx);
 340         if (sc->sc_intrhand)
 341                 bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intrhand);
 342         if (sc->sc_irq_res)
 343                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
 344         if (sc->sc_mem_res)
 345                 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
 346
 347         return (0);
 348 }
 349
 350 static void
 351 bcm_spi_fill_fifo(struct bcm_spi_softc *sc)
 352 {
 353         struct spi_command *cmd;
 354         uint32_t cs, written;
 355         uint8_t *data;
 356
 357         cmd = sc->sc_cmd;
 358         cs = BCM_SPI_READ(sc, SPI_CS) & (SPI_CS_TA | SPI_CS_TXD);
 359         while (sc->sc_written < sc->sc_len &&
 360             cs == (SPI_CS_TA | SPI_CS_TXD)) {
 361                 data = (uint8_t *)cmd->tx_cmd;
 362                 written = sc->sc_written++;
 363                 if (written >= cmd->tx_cmd_sz) {
 364                         data = (uint8_t *)cmd->tx_data;
 365                         written -= cmd->tx_cmd_sz;
 366                 }
 367                 BCM_SPI_WRITE(sc, SPI_FIFO, data[written]);
 368                 cs = BCM_SPI_READ(sc, SPI_CS) & (SPI_CS_TA | SPI_CS_TXD);
 369         }
 370 }
 371
 372 static void
 373 bcm_spi_drain_fifo(struct bcm_spi_softc *sc)
 374 {
 375         struct spi_command *cmd;
 376         uint32_t cs, read;
 377         uint8_t *data;
 378
 379         cmd = sc->sc_cmd;
 380         cs = BCM_SPI_READ(sc, SPI_CS) & SPI_CS_RXD;
 381         while (sc->sc_read < sc->sc_len && cs == SPI_CS_RXD) {
 382                 data = (uint8_t *)cmd->rx_cmd;
 383                 read = sc->sc_read++;
 384                 if (read >= cmd->rx_cmd_sz) {
 385                         data = (uint8_t *)cmd->rx_data;
 386                         read -= cmd->rx_cmd_sz;
 387                 }
 388                 data[read] = BCM_SPI_READ(sc, SPI_FIFO) & 0xff;
 389                 cs = BCM_SPI_READ(sc, SPI_CS) & SPI_CS_RXD;
 390         }
 391 }
 392
 393 static void
 394 bcm_spi_intr(void *arg)
 395 {
 396         struct bcm_spi_softc *sc;
 397
 398         sc = (struct bcm_spi_softc *)arg;
 399         BCM_SPI_LOCK(sc);
 400
 401         /* Filter stray interrupts. */
 402         if ((sc->sc_flags & BCM_SPI_BUSY) == 0) {
 403                 BCM_SPI_UNLOCK(sc);
 404                 return;
 405         }
 406
 407         /* TX - Fill up the FIFO. */
 408         bcm_spi_fill_fifo(sc);
 409
 410         /* RX - Drain the FIFO. */
 411         bcm_spi_drain_fifo(sc);
 412
 413         /* Check for end of transfer. */
 414         if (sc->sc_written == sc->sc_len && sc->sc_read == sc->sc_len) {
 415                 /* Disable interrupts and the SPI engine. */
 416                 bcm_spi_modifyreg(sc, SPI_CS,
 417                     SPI_CS_TA | SPI_CS_INTR | SPI_CS_INTD, 0);
 418                 wakeup(sc->sc_dev);
 419         }
 420
 421         BCM_SPI_UNLOCK(sc);
 422 }
 423
 424 static int
 425 bcm_spi_transfer(device_t dev, device_t child, struct spi_command *cmd)
 426 {
 427         struct bcm_spi_softc *sc;
 428         int cs, err;
 429
 430         sc = device_get_softc(dev);
 431
 432         KASSERT(cmd->tx_cmd_sz == cmd->rx_cmd_sz,
 433             ("TX/RX command sizes should be equal"));
 434         KASSERT(cmd->tx_data_sz == cmd->rx_data_sz,
 435             ("TX/RX data sizes should be equal"));
 436
 437         /* Get the proper chip select for this child. */
 438         spibus_get_cs(child, &cs);
 439         if (cs < 0 || cs > 2) {
 440                 device_printf(dev,
 441                     "Invalid chip select %d requested by %s\n", cs,
 442                     device_get_nameunit(child));
 443                 return (EINVAL);
 444         }
 445
 446         BCM_SPI_LOCK(sc);
 447
 448         /* If the controller is in use wait until it is available. */
 449         while (sc->sc_flags & BCM_SPI_BUSY)
 450                 mtx_sleep(dev, &sc->sc_mtx, 0, "bcm_spi", 0);
 451
 452         /* Now we have control over SPI controller. */
 453         sc->sc_flags = BCM_SPI_BUSY;
 454
 455         /* Clear the FIFO. */
 456         bcm_spi_modifyreg(sc, SPI_CS,
 457             SPI_CS_CLEAR_RXFIFO | SPI_CS_CLEAR_TXFIFO,
 458             SPI_CS_CLEAR_RXFIFO | SPI_CS_CLEAR_TXFIFO);
 459
 460         /* Save a pointer to the SPI command. */
 461         sc->sc_cmd = cmd;
 462         sc->sc_read = 0;
 463         sc->sc_written = 0;
 464         sc->sc_len = cmd->tx_cmd_sz + cmd->tx_data_sz;
 465
 466         /*
 467          * Set the CS for this transaction, enable interrupts and announce
 468          * we're ready to tx.  This will kick off the first interrupt.
 469          */
 470         bcm_spi_modifyreg(sc, SPI_CS,
 471             SPI_CS_MASK | SPI_CS_TA | SPI_CS_INTR | SPI_CS_INTD,
 472             cs | SPI_CS_TA | SPI_CS_INTR | SPI_CS_INTD);
 473
 474         /* Wait for the transaction to complete. */
 475         err = mtx_sleep(dev, &sc->sc_mtx, 0, "bcm_spi", hz * 2);
 476
 477         /* Make sure the SPI engine and interrupts are disabled. */
 478         bcm_spi_modifyreg(sc, SPI_CS, SPI_CS_TA | SPI_CS_INTR | SPI_CS_INTD, 0);
 479
 480         /* Release the controller and wakeup the next thread waiting for it. */
 481         sc->sc_flags = 0;
 482         wakeup_one(dev);
 483         BCM_SPI_UNLOCK(sc);
 484
 485         /*
 486          * Check for transfer timeout.  The SPI controller doesn't
 487          * return errors.
 488          */
 489         if (err == EWOULDBLOCK) {
 490                 device_printf(sc->sc_dev, "SPI error\n");
 491                 err = EIO;
 492         }
 493
 494         return (err);
 495 }
 496
 497 static phandle_t
 498 bcm_spi_get_node(device_t bus, device_t dev)
 499 {
 500
 501         /* We only have one child, the SPI bus, which needs our own node. */
 502         return (ofw_bus_get_node(bus));
 503 }
 504
 505 static device_method_t bcm_spi_methods[] = {
 506         /* Device interface */
 507         DEVMETHOD(device_probe,         bcm_spi_probe),
 508         DEVMETHOD(device_attach,        bcm_spi_attach),
 509         DEVMETHOD(device_detach,        bcm_spi_detach),
 510
 511         /* SPI interface */
 512         DEVMETHOD(spibus_transfer,      bcm_spi_transfer),
 513
 514         /* ofw_bus interface */
 515         DEVMETHOD(ofw_bus_get_node,     bcm_spi_get_node),
 516
 517         DEVMETHOD_END
 518 };
 519
 520 static devclass_t bcm_spi_devclass;
 521
 522 static driver_t bcm_spi_driver = {
 523         "spi",
 524         bcm_spi_methods,
 525         sizeof(struct bcm_spi_softc),
 526 };
 527
 528 DRIVER_MODULE(bcm2835_spi, simplebus, bcm_spi_driver, bcm_spi_devclass, 0, 0);