3 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
4 * to allow user process control of SCSI devices.
5 * Development Sponsored by Killy Corp. NY NY
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
10 * Copyright (C) 1998 - 2005 Douglas Gilbert
12 * Modified 19-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
21 static int sg_version_num = 30534; /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.34"
25 * D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
26 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
27 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
28 * (otherwise the macros compile to empty statements).
31 #include <linux/module.h>
34 #include <linux/kernel.h>
35 #include <linux/sched.h>
36 #include <linux/string.h>
38 #include <linux/errno.h>
39 #include <linux/mtio.h>
40 #include <linux/ioctl.h>
41 #include <linux/fcntl.h>
42 #include <linux/init.h>
43 #include <linux/poll.h>
44 #include <linux/moduleparam.h>
45 #include <linux/cdev.h>
46 #include <linux/idr.h>
47 #include <linux/seq_file.h>
48 #include <linux/blkdev.h>
49 #include <linux/delay.h>
50 #include <linux/scatterlist.h>
53 #include <scsi/scsi_dbg.h>
54 #include <scsi/scsi_host.h>
55 #include <scsi/scsi_driver.h>
56 #include <scsi/scsi_ioctl.h>
59 #include "scsi_logging.h"
61 #ifdef CONFIG_SCSI_PROC_FS
62 #include <linux/proc_fs.h>
63 static char *sg_version_date = "20061027";
65 static int sg_proc_init(void);
66 static void sg_proc_cleanup(void);
69 #define SG_ALLOW_DIO_DEF 0
70 #define SG_ALLOW_DIO_CODE /* compile out by commenting this define */
72 #define SG_MAX_DEVS 32768
75 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
76 * Then when using 32 bit integers x * m may overflow during the calculation.
77 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
78 * calculates the same, but prevents the overflow when both m and d
79 * are "small" numbers (like HZ and USER_HZ).
80 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
83 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
85 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
87 int sg_big_buff = SG_DEF_RESERVED_SIZE;
88 /* N.B. This variable is readable and writeable via
89 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
90 of this size (or less if there is not enough memory) will be reserved
91 for use by this file descriptor. [Deprecated usage: this variable is also
92 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
93 the kernel (i.e. it is not a module).] */
94 static int def_reserved_size = -1; /* picks up init parameter */
95 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
97 static int scatter_elem_sz = SG_SCATTER_SZ;
98 static int scatter_elem_sz_prev = SG_SCATTER_SZ;
100 #define SG_SECTOR_SZ 512
101 #define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
103 static int sg_add(struct class_device *, struct class_interface *);
104 static void sg_remove(struct class_device *, struct class_interface *);
106 static DEFINE_IDR(sg_index_idr);
107 static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
108 file descriptor list for device */
110 static struct class_interface sg_interface = {
115 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
116 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
117 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
118 unsigned bufflen; /* Size of (aggregate) data buffer */
119 unsigned b_malloc_len; /* actual len malloc'ed in buffer */
120 struct scatterlist *buffer;/* scatter list */
121 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
122 unsigned char cmd_opcode; /* first byte of command */
125 struct sg_device; /* forward declarations */
128 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
129 struct sg_request *nextrp; /* NULL -> tail request (slist) */
130 struct sg_fd *parentfp; /* NULL -> not in use */
131 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
132 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
133 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
134 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
135 char orphan; /* 1 -> drop on sight, 0 -> normal */
136 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
137 volatile char done; /* 0->before bh, 1->before read, 2->read */
140 typedef struct sg_fd { /* holds the state of a file descriptor */
141 struct sg_fd *nextfp; /* NULL when last opened fd on this device */
142 struct sg_device *parentdp; /* owning device */
143 wait_queue_head_t read_wait; /* queue read until command done */
144 rwlock_t rq_list_lock; /* protect access to list in req_arr */
145 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
146 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
147 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
148 unsigned save_scat_len; /* original length of trunc. scat. element */
149 Sg_request *headrp; /* head of request slist, NULL->empty */
150 struct fasync_struct *async_qp; /* used by asynchronous notification */
151 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
152 char low_dma; /* as in parent but possibly overridden to 1 */
153 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
154 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
155 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
156 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
157 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
158 char mmap_called; /* 0 -> mmap() never called on this fd */
161 typedef struct sg_device { /* holds the state of each scsi generic device */
162 struct scsi_device *device;
163 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
164 int sg_tablesize; /* adapter's max scatter-gather table size */
165 u32 index; /* device index number */
166 Sg_fd *headfp; /* first open fd belonging to this device */
167 volatile char detached; /* 0->attached, 1->detached pending removal */
168 volatile char exclude; /* opened for exclusive access */
169 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
170 struct gendisk *disk;
171 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
174 static int sg_fasync(int fd, struct file *filp, int mode);
175 /* tasklet or soft irq callback */
176 static void sg_cmd_done(void *data, char *sense, int result, int resid);
177 static int sg_start_req(Sg_request * srp);
178 static void sg_finish_rem_req(Sg_request * srp);
179 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
180 static int sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp,
182 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
184 static ssize_t sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
185 int blocking, int read_only, Sg_request ** o_srp);
186 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
187 unsigned char *cmnd, int timeout, int blocking);
188 static int sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
189 int wr_xf, int *countp, unsigned char __user **up);
190 static int sg_write_xfer(Sg_request * srp);
191 static int sg_read_xfer(Sg_request * srp);
192 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
193 static void sg_remove_scat(Sg_scatter_hold * schp);
194 static void sg_build_reserve(Sg_fd * sfp, int req_size);
195 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
196 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
197 static struct page *sg_page_malloc(int rqSz, int lowDma, int *retSzp);
198 static void sg_page_free(struct page *page, int size);
199 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
200 static int sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
201 static void __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
202 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
203 static Sg_request *sg_add_request(Sg_fd * sfp);
204 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
205 static int sg_res_in_use(Sg_fd * sfp);
206 static int sg_allow_access(unsigned char opcode, char dev_type);
207 static int sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len);
208 static Sg_device *sg_get_dev(int dev);
209 #ifdef CONFIG_SCSI_PROC_FS
210 static int sg_last_dev(void);
213 #define SZ_SG_HEADER sizeof(struct sg_header)
214 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
215 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
216 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
219 sg_open(struct inode *inode, struct file *filp)
221 int dev = iminor(inode);
222 int flags = filp->f_flags;
223 struct request_queue *q;
229 nonseekable_open(inode, filp);
230 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
231 sdp = sg_get_dev(dev);
232 if ((!sdp) || (!sdp->device))
237 /* This driver's module count bumped by fops_get in <linux/fs.h> */
238 /* Prevent the device driver from vanishing while we sleep */
239 retval = scsi_device_get(sdp->device);
243 if (!((flags & O_NONBLOCK) ||
244 scsi_block_when_processing_errors(sdp->device))) {
246 /* we are in error recovery for this device */
250 if (flags & O_EXCL) {
251 if (O_RDONLY == (flags & O_ACCMODE)) {
252 retval = -EPERM; /* Can't lock it with read only access */
255 if (sdp->headfp && (flags & O_NONBLOCK)) {
260 __wait_event_interruptible(sdp->o_excl_wait,
261 ((sdp->headfp || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
263 retval = res; /* -ERESTARTSYS because signal hit process */
266 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
267 if (flags & O_NONBLOCK) {
272 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
275 retval = res; /* -ERESTARTSYS because signal hit process */
283 if (!sdp->headfp) { /* no existing opens on this device */
285 q = sdp->device->request_queue;
286 sdp->sg_tablesize = min(q->max_hw_segments,
287 q->max_phys_segments);
289 if ((sfp = sg_add_sfp(sdp, dev)))
290 filp->private_data = sfp;
293 sdp->exclude = 0; /* undo if error */
300 scsi_device_put(sdp->device);
304 /* Following function was formerly called 'sg_close' */
306 sg_release(struct inode *inode, struct file *filp)
311 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
313 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
314 sg_fasync(-1, filp, 0); /* remove filp from async notification list */
315 if (0 == sg_remove_sfp(sdp, sfp)) { /* Returns 1 when sdp gone */
316 if (!sdp->detached) {
317 scsi_device_put(sdp->device);
320 wake_up_interruptible(&sdp->o_excl_wait);
326 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
331 int req_pack_id = -1;
333 struct sg_header *old_hdr = NULL;
336 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
338 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
339 sdp->disk->disk_name, (int) count));
341 if (!access_ok(VERIFY_WRITE, buf, count))
343 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
344 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
347 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
351 if (old_hdr->reply_len < 0) {
352 if (count >= SZ_SG_IO_HDR) {
353 sg_io_hdr_t *new_hdr;
354 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
359 retval =__copy_from_user
360 (new_hdr, buf, SZ_SG_IO_HDR);
361 req_pack_id = new_hdr->pack_id;
369 req_pack_id = old_hdr->pack_id;
371 srp = sg_get_rq_mark(sfp, req_pack_id);
372 if (!srp) { /* now wait on packet to arrive */
377 if (filp->f_flags & O_NONBLOCK) {
382 retval = 0; /* following macro beats race condition */
383 __wait_event_interruptible(sfp->read_wait,
385 (srp = sg_get_rq_mark(sfp, req_pack_id))),
394 /* -ERESTARTSYS as signal hit process */
398 if (srp->header.interface_id != '\0') {
399 retval = sg_new_read(sfp, buf, count, srp);
404 if (old_hdr == NULL) {
405 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
411 memset(old_hdr, 0, SZ_SG_HEADER);
412 old_hdr->reply_len = (int) hp->timeout;
413 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
414 old_hdr->pack_id = hp->pack_id;
415 old_hdr->twelve_byte =
416 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
417 old_hdr->target_status = hp->masked_status;
418 old_hdr->host_status = hp->host_status;
419 old_hdr->driver_status = hp->driver_status;
420 if ((CHECK_CONDITION & hp->masked_status) ||
421 (DRIVER_SENSE & hp->driver_status))
422 memcpy(old_hdr->sense_buffer, srp->sense_b,
423 sizeof (old_hdr->sense_buffer));
424 switch (hp->host_status) {
425 /* This setup of 'result' is for backward compatibility and is best
426 ignored by the user who should use target, host + driver status */
428 case DID_PASSTHROUGH:
435 old_hdr->result = EBUSY;
442 old_hdr->result = EIO;
445 old_hdr->result = (srp->sense_b[0] == 0 &&
446 hp->masked_status == GOOD) ? 0 : EIO;
449 old_hdr->result = EIO;
453 /* Now copy the result back to the user buffer. */
454 if (count >= SZ_SG_HEADER) {
455 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
460 if (count > old_hdr->reply_len)
461 count = old_hdr->reply_len;
462 if (count > SZ_SG_HEADER) {
463 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
469 count = (old_hdr->result == 0) ? 0 : -EIO;
470 sg_finish_rem_req(srp);
478 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
480 sg_io_hdr_t *hp = &srp->header;
484 if (count < SZ_SG_IO_HDR) {
489 if ((hp->mx_sb_len > 0) && hp->sbp) {
490 if ((CHECK_CONDITION & hp->masked_status) ||
491 (DRIVER_SENSE & hp->driver_status)) {
492 int sb_len = SCSI_SENSE_BUFFERSIZE;
493 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
494 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
495 len = (len > sb_len) ? sb_len : len;
496 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
503 if (hp->masked_status || hp->host_status || hp->driver_status)
504 hp->info |= SG_INFO_CHECK;
505 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
509 err = sg_read_xfer(srp);
511 sg_finish_rem_req(srp);
512 return (0 == err) ? count : err;
516 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
518 int mxsize, cmd_size, k;
519 int input_size, blocking;
520 unsigned char opcode;
524 struct sg_header old_hdr;
526 unsigned char cmnd[MAX_COMMAND_SIZE];
528 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
530 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
531 sdp->disk->disk_name, (int) count));
534 if (!((filp->f_flags & O_NONBLOCK) ||
535 scsi_block_when_processing_errors(sdp->device)))
538 if (!access_ok(VERIFY_READ, buf, count))
539 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
540 if (count < SZ_SG_HEADER)
542 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
544 blocking = !(filp->f_flags & O_NONBLOCK);
545 if (old_hdr.reply_len < 0)
546 return sg_new_write(sfp, buf, count, blocking, 0, NULL);
547 if (count < (SZ_SG_HEADER + 6))
548 return -EIO; /* The minimum scsi command length is 6 bytes. */
550 if (!(srp = sg_add_request(sfp))) {
551 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
555 __get_user(opcode, buf);
556 if (sfp->next_cmd_len > 0) {
557 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
558 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
559 sfp->next_cmd_len = 0;
560 sg_remove_request(sfp, srp);
563 cmd_size = sfp->next_cmd_len;
564 sfp->next_cmd_len = 0; /* reset so only this write() effected */
566 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
567 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
570 SCSI_LOG_TIMEOUT(4, printk(
571 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
572 /* Determine buffer size. */
573 input_size = count - cmd_size;
574 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
575 mxsize -= SZ_SG_HEADER;
576 input_size -= SZ_SG_HEADER;
577 if (input_size < 0) {
578 sg_remove_request(sfp, srp);
579 return -EIO; /* User did not pass enough bytes for this command. */
582 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
583 hp->cmd_len = (unsigned char) cmd_size;
587 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
588 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
590 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
591 hp->dxfer_len = mxsize;
592 hp->dxferp = (char __user *)buf + cmd_size;
594 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
595 hp->flags = input_size; /* structure abuse ... */
596 hp->pack_id = old_hdr.pack_id;
598 if (__copy_from_user(cmnd, buf, cmd_size))
601 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
602 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
603 * is a non-zero input_size, so emit a warning.
605 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
606 static char cmd[TASK_COMM_LEN];
607 if (strcmp(current->comm, cmd) && printk_ratelimit()) {
609 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
610 "guessing data in;\n" KERN_WARNING " "
611 "program %s not setting count and/or reply_len properly\n",
612 old_hdr.reply_len - (int)SZ_SG_HEADER,
613 input_size, (unsigned int) cmnd[0],
615 strcpy(cmd, current->comm);
618 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
619 return (k < 0) ? k : count;
623 sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
624 int blocking, int read_only, Sg_request ** o_srp)
629 unsigned char cmnd[MAX_COMMAND_SIZE];
631 unsigned long ul_timeout;
633 if (count < SZ_SG_IO_HDR)
635 if (!access_ok(VERIFY_READ, buf, count))
636 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
638 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
639 if (!(srp = sg_add_request(sfp))) {
640 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
644 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
645 sg_remove_request(sfp, srp);
648 if (hp->interface_id != 'S') {
649 sg_remove_request(sfp, srp);
652 if (hp->flags & SG_FLAG_MMAP_IO) {
653 if (hp->dxfer_len > sfp->reserve.bufflen) {
654 sg_remove_request(sfp, srp);
655 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
657 if (hp->flags & SG_FLAG_DIRECT_IO) {
658 sg_remove_request(sfp, srp);
659 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
661 if (sg_res_in_use(sfp)) {
662 sg_remove_request(sfp, srp);
663 return -EBUSY; /* reserve buffer already being used */
666 ul_timeout = msecs_to_jiffies(srp->header.timeout);
667 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
668 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
669 sg_remove_request(sfp, srp);
672 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
673 sg_remove_request(sfp, srp);
674 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
676 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
677 sg_remove_request(sfp, srp);
681 (!sg_allow_access(cmnd[0], sfp->parentdp->device->type))) {
682 sg_remove_request(sfp, srp);
685 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
694 sg_common_write(Sg_fd * sfp, Sg_request * srp,
695 unsigned char *cmnd, int timeout, int blocking)
698 Sg_device *sdp = sfp->parentdp;
699 sg_io_hdr_t *hp = &srp->header;
701 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
703 hp->masked_status = 0;
707 hp->driver_status = 0;
709 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
710 (int) cmnd[0], (int) hp->cmd_len));
712 if ((k = sg_start_req(srp))) {
713 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
714 sg_finish_rem_req(srp);
715 return k; /* probably out of space --> ENOMEM */
717 if ((k = sg_write_xfer(srp))) {
718 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: write_xfer, bad address\n"));
719 sg_finish_rem_req(srp);
723 sg_finish_rem_req(srp);
727 switch (hp->dxfer_direction) {
728 case SG_DXFER_TO_FROM_DEV:
729 case SG_DXFER_FROM_DEV:
730 data_dir = DMA_FROM_DEVICE;
732 case SG_DXFER_TO_DEV:
733 data_dir = DMA_TO_DEVICE;
735 case SG_DXFER_UNKNOWN:
736 data_dir = DMA_BIDIRECTIONAL;
742 hp->duration = jiffies_to_msecs(jiffies);
743 /* Now send everything of to mid-level. The next time we hear about this
744 packet is when sg_cmd_done() is called (i.e. a callback). */
745 if (scsi_execute_async(sdp->device, cmnd, hp->cmd_len, data_dir, srp->data.buffer,
746 hp->dxfer_len, srp->data.k_use_sg, timeout,
747 SG_DEFAULT_RETRIES, srp, sg_cmd_done,
749 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: scsi_execute_async failed\n"));
751 * most likely out of mem, but could also be a bad map
753 sg_finish_rem_req(srp);
760 sg_srp_done(Sg_request *srp, Sg_fd *sfp)
762 unsigned long iflags;
765 read_lock_irqsave(&sfp->rq_list_lock, iflags);
767 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
772 sg_ioctl(struct inode *inode, struct file *filp,
773 unsigned int cmd_in, unsigned long arg)
775 void __user *p = (void __user *)arg;
777 int result, val, read_only;
781 unsigned long iflags;
783 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
785 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
786 sdp->disk->disk_name, (int) cmd_in));
787 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
792 int blocking = 1; /* ignore O_NONBLOCK flag */
796 if (!scsi_block_when_processing_errors(sdp->device))
798 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
801 sg_new_write(sfp, p, SZ_SG_IO_HDR,
802 blocking, read_only, &srp);
805 srp->sg_io_owned = 1;
807 result = 0; /* following macro to beat race condition */
808 __wait_event_interruptible(sfp->read_wait,
809 (sdp->detached || sfp->closed || sg_srp_done(srp, sfp)),
814 return 0; /* request packet dropped already */
818 return result; /* -ERESTARTSYS because signal hit process */
820 write_lock_irqsave(&sfp->rq_list_lock, iflags);
822 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
823 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
824 return (result < 0) ? result : 0;
827 result = get_user(val, ip);
832 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
833 val = MULDIV (INT_MAX, USER_HZ, HZ);
834 sfp->timeout_user = val;
835 sfp->timeout = MULDIV (val, HZ, USER_HZ);
838 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
839 /* strange ..., for backward compatibility */
840 return sfp->timeout_user;
841 case SG_SET_FORCE_LOW_DMA:
842 result = get_user(val, ip);
847 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
848 val = (int) sfp->reserve.bufflen;
849 sg_remove_scat(&sfp->reserve);
850 sg_build_reserve(sfp, val);
855 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
859 return put_user((int) sfp->low_dma, ip);
861 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
864 sg_scsi_id_t __user *sg_idp = p;
868 __put_user((int) sdp->device->host->host_no,
870 __put_user((int) sdp->device->channel,
872 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
873 __put_user((int) sdp->device->lun, &sg_idp->lun);
874 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
875 __put_user((short) sdp->device->host->cmd_per_lun,
876 &sg_idp->h_cmd_per_lun);
877 __put_user((short) sdp->device->queue_depth,
878 &sg_idp->d_queue_depth);
879 __put_user(0, &sg_idp->unused[0]);
880 __put_user(0, &sg_idp->unused[1]);
883 case SG_SET_FORCE_PACK_ID:
884 result = get_user(val, ip);
887 sfp->force_packid = val ? 1 : 0;
890 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
892 read_lock_irqsave(&sfp->rq_list_lock, iflags);
893 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
894 if ((1 == srp->done) && (!srp->sg_io_owned)) {
895 read_unlock_irqrestore(&sfp->rq_list_lock,
897 __put_user(srp->header.pack_id, ip);
901 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
904 case SG_GET_NUM_WAITING:
905 read_lock_irqsave(&sfp->rq_list_lock, iflags);
906 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
907 if ((1 == srp->done) && (!srp->sg_io_owned))
910 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
911 return put_user(val, ip);
912 case SG_GET_SG_TABLESIZE:
913 return put_user(sdp->sg_tablesize, ip);
914 case SG_SET_RESERVED_SIZE:
915 result = get_user(val, ip);
920 val = min_t(int, val,
921 sdp->device->request_queue->max_sectors * 512);
922 if (val != sfp->reserve.bufflen) {
923 if (sg_res_in_use(sfp) || sfp->mmap_called)
925 sg_remove_scat(&sfp->reserve);
926 sg_build_reserve(sfp, val);
929 case SG_GET_RESERVED_SIZE:
930 val = min_t(int, sfp->reserve.bufflen,
931 sdp->device->request_queue->max_sectors * 512);
932 return put_user(val, ip);
933 case SG_SET_COMMAND_Q:
934 result = get_user(val, ip);
937 sfp->cmd_q = val ? 1 : 0;
939 case SG_GET_COMMAND_Q:
940 return put_user((int) sfp->cmd_q, ip);
941 case SG_SET_KEEP_ORPHAN:
942 result = get_user(val, ip);
945 sfp->keep_orphan = val;
947 case SG_GET_KEEP_ORPHAN:
948 return put_user((int) sfp->keep_orphan, ip);
949 case SG_NEXT_CMD_LEN:
950 result = get_user(val, ip);
953 sfp->next_cmd_len = (val > 0) ? val : 0;
955 case SG_GET_VERSION_NUM:
956 return put_user(sg_version_num, ip);
957 case SG_GET_ACCESS_COUNT:
958 /* faked - we don't have a real access count anymore */
959 val = (sdp->device ? 1 : 0);
960 return put_user(val, ip);
961 case SG_GET_REQUEST_TABLE:
962 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
965 sg_req_info_t *rinfo;
968 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
972 read_lock_irqsave(&sfp->rq_list_lock, iflags);
973 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
974 ++val, srp = srp ? srp->nextrp : srp) {
975 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
977 rinfo[val].req_state = srp->done + 1;
979 srp->header.masked_status &
980 srp->header.host_status &
981 srp->header.driver_status;
983 rinfo[val].duration =
984 srp->header.duration;
986 ms = jiffies_to_msecs(jiffies);
987 rinfo[val].duration =
988 (ms > srp->header.duration) ?
989 (ms - srp->header.duration) : 0;
991 rinfo[val].orphan = srp->orphan;
992 rinfo[val].sg_io_owned =
1000 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1001 result = __copy_to_user(p, rinfo,
1002 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1003 result = result ? -EFAULT : 0;
1007 case SG_EMULATED_HOST:
1010 return put_user(sdp->device->host->hostt->emulated, ip);
1014 if (filp->f_flags & O_NONBLOCK) {
1015 if (scsi_host_in_recovery(sdp->device->host))
1017 } else if (!scsi_block_when_processing_errors(sdp->device))
1019 result = get_user(val, ip);
1022 if (SG_SCSI_RESET_NOTHING == val)
1025 case SG_SCSI_RESET_DEVICE:
1026 val = SCSI_TRY_RESET_DEVICE;
1028 case SG_SCSI_RESET_BUS:
1029 val = SCSI_TRY_RESET_BUS;
1031 case SG_SCSI_RESET_HOST:
1032 val = SCSI_TRY_RESET_HOST;
1037 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1039 return (scsi_reset_provider(sdp->device, val) ==
1040 SUCCESS) ? 0 : -EIO;
1041 case SCSI_IOCTL_SEND_COMMAND:
1045 unsigned char opcode = WRITE_6;
1046 Scsi_Ioctl_Command __user *siocp = p;
1048 if (copy_from_user(&opcode, siocp->data, 1))
1050 if (!sg_allow_access(opcode, sdp->device->type))
1053 return sg_scsi_ioctl(filp, sdp->device->request_queue, NULL, p);
1055 result = get_user(val, ip);
1058 sdp->sgdebug = (char) val;
1060 case SCSI_IOCTL_GET_IDLUN:
1061 case SCSI_IOCTL_GET_BUS_NUMBER:
1062 case SCSI_IOCTL_PROBE_HOST:
1063 case SG_GET_TRANSFORM:
1066 return scsi_ioctl(sdp->device, cmd_in, p);
1068 return put_user(sdp->device->request_queue->max_sectors * 512,
1072 return -EPERM; /* don't know so take safe approach */
1073 return scsi_ioctl(sdp->device, cmd_in, p);
1077 #ifdef CONFIG_COMPAT
1078 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1082 struct scsi_device *sdev;
1084 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1088 if (sdev->host->hostt->compat_ioctl) {
1091 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1096 return -ENOIOCTLCMD;
1101 sg_poll(struct file *filp, poll_table * wait)
1103 unsigned int res = 0;
1108 unsigned long iflags;
1110 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1113 poll_wait(filp, &sfp->read_wait, wait);
1114 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1115 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1116 /* if any read waiting, flag it */
1117 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1118 res = POLLIN | POLLRDNORM;
1121 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1125 else if (!sfp->cmd_q) {
1127 res |= POLLOUT | POLLWRNORM;
1128 } else if (count < SG_MAX_QUEUE)
1129 res |= POLLOUT | POLLWRNORM;
1130 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1131 sdp->disk->disk_name, (int) res));
1136 sg_fasync(int fd, struct file *filp, int mode)
1142 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1144 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1145 sdp->disk->disk_name, mode));
1147 retval = fasync_helper(fd, filp, mode, &sfp->async_qp);
1148 return (retval < 0) ? retval : 0;
1151 static struct page *
1152 sg_vma_nopage(struct vm_area_struct *vma, unsigned long addr, int *type)
1155 struct page *page = NOPAGE_SIGBUS;
1156 unsigned long offset, len, sa;
1157 Sg_scatter_hold *rsv_schp;
1158 struct scatterlist *sg;
1161 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1163 rsv_schp = &sfp->reserve;
1164 offset = addr - vma->vm_start;
1165 if (offset >= rsv_schp->bufflen)
1167 SCSI_LOG_TIMEOUT(3, printk("sg_vma_nopage: offset=%lu, scatg=%d\n",
1168 offset, rsv_schp->k_use_sg));
1169 sg = rsv_schp->buffer;
1171 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1172 ++k, sg = sg_next(sg)) {
1173 len = vma->vm_end - sa;
1174 len = (len < sg->length) ? len : sg->length;
1176 page = virt_to_page(page_address(sg_page(sg)) + offset);
1177 get_page(page); /* increment page count */
1185 *type = VM_FAULT_MINOR;
1189 static struct vm_operations_struct sg_mmap_vm_ops = {
1190 .nopage = sg_vma_nopage,
1194 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1197 unsigned long req_sz, len, sa;
1198 Sg_scatter_hold *rsv_schp;
1200 struct scatterlist *sg;
1202 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1204 req_sz = vma->vm_end - vma->vm_start;
1205 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1206 (void *) vma->vm_start, (int) req_sz));
1208 return -EINVAL; /* want no offset */
1209 rsv_schp = &sfp->reserve;
1210 if (req_sz > rsv_schp->bufflen)
1211 return -ENOMEM; /* cannot map more than reserved buffer */
1214 sg = rsv_schp->buffer;
1215 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1216 ++k, sg = sg_next(sg)) {
1217 len = vma->vm_end - sa;
1218 len = (len < sg->length) ? len : sg->length;
1222 sfp->mmap_called = 1;
1223 vma->vm_flags |= VM_RESERVED;
1224 vma->vm_private_data = sfp;
1225 vma->vm_ops = &sg_mmap_vm_ops;
1229 /* This function is a "bottom half" handler that is called by the
1230 * mid level when a command is completed (or has failed). */
1232 sg_cmd_done(void *data, char *sense, int result, int resid)
1234 Sg_request *srp = data;
1235 Sg_device *sdp = NULL;
1237 unsigned long iflags;
1241 printk(KERN_ERR "sg_cmd_done: NULL request\n");
1244 sfp = srp->parentfp;
1246 sdp = sfp->parentdp;
1247 if ((NULL == sdp) || sdp->detached) {
1248 printk(KERN_INFO "sg_cmd_done: device detached\n");
1253 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1254 sdp->disk->disk_name, srp->header.pack_id, result));
1255 srp->header.resid = resid;
1256 ms = jiffies_to_msecs(jiffies);
1257 srp->header.duration = (ms > srp->header.duration) ?
1258 (ms - srp->header.duration) : 0;
1260 struct scsi_sense_hdr sshdr;
1262 memcpy(srp->sense_b, sense, sizeof (srp->sense_b));
1263 srp->header.status = 0xff & result;
1264 srp->header.masked_status = status_byte(result);
1265 srp->header.msg_status = msg_byte(result);
1266 srp->header.host_status = host_byte(result);
1267 srp->header.driver_status = driver_byte(result);
1268 if ((sdp->sgdebug > 0) &&
1269 ((CHECK_CONDITION == srp->header.masked_status) ||
1270 (COMMAND_TERMINATED == srp->header.masked_status)))
1271 __scsi_print_sense("sg_cmd_done", sense,
1272 SCSI_SENSE_BUFFERSIZE);
1274 /* Following if statement is a patch supplied by Eric Youngdale */
1275 if (driver_byte(result) != 0
1276 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1277 && !scsi_sense_is_deferred(&sshdr)
1278 && sshdr.sense_key == UNIT_ATTENTION
1279 && sdp->device->removable) {
1280 /* Detected possible disc change. Set the bit - this */
1281 /* may be used if there are filesystems using this device */
1282 sdp->device->changed = 1;
1285 /* Rely on write phase to clean out srp status values, so no "else" */
1287 if (sfp->closed) { /* whoops this fd already released, cleanup */
1288 SCSI_LOG_TIMEOUT(1, printk("sg_cmd_done: already closed, freeing ...\n"));
1289 sg_finish_rem_req(srp);
1291 if (NULL == sfp->headrp) {
1292 SCSI_LOG_TIMEOUT(1, printk("sg_cmd_done: already closed, final cleanup\n"));
1293 if (0 == sg_remove_sfp(sdp, sfp)) { /* device still present */
1294 scsi_device_put(sdp->device);
1298 } else if (srp && srp->orphan) {
1299 if (sfp->keep_orphan)
1300 srp->sg_io_owned = 0;
1302 sg_finish_rem_req(srp);
1307 /* Now wake up any sg_read() that is waiting for this packet. */
1308 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1309 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1311 wake_up_interruptible(&sfp->read_wait);
1312 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1316 static struct file_operations sg_fops = {
1317 .owner = THIS_MODULE,
1322 #ifdef CONFIG_COMPAT
1323 .compat_ioctl = sg_compat_ioctl,
1327 .release = sg_release,
1328 .fasync = sg_fasync,
1331 static struct class *sg_sysfs_class;
1333 static int sg_sysfs_valid = 0;
1335 static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1337 struct request_queue *q = scsidp->request_queue;
1339 unsigned long iflags;
1343 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1345 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1346 return ERR_PTR(-ENOMEM);
1349 if (!idr_pre_get(&sg_index_idr, GFP_KERNEL)) {
1350 printk(KERN_WARNING "idr expansion Sg_device failure\n");
1354 write_lock_irqsave(&sg_index_lock, iflags);
1355 error = idr_get_new(&sg_index_idr, sdp, &k);
1356 write_unlock_irqrestore(&sg_index_lock, iflags);
1359 printk(KERN_WARNING "idr allocation Sg_device failure: %d\n",
1364 if (unlikely(k >= SG_MAX_DEVS))
1367 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1368 sprintf(disk->disk_name, "sg%d", k);
1369 disk->first_minor = k;
1371 sdp->device = scsidp;
1372 init_waitqueue_head(&sdp->o_excl_wait);
1373 sdp->sg_tablesize = min(q->max_hw_segments, q->max_phys_segments);
1380 return ERR_PTR(error);
1385 sdev_printk(KERN_WARNING, scsidp,
1386 "Unable to attach sg device type=%d, minor "
1387 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1393 sg_add(struct class_device *cl_dev, struct class_interface *cl_intf)
1395 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1396 struct gendisk *disk;
1397 Sg_device *sdp = NULL;
1398 struct cdev * cdev = NULL;
1400 unsigned long iflags;
1402 disk = alloc_disk(1);
1404 printk(KERN_WARNING "alloc_disk failed\n");
1407 disk->major = SCSI_GENERIC_MAJOR;
1410 cdev = cdev_alloc();
1412 printk(KERN_WARNING "cdev_alloc failed\n");
1415 cdev->owner = THIS_MODULE;
1416 cdev->ops = &sg_fops;
1418 sdp = sg_alloc(disk, scsidp);
1420 printk(KERN_WARNING "sg_alloc failed\n");
1421 error = PTR_ERR(sdp);
1425 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1430 if (sg_sysfs_valid) {
1431 struct class_device * sg_class_member;
1433 sg_class_member = class_device_create(sg_sysfs_class, NULL,
1434 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1437 if (IS_ERR(sg_class_member))
1438 printk(KERN_WARNING "sg_add: "
1439 "class_device_create failed\n");
1440 class_set_devdata(sg_class_member, sdp);
1441 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1442 &sg_class_member->kobj, "generic");
1444 printk(KERN_ERR "sg_add: unable to make symlink "
1445 "'generic' back to sg%d\n", sdp->index);
1447 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1449 sdev_printk(KERN_NOTICE, scsidp,
1450 "Attached scsi generic sg%d type %d\n", sdp->index,
1453 class_set_devdata(cl_dev, sdp);
1458 write_lock_irqsave(&sg_index_lock, iflags);
1459 idr_remove(&sg_index_idr, sdp->index);
1460 write_unlock_irqrestore(&sg_index_lock, iflags);
1471 sg_remove(struct class_device *cl_dev, struct class_interface *cl_intf)
1473 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1474 Sg_device *sdp = class_get_devdata(cl_dev);
1475 unsigned long iflags;
1486 write_lock_irqsave(&sg_index_lock, iflags);
1489 for (sfp = sdp->headfp; sfp; sfp = tsfp) {
1491 for (srp = sfp->headrp; srp; srp = tsrp) {
1493 if (sfp->closed || (0 == sg_srp_done(srp, sfp)))
1494 sg_finish_rem_req(srp);
1497 scsi_device_put(sdp->device);
1498 __sg_remove_sfp(sdp, sfp);
1501 wake_up_interruptible(&sfp->read_wait);
1502 kill_fasync(&sfp->async_qp, SIGPOLL,
1506 SCSI_LOG_TIMEOUT(3, printk("sg_remove: dev=%d, dirty\n", sdp->index));
1507 if (NULL == sdp->headfp) {
1508 idr_remove(&sg_index_idr, sdp->index);
1510 } else { /* nothing active, simple case */
1511 SCSI_LOG_TIMEOUT(3, printk("sg_remove: dev=%d\n", sdp->index));
1512 idr_remove(&sg_index_idr, sdp->index);
1514 write_unlock_irqrestore(&sg_index_lock, iflags);
1516 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1517 class_device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1518 cdev_del(sdp->cdev);
1520 put_disk(sdp->disk);
1522 if (NULL == sdp->headfp)
1526 msleep(10); /* dirty detach so delay device destruction */
1529 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1530 module_param_named(def_reserved_size, def_reserved_size, int,
1532 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1534 MODULE_AUTHOR("Douglas Gilbert");
1535 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1536 MODULE_LICENSE("GPL");
1537 MODULE_VERSION(SG_VERSION_STR);
1538 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1540 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1541 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1542 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1543 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1550 if (scatter_elem_sz < PAGE_SIZE) {
1551 scatter_elem_sz = PAGE_SIZE;
1552 scatter_elem_sz_prev = scatter_elem_sz;
1554 if (def_reserved_size >= 0)
1555 sg_big_buff = def_reserved_size;
1557 def_reserved_size = sg_big_buff;
1559 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1563 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1564 if ( IS_ERR(sg_sysfs_class) ) {
1565 rc = PTR_ERR(sg_sysfs_class);
1569 rc = scsi_register_interface(&sg_interface);
1571 #ifdef CONFIG_SCSI_PROC_FS
1573 #endif /* CONFIG_SCSI_PROC_FS */
1576 class_destroy(sg_sysfs_class);
1578 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1585 #ifdef CONFIG_SCSI_PROC_FS
1587 #endif /* CONFIG_SCSI_PROC_FS */
1588 scsi_unregister_interface(&sg_interface);
1589 class_destroy(sg_sysfs_class);
1591 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1593 idr_destroy(&sg_index_idr);
1597 sg_start_req(Sg_request * srp)
1600 Sg_fd *sfp = srp->parentfp;
1601 sg_io_hdr_t *hp = &srp->header;
1602 int dxfer_len = (int) hp->dxfer_len;
1603 int dxfer_dir = hp->dxfer_direction;
1604 Sg_scatter_hold *req_schp = &srp->data;
1605 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1607 SCSI_LOG_TIMEOUT(4, printk("sg_start_req: dxfer_len=%d\n", dxfer_len));
1608 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1610 if (sg_allow_dio && (hp->flags & SG_FLAG_DIRECT_IO) &&
1611 (dxfer_dir != SG_DXFER_UNKNOWN) && (0 == hp->iovec_count) &&
1612 (!sfp->parentdp->device->host->unchecked_isa_dma)) {
1613 res = sg_build_direct(srp, sfp, dxfer_len);
1614 if (res <= 0) /* -ve -> error, 0 -> done, 1 -> try indirect */
1617 if ((!sg_res_in_use(sfp)) && (dxfer_len <= rsv_schp->bufflen))
1618 sg_link_reserve(sfp, srp, dxfer_len);
1620 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1622 sg_remove_scat(req_schp);
1630 sg_finish_rem_req(Sg_request * srp)
1632 Sg_fd *sfp = srp->parentfp;
1633 Sg_scatter_hold *req_schp = &srp->data;
1635 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1637 sg_unlink_reserve(sfp, srp);
1639 sg_remove_scat(req_schp);
1640 sg_remove_request(sfp, srp);
1644 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1646 int sg_bufflen = tablesize * sizeof(struct scatterlist);
1647 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1650 * TODO: test without low_dma, we should not need it since
1651 * the block layer will bounce the buffer for us
1653 * XXX(hch): we shouldn't need GFP_DMA for the actual S/G list.
1656 gfp_flags |= GFP_DMA;
1657 schp->buffer = kzalloc(sg_bufflen, gfp_flags);
1660 sg_init_table(schp->buffer, tablesize);
1661 schp->sglist_len = sg_bufflen;
1662 return tablesize; /* number of scat_gath elements allocated */
1665 #ifdef SG_ALLOW_DIO_CODE
1666 /* vvvvvvvv following code borrowed from st driver's direct IO vvvvvvvvv */
1667 /* TODO: hopefully we can use the generic block layer code */
1669 /* Pin down user pages and put them into a scatter gather list. Returns <= 0 if
1670 - mapping of all pages not successful
1671 (i.e., either completely successful or fails)
1674 st_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages,
1675 unsigned long uaddr, size_t count, int rw)
1677 unsigned long end = (uaddr + count + PAGE_SIZE - 1) >> PAGE_SHIFT;
1678 unsigned long start = uaddr >> PAGE_SHIFT;
1679 const int nr_pages = end - start;
1681 struct page **pages;
1683 /* User attempted Overflow! */
1684 if ((uaddr + count) < uaddr)
1688 if (nr_pages > max_pages)
1695 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_ATOMIC)) == NULL)
1698 /* Try to fault in all of the necessary pages */
1699 down_read(¤t->mm->mmap_sem);
1700 /* rw==READ means read from drive, write into memory area */
1701 res = get_user_pages(
1707 0, /* don't force */
1710 up_read(¤t->mm->mmap_sem);
1712 /* Errors and no page mapped should return here */
1716 for (i=0; i < nr_pages; i++) {
1717 /* FIXME: flush superflous for rw==READ,
1718 * probably wrong function for rw==WRITE
1720 flush_dcache_page(pages[i]);
1721 /* ?? Is locking needed? I don't think so */
1722 /* if (TestSetPageLocked(pages[i]))
1726 sg_set_page(sgl, pages[0], 0, uaddr & ~PAGE_MASK);
1728 sgl[0].length = PAGE_SIZE - sgl[0].offset;
1729 count -= sgl[0].length;
1730 for (i=1; i < nr_pages ; i++)
1731 sg_set_page(&sgl[i], pages[i], count < PAGE_SIZE ? count : PAGE_SIZE, 0);
1734 sgl[0].length = count;
1742 for (j=0; j < res; j++)
1743 page_cache_release(pages[j]);
1751 /* And unmap them... */
1753 st_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
1758 for (i=0; i < nr_pages; i++) {
1759 struct page *page = sg_page(&sgl[i]);
1763 /* unlock_page(page); */
1764 /* FIXME: cache flush missing for rw==READ
1765 * FIXME: call the correct reference counting function
1767 page_cache_release(page);
1773 /* ^^^^^^^^ above code borrowed from st driver's direct IO ^^^^^^^^^ */
1777 /* Returns: -ve -> error, 0 -> done, 1 -> try indirect */
1779 sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len)
1781 #ifdef SG_ALLOW_DIO_CODE
1782 sg_io_hdr_t *hp = &srp->header;
1783 Sg_scatter_hold *schp = &srp->data;
1784 int sg_tablesize = sfp->parentdp->sg_tablesize;
1785 int mx_sc_elems, res;
1786 struct scsi_device *sdev = sfp->parentdp->device;
1788 if (((unsigned long)hp->dxferp &
1789 queue_dma_alignment(sdev->request_queue)) != 0)
1792 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1793 if (mx_sc_elems <= 0) {
1796 res = st_map_user_pages(schp->buffer, mx_sc_elems,
1797 (unsigned long)hp->dxferp, dxfer_len,
1798 (SG_DXFER_TO_DEV == hp->dxfer_direction) ? 1 : 0);
1800 sg_remove_scat(schp);
1803 schp->k_use_sg = res;
1804 schp->dio_in_use = 1;
1805 hp->info |= SG_INFO_DIRECT_IO;
1813 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1815 struct scatterlist *sg;
1816 int ret_sz = 0, k, rem_sz, num, mx_sc_elems;
1817 int sg_tablesize = sfp->parentdp->sg_tablesize;
1818 int blk_size = buff_size;
1819 struct page *p = NULL;
1824 ++blk_size; /* don't know why */
1825 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1826 blk_size = (blk_size + SG_SECTOR_MSK) & (~SG_SECTOR_MSK);
1827 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1828 buff_size, blk_size));
1830 /* N.B. ret_sz carried into this block ... */
1831 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1832 if (mx_sc_elems < 0)
1833 return mx_sc_elems; /* most likely -ENOMEM */
1835 num = scatter_elem_sz;
1836 if (unlikely(num != scatter_elem_sz_prev)) {
1837 if (num < PAGE_SIZE) {
1838 scatter_elem_sz = PAGE_SIZE;
1839 scatter_elem_sz_prev = PAGE_SIZE;
1841 scatter_elem_sz_prev = num;
1843 for (k = 0, sg = schp->buffer, rem_sz = blk_size;
1844 (rem_sz > 0) && (k < mx_sc_elems);
1845 ++k, rem_sz -= ret_sz, sg = sg_next(sg)) {
1847 num = (rem_sz > scatter_elem_sz_prev) ?
1848 scatter_elem_sz_prev : rem_sz;
1849 p = sg_page_malloc(num, sfp->low_dma, &ret_sz);
1853 if (num == scatter_elem_sz_prev) {
1854 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1855 scatter_elem_sz = ret_sz;
1856 scatter_elem_sz_prev = ret_sz;
1859 sg_set_page(sg, p, (ret_sz > num) ? num : ret_sz, 0);
1861 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1862 "ret_sz=%d\n", k, num, ret_sz));
1863 } /* end of for loop */
1866 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1867 "rem_sz=%d\n", k, rem_sz));
1869 schp->bufflen = blk_size;
1870 if (rem_sz > 0) /* must have failed */
1877 sg_write_xfer(Sg_request * srp)
1879 sg_io_hdr_t *hp = &srp->header;
1880 Sg_scatter_hold *schp = &srp->data;
1881 struct scatterlist *sg = schp->buffer;
1883 int j, k, onum, usglen, ksglen, res;
1884 int iovec_count = (int) hp->iovec_count;
1885 int dxfer_dir = hp->dxfer_direction;
1887 unsigned char __user *up;
1888 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
1890 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_TO_DEV == dxfer_dir) ||
1891 (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
1892 num_xfer = (int) (new_interface ? hp->dxfer_len : hp->flags);
1893 if (schp->bufflen < num_xfer)
1894 num_xfer = schp->bufflen;
1896 if ((num_xfer <= 0) || (schp->dio_in_use) ||
1898 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
1901 SCSI_LOG_TIMEOUT(4, printk("sg_write_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
1902 num_xfer, iovec_count, schp->k_use_sg));
1905 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
1910 ksglen = sg->length;
1911 p = page_address(sg_page(sg));
1912 for (j = 0, k = 0; j < onum; ++j) {
1913 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1917 for (; p; sg = sg_next(sg), ksglen = sg->length,
1918 p = page_address(sg_page(sg))) {
1921 if (ksglen > usglen) {
1922 if (usglen >= num_xfer) {
1923 if (__copy_from_user(p, up, num_xfer))
1927 if (__copy_from_user(p, up, usglen))
1933 if (ksglen >= num_xfer) {
1934 if (__copy_from_user(p, up, num_xfer))
1938 if (__copy_from_user(p, up, ksglen))
1944 if (k >= schp->k_use_sg)
1953 sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
1954 int wr_xf, int *countp, unsigned char __user **up)
1956 int num_xfer = (int) hp->dxfer_len;
1957 unsigned char __user *p = hp->dxferp;
1961 if (wr_xf && ('\0' == hp->interface_id))
1962 count = (int) hp->flags; /* holds "old" input_size */
1967 if (__copy_from_user(&iovec, p + ind*SZ_SG_IOVEC, SZ_SG_IOVEC))
1970 count = (int) iovec.iov_len;
1972 if (!access_ok(wr_xf ? VERIFY_READ : VERIFY_WRITE, p, count))
1982 sg_remove_scat(Sg_scatter_hold * schp)
1984 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1985 if (schp->buffer && (schp->sglist_len > 0)) {
1986 struct scatterlist *sg = schp->buffer;
1988 if (schp->dio_in_use) {
1989 #ifdef SG_ALLOW_DIO_CODE
1990 st_unmap_user_pages(sg, schp->k_use_sg, TRUE);
1995 for (k = 0; (k < schp->k_use_sg) && sg_page(sg);
1996 ++k, sg = sg_next(sg)) {
1997 SCSI_LOG_TIMEOUT(5, printk(
1998 "sg_remove_scat: k=%d, pg=0x%p, len=%d\n",
1999 k, sg_page(sg), sg->length));
2000 sg_page_free(sg_page(sg), sg->length);
2003 kfree(schp->buffer);
2005 memset(schp, 0, sizeof (*schp));
2009 sg_read_xfer(Sg_request * srp)
2011 sg_io_hdr_t *hp = &srp->header;
2012 Sg_scatter_hold *schp = &srp->data;
2013 struct scatterlist *sg = schp->buffer;
2015 int j, k, onum, usglen, ksglen, res;
2016 int iovec_count = (int) hp->iovec_count;
2017 int dxfer_dir = hp->dxfer_direction;
2019 unsigned char __user *up;
2020 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
2022 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_FROM_DEV == dxfer_dir)
2023 || (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
2024 num_xfer = hp->dxfer_len;
2025 if (schp->bufflen < num_xfer)
2026 num_xfer = schp->bufflen;
2028 if ((num_xfer <= 0) || (schp->dio_in_use) ||
2030 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
2033 SCSI_LOG_TIMEOUT(4, printk("sg_read_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
2034 num_xfer, iovec_count, schp->k_use_sg));
2037 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
2042 p = page_address(sg_page(sg));
2043 ksglen = sg->length;
2044 for (j = 0, k = 0; j < onum; ++j) {
2045 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2049 for (; p; sg = sg_next(sg), ksglen = sg->length,
2050 p = page_address(sg_page(sg))) {
2053 if (ksglen > usglen) {
2054 if (usglen >= num_xfer) {
2055 if (__copy_to_user(up, p, num_xfer))
2059 if (__copy_to_user(up, p, usglen))
2065 if (ksglen >= num_xfer) {
2066 if (__copy_to_user(up, p, num_xfer))
2070 if (__copy_to_user(up, p, ksglen))
2076 if (k >= schp->k_use_sg)
2085 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
2087 Sg_scatter_hold *schp = &srp->data;
2088 struct scatterlist *sg = schp->buffer;
2091 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
2093 if ((!outp) || (num_read_xfer <= 0))
2096 for (k = 0; (k < schp->k_use_sg) && sg_page(sg); ++k, sg = sg_next(sg)) {
2098 if (num > num_read_xfer) {
2099 if (__copy_to_user(outp, page_address(sg_page(sg)),
2104 if (__copy_to_user(outp, page_address(sg_page(sg)),
2107 num_read_xfer -= num;
2108 if (num_read_xfer <= 0)
2118 sg_build_reserve(Sg_fd * sfp, int req_size)
2120 Sg_scatter_hold *schp = &sfp->reserve;
2122 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
2124 if (req_size < PAGE_SIZE)
2125 req_size = PAGE_SIZE;
2126 if (0 == sg_build_indirect(schp, sfp, req_size))
2129 sg_remove_scat(schp);
2130 req_size >>= 1; /* divide by 2 */
2131 } while (req_size > (PAGE_SIZE / 2));
2135 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2137 Sg_scatter_hold *req_schp = &srp->data;
2138 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2139 struct scatterlist *sg = rsv_schp->buffer;
2143 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
2146 for (k = 0; k < rsv_schp->k_use_sg; ++k, sg = sg_next(sg)) {
2149 sfp->save_scat_len = num;
2151 req_schp->k_use_sg = k + 1;
2152 req_schp->sglist_len = rsv_schp->sglist_len;
2153 req_schp->buffer = rsv_schp->buffer;
2155 req_schp->bufflen = size;
2156 req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2162 if (k >= rsv_schp->k_use_sg)
2163 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
2167 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2169 Sg_scatter_hold *req_schp = &srp->data;
2170 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2172 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
2173 (int) req_schp->k_use_sg));
2174 if ((rsv_schp->k_use_sg > 0) && (req_schp->k_use_sg > 0)) {
2175 struct scatterlist *sg = rsv_schp->buffer;
2177 if (sfp->save_scat_len > 0)
2178 (sg + (req_schp->k_use_sg - 1))->length =
2179 (unsigned) sfp->save_scat_len;
2181 SCSI_LOG_TIMEOUT(1, printk ("sg_unlink_reserve: BAD save_scat_len\n"));
2183 req_schp->k_use_sg = 0;
2184 req_schp->bufflen = 0;
2185 req_schp->buffer = NULL;
2186 req_schp->sglist_len = 0;
2187 sfp->save_scat_len = 0;
2192 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2195 unsigned long iflags;
2197 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2198 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2199 /* look for requests that are ready + not SG_IO owned */
2200 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2201 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2202 resp->done = 2; /* guard against other readers */
2206 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2210 #ifdef CONFIG_SCSI_PROC_FS
2212 sg_get_nth_request(Sg_fd * sfp, int nth)
2215 unsigned long iflags;
2218 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2219 for (k = 0, resp = sfp->headrp; resp && (k < nth);
2220 ++k, resp = resp->nextrp) ;
2221 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2226 /* always adds to end of list */
2228 sg_add_request(Sg_fd * sfp)
2231 unsigned long iflags;
2233 Sg_request *rp = sfp->req_arr;
2235 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2238 memset(rp, 0, sizeof (Sg_request));
2243 if (0 == sfp->cmd_q)
2244 resp = NULL; /* command queuing disallowed */
2246 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2250 if (k < SG_MAX_QUEUE) {
2251 memset(rp, 0, sizeof (Sg_request));
2253 while (resp->nextrp)
2254 resp = resp->nextrp;
2262 resp->nextrp = NULL;
2263 resp->header.duration = jiffies_to_msecs(jiffies);
2265 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2269 /* Return of 1 for found; 0 for not found */
2271 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2273 Sg_request *prev_rp;
2275 unsigned long iflags;
2278 if ((!sfp) || (!srp) || (!sfp->headrp))
2280 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2281 prev_rp = sfp->headrp;
2282 if (srp == prev_rp) {
2283 sfp->headrp = prev_rp->nextrp;
2284 prev_rp->parentfp = NULL;
2287 while ((rp = prev_rp->nextrp)) {
2289 prev_rp->nextrp = rp->nextrp;
2290 rp->parentfp = NULL;
2297 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2301 #ifdef CONFIG_SCSI_PROC_FS
2303 sg_get_nth_sfp(Sg_device * sdp, int nth)
2306 unsigned long iflags;
2309 read_lock_irqsave(&sg_index_lock, iflags);
2310 for (k = 0, resp = sdp->headfp; resp && (k < nth);
2311 ++k, resp = resp->nextfp) ;
2312 read_unlock_irqrestore(&sg_index_lock, iflags);
2318 sg_add_sfp(Sg_device * sdp, int dev)
2321 unsigned long iflags;
2324 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2328 init_waitqueue_head(&sfp->read_wait);
2329 rwlock_init(&sfp->rq_list_lock);
2331 sfp->timeout = SG_DEFAULT_TIMEOUT;
2332 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2333 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2334 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2335 sdp->device->host->unchecked_isa_dma : 1;
2336 sfp->cmd_q = SG_DEF_COMMAND_Q;
2337 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2338 sfp->parentdp = sdp;
2339 write_lock_irqsave(&sg_index_lock, iflags);
2342 else { /* add to tail of existing list */
2343 Sg_fd *pfp = sdp->headfp;
2348 write_unlock_irqrestore(&sg_index_lock, iflags);
2349 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2350 if (unlikely(sg_big_buff != def_reserved_size))
2351 sg_big_buff = def_reserved_size;
2353 bufflen = min_t(int, sg_big_buff,
2354 sdp->device->request_queue->max_sectors * 512);
2355 sg_build_reserve(sfp, bufflen);
2356 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2357 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2362 __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2367 prev_fp = sdp->headfp;
2369 sdp->headfp = prev_fp->nextfp;
2371 while ((fp = prev_fp->nextfp)) {
2373 prev_fp->nextfp = fp->nextfp;
2379 if (sfp->reserve.bufflen > 0) {
2381 printk("__sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2382 (int) sfp->reserve.bufflen, (int) sfp->reserve.k_use_sg));
2383 sg_remove_scat(&sfp->reserve);
2385 sfp->parentdp = NULL;
2386 SCSI_LOG_TIMEOUT(6, printk("__sg_remove_sfp: sfp=0x%p\n", sfp));
2390 /* Returns 0 in normal case, 1 when detached and sdp object removed */
2392 sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2399 for (srp = sfp->headrp; srp; srp = tsrp) {
2401 if (sg_srp_done(srp, sfp))
2402 sg_finish_rem_req(srp);
2407 unsigned long iflags;
2409 write_lock_irqsave(&sg_index_lock, iflags);
2410 __sg_remove_sfp(sdp, sfp);
2411 if (sdp->detached && (NULL == sdp->headfp)) {
2412 idr_remove(&sg_index_idr, sdp->index);
2416 write_unlock_irqrestore(&sg_index_lock, iflags);
2418 /* MOD_INC's to inhibit unloading sg and associated adapter driver */
2419 /* only bump the access_count if we actually succeeded in
2420 * throwing another counter on the host module */
2421 scsi_device_get(sdp->device); /* XXX: retval ignored? */
2422 sfp->closed = 1; /* flag dirty state on this fd */
2423 SCSI_LOG_TIMEOUT(1, printk("sg_remove_sfp: worrisome, %d writes pending\n",
2430 sg_res_in_use(Sg_fd * sfp)
2432 const Sg_request *srp;
2433 unsigned long iflags;
2435 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2436 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2439 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2443 /* The size fetched (value output via retSzp) set when non-NULL return */
2444 static struct page *
2445 sg_page_malloc(int rqSz, int lowDma, int *retSzp)
2447 struct page *resp = NULL;
2452 if ((rqSz <= 0) || (NULL == retSzp))
2456 page_mask = GFP_ATOMIC | GFP_DMA | __GFP_COMP | __GFP_NOWARN;
2458 page_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
2460 for (order = 0, a_size = PAGE_SIZE; a_size < rqSz;
2461 order++, a_size <<= 1) ;
2462 resSz = a_size; /* rounded up if necessary */
2463 resp = alloc_pages(page_mask, order);
2464 while ((!resp) && order) {
2466 a_size >>= 1; /* divide by 2, until PAGE_SIZE */
2467 resp = alloc_pages(page_mask, order); /* try half */
2471 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2472 memset(page_address(resp), 0, resSz);
2479 sg_page_free(struct page *page, int size)
2485 for (order = 0, a_size = PAGE_SIZE; a_size < size;
2486 order++, a_size <<= 1) ;
2487 __free_pages(page, order);
2490 #ifndef MAINTENANCE_IN_CMD
2491 #define MAINTENANCE_IN_CMD 0xa3
2494 static unsigned char allow_ops[] = { TEST_UNIT_READY, REQUEST_SENSE,
2495 INQUIRY, READ_CAPACITY, READ_BUFFER, READ_6, READ_10, READ_12,
2496 READ_16, MODE_SENSE, MODE_SENSE_10, LOG_SENSE, REPORT_LUNS,
2497 SERVICE_ACTION_IN, RECEIVE_DIAGNOSTIC, READ_LONG, MAINTENANCE_IN_CMD
2501 sg_allow_access(unsigned char opcode, char dev_type)
2505 if (TYPE_SCANNER == dev_type) /* TYPE_ROM maybe burner */
2507 for (k = 0; k < sizeof (allow_ops); ++k) {
2508 if (opcode == allow_ops[k])
2514 #ifdef CONFIG_SCSI_PROC_FS
2516 sg_idr_max_id(int id, void *p, void *data)
2530 unsigned long iflags;
2532 read_lock_irqsave(&sg_index_lock, iflags);
2533 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2534 read_unlock_irqrestore(&sg_index_lock, iflags);
2535 return k + 1; /* origin 1 */
2543 unsigned long iflags;
2545 read_lock_irqsave(&sg_index_lock, iflags);
2546 sdp = idr_find(&sg_index_idr, dev);
2547 read_unlock_irqrestore(&sg_index_lock, iflags);
2552 #ifdef CONFIG_SCSI_PROC_FS
2554 static struct proc_dir_entry *sg_proc_sgp = NULL;
2556 static char sg_proc_sg_dirname[] = "scsi/sg";
2558 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2560 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2561 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2562 size_t count, loff_t *off);
2563 static struct file_operations adio_fops = {
2564 /* .owner, .read and .llseek added in sg_proc_init() */
2565 .open = sg_proc_single_open_adio,
2566 .write = sg_proc_write_adio,
2567 .release = single_release,
2570 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2571 static ssize_t sg_proc_write_dressz(struct file *filp,
2572 const char __user *buffer, size_t count, loff_t *off);
2573 static struct file_operations dressz_fops = {
2574 .open = sg_proc_single_open_dressz,
2575 .write = sg_proc_write_dressz,
2576 .release = single_release,
2579 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2580 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2581 static struct file_operations version_fops = {
2582 .open = sg_proc_single_open_version,
2583 .release = single_release,
2586 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2587 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2588 static struct file_operations devhdr_fops = {
2589 .open = sg_proc_single_open_devhdr,
2590 .release = single_release,
2593 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2594 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2595 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2596 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2597 static void dev_seq_stop(struct seq_file *s, void *v);
2598 static struct file_operations dev_fops = {
2599 .open = sg_proc_open_dev,
2600 .release = seq_release,
2602 static struct seq_operations dev_seq_ops = {
2603 .start = dev_seq_start,
2604 .next = dev_seq_next,
2605 .stop = dev_seq_stop,
2606 .show = sg_proc_seq_show_dev,
2609 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2610 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2611 static struct file_operations devstrs_fops = {
2612 .open = sg_proc_open_devstrs,
2613 .release = seq_release,
2615 static struct seq_operations devstrs_seq_ops = {
2616 .start = dev_seq_start,
2617 .next = dev_seq_next,
2618 .stop = dev_seq_stop,
2619 .show = sg_proc_seq_show_devstrs,
2622 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2623 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2624 static struct file_operations debug_fops = {
2625 .open = sg_proc_open_debug,
2626 .release = seq_release,
2628 static struct seq_operations debug_seq_ops = {
2629 .start = dev_seq_start,
2630 .next = dev_seq_next,
2631 .stop = dev_seq_stop,
2632 .show = sg_proc_seq_show_debug,
2636 struct sg_proc_leaf {
2638 struct file_operations * fops;
2641 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2642 {"allow_dio", &adio_fops},
2643 {"debug", &debug_fops},
2644 {"def_reserved_size", &dressz_fops},
2645 {"device_hdr", &devhdr_fops},
2646 {"devices", &dev_fops},
2647 {"device_strs", &devstrs_fops},
2648 {"version", &version_fops}
2655 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2656 struct proc_dir_entry *pdep;
2657 struct sg_proc_leaf * leaf;
2659 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2662 for (k = 0; k < num_leaves; ++k) {
2663 leaf = &sg_proc_leaf_arr[k];
2664 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2665 pdep = create_proc_entry(leaf->name, mask, sg_proc_sgp);
2667 leaf->fops->owner = THIS_MODULE,
2668 leaf->fops->read = seq_read,
2669 leaf->fops->llseek = seq_lseek,
2670 pdep->proc_fops = leaf->fops;
2677 sg_proc_cleanup(void)
2680 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2684 for (k = 0; k < num_leaves; ++k)
2685 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2686 remove_proc_entry(sg_proc_sg_dirname, NULL);
2690 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2692 seq_printf(s, "%d\n", *((int *)s->private));
2696 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2698 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2702 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2703 size_t count, loff_t *off)
2708 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2710 num = (count < 10) ? count : 10;
2711 if (copy_from_user(buff, buffer, num))
2714 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2718 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2720 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2724 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2725 size_t count, loff_t *off)
2728 unsigned long k = ULONG_MAX;
2731 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2733 num = (count < 10) ? count : 10;
2734 if (copy_from_user(buff, buffer, num))
2737 k = simple_strtoul(buff, NULL, 10);
2738 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2745 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2747 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2752 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2754 return single_open(file, sg_proc_seq_show_version, NULL);
2757 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2759 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2764 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2766 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2769 struct sg_proc_deviter {
2774 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2776 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2783 it->max = sg_last_dev();
2784 if (it->index >= it->max)
2789 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2791 struct sg_proc_deviter * it = s->private;
2794 return (it->index < it->max) ? it : NULL;
2797 static void dev_seq_stop(struct seq_file *s, void *v)
2802 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2804 return seq_open(file, &dev_seq_ops);
2807 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2809 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2811 struct scsi_device *scsidp;
2813 sdp = it ? sg_get_dev(it->index) : NULL;
2814 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2815 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2816 scsidp->host->host_no, scsidp->channel,
2817 scsidp->id, scsidp->lun, (int) scsidp->type,
2819 (int) scsidp->queue_depth,
2820 (int) scsidp->device_busy,
2821 (int) scsi_device_online(scsidp));
2823 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2827 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2829 return seq_open(file, &devstrs_seq_ops);
2832 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2834 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2836 struct scsi_device *scsidp;
2838 sdp = it ? sg_get_dev(it->index) : NULL;
2839 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2840 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2841 scsidp->vendor, scsidp->model, scsidp->rev);
2843 seq_printf(s, "<no active device>\n");
2847 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2849 int k, m, new_interface, blen, usg;
2852 const sg_io_hdr_t *hp;
2856 for (k = 0; (fp = sg_get_nth_sfp(sdp, k)); ++k) {
2857 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2858 "(res)sgat=%d low_dma=%d\n", k + 1,
2859 jiffies_to_msecs(fp->timeout),
2860 fp->reserve.bufflen,
2861 (int) fp->reserve.k_use_sg,
2863 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2864 (int) fp->cmd_q, (int) fp->force_packid,
2865 (int) fp->keep_orphan, (int) fp->closed);
2866 for (m = 0; (srp = sg_get_nth_request(fp, m)); ++m) {
2868 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2869 if (srp->res_used) {
2870 if (new_interface &&
2871 (SG_FLAG_MMAP_IO & hp->flags))
2876 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2882 blen = srp->data.bufflen;
2883 usg = srp->data.k_use_sg;
2884 seq_printf(s, srp->done ?
2885 ((1 == srp->done) ? "rcv:" : "fin:")
2887 seq_printf(s, " id=%d blen=%d",
2888 srp->header.pack_id, blen);
2890 seq_printf(s, " dur=%d", hp->duration);
2892 ms = jiffies_to_msecs(jiffies);
2893 seq_printf(s, " t_o/elap=%d/%d",
2894 (new_interface ? hp->timeout :
2895 jiffies_to_msecs(fp->timeout)),
2896 (ms > hp->duration ? ms - hp->duration : 0));
2898 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2899 (int) srp->data.cmd_opcode);
2902 seq_printf(s, " No requests active\n");
2906 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2908 return seq_open(file, &debug_seq_ops);
2911 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2913 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2916 if (it && (0 == it->index)) {
2917 seq_printf(s, "max_active_device=%d(origin 1)\n",
2919 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2921 sdp = it ? sg_get_dev(it->index) : NULL;
2923 struct scsi_device *scsidp = sdp->device;
2925 if (NULL == scsidp) {
2926 seq_printf(s, "device %d detached ??\n",
2931 if (sg_get_nth_sfp(sdp, 0)) {
2932 seq_printf(s, " >>> device=%s ",
2933 sdp->disk->disk_name);
2935 seq_printf(s, "detached pending close ");
2938 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2939 scsidp->host->host_no,
2940 scsidp->channel, scsidp->id,
2942 scsidp->host->hostt->emulated);
2943 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2944 sdp->sg_tablesize, sdp->exclude);
2946 sg_proc_debug_helper(s, sdp);
2951 #endif /* CONFIG_SCSI_PROC_FS */
2953 module_init(init_sg);
2954 module_exit(exit_sg);