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         struct spi_device               *spi = to_spi_device(dev);
 261         int ret;
 262
 263         acpi_dev_pm_attach(&spi->dev, true);
 264         ret = sdrv->probe(spi);
 265         if (ret)
 266                 acpi_dev_pm_detach(&spi->dev, true);
 267
 268         return ret;
 269 }
 270
 271 static int spi_drv_remove(struct device *dev)
 272 {
 273         const struct spi_driver         *sdrv = to_spi_driver(dev->driver);
 274         struct spi_device               *spi = to_spi_device(dev);
 275         int ret;
 276
 277         ret = sdrv->remove(spi);
 278         acpi_dev_pm_detach(&spi->dev, true);
 279
 280         return ret;
 281 }
 282
 283 static void spi_drv_shutdown(struct device *dev)
 284 {
 285         const struct spi_driver         *sdrv = to_spi_driver(dev->driver);
 286
 287         sdrv->shutdown(to_spi_device(dev));
 288 }
 289
 290 /**
 291  * spi_register_driver - register a SPI driver
 292  * @sdrv: the driver to register
 293  * Context: can sleep
 294  */
 295 int spi_register_driver(struct spi_driver *sdrv)
 296 {
 297         sdrv->driver.bus = &spi_bus_type;
 298         if (sdrv->probe)
 299                 sdrv->driver.probe = spi_drv_probe;
 300         if (sdrv->remove)
 301                 sdrv->driver.remove = spi_drv_remove;
 302         if (sdrv->shutdown)
 303                 sdrv->driver.shutdown = spi_drv_shutdown;
 304         return driver_register(&sdrv->driver);
 305 }
 306 EXPORT_SYMBOL_GPL(spi_register_driver);
 307
 308 /*-------------------------------------------------------------------------*/
 309
 310 /* SPI devices should normally not be created by SPI device drivers; that
 311  * would make them board-specific.  Similarly with SPI master drivers.
 312  * Device registration normally goes into like arch/.../mach.../board-YYY.c
 313  * with other readonly (flashable) information about mainboard devices.
 314  */
 315
 316 struct boardinfo {
 317         struct list_head        list;
 318         struct spi_board_info   board_info;
 319 };
 320
 321 static LIST_HEAD(board_list);
 322 static LIST_HEAD(spi_master_list);
 323
 324 /*
 325  * Used to protect add/del opertion for board_info list and
 326  * spi_master list, and their matching process
 327  */
 328 static DEFINE_MUTEX(board_lock);
 329
 330 /**
 331  * spi_alloc_device - Allocate a new SPI device
 332  * @master: Controller to which device is connected
 333  * Context: can sleep
 334  *
 335  * Allows a driver to allocate and initialize a spi_device without
 336  * registering it immediately.  This allows a driver to directly
 337  * fill the spi_device with device parameters before calling
 338  * spi_add_device() on it.
 339  *
 340  * Caller is responsible to call spi_add_device() on the returned
 341  * spi_device structure to add it to the SPI master.  If the caller
 342  * needs to discard the spi_device without adding it, then it should
 343  * call spi_dev_put() on it.
 344  *
 345  * Returns a pointer to the new device, or NULL.
 346  */
 347 struct spi_device *spi_alloc_device(struct spi_master *master)
 348 {
 349         struct spi_device       *spi;
 350         struct device           *dev = master->dev.parent;
 351
 352         if (!spi_master_get(master))
 353                 return NULL;
 354
 355         spi = kzalloc(sizeof(*spi), GFP_KERNEL);
 356         if (!spi) {
 357                 dev_err(dev, "cannot alloc spi_device\n");
 358                 spi_master_put(master);
 359                 return NULL;
 360         }
 361
 362         spi->master = master;
 363         spi->dev.parent = &master->dev;
 364         spi->dev.bus = &spi_bus_type;
 365         spi->dev.release = spidev_release;
 366         spi->cs_gpio = -ENOENT;
 367         device_initialize(&spi->dev);
 368         return spi;
 369 }
 370 EXPORT_SYMBOL_GPL(spi_alloc_device);
 371
 372 static void spi_dev_set_name(struct spi_device *spi)
 373 {
 374         struct acpi_device *adev = ACPI_COMPANION(&spi->dev);
 375
 376         if (adev) {
 377                 dev_set_name(&spi->dev, "spi-%s", acpi_dev_name(adev));
 378                 return;
 379         }
 380
 381         dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
 382                      spi->chip_select);
 383 }
 384
 385 static int spi_dev_check(struct device *dev, void *data)
 386 {
 387         struct spi_device *spi = to_spi_device(dev);
 388         struct spi_device *new_spi = data;
 389
 390         if (spi->master == new_spi->master &&
 391             spi->chip_select == new_spi->chip_select)
 392                 return -EBUSY;
 393         return 0;
 394 }
 395
 396 /**
 397  * spi_add_device - Add spi_device allocated with spi_alloc_device
 398  * @spi: spi_device to register
 399  *
 400  * Companion function to spi_alloc_device.  Devices allocated with
 401  * spi_alloc_device can be added onto the spi bus with this function.
 402  *
 403  * Returns 0 on success; negative errno on failure
 404  */
 405 int spi_add_device(struct spi_device *spi)
 406 {
 407         static DEFINE_MUTEX(spi_add_lock);
 408         struct spi_master *master = spi->master;
 409         struct device *dev = master->dev.parent;
 410         int status;
 411
 412         /* Chipselects are numbered 0..max; validate. */
 413         if (spi->chip_select >= master->num_chipselect) {
 414                 dev_err(dev, "cs%d >= max %d\n",
 415                         spi->chip_select,
 416                         master->num_chipselect);
 417                 return -EINVAL;
 418         }
 419
 420         /* Set the bus ID string */
 421         spi_dev_set_name(spi);
 422
 423         /* We need to make sure there's no other device with this
 424          * chipselect **BEFORE** we call setup(), else we'll trash
 425          * its configuration.  Lock against concurrent add() calls.
 426          */
 427         mutex_lock(&spi_add_lock);
 428
 429         status = bus_for_each_dev(&spi_bus_type, NULL, spi, spi_dev_check);
 430         if (status) {
 431                 dev_err(dev, "chipselect %d already in use\n",
 432                                 spi->chip_select);
 433                 goto done;
 434         }
 435
 436         if (master->cs_gpios)
 437                 spi->cs_gpio = master->cs_gpios[spi->chip_select];
 438
 439         /* Drivers may modify this initial i/o setup, but will
 440          * normally rely on the device being setup.  Devices
 441          * using SPI_CS_HIGH can't coexist well otherwise...
 442          */
 443         status = spi_setup(spi);
 444         if (status < 0) {
 445                 dev_err(dev, "can't setup %s, status %d\n",
 446                                 dev_name(&spi->dev), status);
 447                 goto done;
 448         }
 449
 450         /* Device may be bound to an active driver when this returns */
 451         status = device_add(&spi->dev);
 452         if (status < 0)
 453                 dev_err(dev, "can't add %s, status %d\n",
 454                                 dev_name(&spi->dev), status);
 455         else
 456                 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
 457
 458 done:
 459         mutex_unlock(&spi_add_lock);
 460         return status;
 461 }
 462 EXPORT_SYMBOL_GPL(spi_add_device);
 463
 464 /**
 465  * spi_new_device - instantiate one new SPI device
 466  * @master: Controller to which device is connected
 467  * @chip: Describes the SPI device
 468  * Context: can sleep
 469  *
 470  * On typical mainboards, this is purely internal; and it's not needed
 471  * after board init creates the hard-wired devices.  Some development
 472  * platforms may not be able to use spi_register_board_info though, and
 473  * this is exported so that for example a USB or parport based adapter
 474  * driver could add devices (which it would learn about out-of-band).
 475  *
 476  * Returns the new device, or NULL.
 477  */
 478 struct spi_device *spi_new_device(struct spi_master *master,
 479                                   struct spi_board_info *chip)
 480 {
 481         struct spi_device       *proxy;
 482         int                     status;
 483
 484         /* NOTE:  caller did any chip->bus_num checks necessary.
 485          *
 486          * Also, unless we change the return value convention to use
 487          * error-or-pointer (not NULL-or-pointer), troubleshootability
 488          * suggests syslogged diagnostics are best here (ugh).
 489          */
 490
 491         proxy = spi_alloc_device(master);
 492         if (!proxy)
 493                 return NULL;
 494
 495         WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
 496
 497         proxy->chip_select = chip->chip_select;
 498         proxy->max_speed_hz = chip->max_speed_hz;
 499         proxy->mode = chip->mode;
 500         proxy->irq = chip->irq;
 501         strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
 502         proxy->dev.platform_data = (void *) chip->platform_data;
 503         proxy->controller_data = chip->controller_data;
 504         proxy->controller_state = NULL;
 505
 506         status = spi_add_device(proxy);
 507         if (status < 0) {
 508                 spi_dev_put(proxy);
 509                 return NULL;
 510         }
 511
 512         return proxy;
 513 }
 514 EXPORT_SYMBOL_GPL(spi_new_device);
 515
 516 static void spi_match_master_to_boardinfo(struct spi_master *master,
 517                                 struct spi_board_info *bi)
 518 {
 519         struct spi_device *dev;
 520
 521         if (master->bus_num != bi->bus_num)
 522                 return;
 523
 524         dev = spi_new_device(master, bi);
 525         if (!dev)
 526                 dev_err(master->dev.parent, "can't create new device for %s\n",
 527                         bi->modalias);
 528 }
 529
 530 /**
 531  * spi_register_board_info - register SPI devices for a given board
 532  * @info: array of chip descriptors
 533  * @n: how many descriptors are provided
 534  * Context: can sleep
 535  *
 536  * Board-specific early init code calls this (probably during arch_initcall)
 537  * with segments of the SPI device table.  Any device nodes are created later,
 538  * after the relevant parent SPI controller (bus_num) is defined.  We keep
 539  * this table of devices forever, so that reloading a controller driver will
 540  * not make Linux forget about these hard-wired devices.
 541  *
 542  * Other code can also call this, e.g. a particular add-on board might provide
 543  * SPI devices through its expansion connector, so code initializing that board
 544  * would naturally declare its SPI devices.
 545  *
 546  * The board info passed can safely be __initdata ... but be careful of
 547  * any embedded pointers (platform_data, etc), they're copied as-is.
 548  */
 549 int spi_register_board_info(struct spi_board_info const *info, unsigned n)
 550 {
 551         struct boardinfo *bi;
 552         int i;
 553
 554         bi = kzalloc(n * sizeof(*bi), GFP_KERNEL);
 555         if (!bi)
 556                 return -ENOMEM;
 557
 558         for (i = 0; i < n; i++, bi++, info++) {
 559                 struct spi_master *master;
 560
 561                 memcpy(&bi->board_info, info, sizeof(*info));
 562                 mutex_lock(&board_lock);
 563                 list_add_tail(&bi->list, &board_list);
 564                 list_for_each_entry(master, &spi_master_list, list)
 565                         spi_match_master_to_boardinfo(master, &bi->board_info);
 566                 mutex_unlock(&board_lock);
 567         }
 568
 569         return 0;
 570 }
 571
 572 /*-------------------------------------------------------------------------*/
 573
 574 static void spi_set_cs(struct spi_device *spi, bool enable)
 575 {
 576         if (spi->mode & SPI_CS_HIGH)
 577                 enable = !enable;
 578
 579         if (spi->cs_gpio >= 0)
 580                 gpio_set_value(spi->cs_gpio, !enable);
 581         else if (spi->master->set_cs)
 582                 spi->master->set_cs(spi, !enable);
 583 }
 584
 585 static int spi_map_buf(struct spi_master *master, struct device *dev,
 586                        struct sg_table *sgt, void *buf, size_t len,
 587                        enum dma_data_direction dir)
 588 {
 589         const bool vmalloced_buf = is_vmalloc_addr(buf);
 590         const int desc_len = vmalloced_buf ? PAGE_SIZE : master->max_dma_len;
 591         const int sgs = DIV_ROUND_UP(len, desc_len);
 592         struct page *vm_page;
 593         void *sg_buf;
 594         size_t min;
 595         int i, ret;
 596
 597         ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
 598         if (ret != 0)
 599                 return ret;
 600
 601         for (i = 0; i < sgs; i++) {
 602                 min = min_t(size_t, len, desc_len);
 603
 604                 if (vmalloced_buf) {
 605                         vm_page = vmalloc_to_page(buf);
 606                         if (!vm_page) {
 607                                 sg_free_table(sgt);
 608                                 return -ENOMEM;
 609                         }
 610                         sg_buf = page_address(vm_page) +
 611                                 ((size_t)buf & ~PAGE_MASK);
 612                 } else {
 613                         sg_buf = buf;
 614                 }
 615
 616                 sg_set_buf(&sgt->sgl[i], sg_buf, min);
 617
 618                 buf += min;
 619                 len -= min;
 620         }
 621
 622         ret = dma_map_sg(dev, sgt->sgl, sgt->nents, dir);
 623         if (ret < 0) {
 624                 sg_free_table(sgt);
 625                 return ret;
 626         }
 627
 628         sgt->nents = ret;
 629
 630         return 0;
 631 }
 632
 633 static void spi_unmap_buf(struct spi_master *master, struct device *dev,
 634                           struct sg_table *sgt, enum dma_data_direction dir)
 635 {
 636         if (sgt->orig_nents) {
 637                 dma_unmap_sg(dev, sgt->sgl, sgt->orig_nents, dir);
 638                 sg_free_table(sgt);
 639         }
 640 }
 641
 642 static int spi_map_msg(struct spi_master *master, struct spi_message *msg)
 643 {
 644         struct device *tx_dev, *rx_dev;
 645         struct spi_transfer *xfer;
 646         void *tmp;
 647         size_t max_tx, max_rx;
 648         int ret;
 649
 650         if (master->flags & (SPI_MASTER_MUST_RX | SPI_MASTER_MUST_TX)) {
 651                 max_tx = 0;
 652                 max_rx = 0;
 653
 654                 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 655                         if ((master->flags & SPI_MASTER_MUST_TX) &&
 656                             !xfer->tx_buf)
 657                                 max_tx = max(xfer->len, max_tx);
 658                         if ((master->flags & SPI_MASTER_MUST_RX) &&
 659                             !xfer->rx_buf)
 660                                 max_rx = max(xfer->len, max_rx);
 661                 }
 662
 663                 if (max_tx) {
 664                         tmp = krealloc(master->dummy_tx, max_tx,
 665                                        GFP_KERNEL | GFP_DMA);
 666                         if (!tmp)
 667                                 return -ENOMEM;
 668                         master->dummy_tx = tmp;
 669                         memset(tmp, 0, max_tx);
 670                 }
 671
 672                 if (max_rx) {
 673                         tmp = krealloc(master->dummy_rx, max_rx,
 674                                        GFP_KERNEL | GFP_DMA);
 675                         if (!tmp)
 676                                 return -ENOMEM;
 677                         master->dummy_rx = tmp;
 678                 }
 679
 680                 if (max_tx || max_rx) {
 681                         list_for_each_entry(xfer, &msg->transfers,
 682                                             transfer_list) {
 683                                 if (!xfer->tx_buf)
 684                                         xfer->tx_buf = master->dummy_tx;
 685                                 if (!xfer->rx_buf)
 686                                         xfer->rx_buf = master->dummy_rx;
 687                         }
 688                 }
 689         }
 690
 691         if (!master->can_dma)
 692                 return 0;
 693
 694         tx_dev = &master->dma_tx->dev->device;
 695         rx_dev = &master->dma_rx->dev->device;
 696
 697         list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 698                 if (!master->can_dma(master, msg->spi, xfer))
 699                         continue;
 700
 701                 if (xfer->tx_buf != NULL) {
 702                         ret = spi_map_buf(master, tx_dev, &xfer->tx_sg,
 703                                           (void *)xfer->tx_buf, xfer->len,
 704                                           DMA_TO_DEVICE);
 705                         if (ret != 0)
 706                                 return ret;
 707                 }
 708
 709                 if (xfer->rx_buf != NULL) {
 710                         ret = spi_map_buf(master, rx_dev, &xfer->rx_sg,
 711                                           xfer->rx_buf, xfer->len,
 712                                           DMA_FROM_DEVICE);
 713                         if (ret != 0) {
 714                                 spi_unmap_buf(master, tx_dev, &xfer->tx_sg,
 715                                               DMA_TO_DEVICE);
 716                                 return ret;
 717                         }
 718                 }
 719         }
 720
 721         master->cur_msg_mapped = true;
 722
 723         return 0;
 724 }
 725
 726 static int spi_unmap_msg(struct spi_master *master, struct spi_message *msg)
 727 {
 728         struct spi_transfer *xfer;
 729         struct device *tx_dev, *rx_dev;
 730
 731         if (!master->cur_msg_mapped || !master->can_dma)
 732                 return 0;
 733
 734         tx_dev = &master->dma_tx->dev->device;
 735         rx_dev = &master->dma_rx->dev->device;
 736
 737         list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 738                 if (!master->can_dma(master, msg->spi, xfer))
 739                         continue;
 740
 741                 spi_unmap_buf(master, rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
 742                 spi_unmap_buf(master, tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
 743         }
 744
 745         return 0;
 746 }
 747
 748 /*
 749  * spi_transfer_one_message - Default implementation of transfer_one_message()
 750  *
 751  * This is a standard implementation of transfer_one_message() for
 752  * drivers which impelment a transfer_one() operation.  It provides
 753  * standard handling of delays and chip select management.
 754  */
 755 static int spi_transfer_one_message(struct spi_master *master,
 756                                     struct spi_message *msg)
 757 {
 758         struct spi_transfer *xfer;
 759         bool cur_cs = true;
 760         bool keep_cs = false;
 761         int ret = 0;
 762
 763         spi_set_cs(msg->spi, true);
 764
 765         list_for_each_entry(xfer, &msg->transfers, transfer_list) {
 766                 trace_spi_transfer_start(msg, xfer);
 767
 768                 reinit_completion(&master->xfer_completion);
 769
 770                 ret = master->transfer_one(master, msg->spi, xfer);
 771                 if (ret < 0) {
 772                         dev_err(&msg->spi->dev,
 773                                 "SPI transfer failed: %d\n", ret);
 774                         goto out;
 775                 }
 776
 777                 if (ret > 0) {
 778                         ret = 0;
 779                         wait_for_completion(&master->xfer_completion);
 780                 }
 781
 782                 trace_spi_transfer_stop(msg, xfer);
 783
 784                 if (msg->status != -EINPROGRESS)
 785                         goto out;
 786
 787                 if (xfer->delay_usecs)
 788                         udelay(xfer->delay_usecs);
 789
 790                 if (xfer->cs_change) {
 791                         if (list_is_last(&xfer->transfer_list,
 792                                          &msg->transfers)) {
 793                                 keep_cs = true;
 794                         } else {
 795                                 cur_cs = !cur_cs;
 796                                 spi_set_cs(msg->spi, cur_cs);
 797                         }
 798                 }
 799
 800                 msg->actual_length += xfer->len;
 801         }
 802
 803 out:
 804         if (ret != 0 || !keep_cs)
 805                 spi_set_cs(msg->spi, false);
 806
 807         if (msg->status == -EINPROGRESS)
 808                 msg->status = ret;
 809
 810         spi_finalize_current_message(master);
 811
 812         return ret;
 813 }
 814
 815 /**
 816  * spi_finalize_current_transfer - report completion of a transfer
 817  *
 818  * Called by SPI drivers using the core transfer_one_message()
 819  * implementation to notify it that the current interrupt driven
 820  * transfer has finished and the next one may be scheduled.
 821  */
 822 void spi_finalize_current_transfer(struct spi_master *master)
 823 {
 824         complete(&master->xfer_completion);
 825 }
 826 EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
 827
 828 /**
 829  * spi_pump_messages - kthread work function which processes spi message queue
 830  * @work: pointer to kthread work struct contained in the master struct
 831  *
 832  * This function checks if there is any spi message in the queue that
 833  * needs processing and if so call out to the driver to initialize hardware
 834  * and transfer each message.
 835  *
 836  */
 837 static void spi_pump_messages(struct kthread_work *work)
 838 {
 839         struct spi_master *master =
 840                 container_of(work, struct spi_master, pump_messages);
 841         unsigned long flags;
 842         bool was_busy = false;
 843         int ret;
 844
 845         /* Lock queue and check for queue work */
 846         spin_lock_irqsave(&master->queue_lock, flags);
 847         if (list_empty(&master->queue) || !master->running) {
 848                 if (!master->busy) {
 849                         spin_unlock_irqrestore(&master->queue_lock, flags);
 850                         return;
 851                 }
 852                 master->busy = false;
 853                 spin_unlock_irqrestore(&master->queue_lock, flags);
 854                 kfree(master->dummy_rx);
 855                 master->dummy_rx = NULL;
 856                 kfree(master->dummy_tx);
 857                 master->dummy_tx = NULL;
 858                 if (master->unprepare_transfer_hardware &&
 859                     master->unprepare_transfer_hardware(master))
 860                         dev_err(&master->dev,
 861                                 "failed to unprepare transfer hardware\n");
 862                 if (master->auto_runtime_pm) {
 863                         pm_runtime_mark_last_busy(master->dev.parent);
 864                         pm_runtime_put_autosuspend(master->dev.parent);
 865                 }
 866                 trace_spi_master_idle(master);
 867                 return;
 868         }
 869
 870         /* Make sure we are not already running a message */
 871         if (master->cur_msg) {
 872                 spin_unlock_irqrestore(&master->queue_lock, flags);
 873                 return;
 874         }
 875         /* Extract head of queue */
 876         master->cur_msg =
 877                 list_first_entry(&master->queue, struct spi_message, queue);
 878
 879         list_del_init(&master->cur_msg->queue);
 880         if (master->busy)
 881                 was_busy = true;
 882         else
 883                 master->busy = true;
 884         spin_unlock_irqrestore(&master->queue_lock, flags);
 885
 886         if (!was_busy && master->auto_runtime_pm) {
 887                 ret = pm_runtime_get_sync(master->dev.parent);
 888                 if (ret < 0) {
 889                         dev_err(&master->dev, "Failed to power device: %d\n",
 890                                 ret);
 891                         return;
 892                 }
 893         }
 894
 895         if (!was_busy)
 896                 trace_spi_master_busy(master);
 897
 898         if (!was_busy && master->prepare_transfer_hardware) {
 899                 ret = master->prepare_transfer_hardware(master);
 900                 if (ret) {
 901                         dev_err(&master->dev,
 902                                 "failed to prepare transfer hardware\n");
 903
 904                         if (master->auto_runtime_pm)
 905                                 pm_runtime_put(master->dev.parent);
 906                         return;
 907                 }
 908         }
 909
 910         trace_spi_message_start(master->cur_msg);
 911
 912         if (master->prepare_message) {
 913                 ret = master->prepare_message(master, master->cur_msg);
 914                 if (ret) {
 915                         dev_err(&master->dev,
 916                                 "failed to prepare message: %d\n", ret);
 917                         master->cur_msg->status = ret;
 918                         spi_finalize_current_message(master);
 919                         return;
 920                 }
 921                 master->cur_msg_prepared = true;
 922         }
 923
 924         ret = spi_map_msg(master, master->cur_msg);
 925         if (ret) {
 926                 master->cur_msg->status = ret;
 927                 spi_finalize_current_message(master);
 928                 return;
 929         }
 930
 931         ret = master->transfer_one_message(master, master->cur_msg);
 932         if (ret) {
 933                 dev_err(&master->dev,
 934                         "failed to transfer one message from queue\n");
 935                 return;
 936         }
 937 }
 938
 939 static int spi_init_queue(struct spi_master *master)
 940 {
 941         struct sched_param param = { .sched_priority = MAX_RT_PRIO - 1 };
 942
 943         INIT_LIST_HEAD(&master->queue);
 944         spin_lock_init(&master->queue_lock);
 945
 946         master->running = false;
 947         master->busy = false;
 948
 949         init_kthread_worker(&master->kworker);
 950         master->kworker_task = kthread_run(kthread_worker_fn,
 951                                            &master->kworker, "%s",
 952                                            dev_name(&master->dev));
 953         if (IS_ERR(master->kworker_task)) {
 954                 dev_err(&master->dev, "failed to create message pump task\n");
 955                 return -ENOMEM;
 956         }
 957         init_kthread_work(&master->pump_messages, spi_pump_messages);
 958
 959         /*
 960          * Master config will indicate if this controller should run the
 961          * message pump with high (realtime) priority to reduce the transfer
 962          * latency on the bus by minimising the delay between a transfer
 963          * request and the scheduling of the message pump thread. Without this
 964          * setting the message pump thread will remain at default priority.
 965          */
 966         if (master->rt) {
 967                 dev_info(&master->dev,
 968                         "will run message pump with realtime priority\n");
 969                 sched_setscheduler(master->kworker_task, SCHED_FIFO, &param);
 970         }
 971
 972         return 0;
 973 }
 974
 975 /**
 976  * spi_get_next_queued_message() - called by driver to check for queued
 977  * messages
 978  * @master: the master to check for queued messages
 979  *
 980  * If there are more messages in the queue, the next message is returned from
 981  * this call.
 982  */
 983 struct spi_message *spi_get_next_queued_message(struct spi_master *master)
 984 {
 985         struct spi_message *next;
 986         unsigned long flags;
 987
 988         /* get a pointer to the next message, if any */
 989         spin_lock_irqsave(&master->queue_lock, flags);
 990         next = list_first_entry_or_null(&master->queue, struct spi_message,
 991                                         queue);
 992         spin_unlock_irqrestore(&master->queue_lock, flags);
 993
 994         return next;
 995 }
 996 EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
 997
 998 /**
 999  * spi_finalize_current_message() - the current message is complete
1000  * @master: the master to return the message to
1001  *
1002  * Called by the driver to notify the core that the message in the front of the
1003  * queue is complete and can be removed from the queue.
1004  */
1005 void spi_finalize_current_message(struct spi_master *master)
1006 {
1007         struct spi_message *mesg;
1008         unsigned long flags;
1009         int ret;
1010
1011         spin_lock_irqsave(&master->queue_lock, flags);
1012         mesg = master->cur_msg;
1013         master->cur_msg = NULL;
1014
1015         queue_kthread_work(&master->kworker, &master->pump_messages);
1016         spin_unlock_irqrestore(&master->queue_lock, flags);
1017
1018         spi_unmap_msg(master, mesg);
1019
1020         if (master->cur_msg_prepared && master->unprepare_message) {
1021                 ret = master->unprepare_message(master, mesg);
1022                 if (ret) {
1023                         dev_err(&master->dev,
1024                                 "failed to unprepare message: %d\n", ret);
1025                 }
1026         }
1027         master->cur_msg_prepared = false;
1028
1029         mesg->state = NULL;
1030         if (mesg->complete)
1031                 mesg->complete(mesg->context);
1032
1033         trace_spi_message_done(mesg);
1034 }
1035 EXPORT_SYMBOL_GPL(spi_finalize_current_message);
1036
1037 static int spi_start_queue(struct spi_master *master)
1038 {
1039         unsigned long flags;
1040
1041         spin_lock_irqsave(&master->queue_lock, flags);
1042
1043         if (master->running || master->busy) {
1044                 spin_unlock_irqrestore(&master->queue_lock, flags);
1045                 return -EBUSY;
1046         }
1047
1048         master->running = true;
1049         master->cur_msg = NULL;
1050         spin_unlock_irqrestore(&master->queue_lock, flags);
1051
1052         queue_kthread_work(&master->kworker, &master->pump_messages);
1053
1054         return 0;
1055 }
1056
1057 static int spi_stop_queue(struct spi_master *master)
1058 {
1059         unsigned long flags;
1060         unsigned limit = 500;
1061         int ret = 0;
1062
1063         spin_lock_irqsave(&master->queue_lock, flags);
1064
1065         /*
1066          * This is a bit lame, but is optimized for the common execution path.
1067          * A wait_queue on the master->busy could be used, but then the common
1068          * execution path (pump_messages) would be required to call wake_up or
1069          * friends on every SPI message. Do this instead.
1070          */
1071         while ((!list_empty(&master->queue) || master->busy) && limit--) {
1072                 spin_unlock_irqrestore(&master->queue_lock, flags);
1073                 msleep(10);
1074                 spin_lock_irqsave(&master->queue_lock, flags);
1075         }
1076
1077         if (!list_empty(&master->queue) || master->busy)
1078                 ret = -EBUSY;
1079         else
1080                 master->running = false;
1081
1082         spin_unlock_irqrestore(&master->queue_lock, flags);
1083
1084         if (ret) {
1085                 dev_warn(&master->dev,
1086                          "could not stop message queue\n");
1087                 return ret;
1088         }
1089         return ret;
1090 }
1091
1092 static int spi_destroy_queue(struct spi_master *master)
1093 {
1094         int ret;
1095
1096         ret = spi_stop_queue(master);
1097
1098         /*
1099          * flush_kthread_worker will block until all work is done.
1100          * If the reason that stop_queue timed out is that the work will never
1101          * finish, then it does no good to call flush/stop thread, so
1102          * return anyway.
1103          */
1104         if (ret) {
1105                 dev_err(&master->dev, "problem destroying queue\n");
1106                 return ret;
1107         }
1108
1109         flush_kthread_worker(&master->kworker);
1110         kthread_stop(master->kworker_task);
1111
1112         return 0;
1113 }
1114
1115 /**
1116  * spi_queued_transfer - transfer function for queued transfers
1117  * @spi: spi device which is requesting transfer
1118  * @msg: spi message which is to handled is queued to driver queue
1119  */
1120 static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
1121 {
1122         struct spi_master *master = spi->master;
1123         unsigned long flags;
1124
1125         spin_lock_irqsave(&master->queue_lock, flags);
1126
1127         if (!master->running) {
1128                 spin_unlock_irqrestore(&master->queue_lock, flags);
1129                 return -ESHUTDOWN;
1130         }
1131         msg->actual_length = 0;
1132         msg->status = -EINPROGRESS;
1133
1134         list_add_tail(&msg->queue, &master->queue);
1135         if (!master->busy)
1136                 queue_kthread_work(&master->kworker, &master->pump_messages);
1137
1138         spin_unlock_irqrestore(&master->queue_lock, flags);
1139         return 0;
1140 }
1141
1142 static int spi_master_initialize_queue(struct spi_master *master)
1143 {
1144         int ret;
1145
1146         master->queued = true;
1147         master->transfer = spi_queued_transfer;
1148         if (!master->transfer_one_message)
1149                 master->transfer_one_message = spi_transfer_one_message;
1150
1151         /* Initialize and start queue */
1152         ret = spi_init_queue(master);
1153         if (ret) {
1154                 dev_err(&master->dev, "problem initializing queue\n");
1155                 goto err_init_queue;
1156         }
1157         ret = spi_start_queue(master);
1158         if (ret) {
1159                 dev_err(&master->dev, "problem starting queue\n");
1160                 goto err_start_queue;
1161         }
1162
1163         return 0;
1164
1165 err_start_queue:
1166 err_init_queue:
1167         spi_destroy_queue(master);
1168         return ret;
1169 }
1170
1171 /*-------------------------------------------------------------------------*/
1172
1173 #if defined(CONFIG_OF)
1174 /**
1175  * of_register_spi_devices() - Register child devices onto the SPI bus
1176  * @master:     Pointer to spi_master device
1177  *
1178  * Registers an spi_device for each child node of master node which has a 'reg'
1179  * property.
1180  */
1181 static void of_register_spi_devices(struct spi_master *master)
1182 {
1183         struct spi_device *spi;
1184         struct device_node *nc;
1185         int rc;
1186         u32 value;
1187
1188         if (!master->dev.of_node)
1189                 return;
1190
1191         for_each_available_child_of_node(master->dev.of_node, nc) {
1192                 /* Alloc an spi_device */
1193                 spi = spi_alloc_device(master);
1194                 if (!spi) {
1195                         dev_err(&master->dev, "spi_device alloc error for %s\n",
1196                                 nc->full_name);
1197                         spi_dev_put(spi);
1198                         continue;
1199                 }
1200
1201                 /* Select device driver */
1202                 if (of_modalias_node(nc, spi->modalias,
1203                                      sizeof(spi->modalias)) < 0) {
1204                         dev_err(&master->dev, "cannot find modalias for %s\n",
1205                                 nc->full_name);
1206                         spi_dev_put(spi);
1207                         continue;
1208                 }
1209
1210                 /* Device address */
1211                 rc = of_property_read_u32(nc, "reg", &value);
1212                 if (rc) {
1213                         dev_err(&master->dev, "%s has no valid 'reg' property (%d)\n",
1214                                 nc->full_name, rc);
1215                         spi_dev_put(spi);
1216                         continue;
1217                 }
1218                 spi->chip_select = value;
1219
1220                 /* Mode (clock phase/polarity/etc.) */
1221                 if (of_find_property(nc, "spi-cpha", NULL))
1222                         spi->mode |= SPI_CPHA;
1223                 if (of_find_property(nc, "spi-cpol", NULL))
1224                         spi->mode |= SPI_CPOL;
1225                 if (of_find_property(nc, "spi-cs-high", NULL))
1226                         spi->mode |= SPI_CS_HIGH;
1227                 if (of_find_property(nc, "spi-3wire", NULL))
1228                         spi->mode |= SPI_3WIRE;
1229
1230                 /* Device DUAL/QUAD mode */
1231                 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
1232                         switch (value) {
1233                         case 1:
1234                                 break;
1235                         case 2:
1236                                 spi->mode |= SPI_TX_DUAL;
1237                                 break;
1238                         case 4:
1239                                 spi->mode |= SPI_TX_QUAD;
1240                                 break;
1241                         default:
1242                                 dev_warn(&master->dev,
1243                                          "spi-tx-bus-width %d not supported\n",
1244                                          value);
1245                                 break;
1246                         }
1247                 }
1248
1249                 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
1250                         switch (value) {
1251                         case 1:
1252                                 break;
1253                         case 2:
1254                                 spi->mode |= SPI_RX_DUAL;
1255                                 break;
1256                         case 4:
1257                                 spi->mode |= SPI_RX_QUAD;
1258                                 break;
1259                         default:
1260                                 dev_warn(&master->dev,
1261                                          "spi-rx-bus-width %d not supported\n",
1262                                          value);
1263                                 break;
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, ugly_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         ugly_bits = bad_bits &
1770                     (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD);
1771         if (ugly_bits) {
1772                 dev_warn(&spi->dev,
1773                          "setup: ignoring unsupported mode bits %x\n",
1774                          ugly_bits);
1775                 spi->mode &= ~ugly_bits;
1776                 bad_bits &= ~ugly_bits;
1777         }
1778         if (bad_bits) {
1779                 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
1780                         bad_bits);
1781                 return -EINVAL;
1782         }
1783
1784         if (!spi->bits_per_word)
1785                 spi->bits_per_word = 8;
1786
1787         if (spi->master->setup)
1788                 status = spi->master->setup(spi);
1789
1790         dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s%u bits/w, %u Hz max --> %d\n",
1791                         (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
1792                         (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
1793                         (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
1794                         (spi->mode & SPI_3WIRE) ? "3wire, " : "",
1795                         (spi->mode & SPI_LOOP) ? "loopback, " : "",
1796                         spi->bits_per_word, spi->max_speed_hz,
1797                         status);
1798
1799         return status;
1800 }
1801 EXPORT_SYMBOL_GPL(spi_setup);
1802
1803 static int __spi_validate(struct spi_device *spi, struct spi_message *message)
1804 {
1805         struct spi_master *master = spi->master;
1806         struct spi_transfer *xfer;
1807
1808         if (list_empty(&message->transfers))
1809                 return -EINVAL;
1810         if (!message->complete)
1811                 return -EINVAL;
1812
1813         /* Half-duplex links include original MicroWire, and ones with
1814          * only one data pin like SPI_3WIRE (switches direction) or where
1815          * either MOSI or MISO is missing.  They can also be caused by
1816          * software limitations.
1817          */
1818         if ((master->flags & SPI_MASTER_HALF_DUPLEX)
1819                         || (spi->mode & SPI_3WIRE)) {
1820                 unsigned flags = master->flags;
1821
1822                 list_for_each_entry(xfer, &message->transfers, transfer_list) {
1823                         if (xfer->rx_buf && xfer->tx_buf)
1824                                 return -EINVAL;
1825                         if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
1826                                 return -EINVAL;
1827                         if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
1828                                 return -EINVAL;
1829                 }
1830         }
1831
1832         /**
1833          * Set transfer bits_per_word and max speed as spi device default if
1834          * it is not set for this transfer.
1835          * Set transfer tx_nbits and rx_nbits as single transfer default
1836          * (SPI_NBITS_SINGLE) if it is not set for this transfer.
1837          */
1838         list_for_each_entry(xfer, &message->transfers, transfer_list) {
1839                 message->frame_length += xfer->len;
1840                 if (!xfer->bits_per_word)
1841                         xfer->bits_per_word = spi->bits_per_word;
1842                 if (!xfer->speed_hz) {
1843                         xfer->speed_hz = spi->max_speed_hz;
1844                         if (master->max_speed_hz &&
1845                             xfer->speed_hz > master->max_speed_hz)
1846                                 xfer->speed_hz = master->max_speed_hz;
1847                 }
1848
1849                 if (master->bits_per_word_mask) {
1850                         /* Only 32 bits fit in the mask */
1851                         if (xfer->bits_per_word > 32)
1852                                 return -EINVAL;
1853                         if (!(master->bits_per_word_mask &
1854                                         BIT(xfer->bits_per_word - 1)))
1855                                 return -EINVAL;
1856                 }
1857
1858                 if (xfer->speed_hz && master->min_speed_hz &&
1859                     xfer->speed_hz < master->min_speed_hz)
1860                         return -EINVAL;
1861                 if (xfer->speed_hz && master->max_speed_hz &&
1862                     xfer->speed_hz > master->max_speed_hz)
1863                         return -EINVAL;
1864
1865                 if (xfer->tx_buf && !xfer->tx_nbits)
1866                         xfer->tx_nbits = SPI_NBITS_SINGLE;
1867                 if (xfer->rx_buf && !xfer->rx_nbits)
1868                         xfer->rx_nbits = SPI_NBITS_SINGLE;
1869                 /* check transfer tx/rx_nbits:
1870                  * 1. check the value matches one of single, dual and quad
1871                  * 2. check tx/rx_nbits match the mode in spi_device
1872                  */
1873                 if (xfer->tx_buf) {
1874                         if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
1875                                 xfer->tx_nbits != SPI_NBITS_DUAL &&
1876                                 xfer->tx_nbits != SPI_NBITS_QUAD)
1877                                 return -EINVAL;
1878                         if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
1879                                 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
1880                                 return -EINVAL;
1881                         if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
1882                                 !(spi->mode & SPI_TX_QUAD))
1883                                 return -EINVAL;
1884                 }
1885                 /* check transfer rx_nbits */
1886                 if (xfer->rx_buf) {
1887                         if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
1888                                 xfer->rx_nbits != SPI_NBITS_DUAL &&
1889                                 xfer->rx_nbits != SPI_NBITS_QUAD)
1890                                 return -EINVAL;
1891                         if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
1892                                 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
1893                                 return -EINVAL;
1894                         if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
1895                                 !(spi->mode & SPI_RX_QUAD))
1896                                 return -EINVAL;
1897                 }
1898         }
1899
1900         message->status = -EINPROGRESS;
1901
1902         return 0;
1903 }
1904
1905 static int __spi_async(struct spi_device *spi, struct spi_message *message)
1906 {
1907         struct spi_master *master = spi->master;
1908
1909         message->spi = spi;
1910
1911         trace_spi_message_submit(message);
1912
1913         return master->transfer(spi, message);
1914 }
1915
1916 /**
1917  * spi_async - asynchronous SPI transfer
1918  * @spi: device with which data will be exchanged
1919  * @message: describes the data transfers, including completion callback
1920  * Context: any (irqs may be blocked, etc)
1921  *
1922  * This call may be used in_irq and other contexts which can't sleep,
1923  * as well as from task contexts which can sleep.
1924  *
1925  * The completion callback is invoked in a context which can't sleep.
1926  * Before that invocation, the value of message->status is undefined.
1927  * When the callback is issued, message->status holds either zero (to
1928  * indicate complete success) or a negative error code.  After that
1929  * callback returns, the driver which issued the transfer request may
1930  * deallocate the associated memory; it's no longer in use by any SPI
1931  * core or controller driver code.
1932  *
1933  * Note that although all messages to a spi_device are handled in
1934  * FIFO order, messages may go to different devices in other orders.
1935  * Some device might be higher priority, or have various "hard" access
1936  * time requirements, for example.
1937  *
1938  * On detection of any fault during the transfer, processing of
1939  * the entire message is aborted, and the device is deselected.
1940  * Until returning from the associated message completion callback,
1941  * no other spi_message queued to that device will be processed.
1942  * (This rule applies equally to all the synchronous transfer calls,
1943  * which are wrappers around this core asynchronous primitive.)
1944  */
1945 int spi_async(struct spi_device *spi, struct spi_message *message)
1946 {
1947         struct spi_master *master = spi->master;
1948         int ret;
1949         unsigned long flags;
1950
1951         ret = __spi_validate(spi, message);
1952         if (ret != 0)
1953                 return ret;
1954
1955         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
1956
1957         if (master->bus_lock_flag)
1958                 ret = -EBUSY;
1959         else
1960                 ret = __spi_async(spi, message);
1961
1962         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
1963
1964         return ret;
1965 }
1966 EXPORT_SYMBOL_GPL(spi_async);
1967
1968 /**
1969  * spi_async_locked - version of spi_async with exclusive bus usage
1970  * @spi: device with which data will be exchanged
1971  * @message: describes the data transfers, including completion callback
1972  * Context: any (irqs may be blocked, etc)
1973  *
1974  * This call may be used in_irq and other contexts which can't sleep,
1975  * as well as from task contexts which can sleep.
1976  *
1977  * The completion callback is invoked in a context which can't sleep.
1978  * Before that invocation, the value of message->status is undefined.
1979  * When the callback is issued, message->status holds either zero (to
1980  * indicate complete success) or a negative error code.  After that
1981  * callback returns, the driver which issued the transfer request may
1982  * deallocate the associated memory; it's no longer in use by any SPI
1983  * core or controller driver code.
1984  *
1985  * Note that although all messages to a spi_device are handled in
1986  * FIFO order, messages may go to different devices in other orders.
1987  * Some device might be higher priority, or have various "hard" access
1988  * time requirements, for example.
1989  *
1990  * On detection of any fault during the transfer, processing of
1991  * the entire message is aborted, and the device is deselected.
1992  * Until returning from the associated message completion callback,
1993  * no other spi_message queued to that device will be processed.
1994  * (This rule applies equally to all the synchronous transfer calls,
1995  * which are wrappers around this core asynchronous primitive.)
1996  */
1997 int spi_async_locked(struct spi_device *spi, struct spi_message *message)
1998 {
1999         struct spi_master *master = spi->master;
2000         int ret;
2001         unsigned long flags;
2002
2003         ret = __spi_validate(spi, message);
2004         if (ret != 0)
2005                 return ret;
2006
2007         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2008
2009         ret = __spi_async(spi, message);
2010
2011         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2012
2013         return ret;
2014
2015 }
2016 EXPORT_SYMBOL_GPL(spi_async_locked);
2017
2018
2019 /*-------------------------------------------------------------------------*/
2020
2021 /* Utility methods for SPI master protocol drivers, layered on
2022  * top of the core.  Some other utility methods are defined as
2023  * inline functions.
2024  */
2025
2026 static void spi_complete(void *arg)
2027 {
2028         complete(arg);
2029 }
2030
2031 static int __spi_sync(struct spi_device *spi, struct spi_message *message,
2032                       int bus_locked)
2033 {
2034         DECLARE_COMPLETION_ONSTACK(done);
2035         int status;
2036         struct spi_master *master = spi->master;
2037
2038         message->complete = spi_complete;
2039         message->context = &done;
2040
2041         if (!bus_locked)
2042                 mutex_lock(&master->bus_lock_mutex);
2043
2044         status = spi_async_locked(spi, message);
2045
2046         if (!bus_locked)
2047                 mutex_unlock(&master->bus_lock_mutex);
2048
2049         if (status == 0) {
2050                 wait_for_completion(&done);
2051                 status = message->status;
2052         }
2053         message->context = NULL;
2054         return status;
2055 }
2056
2057 /**
2058  * spi_sync - blocking/synchronous SPI data transfers
2059  * @spi: device with which data will be exchanged
2060  * @message: describes the data transfers
2061  * Context: can sleep
2062  *
2063  * This call may only be used from a context that may sleep.  The sleep
2064  * is non-interruptible, and has no timeout.  Low-overhead controller
2065  * drivers may DMA directly into and out of the message buffers.
2066  *
2067  * Note that the SPI device's chip select is active during the message,
2068  * and then is normally disabled between messages.  Drivers for some
2069  * frequently-used devices may want to minimize costs of selecting a chip,
2070  * by leaving it selected in anticipation that the next message will go
2071  * to the same chip.  (That may increase power usage.)
2072  *
2073  * Also, the caller is guaranteeing that the memory associated with the
2074  * message will not be freed before this call returns.
2075  *
2076  * It returns zero on success, else a negative error code.
2077  */
2078 int spi_sync(struct spi_device *spi, struct spi_message *message)
2079 {
2080         return __spi_sync(spi, message, 0);
2081 }
2082 EXPORT_SYMBOL_GPL(spi_sync);
2083
2084 /**
2085  * spi_sync_locked - version of spi_sync with exclusive bus usage
2086  * @spi: device with which data will be exchanged
2087  * @message: describes the data transfers
2088  * Context: can sleep
2089  *
2090  * This call may only be used from a context that may sleep.  The sleep
2091  * is non-interruptible, and has no timeout.  Low-overhead controller
2092  * drivers may DMA directly into and out of the message buffers.
2093  *
2094  * This call should be used by drivers that require exclusive access to the
2095  * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
2096  * be released by a spi_bus_unlock call when the exclusive access is over.
2097  *
2098  * It returns zero on success, else a negative error code.
2099  */
2100 int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
2101 {
2102         return __spi_sync(spi, message, 1);
2103 }
2104 EXPORT_SYMBOL_GPL(spi_sync_locked);
2105
2106 /**
2107  * spi_bus_lock - obtain a lock for exclusive SPI bus usage
2108  * @master: SPI bus master that should be locked for exclusive bus access
2109  * Context: can sleep
2110  *
2111  * This call may only be used from a context that may sleep.  The sleep
2112  * is non-interruptible, and has no timeout.
2113  *
2114  * This call should be used by drivers that require exclusive access to the
2115  * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
2116  * exclusive access is over. Data transfer must be done by spi_sync_locked
2117  * and spi_async_locked calls when the SPI bus lock is held.
2118  *
2119  * It returns zero on success, else a negative error code.
2120  */
2121 int spi_bus_lock(struct spi_master *master)
2122 {
2123         unsigned long flags;
2124
2125         mutex_lock(&master->bus_lock_mutex);
2126
2127         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2128         master->bus_lock_flag = 1;
2129         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2130
2131         /* mutex remains locked until spi_bus_unlock is called */
2132
2133         return 0;
2134 }
2135 EXPORT_SYMBOL_GPL(spi_bus_lock);
2136
2137 /**
2138  * spi_bus_unlock - release the lock for exclusive SPI bus usage
2139  * @master: SPI bus master that was locked for exclusive bus access
2140  * Context: can sleep
2141  *
2142  * This call may only be used from a context that may sleep.  The sleep
2143  * is non-interruptible, and has no timeout.
2144  *
2145  * This call releases an SPI bus lock previously obtained by an spi_bus_lock
2146  * call.
2147  *
2148  * It returns zero on success, else a negative error code.
2149  */
2150 int spi_bus_unlock(struct spi_master *master)
2151 {
2152         master->bus_lock_flag = 0;
2153
2154         mutex_unlock(&master->bus_lock_mutex);
2155
2156         return 0;
2157 }
2158 EXPORT_SYMBOL_GPL(spi_bus_unlock);
2159
2160 /* portable code must never pass more than 32 bytes */
2161 #define SPI_BUFSIZ      max(32, SMP_CACHE_BYTES)
2162
2163 static u8       *buf;
2164
2165 /**
2166  * spi_write_then_read - SPI synchronous write followed by read
2167  * @spi: device with which data will be exchanged
2168  * @txbuf: data to be written (need not be dma-safe)
2169  * @n_tx: size of txbuf, in bytes
2170  * @rxbuf: buffer into which data will be read (need not be dma-safe)
2171  * @n_rx: size of rxbuf, in bytes
2172  * Context: can sleep
2173  *
2174  * This performs a half duplex MicroWire style transaction with the
2175  * device, sending txbuf and then reading rxbuf.  The return value
2176  * is zero for success, else a negative errno status code.
2177  * This call may only be used from a context that may sleep.
2178  *
2179  * Parameters to this routine are always copied using a small buffer;
2180  * portable code should never use this for more than 32 bytes.
2181  * Performance-sensitive or bulk transfer code should instead use
2182  * spi_{async,sync}() calls with dma-safe buffers.
2183  */
2184 int spi_write_then_read(struct spi_device *spi,
2185                 const void *txbuf, unsigned n_tx,
2186                 void *rxbuf, unsigned n_rx)
2187 {
2188         static DEFINE_MUTEX(lock);
2189
2190         int                     status;
2191         struct spi_message      message;
2192         struct spi_transfer     x[2];
2193         u8                      *local_buf;
2194
2195         /* Use preallocated DMA-safe buffer if we can.  We can't avoid
2196          * copying here, (as a pure convenience thing), but we can
2197          * keep heap costs out of the hot path unless someone else is
2198          * using the pre-allocated buffer or the transfer is too large.
2199          */
2200         if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
2201                 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
2202                                     GFP_KERNEL | GFP_DMA);
2203                 if (!local_buf)
2204                         return -ENOMEM;
2205         } else {
2206                 local_buf = buf;
2207         }
2208
2209         spi_message_init(&message);
2210         memset(x, 0, sizeof(x));
2211         if (n_tx) {
2212                 x[0].len = n_tx;
2213                 spi_message_add_tail(&x[0], &message);
2214         }
2215         if (n_rx) {
2216                 x[1].len = n_rx;
2217                 spi_message_add_tail(&x[1], &message);
2218         }
2219
2220         memcpy(local_buf, txbuf, n_tx);
2221         x[0].tx_buf = local_buf;
2222         x[1].rx_buf = local_buf + n_tx;
2223
2224         /* do the i/o */
2225         status = spi_sync(spi, &message);
2226         if (status == 0)
2227                 memcpy(rxbuf, x[1].rx_buf, n_rx);
2228
2229         if (x[0].tx_buf == buf)
2230                 mutex_unlock(&lock);
2231         else
2232                 kfree(local_buf);
2233
2234         return status;
2235 }
2236 EXPORT_SYMBOL_GPL(spi_write_then_read);
2237
2238 /*-------------------------------------------------------------------------*/
2239
2240 static int __init spi_init(void)
2241 {
2242         int     status;
2243
2244         buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
2245         if (!buf) {
2246                 status = -ENOMEM;
2247                 goto err0;
2248         }
2249
2250         status = bus_register(&spi_bus_type);
2251         if (status < 0)
2252                 goto err1;
2253
2254         status = class_register(&spi_master_class);
2255         if (status < 0)
2256                 goto err2;
2257         return 0;
2258
2259 err2:
2260         bus_unregister(&spi_bus_type);
2261 err1:
2262         kfree(buf);
2263         buf = NULL;
2264 err0:
2265         return status;
2266 }
2267
2268 /* board_info is normally registered in arch_initcall(),
2269  * but even essential drivers wait till later
2270  *
2271  * REVISIT only boardinfo really needs static linking. the rest (device and
2272  * driver registration) _could_ be dynamically linked (modular) ... costs
2273  * include needing to have boardinfo data structures be much more public.
2274  */
2275 postcore_initcall(spi_init);
2276