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/seq_file.h>
47 #include <linux/blkdev.h>
48 #include <linux/delay.h>
49 #include <linux/scatterlist.h>
52 #include <scsi/scsi_dbg.h>
53 #include <scsi/scsi_host.h>
54 #include <scsi/scsi_driver.h>
55 #include <scsi/scsi_ioctl.h>
58 #include "scsi_logging.h"
60 #ifdef CONFIG_SCSI_PROC_FS
61 #include <linux/proc_fs.h>
62 static char *sg_version_date = "20061027";
64 static int sg_proc_init(void);
65 static void sg_proc_cleanup(void);
68 #define SG_ALLOW_DIO_DEF 0
69 #define SG_ALLOW_DIO_CODE /* compile out by commenting this define */
71 #define SG_MAX_DEVS 32768
74 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
75 * Then when using 32 bit integers x * m may overflow during the calculation.
76 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
77 * calculates the same, but prevents the overflow when both m and d
78 * are "small" numbers (like HZ and USER_HZ).
79 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
82 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
84 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
86 int sg_big_buff = SG_DEF_RESERVED_SIZE;
87 /* N.B. This variable is readable and writeable via
88 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
89 of this size (or less if there is not enough memory) will be reserved
90 for use by this file descriptor. [Deprecated usage: this variable is also
91 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
92 the kernel (i.e. it is not a module).] */
93 static int def_reserved_size = -1; /* picks up init parameter */
94 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
96 static int scatter_elem_sz = SG_SCATTER_SZ;
97 static int scatter_elem_sz_prev = SG_SCATTER_SZ;
99 #define SG_SECTOR_SZ 512
100 #define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
102 #define SG_DEV_ARR_LUMP 32 /* amount to over allocate sg_dev_arr by */
104 static int sg_add(struct class_device *, struct class_interface *);
105 static void sg_remove(struct class_device *, struct class_interface *);
107 static DEFINE_RWLOCK(sg_dev_arr_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 short 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 Sg_fd *headfp; /* first open fd belonging to this device */
166 volatile char detached; /* 0->attached, 1->detached pending removal */
167 volatile char exclude; /* opened for exclusive access */
168 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
169 struct gendisk *disk;
170 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
173 static int sg_fasync(int fd, struct file *filp, int mode);
174 /* tasklet or soft irq callback */
175 static void sg_cmd_done(void *data, char *sense, int result, int resid);
176 static int sg_start_req(Sg_request * srp);
177 static void sg_finish_rem_req(Sg_request * srp);
178 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
179 static int sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp,
181 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
183 static ssize_t sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
184 int blocking, int read_only, Sg_request ** o_srp);
185 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
186 unsigned char *cmnd, int timeout, int blocking);
187 static int sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
188 int wr_xf, int *countp, unsigned char __user **up);
189 static int sg_write_xfer(Sg_request * srp);
190 static int sg_read_xfer(Sg_request * srp);
191 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
192 static void sg_remove_scat(Sg_scatter_hold * schp);
193 static void sg_build_reserve(Sg_fd * sfp, int req_size);
194 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
195 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
196 static struct page *sg_page_malloc(int rqSz, int lowDma, int *retSzp);
197 static void sg_page_free(struct page *page, int size);
198 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
199 static int sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
200 static void __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
201 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
202 static Sg_request *sg_add_request(Sg_fd * sfp);
203 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
204 static int sg_res_in_use(Sg_fd * sfp);
205 static int sg_allow_access(unsigned char opcode, char dev_type);
206 static int sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len);
207 static Sg_device *sg_get_dev(int dev);
208 #ifdef CONFIG_SCSI_PROC_FS
209 static int sg_last_dev(void);
212 static Sg_device **sg_dev_arr = NULL;
213 static int sg_dev_max;
214 static int sg_nr_dev;
216 #define SZ_SG_HEADER sizeof(struct sg_header)
217 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
218 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
219 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
222 sg_open(struct inode *inode, struct file *filp)
224 int dev = iminor(inode);
225 int flags = filp->f_flags;
226 struct request_queue *q;
232 nonseekable_open(inode, filp);
233 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
234 sdp = sg_get_dev(dev);
235 if ((!sdp) || (!sdp->device))
240 /* This driver's module count bumped by fops_get in <linux/fs.h> */
241 /* Prevent the device driver from vanishing while we sleep */
242 retval = scsi_device_get(sdp->device);
246 if (!((flags & O_NONBLOCK) ||
247 scsi_block_when_processing_errors(sdp->device))) {
249 /* we are in error recovery for this device */
253 if (flags & O_EXCL) {
254 if (O_RDONLY == (flags & O_ACCMODE)) {
255 retval = -EPERM; /* Can't lock it with read only access */
258 if (sdp->headfp && (flags & O_NONBLOCK)) {
263 __wait_event_interruptible(sdp->o_excl_wait,
264 ((sdp->headfp || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
266 retval = res; /* -ERESTARTSYS because signal hit process */
269 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
270 if (flags & O_NONBLOCK) {
275 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
278 retval = res; /* -ERESTARTSYS because signal hit process */
286 if (!sdp->headfp) { /* no existing opens on this device */
288 q = sdp->device->request_queue;
289 sdp->sg_tablesize = min(q->max_hw_segments,
290 q->max_phys_segments);
292 if ((sfp = sg_add_sfp(sdp, dev)))
293 filp->private_data = sfp;
296 sdp->exclude = 0; /* undo if error */
303 scsi_device_put(sdp->device);
307 /* Following function was formerly called 'sg_close' */
309 sg_release(struct inode *inode, struct file *filp)
314 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
316 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
317 sg_fasync(-1, filp, 0); /* remove filp from async notification list */
318 if (0 == sg_remove_sfp(sdp, sfp)) { /* Returns 1 when sdp gone */
319 if (!sdp->detached) {
320 scsi_device_put(sdp->device);
323 wake_up_interruptible(&sdp->o_excl_wait);
329 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
334 int req_pack_id = -1;
336 struct sg_header *old_hdr = NULL;
339 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
341 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
342 sdp->disk->disk_name, (int) count));
344 if (!access_ok(VERIFY_WRITE, buf, count))
346 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
347 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
350 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
354 if (old_hdr->reply_len < 0) {
355 if (count >= SZ_SG_IO_HDR) {
356 sg_io_hdr_t *new_hdr;
357 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
362 retval =__copy_from_user
363 (new_hdr, buf, SZ_SG_IO_HDR);
364 req_pack_id = new_hdr->pack_id;
372 req_pack_id = old_hdr->pack_id;
374 srp = sg_get_rq_mark(sfp, req_pack_id);
375 if (!srp) { /* now wait on packet to arrive */
380 if (filp->f_flags & O_NONBLOCK) {
385 retval = 0; /* following macro beats race condition */
386 __wait_event_interruptible(sfp->read_wait,
388 (srp = sg_get_rq_mark(sfp, req_pack_id))),
397 /* -ERESTARTSYS as signal hit process */
401 if (srp->header.interface_id != '\0') {
402 retval = sg_new_read(sfp, buf, count, srp);
407 if (old_hdr == NULL) {
408 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
414 memset(old_hdr, 0, SZ_SG_HEADER);
415 old_hdr->reply_len = (int) hp->timeout;
416 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
417 old_hdr->pack_id = hp->pack_id;
418 old_hdr->twelve_byte =
419 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
420 old_hdr->target_status = hp->masked_status;
421 old_hdr->host_status = hp->host_status;
422 old_hdr->driver_status = hp->driver_status;
423 if ((CHECK_CONDITION & hp->masked_status) ||
424 (DRIVER_SENSE & hp->driver_status))
425 memcpy(old_hdr->sense_buffer, srp->sense_b,
426 sizeof (old_hdr->sense_buffer));
427 switch (hp->host_status) {
428 /* This setup of 'result' is for backward compatibility and is best
429 ignored by the user who should use target, host + driver status */
431 case DID_PASSTHROUGH:
438 old_hdr->result = EBUSY;
445 old_hdr->result = EIO;
448 old_hdr->result = (srp->sense_b[0] == 0 &&
449 hp->masked_status == GOOD) ? 0 : EIO;
452 old_hdr->result = EIO;
456 /* Now copy the result back to the user buffer. */
457 if (count >= SZ_SG_HEADER) {
458 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
463 if (count > old_hdr->reply_len)
464 count = old_hdr->reply_len;
465 if (count > SZ_SG_HEADER) {
466 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
472 count = (old_hdr->result == 0) ? 0 : -EIO;
473 sg_finish_rem_req(srp);
481 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
483 sg_io_hdr_t *hp = &srp->header;
487 if (count < SZ_SG_IO_HDR) {
492 if ((hp->mx_sb_len > 0) && hp->sbp) {
493 if ((CHECK_CONDITION & hp->masked_status) ||
494 (DRIVER_SENSE & hp->driver_status)) {
495 int sb_len = SCSI_SENSE_BUFFERSIZE;
496 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
497 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
498 len = (len > sb_len) ? sb_len : len;
499 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
506 if (hp->masked_status || hp->host_status || hp->driver_status)
507 hp->info |= SG_INFO_CHECK;
508 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
512 err = sg_read_xfer(srp);
514 sg_finish_rem_req(srp);
515 return (0 == err) ? count : err;
519 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
521 int mxsize, cmd_size, k;
522 int input_size, blocking;
523 unsigned char opcode;
527 struct sg_header old_hdr;
529 unsigned char cmnd[MAX_COMMAND_SIZE];
531 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
533 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
534 sdp->disk->disk_name, (int) count));
537 if (!((filp->f_flags & O_NONBLOCK) ||
538 scsi_block_when_processing_errors(sdp->device)))
541 if (!access_ok(VERIFY_READ, buf, count))
542 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
543 if (count < SZ_SG_HEADER)
545 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
547 blocking = !(filp->f_flags & O_NONBLOCK);
548 if (old_hdr.reply_len < 0)
549 return sg_new_write(sfp, buf, count, blocking, 0, NULL);
550 if (count < (SZ_SG_HEADER + 6))
551 return -EIO; /* The minimum scsi command length is 6 bytes. */
553 if (!(srp = sg_add_request(sfp))) {
554 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
558 __get_user(opcode, buf);
559 if (sfp->next_cmd_len > 0) {
560 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
561 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
562 sfp->next_cmd_len = 0;
563 sg_remove_request(sfp, srp);
566 cmd_size = sfp->next_cmd_len;
567 sfp->next_cmd_len = 0; /* reset so only this write() effected */
569 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
570 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
573 SCSI_LOG_TIMEOUT(4, printk(
574 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
575 /* Determine buffer size. */
576 input_size = count - cmd_size;
577 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
578 mxsize -= SZ_SG_HEADER;
579 input_size -= SZ_SG_HEADER;
580 if (input_size < 0) {
581 sg_remove_request(sfp, srp);
582 return -EIO; /* User did not pass enough bytes for this command. */
585 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
586 hp->cmd_len = (unsigned char) cmd_size;
590 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
591 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
593 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
594 hp->dxfer_len = mxsize;
595 hp->dxferp = (char __user *)buf + cmd_size;
597 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
598 hp->flags = input_size; /* structure abuse ... */
599 hp->pack_id = old_hdr.pack_id;
601 if (__copy_from_user(cmnd, buf, cmd_size))
604 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
605 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
606 * is a non-zero input_size, so emit a warning.
608 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV)
609 if (printk_ratelimit())
611 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
612 "guessing data in;\n" KERN_WARNING " "
613 "program %s not setting count and/or reply_len properly\n",
614 old_hdr.reply_len - (int)SZ_SG_HEADER,
615 input_size, (unsigned int) cmnd[0],
617 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
618 return (k < 0) ? k : count;
622 sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
623 int blocking, int read_only, Sg_request ** o_srp)
628 unsigned char cmnd[MAX_COMMAND_SIZE];
630 unsigned long ul_timeout;
632 if (count < SZ_SG_IO_HDR)
634 if (!access_ok(VERIFY_READ, buf, count))
635 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
637 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
638 if (!(srp = sg_add_request(sfp))) {
639 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
643 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
644 sg_remove_request(sfp, srp);
647 if (hp->interface_id != 'S') {
648 sg_remove_request(sfp, srp);
651 if (hp->flags & SG_FLAG_MMAP_IO) {
652 if (hp->dxfer_len > sfp->reserve.bufflen) {
653 sg_remove_request(sfp, srp);
654 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
656 if (hp->flags & SG_FLAG_DIRECT_IO) {
657 sg_remove_request(sfp, srp);
658 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
660 if (sg_res_in_use(sfp)) {
661 sg_remove_request(sfp, srp);
662 return -EBUSY; /* reserve buffer already being used */
665 ul_timeout = msecs_to_jiffies(srp->header.timeout);
666 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
667 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
668 sg_remove_request(sfp, srp);
671 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
672 sg_remove_request(sfp, srp);
673 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
675 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
676 sg_remove_request(sfp, srp);
680 (!sg_allow_access(cmnd[0], sfp->parentdp->device->type))) {
681 sg_remove_request(sfp, srp);
684 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
693 sg_common_write(Sg_fd * sfp, Sg_request * srp,
694 unsigned char *cmnd, int timeout, int blocking)
697 Sg_device *sdp = sfp->parentdp;
698 sg_io_hdr_t *hp = &srp->header;
700 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
702 hp->masked_status = 0;
706 hp->driver_status = 0;
708 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
709 (int) cmnd[0], (int) hp->cmd_len));
711 if ((k = sg_start_req(srp))) {
712 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
713 sg_finish_rem_req(srp);
714 return k; /* probably out of space --> ENOMEM */
716 if ((k = sg_write_xfer(srp))) {
717 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: write_xfer, bad address\n"));
718 sg_finish_rem_req(srp);
722 sg_finish_rem_req(srp);
726 switch (hp->dxfer_direction) {
727 case SG_DXFER_TO_FROM_DEV:
728 case SG_DXFER_FROM_DEV:
729 data_dir = DMA_FROM_DEVICE;
731 case SG_DXFER_TO_DEV:
732 data_dir = DMA_TO_DEVICE;
734 case SG_DXFER_UNKNOWN:
735 data_dir = DMA_BIDIRECTIONAL;
741 hp->duration = jiffies_to_msecs(jiffies);
742 /* Now send everything of to mid-level. The next time we hear about this
743 packet is when sg_cmd_done() is called (i.e. a callback). */
744 if (scsi_execute_async(sdp->device, cmnd, hp->cmd_len, data_dir, srp->data.buffer,
745 hp->dxfer_len, srp->data.k_use_sg, timeout,
746 SG_DEFAULT_RETRIES, srp, sg_cmd_done,
748 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: scsi_execute_async failed\n"));
750 * most likely out of mem, but could also be a bad map
752 sg_finish_rem_req(srp);
759 sg_srp_done(Sg_request *srp, Sg_fd *sfp)
761 unsigned long iflags;
764 read_lock_irqsave(&sfp->rq_list_lock, iflags);
766 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
771 sg_ioctl(struct inode *inode, struct file *filp,
772 unsigned int cmd_in, unsigned long arg)
774 void __user *p = (void __user *)arg;
776 int result, val, read_only;
780 unsigned long iflags;
782 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
784 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
785 sdp->disk->disk_name, (int) cmd_in));
786 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
791 int blocking = 1; /* ignore O_NONBLOCK flag */
795 if (!scsi_block_when_processing_errors(sdp->device))
797 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
800 sg_new_write(sfp, p, SZ_SG_IO_HDR,
801 blocking, read_only, &srp);
804 srp->sg_io_owned = 1;
806 result = 0; /* following macro to beat race condition */
807 __wait_event_interruptible(sfp->read_wait,
808 (sdp->detached || sfp->closed || sg_srp_done(srp, sfp)),
813 return 0; /* request packet dropped already */
817 return result; /* -ERESTARTSYS because signal hit process */
819 write_lock_irqsave(&sfp->rq_list_lock, iflags);
821 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
822 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
823 return (result < 0) ? result : 0;
826 result = get_user(val, ip);
831 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
832 val = MULDIV (INT_MAX, USER_HZ, HZ);
833 sfp->timeout_user = val;
834 sfp->timeout = MULDIV (val, HZ, USER_HZ);
837 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
838 /* strange ..., for backward compatibility */
839 return sfp->timeout_user;
840 case SG_SET_FORCE_LOW_DMA:
841 result = get_user(val, ip);
846 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
847 val = (int) sfp->reserve.bufflen;
848 sg_remove_scat(&sfp->reserve);
849 sg_build_reserve(sfp, val);
854 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
858 return put_user((int) sfp->low_dma, ip);
860 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
863 sg_scsi_id_t __user *sg_idp = p;
867 __put_user((int) sdp->device->host->host_no,
869 __put_user((int) sdp->device->channel,
871 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
872 __put_user((int) sdp->device->lun, &sg_idp->lun);
873 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
874 __put_user((short) sdp->device->host->cmd_per_lun,
875 &sg_idp->h_cmd_per_lun);
876 __put_user((short) sdp->device->queue_depth,
877 &sg_idp->d_queue_depth);
878 __put_user(0, &sg_idp->unused[0]);
879 __put_user(0, &sg_idp->unused[1]);
882 case SG_SET_FORCE_PACK_ID:
883 result = get_user(val, ip);
886 sfp->force_packid = val ? 1 : 0;
889 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
891 read_lock_irqsave(&sfp->rq_list_lock, iflags);
892 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
893 if ((1 == srp->done) && (!srp->sg_io_owned)) {
894 read_unlock_irqrestore(&sfp->rq_list_lock,
896 __put_user(srp->header.pack_id, ip);
900 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
903 case SG_GET_NUM_WAITING:
904 read_lock_irqsave(&sfp->rq_list_lock, iflags);
905 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
906 if ((1 == srp->done) && (!srp->sg_io_owned))
909 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
910 return put_user(val, ip);
911 case SG_GET_SG_TABLESIZE:
912 return put_user(sdp->sg_tablesize, ip);
913 case SG_SET_RESERVED_SIZE:
914 result = get_user(val, ip);
919 val = min_t(int, val,
920 sdp->device->request_queue->max_sectors * 512);
921 if (val != sfp->reserve.bufflen) {
922 if (sg_res_in_use(sfp) || sfp->mmap_called)
924 sg_remove_scat(&sfp->reserve);
925 sg_build_reserve(sfp, val);
928 case SG_GET_RESERVED_SIZE:
929 val = min_t(int, sfp->reserve.bufflen,
930 sdp->device->request_queue->max_sectors * 512);
931 return put_user(val, ip);
932 case SG_SET_COMMAND_Q:
933 result = get_user(val, ip);
936 sfp->cmd_q = val ? 1 : 0;
938 case SG_GET_COMMAND_Q:
939 return put_user((int) sfp->cmd_q, ip);
940 case SG_SET_KEEP_ORPHAN:
941 result = get_user(val, ip);
944 sfp->keep_orphan = val;
946 case SG_GET_KEEP_ORPHAN:
947 return put_user((int) sfp->keep_orphan, ip);
948 case SG_NEXT_CMD_LEN:
949 result = get_user(val, ip);
952 sfp->next_cmd_len = (val > 0) ? val : 0;
954 case SG_GET_VERSION_NUM:
955 return put_user(sg_version_num, ip);
956 case SG_GET_ACCESS_COUNT:
957 /* faked - we don't have a real access count anymore */
958 val = (sdp->device ? 1 : 0);
959 return put_user(val, ip);
960 case SG_GET_REQUEST_TABLE:
961 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
964 sg_req_info_t *rinfo;
967 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
971 read_lock_irqsave(&sfp->rq_list_lock, iflags);
972 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
973 ++val, srp = srp ? srp->nextrp : srp) {
974 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
976 rinfo[val].req_state = srp->done + 1;
978 srp->header.masked_status &
979 srp->header.host_status &
980 srp->header.driver_status;
982 rinfo[val].duration =
983 srp->header.duration;
985 ms = jiffies_to_msecs(jiffies);
986 rinfo[val].duration =
987 (ms > srp->header.duration) ?
988 (ms - srp->header.duration) : 0;
990 rinfo[val].orphan = srp->orphan;
991 rinfo[val].sg_io_owned =
999 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1000 result = __copy_to_user(p, rinfo,
1001 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1002 result = result ? -EFAULT : 0;
1006 case SG_EMULATED_HOST:
1009 return put_user(sdp->device->host->hostt->emulated, ip);
1013 if (filp->f_flags & O_NONBLOCK) {
1014 if (scsi_host_in_recovery(sdp->device->host))
1016 } else if (!scsi_block_when_processing_errors(sdp->device))
1018 result = get_user(val, ip);
1021 if (SG_SCSI_RESET_NOTHING == val)
1024 case SG_SCSI_RESET_DEVICE:
1025 val = SCSI_TRY_RESET_DEVICE;
1027 case SG_SCSI_RESET_BUS:
1028 val = SCSI_TRY_RESET_BUS;
1030 case SG_SCSI_RESET_HOST:
1031 val = SCSI_TRY_RESET_HOST;
1036 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1038 return (scsi_reset_provider(sdp->device, val) ==
1039 SUCCESS) ? 0 : -EIO;
1040 case SCSI_IOCTL_SEND_COMMAND:
1044 unsigned char opcode = WRITE_6;
1045 Scsi_Ioctl_Command __user *siocp = p;
1047 if (copy_from_user(&opcode, siocp->data, 1))
1049 if (!sg_allow_access(opcode, sdp->device->type))
1052 return sg_scsi_ioctl(filp, sdp->device->request_queue, NULL, p);
1054 result = get_user(val, ip);
1057 sdp->sgdebug = (char) val;
1059 case SCSI_IOCTL_GET_IDLUN:
1060 case SCSI_IOCTL_GET_BUS_NUMBER:
1061 case SCSI_IOCTL_PROBE_HOST:
1062 case SG_GET_TRANSFORM:
1065 return scsi_ioctl(sdp->device, cmd_in, p);
1067 return put_user(sdp->device->request_queue->max_sectors * 512,
1071 return -EPERM; /* don't know so take safe approach */
1072 return scsi_ioctl(sdp->device, cmd_in, p);
1076 #ifdef CONFIG_COMPAT
1077 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1081 struct scsi_device *sdev;
1083 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1087 if (sdev->host->hostt->compat_ioctl) {
1090 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1095 return -ENOIOCTLCMD;
1100 sg_poll(struct file *filp, poll_table * wait)
1102 unsigned int res = 0;
1107 unsigned long iflags;
1109 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1112 poll_wait(filp, &sfp->read_wait, wait);
1113 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1114 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1115 /* if any read waiting, flag it */
1116 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1117 res = POLLIN | POLLRDNORM;
1120 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1124 else if (!sfp->cmd_q) {
1126 res |= POLLOUT | POLLWRNORM;
1127 } else if (count < SG_MAX_QUEUE)
1128 res |= POLLOUT | POLLWRNORM;
1129 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1130 sdp->disk->disk_name, (int) res));
1135 sg_fasync(int fd, struct file *filp, int mode)
1141 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1143 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1144 sdp->disk->disk_name, mode));
1146 retval = fasync_helper(fd, filp, mode, &sfp->async_qp);
1147 return (retval < 0) ? retval : 0;
1150 static struct page *
1151 sg_vma_nopage(struct vm_area_struct *vma, unsigned long addr, int *type)
1154 struct page *page = NOPAGE_SIGBUS;
1155 unsigned long offset, len, sa;
1156 Sg_scatter_hold *rsv_schp;
1157 struct scatterlist *sg;
1160 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1162 rsv_schp = &sfp->reserve;
1163 offset = addr - vma->vm_start;
1164 if (offset >= rsv_schp->bufflen)
1166 SCSI_LOG_TIMEOUT(3, printk("sg_vma_nopage: offset=%lu, scatg=%d\n",
1167 offset, rsv_schp->k_use_sg));
1168 sg = rsv_schp->buffer;
1170 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1172 len = vma->vm_end - sa;
1173 len = (len < sg->length) ? len : sg->length;
1175 page = virt_to_page(page_address(sg->page) + offset);
1176 get_page(page); /* increment page count */
1184 *type = VM_FAULT_MINOR;
1188 static struct vm_operations_struct sg_mmap_vm_ops = {
1189 .nopage = sg_vma_nopage,
1193 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1196 unsigned long req_sz, len, sa;
1197 Sg_scatter_hold *rsv_schp;
1199 struct scatterlist *sg;
1201 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1203 req_sz = vma->vm_end - vma->vm_start;
1204 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1205 (void *) vma->vm_start, (int) req_sz));
1207 return -EINVAL; /* want no offset */
1208 rsv_schp = &sfp->reserve;
1209 if (req_sz > rsv_schp->bufflen)
1210 return -ENOMEM; /* cannot map more than reserved buffer */
1213 sg = rsv_schp->buffer;
1214 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1216 len = vma->vm_end - sa;
1217 len = (len < sg->length) ? len : sg->length;
1221 sfp->mmap_called = 1;
1222 vma->vm_flags |= VM_RESERVED;
1223 vma->vm_private_data = sfp;
1224 vma->vm_ops = &sg_mmap_vm_ops;
1228 /* This function is a "bottom half" handler that is called by the
1229 * mid level when a command is completed (or has failed). */
1231 sg_cmd_done(void *data, char *sense, int result, int resid)
1233 Sg_request *srp = data;
1234 Sg_device *sdp = NULL;
1236 unsigned long iflags;
1240 printk(KERN_ERR "sg_cmd_done: NULL request\n");
1243 sfp = srp->parentfp;
1245 sdp = sfp->parentdp;
1246 if ((NULL == sdp) || sdp->detached) {
1247 printk(KERN_INFO "sg_cmd_done: device detached\n");
1252 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1253 sdp->disk->disk_name, srp->header.pack_id, result));
1254 srp->header.resid = resid;
1255 ms = jiffies_to_msecs(jiffies);
1256 srp->header.duration = (ms > srp->header.duration) ?
1257 (ms - srp->header.duration) : 0;
1259 struct scsi_sense_hdr sshdr;
1261 memcpy(srp->sense_b, sense, sizeof (srp->sense_b));
1262 srp->header.status = 0xff & result;
1263 srp->header.masked_status = status_byte(result);
1264 srp->header.msg_status = msg_byte(result);
1265 srp->header.host_status = host_byte(result);
1266 srp->header.driver_status = driver_byte(result);
1267 if ((sdp->sgdebug > 0) &&
1268 ((CHECK_CONDITION == srp->header.masked_status) ||
1269 (COMMAND_TERMINATED == srp->header.masked_status)))
1270 __scsi_print_sense("sg_cmd_done", sense,
1271 SCSI_SENSE_BUFFERSIZE);
1273 /* Following if statement is a patch supplied by Eric Youngdale */
1274 if (driver_byte(result) != 0
1275 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1276 && !scsi_sense_is_deferred(&sshdr)
1277 && sshdr.sense_key == UNIT_ATTENTION
1278 && sdp->device->removable) {
1279 /* Detected possible disc change. Set the bit - this */
1280 /* may be used if there are filesystems using this device */
1281 sdp->device->changed = 1;
1284 /* Rely on write phase to clean out srp status values, so no "else" */
1286 if (sfp->closed) { /* whoops this fd already released, cleanup */
1287 SCSI_LOG_TIMEOUT(1, printk("sg_cmd_done: already closed, freeing ...\n"));
1288 sg_finish_rem_req(srp);
1290 if (NULL == sfp->headrp) {
1291 SCSI_LOG_TIMEOUT(1, printk("sg_cmd_done: already closed, final cleanup\n"));
1292 if (0 == sg_remove_sfp(sdp, sfp)) { /* device still present */
1293 scsi_device_put(sdp->device);
1297 } else if (srp && srp->orphan) {
1298 if (sfp->keep_orphan)
1299 srp->sg_io_owned = 0;
1301 sg_finish_rem_req(srp);
1306 /* Now wake up any sg_read() that is waiting for this packet. */
1307 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1308 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1310 wake_up_interruptible(&sfp->read_wait);
1311 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1315 static struct file_operations sg_fops = {
1316 .owner = THIS_MODULE,
1321 #ifdef CONFIG_COMPAT
1322 .compat_ioctl = sg_compat_ioctl,
1326 .release = sg_release,
1327 .fasync = sg_fasync,
1330 static struct class *sg_sysfs_class;
1332 static int sg_sysfs_valid = 0;
1334 static int sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1336 struct request_queue *q = scsidp->request_queue;
1338 unsigned long iflags;
1339 void *old_sg_dev_arr = NULL;
1342 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1344 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1348 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1349 if (unlikely(sg_nr_dev >= sg_dev_max)) { /* try to resize */
1351 int tmp_dev_max = sg_nr_dev + SG_DEV_ARR_LUMP;
1352 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1354 tmp_da = kzalloc(tmp_dev_max * sizeof(Sg_device *), GFP_KERNEL);
1355 if (unlikely(!tmp_da))
1358 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1359 memcpy(tmp_da, sg_dev_arr, sg_dev_max * sizeof(Sg_device *));
1360 old_sg_dev_arr = sg_dev_arr;
1361 sg_dev_arr = tmp_da;
1362 sg_dev_max = tmp_dev_max;
1365 for (k = 0; k < sg_dev_max; k++)
1368 if (unlikely(k >= SG_MAX_DEVS))
1371 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1372 sprintf(disk->disk_name, "sg%d", k);
1373 disk->first_minor = k;
1375 sdp->device = scsidp;
1376 init_waitqueue_head(&sdp->o_excl_wait);
1377 sdp->sg_tablesize = min(q->max_hw_segments, q->max_phys_segments);
1380 sg_dev_arr[k] = sdp;
1381 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1387 kfree(old_sg_dev_arr);
1391 printk(KERN_WARNING "sg_alloc: device array cannot be resized\n");
1396 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1397 sdev_printk(KERN_WARNING, scsidp,
1398 "Unable to attach sg device type=%d, minor "
1399 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1405 sg_add(struct class_device *cl_dev, struct class_interface *cl_intf)
1407 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1408 struct gendisk *disk;
1409 Sg_device *sdp = NULL;
1410 struct cdev * cdev = NULL;
1412 unsigned long iflags;
1414 disk = alloc_disk(1);
1416 printk(KERN_WARNING "alloc_disk failed\n");
1419 disk->major = SCSI_GENERIC_MAJOR;
1422 cdev = cdev_alloc();
1424 printk(KERN_WARNING "cdev_alloc failed\n");
1427 cdev->owner = THIS_MODULE;
1428 cdev->ops = &sg_fops;
1430 error = sg_alloc(disk, scsidp);
1432 printk(KERN_WARNING "sg_alloc failed\n");
1436 sdp = sg_dev_arr[k];
1438 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, k), 1);
1443 if (sg_sysfs_valid) {
1444 struct class_device * sg_class_member;
1446 sg_class_member = class_device_create(sg_sysfs_class, NULL,
1447 MKDEV(SCSI_GENERIC_MAJOR, k),
1450 if (IS_ERR(sg_class_member))
1451 printk(KERN_WARNING "sg_add: "
1452 "class_device_create failed\n");
1453 class_set_devdata(sg_class_member, sdp);
1454 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1455 &sg_class_member->kobj, "generic");
1457 printk(KERN_ERR "sg_add: unable to make symlink "
1458 "'generic' back to sg%d\n", k);
1460 printk(KERN_WARNING "sg_add: sg_sys INvalid\n");
1462 sdev_printk(KERN_NOTICE, scsidp,
1463 "Attached scsi generic sg%d type %d\n", k,scsidp->type);
1468 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1469 kfree(sg_dev_arr[k]);
1470 sg_dev_arr[k] = NULL;
1472 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1482 sg_remove(struct class_device *cl_dev, struct class_interface *cl_intf)
1484 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1485 Sg_device *sdp = NULL;
1486 unsigned long iflags;
1493 if (NULL == sg_dev_arr)
1496 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1497 for (k = 0; k < sg_dev_max; k++) {
1498 sdp = sg_dev_arr[k];
1499 if ((NULL == sdp) || (sdp->device != scsidp))
1500 continue; /* dirty but lowers nesting */
1503 for (sfp = sdp->headfp; sfp; sfp = tsfp) {
1505 for (srp = sfp->headrp; srp; srp = tsrp) {
1507 if (sfp->closed || (0 == sg_srp_done(srp, sfp)))
1508 sg_finish_rem_req(srp);
1511 scsi_device_put(sdp->device);
1512 __sg_remove_sfp(sdp, sfp);
1515 wake_up_interruptible(&sfp->read_wait);
1516 kill_fasync(&sfp->async_qp, SIGPOLL,
1520 SCSI_LOG_TIMEOUT(3, printk("sg_remove: dev=%d, dirty\n", k));
1521 if (NULL == sdp->headfp) {
1522 sg_dev_arr[k] = NULL;
1524 } else { /* nothing active, simple case */
1525 SCSI_LOG_TIMEOUT(3, printk("sg_remove: dev=%d\n", k));
1526 sg_dev_arr[k] = NULL;
1531 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1534 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1535 class_device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, k));
1536 cdev_del(sdp->cdev);
1538 put_disk(sdp->disk);
1540 if (NULL == sdp->headfp)
1541 kfree((char *) sdp);
1545 msleep(10); /* dirty detach so delay device destruction */
1548 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1549 module_param_named(def_reserved_size, def_reserved_size, int,
1551 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1553 MODULE_AUTHOR("Douglas Gilbert");
1554 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1555 MODULE_LICENSE("GPL");
1556 MODULE_VERSION(SG_VERSION_STR);
1557 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1559 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1560 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1561 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1562 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1569 if (scatter_elem_sz < PAGE_SIZE) {
1570 scatter_elem_sz = PAGE_SIZE;
1571 scatter_elem_sz_prev = scatter_elem_sz;
1573 if (def_reserved_size >= 0)
1574 sg_big_buff = def_reserved_size;
1576 def_reserved_size = sg_big_buff;
1578 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1582 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1583 if ( IS_ERR(sg_sysfs_class) ) {
1584 rc = PTR_ERR(sg_sysfs_class);
1588 rc = scsi_register_interface(&sg_interface);
1590 #ifdef CONFIG_SCSI_PROC_FS
1592 #endif /* CONFIG_SCSI_PROC_FS */
1595 class_destroy(sg_sysfs_class);
1597 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1604 #ifdef CONFIG_SCSI_PROC_FS
1606 #endif /* CONFIG_SCSI_PROC_FS */
1607 scsi_unregister_interface(&sg_interface);
1608 class_destroy(sg_sysfs_class);
1610 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1612 kfree((char *)sg_dev_arr);
1618 sg_start_req(Sg_request * srp)
1621 Sg_fd *sfp = srp->parentfp;
1622 sg_io_hdr_t *hp = &srp->header;
1623 int dxfer_len = (int) hp->dxfer_len;
1624 int dxfer_dir = hp->dxfer_direction;
1625 Sg_scatter_hold *req_schp = &srp->data;
1626 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1628 SCSI_LOG_TIMEOUT(4, printk("sg_start_req: dxfer_len=%d\n", dxfer_len));
1629 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1631 if (sg_allow_dio && (hp->flags & SG_FLAG_DIRECT_IO) &&
1632 (dxfer_dir != SG_DXFER_UNKNOWN) && (0 == hp->iovec_count) &&
1633 (!sfp->parentdp->device->host->unchecked_isa_dma)) {
1634 res = sg_build_direct(srp, sfp, dxfer_len);
1635 if (res <= 0) /* -ve -> error, 0 -> done, 1 -> try indirect */
1638 if ((!sg_res_in_use(sfp)) && (dxfer_len <= rsv_schp->bufflen))
1639 sg_link_reserve(sfp, srp, dxfer_len);
1641 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1643 sg_remove_scat(req_schp);
1651 sg_finish_rem_req(Sg_request * srp)
1653 Sg_fd *sfp = srp->parentfp;
1654 Sg_scatter_hold *req_schp = &srp->data;
1656 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1658 sg_unlink_reserve(sfp, srp);
1660 sg_remove_scat(req_schp);
1661 sg_remove_request(sfp, srp);
1665 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1667 int sg_bufflen = tablesize * sizeof(struct scatterlist);
1668 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1671 * TODO: test without low_dma, we should not need it since
1672 * the block layer will bounce the buffer for us
1674 * XXX(hch): we shouldn't need GFP_DMA for the actual S/G list.
1677 gfp_flags |= GFP_DMA;
1678 schp->buffer = kzalloc(sg_bufflen, gfp_flags);
1681 schp->sglist_len = sg_bufflen;
1682 return tablesize; /* number of scat_gath elements allocated */
1685 #ifdef SG_ALLOW_DIO_CODE
1686 /* vvvvvvvv following code borrowed from st driver's direct IO vvvvvvvvv */
1687 /* TODO: hopefully we can use the generic block layer code */
1689 /* Pin down user pages and put them into a scatter gather list. Returns <= 0 if
1690 - mapping of all pages not successful
1691 (i.e., either completely successful or fails)
1694 st_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages,
1695 unsigned long uaddr, size_t count, int rw)
1697 unsigned long end = (uaddr + count + PAGE_SIZE - 1) >> PAGE_SHIFT;
1698 unsigned long start = uaddr >> PAGE_SHIFT;
1699 const int nr_pages = end - start;
1701 struct page **pages;
1703 /* User attempted Overflow! */
1704 if ((uaddr + count) < uaddr)
1708 if (nr_pages > max_pages)
1715 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_ATOMIC)) == NULL)
1718 /* Try to fault in all of the necessary pages */
1719 down_read(¤t->mm->mmap_sem);
1720 /* rw==READ means read from drive, write into memory area */
1721 res = get_user_pages(
1727 0, /* don't force */
1730 up_read(¤t->mm->mmap_sem);
1732 /* Errors and no page mapped should return here */
1736 for (i=0; i < nr_pages; i++) {
1737 /* FIXME: flush superflous for rw==READ,
1738 * probably wrong function for rw==WRITE
1740 flush_dcache_page(pages[i]);
1741 /* ?? Is locking needed? I don't think so */
1742 /* if (TestSetPageLocked(pages[i]))
1746 sgl[0].page = pages[0];
1747 sgl[0].offset = uaddr & ~PAGE_MASK;
1749 sgl[0].length = PAGE_SIZE - sgl[0].offset;
1750 count -= sgl[0].length;
1751 for (i=1; i < nr_pages ; i++) {
1752 sgl[i].page = pages[i];
1753 sgl[i].length = count < PAGE_SIZE ? count : PAGE_SIZE;
1758 sgl[0].length = count;
1766 for (j=0; j < res; j++)
1767 page_cache_release(pages[j]);
1775 /* And unmap them... */
1777 st_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
1782 for (i=0; i < nr_pages; i++) {
1783 struct page *page = sgl[i].page;
1787 /* unlock_page(page); */
1788 /* FIXME: cache flush missing for rw==READ
1789 * FIXME: call the correct reference counting function
1791 page_cache_release(page);
1797 /* ^^^^^^^^ above code borrowed from st driver's direct IO ^^^^^^^^^ */
1801 /* Returns: -ve -> error, 0 -> done, 1 -> try indirect */
1803 sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len)
1805 #ifdef SG_ALLOW_DIO_CODE
1806 sg_io_hdr_t *hp = &srp->header;
1807 Sg_scatter_hold *schp = &srp->data;
1808 int sg_tablesize = sfp->parentdp->sg_tablesize;
1809 int mx_sc_elems, res;
1810 struct scsi_device *sdev = sfp->parentdp->device;
1812 if (((unsigned long)hp->dxferp &
1813 queue_dma_alignment(sdev->request_queue)) != 0)
1816 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1817 if (mx_sc_elems <= 0) {
1820 res = st_map_user_pages(schp->buffer, mx_sc_elems,
1821 (unsigned long)hp->dxferp, dxfer_len,
1822 (SG_DXFER_TO_DEV == hp->dxfer_direction) ? 1 : 0);
1824 sg_remove_scat(schp);
1827 schp->k_use_sg = res;
1828 schp->dio_in_use = 1;
1829 hp->info |= SG_INFO_DIRECT_IO;
1837 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1839 struct scatterlist *sg;
1840 int ret_sz = 0, k, rem_sz, num, mx_sc_elems;
1841 int sg_tablesize = sfp->parentdp->sg_tablesize;
1842 int blk_size = buff_size;
1843 struct page *p = NULL;
1845 if ((blk_size < 0) || (!sfp))
1848 ++blk_size; /* don't know why */
1849 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1850 blk_size = (blk_size + SG_SECTOR_MSK) & (~SG_SECTOR_MSK);
1851 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1852 buff_size, blk_size));
1854 /* N.B. ret_sz carried into this block ... */
1855 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1856 if (mx_sc_elems < 0)
1857 return mx_sc_elems; /* most likely -ENOMEM */
1859 num = scatter_elem_sz;
1860 if (unlikely(num != scatter_elem_sz_prev)) {
1861 if (num < PAGE_SIZE) {
1862 scatter_elem_sz = PAGE_SIZE;
1863 scatter_elem_sz_prev = PAGE_SIZE;
1865 scatter_elem_sz_prev = num;
1867 for (k = 0, sg = schp->buffer, rem_sz = blk_size;
1868 (rem_sz > 0) && (k < mx_sc_elems);
1869 ++k, rem_sz -= ret_sz, ++sg) {
1871 num = (rem_sz > scatter_elem_sz_prev) ?
1872 scatter_elem_sz_prev : rem_sz;
1873 p = sg_page_malloc(num, sfp->low_dma, &ret_sz);
1877 if (num == scatter_elem_sz_prev) {
1878 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1879 scatter_elem_sz = ret_sz;
1880 scatter_elem_sz_prev = ret_sz;
1884 sg->length = (ret_sz > num) ? num : ret_sz;
1886 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1887 "ret_sz=%d\n", k, num, ret_sz));
1888 } /* end of for loop */
1891 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1892 "rem_sz=%d\n", k, rem_sz));
1894 schp->bufflen = blk_size;
1895 if (rem_sz > 0) /* must have failed */
1902 sg_write_xfer(Sg_request * srp)
1904 sg_io_hdr_t *hp = &srp->header;
1905 Sg_scatter_hold *schp = &srp->data;
1906 struct scatterlist *sg = schp->buffer;
1908 int j, k, onum, usglen, ksglen, res;
1909 int iovec_count = (int) hp->iovec_count;
1910 int dxfer_dir = hp->dxfer_direction;
1912 unsigned char __user *up;
1913 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
1915 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_TO_DEV == dxfer_dir) ||
1916 (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
1917 num_xfer = (int) (new_interface ? hp->dxfer_len : hp->flags);
1918 if (schp->bufflen < num_xfer)
1919 num_xfer = schp->bufflen;
1921 if ((num_xfer <= 0) || (schp->dio_in_use) ||
1923 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
1926 SCSI_LOG_TIMEOUT(4, printk("sg_write_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
1927 num_xfer, iovec_count, schp->k_use_sg));
1930 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
1935 ksglen = sg->length;
1936 p = page_address(sg->page);
1937 for (j = 0, k = 0; j < onum; ++j) {
1938 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1942 for (; p; ++sg, ksglen = sg->length,
1943 p = page_address(sg->page)) {
1946 if (ksglen > usglen) {
1947 if (usglen >= num_xfer) {
1948 if (__copy_from_user(p, up, num_xfer))
1952 if (__copy_from_user(p, up, usglen))
1958 if (ksglen >= num_xfer) {
1959 if (__copy_from_user(p, up, num_xfer))
1963 if (__copy_from_user(p, up, ksglen))
1969 if (k >= schp->k_use_sg)
1978 sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
1979 int wr_xf, int *countp, unsigned char __user **up)
1981 int num_xfer = (int) hp->dxfer_len;
1982 unsigned char __user *p = hp->dxferp;
1986 if (wr_xf && ('\0' == hp->interface_id))
1987 count = (int) hp->flags; /* holds "old" input_size */
1992 if (__copy_from_user(&iovec, p + ind*SZ_SG_IOVEC, SZ_SG_IOVEC))
1995 count = (int) iovec.iov_len;
1997 if (!access_ok(wr_xf ? VERIFY_READ : VERIFY_WRITE, p, count))
2007 sg_remove_scat(Sg_scatter_hold * schp)
2009 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
2010 if (schp->buffer && (schp->sglist_len > 0)) {
2011 struct scatterlist *sg = schp->buffer;
2013 if (schp->dio_in_use) {
2014 #ifdef SG_ALLOW_DIO_CODE
2015 st_unmap_user_pages(sg, schp->k_use_sg, TRUE);
2020 for (k = 0; (k < schp->k_use_sg) && sg->page;
2022 SCSI_LOG_TIMEOUT(5, printk(
2023 "sg_remove_scat: k=%d, pg=0x%p, len=%d\n",
2024 k, sg->page, sg->length));
2025 sg_page_free(sg->page, sg->length);
2028 kfree(schp->buffer);
2030 memset(schp, 0, sizeof (*schp));
2034 sg_read_xfer(Sg_request * srp)
2036 sg_io_hdr_t *hp = &srp->header;
2037 Sg_scatter_hold *schp = &srp->data;
2038 struct scatterlist *sg = schp->buffer;
2040 int j, k, onum, usglen, ksglen, res;
2041 int iovec_count = (int) hp->iovec_count;
2042 int dxfer_dir = hp->dxfer_direction;
2044 unsigned char __user *up;
2045 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
2047 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_FROM_DEV == dxfer_dir)
2048 || (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
2049 num_xfer = hp->dxfer_len;
2050 if (schp->bufflen < num_xfer)
2051 num_xfer = schp->bufflen;
2053 if ((num_xfer <= 0) || (schp->dio_in_use) ||
2055 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
2058 SCSI_LOG_TIMEOUT(4, printk("sg_read_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
2059 num_xfer, iovec_count, schp->k_use_sg));
2062 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
2067 p = page_address(sg->page);
2068 ksglen = sg->length;
2069 for (j = 0, k = 0; j < onum; ++j) {
2070 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2074 for (; p; ++sg, ksglen = sg->length,
2075 p = page_address(sg->page)) {
2078 if (ksglen > usglen) {
2079 if (usglen >= num_xfer) {
2080 if (__copy_to_user(up, p, num_xfer))
2084 if (__copy_to_user(up, p, usglen))
2090 if (ksglen >= num_xfer) {
2091 if (__copy_to_user(up, p, num_xfer))
2095 if (__copy_to_user(up, p, ksglen))
2101 if (k >= schp->k_use_sg)
2110 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
2112 Sg_scatter_hold *schp = &srp->data;
2113 struct scatterlist *sg = schp->buffer;
2116 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
2118 if ((!outp) || (num_read_xfer <= 0))
2121 for (k = 0; (k < schp->k_use_sg) && sg->page; ++k, ++sg) {
2123 if (num > num_read_xfer) {
2124 if (__copy_to_user(outp, page_address(sg->page),
2129 if (__copy_to_user(outp, page_address(sg->page),
2132 num_read_xfer -= num;
2133 if (num_read_xfer <= 0)
2143 sg_build_reserve(Sg_fd * sfp, int req_size)
2145 Sg_scatter_hold *schp = &sfp->reserve;
2147 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
2149 if (req_size < PAGE_SIZE)
2150 req_size = PAGE_SIZE;
2151 if (0 == sg_build_indirect(schp, sfp, req_size))
2154 sg_remove_scat(schp);
2155 req_size >>= 1; /* divide by 2 */
2156 } while (req_size > (PAGE_SIZE / 2));
2160 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2162 Sg_scatter_hold *req_schp = &srp->data;
2163 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2164 struct scatterlist *sg = rsv_schp->buffer;
2168 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
2171 for (k = 0; k < rsv_schp->k_use_sg; ++k, ++sg) {
2174 sfp->save_scat_len = num;
2176 req_schp->k_use_sg = k + 1;
2177 req_schp->sglist_len = rsv_schp->sglist_len;
2178 req_schp->buffer = rsv_schp->buffer;
2180 req_schp->bufflen = size;
2181 req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2187 if (k >= rsv_schp->k_use_sg)
2188 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
2192 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2194 Sg_scatter_hold *req_schp = &srp->data;
2195 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2197 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
2198 (int) req_schp->k_use_sg));
2199 if ((rsv_schp->k_use_sg > 0) && (req_schp->k_use_sg > 0)) {
2200 struct scatterlist *sg = rsv_schp->buffer;
2202 if (sfp->save_scat_len > 0)
2203 (sg + (req_schp->k_use_sg - 1))->length =
2204 (unsigned) sfp->save_scat_len;
2206 SCSI_LOG_TIMEOUT(1, printk ("sg_unlink_reserve: BAD save_scat_len\n"));
2208 req_schp->k_use_sg = 0;
2209 req_schp->bufflen = 0;
2210 req_schp->buffer = NULL;
2211 req_schp->sglist_len = 0;
2212 sfp->save_scat_len = 0;
2217 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2220 unsigned long iflags;
2222 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2223 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2224 /* look for requests that are ready + not SG_IO owned */
2225 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2226 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2227 resp->done = 2; /* guard against other readers */
2231 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2235 #ifdef CONFIG_SCSI_PROC_FS
2237 sg_get_nth_request(Sg_fd * sfp, int nth)
2240 unsigned long iflags;
2243 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2244 for (k = 0, resp = sfp->headrp; resp && (k < nth);
2245 ++k, resp = resp->nextrp) ;
2246 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2251 /* always adds to end of list */
2253 sg_add_request(Sg_fd * sfp)
2256 unsigned long iflags;
2258 Sg_request *rp = sfp->req_arr;
2260 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2263 memset(rp, 0, sizeof (Sg_request));
2268 if (0 == sfp->cmd_q)
2269 resp = NULL; /* command queuing disallowed */
2271 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2275 if (k < SG_MAX_QUEUE) {
2276 memset(rp, 0, sizeof (Sg_request));
2278 while (resp->nextrp)
2279 resp = resp->nextrp;
2287 resp->nextrp = NULL;
2288 resp->header.duration = jiffies_to_msecs(jiffies);
2290 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2294 /* Return of 1 for found; 0 for not found */
2296 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2298 Sg_request *prev_rp;
2300 unsigned long iflags;
2303 if ((!sfp) || (!srp) || (!sfp->headrp))
2305 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2306 prev_rp = sfp->headrp;
2307 if (srp == prev_rp) {
2308 sfp->headrp = prev_rp->nextrp;
2309 prev_rp->parentfp = NULL;
2312 while ((rp = prev_rp->nextrp)) {
2314 prev_rp->nextrp = rp->nextrp;
2315 rp->parentfp = NULL;
2322 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2326 #ifdef CONFIG_SCSI_PROC_FS
2328 sg_get_nth_sfp(Sg_device * sdp, int nth)
2331 unsigned long iflags;
2334 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2335 for (k = 0, resp = sdp->headfp; resp && (k < nth);
2336 ++k, resp = resp->nextfp) ;
2337 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2343 sg_add_sfp(Sg_device * sdp, int dev)
2346 unsigned long iflags;
2349 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2353 init_waitqueue_head(&sfp->read_wait);
2354 rwlock_init(&sfp->rq_list_lock);
2356 sfp->timeout = SG_DEFAULT_TIMEOUT;
2357 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2358 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2359 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2360 sdp->device->host->unchecked_isa_dma : 1;
2361 sfp->cmd_q = SG_DEF_COMMAND_Q;
2362 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2363 sfp->parentdp = sdp;
2364 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2367 else { /* add to tail of existing list */
2368 Sg_fd *pfp = sdp->headfp;
2373 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2374 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2375 if (unlikely(sg_big_buff != def_reserved_size))
2376 sg_big_buff = def_reserved_size;
2378 bufflen = min_t(int, sg_big_buff,
2379 sdp->device->request_queue->max_sectors * 512);
2380 sg_build_reserve(sfp, bufflen);
2381 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2382 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2387 __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2392 prev_fp = sdp->headfp;
2394 sdp->headfp = prev_fp->nextfp;
2396 while ((fp = prev_fp->nextfp)) {
2398 prev_fp->nextfp = fp->nextfp;
2404 if (sfp->reserve.bufflen > 0) {
2406 printk("__sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2407 (int) sfp->reserve.bufflen, (int) sfp->reserve.k_use_sg));
2408 sg_remove_scat(&sfp->reserve);
2410 sfp->parentdp = NULL;
2411 SCSI_LOG_TIMEOUT(6, printk("__sg_remove_sfp: sfp=0x%p\n", sfp));
2415 /* Returns 0 in normal case, 1 when detached and sdp object removed */
2417 sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2424 for (srp = sfp->headrp; srp; srp = tsrp) {
2426 if (sg_srp_done(srp, sfp))
2427 sg_finish_rem_req(srp);
2432 unsigned long iflags;
2434 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2435 __sg_remove_sfp(sdp, sfp);
2436 if (sdp->detached && (NULL == sdp->headfp)) {
2440 for (k = 0; k < maxd; ++k) {
2441 if (sdp == sg_dev_arr[k])
2445 sg_dev_arr[k] = NULL;
2446 kfree((char *) sdp);
2449 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2451 /* MOD_INC's to inhibit unloading sg and associated adapter driver */
2452 /* only bump the access_count if we actually succeeded in
2453 * throwing another counter on the host module */
2454 scsi_device_get(sdp->device); /* XXX: retval ignored? */
2455 sfp->closed = 1; /* flag dirty state on this fd */
2456 SCSI_LOG_TIMEOUT(1, printk("sg_remove_sfp: worrisome, %d writes pending\n",
2463 sg_res_in_use(Sg_fd * sfp)
2465 const Sg_request *srp;
2466 unsigned long iflags;
2468 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2469 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2472 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2476 /* The size fetched (value output via retSzp) set when non-NULL return */
2477 static struct page *
2478 sg_page_malloc(int rqSz, int lowDma, int *retSzp)
2480 struct page *resp = NULL;
2485 if ((rqSz <= 0) || (NULL == retSzp))
2489 page_mask = GFP_ATOMIC | GFP_DMA | __GFP_COMP | __GFP_NOWARN;
2491 page_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
2493 for (order = 0, a_size = PAGE_SIZE; a_size < rqSz;
2494 order++, a_size <<= 1) ;
2495 resSz = a_size; /* rounded up if necessary */
2496 resp = alloc_pages(page_mask, order);
2497 while ((!resp) && order) {
2499 a_size >>= 1; /* divide by 2, until PAGE_SIZE */
2500 resp = alloc_pages(page_mask, order); /* try half */
2504 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2505 memset(page_address(resp), 0, resSz);
2512 sg_page_free(struct page *page, int size)
2518 for (order = 0, a_size = PAGE_SIZE; a_size < size;
2519 order++, a_size <<= 1) ;
2520 __free_pages(page, order);
2523 #ifndef MAINTENANCE_IN_CMD
2524 #define MAINTENANCE_IN_CMD 0xa3
2527 static unsigned char allow_ops[] = { TEST_UNIT_READY, REQUEST_SENSE,
2528 INQUIRY, READ_CAPACITY, READ_BUFFER, READ_6, READ_10, READ_12,
2529 READ_16, MODE_SENSE, MODE_SENSE_10, LOG_SENSE, REPORT_LUNS,
2530 SERVICE_ACTION_IN, RECEIVE_DIAGNOSTIC, READ_LONG, MAINTENANCE_IN_CMD
2534 sg_allow_access(unsigned char opcode, char dev_type)
2538 if (TYPE_SCANNER == dev_type) /* TYPE_ROM maybe burner */
2540 for (k = 0; k < sizeof (allow_ops); ++k) {
2541 if (opcode == allow_ops[k])
2547 #ifdef CONFIG_SCSI_PROC_FS
2552 unsigned long iflags;
2554 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2555 for (k = sg_dev_max - 1; k >= 0; --k)
2556 if (sg_dev_arr[k] && sg_dev_arr[k]->device)
2558 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2559 return k + 1; /* origin 1 */
2566 Sg_device *sdp = NULL;
2567 unsigned long iflags;
2569 if (sg_dev_arr && (dev >= 0)) {
2570 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2571 if (dev < sg_dev_max)
2572 sdp = sg_dev_arr[dev];
2573 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2578 #ifdef CONFIG_SCSI_PROC_FS
2580 static struct proc_dir_entry *sg_proc_sgp = NULL;
2582 static char sg_proc_sg_dirname[] = "scsi/sg";
2584 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2586 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2587 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2588 size_t count, loff_t *off);
2589 static struct file_operations adio_fops = {
2590 /* .owner, .read and .llseek added in sg_proc_init() */
2591 .open = sg_proc_single_open_adio,
2592 .write = sg_proc_write_adio,
2593 .release = single_release,
2596 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2597 static ssize_t sg_proc_write_dressz(struct file *filp,
2598 const char __user *buffer, size_t count, loff_t *off);
2599 static struct file_operations dressz_fops = {
2600 .open = sg_proc_single_open_dressz,
2601 .write = sg_proc_write_dressz,
2602 .release = single_release,
2605 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2606 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2607 static struct file_operations version_fops = {
2608 .open = sg_proc_single_open_version,
2609 .release = single_release,
2612 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2613 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2614 static struct file_operations devhdr_fops = {
2615 .open = sg_proc_single_open_devhdr,
2616 .release = single_release,
2619 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2620 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2621 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2622 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2623 static void dev_seq_stop(struct seq_file *s, void *v);
2624 static struct file_operations dev_fops = {
2625 .open = sg_proc_open_dev,
2626 .release = seq_release,
2628 static struct seq_operations dev_seq_ops = {
2629 .start = dev_seq_start,
2630 .next = dev_seq_next,
2631 .stop = dev_seq_stop,
2632 .show = sg_proc_seq_show_dev,
2635 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2636 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2637 static struct file_operations devstrs_fops = {
2638 .open = sg_proc_open_devstrs,
2639 .release = seq_release,
2641 static struct seq_operations devstrs_seq_ops = {
2642 .start = dev_seq_start,
2643 .next = dev_seq_next,
2644 .stop = dev_seq_stop,
2645 .show = sg_proc_seq_show_devstrs,
2648 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2649 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2650 static struct file_operations debug_fops = {
2651 .open = sg_proc_open_debug,
2652 .release = seq_release,
2654 static struct seq_operations debug_seq_ops = {
2655 .start = dev_seq_start,
2656 .next = dev_seq_next,
2657 .stop = dev_seq_stop,
2658 .show = sg_proc_seq_show_debug,
2662 struct sg_proc_leaf {
2664 struct file_operations * fops;
2667 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2668 {"allow_dio", &adio_fops},
2669 {"debug", &debug_fops},
2670 {"def_reserved_size", &dressz_fops},
2671 {"device_hdr", &devhdr_fops},
2672 {"devices", &dev_fops},
2673 {"device_strs", &devstrs_fops},
2674 {"version", &version_fops}
2681 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2682 struct proc_dir_entry *pdep;
2683 struct sg_proc_leaf * leaf;
2685 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2688 for (k = 0; k < num_leaves; ++k) {
2689 leaf = &sg_proc_leaf_arr[k];
2690 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2691 pdep = create_proc_entry(leaf->name, mask, sg_proc_sgp);
2693 leaf->fops->owner = THIS_MODULE,
2694 leaf->fops->read = seq_read,
2695 leaf->fops->llseek = seq_lseek,
2696 pdep->proc_fops = leaf->fops;
2703 sg_proc_cleanup(void)
2706 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2710 for (k = 0; k < num_leaves; ++k)
2711 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2712 remove_proc_entry(sg_proc_sg_dirname, NULL);
2716 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2718 seq_printf(s, "%d\n", *((int *)s->private));
2722 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2724 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2728 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2729 size_t count, loff_t *off)
2734 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2736 num = (count < 10) ? count : 10;
2737 if (copy_from_user(buff, buffer, num))
2740 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2744 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2746 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2750 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2751 size_t count, loff_t *off)
2754 unsigned long k = ULONG_MAX;
2757 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2759 num = (count < 10) ? count : 10;
2760 if (copy_from_user(buff, buffer, num))
2763 k = simple_strtoul(buff, NULL, 10);
2764 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2771 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2773 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2778 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2780 return single_open(file, sg_proc_seq_show_version, NULL);
2783 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2785 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2790 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2792 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2795 struct sg_proc_deviter {
2800 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2802 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2808 if (NULL == sg_dev_arr)
2811 it->max = sg_last_dev();
2812 if (it->index >= it->max)
2817 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2819 struct sg_proc_deviter * it = s->private;
2822 return (it->index < it->max) ? it : NULL;
2825 static void dev_seq_stop(struct seq_file *s, void *v)
2830 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2832 return seq_open(file, &dev_seq_ops);
2835 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2837 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2839 struct scsi_device *scsidp;
2841 sdp = it ? sg_get_dev(it->index) : NULL;
2842 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2843 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2844 scsidp->host->host_no, scsidp->channel,
2845 scsidp->id, scsidp->lun, (int) scsidp->type,
2847 (int) scsidp->queue_depth,
2848 (int) scsidp->device_busy,
2849 (int) scsi_device_online(scsidp));
2851 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2855 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2857 return seq_open(file, &devstrs_seq_ops);
2860 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2862 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2864 struct scsi_device *scsidp;
2866 sdp = it ? sg_get_dev(it->index) : NULL;
2867 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2868 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2869 scsidp->vendor, scsidp->model, scsidp->rev);
2871 seq_printf(s, "<no active device>\n");
2875 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2877 int k, m, new_interface, blen, usg;
2880 const sg_io_hdr_t *hp;
2884 for (k = 0; (fp = sg_get_nth_sfp(sdp, k)); ++k) {
2885 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2886 "(res)sgat=%d low_dma=%d\n", k + 1,
2887 jiffies_to_msecs(fp->timeout),
2888 fp->reserve.bufflen,
2889 (int) fp->reserve.k_use_sg,
2891 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2892 (int) fp->cmd_q, (int) fp->force_packid,
2893 (int) fp->keep_orphan, (int) fp->closed);
2894 for (m = 0; (srp = sg_get_nth_request(fp, m)); ++m) {
2896 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2897 if (srp->res_used) {
2898 if (new_interface &&
2899 (SG_FLAG_MMAP_IO & hp->flags))
2904 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2910 blen = srp->data.bufflen;
2911 usg = srp->data.k_use_sg;
2912 seq_printf(s, srp->done ?
2913 ((1 == srp->done) ? "rcv:" : "fin:")
2915 seq_printf(s, " id=%d blen=%d",
2916 srp->header.pack_id, blen);
2918 seq_printf(s, " dur=%d", hp->duration);
2920 ms = jiffies_to_msecs(jiffies);
2921 seq_printf(s, " t_o/elap=%d/%d",
2922 (new_interface ? hp->timeout :
2923 jiffies_to_msecs(fp->timeout)),
2924 (ms > hp->duration ? ms - hp->duration : 0));
2926 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2927 (int) srp->data.cmd_opcode);
2930 seq_printf(s, " No requests active\n");
2934 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2936 return seq_open(file, &debug_seq_ops);
2939 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2941 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2944 if (it && (0 == it->index)) {
2945 seq_printf(s, "dev_max(currently)=%d max_active_device=%d "
2946 "(origin 1)\n", sg_dev_max, (int)it->max);
2947 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2949 sdp = it ? sg_get_dev(it->index) : NULL;
2951 struct scsi_device *scsidp = sdp->device;
2953 if (NULL == scsidp) {
2954 seq_printf(s, "device %d detached ??\n",
2959 if (sg_get_nth_sfp(sdp, 0)) {
2960 seq_printf(s, " >>> device=%s ",
2961 sdp->disk->disk_name);
2963 seq_printf(s, "detached pending close ");
2966 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2967 scsidp->host->host_no,
2968 scsidp->channel, scsidp->id,
2970 scsidp->host->hostt->emulated);
2971 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2972 sdp->sg_tablesize, sdp->exclude);
2974 sg_proc_debug_helper(s, sdp);
2979 #endif /* CONFIG_SCSI_PROC_FS */
2981 module_init(init_sg);
2982 module_exit(exit_sg);