blob: eb0a075b23a2222eba583225afc3844b455cfb96 [file] [log] [blame]
Andrea Paterniani814a8d52007-05-08 00:32:15 -07001/*
Grant Likelyca632f52011-06-06 01:16:30 -06002 * Simple synchronous userspace interface to SPI devices
Andrea Paterniani814a8d52007-05-08 00:32:15 -07003 *
4 * Copyright (C) 2006 SWAPP
5 * Andrea Paterniani <a.paterniani@swapp-eng.it>
6 * Copyright (C) 2007 David Brownell (simplification, cleanup)
7 *
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.
12 *
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.
Andrea Paterniani814a8d52007-05-08 00:32:15 -070017 */
18
19#include <linux/init.h>
20#include <linux/module.h>
21#include <linux/ioctl.h>
22#include <linux/fs.h>
23#include <linux/device.h>
David Brownellb2c8dad2008-06-05 22:45:50 -070024#include <linux/err.h>
Andrea Paterniani814a8d52007-05-08 00:32:15 -070025#include <linux/list.h>
26#include <linux/errno.h>
27#include <linux/mutex.h>
28#include <linux/slab.h>
Bernhard Walle7d48ec32011-02-03 09:37:18 +010029#include <linux/compat.h>
Maxime Ripard880cfd42012-10-31 11:30:08 +010030#include <linux/of.h>
31#include <linux/of_device.h>
Andrea Paterniani814a8d52007-05-08 00:32:15 -070032
33#include <linux/spi/spi.h>
34#include <linux/spi/spidev.h>
35
Jingoo Han95c63cf2013-10-14 10:36:54 +090036#include <linux/uaccess.h>
Andrea Paterniani814a8d52007-05-08 00:32:15 -070037
38
39/*
Uwe Kleine-Königb5950762010-11-01 15:38:34 -040040 * This supports access to SPI devices using normal userspace I/O calls.
Andrea Paterniani814a8d52007-05-08 00:32:15 -070041 * Note that while traditional UNIX/POSIX I/O semantics are half duplex,
42 * and often mask message boundaries, full SPI support requires full duplex
Thadeu Lima de Souza Cascardo137f1182009-10-22 17:34:29 -020043 * transfers. There are several kinds of internal message boundaries to
Andrea Paterniani814a8d52007-05-08 00:32:15 -070044 * handle chipselect management and other protocol options.
45 *
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.
51 */
52#define SPIDEV_MAJOR 153 /* assigned */
53#define N_SPI_MINORS 32 /* ... up to 256 */
54
Thadeu Lima de Souza Cascardo8ae1c922009-12-14 14:20:23 -080055static DECLARE_BITMAP(minors, N_SPI_MINORS);
Andrea Paterniani814a8d52007-05-08 00:32:15 -070056
57
Anton Vorontsov6f166e32007-07-31 00:38:43 -070058/* Bit masks for spi_device.mode management. Note that incorrect
David Brownellb55f6272009-06-30 11:41:26 -070059 * settings for some settings can cause *lots* of trouble for other
60 * devices on a shared bus:
Anton Vorontsov6f166e32007-07-31 00:38:43 -070061 *
David Brownellb55f6272009-06-30 11:41:26 -070062 * - CS_HIGH ... this device will be active when it shouldn't be
63 * - 3WIRE ... when active, it won't behave as it should
64 * - NO_CS ... there will be no explicit message boundaries; this
65 * is completely incompatible with the shared bus model
66 * - READY ... transfers may proceed when they shouldn't.
67 *
68 * REVISIT should changing those flags be privileged?
Anton Vorontsov6f166e32007-07-31 00:38:43 -070069 */
70#define SPI_MODE_MASK (SPI_CPHA | SPI_CPOL | SPI_CS_HIGH \
David Brownellb55f6272009-06-30 11:41:26 -070071 | SPI_LSB_FIRST | SPI_3WIRE | SPI_LOOP \
Geert Uytterhoevendc64d392014-02-25 11:40:17 +010072 | SPI_NO_CS | SPI_READY | SPI_TX_DUAL \
73 | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD)
Andrea Paterniani814a8d52007-05-08 00:32:15 -070074
75struct spidev_data {
David Brownellb2c8dad2008-06-05 22:45:50 -070076 dev_t devt;
David Brownell25d5cb42008-05-23 13:05:03 -070077 spinlock_t spi_lock;
Andrea Paterniani814a8d52007-05-08 00:32:15 -070078 struct spi_device *spi;
79 struct list_head device_entry;
80
Ray Jui865f6d12014-10-09 11:19:25 -070081 /* TX/RX buffers are NULL unless this device is open (users > 0) */
Andrea Paterniani814a8d52007-05-08 00:32:15 -070082 struct mutex buf_lock;
83 unsigned users;
Ray Jui865f6d12014-10-09 11:19:25 -070084 u8 *tx_buffer;
85 u8 *rx_buffer;
Mark Brown91690512014-11-08 10:28:10 +000086 u32 speed_hz;
Andrea Paterniani814a8d52007-05-08 00:32:15 -070087};
88
89static LIST_HEAD(device_list);
90static DEFINE_MUTEX(device_list_lock);
91
92static unsigned bufsiz = 4096;
93module_param(bufsiz, uint, S_IRUGO);
94MODULE_PARM_DESC(bufsiz, "data bytes in biggest supported SPI message");
95
96/*-------------------------------------------------------------------------*/
97
David Brownell25d5cb42008-05-23 13:05:03 -070098static ssize_t
99spidev_sync(struct spidev_data *spidev, struct spi_message *message)
100{
101 DECLARE_COMPLETION_ONSTACK(done);
102 int status;
Martin Sperl98d6f472015-04-23 07:56:01 +0000103 struct spi_device *spi;
David Brownell25d5cb42008-05-23 13:05:03 -0700104
105 spin_lock_irq(&spidev->spi_lock);
Martin Sperl98d6f472015-04-23 07:56:01 +0000106 spi = spidev->spi;
David Brownell25d5cb42008-05-23 13:05:03 -0700107 spin_unlock_irq(&spidev->spi_lock);
108
Martin Sperl98d6f472015-04-23 07:56:01 +0000109 if (spi == NULL)
110 status = -ESHUTDOWN;
111 else
112 status = spi_sync(spi, message);
113
114 if (status == 0)
115 status = message->actual_length;
116
David Brownell25d5cb42008-05-23 13:05:03 -0700117 return status;
118}
119
120static inline ssize_t
121spidev_sync_write(struct spidev_data *spidev, size_t len)
122{
123 struct spi_transfer t = {
Ray Jui865f6d12014-10-09 11:19:25 -0700124 .tx_buf = spidev->tx_buffer,
David Brownell25d5cb42008-05-23 13:05:03 -0700125 .len = len,
Mark Brown91690512014-11-08 10:28:10 +0000126 .speed_hz = spidev->speed_hz,
David Brownell25d5cb42008-05-23 13:05:03 -0700127 };
128 struct spi_message m;
129
130 spi_message_init(&m);
131 spi_message_add_tail(&t, &m);
132 return spidev_sync(spidev, &m);
133}
134
135static inline ssize_t
136spidev_sync_read(struct spidev_data *spidev, size_t len)
137{
138 struct spi_transfer t = {
Ray Jui865f6d12014-10-09 11:19:25 -0700139 .rx_buf = spidev->rx_buffer,
David Brownell25d5cb42008-05-23 13:05:03 -0700140 .len = len,
Mark Brown91690512014-11-08 10:28:10 +0000141 .speed_hz = spidev->speed_hz,
David Brownell25d5cb42008-05-23 13:05:03 -0700142 };
143 struct spi_message m;
144
145 spi_message_init(&m);
146 spi_message_add_tail(&t, &m);
147 return spidev_sync(spidev, &m);
148}
149
150/*-------------------------------------------------------------------------*/
151
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700152/* Read-only message with current device setup */
153static ssize_t
154spidev_read(struct file *filp, char __user *buf, size_t count, loff_t *f_pos)
155{
156 struct spidev_data *spidev;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700157 ssize_t status = 0;
158
159 /* chipselect only toggles at start or end of operation */
160 if (count > bufsiz)
161 return -EMSGSIZE;
162
163 spidev = filp->private_data;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700164
165 mutex_lock(&spidev->buf_lock);
David Brownell25d5cb42008-05-23 13:05:03 -0700166 status = spidev_sync_read(spidev, count);
Sebastian Siewior4b1295b2008-07-04 09:59:56 -0700167 if (status > 0) {
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700168 unsigned long missing;
169
Ray Jui865f6d12014-10-09 11:19:25 -0700170 missing = copy_to_user(buf, spidev->rx_buffer, status);
Sebastian Siewior4b1295b2008-07-04 09:59:56 -0700171 if (missing == status)
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700172 status = -EFAULT;
173 else
Sebastian Siewior4b1295b2008-07-04 09:59:56 -0700174 status = status - missing;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700175 }
176 mutex_unlock(&spidev->buf_lock);
177
178 return status;
179}
180
181/* Write-only message with current device setup */
182static ssize_t
183spidev_write(struct file *filp, const char __user *buf,
184 size_t count, loff_t *f_pos)
185{
186 struct spidev_data *spidev;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700187 ssize_t status = 0;
188 unsigned long missing;
189
190 /* chipselect only toggles at start or end of operation */
191 if (count > bufsiz)
192 return -EMSGSIZE;
193
194 spidev = filp->private_data;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700195
196 mutex_lock(&spidev->buf_lock);
Ray Jui865f6d12014-10-09 11:19:25 -0700197 missing = copy_from_user(spidev->tx_buffer, buf, count);
Jingoo Han95c63cf2013-10-14 10:36:54 +0900198 if (missing == 0)
David Brownell25d5cb42008-05-23 13:05:03 -0700199 status = spidev_sync_write(spidev, count);
Jingoo Han95c63cf2013-10-14 10:36:54 +0900200 else
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700201 status = -EFAULT;
202 mutex_unlock(&spidev->buf_lock);
203
204 return status;
205}
206
207static int spidev_message(struct spidev_data *spidev,
208 struct spi_ioc_transfer *u_xfers, unsigned n_xfers)
209{
210 struct spi_message msg;
211 struct spi_transfer *k_xfers;
212 struct spi_transfer *k_tmp;
213 struct spi_ioc_transfer *u_tmp;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700214 unsigned n, total;
Ray Jui865f6d12014-10-09 11:19:25 -0700215 u8 *tx_buf, *rx_buf;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700216 int status = -EFAULT;
217
218 spi_message_init(&msg);
219 k_xfers = kcalloc(n_xfers, sizeof(*k_tmp), GFP_KERNEL);
220 if (k_xfers == NULL)
221 return -ENOMEM;
222
223 /* Construct spi_message, copying any tx data to bounce buffer.
224 * We walk the array of user-provided transfers, using each one
225 * to initialize a kernel version of the same transfer.
226 */
Ray Jui865f6d12014-10-09 11:19:25 -0700227 tx_buf = spidev->tx_buffer;
228 rx_buf = spidev->rx_buffer;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700229 total = 0;
230 for (n = n_xfers, k_tmp = k_xfers, u_tmp = u_xfers;
231 n;
232 n--, k_tmp++, u_tmp++) {
233 k_tmp->len = u_tmp->len;
234
Domen Puncerda90fa82007-05-23 13:57:39 -0700235 total += k_tmp->len;
236 if (total > bufsiz) {
237 status = -EMSGSIZE;
238 goto done;
239 }
240
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700241 if (u_tmp->rx_buf) {
Ray Jui865f6d12014-10-09 11:19:25 -0700242 k_tmp->rx_buf = rx_buf;
David Brownell96ddbf52007-08-10 13:01:09 -0700243 if (!access_ok(VERIFY_WRITE, (u8 __user *)
Al Viro142956a2007-10-29 05:11:28 +0000244 (uintptr_t) u_tmp->rx_buf,
David Brownell96ddbf52007-08-10 13:01:09 -0700245 u_tmp->len))
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700246 goto done;
247 }
248 if (u_tmp->tx_buf) {
Ray Jui865f6d12014-10-09 11:19:25 -0700249 k_tmp->tx_buf = tx_buf;
250 if (copy_from_user(tx_buf, (const u8 __user *)
Al Viro142956a2007-10-29 05:11:28 +0000251 (uintptr_t) u_tmp->tx_buf,
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700252 u_tmp->len))
253 goto done;
254 }
Ray Jui865f6d12014-10-09 11:19:25 -0700255 tx_buf += k_tmp->len;
256 rx_buf += k_tmp->len;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700257
258 k_tmp->cs_change = !!u_tmp->cs_change;
Geert Uytterhoevendc64d392014-02-25 11:40:17 +0100259 k_tmp->tx_nbits = u_tmp->tx_nbits;
260 k_tmp->rx_nbits = u_tmp->rx_nbits;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700261 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;
Mark Brown91690512014-11-08 10:28:10 +0000264 if (!k_tmp->speed_hz)
265 k_tmp->speed_hz = spidev->speed_hz;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700266#ifdef VERBOSE
Florian Fainelli41df70d2009-12-07 14:28:43 +0000267 dev_dbg(&spidev->spi->dev,
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700268 " xfer len %zd %s%s%s%dbits %u usec %uHz\n",
269 u_tmp->len,
270 u_tmp->rx_buf ? "rx " : "",
271 u_tmp->tx_buf ? "tx " : "",
272 u_tmp->cs_change ? "cs " : "",
Florian Fainelli41df70d2009-12-07 14:28:43 +0000273 u_tmp->bits_per_word ? : spidev->spi->bits_per_word,
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700274 u_tmp->delay_usecs,
Florian Fainelli41df70d2009-12-07 14:28:43 +0000275 u_tmp->speed_hz ? : spidev->spi->max_speed_hz);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700276#endif
277 spi_message_add_tail(k_tmp, &msg);
278 }
279
David Brownell25d5cb42008-05-23 13:05:03 -0700280 status = spidev_sync(spidev, &msg);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700281 if (status < 0)
282 goto done;
283
284 /* copy any rx data out of bounce buffer */
Ray Jui865f6d12014-10-09 11:19:25 -0700285 rx_buf = spidev->rx_buffer;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700286 for (n = n_xfers, u_tmp = u_xfers; n; n--, u_tmp++) {
287 if (u_tmp->rx_buf) {
David Brownell4917d922007-07-17 04:04:04 -0700288 if (__copy_to_user((u8 __user *)
Ray Jui865f6d12014-10-09 11:19:25 -0700289 (uintptr_t) u_tmp->rx_buf, rx_buf,
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700290 u_tmp->len)) {
291 status = -EFAULT;
292 goto done;
293 }
294 }
Ray Jui865f6d12014-10-09 11:19:25 -0700295 rx_buf += u_tmp->len;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700296 }
297 status = total;
298
299done:
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700300 kfree(k_xfers);
301 return status;
302}
303
Ian Abbott7782a1a2015-01-30 18:43:33 +0000304static struct spi_ioc_transfer *
305spidev_get_ioc_message(unsigned int cmd, struct spi_ioc_transfer __user *u_ioc,
306 unsigned *n_ioc)
307{
308 struct spi_ioc_transfer *ioc;
309 u32 tmp;
310
311 /* Check type, command number and direction */
312 if (_IOC_TYPE(cmd) != SPI_IOC_MAGIC
313 || _IOC_NR(cmd) != _IOC_NR(SPI_IOC_MESSAGE(0))
314 || _IOC_DIR(cmd) != _IOC_WRITE)
315 return ERR_PTR(-ENOTTY);
316
317 tmp = _IOC_SIZE(cmd);
318 if ((tmp % sizeof(struct spi_ioc_transfer)) != 0)
319 return ERR_PTR(-EINVAL);
320 *n_ioc = tmp / sizeof(struct spi_ioc_transfer);
321 if (*n_ioc == 0)
322 return NULL;
323
324 /* copy into scratch area */
325 ioc = kmalloc(tmp, GFP_KERNEL);
326 if (!ioc)
327 return ERR_PTR(-ENOMEM);
328 if (__copy_from_user(ioc, u_ioc, tmp)) {
329 kfree(ioc);
330 return ERR_PTR(-EFAULT);
331 }
332 return ioc;
333}
334
Alan Cox4ef754b2008-07-23 21:29:55 -0700335static long
336spidev_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700337{
338 int err = 0;
339 int retval = 0;
340 struct spidev_data *spidev;
341 struct spi_device *spi;
342 u32 tmp;
343 unsigned n_ioc;
344 struct spi_ioc_transfer *ioc;
345
346 /* Check type and command number */
347 if (_IOC_TYPE(cmd) != SPI_IOC_MAGIC)
348 return -ENOTTY;
349
350 /* Check access direction once here; don't repeat below.
351 * IOC_DIR is from the user perspective, while access_ok is
352 * from the kernel perspective; so they look reversed.
353 */
354 if (_IOC_DIR(cmd) & _IOC_READ)
355 err = !access_ok(VERIFY_WRITE,
356 (void __user *)arg, _IOC_SIZE(cmd));
357 if (err == 0 && _IOC_DIR(cmd) & _IOC_WRITE)
358 err = !access_ok(VERIFY_READ,
359 (void __user *)arg, _IOC_SIZE(cmd));
360 if (err)
361 return -EFAULT;
362
David Brownell25d5cb42008-05-23 13:05:03 -0700363 /* guard against device removal before, or while,
364 * we issue this ioctl.
365 */
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700366 spidev = filp->private_data;
David Brownell25d5cb42008-05-23 13:05:03 -0700367 spin_lock_irq(&spidev->spi_lock);
368 spi = spi_dev_get(spidev->spi);
369 spin_unlock_irq(&spidev->spi_lock);
370
371 if (spi == NULL)
372 return -ESHUTDOWN;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700373
Alan Cox4ef754b2008-07-23 21:29:55 -0700374 /* use the buffer lock here for triple duty:
375 * - prevent I/O (from us) so calling spi_setup() is safe;
376 * - prevent concurrent SPI_IOC_WR_* from morphing
377 * data fields while SPI_IOC_RD_* reads them;
378 * - SPI_IOC_MESSAGE needs the buffer locked "normally".
379 */
380 mutex_lock(&spidev->buf_lock);
381
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700382 switch (cmd) {
383 /* read requests */
384 case SPI_IOC_RD_MODE:
385 retval = __put_user(spi->mode & SPI_MODE_MASK,
386 (__u8 __user *)arg);
387 break;
Geert Uytterhoevendc64d392014-02-25 11:40:17 +0100388 case SPI_IOC_RD_MODE32:
389 retval = __put_user(spi->mode & SPI_MODE_MASK,
390 (__u32 __user *)arg);
391 break;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700392 case SPI_IOC_RD_LSB_FIRST:
393 retval = __put_user((spi->mode & SPI_LSB_FIRST) ? 1 : 0,
394 (__u8 __user *)arg);
395 break;
396 case SPI_IOC_RD_BITS_PER_WORD:
397 retval = __put_user(spi->bits_per_word, (__u8 __user *)arg);
398 break;
399 case SPI_IOC_RD_MAX_SPEED_HZ:
Mark Brown91690512014-11-08 10:28:10 +0000400 retval = __put_user(spidev->speed_hz, (__u32 __user *)arg);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700401 break;
402
403 /* write requests */
404 case SPI_IOC_WR_MODE:
Geert Uytterhoevendc64d392014-02-25 11:40:17 +0100405 case SPI_IOC_WR_MODE32:
406 if (cmd == SPI_IOC_WR_MODE)
407 retval = __get_user(tmp, (u8 __user *)arg);
408 else
409 retval = __get_user(tmp, (u32 __user *)arg);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700410 if (retval == 0) {
Geert Uytterhoevene6456182014-02-25 11:40:16 +0100411 u32 save = spi->mode;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700412
413 if (tmp & ~SPI_MODE_MASK) {
414 retval = -EINVAL;
415 break;
416 }
417
418 tmp |= spi->mode & ~SPI_MODE_MASK;
Geert Uytterhoevendc64d392014-02-25 11:40:17 +0100419 spi->mode = (u16)tmp;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700420 retval = spi_setup(spi);
421 if (retval < 0)
422 spi->mode = save;
423 else
Geert Uytterhoevendc64d392014-02-25 11:40:17 +0100424 dev_dbg(&spi->dev, "spi mode %x\n", tmp);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700425 }
426 break;
427 case SPI_IOC_WR_LSB_FIRST:
428 retval = __get_user(tmp, (__u8 __user *)arg);
429 if (retval == 0) {
Geert Uytterhoevene6456182014-02-25 11:40:16 +0100430 u32 save = spi->mode;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700431
432 if (tmp)
433 spi->mode |= SPI_LSB_FIRST;
434 else
435 spi->mode &= ~SPI_LSB_FIRST;
436 retval = spi_setup(spi);
437 if (retval < 0)
438 spi->mode = save;
439 else
440 dev_dbg(&spi->dev, "%csb first\n",
441 tmp ? 'l' : 'm');
442 }
443 break;
444 case SPI_IOC_WR_BITS_PER_WORD:
445 retval = __get_user(tmp, (__u8 __user *)arg);
446 if (retval == 0) {
447 u8 save = spi->bits_per_word;
448
449 spi->bits_per_word = tmp;
450 retval = spi_setup(spi);
451 if (retval < 0)
452 spi->bits_per_word = save;
453 else
454 dev_dbg(&spi->dev, "%d bits per word\n", tmp);
455 }
456 break;
457 case SPI_IOC_WR_MAX_SPEED_HZ:
458 retval = __get_user(tmp, (__u32 __user *)arg);
459 if (retval == 0) {
460 u32 save = spi->max_speed_hz;
461
462 spi->max_speed_hz = tmp;
463 retval = spi_setup(spi);
Mark Brown91690512014-11-08 10:28:10 +0000464 if (retval >= 0)
465 spidev->speed_hz = tmp;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700466 else
467 dev_dbg(&spi->dev, "%d Hz (max)\n", tmp);
Mark Brown91690512014-11-08 10:28:10 +0000468 spi->max_speed_hz = save;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700469 }
470 break;
471
472 default:
473 /* segmented and/or full-duplex I/O request */
Ian Abbott7782a1a2015-01-30 18:43:33 +0000474 /* Check message and copy into scratch area */
475 ioc = spidev_get_ioc_message(cmd,
476 (struct spi_ioc_transfer __user *)arg, &n_ioc);
477 if (IS_ERR(ioc)) {
478 retval = PTR_ERR(ioc);
David Brownell25d5cb42008-05-23 13:05:03 -0700479 break;
480 }
Ian Abbott7782a1a2015-01-30 18:43:33 +0000481 if (!ioc)
482 break; /* n_ioc is also 0 */
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700483
484 /* translate to spi_message, execute */
485 retval = spidev_message(spidev, ioc, n_ioc);
486 kfree(ioc);
487 break;
488 }
Alan Cox4ef754b2008-07-23 21:29:55 -0700489
490 mutex_unlock(&spidev->buf_lock);
David Brownell25d5cb42008-05-23 13:05:03 -0700491 spi_dev_put(spi);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700492 return retval;
493}
494
Bernhard Walle7d48ec32011-02-03 09:37:18 +0100495#ifdef CONFIG_COMPAT
496static long
Ian Abbott7782a1a2015-01-30 18:43:33 +0000497spidev_compat_ioc_message(struct file *filp, unsigned int cmd,
498 unsigned long arg)
499{
500 struct spi_ioc_transfer __user *u_ioc;
501 int retval = 0;
502 struct spidev_data *spidev;
503 struct spi_device *spi;
504 unsigned n_ioc, n;
505 struct spi_ioc_transfer *ioc;
506
507 u_ioc = (struct spi_ioc_transfer __user *) compat_ptr(arg);
508 if (!access_ok(VERIFY_READ, u_ioc, _IOC_SIZE(cmd)))
509 return -EFAULT;
510
511 /* guard against device removal before, or while,
512 * we issue this ioctl.
513 */
514 spidev = filp->private_data;
515 spin_lock_irq(&spidev->spi_lock);
516 spi = spi_dev_get(spidev->spi);
517 spin_unlock_irq(&spidev->spi_lock);
518
519 if (spi == NULL)
520 return -ESHUTDOWN;
521
522 /* SPI_IOC_MESSAGE needs the buffer locked "normally" */
523 mutex_lock(&spidev->buf_lock);
524
525 /* Check message and copy into scratch area */
526 ioc = spidev_get_ioc_message(cmd, u_ioc, &n_ioc);
527 if (IS_ERR(ioc)) {
528 retval = PTR_ERR(ioc);
529 goto done;
530 }
531 if (!ioc)
532 goto done; /* n_ioc is also 0 */
533
534 /* Convert buffer pointers */
535 for (n = 0; n < n_ioc; n++) {
536 ioc[n].rx_buf = (uintptr_t) compat_ptr(ioc[n].rx_buf);
537 ioc[n].tx_buf = (uintptr_t) compat_ptr(ioc[n].tx_buf);
538 }
539
540 /* translate to spi_message, execute */
541 retval = spidev_message(spidev, ioc, n_ioc);
542 kfree(ioc);
543
544done:
545 mutex_unlock(&spidev->buf_lock);
546 spi_dev_put(spi);
547 return retval;
548}
549
550static long
Bernhard Walle7d48ec32011-02-03 09:37:18 +0100551spidev_compat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
552{
Ian Abbott7782a1a2015-01-30 18:43:33 +0000553 if (_IOC_TYPE(cmd) == SPI_IOC_MAGIC
554 && _IOC_NR(cmd) == _IOC_NR(SPI_IOC_MESSAGE(0))
555 && _IOC_DIR(cmd) == _IOC_WRITE)
556 return spidev_compat_ioc_message(filp, cmd, arg);
557
Bernhard Walle7d48ec32011-02-03 09:37:18 +0100558 return spidev_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
559}
560#else
561#define spidev_compat_ioctl NULL
562#endif /* CONFIG_COMPAT */
563
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700564static int spidev_open(struct inode *inode, struct file *filp)
565{
566 struct spidev_data *spidev;
567 int status = -ENXIO;
568
569 mutex_lock(&device_list_lock);
570
571 list_for_each_entry(spidev, &device_list, device_entry) {
David Brownellb2c8dad2008-06-05 22:45:50 -0700572 if (spidev->devt == inode->i_rdev) {
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700573 status = 0;
574 break;
575 }
576 }
Ray Jui865f6d12014-10-09 11:19:25 -0700577
578 if (status) {
579 pr_debug("spidev: nothing for minor %d\n", iminor(inode));
580 goto err_find_dev;
581 }
582
583 if (!spidev->tx_buffer) {
584 spidev->tx_buffer = kmalloc(bufsiz, GFP_KERNEL);
585 if (!spidev->tx_buffer) {
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700586 dev_dbg(&spidev->spi->dev, "open/ENOMEM\n");
587 status = -ENOMEM;
Ray Jui865f6d12014-10-09 11:19:25 -0700588 goto err_find_dev;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700589 }
590 }
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700591
Ray Jui865f6d12014-10-09 11:19:25 -0700592 if (!spidev->rx_buffer) {
593 spidev->rx_buffer = kmalloc(bufsiz, GFP_KERNEL);
594 if (!spidev->rx_buffer) {
595 dev_dbg(&spidev->spi->dev, "open/ENOMEM\n");
596 status = -ENOMEM;
597 goto err_alloc_rx_buf;
598 }
599 }
600
601 spidev->users++;
602 filp->private_data = spidev;
603 nonseekable_open(inode, filp);
604
605 mutex_unlock(&device_list_lock);
606 return 0;
607
608err_alloc_rx_buf:
609 kfree(spidev->tx_buffer);
610 spidev->tx_buffer = NULL;
611err_find_dev:
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700612 mutex_unlock(&device_list_lock);
613 return status;
614}
615
616static int spidev_release(struct inode *inode, struct file *filp)
617{
618 struct spidev_data *spidev;
619 int status = 0;
620
621 mutex_lock(&device_list_lock);
622 spidev = filp->private_data;
623 filp->private_data = NULL;
David Brownellb2c8dad2008-06-05 22:45:50 -0700624
625 /* last close? */
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700626 spidev->users--;
627 if (!spidev->users) {
David Brownellb2c8dad2008-06-05 22:45:50 -0700628 int dofree;
629
Ray Jui865f6d12014-10-09 11:19:25 -0700630 kfree(spidev->tx_buffer);
631 spidev->tx_buffer = NULL;
632
633 kfree(spidev->rx_buffer);
634 spidev->rx_buffer = NULL;
David Brownellb2c8dad2008-06-05 22:45:50 -0700635
Mark Brown91690512014-11-08 10:28:10 +0000636 spidev->speed_hz = spidev->spi->max_speed_hz;
637
David Brownellb2c8dad2008-06-05 22:45:50 -0700638 /* ... after we unbound from the underlying device? */
639 spin_lock_irq(&spidev->spi_lock);
640 dofree = (spidev->spi == NULL);
641 spin_unlock_irq(&spidev->spi_lock);
642
643 if (dofree)
644 kfree(spidev);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700645 }
646 mutex_unlock(&device_list_lock);
647
648 return status;
649}
650
Alexey Dobriyan828c0952009-10-01 15:43:56 -0700651static const struct file_operations spidev_fops = {
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700652 .owner = THIS_MODULE,
653 /* REVISIT switch to aio primitives, so that userspace
654 * gets more complete API coverage. It'll simplify things
655 * too, except for the locking.
656 */
657 .write = spidev_write,
658 .read = spidev_read,
Alan Cox4ef754b2008-07-23 21:29:55 -0700659 .unlocked_ioctl = spidev_ioctl,
Bernhard Walle7d48ec32011-02-03 09:37:18 +0100660 .compat_ioctl = spidev_compat_ioctl,
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700661 .open = spidev_open,
662 .release = spidev_release,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200663 .llseek = no_llseek,
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700664};
665
666/*-------------------------------------------------------------------------*/
667
668/* The main reason to have this class is to make mdev/udev create the
669 * /dev/spidevB.C character device nodes exposing our userspace API.
670 * It also simplifies memory management.
671 */
672
David Brownellb2c8dad2008-06-05 22:45:50 -0700673static struct class *spidev_class;
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700674
675/*-------------------------------------------------------------------------*/
676
Grant Likelyfd4a3192012-12-07 16:57:14 +0000677static int spidev_probe(struct spi_device *spi)
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700678{
679 struct spidev_data *spidev;
680 int status;
681 unsigned long minor;
682
683 /* Allocate driver data */
684 spidev = kzalloc(sizeof(*spidev), GFP_KERNEL);
685 if (!spidev)
686 return -ENOMEM;
687
688 /* Initialize the driver data */
689 spidev->spi = spi;
David Brownell25d5cb42008-05-23 13:05:03 -0700690 spin_lock_init(&spidev->spi_lock);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700691 mutex_init(&spidev->buf_lock);
692
693 INIT_LIST_HEAD(&spidev->device_entry);
694
695 /* If we can allocate a minor number, hook up this device.
696 * Reusing minors is fine so long as udev or mdev is working.
697 */
698 mutex_lock(&device_list_lock);
Domen Puncer0a4dd772007-05-15 23:57:05 -0700699 minor = find_first_zero_bit(minors, N_SPI_MINORS);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700700 if (minor < N_SPI_MINORS) {
David Brownellb2c8dad2008-06-05 22:45:50 -0700701 struct device *dev;
702
703 spidev->devt = MKDEV(SPIDEV_MAJOR, minor);
Greg Kroah-Hartmana9b12612008-07-21 20:03:34 -0700704 dev = device_create(spidev_class, &spi->dev, spidev->devt,
705 spidev, "spidev%d.%d",
706 spi->master->bus_num, spi->chip_select);
Rusty Russell8c6ffba2013-07-15 11:20:32 +0930707 status = PTR_ERR_OR_ZERO(dev);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700708 } else {
709 dev_dbg(&spi->dev, "no minor number available!\n");
710 status = -ENODEV;
711 }
712 if (status == 0) {
713 set_bit(minor, minors);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700714 list_add(&spidev->device_entry, &device_list);
715 }
716 mutex_unlock(&device_list_lock);
717
Mark Brown91690512014-11-08 10:28:10 +0000718 spidev->speed_hz = spi->max_speed_hz;
719
Wolfgang Ockeraaacf4b2008-12-01 13:13:52 -0800720 if (status == 0)
721 spi_set_drvdata(spi, spidev);
722 else
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700723 kfree(spidev);
724
725 return status;
726}
727
Grant Likelyfd4a3192012-12-07 16:57:14 +0000728static int spidev_remove(struct spi_device *spi)
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700729{
David Brownellb2c8dad2008-06-05 22:45:50 -0700730 struct spidev_data *spidev = spi_get_drvdata(spi);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700731
David Brownell25d5cb42008-05-23 13:05:03 -0700732 /* make sure ops on existing fds can abort cleanly */
733 spin_lock_irq(&spidev->spi_lock);
734 spidev->spi = NULL;
735 spin_unlock_irq(&spidev->spi_lock);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700736
David Brownell25d5cb42008-05-23 13:05:03 -0700737 /* prevent new opens */
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700738 mutex_lock(&device_list_lock);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700739 list_del(&spidev->device_entry);
David Brownellb2c8dad2008-06-05 22:45:50 -0700740 device_destroy(spidev_class, spidev->devt);
741 clear_bit(MINOR(spidev->devt), minors);
742 if (spidev->users == 0)
743 kfree(spidev);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700744 mutex_unlock(&device_list_lock);
745
746 return 0;
747}
748
Maxime Ripard880cfd42012-10-31 11:30:08 +0100749static const struct of_device_id spidev_dt_ids[] = {
Maxime Ripard8fad8052012-10-31 11:30:09 +0100750 { .compatible = "rohm,dh2228fv" },
Maxime Ripard880cfd42012-10-31 11:30:08 +0100751 {},
752};
753
754MODULE_DEVICE_TABLE(of, spidev_dt_ids);
755
Mike Frysingerdb389b62009-12-14 14:20:22 -0800756static struct spi_driver spidev_spi_driver = {
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700757 .driver = {
758 .name = "spidev",
759 .owner = THIS_MODULE,
Maxime Ripard880cfd42012-10-31 11:30:08 +0100760 .of_match_table = of_match_ptr(spidev_dt_ids),
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700761 },
762 .probe = spidev_probe,
Grant Likelyfd4a3192012-12-07 16:57:14 +0000763 .remove = spidev_remove,
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700764
765 /* NOTE: suspend/resume methods are not necessary here.
766 * We don't do anything except pass the requests to/from
767 * the underlying controller. The refrigerator handles
768 * most issues; the controller driver handles the rest.
769 */
770};
771
772/*-------------------------------------------------------------------------*/
773
774static int __init spidev_init(void)
775{
776 int status;
777
778 /* Claim our 256 reserved device numbers. Then register a class
779 * that will key udev/mdev to add/remove /dev nodes. Last, register
780 * the driver which manages those device numbers.
781 */
782 BUILD_BUG_ON(N_SPI_MINORS > 256);
783 status = register_chrdev(SPIDEV_MAJOR, "spi", &spidev_fops);
784 if (status < 0)
785 return status;
786
David Brownellb2c8dad2008-06-05 22:45:50 -0700787 spidev_class = class_create(THIS_MODULE, "spidev");
788 if (IS_ERR(spidev_class)) {
Mike Frysingerdb389b62009-12-14 14:20:22 -0800789 unregister_chrdev(SPIDEV_MAJOR, spidev_spi_driver.driver.name);
David Brownellb2c8dad2008-06-05 22:45:50 -0700790 return PTR_ERR(spidev_class);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700791 }
792
Mike Frysingerdb389b62009-12-14 14:20:22 -0800793 status = spi_register_driver(&spidev_spi_driver);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700794 if (status < 0) {
David Brownellb2c8dad2008-06-05 22:45:50 -0700795 class_destroy(spidev_class);
Mike Frysingerdb389b62009-12-14 14:20:22 -0800796 unregister_chrdev(SPIDEV_MAJOR, spidev_spi_driver.driver.name);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700797 }
798 return status;
799}
800module_init(spidev_init);
801
802static void __exit spidev_exit(void)
803{
Mike Frysingerdb389b62009-12-14 14:20:22 -0800804 spi_unregister_driver(&spidev_spi_driver);
David Brownellb2c8dad2008-06-05 22:45:50 -0700805 class_destroy(spidev_class);
Mike Frysingerdb389b62009-12-14 14:20:22 -0800806 unregister_chrdev(SPIDEV_MAJOR, spidev_spi_driver.driver.name);
Andrea Paterniani814a8d52007-05-08 00:32:15 -0700807}
808module_exit(spidev_exit);
809
810MODULE_AUTHOR("Andrea Paterniani, <a.paterniani@swapp-eng.it>");
811MODULE_DESCRIPTION("User mode SPI device interface");
812MODULE_LICENSE("GPL");
Anton Vorontsove0626e32009-09-22 16:46:08 -0700813MODULE_ALIAS("spi:spidev");