2 * spidev.c -- simple synchronous userspace interface to SPI devices
4 * Copyright (C) 2006 SWAPP
5 * Andrea Paterniani <a.paterniani@swapp-eng.it>
6 * Copyright (C) 2007 David Brownell (simplification, cleanup)
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include <linux/init.h>
24 #include <linux/module.h>
25 #include <linux/ioctl.h>
27 #include <linux/device.h>
28 #include <linux/list.h>
29 #include <linux/errno.h>
30 #include <linux/mutex.h>
31 #include <linux/slab.h>
33 #include <linux/spi/spi.h>
34 #include <linux/spi/spidev.h>
36 #include <asm/uaccess.h>
40 * This supports acccess to SPI devices using normal userspace I/O calls.
41 * Note that while traditional UNIX/POSIX I/O semantics are half duplex,
42 * and often mask message boundaries, full SPI support requires full duplex
43 * transfers. There are several kinds of of internal message boundaries to
44 * handle chipselect management and other protocol options.
46 * SPI has a character major number assigned. We allocate minor numbers
47 * dynamically using a bitmask. You must use hotplug tools, such as udev
48 * (or mdev with busybox) to create and destroy the /dev/spidevB.C device
49 * nodes, since there is no fixed association of minor numbers with any
50 * particular SPI bus or device.
52 #define SPIDEV_MAJOR 153 /* assigned */
53 #define N_SPI_MINORS 32 /* ... up to 256 */
55 static unsigned long minors[N_SPI_MINORS / BITS_PER_LONG];
58 /* Bit masks for spi_device.mode management. Note that incorrect
59 * settings for CS_HIGH and 3WIRE can cause *lots* of trouble for other
60 * devices on a shared bus: CS_HIGH, because this device will be
61 * active when it shouldn't be; 3WIRE, because when active it won't
62 * behave as it should.
64 * REVISIT should changing those two modes be privileged?
66 #define SPI_MODE_MASK (SPI_CPHA | SPI_CPOL | SPI_CS_HIGH \
67 | SPI_LSB_FIRST | SPI_3WIRE | SPI_LOOP)
72 struct spi_device *spi;
73 struct list_head device_entry;
75 struct mutex buf_lock;
80 static LIST_HEAD(device_list);
81 static DEFINE_MUTEX(device_list_lock);
83 static unsigned bufsiz = 4096;
84 module_param(bufsiz, uint, S_IRUGO);
85 MODULE_PARM_DESC(bufsiz, "data bytes in biggest supported SPI message");
87 /*-------------------------------------------------------------------------*/
90 * We can't use the standard synchronous wrappers for file I/O; we
91 * need to protect against async removal of the underlying spi_device.
93 static void spidev_complete(void *arg)
99 spidev_sync(struct spidev_data *spidev, struct spi_message *message)
101 DECLARE_COMPLETION_ONSTACK(done);
104 message->complete = spidev_complete;
105 message->context = &done;
107 spin_lock_irq(&spidev->spi_lock);
108 if (spidev->spi == NULL)
111 status = spi_async(spidev->spi, message);
112 spin_unlock_irq(&spidev->spi_lock);
115 wait_for_completion(&done);
116 status = message->status;
118 status = message->actual_length;
123 static inline ssize_t
124 spidev_sync_write(struct spidev_data *spidev, size_t len)
126 struct spi_transfer t = {
127 .tx_buf = spidev->buffer,
130 struct spi_message m;
132 spi_message_init(&m);
133 spi_message_add_tail(&t, &m);
134 return spidev_sync(spidev, &m);
137 static inline ssize_t
138 spidev_sync_read(struct spidev_data *spidev, size_t len)
140 struct spi_transfer t = {
141 .rx_buf = spidev->buffer,
144 struct spi_message m;
146 spi_message_init(&m);
147 spi_message_add_tail(&t, &m);
148 return spidev_sync(spidev, &m);
151 /*-------------------------------------------------------------------------*/
153 /* Read-only message with current device setup */
155 spidev_read(struct file *filp, char __user *buf, size_t count, loff_t *f_pos)
157 struct spidev_data *spidev;
160 /* chipselect only toggles at start or end of operation */
164 spidev = filp->private_data;
166 mutex_lock(&spidev->buf_lock);
167 status = spidev_sync_read(spidev, count);
169 unsigned long missing;
171 missing = copy_to_user(buf, spidev->buffer, count);
172 if (count && missing == count)
175 status = count - missing;
177 mutex_unlock(&spidev->buf_lock);
182 /* Write-only message with current device setup */
184 spidev_write(struct file *filp, const char __user *buf,
185 size_t count, loff_t *f_pos)
187 struct spidev_data *spidev;
189 unsigned long missing;
191 /* chipselect only toggles at start or end of operation */
195 spidev = filp->private_data;
197 mutex_lock(&spidev->buf_lock);
198 missing = copy_from_user(spidev->buffer, buf, count);
200 status = spidev_sync_write(spidev, count);
205 mutex_unlock(&spidev->buf_lock);
210 static int spidev_message(struct spidev_data *spidev,
211 struct spi_ioc_transfer *u_xfers, unsigned n_xfers)
213 struct spi_message msg;
214 struct spi_transfer *k_xfers;
215 struct spi_transfer *k_tmp;
216 struct spi_ioc_transfer *u_tmp;
219 int status = -EFAULT;
221 spi_message_init(&msg);
222 k_xfers = kcalloc(n_xfers, sizeof(*k_tmp), GFP_KERNEL);
226 /* Construct spi_message, copying any tx data to bounce buffer.
227 * We walk the array of user-provided transfers, using each one
228 * to initialize a kernel version of the same transfer.
230 mutex_lock(&spidev->buf_lock);
231 buf = spidev->buffer;
233 for (n = n_xfers, k_tmp = k_xfers, u_tmp = u_xfers;
235 n--, k_tmp++, u_tmp++) {
236 k_tmp->len = u_tmp->len;
239 if (total > bufsiz) {
246 if (!access_ok(VERIFY_WRITE, (u8 __user *)
247 (uintptr_t) u_tmp->rx_buf,
253 if (copy_from_user(buf, (const u8 __user *)
254 (uintptr_t) u_tmp->tx_buf,
260 k_tmp->cs_change = !!u_tmp->cs_change;
261 k_tmp->bits_per_word = u_tmp->bits_per_word;
262 k_tmp->delay_usecs = u_tmp->delay_usecs;
263 k_tmp->speed_hz = u_tmp->speed_hz;
266 " xfer len %zd %s%s%s%dbits %u usec %uHz\n",
268 u_tmp->rx_buf ? "rx " : "",
269 u_tmp->tx_buf ? "tx " : "",
270 u_tmp->cs_change ? "cs " : "",
271 u_tmp->bits_per_word ? : spi->bits_per_word,
273 u_tmp->speed_hz ? : spi->max_speed_hz);
275 spi_message_add_tail(k_tmp, &msg);
278 status = spidev_sync(spidev, &msg);
282 /* copy any rx data out of bounce buffer */
283 buf = spidev->buffer;
284 for (n = n_xfers, u_tmp = u_xfers; n; n--, u_tmp++) {
286 if (__copy_to_user((u8 __user *)
287 (uintptr_t) u_tmp->rx_buf, buf,
298 mutex_unlock(&spidev->buf_lock);
304 spidev_ioctl(struct inode *inode, struct file *filp,
305 unsigned int cmd, unsigned long arg)
309 struct spidev_data *spidev;
310 struct spi_device *spi;
313 struct spi_ioc_transfer *ioc;
315 /* Check type and command number */
316 if (_IOC_TYPE(cmd) != SPI_IOC_MAGIC)
319 /* Check access direction once here; don't repeat below.
320 * IOC_DIR is from the user perspective, while access_ok is
321 * from the kernel perspective; so they look reversed.
323 if (_IOC_DIR(cmd) & _IOC_READ)
324 err = !access_ok(VERIFY_WRITE,
325 (void __user *)arg, _IOC_SIZE(cmd));
326 if (err == 0 && _IOC_DIR(cmd) & _IOC_WRITE)
327 err = !access_ok(VERIFY_READ,
328 (void __user *)arg, _IOC_SIZE(cmd));
332 /* guard against device removal before, or while,
333 * we issue this ioctl.
335 spidev = filp->private_data;
336 spin_lock_irq(&spidev->spi_lock);
337 spi = spi_dev_get(spidev->spi);
338 spin_unlock_irq(&spidev->spi_lock);
345 case SPI_IOC_RD_MODE:
346 retval = __put_user(spi->mode & SPI_MODE_MASK,
349 case SPI_IOC_RD_LSB_FIRST:
350 retval = __put_user((spi->mode & SPI_LSB_FIRST) ? 1 : 0,
353 case SPI_IOC_RD_BITS_PER_WORD:
354 retval = __put_user(spi->bits_per_word, (__u8 __user *)arg);
356 case SPI_IOC_RD_MAX_SPEED_HZ:
357 retval = __put_user(spi->max_speed_hz, (__u32 __user *)arg);
361 case SPI_IOC_WR_MODE:
362 retval = __get_user(tmp, (u8 __user *)arg);
366 if (tmp & ~SPI_MODE_MASK) {
371 tmp |= spi->mode & ~SPI_MODE_MASK;
373 retval = spi_setup(spi);
377 dev_dbg(&spi->dev, "spi mode %02x\n", tmp);
380 case SPI_IOC_WR_LSB_FIRST:
381 retval = __get_user(tmp, (__u8 __user *)arg);
386 spi->mode |= SPI_LSB_FIRST;
388 spi->mode &= ~SPI_LSB_FIRST;
389 retval = spi_setup(spi);
393 dev_dbg(&spi->dev, "%csb first\n",
397 case SPI_IOC_WR_BITS_PER_WORD:
398 retval = __get_user(tmp, (__u8 __user *)arg);
400 u8 save = spi->bits_per_word;
402 spi->bits_per_word = tmp;
403 retval = spi_setup(spi);
405 spi->bits_per_word = save;
407 dev_dbg(&spi->dev, "%d bits per word\n", tmp);
410 case SPI_IOC_WR_MAX_SPEED_HZ:
411 retval = __get_user(tmp, (__u32 __user *)arg);
413 u32 save = spi->max_speed_hz;
415 spi->max_speed_hz = tmp;
416 retval = spi_setup(spi);
418 spi->max_speed_hz = save;
420 dev_dbg(&spi->dev, "%d Hz (max)\n", tmp);
425 /* segmented and/or full-duplex I/O request */
426 if (_IOC_NR(cmd) != _IOC_NR(SPI_IOC_MESSAGE(0))
427 || _IOC_DIR(cmd) != _IOC_WRITE) {
432 tmp = _IOC_SIZE(cmd);
433 if ((tmp % sizeof(struct spi_ioc_transfer)) != 0) {
437 n_ioc = tmp / sizeof(struct spi_ioc_transfer);
441 /* copy into scratch area */
442 ioc = kmalloc(tmp, GFP_KERNEL);
447 if (__copy_from_user(ioc, (void __user *)arg, tmp)) {
453 /* translate to spi_message, execute */
454 retval = spidev_message(spidev, ioc, n_ioc);
462 static int spidev_open(struct inode *inode, struct file *filp)
464 struct spidev_data *spidev;
467 mutex_lock(&device_list_lock);
469 list_for_each_entry(spidev, &device_list, device_entry) {
470 if (spidev->dev.devt == inode->i_rdev) {
476 if (!spidev->buffer) {
477 spidev->buffer = kmalloc(bufsiz, GFP_KERNEL);
478 if (!spidev->buffer) {
479 dev_dbg(&spidev->spi->dev, "open/ENOMEM\n");
485 filp->private_data = spidev;
486 nonseekable_open(inode, filp);
489 pr_debug("spidev: nothing for minor %d\n", iminor(inode));
491 mutex_unlock(&device_list_lock);
495 static int spidev_release(struct inode *inode, struct file *filp)
497 struct spidev_data *spidev;
500 mutex_lock(&device_list_lock);
501 spidev = filp->private_data;
502 filp->private_data = NULL;
504 if (!spidev->users) {
505 kfree(spidev->buffer);
506 spidev->buffer = NULL;
508 mutex_unlock(&device_list_lock);
513 static struct file_operations spidev_fops = {
514 .owner = THIS_MODULE,
515 /* REVISIT switch to aio primitives, so that userspace
516 * gets more complete API coverage. It'll simplify things
517 * too, except for the locking.
519 .write = spidev_write,
521 .ioctl = spidev_ioctl,
523 .release = spidev_release,
526 /*-------------------------------------------------------------------------*/
528 /* The main reason to have this class is to make mdev/udev create the
529 * /dev/spidevB.C character device nodes exposing our userspace API.
530 * It also simplifies memory management.
533 static void spidev_classdev_release(struct device *dev)
535 struct spidev_data *spidev;
537 spidev = container_of(dev, struct spidev_data, dev);
541 static struct class spidev_class = {
543 .owner = THIS_MODULE,
544 .dev_release = spidev_classdev_release,
547 /*-------------------------------------------------------------------------*/
549 static int spidev_probe(struct spi_device *spi)
551 struct spidev_data *spidev;
555 /* Allocate driver data */
556 spidev = kzalloc(sizeof(*spidev), GFP_KERNEL);
560 /* Initialize the driver data */
562 spin_lock_init(&spidev->spi_lock);
563 mutex_init(&spidev->buf_lock);
565 INIT_LIST_HEAD(&spidev->device_entry);
567 /* If we can allocate a minor number, hook up this device.
568 * Reusing minors is fine so long as udev or mdev is working.
570 mutex_lock(&device_list_lock);
571 minor = find_first_zero_bit(minors, N_SPI_MINORS);
572 if (minor < N_SPI_MINORS) {
573 spidev->dev.parent = &spi->dev;
574 spidev->dev.class = &spidev_class;
575 spidev->dev.devt = MKDEV(SPIDEV_MAJOR, minor);
576 snprintf(spidev->dev.bus_id, sizeof spidev->dev.bus_id,
578 spi->master->bus_num, spi->chip_select);
579 status = device_register(&spidev->dev);
581 dev_dbg(&spi->dev, "no minor number available!\n");
585 set_bit(minor, minors);
586 dev_set_drvdata(&spi->dev, spidev);
587 list_add(&spidev->device_entry, &device_list);
589 mutex_unlock(&device_list_lock);
597 static int spidev_remove(struct spi_device *spi)
599 struct spidev_data *spidev = dev_get_drvdata(&spi->dev);
601 /* make sure ops on existing fds can abort cleanly */
602 spin_lock_irq(&spidev->spi_lock);
604 spin_unlock_irq(&spidev->spi_lock);
606 /* prevent new opens */
607 mutex_lock(&device_list_lock);
608 list_del(&spidev->device_entry);
609 dev_set_drvdata(&spi->dev, NULL);
610 clear_bit(MINOR(spidev->dev.devt), minors);
611 device_unregister(&spidev->dev);
612 mutex_unlock(&device_list_lock);
617 static struct spi_driver spidev_spi = {
620 .owner = THIS_MODULE,
622 .probe = spidev_probe,
623 .remove = __devexit_p(spidev_remove),
625 /* NOTE: suspend/resume methods are not necessary here.
626 * We don't do anything except pass the requests to/from
627 * the underlying controller. The refrigerator handles
628 * most issues; the controller driver handles the rest.
632 /*-------------------------------------------------------------------------*/
634 static int __init spidev_init(void)
638 /* Claim our 256 reserved device numbers. Then register a class
639 * that will key udev/mdev to add/remove /dev nodes. Last, register
640 * the driver which manages those device numbers.
642 BUILD_BUG_ON(N_SPI_MINORS > 256);
643 status = register_chrdev(SPIDEV_MAJOR, "spi", &spidev_fops);
647 status = class_register(&spidev_class);
649 unregister_chrdev(SPIDEV_MAJOR, spidev_spi.driver.name);
653 status = spi_register_driver(&spidev_spi);
655 class_unregister(&spidev_class);
656 unregister_chrdev(SPIDEV_MAJOR, spidev_spi.driver.name);
660 module_init(spidev_init);
662 static void __exit spidev_exit(void)
664 spi_unregister_driver(&spidev_spi);
665 class_unregister(&spidev_class);
666 unregister_chrdev(SPIDEV_MAJOR, spidev_spi.driver.name);
668 module_exit(spidev_exit);
670 MODULE_AUTHOR("Andrea Paterniani, <a.paterniani@swapp-eng.it>");
671 MODULE_DESCRIPTION("User mode SPI device interface");
672 MODULE_LICENSE("GPL");