drivers/spi/spi.c

   1 /*
   2  * SPI init/core code
   3  *
   4  * Copyright (C) 2005 David Brownell
   5  * Copyright (C) 2008 Secret Lab Technologies Ltd.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 #include <linux/kernel.h>
  23 #include <linux/kmod.h>
  24 #include <linux/device.h>
  25 #include <linux/init.h>
  26 #include <linux/cache.h>
  27 #include <linux/dma-mapping.h>
  28 #include <linux/dmaengine.h>
  29 #include <linux/mutex.h>
  30 #include <linux/of_device.h>
  31 #include <linux/of_irq.h>
  32 #include <linux/slab.h>
  33 #include <linux/mod_devicetable.h>
  34 #include <linux/spi/spi.h>
  35 #include <linux/of_gpio.h>
  36 #include <linux/pm_runtime.h>
  37 #include <linux/export.h>
  38 #include <linux/sched/rt.h>
  39 #include <linux/delay.h>
  40 #include <linux/kthread.h>
  41 #include <linux/ioport.h>
  42 #include <linux/acpi.h>
  43
  44 #define CREATE_TRACE_POINTS
  45 #include <trace/events/spi.h>
  46
  47 static void spidev_release(struct device *dev)
  48 {
  49         struct spi_device       *spi = to_spi_device(dev);
  50
  51         /* spi masters may cleanup for released devices */
  52         if (spi->master->cleanup)
  53                 spi->master->cleanup(spi);
  54
  55         spi_master_put(spi->master);
  56         kfree(spi);
  57 }
  58
  59 static ssize_t
  60 modalias_show(struct device *dev, struct device_attribute *a, char *buf)
  61 {
  62         const struct spi_device *spi = to_spi_device(dev);
  63         int len;
  64
  65         len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
  66         if (len != -ENODEV)
  67                 return len;
  68
  69         return sprintf(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
  70 }
  71 static DEVICE_ATTR_RO(modalias);
  72
  73 static struct attribute *spi_dev_attrs[] = {
  74         &dev_attr_modalias.attr,
  75         NULL,
  76 };
  77 ATTRIBUTE_GROUPS(spi_dev);
  78
  79 /* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
  80  * and the sysfs version makes coldplug work too.
  81  */
  82
  83 static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
  84                                                 const struct spi_device *sdev)
  85 {
  86         while (id->name[0]) {
  87                 if (!strcmp(sdev->modalias, id->name))
  88                         return id;
  89                 id++;
  90         }
  91         return NULL;
  92 }
  93
  94 const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
  95 {
  96         const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
  97
  98         return spi_match_id(sdrv->id_table, sdev);
  99 }
 100 EXPORT_SYMBOL_GPL(spi_get_device_id);
 101
 102 static int spi_match_device(struct device *dev, struct device_driver *drv)
 103 {
 104         const struct spi_device *spi = to_spi_device(dev);
 105         const struct spi_driver *sdrv = to_spi_driver(drv);
 106
 107         /* Attempt an OF style match */
 108         if (of_driver_match_device(dev, drv))
 109                 return 1;
 110
 111         /* Then try ACPI */
 112         if (acpi_driver_match_device(dev, drv))
 113                 return 1;
 114
 115         if (sdrv->id_table)
 116                 return !!spi_match_id(sdrv->id_table, spi);
 117
 118         return strcmp(spi->modalias, drv->name) == 0;
 119 }
 120
 121 static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
 122 {
 123         const struct spi_device         *spi = to_spi_device(dev);
 124         int rc;
 125
 126         rc = acpi_device_uevent_modalias(dev, env);
 127         if (rc != -ENODEV)
 128                 return rc;
 129
 130         add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
 131         return 0;
 132 }
 133
 134 #ifdef CONFIG_PM_SLEEP
 135 static int spi_legacy_suspend(struct device *dev, pm_message_t message)
 136 {
 137         int                     value = 0;
 138         struct spi_driver       *drv = to_spi_driver(dev->driver);
 139
 140         /* suspend will stop irqs and dma; no more i/o */
 141         if (drv) {
 142                 if (drv->suspend)
 143                         value = drv->suspend(to_spi_device(dev), message);
 144                 else
 145                         dev_dbg(dev, "... can't suspend\n");
 146         }
 147         return value;
 148 }
 149
 150 static int spi_legacy_resume(struct device *dev)
 151 {
 152         int                     value = 0;
 153         struct spi_driver       *drv = to_spi_driver(dev->driver);
 154
 155         /* resume may restart the i/o queue */
 156         if (drv) {
 157                 if (drv->resume)
 158                         value = drv->resume(to_spi_device(dev));
 159                 else
 160                         dev_dbg(dev, "... can't resume\n");
 161         }
 162         return value;
 163 }
 164
 165 static int spi_pm_suspend(struct device *dev)
 166 {
 167         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 168
 169         if (pm)
 170                 return pm_generic_suspend(dev);
 171         else
 172                 return spi_legacy_suspend(dev, PMSG_SUSPEND);
 173 }
 174
 175 static int spi_pm_resume(struct device *dev)
 176 {
 177         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 178
 179         if (pm)
 180                 return pm_generic_resume(dev);
 181         else
 182                 return spi_legacy_resume(dev);
 183 }
 184
 185 static int spi_pm_freeze(struct device *dev)
 186 {
 187         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 188
 189         if (pm)
 190                 return pm_generic_freeze(dev);
 191         else
 192                 return spi_legacy_suspend(dev, PMSG_FREEZE);
 193 }
 194
 195 static int spi_pm_thaw(struct device *dev)
 196 {
 197         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 198
 199         if (pm)
 200                 return pm_generic_thaw(dev);
 201         else
 202                 return spi_legacy_resume(dev);
 203 }
 204
 205 static int spi_pm_poweroff(struct device *dev)
 206 {
 207         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 208
 209         if (pm)
 210                 return pm_generic_poweroff(dev);
 211         else
 212                 return spi_legacy_suspend(dev, PMSG_HIBERNATE);
 213 }
 214
 215 static int spi_pm_restore(struct device *dev)
 216 {
 217         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 218
 219         if (pm)
 220                 return pm_generic_restore(dev);
 221         else
 222                 return spi_legacy_resume(dev);
 223 }
 224 #else
 225 #define spi_pm_suspend  NULL
 226 #define spi_pm_resume   NULL
 227 #define spi_pm_freeze   NULL
 228 #define spi_pm_thaw     NULL
 229 #define spi_pm_poweroff NULL
 230 #define spi_pm_restore  NULL
 231 #endif
 232
 233 static const struct dev_pm_ops spi_pm = {
 234         .suspend = spi_pm_suspend,
 235         .resume = spi_pm_resume,
 236         .freeze = spi_pm_freeze,
 237         .thaw = spi_pm_thaw,
 238         .poweroff = spi_pm_poweroff,
 239         .restore = spi_pm_restore,
 240         SET_RUNTIME_PM_OPS(
 241                 pm_generic_runtime_suspend,
 242                 pm_generic_runtime_resume,
 243                 NULL
 244         )
 245 };
 246
 247 struct bus_type spi_bus_type = {
 248         .name           = "spi",
 249         .dev_groups     = spi_dev_groups,
 250         .match          = spi_match_device,
 251         .uevent         = spi_uevent,
 252         .pm             = &spi_pm,
 253 };
 254 EXPORT_SYMBOL_GPL(spi_bus_type);
 255
 256
 257 static int spi_drv_probe(struct device *dev)
 258 {
 259         const struct spi_driver         *sdrv = to_spi_driver(dev->driver);
 260         int ret;
 261
 262         acpi_dev_pm_attach(dev, true);
 263         ret = sdrv->probe(to_spi_device(dev));
 264         if (ret)
 265                 acpi_dev_pm_detach(dev, true);
 266
 267         return ret;
 268 }
 269
 270 static int spi_drv_remove(struct device *dev)
 271 {
 272         const struct spi_driver         *sdrv = to_spi_driver(dev->driver);
 273         int ret;
 274
 275         ret = sdrv->remove(to_spi_device(dev));
 276         acpi_dev_pm_detach(dev, true);
 277
 278         return ret;
 279 }
 280
 281 static void spi_drv_shutdown(struct device *dev)
 282 {
 283         const struct spi_driver         *sdrv = to_spi_driver(dev->driver);
 284
 285         sdrv->shutdown(to_spi_device(dev));
 286 }
 287
 288 /**
 289  * spi_register_driver - register a SPI driver
 290  * @sdrv: the driver to register
 291  * Context: can sleep
 292  */
 293 int spi_register_driver(struct spi_driver *sdrv)
 294 {
 295         sdrv->driver.bus = &spi_bus_type;
 296         if (sdrv->probe)
 297                 sdrv->driver.probe = spi_drv_probe;
 298         if (sdrv->remove)
 299                 sdrv->driver.remove = spi_drv_remove;
 300         if (sdrv->shutdown)
 301                 sdrv->driver.shutdown = spi_drv_shutdown;
 302         return driver_register(&sdrv->driver);
 303 }
 304 EXPORT_SYMBOL_GPL(spi_register_driver);
 305
 306 /*-------------------------------------------------------------------------*/
 307
 308 /* SPI devices should normally not be created by SPI device drivers; that
 309  * would make them board-specific.  Similarly with SPI master drivers.
 310  * Device registration normally goes into like arch/.../mach.../board-YYY.c
 311  * with other readonly (flashable) information about mainboard devices.
 312  */
 313
 314 struct boardinfo {
 315         struct list_head        list;
 316         struct spi_board_info   board_info;
 317 };
 318
 319 static LIST_HEAD(board_list);
 320 static LIST_HEAD(spi_master_list);
 321
 322 /*
 323  * Used to protect add/del opertion for board_info list and
 324  * spi_master list, and their matching process
 325  */
 326 static DEFINE_MUTEX(board_lock);
 327
 328 /**
 329  * spi_alloc_device - Allocate a new SPI device
 330  * @master: Controller to which device is connected
 331  * Context: can sleep
 332  *
 333  * Allows a driver to allocate and initialize a spi_device without
 334  * registering it immediately.  This allows a driver to directly
 335  * fill the spi_device with device parameters before calling
 336  * spi_add_device() on it.
 337  *
 338  * Caller is responsible to call spi_add_device() on the returned
 339  * spi_device structure to add it to the SPI master.  If the caller
 340  * needs to discard the spi_device without adding it, then it should
 341  * call spi_dev_put() on it.
 342  *
 343  * Returns a pointer to the new device, or NULL.
 344  */
 345 struct spi_device *spi_alloc_device(struct spi_master *master)
 346 {
 347         struct spi_device       *spi;
 348         struct device           *dev = master->dev.parent;
 349
 350         if (!spi_master_get(master))
 351                 return NULL;
 352
 353         spi = kzalloc(sizeof(*spi), GFP_KERNEL);
 354         if (!spi) {
 355                 dev_err(dev, "cannot alloc spi_device\n");
 356                 spi_master_put(master);
 357                 return NULL;
 358         }
 359
 360         spi->master = master;
 361         spi->dev.parent = &master->dev;
 362         spi->dev.bus = &spi_bus_type;
 363         spi->dev.release = spidev_release;
 364         spi->cs_gpio = -ENOENT;
 365         device_initialize(&spi->dev);
 366         return spi;
 367 }
 368 EXPORT_SYMBOL_GPL(spi_alloc_device);
 369
 370 static void spi_dev_set_name(struct spi_device *spi)
 371 {
 372         struct acpi_device *adev = ACPI_COMPANION(&spi->dev);
 373
 374         if (adev) {
 375                 dev_set_name(&spi->dev, "spi-%s", acpi_dev_name(adev));
 376                 return;
 377         }
 378
 379         dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
 380                      spi->chip_select);
 381 }
 382
 383 static int spi_dev_check(struct device *dev, void *data)
 384 {
 385         struct spi_device *spi = to_spi_device(dev);
 386         struct spi_device *new_spi = data;
 387
 388         if (spi->master == new_spi->master &&
 389             spi->chip_select == new_spi->chip_select)
 390                 return -EBUSY;
 391         return 0;
 392 }
 393
 394 /**
 395  * spi_add_device - Add spi_device allocated with spi_alloc_device
 396  * @spi: spi_device to register
 397  *
 398  * Companion function to spi_alloc_device.  Devices allocated with
 399  * spi_alloc_device can be added onto the spi bus with this function.
 400  *
 401  * Returns 0 on success; negative errno on failure
 402  */
 403 int spi_add_device(struct spi_device *spi)
 404 {
 405         static DEFINE_MUTEX(spi_add_lock);
 406         struct spi_master *master = spi->master;
 407         struct device *dev = master->dev.parent;
 408         int status;
 409
 410         /* Chipselects are numbered 0..max; validate. */
 411         if (spi->chip_select >= master->num_chipselect) {
 412                 dev_err(dev, "cs%d >= max %d\n",
 413                         spi->chip_select,
 414                         master->num_chipselect);
 415                 return -EINVAL;
 416         }
 417
 418         /* Set the bus ID string */
 419         spi_dev_set_name(spi);
 420
 421         /* We need to make sure there's no other device with this
 422          * chipselect **BEFORE** we call setup(), else we'll trash
 423          * its configuration.  Lock against concurrent add() calls.
 424          */
 425         mutex_lock(&spi_add_lock);
 426
 427         status = bus_for_each_dev(&spi_bus_type, NULL, spi, spi_dev_check);
 428         if (status) {
 429                 dev_err(dev, "chipselect %d already in use\n",
 430                                 spi->chip_select);
 431                 goto done;
 432         }
 433
 434         if (master->cs_gpios)
 435                 spi->cs_gpio = master->cs_gpios[spi->chip_select];
 436
 437         /* Drivers may modify this initial i/o setup, but will
 438          * normally rely on the device being setup.  Devices
 439          * using SPI_CS_HIGH can't coexist well otherwise...
 440          */
 441         status = spi_setup(spi);
 442         if (status < 0) {
 443                 dev_err(dev, "can't setup %s, status %d\n",
 444                                 dev_name(&spi->dev), status);
 445                 goto done;
 446         }
 447
 448         /* Device may be bound to an active driver when this returns */
 449         status = device_add(&spi->dev);
 450         if (status < 0)
 451                 dev_err(dev, "can't add %s, status %d\n",
 452                                 dev_name(&spi->dev), status);
 453         else
 454                 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
 455
 456 done:
 457         mutex_unlock(&spi_add_lock);
 458         return status;
 459 }
 460 EXPORT_SYMBOL_GPL(spi_add_device);
 461
 462 /**
 463  * spi_new_device - instantiate one new SPI device
 464  * @master: Controller to which device is connected
 465  * @chip: Describes the SPI device
 466  * Context: can sleep
 467  *
 468  * On typical mainboards, this is purely internal; and it's not needed
 469  * after board init creates the hard-wired devices.  Some development
 470  * platforms may not be able to use spi_register_board_info though, and
 471  * this is exported so that for example a USB or parport based adapter
 472  * driver could add devices (which it would learn about out-of-band).
 473  *
 474  * Returns the new device, or NULL.
 475  */
 476 struct spi_device *spi_new_device(struct spi_master *master,
 477                                   struct spi_board_info *chip)
 478 {
 479         struct spi_device       *proxy;
 480         int                     status;
 481
 482         /* NOTE:  caller did any chip->bus_num checks necessary.
 483          *
 484          * Also, unless we change the return value convention to use
 485          * error-or-pointer (not NULL-or-pointer), troubleshootability
 486          * suggests syslogged diagnostics are best here (ugh).
 487          */
 488
 489         proxy = spi_alloc_device(master);
 490         if (!proxy)
 491                 return NULL;
 492
 493         WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
 494
 495         proxy->chip_select = chip->chip_select;
 496         proxy->max_speed_hz = chip->max_speed_hz;
 497         proxy->mode = chip->mode;
 498         proxy->irq = chip->irq;
 499         strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
 500         proxy->dev.platform_data = (void *) chip->platform_data;
 501         proxy->controller_data = chip->controller_data;
 502         proxy->controller_state = NULL;
 503
 504         status = spi_add_device(proxy);
 505         if (status < 0) {
 506                 spi_dev_put(proxy);
 507                 return NULL;
 508         }
 509
 510         return proxy;
 511 }
 512 EXPORT_SYMBOL_GPL(spi_new_device);
 513
 514 static void spi_match_master_to_boardinfo(struct spi_master *master,
 515                                 struct spi_board_info *bi)
 516 {
 517         struct spi_device *dev;
 518
 519         if (master->bus_num != bi->bus_num)
 520                 return;
 521
 522         dev = spi_new_device(master, bi);
 523         if (!dev)
 524                 dev_err(master->dev.parent, "can't create new device for %s\n",
 525                         bi->modalias);
 526 }
 527
 528 /**
 529  * spi_register_board_info - register SPI devices for a given board
 530  * @info: array of chip descriptors
 531  * @n: how many descriptors are provided
 532  * Context: can sleep
 533  *
 534  * Board-specific early init code calls this (probably during arch_initcall)
 535  * with segments of the SPI device table.  Any device nodes are created later,
 536  * after the relevant parent SPI controller (bus_num) is defined.  We keep
 537  * this table of devices forever, so that reloading a controller driver will
 538  * not make Linux forget about these hard-wired devices.
 539  *
 540  * Other code can also call this, e.g. a particular add-on board might provide
 541  * SPI devices through its expansion connector, so code initializing that board
 542  * would naturally declare its SPI devices.
 543  *
 544  * The board info passed can safely be __initdata ... but be careful of
 545  * any embedded pointers (platform_data, etc), they're copied as-is.
 546  */
 547 int spi_register_board_info(struct spi_board_info const *info, unsigned n)
 548 {
 549         struct boardinfo *bi;
 550         int i;
 551
 552         bi = kzalloc(n * sizeof(*bi), GFP_KERNEL);
 553         if (!bi)
 554                 return -ENOMEM;
 555
 556         for (i = 0; i < n; i++, bi++, info++) {
 557                 struct spi_master *master;
 558
 559                 memcpy(&bi->board_info, info, sizeof(*info));
 560                 mutex_lock(&board_lock);
 561                 list_add_tail(&bi->list, &board_list);
 562                 list_for_each_entry(master, &spi_master_list, list)
 563                         spi_match_master_to_boardinfo(master, &bi->board_info);
 564                 mutex_unlock(&board_lock);
 565         }
 566
 567         return 0;
 568 }
 569
 570 /*-------------------------------------------------------------------------*/
 571
 572 static void spi_set_cs(struct spi_device *spi, bool enable)
 573 {
 574         if (spi->mode & SPI_CS_HIGH)
 575                 enable = !enable;
 576
 577         if (spi->cs_gpio >= 0)
 578                 gpio_set_value(spi->cs_gpio, !enable);
 579         else if (spi->master->set_cs)
 580                 spi->master->set_cs(spi, !enable);
 581 }
 582
 583 static int spi_map_buf(struct spi_master *master, struct device *dev,
 584                        struct sg_table *sgt, void *buf, size_t len,
 585                        enum dma_data_direction dir)
 586 {
 587         const bool vmalloced_buf = is_vmalloc_addr(buf);
 588         const int desc_len = vmalloced_buf ? PAGE_SIZE : master->max_dma_len;
 589         const int sgs = DIV_ROUND_UP(len, desc_len);
 590         struct page *vm_page;
 591         void *sg_buf;
 592         size_t min;
 593         int i, ret;
 594
 595         ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
 596         if (ret != 0)
 597                 return ret;
 598
 599         for (i = 0; i < sgs; i++) {
 600                 min = min_t(size_t, len, desc_len);
 601
 602                 if (vmalloced_buf) {
 603                         vm_page = vmalloc_to_page(buf);
 604                         if (!vm_page) {
 605                                 sg_free_table(sgt);
 606                                 return -ENOMEM;
 607                         }
 608                         sg_buf = page_address(vm_page) +
 609                                 ((size_t)buf & ~PAGE_MASK);
 610                 } else {
 611                         sg_buf = buf;
 612                 }
 613
 614                 sg_set_buf(&sgt->sgl[i], sg_buf, min);
 615
 616                 buf += min;
 617                 len -= min;
 618         }
 619
 620         ret = dma_map_sg(dev, sgt->sgl, sgt->nents, dir);
 621         if (ret < 0) {
 622                 sg_free_table(sgt);
 623                 return ret;
 624         }
 625
 626         sgt->nents = ret;
 627
 628         return 0;
 629 }
 630
 631 static void spi_unmap_buf(struct spi_master *master, struct device *dev,
 632                           struct sg_table *sgt, enum dma_data_direction dir)
 633 {
 634         if (sgt->orig_nents) {
 635                 dma_unmap_sg(dev, sgt->sgl, sgt->orig_nents, dir);
 636                 sg_free_table(sgt);
 637         }
 638 }
 639
 640 static int spi_map_msg(struct spi_master *master, struct spi_message *msg)
 641 {
 642         struct device *tx_dev, *rx_dev;
 643         struct spi_transfer *xfer;
 644         void *tmp;
 645         unsigned int max_tx, max_rx;
 646         int ret;
 647
 648         if (master->flags & (SPI_MASTER_MUST_RX | SPI_MASTER_MUST_TX)) {
 649                 max_tx = 0;
 650                 max_rx = 0;
 651
 652                 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 653                         if ((master->flags & SPI_MASTER_MUST_TX) &&
 654                             !xfer->tx_buf)
 655                                 max_tx = max(xfer->len, max_tx);
 656                         if ((master->flags & SPI_MASTER_MUST_RX) &&
 657                             !xfer->rx_buf)
 658                                 max_rx = max(xfer->len, max_rx);
 659                 }
 660
 661                 if (max_tx) {
 662                         tmp = krealloc(master->dummy_tx, max_tx,
 663                                        GFP_KERNEL | GFP_DMA);
 664                         if (!tmp)
 665                                 return -ENOMEM;
 666                         master->dummy_tx = tmp;
 667                         memset(tmp, 0, max_tx);
 668                 }
 669
 670                 if (max_rx) {
 671                         tmp = krealloc(master->dummy_rx, max_rx,
 672                                        GFP_KERNEL | GFP_DMA);
 673                         if (!tmp)
 674                                 return -ENOMEM;
 675                         master->dummy_rx = tmp;
 676                 }
 677
 678                 if (max_tx || max_rx) {
 679                         list_for_each_entry(xfer, &msg->transfers,
 680                                             transfer_list) {
 681                                 if (!xfer->tx_buf)
 682                                         xfer->tx_buf = master->dummy_tx;
 683                                 if (!xfer->rx_buf)
 684                                         xfer->rx_buf = master->dummy_rx;
 685                         }
 686                 }
 687         }
 688
 689         if (!master->can_dma)
 690                 return 0;
 691
 692         tx_dev = &master->dma_tx->dev->device;
 693         rx_dev = &master->dma_rx->dev->device;
 694
 695         list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 696                 if (!master->can_dma(master, msg->spi, xfer))
 697                         continue;
 698
 699                 if (xfer->tx_buf != NULL) {
 700                         ret = spi_map_buf(master, tx_dev, &xfer->tx_sg,
 701                                           (void *)xfer->tx_buf, xfer->len,
 702                                           DMA_TO_DEVICE);
 703                         if (ret != 0)
 704                                 return ret;
 705                 }
 706
 707                 if (xfer->rx_buf != NULL) {
 708                         ret = spi_map_buf(master, rx_dev, &xfer->rx_sg,
 709                                           xfer->rx_buf, xfer->len,
 710                                           DMA_FROM_DEVICE);
 711                         if (ret != 0) {
 712                                 spi_unmap_buf(master, tx_dev, &xfer->tx_sg,
 713                                               DMA_TO_DEVICE);
 714                                 return ret;
 715                         }
 716                 }
 717         }
 718
 719         master->cur_msg_mapped = true;
 720
 721         return 0;
 722 }
 723
 724 static int spi_unmap_msg(struct spi_master *master, struct spi_message *msg)
 725 {
 726         struct spi_transfer *xfer;
 727         struct device *tx_dev, *rx_dev;
 728
 729         if (!master->cur_msg_mapped || !master->can_dma)
 730                 return 0;
 731
 732         tx_dev = &master->dma_tx->dev->device;
 733         rx_dev = &master->dma_rx->dev->device;
 734
 735         list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 736                 if (!master->can_dma(master, msg->spi, xfer))
 737                         continue;
 738
 739                 spi_unmap_buf(master, rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
 740                 spi_unmap_buf(master, tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
 741         }
 742
 743         return 0;
 744 }
 745
 746 /*
 747  * spi_transfer_one_message - Default implementation of transfer_one_message()
 748  *
 749  * This is a standard implementation of transfer_one_message() for
 750  * drivers which impelment a transfer_one() operation.  It provides
 751  * standard handling of delays and chip select management.
 752  */
 753 static int spi_transfer_one_message(struct spi_master *master,
 754                                     struct spi_message *msg)
 755 {
 756         struct spi_transfer *xfer;
 757         bool keep_cs = false;
 758         int ret = 0;
 759
 760         spi_set_cs(msg->spi, true);
 761
 762         list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 763                 trace_spi_transfer_start(msg, xfer);
 764
 765                 reinit_completion(&master->xfer_completion);
 766
 767                 ret = master->transfer_one(master, msg->spi, xfer);
 768                 if (ret < 0) {
 769                         dev_err(&msg->spi->dev,
 770                                 "SPI transfer failed: %d\n", ret);
 771                         goto out;
 772                 }
 773
 774                 if (ret > 0) {
 775                         ret = 0;
 776                         wait_for_completion(&master->xfer_completion);
 777                 }
 778
 779                 trace_spi_transfer_stop(msg, xfer);
 780
 781                 if (msg->status != -EINPROGRESS)
 782                         goto out;
 783
 784                 if (xfer->delay_usecs)
 785                         udelay(xfer->delay_usecs);
 786
 787                 if (xfer->cs_change) {
 788                         if (list_is_last(&xfer->transfer_list,
 789                                          &msg->transfers)) {
 790                                 keep_cs = true;
 791                         } else {
 792                                 spi_set_cs(msg->spi, false);
 793                                 udelay(10);
 794                                 spi_set_cs(msg->spi, true);
 795                         }
 796                 }
 797
 798                 msg->actual_length += xfer->len;
 799         }
 800
 801 out:
 802         if (ret != 0 || !keep_cs)
 803                 spi_set_cs(msg->spi, false);
 804
 805         if (msg->status == -EINPROGRESS)
 806                 msg->status = ret;
 807
 808         spi_finalize_current_message(master);
 809
 810         return ret;
 811 }
 812
 813 /**
 814  * spi_finalize_current_transfer - report completion of a transfer
 815  *
 816  * Called by SPI drivers using the core transfer_one_message()
 817  * implementation to notify it that the current interrupt driven
 818  * transfer has finished and the next one may be scheduled.
 819  */
 820 void spi_finalize_current_transfer(struct spi_master *master)
 821 {
 822         complete(&master->xfer_completion);
 823 }
 824 EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
 825
 826 /**
 827  * spi_pump_messages - kthread work function which processes spi message queue
 828  * @work: pointer to kthread work struct contained in the master struct
 829  *
 830  * This function checks if there is any spi message in the queue that
 831  * needs processing and if so call out to the driver to initialize hardware
 832  * and transfer each message.
 833  *
 834  */
 835 static void spi_pump_messages(struct kthread_work *work)
 836 {
 837         struct spi_master *master =
 838                 container_of(work, struct spi_master, pump_messages);
 839         unsigned long flags;
 840         bool was_busy = false;
 841         int ret;
 842
 843         /* Lock queue and check for queue work */
 844         spin_lock_irqsave(&master->queue_lock, flags);
 845         if (list_empty(&master->queue) || !master->running) {
 846                 if (!master->busy) {
 847                         spin_unlock_irqrestore(&master->queue_lock, flags);
 848                         return;
 849                 }
 850                 master->busy = false;
 851                 spin_unlock_irqrestore(&master->queue_lock, flags);
 852                 kfree(master->dummy_rx);
 853                 master->dummy_rx = NULL;
 854                 kfree(master->dummy_tx);
 855                 master->dummy_tx = NULL;
 856                 if (master->unprepare_transfer_hardware &&
 857                     master->unprepare_transfer_hardware(master))
 858                         dev_err(&master->dev,
 859                                 "failed to unprepare transfer hardware\n");
 860                 if (master->auto_runtime_pm) {
 861                         pm_runtime_mark_last_busy(master->dev.parent);
 862                         pm_runtime_put_autosuspend(master->dev.parent);
 863                 }
 864                 trace_spi_master_idle(master);
 865                 return;
 866         }
 867
 868         /* Make sure we are not already running a message */
 869         if (master->cur_msg) {
 870                 spin_unlock_irqrestore(&master->queue_lock, flags);
 871                 return;
 872         }
 873         /* Extract head of queue */
 874         master->cur_msg =
 875                 list_first_entry(&master->queue, struct spi_message, queue);
 876
 877         list_del_init(&master->cur_msg->queue);
 878         if (master->busy)
 879                 was_busy = true;
 880         else
 881                 master->busy = true;
 882         spin_unlock_irqrestore(&master->queue_lock, flags);
 883
 884         if (!was_busy && master->auto_runtime_pm) {
 885                 ret = pm_runtime_get_sync(master->dev.parent);
 886                 if (ret < 0) {
 887                         dev_err(&master->dev, "Failed to power device: %d\n",
 888                                 ret);
 889                         return;
 890                 }
 891         }
 892
 893         if (!was_busy)
 894                 trace_spi_master_busy(master);
 895
 896         if (!was_busy && master->prepare_transfer_hardware) {
 897                 ret = master->prepare_transfer_hardware(master);
 898                 if (ret) {
 899                         dev_err(&master->dev,
 900                                 "failed to prepare transfer hardware\n");
 901
 902                         if (master->auto_runtime_pm)
 903                                 pm_runtime_put(master->dev.parent);
 904                         return;
 905                 }
 906         }
 907
 908         trace_spi_message_start(master->cur_msg);
 909
 910         if (master->prepare_message) {
 911                 ret = master->prepare_message(master, master->cur_msg);
 912                 if (ret) {
 913                         dev_err(&master->dev,
 914                                 "failed to prepare message: %d\n", ret);
 915                         master->cur_msg->status = ret;
 916                         spi_finalize_current_message(master);
 917                         return;
 918                 }
 919                 master->cur_msg_prepared = true;
 920         }
 921
 922         ret = spi_map_msg(master, master->cur_msg);
 923         if (ret) {
 924                 master->cur_msg->status = ret;
 925                 spi_finalize_current_message(master);
 926                 return;
 927         }
 928
 929         ret = master->transfer_one_message(master, master->cur_msg);
 930         if (ret) {
 931                 dev_err(&master->dev,
 932                         "failed to transfer one message from queue\n");
 933                 return;
 934         }
 935 }
 936
 937 static int spi_init_queue(struct spi_master *master)
 938 {
 939         struct sched_param param = { .sched_priority = MAX_RT_PRIO - 1 };
 940
 941         INIT_LIST_HEAD(&master->queue);
 942         spin_lock_init(&master->queue_lock);
 943
 944         master->running = false;
 945         master->busy = false;
 946
 947         init_kthread_worker(&master->kworker);
 948         master->kworker_task = kthread_run(kthread_worker_fn,
 949                                            &master->kworker, "%s",
 950                                            dev_name(&master->dev));
 951         if (IS_ERR(master->kworker_task)) {
 952                 dev_err(&master->dev, "failed to create message pump task\n");
 953                 return -ENOMEM;
 954         }
 955         init_kthread_work(&master->pump_messages, spi_pump_messages);
 956
 957         /*
 958          * Master config will indicate if this controller should run the
 959          * message pump with high (realtime) priority to reduce the transfer
 960          * latency on the bus by minimising the delay between a transfer
 961          * request and the scheduling of the message pump thread. Without this
 962          * setting the message pump thread will remain at default priority.
 963          */
 964         if (master->rt) {
 965                 dev_info(&master->dev,
 966                         "will run message pump with realtime priority\n");
 967                 sched_setscheduler(master->kworker_task, SCHED_FIFO, &param);
 968         }
 969
 970         return 0;
 971 }
 972
 973 /**
 974  * spi_get_next_queued_message() - called by driver to check for queued
 975  * messages
 976  * @master: the master to check for queued messages
 977  *
 978  * If there are more messages in the queue, the next message is returned from
 979  * this call.
 980  */
 981 struct spi_message *spi_get_next_queued_message(struct spi_master *master)
 982 {
 983         struct spi_message *next;
 984         unsigned long flags;
 985
 986         /* get a pointer to the next message, if any */
 987         spin_lock_irqsave(&master->queue_lock, flags);
 988         next = list_first_entry_or_null(&master->queue, struct spi_message,
 989                                         queue);
 990         spin_unlock_irqrestore(&master->queue_lock, flags);
 991
 992         return next;
 993 }
 994 EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
 995
 996 /**
 997  * spi_finalize_current_message() - the current message is complete
 998  * @master: the master to return the message to
 999  *
1000  * Called by the driver to notify the core that the message in the front of the
1001  * queue is complete and can be removed from the queue.
1002  */
1003 void spi_finalize_current_message(struct spi_master *master)
1004 {
1005         struct spi_message *mesg;
1006         unsigned long flags;
1007         int ret;
1008
1009         spin_lock_irqsave(&master->queue_lock, flags);
1010         mesg = master->cur_msg;
1011         master->cur_msg = NULL;
1012
1013         queue_kthread_work(&master->kworker, &master->pump_messages);
1014         spin_unlock_irqrestore(&master->queue_lock, flags);
1015
1016         spi_unmap_msg(master, mesg);
1017
1018         if (master->cur_msg_prepared && master->unprepare_message) {
1019                 ret = master->unprepare_message(master, mesg);
1020                 if (ret) {
1021                         dev_err(&master->dev,
1022                                 "failed to unprepare message: %d\n", ret);
1023                 }
1024         }
1025         master->cur_msg_prepared = false;
1026
1027         mesg->state = NULL;
1028         if (mesg->complete)
1029                 mesg->complete(mesg->context);
1030
1031         trace_spi_message_done(mesg);
1032 }
1033 EXPORT_SYMBOL_GPL(spi_finalize_current_message);
1034
1035 static int spi_start_queue(struct spi_master *master)
1036 {
1037         unsigned long flags;
1038
1039         spin_lock_irqsave(&master->queue_lock, flags);
1040
1041         if (master->running || master->busy) {
1042                 spin_unlock_irqrestore(&master->queue_lock, flags);
1043                 return -EBUSY;
1044         }
1045
1046         master->running = true;
1047         master->cur_msg = NULL;
1048         spin_unlock_irqrestore(&master->queue_lock, flags);
1049
1050         queue_kthread_work(&master->kworker, &master->pump_messages);
1051
1052         return 0;
1053 }
1054
1055 static int spi_stop_queue(struct spi_master *master)
1056 {
1057         unsigned long flags;
1058         unsigned limit = 500;
1059         int ret = 0;
1060
1061         spin_lock_irqsave(&master->queue_lock, flags);
1062
1063         /*
1064          * This is a bit lame, but is optimized for the common execution path.
1065          * A wait_queue on the master->busy could be used, but then the common
1066          * execution path (pump_messages) would be required to call wake_up or
1067          * friends on every SPI message. Do this instead.
1068          */
1069         while ((!list_empty(&master->queue) || master->busy) && limit--) {
1070                 spin_unlock_irqrestore(&master->queue_lock, flags);
1071                 usleep_range(10000, 11000);
1072                 spin_lock_irqsave(&master->queue_lock, flags);
1073         }
1074
1075         if (!list_empty(&master->queue) || master->busy)
1076                 ret = -EBUSY;
1077         else
1078                 master->running = false;
1079
1080         spin_unlock_irqrestore(&master->queue_lock, flags);
1081
1082         if (ret) {
1083                 dev_warn(&master->dev,
1084                          "could not stop message queue\n");
1085                 return ret;
1086         }
1087         return ret;
1088 }
1089
1090 static int spi_destroy_queue(struct spi_master *master)
1091 {
1092         int ret;
1093
1094         ret = spi_stop_queue(master);
1095
1096         /*
1097          * flush_kthread_worker will block until all work is done.
1098          * If the reason that stop_queue timed out is that the work will never
1099          * finish, then it does no good to call flush/stop thread, so
1100          * return anyway.
1101          */
1102         if (ret) {
1103                 dev_err(&master->dev, "problem destroying queue\n");
1104                 return ret;
1105         }
1106
1107         flush_kthread_worker(&master->kworker);
1108         kthread_stop(master->kworker_task);
1109
1110         return 0;
1111 }
1112
1113 /**
1114  * spi_queued_transfer - transfer function for queued transfers
1115  * @spi: spi device which is requesting transfer
1116  * @msg: spi message which is to handled is queued to driver queue
1117  */
1118 static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
1119 {
1120         struct spi_master *master = spi->master;
1121         unsigned long flags;
1122
1123         spin_lock_irqsave(&master->queue_lock, flags);
1124
1125         if (!master->running) {
1126                 spin_unlock_irqrestore(&master->queue_lock, flags);
1127                 return -ESHUTDOWN;
1128         }
1129         msg->actual_length = 0;
1130         msg->status = -EINPROGRESS;
1131
1132         list_add_tail(&msg->queue, &master->queue);
1133         if (!master->busy)
1134                 queue_kthread_work(&master->kworker, &master->pump_messages);
1135
1136         spin_unlock_irqrestore(&master->queue_lock, flags);
1137         return 0;
1138 }
1139
1140 static int spi_master_initialize_queue(struct spi_master *master)
1141 {
1142         int ret;
1143
1144         master->queued = true;
1145         master->transfer = spi_queued_transfer;
1146         if (!master->transfer_one_message)
1147                 master->transfer_one_message = spi_transfer_one_message;
1148
1149         /* Initialize and start queue */
1150         ret = spi_init_queue(master);
1151         if (ret) {
1152                 dev_err(&master->dev, "problem initializing queue\n");
1153                 goto err_init_queue;
1154         }
1155         ret = spi_start_queue(master);
1156         if (ret) {
1157                 dev_err(&master->dev, "problem starting queue\n");
1158                 goto err_start_queue;
1159         }
1160
1161         return 0;
1162
1163 err_start_queue:
1164 err_init_queue:
1165         spi_destroy_queue(master);
1166         return ret;
1167 }
1168
1169 /*-------------------------------------------------------------------------*/
1170
1171 #if defined(CONFIG_OF)
1172 /**
1173  * of_register_spi_devices() - Register child devices onto the SPI bus
1174  * @master:     Pointer to spi_master device
1175  *
1176  * Registers an spi_device for each child node of master node which has a 'reg'
1177  * property.
1178  */
1179 static void of_register_spi_devices(struct spi_master *master)
1180 {
1181         struct spi_device *spi;
1182         struct device_node *nc;
1183         int rc;
1184         u32 value;
1185
1186         if (!master->dev.of_node)
1187                 return;
1188
1189         for_each_available_child_of_node(master->dev.of_node, nc) {
1190                 /* Alloc an spi_device */
1191                 spi = spi_alloc_device(master);
1192                 if (!spi) {
1193                         dev_err(&master->dev, "spi_device alloc error for %s\n",
1194                                 nc->full_name);
1195                         spi_dev_put(spi);
1196                         continue;
1197                 }
1198
1199                 /* Select device driver */
1200                 if (of_modalias_node(nc, spi->modalias,
1201                                      sizeof(spi->modalias)) < 0) {
1202                         dev_err(&master->dev, "cannot find modalias for %s\n",
1203                                 nc->full_name);
1204                         spi_dev_put(spi);
1205                         continue;
1206                 }
1207
1208                 /* Device address */
1209                 rc = of_property_read_u32(nc, "reg", &value);
1210                 if (rc) {
1211                         dev_err(&master->dev, "%s has no valid 'reg' property (%d)\n",
1212                                 nc->full_name, rc);
1213                         spi_dev_put(spi);
1214                         continue;
1215                 }
1216                 spi->chip_select = value;
1217
1218                 /* Mode (clock phase/polarity/etc.) */
1219                 if (of_find_property(nc, "spi-cpha", NULL))
1220                         spi->mode |= SPI_CPHA;
1221                 if (of_find_property(nc, "spi-cpol", NULL))
1222                         spi->mode |= SPI_CPOL;
1223                 if (of_find_property(nc, "spi-cs-high", NULL))
1224                         spi->mode |= SPI_CS_HIGH;
1225                 if (of_find_property(nc, "spi-3wire", NULL))
1226                         spi->mode |= SPI_3WIRE;
1227
1228                 /* Device DUAL/QUAD mode */
1229                 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
1230                         switch (value) {
1231                         case 1:
1232                                 break;
1233                         case 2:
1234                                 spi->mode |= SPI_TX_DUAL;
1235                                 break;
1236                         case 4:
1237                                 spi->mode |= SPI_TX_QUAD;
1238                                 break;
1239                         default:
1240                                 dev_err(&master->dev,
1241                                         "spi-tx-bus-width %d not supported\n",
1242                                         value);
1243                                 spi_dev_put(spi);
1244                                 continue;
1245                         }
1246                 }
1247
1248                 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
1249                         switch (value) {
1250                         case 1:
1251                                 break;
1252                         case 2:
1253                                 spi->mode |= SPI_RX_DUAL;
1254                                 break;
1255                         case 4:
1256                                 spi->mode |= SPI_RX_QUAD;
1257                                 break;
1258                         default:
1259                                 dev_err(&master->dev,
1260                                         "spi-rx-bus-width %d not supported\n",
1261                                         value);
1262                                 spi_dev_put(spi);
1263                                 continue;
1264                         }
1265                 }
1266
1267                 /* Device speed */
1268                 rc = of_property_read_u32(nc, "spi-max-frequency", &value);
1269                 if (rc) {
1270                         dev_err(&master->dev, "%s has no valid 'spi-max-frequency' property (%d)\n",
1271                                 nc->full_name, rc);
1272                         spi_dev_put(spi);
1273                         continue;
1274                 }
1275                 spi->max_speed_hz = value;
1276
1277                 /* IRQ */
1278                 spi->irq = irq_of_parse_and_map(nc, 0);
1279
1280                 /* Store a pointer to the node in the device structure */
1281                 of_node_get(nc);
1282                 spi->dev.of_node = nc;
1283
1284                 /* Register the new device */
1285                 request_module("%s%s", SPI_MODULE_PREFIX, spi->modalias);
1286                 rc = spi_add_device(spi);
1287                 if (rc) {
1288                         dev_err(&master->dev, "spi_device register error %s\n",
1289                                 nc->full_name);
1290                         spi_dev_put(spi);
1291                 }
1292
1293         }
1294 }
1295 #else
1296 static void of_register_spi_devices(struct spi_master *master) { }
1297 #endif
1298
1299 #ifdef CONFIG_ACPI
1300 static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
1301 {
1302         struct spi_device *spi = data;
1303
1304         if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
1305                 struct acpi_resource_spi_serialbus *sb;
1306
1307                 sb = &ares->data.spi_serial_bus;
1308                 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
1309                         spi->chip_select = sb->device_selection;
1310                         spi->max_speed_hz = sb->connection_speed;
1311
1312                         if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
1313                                 spi->mode |= SPI_CPHA;
1314                         if (sb->clock_polarity == ACPI_SPI_START_HIGH)
1315                                 spi->mode |= SPI_CPOL;
1316                         if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
1317                                 spi->mode |= SPI_CS_HIGH;
1318                 }
1319         } else if (spi->irq < 0) {
1320                 struct resource r;
1321
1322                 if (acpi_dev_resource_interrupt(ares, 0, &r))
1323                         spi->irq = r.start;
1324         }
1325
1326         /* Always tell the ACPI core to skip this resource */
1327         return 1;
1328 }
1329
1330 static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
1331                                        void *data, void **return_value)
1332 {
1333         struct spi_master *master = data;
1334         struct list_head resource_list;
1335         struct acpi_device *adev;
1336         struct spi_device *spi;
1337         int ret;
1338
1339         if (acpi_bus_get_device(handle, &adev))
1340                 return AE_OK;
1341         if (acpi_bus_get_status(adev) || !adev->status.present)
1342                 return AE_OK;
1343
1344         spi = spi_alloc_device(master);
1345         if (!spi) {
1346                 dev_err(&master->dev, "failed to allocate SPI device for %s\n",
1347                         dev_name(&adev->dev));
1348                 return AE_NO_MEMORY;
1349         }
1350
1351         ACPI_COMPANION_SET(&spi->dev, adev);
1352         spi->irq = -1;
1353
1354         INIT_LIST_HEAD(&resource_list);
1355         ret = acpi_dev_get_resources(adev, &resource_list,
1356                                      acpi_spi_add_resource, spi);
1357         acpi_dev_free_resource_list(&resource_list);
1358
1359         if (ret < 0 || !spi->max_speed_hz) {
1360                 spi_dev_put(spi);
1361                 return AE_OK;
1362         }
1363
1364         adev->power.flags.ignore_parent = true;
1365         strlcpy(spi->modalias, acpi_device_hid(adev), sizeof(spi->modalias));
1366         if (spi_add_device(spi)) {
1367                 adev->power.flags.ignore_parent = false;
1368                 dev_err(&master->dev, "failed to add SPI device %s from ACPI\n",
1369                         dev_name(&adev->dev));
1370                 spi_dev_put(spi);
1371         }
1372
1373         return AE_OK;
1374 }
1375
1376 static void acpi_register_spi_devices(struct spi_master *master)
1377 {
1378         acpi_status status;
1379         acpi_handle handle;
1380
1381         handle = ACPI_HANDLE(master->dev.parent);
1382         if (!handle)
1383                 return;
1384
1385         status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
1386                                      acpi_spi_add_device, NULL,
1387                                      master, NULL);
1388         if (ACPI_FAILURE(status))
1389                 dev_warn(&master->dev, "failed to enumerate SPI slaves\n");
1390 }
1391 #else
1392 static inline void acpi_register_spi_devices(struct spi_master *master) {}
1393 #endif /* CONFIG_ACPI */
1394
1395 static void spi_master_release(struct device *dev)
1396 {
1397         struct spi_master *master;
1398
1399         master = container_of(dev, struct spi_master, dev);
1400         kfree(master);
1401 }
1402
1403 static struct class spi_master_class = {
1404         .name           = "spi_master",
1405         .owner          = THIS_MODULE,
1406         .dev_release    = spi_master_release,
1407 };
1408
1409
1410
1411 /**
1412  * spi_alloc_master - allocate SPI master controller
1413  * @dev: the controller, possibly using the platform_bus
1414  * @size: how much zeroed driver-private data to allocate; the pointer to this
1415  *      memory is in the driver_data field of the returned device,
1416  *      accessible with spi_master_get_devdata().
1417  * Context: can sleep
1418  *
1419  * This call is used only by SPI master controller drivers, which are the
1420  * only ones directly touching chip registers.  It's how they allocate
1421  * an spi_master structure, prior to calling spi_register_master().
1422  *
1423  * This must be called from context that can sleep.  It returns the SPI
1424  * master structure on success, else NULL.
1425  *
1426  * The caller is responsible for assigning the bus number and initializing
1427  * the master's methods before calling spi_register_master(); and (after errors
1428  * adding the device) calling spi_master_put() and kfree() to prevent a memory
1429  * leak.
1430  */
1431 struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
1432 {
1433         struct spi_master       *master;
1434
1435         if (!dev)
1436                 return NULL;
1437
1438         master = kzalloc(size + sizeof(*master), GFP_KERNEL);
1439         if (!master)
1440                 return NULL;
1441
1442         device_initialize(&master->dev);
1443         master->bus_num = -1;
1444         master->num_chipselect = 1;
1445         master->dev.class = &spi_master_class;
1446         master->dev.parent = get_device(dev);
1447         spi_master_set_devdata(master, &master[1]);
1448
1449         return master;
1450 }
1451 EXPORT_SYMBOL_GPL(spi_alloc_master);
1452
1453 #ifdef CONFIG_OF
1454 static int of_spi_register_master(struct spi_master *master)
1455 {
1456         int nb, i, *cs;
1457         struct device_node *np = master->dev.of_node;
1458
1459         if (!np)
1460                 return 0;
1461
1462         nb = of_gpio_named_count(np, "cs-gpios");
1463         master->num_chipselect = max_t(int, nb, master->num_chipselect);
1464
1465         /* Return error only for an incorrectly formed cs-gpios property */
1466         if (nb == 0 || nb == -ENOENT)
1467                 return 0;
1468         else if (nb < 0)
1469                 return nb;
1470
1471         cs = devm_kzalloc(&master->dev,
1472                           sizeof(int) * master->num_chipselect,
1473                           GFP_KERNEL);
1474         master->cs_gpios = cs;
1475
1476         if (!master->cs_gpios)
1477                 return -ENOMEM;
1478
1479         for (i = 0; i < master->num_chipselect; i++)
1480                 cs[i] = -ENOENT;
1481
1482         for (i = 0; i < nb; i++)
1483                 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
1484
1485         return 0;
1486 }
1487 #else
1488 static int of_spi_register_master(struct spi_master *master)
1489 {
1490         return 0;
1491 }
1492 #endif
1493
1494 /**
1495  * spi_register_master - register SPI master controller
1496  * @master: initialized master, originally from spi_alloc_master()
1497  * Context: can sleep
1498  *
1499  * SPI master controllers connect to their drivers using some non-SPI bus,
1500  * such as the platform bus.  The final stage of probe() in that code
1501  * includes calling spi_register_master() to hook up to this SPI bus glue.
1502  *
1503  * SPI controllers use board specific (often SOC specific) bus numbers,
1504  * and board-specific addressing for SPI devices combines those numbers
1505  * with chip select numbers.  Since SPI does not directly support dynamic
1506  * device identification, boards need configuration tables telling which
1507  * chip is at which address.
1508  *
1509  * This must be called from context that can sleep.  It returns zero on
1510  * success, else a negative error code (dropping the master's refcount).
1511  * After a successful return, the caller is responsible for calling
1512  * spi_unregister_master().
1513  */
1514 int spi_register_master(struct spi_master *master)
1515 {
1516         static atomic_t         dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
1517         struct device           *dev = master->dev.parent;
1518         struct boardinfo        *bi;
1519         int                     status = -ENODEV;
1520         int                     dynamic = 0;
1521
1522         if (!dev)
1523                 return -ENODEV;
1524
1525         status = of_spi_register_master(master);
1526         if (status)
1527                 return status;
1528
1529         /* even if it's just one always-selected device, there must
1530          * be at least one chipselect
1531          */
1532         if (master->num_chipselect == 0)
1533                 return -EINVAL;
1534
1535         if ((master->bus_num < 0) && master->dev.of_node)
1536                 master->bus_num = of_alias_get_id(master->dev.of_node, "spi");
1537
1538         /* convention:  dynamically assigned bus IDs count down from the max */
1539         if (master->bus_num < 0) {
1540                 /* FIXME switch to an IDR based scheme, something like
1541                  * I2C now uses, so we can't run out of "dynamic" IDs
1542                  */
1543                 master->bus_num = atomic_dec_return(&dyn_bus_id);
1544                 dynamic = 1;
1545         }
1546
1547         spin_lock_init(&master->bus_lock_spinlock);
1548         mutex_init(&master->bus_lock_mutex);
1549         master->bus_lock_flag = 0;
1550         init_completion(&master->xfer_completion);
1551         if (!master->max_dma_len)
1552                 master->max_dma_len = INT_MAX;
1553
1554         /* register the device, then userspace will see it.
1555          * registration fails if the bus ID is in use.
1556          */
1557         dev_set_name(&master->dev, "spi%u", master->bus_num);
1558         status = device_add(&master->dev);
1559         if (status < 0)
1560                 goto done;
1561         dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
1562                         dynamic ? " (dynamic)" : "");
1563
1564         /* If we're using a queued driver, start the queue */
1565         if (master->transfer)
1566                 dev_info(dev, "master is unqueued, this is deprecated\n");
1567         else {
1568                 status = spi_master_initialize_queue(master);
1569                 if (status) {
1570                         device_del(&master->dev);
1571                         goto done;
1572                 }
1573         }
1574
1575         mutex_lock(&board_lock);
1576         list_add_tail(&master->list, &spi_master_list);
1577         list_for_each_entry(bi, &board_list, list)
1578                 spi_match_master_to_boardinfo(master, &bi->board_info);
1579         mutex_unlock(&board_lock);
1580
1581         /* Register devices from the device tree and ACPI */
1582         of_register_spi_devices(master);
1583         acpi_register_spi_devices(master);
1584 done:
1585         return status;
1586 }
1587 EXPORT_SYMBOL_GPL(spi_register_master);
1588
1589 static void devm_spi_unregister(struct device *dev, void *res)
1590 {
1591         spi_unregister_master(*(struct spi_master **)res);
1592 }
1593
1594 /**
1595  * dev_spi_register_master - register managed SPI master controller
1596  * @dev:    device managing SPI master
1597  * @master: initialized master, originally from spi_alloc_master()
1598  * Context: can sleep
1599  *
1600  * Register a SPI device as with spi_register_master() which will
1601  * automatically be unregister
1602  */
1603 int devm_spi_register_master(struct device *dev, struct spi_master *master)
1604 {
1605         struct spi_master **ptr;
1606         int ret;
1607
1608         ptr = devres_alloc(devm_spi_unregister, sizeof(*ptr), GFP_KERNEL);
1609         if (!ptr)
1610                 return -ENOMEM;
1611
1612         ret = spi_register_master(master);
1613         if (!ret) {
1614                 *ptr = master;
1615                 devres_add(dev, ptr);
1616         } else {
1617                 devres_free(ptr);
1618         }
1619
1620         return ret;
1621 }
1622 EXPORT_SYMBOL_GPL(devm_spi_register_master);
1623
1624 static int __unregister(struct device *dev, void *null)
1625 {
1626         spi_unregister_device(to_spi_device(dev));
1627         return 0;
1628 }
1629
1630 /**
1631  * spi_unregister_master - unregister SPI master controller
1632  * @master: the master being unregistered
1633  * Context: can sleep
1634  *
1635  * This call is used only by SPI master controller drivers, which are the
1636  * only ones directly touching chip registers.
1637  *
1638  * This must be called from context that can sleep.
1639  */
1640 void spi_unregister_master(struct spi_master *master)
1641 {
1642         int dummy;
1643
1644         if (master->queued) {
1645                 if (spi_destroy_queue(master))
1646                         dev_err(&master->dev, "queue remove failed\n");
1647         }
1648
1649         mutex_lock(&board_lock);
1650         list_del(&master->list);
1651         mutex_unlock(&board_lock);
1652
1653         dummy = device_for_each_child(&master->dev, NULL, __unregister);
1654         device_unregister(&master->dev);
1655 }
1656 EXPORT_SYMBOL_GPL(spi_unregister_master);
1657
1658 int spi_master_suspend(struct spi_master *master)
1659 {
1660         int ret;
1661
1662         /* Basically no-ops for non-queued masters */
1663         if (!master->queued)
1664                 return 0;
1665
1666         ret = spi_stop_queue(master);
1667         if (ret)
1668                 dev_err(&master->dev, "queue stop failed\n");
1669
1670         return ret;
1671 }
1672 EXPORT_SYMBOL_GPL(spi_master_suspend);
1673
1674 int spi_master_resume(struct spi_master *master)
1675 {
1676         int ret;
1677
1678         if (!master->queued)
1679                 return 0;
1680
1681         ret = spi_start_queue(master);
1682         if (ret)
1683                 dev_err(&master->dev, "queue restart failed\n");
1684
1685         return ret;
1686 }
1687 EXPORT_SYMBOL_GPL(spi_master_resume);
1688
1689 static int __spi_master_match(struct device *dev, const void *data)
1690 {
1691         struct spi_master *m;
1692         const u16 *bus_num = data;
1693
1694         m = container_of(dev, struct spi_master, dev);
1695         return m->bus_num == *bus_num;
1696 }
1697
1698 /**
1699  * spi_busnum_to_master - look up master associated with bus_num
1700  * @bus_num: the master's bus number
1701  * Context: can sleep
1702  *
1703  * This call may be used with devices that are registered after
1704  * arch init time.  It returns a refcounted pointer to the relevant
1705  * spi_master (which the caller must release), or NULL if there is
1706  * no such master registered.
1707  */
1708 struct spi_master *spi_busnum_to_master(u16 bus_num)
1709 {
1710         struct device           *dev;
1711         struct spi_master       *master = NULL;
1712
1713         dev = class_find_device(&spi_master_class, NULL, &bus_num,
1714                                 __spi_master_match);
1715         if (dev)
1716                 master = container_of(dev, struct spi_master, dev);
1717         /* reference got in class_find_device */
1718         return master;
1719 }
1720 EXPORT_SYMBOL_GPL(spi_busnum_to_master);
1721
1722
1723 /*-------------------------------------------------------------------------*/
1724
1725 /* Core methods for SPI master protocol drivers.  Some of the
1726  * other core methods are currently defined as inline functions.
1727  */
1728
1729 /**
1730  * spi_setup - setup SPI mode and clock rate
1731  * @spi: the device whose settings are being modified
1732  * Context: can sleep, and no requests are queued to the device
1733  *
1734  * SPI protocol drivers may need to update the transfer mode if the
1735  * device doesn't work with its default.  They may likewise need
1736  * to update clock rates or word sizes from initial values.  This function
1737  * changes those settings, and must be called from a context that can sleep.
1738  * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
1739  * effect the next time the device is selected and data is transferred to
1740  * or from it.  When this function returns, the spi device is deselected.
1741  *
1742  * Note that this call will fail if the protocol driver specifies an option
1743  * that the underlying controller or its driver does not support.  For
1744  * example, not all hardware supports wire transfers using nine bit words,
1745  * LSB-first wire encoding, or active-high chipselects.
1746  */
1747 int spi_setup(struct spi_device *spi)
1748 {
1749         unsigned        bad_bits;
1750         int             status = 0;
1751
1752         /* check mode to prevent that DUAL and QUAD set at the same time
1753          */
1754         if (((spi->mode & SPI_TX_DUAL) && (spi->mode & SPI_TX_QUAD)) ||
1755                 ((spi->mode & SPI_RX_DUAL) && (spi->mode & SPI_RX_QUAD))) {
1756                 dev_err(&spi->dev,
1757                 "setup: can not select dual and quad at the same time\n");
1758                 return -EINVAL;
1759         }
1760         /* if it is SPI_3WIRE mode, DUAL and QUAD should be forbidden
1761          */
1762         if ((spi->mode & SPI_3WIRE) && (spi->mode &
1763                 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD)))
1764                 return -EINVAL;
1765         /* help drivers fail *cleanly* when they need options
1766          * that aren't supported with their current master
1767          */
1768         bad_bits = spi->mode & ~spi->master->mode_bits;
1769         if (bad_bits) {
1770                 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
1771                         bad_bits);
1772                 return -EINVAL;
1773         }
1774
1775         if (!spi->bits_per_word)
1776                 spi->bits_per_word = 8;
1777
1778         if (spi->master->setup)
1779                 status = spi->master->setup(spi);
1780
1781         dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s%u bits/w, %u Hz max --> %d\n",
1782                         (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
1783                         (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
1784                         (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
1785                         (spi->mode & SPI_3WIRE) ? "3wire, " : "",
1786                         (spi->mode & SPI_LOOP) ? "loopback, " : "",
1787                         spi->bits_per_word, spi->max_speed_hz,
1788                         status);
1789
1790         return status;
1791 }
1792 EXPORT_SYMBOL_GPL(spi_setup);
1793
1794 static int __spi_validate(struct spi_device *spi, struct spi_message *message)
1795 {
1796         struct spi_master *master = spi->master;
1797         struct spi_transfer *xfer;
1798         int w_size;
1799
1800         if (list_empty(&message->transfers))
1801                 return -EINVAL;
1802
1803         /* Half-duplex links include original MicroWire, and ones with
1804          * only one data pin like SPI_3WIRE (switches direction) or where
1805          * either MOSI or MISO is missing.  They can also be caused by
1806          * software limitations.
1807          */
1808         if ((master->flags & SPI_MASTER_HALF_DUPLEX)
1809                         || (spi->mode & SPI_3WIRE)) {
1810                 unsigned flags = master->flags;
1811
1812                 list_for_each_entry(xfer, &message->transfers, transfer_list) {
1813                         if (xfer->rx_buf && xfer->tx_buf)
1814                                 return -EINVAL;
1815                         if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
1816                                 return -EINVAL;
1817                         if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
1818                                 return -EINVAL;
1819                 }
1820         }
1821
1822         /**
1823          * Set transfer bits_per_word and max speed as spi device default if
1824          * it is not set for this transfer.
1825          * Set transfer tx_nbits and rx_nbits as single transfer default
1826          * (SPI_NBITS_SINGLE) if it is not set for this transfer.
1827          */
1828         list_for_each_entry(xfer, &message->transfers, transfer_list) {
1829                 message->frame_length += xfer->len;
1830                 if (!xfer->bits_per_word)
1831                         xfer->bits_per_word = spi->bits_per_word;
1832
1833                 if (!xfer->speed_hz)
1834                         xfer->speed_hz = spi->max_speed_hz;
1835
1836                 if (master->max_speed_hz &&
1837                     xfer->speed_hz > master->max_speed_hz)
1838                         xfer->speed_hz = master->max_speed_hz;
1839
1840                 if (master->bits_per_word_mask) {
1841                         /* Only 32 bits fit in the mask */
1842                         if (xfer->bits_per_word > 32)
1843                                 return -EINVAL;
1844                         if (!(master->bits_per_word_mask &
1845                                         BIT(xfer->bits_per_word - 1)))
1846                                 return -EINVAL;
1847                 }
1848
1849                 /*
1850                  * SPI transfer length should be multiple of SPI word size
1851                  * where SPI word size should be power-of-two multiple
1852                  */
1853                 if (xfer->bits_per_word <= 8)
1854                         w_size = 1;
1855                 else if (xfer->bits_per_word <= 16)
1856                         w_size = 2;
1857                 else
1858                         w_size = 4;
1859
1860                 /* No partial transfers accepted */
1861                 if (xfer->len % w_size)
1862                         return -EINVAL;
1863
1864                 if (xfer->speed_hz && master->min_speed_hz &&
1865                     xfer->speed_hz < master->min_speed_hz)
1866                         return -EINVAL;
1867
1868                 if (xfer->tx_buf && !xfer->tx_nbits)
1869                         xfer->tx_nbits = SPI_NBITS_SINGLE;
1870                 if (xfer->rx_buf && !xfer->rx_nbits)
1871                         xfer->rx_nbits = SPI_NBITS_SINGLE;
1872                 /* check transfer tx/rx_nbits:
1873                  * 1. check the value matches one of single, dual and quad
1874                  * 2. check tx/rx_nbits match the mode in spi_device
1875                  */
1876                 if (xfer->tx_buf) {
1877                         if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
1878                                 xfer->tx_nbits != SPI_NBITS_DUAL &&
1879                                 xfer->tx_nbits != SPI_NBITS_QUAD)
1880                                 return -EINVAL;
1881                         if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
1882                                 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
1883                                 return -EINVAL;
1884                         if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
1885                                 !(spi->mode & SPI_TX_QUAD))
1886                                 return -EINVAL;
1887                 }
1888                 /* check transfer rx_nbits */
1889                 if (xfer->rx_buf) {
1890                         if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
1891                                 xfer->rx_nbits != SPI_NBITS_DUAL &&
1892                                 xfer->rx_nbits != SPI_NBITS_QUAD)
1893                                 return -EINVAL;
1894                         if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
1895                                 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
1896                                 return -EINVAL;
1897                         if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
1898                                 !(spi->mode & SPI_RX_QUAD))
1899                                 return -EINVAL;
1900                 }
1901         }
1902
1903         message->status = -EINPROGRESS;
1904
1905         return 0;
1906 }
1907
1908 static int __spi_async(struct spi_device *spi, struct spi_message *message)
1909 {
1910         struct spi_master *master = spi->master;
1911
1912         message->spi = spi;
1913
1914         trace_spi_message_submit(message);
1915
1916         return master->transfer(spi, message);
1917 }
1918
1919 /**
1920  * spi_async - asynchronous SPI transfer
1921  * @spi: device with which data will be exchanged
1922  * @message: describes the data transfers, including completion callback
1923  * Context: any (irqs may be blocked, etc)
1924  *
1925  * This call may be used in_irq and other contexts which can't sleep,
1926  * as well as from task contexts which can sleep.
1927  *
1928  * The completion callback is invoked in a context which can't sleep.
1929  * Before that invocation, the value of message->status is undefined.
1930  * When the callback is issued, message->status holds either zero (to
1931  * indicate complete success) or a negative error code.  After that
1932  * callback returns, the driver which issued the transfer request may
1933  * deallocate the associated memory; it's no longer in use by any SPI
1934  * core or controller driver code.
1935  *
1936  * Note that although all messages to a spi_device are handled in
1937  * FIFO order, messages may go to different devices in other orders.
1938  * Some device might be higher priority, or have various "hard" access
1939  * time requirements, for example.
1940  *
1941  * On detection of any fault during the transfer, processing of
1942  * the entire message is aborted, and the device is deselected.
1943  * Until returning from the associated message completion callback,
1944  * no other spi_message queued to that device will be processed.
1945  * (This rule applies equally to all the synchronous transfer calls,
1946  * which are wrappers around this core asynchronous primitive.)
1947  */
1948 int spi_async(struct spi_device *spi, struct spi_message *message)
1949 {
1950         struct spi_master *master = spi->master;
1951         int ret;
1952         unsigned long flags;
1953
1954         ret = __spi_validate(spi, message);
1955         if (ret != 0)
1956                 return ret;
1957
1958         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
1959
1960         if (master->bus_lock_flag)
1961                 ret = -EBUSY;
1962         else
1963                 ret = __spi_async(spi, message);
1964
1965         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
1966
1967         return ret;
1968 }
1969 EXPORT_SYMBOL_GPL(spi_async);
1970
1971 /**
1972  * spi_async_locked - version of spi_async with exclusive bus usage
1973  * @spi: device with which data will be exchanged
1974  * @message: describes the data transfers, including completion callback
1975  * Context: any (irqs may be blocked, etc)
1976  *
1977  * This call may be used in_irq and other contexts which can't sleep,
1978  * as well as from task contexts which can sleep.
1979  *
1980  * The completion callback is invoked in a context which can't sleep.
1981  * Before that invocation, the value of message->status is undefined.
1982  * When the callback is issued, message->status holds either zero (to
1983  * indicate complete success) or a negative error code.  After that
1984  * callback returns, the driver which issued the transfer request may
1985  * deallocate the associated memory; it's no longer in use by any SPI
1986  * core or controller driver code.
1987  *
1988  * Note that although all messages to a spi_device are handled in
1989  * FIFO order, messages may go to different devices in other orders.
1990  * Some device might be higher priority, or have various "hard" access
1991  * time requirements, for example.
1992  *
1993  * On detection of any fault during the transfer, processing of
1994  * the entire message is aborted, and the device is deselected.
1995  * Until returning from the associated message completion callback,
1996  * no other spi_message queued to that device will be processed.
1997  * (This rule applies equally to all the synchronous transfer calls,
1998  * which are wrappers around this core asynchronous primitive.)
1999  */
2000 int spi_async_locked(struct spi_device *spi, struct spi_message *message)
2001 {
2002         struct spi_master *master = spi->master;
2003         int ret;
2004         unsigned long flags;
2005
2006         ret = __spi_validate(spi, message);
2007         if (ret != 0)
2008                 return ret;
2009
2010         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2011
2012         ret = __spi_async(spi, message);
2013
2014         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2015
2016         return ret;
2017
2018 }
2019 EXPORT_SYMBOL_GPL(spi_async_locked);
2020
2021
2022 /*-------------------------------------------------------------------------*/
2023
2024 /* Utility methods for SPI master protocol drivers, layered on
2025  * top of the core.  Some other utility methods are defined as
2026  * inline functions.
2027  */
2028
2029 static void spi_complete(void *arg)
2030 {
2031         complete(arg);
2032 }
2033
2034 static int __spi_sync(struct spi_device *spi, struct spi_message *message,
2035                       int bus_locked)
2036 {
2037         DECLARE_COMPLETION_ONSTACK(done);
2038         int status;
2039         struct spi_master *master = spi->master;
2040
2041         message->complete = spi_complete;
2042         message->context = &done;
2043
2044         if (!bus_locked)
2045                 mutex_lock(&master->bus_lock_mutex);
2046
2047         status = spi_async_locked(spi, message);
2048
2049         if (!bus_locked)
2050                 mutex_unlock(&master->bus_lock_mutex);
2051
2052         if (status == 0) {
2053                 wait_for_completion(&done);
2054                 status = message->status;
2055         }
2056         message->context = NULL;
2057         return status;
2058 }
2059
2060 /**
2061  * spi_sync - blocking/synchronous SPI data transfers
2062  * @spi: device with which data will be exchanged
2063  * @message: describes the data transfers
2064  * Context: can sleep
2065  *
2066  * This call may only be used from a context that may sleep.  The sleep
2067  * is non-interruptible, and has no timeout.  Low-overhead controller
2068  * drivers may DMA directly into and out of the message buffers.
2069  *
2070  * Note that the SPI device's chip select is active during the message,
2071  * and then is normally disabled between messages.  Drivers for some
2072  * frequently-used devices may want to minimize costs of selecting a chip,
2073  * by leaving it selected in anticipation that the next message will go
2074  * to the same chip.  (That may increase power usage.)
2075  *
2076  * Also, the caller is guaranteeing that the memory associated with the
2077  * message will not be freed before this call returns.
2078  *
2079  * It returns zero on success, else a negative error code.
2080  */
2081 int spi_sync(struct spi_device *spi, struct spi_message *message)
2082 {
2083         return __spi_sync(spi, message, 0);
2084 }
2085 EXPORT_SYMBOL_GPL(spi_sync);
2086
2087 /**
2088  * spi_sync_locked - version of spi_sync with exclusive bus usage
2089  * @spi: device with which data will be exchanged
2090  * @message: describes the data transfers
2091  * Context: can sleep
2092  *
2093  * This call may only be used from a context that may sleep.  The sleep
2094  * is non-interruptible, and has no timeout.  Low-overhead controller
2095  * drivers may DMA directly into and out of the message buffers.
2096  *
2097  * This call should be used by drivers that require exclusive access to the
2098  * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
2099  * be released by a spi_bus_unlock call when the exclusive access is over.
2100  *
2101  * It returns zero on success, else a negative error code.
2102  */
2103 int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
2104 {
2105         return __spi_sync(spi, message, 1);
2106 }
2107 EXPORT_SYMBOL_GPL(spi_sync_locked);
2108
2109 /**
2110  * spi_bus_lock - obtain a lock for exclusive SPI bus usage
2111  * @master: SPI bus master that should be locked for exclusive bus access
2112  * Context: can sleep
2113  *
2114  * This call may only be used from a context that may sleep.  The sleep
2115  * is non-interruptible, and has no timeout.
2116  *
2117  * This call should be used by drivers that require exclusive access to the
2118  * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
2119  * exclusive access is over. Data transfer must be done by spi_sync_locked
2120  * and spi_async_locked calls when the SPI bus lock is held.
2121  *
2122  * It returns zero on success, else a negative error code.
2123  */
2124 int spi_bus_lock(struct spi_master *master)
2125 {
2126         unsigned long flags;
2127
2128         mutex_lock(&master->bus_lock_mutex);
2129
2130         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2131         master->bus_lock_flag = 1;
2132         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2133
2134         /* mutex remains locked until spi_bus_unlock is called */
2135
2136         return 0;
2137 }
2138 EXPORT_SYMBOL_GPL(spi_bus_lock);
2139
2140 /**
2141  * spi_bus_unlock - release the lock for exclusive SPI bus usage
2142  * @master: SPI bus master that was locked for exclusive bus access
2143  * Context: can sleep
2144  *
2145  * This call may only be used from a context that may sleep.  The sleep
2146  * is non-interruptible, and has no timeout.
2147  *
2148  * This call releases an SPI bus lock previously obtained by an spi_bus_lock
2149  * call.
2150  *
2151  * It returns zero on success, else a negative error code.
2152  */
2153 int spi_bus_unlock(struct spi_master *master)
2154 {
2155         master->bus_lock_flag = 0;
2156
2157         mutex_unlock(&master->bus_lock_mutex);
2158
2159         return 0;
2160 }
2161 EXPORT_SYMBOL_GPL(spi_bus_unlock);
2162
2163 /* portable code must never pass more than 32 bytes */
2164 #define SPI_BUFSIZ      max(32, SMP_CACHE_BYTES)
2165
2166 static u8       *buf;
2167
2168 /**
2169  * spi_write_then_read - SPI synchronous write followed by read
2170  * @spi: device with which data will be exchanged
2171  * @txbuf: data to be written (need not be dma-safe)
2172  * @n_tx: size of txbuf, in bytes
2173  * @rxbuf: buffer into which data will be read (need not be dma-safe)
2174  * @n_rx: size of rxbuf, in bytes
2175  * Context: can sleep
2176  *
2177  * This performs a half duplex MicroWire style transaction with the
2178  * device, sending txbuf and then reading rxbuf.  The return value
2179  * is zero for success, else a negative errno status code.
2180  * This call may only be used from a context that may sleep.
2181  *
2182  * Parameters to this routine are always copied using a small buffer;
2183  * portable code should never use this for more than 32 bytes.
2184  * Performance-sensitive or bulk transfer code should instead use
2185  * spi_{async,sync}() calls with dma-safe buffers.
2186  */
2187 int spi_write_then_read(struct spi_device *spi,
2188                 const void *txbuf, unsigned n_tx,
2189                 void *rxbuf, unsigned n_rx)
2190 {
2191         static DEFINE_MUTEX(lock);
2192
2193         int                     status;
2194         struct spi_message      message;
2195         struct spi_transfer     x[2];
2196         u8                      *local_buf;
2197
2198         /* Use preallocated DMA-safe buffer if we can.  We can't avoid
2199          * copying here, (as a pure convenience thing), but we can
2200          * keep heap costs out of the hot path unless someone else is
2201          * using the pre-allocated buffer or the transfer is too large.
2202          */
2203         if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
2204                 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
2205                                     GFP_KERNEL | GFP_DMA);
2206                 if (!local_buf)
2207                         return -ENOMEM;
2208         } else {
2209                 local_buf = buf;
2210         }
2211
2212         spi_message_init(&message);
2213         memset(x, 0, sizeof(x));
2214         if (n_tx) {
2215                 x[0].len = n_tx;
2216                 spi_message_add_tail(&x[0], &message);
2217         }
2218         if (n_rx) {
2219                 x[1].len = n_rx;
2220                 spi_message_add_tail(&x[1], &message);
2221         }
2222
2223         memcpy(local_buf, txbuf, n_tx);
2224         x[0].tx_buf = local_buf;
2225         x[1].rx_buf = local_buf + n_tx;
2226
2227         /* do the i/o */
2228         status = spi_sync(spi, &message);
2229         if (status == 0)
2230                 memcpy(rxbuf, x[1].rx_buf, n_rx);
2231
2232         if (x[0].tx_buf == buf)
2233                 mutex_unlock(&lock);
2234         else
2235                 kfree(local_buf);
2236
2237         return status;
2238 }
2239 EXPORT_SYMBOL_GPL(spi_write_then_read);
2240
2241 /*-------------------------------------------------------------------------*/
2242
2243 static int __init spi_init(void)
2244 {
2245         int     status;
2246
2247         buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
2248         if (!buf) {
2249                 status = -ENOMEM;
2250                 goto err0;
2251         }
2252
2253         status = bus_register(&spi_bus_type);
2254         if (status < 0)
2255                 goto err1;
2256
2257         status = class_register(&spi_master_class);
2258         if (status < 0)
2259                 goto err2;
2260         return 0;
2261
2262 err2:
2263         bus_unregister(&spi_bus_type);
2264 err1:
2265         kfree(buf);
2266         buf = NULL;
2267 err0:
2268         return status;
2269 }
2270
2271 /* board_info is normally registered in arch_initcall(),
2272  * but even essential drivers wait till later
2273  *
2274  * REVISIT only boardinfo really needs static linking. the rest (device and
2275  * driver registration) _could_ be dynamically linked (modular) ... costs
2276  * include needing to have boardinfo data structures be much more public.
2277  */
2278 postcore_initcall(spi_init);
2279