bsg: mark FUJITA Tomonori as bsg maintainer
[GitHub/LineageOS/android_kernel_samsung_universal7580.git] / block / bsg.c
CommitLineData
3d6392cf
JA
1/*
2 * bsg.c - block layer implementation of the sg v3 interface
3 *
4 * Copyright (C) 2004 Jens Axboe <axboe@suse.de> SUSE Labs
5 * Copyright (C) 2004 Peter M. Jones <pjones@redhat.com>
6 *
7 * This file is subject to the terms and conditions of the GNU General Public
8 * License version 2. See the file "COPYING" in the main directory of this
9 * archive for more details.
10 *
11 */
12/*
13 * TODO
14 * - Should this get merged, block/scsi_ioctl.c will be migrated into
15 * this file. To keep maintenance down, it's easier to have them
16 * seperated right now.
17 *
18 */
3d6392cf
JA
19#include <linux/module.h>
20#include <linux/init.h>
21#include <linux/file.h>
22#include <linux/blkdev.h>
23#include <linux/poll.h>
24#include <linux/cdev.h>
25#include <linux/percpu.h>
26#include <linux/uio.h>
27#include <linux/bsg.h>
28
29#include <scsi/scsi.h>
30#include <scsi/scsi_ioctl.h>
31#include <scsi/scsi_cmnd.h>
4e2872d6
FT
32#include <scsi/scsi_device.h>
33#include <scsi/scsi_driver.h>
3d6392cf
JA
34#include <scsi/sg.h>
35
25fd1643 36const static char bsg_version[] = "block layer sg (bsg) 0.4";
3d6392cf 37
3d6392cf 38struct bsg_device {
3d6392cf
JA
39 request_queue_t *queue;
40 spinlock_t lock;
41 struct list_head busy_list;
42 struct list_head done_list;
43 struct hlist_node dev_list;
44 atomic_t ref_count;
45 int minor;
46 int queued_cmds;
47 int done_cmds;
3d6392cf
JA
48 wait_queue_head_t wq_done;
49 wait_queue_head_t wq_free;
d351af01 50 char name[BUS_ID_SIZE];
3d6392cf
JA
51 int max_queue;
52 unsigned long flags;
53};
54
55enum {
56 BSG_F_BLOCK = 1,
57 BSG_F_WRITE_PERM = 2,
58};
59
5309cb38 60#define BSG_DEFAULT_CMDS 64
292b7f27 61#define BSG_MAX_DEVS 32768
3d6392cf
JA
62
63#undef BSG_DEBUG
64
65#ifdef BSG_DEBUG
66#define dprintk(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ##args)
67#else
68#define dprintk(fmt, args...)
69#endif
70
3d6392cf 71static DEFINE_MUTEX(bsg_mutex);
292b7f27 72static int bsg_device_nr, bsg_minor_idx;
3d6392cf 73
25fd1643
JA
74#define BSG_LIST_ARRAY_SIZE 8
75#define bsg_list_idx(minor) ((minor) & (BSG_LIST_ARRAY_SIZE - 1))
76static struct hlist_head bsg_device_list[BSG_LIST_ARRAY_SIZE];
3d6392cf
JA
77
78static struct class *bsg_class;
79static LIST_HEAD(bsg_class_list);
46f6ef4a 80static int bsg_major;
3d6392cf 81
5309cb38
JA
82static struct kmem_cache *bsg_cmd_cachep;
83
3d6392cf
JA
84/*
85 * our internal command type
86 */
87struct bsg_command {
88 struct bsg_device *bd;
89 struct list_head list;
90 struct request *rq;
91 struct bio *bio;
2c9ecdf4 92 struct bio *bidi_bio;
3d6392cf 93 int err;
70e36ece
FT
94 struct sg_io_v4 hdr;
95 struct sg_io_v4 __user *uhdr;
3d6392cf
JA
96 char sense[SCSI_SENSE_BUFFERSIZE];
97};
98
99static void bsg_free_command(struct bsg_command *bc)
100{
101 struct bsg_device *bd = bc->bd;
3d6392cf
JA
102 unsigned long flags;
103
5309cb38 104 kmem_cache_free(bsg_cmd_cachep, bc);
3d6392cf
JA
105
106 spin_lock_irqsave(&bd->lock, flags);
107 bd->queued_cmds--;
3d6392cf
JA
108 spin_unlock_irqrestore(&bd->lock, flags);
109
110 wake_up(&bd->wq_free);
111}
112
e7d72173 113static struct bsg_command *bsg_alloc_command(struct bsg_device *bd)
3d6392cf 114{
e7d72173 115 struct bsg_command *bc = ERR_PTR(-EINVAL);
3d6392cf
JA
116
117 spin_lock_irq(&bd->lock);
118
119 if (bd->queued_cmds >= bd->max_queue)
120 goto out;
121
3d6392cf 122 bd->queued_cmds++;
3d6392cf
JA
123 spin_unlock_irq(&bd->lock);
124
25fd1643 125 bc = kmem_cache_zalloc(bsg_cmd_cachep, GFP_KERNEL);
5309cb38
JA
126 if (unlikely(!bc)) {
127 spin_lock_irq(&bd->lock);
7e75d730 128 bd->queued_cmds--;
e7d72173 129 bc = ERR_PTR(-ENOMEM);
7e75d730 130 goto out;
5309cb38
JA
131 }
132
3d6392cf
JA
133 bc->bd = bd;
134 INIT_LIST_HEAD(&bc->list);
5309cb38 135 dprintk("%s: returning free cmd %p\n", bd->name, bc);
3d6392cf
JA
136 return bc;
137out:
3d6392cf
JA
138 spin_unlock_irq(&bd->lock);
139 return bc;
140}
141
3d6392cf
JA
142static inline void
143bsg_add_done_cmd(struct bsg_device *bd, struct bsg_command *bc)
144{
3d6392cf
JA
145}
146
25fd1643 147static int bsg_io_schedule(struct bsg_device *bd)
3d6392cf
JA
148{
149 DEFINE_WAIT(wait);
150 int ret = 0;
151
152 spin_lock_irq(&bd->lock);
153
154 BUG_ON(bd->done_cmds > bd->queued_cmds);
155
156 /*
157 * -ENOSPC or -ENODATA? I'm going for -ENODATA, meaning "I have no
158 * work to do", even though we return -ENOSPC after this same test
159 * during bsg_write() -- there, it means our buffer can't have more
160 * bsg_commands added to it, thus has no space left.
161 */
162 if (bd->done_cmds == bd->queued_cmds) {
163 ret = -ENODATA;
164 goto unlock;
165 }
166
167 if (!test_bit(BSG_F_BLOCK, &bd->flags)) {
168 ret = -EAGAIN;
169 goto unlock;
170 }
171
25fd1643 172 prepare_to_wait(&bd->wq_done, &wait, TASK_UNINTERRUPTIBLE);
3d6392cf
JA
173 spin_unlock_irq(&bd->lock);
174 io_schedule();
175 finish_wait(&bd->wq_done, &wait);
176
3d6392cf
JA
177 return ret;
178unlock:
179 spin_unlock_irq(&bd->lock);
180 return ret;
181}
182
70e36ece
FT
183static int blk_fill_sgv4_hdr_rq(request_queue_t *q, struct request *rq,
184 struct sg_io_v4 *hdr, int has_write_perm)
185{
186 memset(rq->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */
187
188 if (copy_from_user(rq->cmd, (void *)(unsigned long)hdr->request,
189 hdr->request_len))
190 return -EFAULT;
15d10b61
FT
191
192 if (hdr->subprotocol == BSG_SUB_PROTOCOL_SCSI_CMD) {
193 if (blk_verify_command(rq->cmd, has_write_perm))
194 return -EPERM;
195 } else if (!capable(CAP_SYS_RAWIO))
70e36ece
FT
196 return -EPERM;
197
198 /*
199 * fill in request structure
200 */
201 rq->cmd_len = hdr->request_len;
202 rq->cmd_type = REQ_TYPE_BLOCK_PC;
203
204 rq->timeout = (hdr->timeout * HZ) / 1000;
205 if (!rq->timeout)
206 rq->timeout = q->sg_timeout;
207 if (!rq->timeout)
208 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
209
210 return 0;
211}
212
3d6392cf 213/*
70e36ece 214 * Check if sg_io_v4 from user is allowed and valid
3d6392cf
JA
215 */
216static int
70e36ece 217bsg_validate_sgv4_hdr(request_queue_t *q, struct sg_io_v4 *hdr, int *rw)
3d6392cf 218{
15d10b61
FT
219 int ret = 0;
220
70e36ece 221 if (hdr->guard != 'Q')
3d6392cf 222 return -EINVAL;
70e36ece 223 if (hdr->request_len > BLK_MAX_CDB)
3d6392cf 224 return -EINVAL;
70e36ece
FT
225 if (hdr->dout_xfer_len > (q->max_sectors << 9) ||
226 hdr->din_xfer_len > (q->max_sectors << 9))
3d6392cf
JA
227 return -EIO;
228
15d10b61
FT
229 switch (hdr->protocol) {
230 case BSG_PROTOCOL_SCSI:
231 switch (hdr->subprotocol) {
232 case BSG_SUB_PROTOCOL_SCSI_CMD:
233 case BSG_SUB_PROTOCOL_SCSI_TRANSPORT:
234 break;
235 default:
236 ret = -EINVAL;
237 }
238 break;
239 default:
240 ret = -EINVAL;
241 }
70e36ece 242
70e36ece 243 *rw = hdr->dout_xfer_len ? WRITE : READ;
15d10b61 244 return ret;
3d6392cf
JA
245}
246
247/*
70e36ece 248 * map sg_io_v4 to a request.
3d6392cf
JA
249 */
250static struct request *
70e36ece 251bsg_map_hdr(struct bsg_device *bd, struct sg_io_v4 *hdr)
3d6392cf
JA
252{
253 request_queue_t *q = bd->queue;
2c9ecdf4 254 struct request *rq, *next_rq = NULL;
25fd1643 255 int ret, rw;
70e36ece
FT
256 unsigned int dxfer_len;
257 void *dxferp = NULL;
3d6392cf 258
70e36ece
FT
259 dprintk("map hdr %llx/%u %llx/%u\n", (unsigned long long) hdr->dout_xferp,
260 hdr->dout_xfer_len, (unsigned long long) hdr->din_xferp,
261 hdr->din_xfer_len);
3d6392cf 262
70e36ece 263 ret = bsg_validate_sgv4_hdr(q, hdr, &rw);
3d6392cf
JA
264 if (ret)
265 return ERR_PTR(ret);
266
267 /*
268 * map scatter-gather elements seperately and string them to request
269 */
270 rq = blk_get_request(q, rw, GFP_KERNEL);
2c9ecdf4
FT
271 if (!rq)
272 return ERR_PTR(-ENOMEM);
70e36ece
FT
273 ret = blk_fill_sgv4_hdr_rq(q, rq, hdr, test_bit(BSG_F_WRITE_PERM,
274 &bd->flags));
2c9ecdf4
FT
275 if (ret)
276 goto out;
277
278 if (rw == WRITE && hdr->din_xfer_len) {
279 if (!test_bit(QUEUE_FLAG_BIDI, &q->queue_flags)) {
280 ret = -EOPNOTSUPP;
281 goto out;
282 }
283
284 next_rq = blk_get_request(q, READ, GFP_KERNEL);
285 if (!next_rq) {
286 ret = -ENOMEM;
287 goto out;
288 }
289 rq->next_rq = next_rq;
290
291 dxferp = (void*)(unsigned long)hdr->din_xferp;
292 ret = blk_rq_map_user(q, next_rq, dxferp, hdr->din_xfer_len);
293 if (ret)
294 goto out;
3d6392cf
JA
295 }
296
70e36ece
FT
297 if (hdr->dout_xfer_len) {
298 dxfer_len = hdr->dout_xfer_len;
299 dxferp = (void*)(unsigned long)hdr->dout_xferp;
300 } else if (hdr->din_xfer_len) {
301 dxfer_len = hdr->din_xfer_len;
302 dxferp = (void*)(unsigned long)hdr->din_xferp;
303 } else
304 dxfer_len = 0;
305
306 if (dxfer_len) {
307 ret = blk_rq_map_user(q, rq, dxferp, dxfer_len);
2c9ecdf4
FT
308 if (ret)
309 goto out;
3d6392cf 310 }
3d6392cf 311 return rq;
2c9ecdf4
FT
312out:
313 blk_put_request(rq);
314 if (next_rq) {
315 blk_rq_unmap_user(next_rq->bio);
316 blk_put_request(next_rq);
317 }
318 return ERR_PTR(ret);
3d6392cf
JA
319}
320
321/*
322 * async completion call-back from the block layer, when scsi/ide/whatever
323 * calls end_that_request_last() on a request
324 */
325static void bsg_rq_end_io(struct request *rq, int uptodate)
326{
327 struct bsg_command *bc = rq->end_io_data;
328 struct bsg_device *bd = bc->bd;
329 unsigned long flags;
330
5309cb38
JA
331 dprintk("%s: finished rq %p bc %p, bio %p stat %d\n",
332 bd->name, rq, bc, bc->bio, uptodate);
3d6392cf
JA
333
334 bc->hdr.duration = jiffies_to_msecs(jiffies - bc->hdr.duration);
335
336 spin_lock_irqsave(&bd->lock, flags);
25fd1643
JA
337 list_move_tail(&bc->list, &bd->done_list);
338 bd->done_cmds++;
3d6392cf 339 spin_unlock_irqrestore(&bd->lock, flags);
25fd1643
JA
340
341 wake_up(&bd->wq_done);
3d6392cf
JA
342}
343
344/*
345 * do final setup of a 'bc' and submit the matching 'rq' to the block
346 * layer for io
347 */
348static void bsg_add_command(struct bsg_device *bd, request_queue_t *q,
349 struct bsg_command *bc, struct request *rq)
350{
351 rq->sense = bc->sense;
352 rq->sense_len = 0;
353
354 /*
355 * add bc command to busy queue and submit rq for io
356 */
357 bc->rq = rq;
358 bc->bio = rq->bio;
2c9ecdf4
FT
359 if (rq->next_rq)
360 bc->bidi_bio = rq->next_rq->bio;
3d6392cf
JA
361 bc->hdr.duration = jiffies;
362 spin_lock_irq(&bd->lock);
363 list_add_tail(&bc->list, &bd->busy_list);
364 spin_unlock_irq(&bd->lock);
365
366 dprintk("%s: queueing rq %p, bc %p\n", bd->name, rq, bc);
367
368 rq->end_io_data = bc;
d351af01 369 blk_execute_rq_nowait(q, NULL, rq, 1, bsg_rq_end_io);
3d6392cf
JA
370}
371
25fd1643 372static struct bsg_command *bsg_next_done_cmd(struct bsg_device *bd)
3d6392cf
JA
373{
374 struct bsg_command *bc = NULL;
375
376 spin_lock_irq(&bd->lock);
377 if (bd->done_cmds) {
25fd1643
JA
378 bc = list_entry(bd->done_list.next, struct bsg_command, list);
379 list_del(&bc->list);
380 bd->done_cmds--;
3d6392cf
JA
381 }
382 spin_unlock_irq(&bd->lock);
383
384 return bc;
385}
386
387/*
388 * Get a finished command from the done list
389 */
e7d72173 390static struct bsg_command *bsg_get_done_cmd(struct bsg_device *bd)
3d6392cf
JA
391{
392 struct bsg_command *bc;
393 int ret;
394
395 do {
396 bc = bsg_next_done_cmd(bd);
397 if (bc)
398 break;
399
e7d72173
FT
400 if (!test_bit(BSG_F_BLOCK, &bd->flags)) {
401 bc = ERR_PTR(-EAGAIN);
402 break;
403 }
404
405 ret = wait_event_interruptible(bd->wq_done, bd->done_cmds);
3d6392cf 406 if (ret) {
e7d72173 407 bc = ERR_PTR(-ERESTARTSYS);
3d6392cf
JA
408 break;
409 }
410 } while (1);
411
412 dprintk("%s: returning done %p\n", bd->name, bc);
413
414 return bc;
415}
416
70e36ece 417static int blk_complete_sgv4_hdr_rq(struct request *rq, struct sg_io_v4 *hdr,
2c9ecdf4 418 struct bio *bio, struct bio *bidi_bio)
70e36ece
FT
419{
420 int ret = 0;
421
422 dprintk("rq %p bio %p %u\n", rq, bio, rq->errors);
423 /*
424 * fill in all the output members
425 */
426 hdr->device_status = status_byte(rq->errors);
427 hdr->transport_status = host_byte(rq->errors);
428 hdr->driver_status = driver_byte(rq->errors);
429 hdr->info = 0;
430 if (hdr->device_status || hdr->transport_status || hdr->driver_status)
431 hdr->info |= SG_INFO_CHECK;
432 hdr->din_resid = rq->data_len;
433 hdr->response_len = 0;
434
435 if (rq->sense_len && hdr->response) {
25fd1643
JA
436 int len = min_t(unsigned int, hdr->max_response_len,
437 rq->sense_len);
70e36ece
FT
438
439 ret = copy_to_user((void*)(unsigned long)hdr->response,
440 rq->sense, len);
441 if (!ret)
442 hdr->response_len = len;
443 else
444 ret = -EFAULT;
445 }
446
2c9ecdf4
FT
447 if (rq->next_rq) {
448 blk_rq_unmap_user(bidi_bio);
449 blk_put_request(rq->next_rq);
450 }
451
70e36ece
FT
452 blk_rq_unmap_user(bio);
453 blk_put_request(rq);
454
455 return ret;
456}
457
3d6392cf
JA
458static int bsg_complete_all_commands(struct bsg_device *bd)
459{
460 struct bsg_command *bc;
461 int ret, tret;
462
463 dprintk("%s: entered\n", bd->name);
464
465 set_bit(BSG_F_BLOCK, &bd->flags);
466
467 /*
468 * wait for all commands to complete
469 */
470 ret = 0;
471 do {
25fd1643 472 ret = bsg_io_schedule(bd);
3d6392cf
JA
473 /*
474 * look for -ENODATA specifically -- we'll sometimes get
475 * -ERESTARTSYS when we've taken a signal, but we can't
476 * return until we're done freeing the queue, so ignore
477 * it. The signal will get handled when we're done freeing
478 * the bsg_device.
479 */
480 } while (ret != -ENODATA);
481
482 /*
483 * discard done commands
484 */
485 ret = 0;
486 do {
e7d72173
FT
487 spin_lock_irq(&bd->lock);
488 if (!bd->queued_cmds) {
489 spin_unlock_irq(&bd->lock);
3d6392cf
JA
490 break;
491 }
efba1a31 492 spin_unlock_irq(&bd->lock);
3d6392cf 493
e7d72173
FT
494 bc = bsg_get_done_cmd(bd);
495 if (IS_ERR(bc))
496 break;
497
2c9ecdf4
FT
498 tret = blk_complete_sgv4_hdr_rq(bc->rq, &bc->hdr, bc->bio,
499 bc->bidi_bio);
3d6392cf
JA
500 if (!ret)
501 ret = tret;
502
503 bsg_free_command(bc);
504 } while (1);
505
506 return ret;
507}
508
25fd1643 509static int
e7d72173
FT
510__bsg_read(char __user *buf, size_t count, struct bsg_device *bd,
511 const struct iovec *iov, ssize_t *bytes_read)
3d6392cf
JA
512{
513 struct bsg_command *bc;
514 int nr_commands, ret;
515
70e36ece 516 if (count % sizeof(struct sg_io_v4))
3d6392cf
JA
517 return -EINVAL;
518
519 ret = 0;
70e36ece 520 nr_commands = count / sizeof(struct sg_io_v4);
3d6392cf 521 while (nr_commands) {
e7d72173 522 bc = bsg_get_done_cmd(bd);
3d6392cf
JA
523 if (IS_ERR(bc)) {
524 ret = PTR_ERR(bc);
525 break;
526 }
527
528 /*
529 * this is the only case where we need to copy data back
530 * after completing the request. so do that here,
531 * bsg_complete_work() cannot do that for us
532 */
2c9ecdf4
FT
533 ret = blk_complete_sgv4_hdr_rq(bc->rq, &bc->hdr, bc->bio,
534 bc->bidi_bio);
3d6392cf 535
25fd1643 536 if (copy_to_user(buf, &bc->hdr, sizeof(bc->hdr)))
3d6392cf
JA
537 ret = -EFAULT;
538
539 bsg_free_command(bc);
540
541 if (ret)
542 break;
543
70e36ece
FT
544 buf += sizeof(struct sg_io_v4);
545 *bytes_read += sizeof(struct sg_io_v4);
3d6392cf
JA
546 nr_commands--;
547 }
548
549 return ret;
550}
551
552static inline void bsg_set_block(struct bsg_device *bd, struct file *file)
553{
554 if (file->f_flags & O_NONBLOCK)
555 clear_bit(BSG_F_BLOCK, &bd->flags);
556 else
557 set_bit(BSG_F_BLOCK, &bd->flags);
558}
559
560static inline void bsg_set_write_perm(struct bsg_device *bd, struct file *file)
561{
562 if (file->f_mode & FMODE_WRITE)
563 set_bit(BSG_F_WRITE_PERM, &bd->flags);
564 else
565 clear_bit(BSG_F_WRITE_PERM, &bd->flags);
566}
567
25fd1643
JA
568/*
569 * Check if the error is a "real" error that we should return.
570 */
3d6392cf
JA
571static inline int err_block_err(int ret)
572{
573 if (ret && ret != -ENOSPC && ret != -ENODATA && ret != -EAGAIN)
574 return 1;
575
576 return 0;
577}
578
579static ssize_t
580bsg_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
581{
582 struct bsg_device *bd = file->private_data;
583 int ret;
584 ssize_t bytes_read;
585
9e69fbb5 586 dprintk("%s: read %Zd bytes\n", bd->name, count);
3d6392cf
JA
587
588 bsg_set_block(bd, file);
589 bytes_read = 0;
e7d72173 590 ret = __bsg_read(buf, count, bd, NULL, &bytes_read);
3d6392cf
JA
591 *ppos = bytes_read;
592
593 if (!bytes_read || (bytes_read && err_block_err(ret)))
594 bytes_read = ret;
595
596 return bytes_read;
597}
598
25fd1643
JA
599static int __bsg_write(struct bsg_device *bd, const char __user *buf,
600 size_t count, ssize_t *bytes_written)
3d6392cf
JA
601{
602 struct bsg_command *bc;
603 struct request *rq;
604 int ret, nr_commands;
605
70e36ece 606 if (count % sizeof(struct sg_io_v4))
3d6392cf
JA
607 return -EINVAL;
608
70e36ece 609 nr_commands = count / sizeof(struct sg_io_v4);
3d6392cf
JA
610 rq = NULL;
611 bc = NULL;
612 ret = 0;
613 while (nr_commands) {
614 request_queue_t *q = bd->queue;
3d6392cf 615
e7d72173 616 bc = bsg_alloc_command(bd);
3d6392cf
JA
617 if (IS_ERR(bc)) {
618 ret = PTR_ERR(bc);
619 bc = NULL;
620 break;
621 }
622
70e36ece 623 bc->uhdr = (struct sg_io_v4 __user *) buf;
3d6392cf
JA
624 if (copy_from_user(&bc->hdr, buf, sizeof(bc->hdr))) {
625 ret = -EFAULT;
626 break;
627 }
628
629 /*
630 * get a request, fill in the blanks, and add to request queue
631 */
70e36ece 632 rq = bsg_map_hdr(bd, &bc->hdr);
3d6392cf
JA
633 if (IS_ERR(rq)) {
634 ret = PTR_ERR(rq);
635 rq = NULL;
636 break;
637 }
638
639 bsg_add_command(bd, q, bc, rq);
640 bc = NULL;
641 rq = NULL;
642 nr_commands--;
70e36ece 643 buf += sizeof(struct sg_io_v4);
25fd1643 644 *bytes_written += sizeof(struct sg_io_v4);
3d6392cf
JA
645 }
646
3d6392cf
JA
647 if (bc)
648 bsg_free_command(bc);
649
650 return ret;
651}
652
653static ssize_t
654bsg_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
655{
656 struct bsg_device *bd = file->private_data;
25fd1643 657 ssize_t bytes_written;
3d6392cf
JA
658 int ret;
659
9e69fbb5 660 dprintk("%s: write %Zd bytes\n", bd->name, count);
3d6392cf
JA
661
662 bsg_set_block(bd, file);
663 bsg_set_write_perm(bd, file);
664
25fd1643
JA
665 bytes_written = 0;
666 ret = __bsg_write(bd, buf, count, &bytes_written);
667 *ppos = bytes_written;
3d6392cf
JA
668
669 /*
670 * return bytes written on non-fatal errors
671 */
25fd1643
JA
672 if (!bytes_written || (bytes_written && err_block_err(ret)))
673 bytes_written = ret;
3d6392cf 674
25fd1643
JA
675 dprintk("%s: returning %Zd\n", bd->name, bytes_written);
676 return bytes_written;
3d6392cf
JA
677}
678
3d6392cf
JA
679static struct bsg_device *bsg_alloc_device(void)
680{
3d6392cf 681 struct bsg_device *bd;
3d6392cf
JA
682
683 bd = kzalloc(sizeof(struct bsg_device), GFP_KERNEL);
684 if (unlikely(!bd))
685 return NULL;
686
687 spin_lock_init(&bd->lock);
688
5309cb38 689 bd->max_queue = BSG_DEFAULT_CMDS;
3d6392cf
JA
690
691 INIT_LIST_HEAD(&bd->busy_list);
692 INIT_LIST_HEAD(&bd->done_list);
693 INIT_HLIST_NODE(&bd->dev_list);
694
695 init_waitqueue_head(&bd->wq_free);
696 init_waitqueue_head(&bd->wq_done);
697 return bd;
3d6392cf
JA
698}
699
700static int bsg_put_device(struct bsg_device *bd)
701{
702 int ret = 0;
703
704 mutex_lock(&bsg_mutex);
705
706 if (!atomic_dec_and_test(&bd->ref_count))
707 goto out;
708
709 dprintk("%s: tearing down\n", bd->name);
710
711 /*
712 * close can always block
713 */
714 set_bit(BSG_F_BLOCK, &bd->flags);
715
716 /*
717 * correct error detection baddies here again. it's the responsibility
718 * of the app to properly reap commands before close() if it wants
719 * fool-proof error detection
720 */
721 ret = bsg_complete_all_commands(bd);
722
723 blk_put_queue(bd->queue);
724 hlist_del(&bd->dev_list);
5309cb38 725 kfree(bd);
3d6392cf
JA
726out:
727 mutex_unlock(&bsg_mutex);
728 return ret;
729}
730
731static struct bsg_device *bsg_add_device(struct inode *inode,
d351af01 732 struct request_queue *rq,
3d6392cf
JA
733 struct file *file)
734{
25fd1643 735 struct bsg_device *bd;
3d6392cf
JA
736#ifdef BSG_DEBUG
737 unsigned char buf[32];
738#endif
739
740 bd = bsg_alloc_device();
741 if (!bd)
742 return ERR_PTR(-ENOMEM);
743
d351af01
FT
744 bd->queue = rq;
745 kobject_get(&rq->kobj);
3d6392cf
JA
746 bsg_set_block(bd, file);
747
748 atomic_set(&bd->ref_count, 1);
749 bd->minor = iminor(inode);
750 mutex_lock(&bsg_mutex);
25fd1643
JA
751 hlist_add_head(&bd->dev_list,
752 &bsg_device_list[bd->minor & (BSG_LIST_ARRAY_SIZE - 1)]);
3d6392cf 753
d351af01 754 strncpy(bd->name, rq->bsg_dev.class_dev->class_id, sizeof(bd->name) - 1);
3d6392cf 755 dprintk("bound to <%s>, max queue %d\n",
9e69fbb5 756 format_dev_t(buf, inode->i_rdev), bd->max_queue);
3d6392cf
JA
757
758 mutex_unlock(&bsg_mutex);
759 return bd;
760}
761
762static struct bsg_device *__bsg_get_device(int minor)
763{
25fd1643 764 struct hlist_head *list;
3d6392cf
JA
765 struct bsg_device *bd = NULL;
766 struct hlist_node *entry;
767
768 mutex_lock(&bsg_mutex);
769
25fd1643 770 list = &bsg_device_list[minor & (BSG_LIST_ARRAY_SIZE - 1)];
3d6392cf
JA
771 hlist_for_each(entry, list) {
772 bd = hlist_entry(entry, struct bsg_device, dev_list);
773 if (bd->minor == minor) {
774 atomic_inc(&bd->ref_count);
775 break;
776 }
777
778 bd = NULL;
779 }
780
781 mutex_unlock(&bsg_mutex);
782 return bd;
783}
784
785static struct bsg_device *bsg_get_device(struct inode *inode, struct file *file)
786{
787 struct bsg_device *bd = __bsg_get_device(iminor(inode));
788 struct bsg_class_device *bcd, *__bcd;
789
790 if (bd)
791 return bd;
792
793 /*
794 * find the class device
795 */
796 bcd = NULL;
797 mutex_lock(&bsg_mutex);
798 list_for_each_entry(__bcd, &bsg_class_list, list) {
799 if (__bcd->minor == iminor(inode)) {
800 bcd = __bcd;
801 break;
802 }
803 }
804 mutex_unlock(&bsg_mutex);
805
806 if (!bcd)
807 return ERR_PTR(-ENODEV);
808
d351af01 809 return bsg_add_device(inode, bcd->queue, file);
3d6392cf
JA
810}
811
812static int bsg_open(struct inode *inode, struct file *file)
813{
814 struct bsg_device *bd = bsg_get_device(inode, file);
815
816 if (IS_ERR(bd))
817 return PTR_ERR(bd);
818
819 file->private_data = bd;
820 return 0;
821}
822
823static int bsg_release(struct inode *inode, struct file *file)
824{
825 struct bsg_device *bd = file->private_data;
826
827 file->private_data = NULL;
828 return bsg_put_device(bd);
829}
830
831static unsigned int bsg_poll(struct file *file, poll_table *wait)
832{
833 struct bsg_device *bd = file->private_data;
834 unsigned int mask = 0;
835
836 poll_wait(file, &bd->wq_done, wait);
837 poll_wait(file, &bd->wq_free, wait);
838
839 spin_lock_irq(&bd->lock);
840 if (!list_empty(&bd->done_list))
841 mask |= POLLIN | POLLRDNORM;
842 if (bd->queued_cmds >= bd->max_queue)
843 mask |= POLLOUT;
844 spin_unlock_irq(&bd->lock);
845
846 return mask;
847}
848
25fd1643 849static long bsg_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
3d6392cf
JA
850{
851 struct bsg_device *bd = file->private_data;
852 int __user *uarg = (int __user *) arg;
853
3d6392cf
JA
854 switch (cmd) {
855 /*
856 * our own ioctls
857 */
858 case SG_GET_COMMAND_Q:
859 return put_user(bd->max_queue, uarg);
5309cb38 860 case SG_SET_COMMAND_Q: {
3d6392cf
JA
861 int queue;
862
863 if (get_user(queue, uarg))
864 return -EFAULT;
5309cb38 865 if (queue < 1)
3d6392cf
JA
866 return -EINVAL;
867
5309cb38 868 spin_lock_irq(&bd->lock);
3d6392cf 869 bd->max_queue = queue;
5309cb38 870 spin_unlock_irq(&bd->lock);
3d6392cf
JA
871 return 0;
872 }
873
874 /*
875 * SCSI/sg ioctls
876 */
877 case SG_GET_VERSION_NUM:
878 case SCSI_IOCTL_GET_IDLUN:
879 case SCSI_IOCTL_GET_BUS_NUMBER:
880 case SG_SET_TIMEOUT:
881 case SG_GET_TIMEOUT:
882 case SG_GET_RESERVED_SIZE:
883 case SG_SET_RESERVED_SIZE:
884 case SG_EMULATED_HOST:
3d6392cf
JA
885 case SCSI_IOCTL_SEND_COMMAND: {
886 void __user *uarg = (void __user *) arg;
d351af01 887 return scsi_cmd_ioctl(file, bd->queue, NULL, cmd, uarg);
3d6392cf 888 }
10e8855b
FT
889 case SG_IO: {
890 struct request *rq;
2c9ecdf4 891 struct bio *bio, *bidi_bio = NULL;
10e8855b
FT
892 struct sg_io_v4 hdr;
893
894 if (copy_from_user(&hdr, uarg, sizeof(hdr)))
895 return -EFAULT;
896
897 rq = bsg_map_hdr(bd, &hdr);
898 if (IS_ERR(rq))
899 return PTR_ERR(rq);
900
901 bio = rq->bio;
2c9ecdf4
FT
902 if (rq->next_rq)
903 bidi_bio = rq->next_rq->bio;
d351af01 904 blk_execute_rq(bd->queue, NULL, rq, 0);
2c9ecdf4 905 blk_complete_sgv4_hdr_rq(rq, &hdr, bio, bidi_bio);
10e8855b
FT
906
907 if (copy_to_user(uarg, &hdr, sizeof(hdr)))
908 return -EFAULT;
b711afa6
JA
909
910 return 0;
10e8855b 911 }
3d6392cf
JA
912 /*
913 * block device ioctls
914 */
915 default:
916#if 0
917 return ioctl_by_bdev(bd->bdev, cmd, arg);
918#else
919 return -ENOTTY;
920#endif
921 }
922}
923
924static struct file_operations bsg_fops = {
925 .read = bsg_read,
926 .write = bsg_write,
927 .poll = bsg_poll,
928 .open = bsg_open,
929 .release = bsg_release,
25fd1643 930 .unlocked_ioctl = bsg_ioctl,
3d6392cf
JA
931 .owner = THIS_MODULE,
932};
933
d351af01 934void bsg_unregister_queue(struct request_queue *q)
3d6392cf 935{
d351af01 936 struct bsg_class_device *bcd = &q->bsg_dev;
3d6392cf 937
25fd1643 938 WARN_ON(!bcd->class_dev);
3d6392cf
JA
939
940 mutex_lock(&bsg_mutex);
d351af01 941 sysfs_remove_link(&q->kobj, "bsg");
46f6ef4a 942 class_device_destroy(bsg_class, MKDEV(bsg_major, bcd->minor));
3d6392cf
JA
943 bcd->class_dev = NULL;
944 list_del_init(&bcd->list);
292b7f27 945 bsg_device_nr--;
3d6392cf
JA
946 mutex_unlock(&bsg_mutex);
947}
4cf0723a 948EXPORT_SYMBOL_GPL(bsg_unregister_queue);
3d6392cf 949
4cf0723a 950int bsg_register_queue(struct request_queue *q, const char *name)
3d6392cf 951{
292b7f27 952 struct bsg_class_device *bcd, *__bcd;
3d6392cf 953 dev_t dev;
292b7f27 954 int ret = -EMFILE;
4e2872d6 955 struct class_device *class_dev = NULL;
3d6392cf
JA
956
957 /*
958 * we need a proper transport to send commands, not a stacked device
959 */
960 if (!q->request_fn)
961 return 0;
962
d351af01 963 bcd = &q->bsg_dev;
3d6392cf
JA
964 memset(bcd, 0, sizeof(*bcd));
965 INIT_LIST_HEAD(&bcd->list);
966
967 mutex_lock(&bsg_mutex);
292b7f27
FT
968 if (bsg_device_nr == BSG_MAX_DEVS) {
969 printk(KERN_ERR "bsg: too many bsg devices\n");
970 goto err;
971 }
972
973retry:
974 list_for_each_entry(__bcd, &bsg_class_list, list) {
975 if (__bcd->minor == bsg_minor_idx) {
976 bsg_minor_idx++;
977 if (bsg_minor_idx == BSG_MAX_DEVS)
978 bsg_minor_idx = 0;
979 goto retry;
980 }
981 }
982
983 bcd->minor = bsg_minor_idx++;
984 if (bsg_minor_idx == BSG_MAX_DEVS)
985 bsg_minor_idx = 0;
986
d351af01 987 bcd->queue = q;
46f6ef4a 988 dev = MKDEV(bsg_major, bcd->minor);
4e2872d6
FT
989 class_dev = class_device_create(bsg_class, NULL, dev, bcd->dev, "%s", name);
990 if (IS_ERR(class_dev)) {
991 ret = PTR_ERR(class_dev);
264a0472 992 goto err;
4e2872d6
FT
993 }
994 bcd->class_dev = class_dev;
995
abce891a 996 if (q->kobj.sd) {
4e2872d6
FT
997 ret = sysfs_create_link(&q->kobj, &bcd->class_dev->kobj, "bsg");
998 if (ret)
999 goto err;
1000 }
1001
3d6392cf 1002 list_add_tail(&bcd->list, &bsg_class_list);
292b7f27 1003 bsg_device_nr++;
4e2872d6 1004
3d6392cf
JA
1005 mutex_unlock(&bsg_mutex);
1006 return 0;
264a0472 1007err:
4e2872d6 1008 if (class_dev)
46f6ef4a 1009 class_device_destroy(bsg_class, MKDEV(bsg_major, bcd->minor));
264a0472 1010 mutex_unlock(&bsg_mutex);
4e2872d6
FT
1011 return ret;
1012}
4cf0723a 1013EXPORT_SYMBOL_GPL(bsg_register_queue);
4e2872d6
FT
1014
1015static int bsg_add(struct class_device *cl_dev, struct class_interface *cl_intf)
1016{
1017 int ret;
1018 struct scsi_device *sdp = to_scsi_device(cl_dev->dev);
1019 struct request_queue *rq = sdp->request_queue;
1020
1021 if (rq->kobj.parent)
1022 ret = bsg_register_queue(rq, kobject_name(rq->kobj.parent));
1023 else
1024 ret = bsg_register_queue(rq, kobject_name(&sdp->sdev_gendev.kobj));
1025 return ret;
3d6392cf
JA
1026}
1027
4e2872d6
FT
1028static void bsg_remove(struct class_device *cl_dev, struct class_interface *cl_intf)
1029{
1030 bsg_unregister_queue(to_scsi_device(cl_dev->dev)->request_queue);
1031}
1032
1033static struct class_interface bsg_intf = {
1034 .add = bsg_add,
1035 .remove = bsg_remove,
1036};
1037
292b7f27
FT
1038static struct cdev bsg_cdev = {
1039 .kobj = {.name = "bsg", },
1040 .owner = THIS_MODULE,
1041};
1042
3d6392cf
JA
1043static int __init bsg_init(void)
1044{
1045 int ret, i;
46f6ef4a 1046 dev_t devid;
3d6392cf 1047
5309cb38
JA
1048 bsg_cmd_cachep = kmem_cache_create("bsg_cmd",
1049 sizeof(struct bsg_command), 0, 0, NULL, NULL);
1050 if (!bsg_cmd_cachep) {
1051 printk(KERN_ERR "bsg: failed creating slab cache\n");
1052 return -ENOMEM;
1053 }
1054
25fd1643 1055 for (i = 0; i < BSG_LIST_ARRAY_SIZE; i++)
3d6392cf
JA
1056 INIT_HLIST_HEAD(&bsg_device_list[i]);
1057
1058 bsg_class = class_create(THIS_MODULE, "bsg");
5309cb38
JA
1059 if (IS_ERR(bsg_class)) {
1060 kmem_cache_destroy(bsg_cmd_cachep);
3d6392cf 1061 return PTR_ERR(bsg_class);
5309cb38 1062 }
3d6392cf 1063
46f6ef4a 1064 ret = alloc_chrdev_region(&devid, 0, BSG_MAX_DEVS, "bsg");
292b7f27
FT
1065 if (ret) {
1066 kmem_cache_destroy(bsg_cmd_cachep);
1067 class_destroy(bsg_class);
1068 return ret;
1069 }
1070
46f6ef4a
JA
1071 bsg_major = MAJOR(devid);
1072
292b7f27 1073 cdev_init(&bsg_cdev, &bsg_fops);
46f6ef4a 1074 ret = cdev_add(&bsg_cdev, MKDEV(bsg_major, 0), BSG_MAX_DEVS);
3d6392cf 1075 if (ret) {
5309cb38 1076 kmem_cache_destroy(bsg_cmd_cachep);
3d6392cf 1077 class_destroy(bsg_class);
46f6ef4a 1078 unregister_chrdev_region(MKDEV(bsg_major, 0), BSG_MAX_DEVS);
3d6392cf
JA
1079 return ret;
1080 }
1081
4e2872d6
FT
1082 ret = scsi_register_interface(&bsg_intf);
1083 if (ret) {
1084 printk(KERN_ERR "bsg: failed register scsi interface %d\n", ret);
1085 kmem_cache_destroy(bsg_cmd_cachep);
1086 class_destroy(bsg_class);
46f6ef4a 1087 unregister_chrdev(bsg_major, "bsg");
4e2872d6
FT
1088 return ret;
1089 }
1090
46f6ef4a 1091 printk(KERN_INFO "%s loaded (major %d)\n", bsg_version, bsg_major);
3d6392cf
JA
1092 return 0;
1093}
1094
1095MODULE_AUTHOR("Jens Axboe");
1096MODULE_DESCRIPTION("Block layer SGSI generic (sg) driver");
1097MODULE_LICENSE("GPL");
1098
4e2872d6 1099device_initcall(bsg_init);