Merge remote-tracking branch 'lsk/v3.10/topic/arm64-topology' into linux-linaro-lsk
[firefly-linux-kernel-4.4.55.git] / 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/mutex.h>
28 #include <linux/of_device.h>
29 #include <linux/of_irq.h>
30 #include <linux/slab.h>
31 #include <linux/mod_devicetable.h>
32 #include <linux/spi/spi.h>
33 #include <linux/of_gpio.h>
34 #include <linux/pm_runtime.h>
35 #include <linux/export.h>
36 #include <linux/sched/rt.h>
37 #include <linux/delay.h>
38 #include <linux/kthread.h>
39 #include <linux/ioport.h>
40 #include <linux/acpi.h>
41
42 static void spidev_release(struct device *dev)
43 {
44         struct spi_device       *spi = to_spi_device(dev);
45
46         /* spi masters may cleanup for released devices */
47         if (spi->master->cleanup)
48                 spi->master->cleanup(spi);
49
50         spi_master_put(spi->master);
51         kfree(spi);
52 }
53
54 static ssize_t
55 modalias_show(struct device *dev, struct device_attribute *a, char *buf)
56 {
57         const struct spi_device *spi = to_spi_device(dev);
58
59         return sprintf(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
60 }
61
62 static struct device_attribute spi_dev_attrs[] = {
63         __ATTR_RO(modalias),
64         __ATTR_NULL,
65 };
66
67 /* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
68  * and the sysfs version makes coldplug work too.
69  */
70
71 static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
72                                                 const struct spi_device *sdev)
73 {
74         while (id->name[0]) {
75                 if (!strcmp(sdev->modalias, id->name))
76                         return id;
77                 id++;
78         }
79         return NULL;
80 }
81
82 const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
83 {
84         const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
85
86         return spi_match_id(sdrv->id_table, sdev);
87 }
88 EXPORT_SYMBOL_GPL(spi_get_device_id);
89
90 static int spi_match_device(struct device *dev, struct device_driver *drv)
91 {
92         const struct spi_device *spi = to_spi_device(dev);
93         const struct spi_driver *sdrv = to_spi_driver(drv);
94
95         /* Attempt an OF style match */
96         if (of_driver_match_device(dev, drv))
97                 return 1;
98
99         /* Then try ACPI */
100         if (acpi_driver_match_device(dev, drv))
101                 return 1;
102
103         if (sdrv->id_table)
104                 return !!spi_match_id(sdrv->id_table, spi);
105
106         return strcmp(spi->modalias, drv->name) == 0;
107 }
108
109 static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
110 {
111         const struct spi_device         *spi = to_spi_device(dev);
112
113         add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
114         return 0;
115 }
116
117 #ifdef CONFIG_PM_SLEEP
118 static int spi_legacy_suspend(struct device *dev, pm_message_t message)
119 {
120         int                     value = 0;
121         struct spi_driver       *drv = to_spi_driver(dev->driver);
122
123         /* suspend will stop irqs and dma; no more i/o */
124         if (drv) {
125                 if (drv->suspend)
126                         value = drv->suspend(to_spi_device(dev), message);
127                 else
128                         dev_dbg(dev, "... can't suspend\n");
129         }
130         return value;
131 }
132
133 static int spi_legacy_resume(struct device *dev)
134 {
135         int                     value = 0;
136         struct spi_driver       *drv = to_spi_driver(dev->driver);
137
138         /* resume may restart the i/o queue */
139         if (drv) {
140                 if (drv->resume)
141                         value = drv->resume(to_spi_device(dev));
142                 else
143                         dev_dbg(dev, "... can't resume\n");
144         }
145         return value;
146 }
147
148 static int spi_pm_suspend(struct device *dev)
149 {
150         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
151
152         if (pm)
153                 return pm_generic_suspend(dev);
154         else
155                 return spi_legacy_suspend(dev, PMSG_SUSPEND);
156 }
157
158 static int spi_pm_resume(struct device *dev)
159 {
160         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
161
162         if (pm)
163                 return pm_generic_resume(dev);
164         else
165                 return spi_legacy_resume(dev);
166 }
167
168 static int spi_pm_freeze(struct device *dev)
169 {
170         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
171
172         if (pm)
173                 return pm_generic_freeze(dev);
174         else
175                 return spi_legacy_suspend(dev, PMSG_FREEZE);
176 }
177
178 static int spi_pm_thaw(struct device *dev)
179 {
180         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
181
182         if (pm)
183                 return pm_generic_thaw(dev);
184         else
185                 return spi_legacy_resume(dev);
186 }
187
188 static int spi_pm_poweroff(struct device *dev)
189 {
190         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
191
192         if (pm)
193                 return pm_generic_poweroff(dev);
194         else
195                 return spi_legacy_suspend(dev, PMSG_HIBERNATE);
196 }
197
198 static int spi_pm_restore(struct device *dev)
199 {
200         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
201
202         if (pm)
203                 return pm_generic_restore(dev);
204         else
205                 return spi_legacy_resume(dev);
206 }
207 #else
208 #define spi_pm_suspend  NULL
209 #define spi_pm_resume   NULL
210 #define spi_pm_freeze   NULL
211 #define spi_pm_thaw     NULL
212 #define spi_pm_poweroff NULL
213 #define spi_pm_restore  NULL
214 #endif
215
216 static const struct dev_pm_ops spi_pm = {
217         .suspend = spi_pm_suspend,
218         .resume = spi_pm_resume,
219         .freeze = spi_pm_freeze,
220         .thaw = spi_pm_thaw,
221         .poweroff = spi_pm_poweroff,
222         .restore = spi_pm_restore,
223         SET_RUNTIME_PM_OPS(
224                 pm_generic_runtime_suspend,
225                 pm_generic_runtime_resume,
226                 pm_generic_runtime_idle
227         )
228 };
229
230 struct bus_type spi_bus_type = {
231         .name           = "spi",
232         .dev_attrs      = spi_dev_attrs,
233         .match          = spi_match_device,
234         .uevent         = spi_uevent,
235         .pm             = &spi_pm,
236 };
237 EXPORT_SYMBOL_GPL(spi_bus_type);
238
239
240 static int spi_drv_probe(struct device *dev)
241 {
242         const struct spi_driver         *sdrv = to_spi_driver(dev->driver);
243
244         return sdrv->probe(to_spi_device(dev));
245 }
246
247 static int spi_drv_remove(struct device *dev)
248 {
249         const struct spi_driver         *sdrv = to_spi_driver(dev->driver);
250
251         return sdrv->remove(to_spi_device(dev));
252 }
253
254 static void spi_drv_shutdown(struct device *dev)
255 {
256         const struct spi_driver         *sdrv = to_spi_driver(dev->driver);
257
258         sdrv->shutdown(to_spi_device(dev));
259 }
260
261 /**
262  * spi_register_driver - register a SPI driver
263  * @sdrv: the driver to register
264  * Context: can sleep
265  */
266 int spi_register_driver(struct spi_driver *sdrv)
267 {
268         sdrv->driver.bus = &spi_bus_type;
269         if (sdrv->probe)
270                 sdrv->driver.probe = spi_drv_probe;
271         if (sdrv->remove)
272                 sdrv->driver.remove = spi_drv_remove;
273         if (sdrv->shutdown)
274                 sdrv->driver.shutdown = spi_drv_shutdown;
275         return driver_register(&sdrv->driver);
276 }
277 EXPORT_SYMBOL_GPL(spi_register_driver);
278
279 /*-------------------------------------------------------------------------*/
280
281 /* SPI devices should normally not be created by SPI device drivers; that
282  * would make them board-specific.  Similarly with SPI master drivers.
283  * Device registration normally goes into like arch/.../mach.../board-YYY.c
284  * with other readonly (flashable) information about mainboard devices.
285  */
286
287 struct boardinfo {
288         struct list_head        list;
289         struct spi_board_info   board_info;
290 };
291
292 static LIST_HEAD(board_list);
293 static LIST_HEAD(spi_master_list);
294
295 /*
296  * Used to protect add/del opertion for board_info list and
297  * spi_master list, and their matching process
298  */
299 static DEFINE_MUTEX(board_lock);
300
301 /**
302  * spi_alloc_device - Allocate a new SPI device
303  * @master: Controller to which device is connected
304  * Context: can sleep
305  *
306  * Allows a driver to allocate and initialize a spi_device without
307  * registering it immediately.  This allows a driver to directly
308  * fill the spi_device with device parameters before calling
309  * spi_add_device() on it.
310  *
311  * Caller is responsible to call spi_add_device() on the returned
312  * spi_device structure to add it to the SPI master.  If the caller
313  * needs to discard the spi_device without adding it, then it should
314  * call spi_dev_put() on it.
315  *
316  * Returns a pointer to the new device, or NULL.
317  */
318 struct spi_device *spi_alloc_device(struct spi_master *master)
319 {
320         struct spi_device       *spi;
321         struct device           *dev = master->dev.parent;
322
323         if (!spi_master_get(master))
324                 return NULL;
325
326         spi = kzalloc(sizeof *spi, GFP_KERNEL);
327         if (!spi) {
328                 dev_err(dev, "cannot alloc spi_device\n");
329                 spi_master_put(master);
330                 return NULL;
331         }
332
333         spi->master = master;
334         spi->dev.parent = &master->dev;
335         spi->dev.bus = &spi_bus_type;
336         spi->dev.release = spidev_release;
337         spi->cs_gpio = -ENOENT;
338         device_initialize(&spi->dev);
339         return spi;
340 }
341 EXPORT_SYMBOL_GPL(spi_alloc_device);
342
343 /**
344  * spi_add_device - Add spi_device allocated with spi_alloc_device
345  * @spi: spi_device to register
346  *
347  * Companion function to spi_alloc_device.  Devices allocated with
348  * spi_alloc_device can be added onto the spi bus with this function.
349  *
350  * Returns 0 on success; negative errno on failure
351  */
352 int spi_add_device(struct spi_device *spi)
353 {
354         static DEFINE_MUTEX(spi_add_lock);
355         struct spi_master *master = spi->master;
356         struct device *dev = master->dev.parent;
357         struct device *d;
358         int status;
359
360         /* Chipselects are numbered 0..max; validate. */
361         if (spi->chip_select >= master->num_chipselect) {
362                 dev_err(dev, "cs%d >= max %d\n",
363                         spi->chip_select,
364                         master->num_chipselect);
365                 return -EINVAL;
366         }
367
368         /* Set the bus ID string */
369         dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
370                         spi->chip_select);
371
372
373         /* We need to make sure there's no other device with this
374          * chipselect **BEFORE** we call setup(), else we'll trash
375          * its configuration.  Lock against concurrent add() calls.
376          */
377         mutex_lock(&spi_add_lock);
378
379         d = bus_find_device_by_name(&spi_bus_type, NULL, dev_name(&spi->dev));
380         if (d != NULL) {
381                 dev_err(dev, "chipselect %d already in use\n",
382                                 spi->chip_select);
383                 put_device(d);
384                 status = -EBUSY;
385                 goto done;
386         }
387
388         if (master->cs_gpios)
389                 spi->cs_gpio = master->cs_gpios[spi->chip_select];
390
391         /* Drivers may modify this initial i/o setup, but will
392          * normally rely on the device being setup.  Devices
393          * using SPI_CS_HIGH can't coexist well otherwise...
394          */
395         status = spi_setup(spi);
396         if (status < 0) {
397                 dev_err(dev, "can't setup %s, status %d\n",
398                                 dev_name(&spi->dev), status);
399                 goto done;
400         }
401
402         /* Device may be bound to an active driver when this returns */
403         status = device_add(&spi->dev);
404         if (status < 0)
405                 dev_err(dev, "can't add %s, status %d\n",
406                                 dev_name(&spi->dev), status);
407         else
408                 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
409
410 done:
411         mutex_unlock(&spi_add_lock);
412         return status;
413 }
414 EXPORT_SYMBOL_GPL(spi_add_device);
415
416 /**
417  * spi_new_device - instantiate one new SPI device
418  * @master: Controller to which device is connected
419  * @chip: Describes the SPI device
420  * Context: can sleep
421  *
422  * On typical mainboards, this is purely internal; and it's not needed
423  * after board init creates the hard-wired devices.  Some development
424  * platforms may not be able to use spi_register_board_info though, and
425  * this is exported so that for example a USB or parport based adapter
426  * driver could add devices (which it would learn about out-of-band).
427  *
428  * Returns the new device, or NULL.
429  */
430 struct spi_device *spi_new_device(struct spi_master *master,
431                                   struct spi_board_info *chip)
432 {
433         struct spi_device       *proxy;
434         int                     status;
435
436         /* NOTE:  caller did any chip->bus_num checks necessary.
437          *
438          * Also, unless we change the return value convention to use
439          * error-or-pointer (not NULL-or-pointer), troubleshootability
440          * suggests syslogged diagnostics are best here (ugh).
441          */
442
443         proxy = spi_alloc_device(master);
444         if (!proxy)
445                 return NULL;
446
447         WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
448
449         proxy->chip_select = chip->chip_select;
450         proxy->max_speed_hz = chip->max_speed_hz;
451         proxy->mode = chip->mode;
452         proxy->irq = chip->irq;
453         strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
454         proxy->dev.platform_data = (void *) chip->platform_data;
455         proxy->controller_data = chip->controller_data;
456         proxy->controller_state = NULL;
457
458         status = spi_add_device(proxy);
459         if (status < 0) {
460                 spi_dev_put(proxy);
461                 return NULL;
462         }
463
464         return proxy;
465 }
466 EXPORT_SYMBOL_GPL(spi_new_device);
467
468 static void spi_match_master_to_boardinfo(struct spi_master *master,
469                                 struct spi_board_info *bi)
470 {
471         struct spi_device *dev;
472
473         if (master->bus_num != bi->bus_num)
474                 return;
475
476         dev = spi_new_device(master, bi);
477         if (!dev)
478                 dev_err(master->dev.parent, "can't create new device for %s\n",
479                         bi->modalias);
480 }
481
482 /**
483  * spi_register_board_info - register SPI devices for a given board
484  * @info: array of chip descriptors
485  * @n: how many descriptors are provided
486  * Context: can sleep
487  *
488  * Board-specific early init code calls this (probably during arch_initcall)
489  * with segments of the SPI device table.  Any device nodes are created later,
490  * after the relevant parent SPI controller (bus_num) is defined.  We keep
491  * this table of devices forever, so that reloading a controller driver will
492  * not make Linux forget about these hard-wired devices.
493  *
494  * Other code can also call this, e.g. a particular add-on board might provide
495  * SPI devices through its expansion connector, so code initializing that board
496  * would naturally declare its SPI devices.
497  *
498  * The board info passed can safely be __initdata ... but be careful of
499  * any embedded pointers (platform_data, etc), they're copied as-is.
500  */
501 int spi_register_board_info(struct spi_board_info const *info, unsigned n)
502 {
503         struct boardinfo *bi;
504         int i;
505
506         bi = kzalloc(n * sizeof(*bi), GFP_KERNEL);
507         if (!bi)
508                 return -ENOMEM;
509
510         for (i = 0; i < n; i++, bi++, info++) {
511                 struct spi_master *master;
512
513                 memcpy(&bi->board_info, info, sizeof(*info));
514                 mutex_lock(&board_lock);
515                 list_add_tail(&bi->list, &board_list);
516                 list_for_each_entry(master, &spi_master_list, list)
517                         spi_match_master_to_boardinfo(master, &bi->board_info);
518                 mutex_unlock(&board_lock);
519         }
520
521         return 0;
522 }
523
524 /*-------------------------------------------------------------------------*/
525
526 /**
527  * spi_pump_messages - kthread work function which processes spi message queue
528  * @work: pointer to kthread work struct contained in the master struct
529  *
530  * This function checks if there is any spi message in the queue that
531  * needs processing and if so call out to the driver to initialize hardware
532  * and transfer each message.
533  *
534  */
535 static void spi_pump_messages(struct kthread_work *work)
536 {
537         struct spi_master *master =
538                 container_of(work, struct spi_master, pump_messages);
539         unsigned long flags;
540         bool was_busy = false;
541         int ret;
542
543         /* Lock queue and check for queue work */
544         spin_lock_irqsave(&master->queue_lock, flags);
545         if (list_empty(&master->queue) || !master->running) {
546                 if (!master->busy) {
547                         spin_unlock_irqrestore(&master->queue_lock, flags);
548                         return;
549                 }
550                 master->busy = false;
551                 spin_unlock_irqrestore(&master->queue_lock, flags);
552                 if (master->unprepare_transfer_hardware &&
553                     master->unprepare_transfer_hardware(master))
554                         dev_err(&master->dev,
555                                 "failed to unprepare transfer hardware\n");
556                 return;
557         }
558
559         /* Make sure we are not already running a message */
560         if (master->cur_msg) {
561                 spin_unlock_irqrestore(&master->queue_lock, flags);
562                 return;
563         }
564         /* Extract head of queue */
565         master->cur_msg =
566             list_entry(master->queue.next, struct spi_message, queue);
567
568         list_del_init(&master->cur_msg->queue);
569         if (master->busy)
570                 was_busy = true;
571         else
572                 master->busy = true;
573         spin_unlock_irqrestore(&master->queue_lock, flags);
574
575         if (!was_busy && master->prepare_transfer_hardware) {
576                 ret = master->prepare_transfer_hardware(master);
577                 if (ret) {
578                         dev_err(&master->dev,
579                                 "failed to prepare transfer hardware\n");
580                         return;
581                 }
582         }
583
584         ret = master->transfer_one_message(master, master->cur_msg);
585         if (ret) {
586                 dev_err(&master->dev,
587                         "failed to transfer one message from queue: %d\n", ret);
588                 master->cur_msg->status = ret;
589                 spi_finalize_current_message(master);
590                 return;
591         }
592 }
593
594 static int spi_init_queue(struct spi_master *master)
595 {
596         struct sched_param param = { .sched_priority = MAX_RT_PRIO - 1 };
597
598         INIT_LIST_HEAD(&master->queue);
599         spin_lock_init(&master->queue_lock);
600
601         master->running = false;
602         master->busy = false;
603
604         init_kthread_worker(&master->kworker);
605         master->kworker_task = kthread_run(kthread_worker_fn,
606                                            &master->kworker,
607                                            dev_name(&master->dev));
608         if (IS_ERR(master->kworker_task)) {
609                 dev_err(&master->dev, "failed to create message pump task\n");
610                 return -ENOMEM;
611         }
612         init_kthread_work(&master->pump_messages, spi_pump_messages);
613
614         /*
615          * Master config will indicate if this controller should run the
616          * message pump with high (realtime) priority to reduce the transfer
617          * latency on the bus by minimising the delay between a transfer
618          * request and the scheduling of the message pump thread. Without this
619          * setting the message pump thread will remain at default priority.
620          */
621         if (master->rt) {
622                 dev_info(&master->dev,
623                         "will run message pump with realtime priority\n");
624                 sched_setscheduler(master->kworker_task, SCHED_FIFO, &param);
625         }
626
627         return 0;
628 }
629
630 /**
631  * spi_get_next_queued_message() - called by driver to check for queued
632  * messages
633  * @master: the master to check for queued messages
634  *
635  * If there are more messages in the queue, the next message is returned from
636  * this call.
637  */
638 struct spi_message *spi_get_next_queued_message(struct spi_master *master)
639 {
640         struct spi_message *next;
641         unsigned long flags;
642
643         /* get a pointer to the next message, if any */
644         spin_lock_irqsave(&master->queue_lock, flags);
645         if (list_empty(&master->queue))
646                 next = NULL;
647         else
648                 next = list_entry(master->queue.next,
649                                   struct spi_message, queue);
650         spin_unlock_irqrestore(&master->queue_lock, flags);
651
652         return next;
653 }
654 EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
655
656 /**
657  * spi_finalize_current_message() - the current message is complete
658  * @master: the master to return the message to
659  *
660  * Called by the driver to notify the core that the message in the front of the
661  * queue is complete and can be removed from the queue.
662  */
663 void spi_finalize_current_message(struct spi_master *master)
664 {
665         struct spi_message *mesg;
666         unsigned long flags;
667
668         spin_lock_irqsave(&master->queue_lock, flags);
669         mesg = master->cur_msg;
670         master->cur_msg = NULL;
671
672         queue_kthread_work(&master->kworker, &master->pump_messages);
673         spin_unlock_irqrestore(&master->queue_lock, flags);
674
675         mesg->state = NULL;
676         if (mesg->complete)
677                 mesg->complete(mesg->context);
678 }
679 EXPORT_SYMBOL_GPL(spi_finalize_current_message);
680
681 static int spi_start_queue(struct spi_master *master)
682 {
683         unsigned long flags;
684
685         spin_lock_irqsave(&master->queue_lock, flags);
686
687         if (master->running || master->busy) {
688                 spin_unlock_irqrestore(&master->queue_lock, flags);
689                 return -EBUSY;
690         }
691
692         master->running = true;
693         master->cur_msg = NULL;
694         spin_unlock_irqrestore(&master->queue_lock, flags);
695
696         queue_kthread_work(&master->kworker, &master->pump_messages);
697
698         return 0;
699 }
700
701 static int spi_stop_queue(struct spi_master *master)
702 {
703         unsigned long flags;
704         unsigned limit = 500;
705         int ret = 0;
706
707         spin_lock_irqsave(&master->queue_lock, flags);
708
709         /*
710          * This is a bit lame, but is optimized for the common execution path.
711          * A wait_queue on the master->busy could be used, but then the common
712          * execution path (pump_messages) would be required to call wake_up or
713          * friends on every SPI message. Do this instead.
714          */
715         while ((!list_empty(&master->queue) || master->busy) && limit--) {
716                 spin_unlock_irqrestore(&master->queue_lock, flags);
717                 msleep(10);
718                 spin_lock_irqsave(&master->queue_lock, flags);
719         }
720
721         if (!list_empty(&master->queue) || master->busy)
722                 ret = -EBUSY;
723         else
724                 master->running = false;
725
726         spin_unlock_irqrestore(&master->queue_lock, flags);
727
728         if (ret) {
729                 dev_warn(&master->dev,
730                          "could not stop message queue\n");
731                 return ret;
732         }
733         return ret;
734 }
735
736 static int spi_destroy_queue(struct spi_master *master)
737 {
738         int ret;
739
740         ret = spi_stop_queue(master);
741
742         /*
743          * flush_kthread_worker will block until all work is done.
744          * If the reason that stop_queue timed out is that the work will never
745          * finish, then it does no good to call flush/stop thread, so
746          * return anyway.
747          */
748         if (ret) {
749                 dev_err(&master->dev, "problem destroying queue\n");
750                 return ret;
751         }
752
753         flush_kthread_worker(&master->kworker);
754         kthread_stop(master->kworker_task);
755
756         return 0;
757 }
758
759 /**
760  * spi_queued_transfer - transfer function for queued transfers
761  * @spi: spi device which is requesting transfer
762  * @msg: spi message which is to handled is queued to driver queue
763  */
764 static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
765 {
766         struct spi_master *master = spi->master;
767         unsigned long flags;
768
769         spin_lock_irqsave(&master->queue_lock, flags);
770
771         if (!master->running) {
772                 spin_unlock_irqrestore(&master->queue_lock, flags);
773                 return -ESHUTDOWN;
774         }
775         msg->actual_length = 0;
776         msg->status = -EINPROGRESS;
777
778         list_add_tail(&msg->queue, &master->queue);
779         if (master->running && !master->busy)
780                 queue_kthread_work(&master->kworker, &master->pump_messages);
781
782         spin_unlock_irqrestore(&master->queue_lock, flags);
783         return 0;
784 }
785
786 static int spi_master_initialize_queue(struct spi_master *master)
787 {
788         int ret;
789
790         master->queued = true;
791         master->transfer = spi_queued_transfer;
792
793         /* Initialize and start queue */
794         ret = spi_init_queue(master);
795         if (ret) {
796                 dev_err(&master->dev, "problem initializing queue\n");
797                 goto err_init_queue;
798         }
799         ret = spi_start_queue(master);
800         if (ret) {
801                 dev_err(&master->dev, "problem starting queue\n");
802                 goto err_start_queue;
803         }
804
805         return 0;
806
807 err_start_queue:
808 err_init_queue:
809         spi_destroy_queue(master);
810         return ret;
811 }
812
813 /*-------------------------------------------------------------------------*/
814
815 #if defined(CONFIG_OF)
816 /**
817  * of_register_spi_devices() - Register child devices onto the SPI bus
818  * @master:     Pointer to spi_master device
819  *
820  * Registers an spi_device for each child node of master node which has a 'reg'
821  * property.
822  */
823 static void of_register_spi_devices(struct spi_master *master)
824 {
825         struct spi_device *spi;
826         struct device_node *nc;
827         const __be32 *prop;
828         char modalias[SPI_NAME_SIZE + 4];
829         int rc;
830         int len;
831
832         if (!master->dev.of_node)
833                 return;
834
835         for_each_available_child_of_node(master->dev.of_node, nc) {
836                 /* Alloc an spi_device */
837                 spi = spi_alloc_device(master);
838                 if (!spi) {
839                         dev_err(&master->dev, "spi_device alloc error for %s\n",
840                                 nc->full_name);
841                         spi_dev_put(spi);
842                         continue;
843                 }
844
845                 /* Select device driver */
846                 if (of_modalias_node(nc, spi->modalias,
847                                      sizeof(spi->modalias)) < 0) {
848                         dev_err(&master->dev, "cannot find modalias for %s\n",
849                                 nc->full_name);
850                         spi_dev_put(spi);
851                         continue;
852                 }
853
854                 /* Device address */
855                 prop = of_get_property(nc, "reg", &len);
856                 if (!prop || len < sizeof(*prop)) {
857                         dev_err(&master->dev, "%s has no 'reg' property\n",
858                                 nc->full_name);
859                         spi_dev_put(spi);
860                         continue;
861                 }
862                 spi->chip_select = be32_to_cpup(prop);
863
864                 /* Mode (clock phase/polarity/etc.) */
865                 if (of_find_property(nc, "spi-cpha", NULL))
866                         spi->mode |= SPI_CPHA;
867                 if (of_find_property(nc, "spi-cpol", NULL))
868                         spi->mode |= SPI_CPOL;
869                 if (of_find_property(nc, "spi-cs-high", NULL))
870                         spi->mode |= SPI_CS_HIGH;
871                 if (of_find_property(nc, "spi-3wire", NULL))
872                         spi->mode |= SPI_3WIRE;
873
874                 /* Device speed */
875                 prop = of_get_property(nc, "spi-max-frequency", &len);
876                 if (!prop || len < sizeof(*prop)) {
877                         dev_err(&master->dev, "%s has no 'spi-max-frequency' property\n",
878                                 nc->full_name);
879                         spi_dev_put(spi);
880                         continue;
881                 }
882                 spi->max_speed_hz = be32_to_cpup(prop);
883
884                 /* IRQ */
885                 spi->irq = irq_of_parse_and_map(nc, 0);
886
887                 /* Store a pointer to the node in the device structure */
888                 of_node_get(nc);
889                 spi->dev.of_node = nc;
890
891                 /* Register the new device */
892                 snprintf(modalias, sizeof(modalias), "%s%s", SPI_MODULE_PREFIX,
893                          spi->modalias);
894                 request_module(modalias);
895                 rc = spi_add_device(spi);
896                 if (rc) {
897                         dev_err(&master->dev, "spi_device register error %s\n",
898                                 nc->full_name);
899                         spi_dev_put(spi);
900                 }
901
902         }
903 }
904 #else
905 static void of_register_spi_devices(struct spi_master *master) { }
906 #endif
907
908 #ifdef CONFIG_ACPI
909 static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
910 {
911         struct spi_device *spi = data;
912
913         if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
914                 struct acpi_resource_spi_serialbus *sb;
915
916                 sb = &ares->data.spi_serial_bus;
917                 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
918                         spi->chip_select = sb->device_selection;
919                         spi->max_speed_hz = sb->connection_speed;
920
921                         if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
922                                 spi->mode |= SPI_CPHA;
923                         if (sb->clock_polarity == ACPI_SPI_START_HIGH)
924                                 spi->mode |= SPI_CPOL;
925                         if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
926                                 spi->mode |= SPI_CS_HIGH;
927                 }
928         } else if (spi->irq < 0) {
929                 struct resource r;
930
931                 if (acpi_dev_resource_interrupt(ares, 0, &r))
932                         spi->irq = r.start;
933         }
934
935         /* Always tell the ACPI core to skip this resource */
936         return 1;
937 }
938
939 static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
940                                        void *data, void **return_value)
941 {
942         struct spi_master *master = data;
943         struct list_head resource_list;
944         struct acpi_device *adev;
945         struct spi_device *spi;
946         int ret;
947
948         if (acpi_bus_get_device(handle, &adev))
949                 return AE_OK;
950         if (acpi_bus_get_status(adev) || !adev->status.present)
951                 return AE_OK;
952
953         spi = spi_alloc_device(master);
954         if (!spi) {
955                 dev_err(&master->dev, "failed to allocate SPI device for %s\n",
956                         dev_name(&adev->dev));
957                 return AE_NO_MEMORY;
958         }
959
960         ACPI_HANDLE_SET(&spi->dev, handle);
961         spi->irq = -1;
962
963         INIT_LIST_HEAD(&resource_list);
964         ret = acpi_dev_get_resources(adev, &resource_list,
965                                      acpi_spi_add_resource, spi);
966         acpi_dev_free_resource_list(&resource_list);
967
968         if (ret < 0 || !spi->max_speed_hz) {
969                 spi_dev_put(spi);
970                 return AE_OK;
971         }
972
973         strlcpy(spi->modalias, dev_name(&adev->dev), sizeof(spi->modalias));
974         if (spi_add_device(spi)) {
975                 dev_err(&master->dev, "failed to add SPI device %s from ACPI\n",
976                         dev_name(&adev->dev));
977                 spi_dev_put(spi);
978         }
979
980         return AE_OK;
981 }
982
983 static void acpi_register_spi_devices(struct spi_master *master)
984 {
985         acpi_status status;
986         acpi_handle handle;
987
988         handle = ACPI_HANDLE(master->dev.parent);
989         if (!handle)
990                 return;
991
992         status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
993                                      acpi_spi_add_device, NULL,
994                                      master, NULL);
995         if (ACPI_FAILURE(status))
996                 dev_warn(&master->dev, "failed to enumerate SPI slaves\n");
997 }
998 #else
999 static inline void acpi_register_spi_devices(struct spi_master *master) {}
1000 #endif /* CONFIG_ACPI */
1001
1002 static void spi_master_release(struct device *dev)
1003 {
1004         struct spi_master *master;
1005
1006         master = container_of(dev, struct spi_master, dev);
1007         kfree(master);
1008 }
1009
1010 static struct class spi_master_class = {
1011         .name           = "spi_master",
1012         .owner          = THIS_MODULE,
1013         .dev_release    = spi_master_release,
1014 };
1015
1016
1017
1018 /**
1019  * spi_alloc_master - allocate SPI master controller
1020  * @dev: the controller, possibly using the platform_bus
1021  * @size: how much zeroed driver-private data to allocate; the pointer to this
1022  *      memory is in the driver_data field of the returned device,
1023  *      accessible with spi_master_get_devdata().
1024  * Context: can sleep
1025  *
1026  * This call is used only by SPI master controller drivers, which are the
1027  * only ones directly touching chip registers.  It's how they allocate
1028  * an spi_master structure, prior to calling spi_register_master().
1029  *
1030  * This must be called from context that can sleep.  It returns the SPI
1031  * master structure on success, else NULL.
1032  *
1033  * The caller is responsible for assigning the bus number and initializing
1034  * the master's methods before calling spi_register_master(); and (after errors
1035  * adding the device) calling spi_master_put() and kfree() to prevent a memory
1036  * leak.
1037  */
1038 struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
1039 {
1040         struct spi_master       *master;
1041
1042         if (!dev)
1043                 return NULL;
1044
1045         master = kzalloc(size + sizeof *master, GFP_KERNEL);
1046         if (!master)
1047                 return NULL;
1048
1049         device_initialize(&master->dev);
1050         master->bus_num = -1;
1051         master->num_chipselect = 1;
1052         master->dev.class = &spi_master_class;
1053         master->dev.parent = get_device(dev);
1054         spi_master_set_devdata(master, &master[1]);
1055
1056         return master;
1057 }
1058 EXPORT_SYMBOL_GPL(spi_alloc_master);
1059
1060 #ifdef CONFIG_OF
1061 static int of_spi_register_master(struct spi_master *master)
1062 {
1063         int nb, i, *cs;
1064         struct device_node *np = master->dev.of_node;
1065
1066         if (!np)
1067                 return 0;
1068
1069         nb = of_gpio_named_count(np, "cs-gpios");
1070         master->num_chipselect = max(nb, (int)master->num_chipselect);
1071
1072         /* Return error only for an incorrectly formed cs-gpios property */
1073         if (nb == 0 || nb == -ENOENT)
1074                 return 0;
1075         else if (nb < 0)
1076                 return nb;
1077
1078         cs = devm_kzalloc(&master->dev,
1079                           sizeof(int) * master->num_chipselect,
1080                           GFP_KERNEL);
1081         master->cs_gpios = cs;
1082
1083         if (!master->cs_gpios)
1084                 return -ENOMEM;
1085
1086         for (i = 0; i < master->num_chipselect; i++)
1087                 cs[i] = -ENOENT;
1088
1089         for (i = 0; i < nb; i++)
1090                 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
1091
1092         return 0;
1093 }
1094 #else
1095 static int of_spi_register_master(struct spi_master *master)
1096 {
1097         return 0;
1098 }
1099 #endif
1100
1101 /**
1102  * spi_register_master - register SPI master controller
1103  * @master: initialized master, originally from spi_alloc_master()
1104  * Context: can sleep
1105  *
1106  * SPI master controllers connect to their drivers using some non-SPI bus,
1107  * such as the platform bus.  The final stage of probe() in that code
1108  * includes calling spi_register_master() to hook up to this SPI bus glue.
1109  *
1110  * SPI controllers use board specific (often SOC specific) bus numbers,
1111  * and board-specific addressing for SPI devices combines those numbers
1112  * with chip select numbers.  Since SPI does not directly support dynamic
1113  * device identification, boards need configuration tables telling which
1114  * chip is at which address.
1115  *
1116  * This must be called from context that can sleep.  It returns zero on
1117  * success, else a negative error code (dropping the master's refcount).
1118  * After a successful return, the caller is responsible for calling
1119  * spi_unregister_master().
1120  */
1121 int spi_register_master(struct spi_master *master)
1122 {
1123         static atomic_t         dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
1124         struct device           *dev = master->dev.parent;
1125         struct boardinfo        *bi;
1126         int                     status = -ENODEV;
1127         int                     dynamic = 0;
1128
1129         if (!dev)
1130                 return -ENODEV;
1131
1132         status = of_spi_register_master(master);
1133         if (status)
1134                 return status;
1135
1136         /* even if it's just one always-selected device, there must
1137          * be at least one chipselect
1138          */
1139         if (master->num_chipselect == 0)
1140                 return -EINVAL;
1141
1142         if ((master->bus_num < 0) && master->dev.of_node)
1143                 master->bus_num = of_alias_get_id(master->dev.of_node, "spi");
1144
1145         /* convention:  dynamically assigned bus IDs count down from the max */
1146         if (master->bus_num < 0) {
1147                 /* FIXME switch to an IDR based scheme, something like
1148                  * I2C now uses, so we can't run out of "dynamic" IDs
1149                  */
1150                 master->bus_num = atomic_dec_return(&dyn_bus_id);
1151                 dynamic = 1;
1152         }
1153
1154         spin_lock_init(&master->bus_lock_spinlock);
1155         mutex_init(&master->bus_lock_mutex);
1156         master->bus_lock_flag = 0;
1157
1158         /* register the device, then userspace will see it.
1159          * registration fails if the bus ID is in use.
1160          */
1161         dev_set_name(&master->dev, "spi%u", master->bus_num);
1162         status = device_add(&master->dev);
1163         if (status < 0)
1164                 goto done;
1165         dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
1166                         dynamic ? " (dynamic)" : "");
1167
1168         /* If we're using a queued driver, start the queue */
1169         if (master->transfer)
1170                 dev_info(dev, "master is unqueued, this is deprecated\n");
1171         else {
1172                 status = spi_master_initialize_queue(master);
1173                 if (status) {
1174                         device_unregister(&master->dev);
1175                         goto done;
1176                 }
1177         }
1178
1179         mutex_lock(&board_lock);
1180         list_add_tail(&master->list, &spi_master_list);
1181         list_for_each_entry(bi, &board_list, list)
1182                 spi_match_master_to_boardinfo(master, &bi->board_info);
1183         mutex_unlock(&board_lock);
1184
1185         /* Register devices from the device tree and ACPI */
1186         of_register_spi_devices(master);
1187         acpi_register_spi_devices(master);
1188 done:
1189         return status;
1190 }
1191 EXPORT_SYMBOL_GPL(spi_register_master);
1192
1193 static int __unregister(struct device *dev, void *null)
1194 {
1195         spi_unregister_device(to_spi_device(dev));
1196         return 0;
1197 }
1198
1199 /**
1200  * spi_unregister_master - unregister SPI master controller
1201  * @master: the master being unregistered
1202  * Context: can sleep
1203  *
1204  * This call is used only by SPI master controller drivers, which are the
1205  * only ones directly touching chip registers.
1206  *
1207  * This must be called from context that can sleep.
1208  */
1209 void spi_unregister_master(struct spi_master *master)
1210 {
1211         int dummy;
1212
1213         if (master->queued) {
1214                 if (spi_destroy_queue(master))
1215                         dev_err(&master->dev, "queue remove failed\n");
1216         }
1217
1218         mutex_lock(&board_lock);
1219         list_del(&master->list);
1220         mutex_unlock(&board_lock);
1221
1222         dummy = device_for_each_child(&master->dev, NULL, __unregister);
1223         device_unregister(&master->dev);
1224 }
1225 EXPORT_SYMBOL_GPL(spi_unregister_master);
1226
1227 int spi_master_suspend(struct spi_master *master)
1228 {
1229         int ret;
1230
1231         /* Basically no-ops for non-queued masters */
1232         if (!master->queued)
1233                 return 0;
1234
1235         ret = spi_stop_queue(master);
1236         if (ret)
1237                 dev_err(&master->dev, "queue stop failed\n");
1238
1239         return ret;
1240 }
1241 EXPORT_SYMBOL_GPL(spi_master_suspend);
1242
1243 int spi_master_resume(struct spi_master *master)
1244 {
1245         int ret;
1246
1247         if (!master->queued)
1248                 return 0;
1249
1250         ret = spi_start_queue(master);
1251         if (ret)
1252                 dev_err(&master->dev, "queue restart failed\n");
1253
1254         return ret;
1255 }
1256 EXPORT_SYMBOL_GPL(spi_master_resume);
1257
1258 static int __spi_master_match(struct device *dev, const void *data)
1259 {
1260         struct spi_master *m;
1261         const u16 *bus_num = data;
1262
1263         m = container_of(dev, struct spi_master, dev);
1264         return m->bus_num == *bus_num;
1265 }
1266
1267 /**
1268  * spi_busnum_to_master - look up master associated with bus_num
1269  * @bus_num: the master's bus number
1270  * Context: can sleep
1271  *
1272  * This call may be used with devices that are registered after
1273  * arch init time.  It returns a refcounted pointer to the relevant
1274  * spi_master (which the caller must release), or NULL if there is
1275  * no such master registered.
1276  */
1277 struct spi_master *spi_busnum_to_master(u16 bus_num)
1278 {
1279         struct device           *dev;
1280         struct spi_master       *master = NULL;
1281
1282         dev = class_find_device(&spi_master_class, NULL, &bus_num,
1283                                 __spi_master_match);
1284         if (dev)
1285                 master = container_of(dev, struct spi_master, dev);
1286         /* reference got in class_find_device */
1287         return master;
1288 }
1289 EXPORT_SYMBOL_GPL(spi_busnum_to_master);
1290
1291
1292 /*-------------------------------------------------------------------------*/
1293
1294 /* Core methods for SPI master protocol drivers.  Some of the
1295  * other core methods are currently defined as inline functions.
1296  */
1297
1298 /**
1299  * spi_setup - setup SPI mode and clock rate
1300  * @spi: the device whose settings are being modified
1301  * Context: can sleep, and no requests are queued to the device
1302  *
1303  * SPI protocol drivers may need to update the transfer mode if the
1304  * device doesn't work with its default.  They may likewise need
1305  * to update clock rates or word sizes from initial values.  This function
1306  * changes those settings, and must be called from a context that can sleep.
1307  * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
1308  * effect the next time the device is selected and data is transferred to
1309  * or from it.  When this function returns, the spi device is deselected.
1310  *
1311  * Note that this call will fail if the protocol driver specifies an option
1312  * that the underlying controller or its driver does not support.  For
1313  * example, not all hardware supports wire transfers using nine bit words,
1314  * LSB-first wire encoding, or active-high chipselects.
1315  */
1316 int spi_setup(struct spi_device *spi)
1317 {
1318         unsigned        bad_bits;
1319         int             status = 0;
1320
1321         /* help drivers fail *cleanly* when they need options
1322          * that aren't supported with their current master
1323          */
1324         bad_bits = spi->mode & ~spi->master->mode_bits;
1325         if (bad_bits) {
1326                 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
1327                         bad_bits);
1328                 return -EINVAL;
1329         }
1330
1331         if (!spi->bits_per_word)
1332                 spi->bits_per_word = 8;
1333
1334         if (spi->master->setup)
1335                 status = spi->master->setup(spi);
1336
1337         dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s"
1338                                 "%u bits/w, %u Hz max --> %d\n",
1339                         (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
1340                         (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
1341                         (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
1342                         (spi->mode & SPI_3WIRE) ? "3wire, " : "",
1343                         (spi->mode & SPI_LOOP) ? "loopback, " : "",
1344                         spi->bits_per_word, spi->max_speed_hz,
1345                         status);
1346
1347         return status;
1348 }
1349 EXPORT_SYMBOL_GPL(spi_setup);
1350
1351 static int __spi_async(struct spi_device *spi, struct spi_message *message)
1352 {
1353         struct spi_master *master = spi->master;
1354         struct spi_transfer *xfer;
1355
1356         /* Half-duplex links include original MicroWire, and ones with
1357          * only one data pin like SPI_3WIRE (switches direction) or where
1358          * either MOSI or MISO is missing.  They can also be caused by
1359          * software limitations.
1360          */
1361         if ((master->flags & SPI_MASTER_HALF_DUPLEX)
1362                         || (spi->mode & SPI_3WIRE)) {
1363                 unsigned flags = master->flags;
1364
1365                 list_for_each_entry(xfer, &message->transfers, transfer_list) {
1366                         if (xfer->rx_buf && xfer->tx_buf)
1367                                 return -EINVAL;
1368                         if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
1369                                 return -EINVAL;
1370                         if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
1371                                 return -EINVAL;
1372                 }
1373         }
1374
1375         /**
1376          * Set transfer bits_per_word and max speed as spi device default if
1377          * it is not set for this transfer.
1378          */
1379         list_for_each_entry(xfer, &message->transfers, transfer_list) {
1380                 if (!xfer->bits_per_word)
1381                         xfer->bits_per_word = spi->bits_per_word;
1382                 if (!xfer->speed_hz)
1383                         xfer->speed_hz = spi->max_speed_hz;
1384                 if (master->bits_per_word_mask) {
1385                         /* Only 32 bits fit in the mask */
1386                         if (xfer->bits_per_word > 32)
1387                                 return -EINVAL;
1388                         if (!(master->bits_per_word_mask &
1389                                         BIT(xfer->bits_per_word - 1)))
1390                                 return -EINVAL;
1391                 }
1392         }
1393
1394         message->spi = spi;
1395         message->status = -EINPROGRESS;
1396         return master->transfer(spi, message);
1397 }
1398
1399 /**
1400  * spi_async - asynchronous SPI transfer
1401  * @spi: device with which data will be exchanged
1402  * @message: describes the data transfers, including completion callback
1403  * Context: any (irqs may be blocked, etc)
1404  *
1405  * This call may be used in_irq and other contexts which can't sleep,
1406  * as well as from task contexts which can sleep.
1407  *
1408  * The completion callback is invoked in a context which can't sleep.
1409  * Before that invocation, the value of message->status is undefined.
1410  * When the callback is issued, message->status holds either zero (to
1411  * indicate complete success) or a negative error code.  After that
1412  * callback returns, the driver which issued the transfer request may
1413  * deallocate the associated memory; it's no longer in use by any SPI
1414  * core or controller driver code.
1415  *
1416  * Note that although all messages to a spi_device are handled in
1417  * FIFO order, messages may go to different devices in other orders.
1418  * Some device might be higher priority, or have various "hard" access
1419  * time requirements, for example.
1420  *
1421  * On detection of any fault during the transfer, processing of
1422  * the entire message is aborted, and the device is deselected.
1423  * Until returning from the associated message completion callback,
1424  * no other spi_message queued to that device will be processed.
1425  * (This rule applies equally to all the synchronous transfer calls,
1426  * which are wrappers around this core asynchronous primitive.)
1427  */
1428 int spi_async(struct spi_device *spi, struct spi_message *message)
1429 {
1430         struct spi_master *master = spi->master;
1431         int ret;
1432         unsigned long flags;
1433
1434         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
1435
1436         if (master->bus_lock_flag)
1437                 ret = -EBUSY;
1438         else
1439                 ret = __spi_async(spi, message);
1440
1441         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
1442
1443         return ret;
1444 }
1445 EXPORT_SYMBOL_GPL(spi_async);
1446
1447 /**
1448  * spi_async_locked - version of spi_async with exclusive bus usage
1449  * @spi: device with which data will be exchanged
1450  * @message: describes the data transfers, including completion callback
1451  * Context: any (irqs may be blocked, etc)
1452  *
1453  * This call may be used in_irq and other contexts which can't sleep,
1454  * as well as from task contexts which can sleep.
1455  *
1456  * The completion callback is invoked in a context which can't sleep.
1457  * Before that invocation, the value of message->status is undefined.
1458  * When the callback is issued, message->status holds either zero (to
1459  * indicate complete success) or a negative error code.  After that
1460  * callback returns, the driver which issued the transfer request may
1461  * deallocate the associated memory; it's no longer in use by any SPI
1462  * core or controller driver code.
1463  *
1464  * Note that although all messages to a spi_device are handled in
1465  * FIFO order, messages may go to different devices in other orders.
1466  * Some device might be higher priority, or have various "hard" access
1467  * time requirements, for example.
1468  *
1469  * On detection of any fault during the transfer, processing of
1470  * the entire message is aborted, and the device is deselected.
1471  * Until returning from the associated message completion callback,
1472  * no other spi_message queued to that device will be processed.
1473  * (This rule applies equally to all the synchronous transfer calls,
1474  * which are wrappers around this core asynchronous primitive.)
1475  */
1476 int spi_async_locked(struct spi_device *spi, struct spi_message *message)
1477 {
1478         struct spi_master *master = spi->master;
1479         int ret;
1480         unsigned long flags;
1481
1482         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
1483
1484         ret = __spi_async(spi, message);
1485
1486         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
1487
1488         return ret;
1489
1490 }
1491 EXPORT_SYMBOL_GPL(spi_async_locked);
1492
1493
1494 /*-------------------------------------------------------------------------*/
1495
1496 /* Utility methods for SPI master protocol drivers, layered on
1497  * top of the core.  Some other utility methods are defined as
1498  * inline functions.
1499  */
1500
1501 static void spi_complete(void *arg)
1502 {
1503         complete(arg);
1504 }
1505
1506 static int __spi_sync(struct spi_device *spi, struct spi_message *message,
1507                       int bus_locked)
1508 {
1509         DECLARE_COMPLETION_ONSTACK(done);
1510         int status;
1511         struct spi_master *master = spi->master;
1512
1513         message->complete = spi_complete;
1514         message->context = &done;
1515
1516         if (!bus_locked)
1517                 mutex_lock(&master->bus_lock_mutex);
1518
1519         status = spi_async_locked(spi, message);
1520
1521         if (!bus_locked)
1522                 mutex_unlock(&master->bus_lock_mutex);
1523
1524         if (status == 0) {
1525                 wait_for_completion(&done);
1526                 status = message->status;
1527         }
1528         message->context = NULL;
1529         return status;
1530 }
1531
1532 /**
1533  * spi_sync - blocking/synchronous SPI data transfers
1534  * @spi: device with which data will be exchanged
1535  * @message: describes the data transfers
1536  * Context: can sleep
1537  *
1538  * This call may only be used from a context that may sleep.  The sleep
1539  * is non-interruptible, and has no timeout.  Low-overhead controller
1540  * drivers may DMA directly into and out of the message buffers.
1541  *
1542  * Note that the SPI device's chip select is active during the message,
1543  * and then is normally disabled between messages.  Drivers for some
1544  * frequently-used devices may want to minimize costs of selecting a chip,
1545  * by leaving it selected in anticipation that the next message will go
1546  * to the same chip.  (That may increase power usage.)
1547  *
1548  * Also, the caller is guaranteeing that the memory associated with the
1549  * message will not be freed before this call returns.
1550  *
1551  * It returns zero on success, else a negative error code.
1552  */
1553 int spi_sync(struct spi_device *spi, struct spi_message *message)
1554 {
1555         return __spi_sync(spi, message, 0);
1556 }
1557 EXPORT_SYMBOL_GPL(spi_sync);
1558
1559 /**
1560  * spi_sync_locked - version of spi_sync with exclusive bus usage
1561  * @spi: device with which data will be exchanged
1562  * @message: describes the data transfers
1563  * Context: can sleep
1564  *
1565  * This call may only be used from a context that may sleep.  The sleep
1566  * is non-interruptible, and has no timeout.  Low-overhead controller
1567  * drivers may DMA directly into and out of the message buffers.
1568  *
1569  * This call should be used by drivers that require exclusive access to the
1570  * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
1571  * be released by a spi_bus_unlock call when the exclusive access is over.
1572  *
1573  * It returns zero on success, else a negative error code.
1574  */
1575 int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
1576 {
1577         return __spi_sync(spi, message, 1);
1578 }
1579 EXPORT_SYMBOL_GPL(spi_sync_locked);
1580
1581 /**
1582  * spi_bus_lock - obtain a lock for exclusive SPI bus usage
1583  * @master: SPI bus master that should be locked for exclusive bus access
1584  * Context: can sleep
1585  *
1586  * This call may only be used from a context that may sleep.  The sleep
1587  * is non-interruptible, and has no timeout.
1588  *
1589  * This call should be used by drivers that require exclusive access to the
1590  * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
1591  * exclusive access is over. Data transfer must be done by spi_sync_locked
1592  * and spi_async_locked calls when the SPI bus lock is held.
1593  *
1594  * It returns zero on success, else a negative error code.
1595  */
1596 int spi_bus_lock(struct spi_master *master)
1597 {
1598         unsigned long flags;
1599
1600         mutex_lock(&master->bus_lock_mutex);
1601
1602         spin_lock_irqsave(&master->bus_lock_spinlock, flags);
1603         master->bus_lock_flag = 1;
1604         spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
1605
1606         /* mutex remains locked until spi_bus_unlock is called */
1607
1608         return 0;
1609 }
1610 EXPORT_SYMBOL_GPL(spi_bus_lock);
1611
1612 /**
1613  * spi_bus_unlock - release the lock for exclusive SPI bus usage
1614  * @master: SPI bus master that was locked for exclusive bus access
1615  * Context: can sleep
1616  *
1617  * This call may only be used from a context that may sleep.  The sleep
1618  * is non-interruptible, and has no timeout.
1619  *
1620  * This call releases an SPI bus lock previously obtained by an spi_bus_lock
1621  * call.
1622  *
1623  * It returns zero on success, else a negative error code.
1624  */
1625 int spi_bus_unlock(struct spi_master *master)
1626 {
1627         master->bus_lock_flag = 0;
1628
1629         mutex_unlock(&master->bus_lock_mutex);
1630
1631         return 0;
1632 }
1633 EXPORT_SYMBOL_GPL(spi_bus_unlock);
1634
1635 /* portable code must never pass more than 32 bytes */
1636 #define SPI_BUFSIZ      max(32,SMP_CACHE_BYTES)
1637
1638 static u8       *buf;
1639
1640 /**
1641  * spi_write_then_read - SPI synchronous write followed by read
1642  * @spi: device with which data will be exchanged
1643  * @txbuf: data to be written (need not be dma-safe)
1644  * @n_tx: size of txbuf, in bytes
1645  * @rxbuf: buffer into which data will be read (need not be dma-safe)
1646  * @n_rx: size of rxbuf, in bytes
1647  * Context: can sleep
1648  *
1649  * This performs a half duplex MicroWire style transaction with the
1650  * device, sending txbuf and then reading rxbuf.  The return value
1651  * is zero for success, else a negative errno status code.
1652  * This call may only be used from a context that may sleep.
1653  *
1654  * Parameters to this routine are always copied using a small buffer;
1655  * portable code should never use this for more than 32 bytes.
1656  * Performance-sensitive or bulk transfer code should instead use
1657  * spi_{async,sync}() calls with dma-safe buffers.
1658  */
1659 int spi_write_then_read(struct spi_device *spi,
1660                 const void *txbuf, unsigned n_tx,
1661                 void *rxbuf, unsigned n_rx)
1662 {
1663         static DEFINE_MUTEX(lock);
1664
1665         int                     status;
1666         struct spi_message      message;
1667         struct spi_transfer     x[2];
1668         u8                      *local_buf;
1669
1670         /* Use preallocated DMA-safe buffer if we can.  We can't avoid
1671          * copying here, (as a pure convenience thing), but we can
1672          * keep heap costs out of the hot path unless someone else is
1673          * using the pre-allocated buffer or the transfer is too large.
1674          */
1675         if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
1676                 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
1677                                     GFP_KERNEL | GFP_DMA);
1678                 if (!local_buf)
1679                         return -ENOMEM;
1680         } else {
1681                 local_buf = buf;
1682         }
1683
1684         spi_message_init(&message);
1685         memset(x, 0, sizeof x);
1686         if (n_tx) {
1687                 x[0].len = n_tx;
1688                 spi_message_add_tail(&x[0], &message);
1689         }
1690         if (n_rx) {
1691                 x[1].len = n_rx;
1692                 spi_message_add_tail(&x[1], &message);
1693         }
1694
1695         memcpy(local_buf, txbuf, n_tx);
1696         x[0].tx_buf = local_buf;
1697         x[1].rx_buf = local_buf + n_tx;
1698
1699         /* do the i/o */
1700         status = spi_sync(spi, &message);
1701         if (status == 0)
1702                 memcpy(rxbuf, x[1].rx_buf, n_rx);
1703
1704         if (x[0].tx_buf == buf)
1705                 mutex_unlock(&lock);
1706         else
1707                 kfree(local_buf);
1708
1709         return status;
1710 }
1711 EXPORT_SYMBOL_GPL(spi_write_then_read);
1712
1713 /*-------------------------------------------------------------------------*/
1714
1715 static int __init spi_init(void)
1716 {
1717         int     status;
1718
1719         buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
1720         if (!buf) {
1721                 status = -ENOMEM;
1722                 goto err0;
1723         }
1724
1725         status = bus_register(&spi_bus_type);
1726         if (status < 0)
1727                 goto err1;
1728
1729         status = class_register(&spi_master_class);
1730         if (status < 0)
1731                 goto err2;
1732         return 0;
1733
1734 err2:
1735         bus_unregister(&spi_bus_type);
1736 err1:
1737         kfree(buf);
1738         buf = NULL;
1739 err0:
1740         return status;
1741 }
1742
1743 /* board_info is normally registered in arch_initcall(),
1744  * but even essential drivers wait till later
1745  *
1746  * REVISIT only boardinfo really needs static linking. the rest (device and
1747  * driver registration) _could_ be dynamically linked (modular) ... costs
1748  * include needing to have boardinfo data structures be much more public.
1749  */
1750 postcore_initcall(spi_init);
1751