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