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 = 30533; /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.33"
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/smp_lock.h>
45 #include <linux/moduleparam.h>
46 #include <linux/cdev.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 = "20050908";
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 #define SG_SECTOR_SZ 512
98 #define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
100 #define SG_DEV_ARR_LUMP 32 /* amount to over allocate sg_dev_arr by */
102 static int sg_add(struct class_device *, struct class_interface *);
103 static void sg_remove(struct class_device *, struct class_interface *);
105 static DEFINE_RWLOCK(sg_dev_arr_lock); /* Also used to lock
106 file descriptor list for device */
108 static struct class_interface sg_interface = {
113 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
114 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
115 unsigned short sglist_len; /* size of malloc'd scatter-gather list ++ */
116 unsigned bufflen; /* Size of (aggregate) data buffer */
117 unsigned b_malloc_len; /* actual len malloc'ed in buffer */
118 struct scatterlist *buffer;/* scatter list */
119 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
120 unsigned char cmd_opcode; /* first byte of command */
123 struct sg_device; /* forward declarations */
126 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
127 struct sg_request *nextrp; /* NULL -> tail request (slist) */
128 struct sg_fd *parentfp; /* NULL -> not in use */
129 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
130 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
131 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
132 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
133 char orphan; /* 1 -> drop on sight, 0 -> normal */
134 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
135 volatile char done; /* 0->before bh, 1->before read, 2->read */
138 typedef struct sg_fd { /* holds the state of a file descriptor */
139 struct sg_fd *nextfp; /* NULL when last opened fd on this device */
140 struct sg_device *parentdp; /* owning device */
141 wait_queue_head_t read_wait; /* queue read until command done */
142 rwlock_t rq_list_lock; /* protect access to list in req_arr */
143 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
144 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
145 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
146 unsigned save_scat_len; /* original length of trunc. scat. element */
147 Sg_request *headrp; /* head of request slist, NULL->empty */
148 struct fasync_struct *async_qp; /* used by asynchronous notification */
149 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
150 char low_dma; /* as in parent but possibly overridden to 1 */
151 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
152 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
153 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
154 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
155 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
156 char mmap_called; /* 0 -> mmap() never called on this fd */
159 typedef struct sg_device { /* holds the state of each scsi generic device */
160 struct scsi_device *device;
161 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
162 int sg_tablesize; /* adapter's max scatter-gather table size */
163 Sg_fd *headfp; /* first open fd belonging to this device */
164 volatile char detached; /* 0->attached, 1->detached pending removal */
165 volatile char exclude; /* opened for exclusive access */
166 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
167 struct gendisk *disk;
168 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
171 static int sg_fasync(int fd, struct file *filp, int mode);
172 /* tasklet or soft irq callback */
173 static void sg_cmd_done(void *data, char *sense, int result, int resid);
174 static int sg_start_req(Sg_request * srp);
175 static void sg_finish_rem_req(Sg_request * srp);
176 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
177 static int sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp,
179 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
181 static ssize_t sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
182 int blocking, int read_only, Sg_request ** o_srp);
183 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
184 unsigned char *cmnd, int timeout, int blocking);
185 static int sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
186 int wr_xf, int *countp, unsigned char __user **up);
187 static int sg_write_xfer(Sg_request * srp);
188 static int sg_read_xfer(Sg_request * srp);
189 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
190 static void sg_remove_scat(Sg_scatter_hold * schp);
191 static void sg_build_reserve(Sg_fd * sfp, int req_size);
192 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
193 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
194 static struct page *sg_page_malloc(int rqSz, int lowDma, int *retSzp);
195 static void sg_page_free(struct page *page, int size);
196 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
197 static int sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
198 static void __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
199 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
200 static Sg_request *sg_add_request(Sg_fd * sfp);
201 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
202 static int sg_res_in_use(Sg_fd * sfp);
203 static int sg_allow_access(unsigned char opcode, char dev_type);
204 static int sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len);
205 static Sg_device *sg_get_dev(int dev);
206 #ifdef CONFIG_SCSI_PROC_FS
207 static int sg_last_dev(void);
210 static Sg_device **sg_dev_arr = NULL;
211 static int sg_dev_max;
212 static int sg_nr_dev;
214 #define SZ_SG_HEADER sizeof(struct sg_header)
215 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
216 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
217 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
220 sg_open(struct inode *inode, struct file *filp)
222 int dev = iminor(inode);
223 int flags = filp->f_flags;
224 struct request_queue *q;
230 nonseekable_open(inode, filp);
231 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
232 sdp = sg_get_dev(dev);
233 if ((!sdp) || (!sdp->device))
238 /* This driver's module count bumped by fops_get in <linux/fs.h> */
239 /* Prevent the device driver from vanishing while we sleep */
240 retval = scsi_device_get(sdp->device);
244 if (!((flags & O_NONBLOCK) ||
245 scsi_block_when_processing_errors(sdp->device))) {
247 /* we are in error recovery for this device */
251 if (flags & O_EXCL) {
252 if (O_RDONLY == (flags & O_ACCMODE)) {
253 retval = -EPERM; /* Can't lock it with read only access */
256 if (sdp->headfp && (flags & O_NONBLOCK)) {
261 __wait_event_interruptible(sdp->o_excl_wait,
262 ((sdp->headfp || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
264 retval = res; /* -ERESTARTSYS because signal hit process */
267 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
268 if (flags & O_NONBLOCK) {
273 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
276 retval = res; /* -ERESTARTSYS because signal hit process */
284 if (!sdp->headfp) { /* no existing opens on this device */
286 q = sdp->device->request_queue;
287 sdp->sg_tablesize = min(q->max_hw_segments,
288 q->max_phys_segments);
290 if ((sfp = sg_add_sfp(sdp, dev)))
291 filp->private_data = sfp;
294 sdp->exclude = 0; /* undo if error */
301 scsi_device_put(sdp->device);
305 /* Following function was formerly called 'sg_close' */
307 sg_release(struct inode *inode, struct file *filp)
312 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
314 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
315 sg_fasync(-1, filp, 0); /* remove filp from async notification list */
316 if (0 == sg_remove_sfp(sdp, sfp)) { /* Returns 1 when sdp gone */
317 if (!sdp->detached) {
318 scsi_device_put(sdp->device);
321 wake_up_interruptible(&sdp->o_excl_wait);
327 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
332 int req_pack_id = -1;
334 struct sg_header *old_hdr = NULL;
337 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
339 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
340 sdp->disk->disk_name, (int) count));
342 if (!access_ok(VERIFY_WRITE, buf, count))
344 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
345 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
348 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
352 if (old_hdr->reply_len < 0) {
353 if (count >= SZ_SG_IO_HDR) {
354 sg_io_hdr_t *new_hdr;
355 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
360 retval =__copy_from_user
361 (new_hdr, buf, SZ_SG_IO_HDR);
362 req_pack_id = new_hdr->pack_id;
370 req_pack_id = old_hdr->pack_id;
372 srp = sg_get_rq_mark(sfp, req_pack_id);
373 if (!srp) { /* now wait on packet to arrive */
378 if (filp->f_flags & O_NONBLOCK) {
383 retval = 0; /* following macro beats race condition */
384 __wait_event_interruptible(sfp->read_wait,
386 (srp = sg_get_rq_mark(sfp, req_pack_id))),
395 /* -ERESTARTSYS as signal hit process */
399 if (srp->header.interface_id != '\0') {
400 retval = sg_new_read(sfp, buf, count, srp);
405 if (old_hdr == NULL) {
406 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
412 memset(old_hdr, 0, SZ_SG_HEADER);
413 old_hdr->reply_len = (int) hp->timeout;
414 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
415 old_hdr->pack_id = hp->pack_id;
416 old_hdr->twelve_byte =
417 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
418 old_hdr->target_status = hp->masked_status;
419 old_hdr->host_status = hp->host_status;
420 old_hdr->driver_status = hp->driver_status;
421 if ((CHECK_CONDITION & hp->masked_status) ||
422 (DRIVER_SENSE & hp->driver_status))
423 memcpy(old_hdr->sense_buffer, srp->sense_b,
424 sizeof (old_hdr->sense_buffer));
425 switch (hp->host_status) {
426 /* This setup of 'result' is for backward compatibility and is best
427 ignored by the user who should use target, host + driver status */
429 case DID_PASSTHROUGH:
436 old_hdr->result = EBUSY;
443 old_hdr->result = EIO;
446 old_hdr->result = (srp->sense_b[0] == 0 &&
447 hp->masked_status == GOOD) ? 0 : EIO;
450 old_hdr->result = EIO;
454 /* Now copy the result back to the user buffer. */
455 if (count >= SZ_SG_HEADER) {
456 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
461 if (count > old_hdr->reply_len)
462 count = old_hdr->reply_len;
463 if (count > SZ_SG_HEADER) {
464 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
470 count = (old_hdr->result == 0) ? 0 : -EIO;
471 sg_finish_rem_req(srp);
479 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
481 sg_io_hdr_t *hp = &srp->header;
485 if (count < SZ_SG_IO_HDR) {
490 if ((hp->mx_sb_len > 0) && hp->sbp) {
491 if ((CHECK_CONDITION & hp->masked_status) ||
492 (DRIVER_SENSE & hp->driver_status)) {
493 int sb_len = SCSI_SENSE_BUFFERSIZE;
494 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
495 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
496 len = (len > sb_len) ? sb_len : len;
497 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
504 if (hp->masked_status || hp->host_status || hp->driver_status)
505 hp->info |= SG_INFO_CHECK;
506 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
510 err = sg_read_xfer(srp);
512 sg_finish_rem_req(srp);
513 return (0 == err) ? count : err;
517 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
519 int mxsize, cmd_size, k;
520 int input_size, blocking;
521 unsigned char opcode;
525 struct sg_header old_hdr;
527 unsigned char cmnd[MAX_COMMAND_SIZE];
529 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
531 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
532 sdp->disk->disk_name, (int) count));
535 if (!((filp->f_flags & O_NONBLOCK) ||
536 scsi_block_when_processing_errors(sdp->device)))
539 if (!access_ok(VERIFY_READ, buf, count))
540 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
541 if (count < SZ_SG_HEADER)
543 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
545 blocking = !(filp->f_flags & O_NONBLOCK);
546 if (old_hdr.reply_len < 0)
547 return sg_new_write(sfp, buf, count, blocking, 0, NULL);
548 if (count < (SZ_SG_HEADER + 6))
549 return -EIO; /* The minimum scsi command length is 6 bytes. */
551 if (!(srp = sg_add_request(sfp))) {
552 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
556 __get_user(opcode, buf);
557 if (sfp->next_cmd_len > 0) {
558 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
559 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
560 sfp->next_cmd_len = 0;
561 sg_remove_request(sfp, srp);
564 cmd_size = sfp->next_cmd_len;
565 sfp->next_cmd_len = 0; /* reset so only this write() effected */
567 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
568 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
571 SCSI_LOG_TIMEOUT(4, printk(
572 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
573 /* Determine buffer size. */
574 input_size = count - cmd_size;
575 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
576 mxsize -= SZ_SG_HEADER;
577 input_size -= SZ_SG_HEADER;
578 if (input_size < 0) {
579 sg_remove_request(sfp, srp);
580 return -EIO; /* User did not pass enough bytes for this command. */
583 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
584 hp->cmd_len = (unsigned char) cmd_size;
588 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
589 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
591 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
592 hp->dxfer_len = mxsize;
593 hp->dxferp = (char __user *)buf + cmd_size;
595 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
596 hp->flags = input_size; /* structure abuse ... */
597 hp->pack_id = old_hdr.pack_id;
599 if (__copy_from_user(cmnd, buf, cmd_size))
602 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
603 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
604 * is a non-zero input_size, so emit a warning.
606 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV)
607 if (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 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
616 return (k < 0) ? k : count;
620 sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
621 int blocking, int read_only, Sg_request ** o_srp)
626 unsigned char cmnd[MAX_COMMAND_SIZE];
628 unsigned long ul_timeout;
630 if (count < SZ_SG_IO_HDR)
632 if (!access_ok(VERIFY_READ, buf, count))
633 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
635 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
636 if (!(srp = sg_add_request(sfp))) {
637 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
641 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
642 sg_remove_request(sfp, srp);
645 if (hp->interface_id != 'S') {
646 sg_remove_request(sfp, srp);
649 if (hp->flags & SG_FLAG_MMAP_IO) {
650 if (hp->dxfer_len > sfp->reserve.bufflen) {
651 sg_remove_request(sfp, srp);
652 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
654 if (hp->flags & SG_FLAG_DIRECT_IO) {
655 sg_remove_request(sfp, srp);
656 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
658 if (sg_res_in_use(sfp)) {
659 sg_remove_request(sfp, srp);
660 return -EBUSY; /* reserve buffer already being used */
663 ul_timeout = msecs_to_jiffies(srp->header.timeout);
664 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
665 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
666 sg_remove_request(sfp, srp);
669 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
670 sg_remove_request(sfp, srp);
671 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
673 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
674 sg_remove_request(sfp, srp);
678 (!sg_allow_access(cmnd[0], sfp->parentdp->device->type))) {
679 sg_remove_request(sfp, srp);
682 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
691 sg_common_write(Sg_fd * sfp, Sg_request * srp,
692 unsigned char *cmnd, int timeout, int blocking)
695 Sg_device *sdp = sfp->parentdp;
696 sg_io_hdr_t *hp = &srp->header;
698 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
700 hp->masked_status = 0;
704 hp->driver_status = 0;
706 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
707 (int) cmnd[0], (int) hp->cmd_len));
709 if ((k = sg_start_req(srp))) {
710 SCSI_LOG_TIMEOUT(1, printk("sg_write: start_req err=%d\n", k));
711 sg_finish_rem_req(srp);
712 return k; /* probably out of space --> ENOMEM */
714 if ((k = sg_write_xfer(srp))) {
715 SCSI_LOG_TIMEOUT(1, printk("sg_write: write_xfer, bad address\n"));
716 sg_finish_rem_req(srp);
720 sg_finish_rem_req(srp);
724 switch (hp->dxfer_direction) {
725 case SG_DXFER_TO_FROM_DEV:
726 case SG_DXFER_FROM_DEV:
727 data_dir = DMA_FROM_DEVICE;
729 case SG_DXFER_TO_DEV:
730 data_dir = DMA_TO_DEVICE;
732 case SG_DXFER_UNKNOWN:
733 data_dir = DMA_BIDIRECTIONAL;
739 hp->duration = jiffies_to_msecs(jiffies);
740 /* Now send everything of to mid-level. The next time we hear about this
741 packet is when sg_cmd_done() is called (i.e. a callback). */
742 if (scsi_execute_async(sdp->device, cmnd, hp->cmd_len, data_dir, srp->data.buffer,
743 hp->dxfer_len, srp->data.k_use_sg, timeout,
744 SG_DEFAULT_RETRIES, srp, sg_cmd_done,
746 SCSI_LOG_TIMEOUT(1, printk("sg_write: scsi_execute_async failed\n"));
748 * most likely out of mem, but could also be a bad map
750 sg_finish_rem_req(srp);
757 sg_srp_done(Sg_request *srp, Sg_fd *sfp)
759 unsigned long iflags;
762 read_lock_irqsave(&sfp->rq_list_lock, iflags);
764 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
769 sg_ioctl(struct inode *inode, struct file *filp,
770 unsigned int cmd_in, unsigned long arg)
772 void __user *p = (void __user *)arg;
774 int result, val, read_only;
778 unsigned long iflags;
780 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
782 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
783 sdp->disk->disk_name, (int) cmd_in));
784 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
789 int blocking = 1; /* ignore O_NONBLOCK flag */
793 if (!scsi_block_when_processing_errors(sdp->device))
795 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
798 sg_new_write(sfp, p, SZ_SG_IO_HDR,
799 blocking, read_only, &srp);
802 srp->sg_io_owned = 1;
804 result = 0; /* following macro to beat race condition */
805 __wait_event_interruptible(sfp->read_wait,
806 (sdp->detached || sfp->closed || sg_srp_done(srp, sfp)),
811 return 0; /* request packet dropped already */
815 return result; /* -ERESTARTSYS because signal hit process */
817 write_lock_irqsave(&sfp->rq_list_lock, iflags);
819 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
820 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
821 return (result < 0) ? result : 0;
824 result = get_user(val, ip);
829 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
830 val = MULDIV (INT_MAX, USER_HZ, HZ);
831 sfp->timeout_user = val;
832 sfp->timeout = MULDIV (val, HZ, USER_HZ);
835 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
836 /* strange ..., for backward compatibility */
837 return sfp->timeout_user;
838 case SG_SET_FORCE_LOW_DMA:
839 result = get_user(val, ip);
844 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
845 val = (int) sfp->reserve.bufflen;
846 sg_remove_scat(&sfp->reserve);
847 sg_build_reserve(sfp, val);
852 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
856 return put_user((int) sfp->low_dma, ip);
858 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
861 sg_scsi_id_t __user *sg_idp = p;
865 __put_user((int) sdp->device->host->host_no,
867 __put_user((int) sdp->device->channel,
869 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
870 __put_user((int) sdp->device->lun, &sg_idp->lun);
871 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
872 __put_user((short) sdp->device->host->cmd_per_lun,
873 &sg_idp->h_cmd_per_lun);
874 __put_user((short) sdp->device->queue_depth,
875 &sg_idp->d_queue_depth);
876 __put_user(0, &sg_idp->unused[0]);
877 __put_user(0, &sg_idp->unused[1]);
880 case SG_SET_FORCE_PACK_ID:
881 result = get_user(val, ip);
884 sfp->force_packid = val ? 1 : 0;
887 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
889 read_lock_irqsave(&sfp->rq_list_lock, iflags);
890 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
891 if ((1 == srp->done) && (!srp->sg_io_owned)) {
892 read_unlock_irqrestore(&sfp->rq_list_lock,
894 __put_user(srp->header.pack_id, ip);
898 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
901 case SG_GET_NUM_WAITING:
902 read_lock_irqsave(&sfp->rq_list_lock, iflags);
903 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
904 if ((1 == srp->done) && (!srp->sg_io_owned))
907 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
908 return put_user(val, ip);
909 case SG_GET_SG_TABLESIZE:
910 return put_user(sdp->sg_tablesize, ip);
911 case SG_SET_RESERVED_SIZE:
912 result = get_user(val, ip);
917 if (val != sfp->reserve.bufflen) {
918 if (sg_res_in_use(sfp) || sfp->mmap_called)
920 sg_remove_scat(&sfp->reserve);
921 sg_build_reserve(sfp, val);
924 case SG_GET_RESERVED_SIZE:
925 val = (int) sfp->reserve.bufflen;
926 return put_user(val, ip);
927 case SG_SET_COMMAND_Q:
928 result = get_user(val, ip);
931 sfp->cmd_q = val ? 1 : 0;
933 case SG_GET_COMMAND_Q:
934 return put_user((int) sfp->cmd_q, ip);
935 case SG_SET_KEEP_ORPHAN:
936 result = get_user(val, ip);
939 sfp->keep_orphan = val;
941 case SG_GET_KEEP_ORPHAN:
942 return put_user((int) sfp->keep_orphan, ip);
943 case SG_NEXT_CMD_LEN:
944 result = get_user(val, ip);
947 sfp->next_cmd_len = (val > 0) ? val : 0;
949 case SG_GET_VERSION_NUM:
950 return put_user(sg_version_num, ip);
951 case SG_GET_ACCESS_COUNT:
952 /* faked - we don't have a real access count anymore */
953 val = (sdp->device ? 1 : 0);
954 return put_user(val, ip);
955 case SG_GET_REQUEST_TABLE:
956 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
959 sg_req_info_t *rinfo;
962 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
966 read_lock_irqsave(&sfp->rq_list_lock, iflags);
967 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
968 ++val, srp = srp ? srp->nextrp : srp) {
969 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
971 rinfo[val].req_state = srp->done + 1;
973 srp->header.masked_status &
974 srp->header.host_status &
975 srp->header.driver_status;
977 rinfo[val].duration =
978 srp->header.duration;
980 ms = jiffies_to_msecs(jiffies);
981 rinfo[val].duration =
982 (ms > srp->header.duration) ?
983 (ms - srp->header.duration) : 0;
985 rinfo[val].orphan = srp->orphan;
986 rinfo[val].sg_io_owned =
994 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
995 result = __copy_to_user(p, rinfo,
996 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
997 result = result ? -EFAULT : 0;
1001 case SG_EMULATED_HOST:
1004 return put_user(sdp->device->host->hostt->emulated, ip);
1008 if (filp->f_flags & O_NONBLOCK) {
1009 if (scsi_host_in_recovery(sdp->device->host))
1011 } else if (!scsi_block_when_processing_errors(sdp->device))
1013 result = get_user(val, ip);
1016 if (SG_SCSI_RESET_NOTHING == val)
1019 case SG_SCSI_RESET_DEVICE:
1020 val = SCSI_TRY_RESET_DEVICE;
1022 case SG_SCSI_RESET_BUS:
1023 val = SCSI_TRY_RESET_BUS;
1025 case SG_SCSI_RESET_HOST:
1026 val = SCSI_TRY_RESET_HOST;
1031 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1033 return (scsi_reset_provider(sdp->device, val) ==
1034 SUCCESS) ? 0 : -EIO;
1035 case SCSI_IOCTL_SEND_COMMAND:
1039 unsigned char opcode = WRITE_6;
1040 Scsi_Ioctl_Command __user *siocp = p;
1042 if (copy_from_user(&opcode, siocp->data, 1))
1044 if (!sg_allow_access(opcode, sdp->device->type))
1047 return sg_scsi_ioctl(filp, sdp->device->request_queue, NULL, p);
1049 result = get_user(val, ip);
1052 sdp->sgdebug = (char) val;
1054 case SCSI_IOCTL_GET_IDLUN:
1055 case SCSI_IOCTL_GET_BUS_NUMBER:
1056 case SCSI_IOCTL_PROBE_HOST:
1057 case SG_GET_TRANSFORM:
1060 return scsi_ioctl(sdp->device, cmd_in, p);
1063 return -EPERM; /* don't know so take safe approach */
1064 return scsi_ioctl(sdp->device, cmd_in, p);
1068 #ifdef CONFIG_COMPAT
1069 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1073 struct scsi_device *sdev;
1075 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1079 if (sdev->host->hostt->compat_ioctl) {
1082 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1087 return -ENOIOCTLCMD;
1092 sg_poll(struct file *filp, poll_table * wait)
1094 unsigned int res = 0;
1099 unsigned long iflags;
1101 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1104 poll_wait(filp, &sfp->read_wait, wait);
1105 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1106 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1107 /* if any read waiting, flag it */
1108 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1109 res = POLLIN | POLLRDNORM;
1112 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1116 else if (!sfp->cmd_q) {
1118 res |= POLLOUT | POLLWRNORM;
1119 } else if (count < SG_MAX_QUEUE)
1120 res |= POLLOUT | POLLWRNORM;
1121 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1122 sdp->disk->disk_name, (int) res));
1127 sg_fasync(int fd, struct file *filp, int mode)
1133 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1135 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1136 sdp->disk->disk_name, mode));
1138 retval = fasync_helper(fd, filp, mode, &sfp->async_qp);
1139 return (retval < 0) ? retval : 0;
1142 static struct page *
1143 sg_vma_nopage(struct vm_area_struct *vma, unsigned long addr, int *type)
1146 struct page *page = NOPAGE_SIGBUS;
1147 unsigned long offset, len, sa;
1148 Sg_scatter_hold *rsv_schp;
1149 struct scatterlist *sg;
1152 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1154 rsv_schp = &sfp->reserve;
1155 offset = addr - vma->vm_start;
1156 if (offset >= rsv_schp->bufflen)
1158 SCSI_LOG_TIMEOUT(3, printk("sg_vma_nopage: offset=%lu, scatg=%d\n",
1159 offset, rsv_schp->k_use_sg));
1160 sg = rsv_schp->buffer;
1162 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1164 len = vma->vm_end - sa;
1165 len = (len < sg->length) ? len : sg->length;
1168 get_page(page); /* increment page count */
1176 *type = VM_FAULT_MINOR;
1180 static struct vm_operations_struct sg_mmap_vm_ops = {
1181 .nopage = sg_vma_nopage,
1185 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1188 unsigned long req_sz, len, sa;
1189 Sg_scatter_hold *rsv_schp;
1191 struct scatterlist *sg;
1193 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1195 req_sz = vma->vm_end - vma->vm_start;
1196 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1197 (void *) vma->vm_start, (int) req_sz));
1199 return -EINVAL; /* want no offset */
1200 rsv_schp = &sfp->reserve;
1201 if (req_sz > rsv_schp->bufflen)
1202 return -ENOMEM; /* cannot map more than reserved buffer */
1205 sg = rsv_schp->buffer;
1206 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1208 len = vma->vm_end - sa;
1209 len = (len < sg->length) ? len : sg->length;
1213 sfp->mmap_called = 1;
1214 vma->vm_flags |= VM_RESERVED;
1215 vma->vm_private_data = sfp;
1216 vma->vm_ops = &sg_mmap_vm_ops;
1220 /* This function is a "bottom half" handler that is called by the
1221 * mid level when a command is completed (or has failed). */
1223 sg_cmd_done(void *data, char *sense, int result, int resid)
1225 Sg_request *srp = data;
1226 Sg_device *sdp = NULL;
1228 unsigned long iflags;
1232 printk(KERN_ERR "sg_cmd_done: NULL request\n");
1235 sfp = srp->parentfp;
1237 sdp = sfp->parentdp;
1238 if ((NULL == sdp) || sdp->detached) {
1239 printk(KERN_INFO "sg_cmd_done: device detached\n");
1244 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1245 sdp->disk->disk_name, srp->header.pack_id, result));
1246 srp->header.resid = resid;
1247 ms = jiffies_to_msecs(jiffies);
1248 srp->header.duration = (ms > srp->header.duration) ?
1249 (ms - srp->header.duration) : 0;
1251 struct scsi_sense_hdr sshdr;
1253 memcpy(srp->sense_b, sense, sizeof (srp->sense_b));
1254 srp->header.status = 0xff & result;
1255 srp->header.masked_status = status_byte(result);
1256 srp->header.msg_status = msg_byte(result);
1257 srp->header.host_status = host_byte(result);
1258 srp->header.driver_status = driver_byte(result);
1259 if ((sdp->sgdebug > 0) &&
1260 ((CHECK_CONDITION == srp->header.masked_status) ||
1261 (COMMAND_TERMINATED == srp->header.masked_status)))
1262 __scsi_print_sense("sg_cmd_done", sense,
1263 SCSI_SENSE_BUFFERSIZE);
1265 /* Following if statement is a patch supplied by Eric Youngdale */
1266 if (driver_byte(result) != 0
1267 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1268 && !scsi_sense_is_deferred(&sshdr)
1269 && sshdr.sense_key == UNIT_ATTENTION
1270 && sdp->device->removable) {
1271 /* Detected possible disc change. Set the bit - this */
1272 /* may be used if there are filesystems using this device */
1273 sdp->device->changed = 1;
1276 /* Rely on write phase to clean out srp status values, so no "else" */
1278 if (sfp->closed) { /* whoops this fd already released, cleanup */
1279 SCSI_LOG_TIMEOUT(1, printk("sg_cmd_done: already closed, freeing ...\n"));
1280 sg_finish_rem_req(srp);
1282 if (NULL == sfp->headrp) {
1283 SCSI_LOG_TIMEOUT(1, printk("sg...bh: already closed, final cleanup\n"));
1284 if (0 == sg_remove_sfp(sdp, sfp)) { /* device still present */
1285 scsi_device_put(sdp->device);
1289 } else if (srp && srp->orphan) {
1290 if (sfp->keep_orphan)
1291 srp->sg_io_owned = 0;
1293 sg_finish_rem_req(srp);
1298 /* Now wake up any sg_read() that is waiting for this packet. */
1299 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1300 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1302 wake_up_interruptible(&sfp->read_wait);
1303 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1307 static struct file_operations sg_fops = {
1308 .owner = THIS_MODULE,
1313 #ifdef CONFIG_COMPAT
1314 .compat_ioctl = sg_compat_ioctl,
1318 .release = sg_release,
1319 .fasync = sg_fasync,
1322 static struct class *sg_sysfs_class;
1324 static int sg_sysfs_valid = 0;
1326 static int sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1328 struct request_queue *q = scsidp->request_queue;
1330 unsigned long iflags;
1331 void *old_sg_dev_arr = NULL;
1334 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1336 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1340 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1341 if (unlikely(sg_nr_dev >= sg_dev_max)) { /* try to resize */
1343 int tmp_dev_max = sg_nr_dev + SG_DEV_ARR_LUMP;
1344 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1346 tmp_da = kzalloc(tmp_dev_max * sizeof(Sg_device *), GFP_KERNEL);
1347 if (unlikely(!tmp_da))
1350 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1351 memcpy(tmp_da, sg_dev_arr, sg_dev_max * sizeof(Sg_device *));
1352 old_sg_dev_arr = sg_dev_arr;
1353 sg_dev_arr = tmp_da;
1354 sg_dev_max = tmp_dev_max;
1357 for (k = 0; k < sg_dev_max; k++)
1360 if (unlikely(k >= SG_MAX_DEVS))
1363 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1364 sprintf(disk->disk_name, "sg%d", k);
1365 disk->first_minor = k;
1367 sdp->device = scsidp;
1368 init_waitqueue_head(&sdp->o_excl_wait);
1369 sdp->sg_tablesize = min(q->max_hw_segments, q->max_phys_segments);
1372 sg_dev_arr[k] = sdp;
1373 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1379 kfree(old_sg_dev_arr);
1383 printk(KERN_WARNING "sg_alloc: device array cannot be resized\n");
1388 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1389 sdev_printk(KERN_WARNING, scsidp,
1390 "Unable to attach sg device type=%d, minor "
1391 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1397 sg_add(struct class_device *cl_dev, struct class_interface *cl_intf)
1399 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1400 struct gendisk *disk;
1401 Sg_device *sdp = NULL;
1402 struct cdev * cdev = NULL;
1405 disk = alloc_disk(1);
1407 printk(KERN_WARNING "alloc_disk failed\n");
1410 disk->major = SCSI_GENERIC_MAJOR;
1413 cdev = cdev_alloc();
1415 printk(KERN_WARNING "cdev_alloc failed\n");
1418 cdev->owner = THIS_MODULE;
1419 cdev->ops = &sg_fops;
1421 error = sg_alloc(disk, scsidp);
1423 printk(KERN_WARNING "sg_alloc failed\n");
1427 sdp = sg_dev_arr[k];
1429 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, k), 1);
1434 if (sg_sysfs_valid) {
1435 struct class_device * sg_class_member;
1437 sg_class_member = class_device_create(sg_sysfs_class, NULL,
1438 MKDEV(SCSI_GENERIC_MAJOR, k),
1441 if (IS_ERR(sg_class_member))
1442 printk(KERN_WARNING "sg_add: "
1443 "class_device_create failed\n");
1444 class_set_devdata(sg_class_member, sdp);
1445 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1446 &sg_class_member->kobj, "generic");
1448 printk(KERN_ERR "sg_add: unable to make symlink "
1449 "'generic' back to sg%d\n", k);
1451 printk(KERN_WARNING "sg_add: sg_sys INvalid\n");
1453 sdev_printk(KERN_NOTICE, scsidp,
1454 "Attached scsi generic sg%d type %d\n", k,scsidp->type);
1466 sg_remove(struct class_device *cl_dev, struct class_interface *cl_intf)
1468 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1469 Sg_device *sdp = NULL;
1470 unsigned long iflags;
1477 if (NULL == sg_dev_arr)
1480 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1481 for (k = 0; k < sg_dev_max; k++) {
1482 sdp = sg_dev_arr[k];
1483 if ((NULL == sdp) || (sdp->device != scsidp))
1484 continue; /* dirty but lowers nesting */
1487 for (sfp = sdp->headfp; sfp; sfp = tsfp) {
1489 for (srp = sfp->headrp; srp; srp = tsrp) {
1491 if (sfp->closed || (0 == sg_srp_done(srp, sfp)))
1492 sg_finish_rem_req(srp);
1495 scsi_device_put(sdp->device);
1496 __sg_remove_sfp(sdp, sfp);
1499 wake_up_interruptible(&sfp->read_wait);
1500 kill_fasync(&sfp->async_qp, SIGPOLL,
1504 SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d, dirty\n", k));
1505 if (NULL == sdp->headfp) {
1506 sg_dev_arr[k] = NULL;
1508 } else { /* nothing active, simple case */
1509 SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d\n", k));
1510 sg_dev_arr[k] = NULL;
1515 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1518 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1519 class_device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, k));
1520 cdev_del(sdp->cdev);
1522 put_disk(sdp->disk);
1524 if (NULL == sdp->headfp)
1525 kfree((char *) sdp);
1529 msleep(10); /* dirty detach so delay device destruction */
1532 /* Set 'perm' (4th argument) to 0 to disable module_param's definition
1533 * of sysfs parameters (which module_param doesn't yet support).
1534 * Sysfs parameters defined explicitly below.
1536 module_param_named(def_reserved_size, def_reserved_size, int, S_IRUGO);
1537 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1539 MODULE_AUTHOR("Douglas Gilbert");
1540 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1541 MODULE_LICENSE("GPL");
1542 MODULE_VERSION(SG_VERSION_STR);
1543 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1545 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1546 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1553 if (def_reserved_size >= 0)
1554 sg_big_buff = def_reserved_size;
1556 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1560 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1561 if ( IS_ERR(sg_sysfs_class) ) {
1562 rc = PTR_ERR(sg_sysfs_class);
1566 rc = scsi_register_interface(&sg_interface);
1568 #ifdef CONFIG_SCSI_PROC_FS
1570 #endif /* CONFIG_SCSI_PROC_FS */
1573 class_destroy(sg_sysfs_class);
1575 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1582 #ifdef CONFIG_SCSI_PROC_FS
1584 #endif /* CONFIG_SCSI_PROC_FS */
1585 scsi_unregister_interface(&sg_interface);
1586 class_destroy(sg_sysfs_class);
1588 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1590 kfree((char *)sg_dev_arr);
1596 sg_start_req(Sg_request * srp)
1599 Sg_fd *sfp = srp->parentfp;
1600 sg_io_hdr_t *hp = &srp->header;
1601 int dxfer_len = (int) hp->dxfer_len;
1602 int dxfer_dir = hp->dxfer_direction;
1603 Sg_scatter_hold *req_schp = &srp->data;
1604 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1606 SCSI_LOG_TIMEOUT(4, printk("sg_start_req: dxfer_len=%d\n", dxfer_len));
1607 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1609 if (sg_allow_dio && (hp->flags & SG_FLAG_DIRECT_IO) &&
1610 (dxfer_dir != SG_DXFER_UNKNOWN) && (0 == hp->iovec_count) &&
1611 (!sfp->parentdp->device->host->unchecked_isa_dma)) {
1612 res = sg_build_direct(srp, sfp, dxfer_len);
1613 if (res <= 0) /* -ve -> error, 0 -> done, 1 -> try indirect */
1616 if ((!sg_res_in_use(sfp)) && (dxfer_len <= rsv_schp->bufflen))
1617 sg_link_reserve(sfp, srp, dxfer_len);
1619 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1621 sg_remove_scat(req_schp);
1629 sg_finish_rem_req(Sg_request * srp)
1631 Sg_fd *sfp = srp->parentfp;
1632 Sg_scatter_hold *req_schp = &srp->data;
1634 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1636 sg_unlink_reserve(sfp, srp);
1638 sg_remove_scat(req_schp);
1639 sg_remove_request(sfp, srp);
1643 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1645 int sg_bufflen = tablesize * sizeof(struct scatterlist);
1646 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1649 * TODO: test without low_dma, we should not need it since
1650 * the block layer will bounce the buffer for us
1652 * XXX(hch): we shouldn't need GFP_DMA for the actual S/G list.
1655 gfp_flags |= GFP_DMA;
1656 schp->buffer = kzalloc(sg_bufflen, gfp_flags);
1659 schp->sglist_len = sg_bufflen;
1660 return tablesize; /* number of scat_gath elements allocated */
1663 #ifdef SG_ALLOW_DIO_CODE
1664 /* vvvvvvvv following code borrowed from st driver's direct IO vvvvvvvvv */
1665 /* TODO: hopefully we can use the generic block layer code */
1667 /* Pin down user pages and put them into a scatter gather list. Returns <= 0 if
1668 - mapping of all pages not successful
1669 (i.e., either completely successful or fails)
1672 st_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages,
1673 unsigned long uaddr, size_t count, int rw)
1675 unsigned long end = (uaddr + count + PAGE_SIZE - 1) >> PAGE_SHIFT;
1676 unsigned long start = uaddr >> PAGE_SHIFT;
1677 const int nr_pages = end - start;
1679 struct page **pages;
1681 /* User attempted Overflow! */
1682 if ((uaddr + count) < uaddr)
1686 if (nr_pages > max_pages)
1693 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_ATOMIC)) == NULL)
1696 /* Try to fault in all of the necessary pages */
1697 down_read(¤t->mm->mmap_sem);
1698 /* rw==READ means read from drive, write into memory area */
1699 res = get_user_pages(
1705 0, /* don't force */
1708 up_read(¤t->mm->mmap_sem);
1710 /* Errors and no page mapped should return here */
1714 for (i=0; i < nr_pages; i++) {
1715 /* FIXME: flush superflous for rw==READ,
1716 * probably wrong function for rw==WRITE
1718 flush_dcache_page(pages[i]);
1719 /* ?? Is locking needed? I don't think so */
1720 /* if (TestSetPageLocked(pages[i]))
1724 sgl[0].page = pages[0];
1725 sgl[0].offset = uaddr & ~PAGE_MASK;
1727 sgl[0].length = PAGE_SIZE - sgl[0].offset;
1728 count -= sgl[0].length;
1729 for (i=1; i < nr_pages ; i++) {
1730 sgl[i].page = pages[i];
1731 sgl[i].length = count < PAGE_SIZE ? count : PAGE_SIZE;
1736 sgl[0].length = count;
1744 for (j=0; j < res; j++)
1745 page_cache_release(pages[j]);
1753 /* And unmap them... */
1755 st_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
1760 for (i=0; i < nr_pages; i++) {
1761 struct page *page = sgl[i].page;
1765 /* unlock_page(page); */
1766 /* FIXME: cache flush missing for rw==READ
1767 * FIXME: call the correct reference counting function
1769 page_cache_release(page);
1775 /* ^^^^^^^^ above code borrowed from st driver's direct IO ^^^^^^^^^ */
1779 /* Returns: -ve -> error, 0 -> done, 1 -> try indirect */
1781 sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len)
1783 #ifdef SG_ALLOW_DIO_CODE
1784 sg_io_hdr_t *hp = &srp->header;
1785 Sg_scatter_hold *schp = &srp->data;
1786 int sg_tablesize = sfp->parentdp->sg_tablesize;
1787 int mx_sc_elems, res;
1788 struct scsi_device *sdev = sfp->parentdp->device;
1790 if (((unsigned long)hp->dxferp &
1791 queue_dma_alignment(sdev->request_queue)) != 0)
1794 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1795 if (mx_sc_elems <= 0) {
1798 res = st_map_user_pages(schp->buffer, mx_sc_elems,
1799 (unsigned long)hp->dxferp, dxfer_len,
1800 (SG_DXFER_TO_DEV == hp->dxfer_direction) ? 1 : 0);
1802 sg_remove_scat(schp);
1805 schp->k_use_sg = res;
1806 schp->dio_in_use = 1;
1807 hp->info |= SG_INFO_DIRECT_IO;
1815 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1817 struct scatterlist *sg;
1818 int ret_sz = 0, k, rem_sz, num, mx_sc_elems;
1819 int sg_tablesize = sfp->parentdp->sg_tablesize;
1820 int blk_size = buff_size;
1821 struct page *p = NULL;
1823 if ((blk_size < 0) || (!sfp))
1826 ++blk_size; /* don't know why */
1827 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1828 blk_size = (blk_size + SG_SECTOR_MSK) & (~SG_SECTOR_MSK);
1829 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1830 buff_size, blk_size));
1832 /* N.B. ret_sz carried into this block ... */
1833 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1834 if (mx_sc_elems < 0)
1835 return mx_sc_elems; /* most likely -ENOMEM */
1837 for (k = 0, sg = schp->buffer, rem_sz = blk_size;
1838 (rem_sz > 0) && (k < mx_sc_elems);
1839 ++k, rem_sz -= ret_sz, ++sg) {
1841 num = (rem_sz > SG_SCATTER_SZ) ? SG_SCATTER_SZ : rem_sz;
1842 p = sg_page_malloc(num, sfp->low_dma, &ret_sz);
1847 sg->length = ret_sz;
1849 SCSI_LOG_TIMEOUT(5, printk("sg_build_build: k=%d, a=0x%p, len=%d\n",
1851 } /* end of for loop */
1854 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, rem_sz=%d\n", k, rem_sz));
1856 schp->bufflen = blk_size;
1857 if (rem_sz > 0) /* must have failed */
1864 sg_write_xfer(Sg_request * srp)
1866 sg_io_hdr_t *hp = &srp->header;
1867 Sg_scatter_hold *schp = &srp->data;
1868 struct scatterlist *sg = schp->buffer;
1870 int j, k, onum, usglen, ksglen, res;
1871 int iovec_count = (int) hp->iovec_count;
1872 int dxfer_dir = hp->dxfer_direction;
1874 unsigned char __user *up;
1875 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
1877 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_TO_DEV == dxfer_dir) ||
1878 (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
1879 num_xfer = (int) (new_interface ? hp->dxfer_len : hp->flags);
1880 if (schp->bufflen < num_xfer)
1881 num_xfer = schp->bufflen;
1883 if ((num_xfer <= 0) || (schp->dio_in_use) ||
1885 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
1888 SCSI_LOG_TIMEOUT(4, printk("sg_write_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
1889 num_xfer, iovec_count, schp->k_use_sg));
1892 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
1897 ksglen = sg->length;
1898 p = page_address(sg->page);
1899 for (j = 0, k = 0; j < onum; ++j) {
1900 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1904 for (; p; ++sg, ksglen = sg->length,
1905 p = page_address(sg->page)) {
1908 if (ksglen > usglen) {
1909 if (usglen >= num_xfer) {
1910 if (__copy_from_user(p, up, num_xfer))
1914 if (__copy_from_user(p, up, usglen))
1920 if (ksglen >= num_xfer) {
1921 if (__copy_from_user(p, up, num_xfer))
1925 if (__copy_from_user(p, up, ksglen))
1931 if (k >= schp->k_use_sg)
1940 sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
1941 int wr_xf, int *countp, unsigned char __user **up)
1943 int num_xfer = (int) hp->dxfer_len;
1944 unsigned char __user *p = hp->dxferp;
1948 if (wr_xf && ('\0' == hp->interface_id))
1949 count = (int) hp->flags; /* holds "old" input_size */
1954 if (__copy_from_user(&iovec, p + ind*SZ_SG_IOVEC, SZ_SG_IOVEC))
1957 count = (int) iovec.iov_len;
1959 if (!access_ok(wr_xf ? VERIFY_READ : VERIFY_WRITE, p, count))
1969 sg_remove_scat(Sg_scatter_hold * schp)
1971 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1972 if (schp->buffer && (schp->sglist_len > 0)) {
1973 struct scatterlist *sg = schp->buffer;
1975 if (schp->dio_in_use) {
1976 #ifdef SG_ALLOW_DIO_CODE
1977 st_unmap_user_pages(sg, schp->k_use_sg, TRUE);
1982 for (k = 0; (k < schp->k_use_sg) && sg->page;
1984 SCSI_LOG_TIMEOUT(5, printk(
1985 "sg_remove_scat: k=%d, a=0x%p, len=%d\n",
1986 k, sg->page, sg->length));
1987 sg_page_free(sg->page, sg->length);
1990 kfree(schp->buffer);
1992 memset(schp, 0, sizeof (*schp));
1996 sg_read_xfer(Sg_request * srp)
1998 sg_io_hdr_t *hp = &srp->header;
1999 Sg_scatter_hold *schp = &srp->data;
2000 struct scatterlist *sg = schp->buffer;
2002 int j, k, onum, usglen, ksglen, res;
2003 int iovec_count = (int) hp->iovec_count;
2004 int dxfer_dir = hp->dxfer_direction;
2006 unsigned char __user *up;
2007 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
2009 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_FROM_DEV == dxfer_dir)
2010 || (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
2011 num_xfer = hp->dxfer_len;
2012 if (schp->bufflen < num_xfer)
2013 num_xfer = schp->bufflen;
2015 if ((num_xfer <= 0) || (schp->dio_in_use) ||
2017 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
2020 SCSI_LOG_TIMEOUT(4, printk("sg_read_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
2021 num_xfer, iovec_count, schp->k_use_sg));
2024 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
2029 p = page_address(sg->page);
2030 ksglen = sg->length;
2031 for (j = 0, k = 0; j < onum; ++j) {
2032 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2036 for (; p; ++sg, ksglen = sg->length,
2037 p = page_address(sg->page)) {
2040 if (ksglen > usglen) {
2041 if (usglen >= num_xfer) {
2042 if (__copy_to_user(up, p, num_xfer))
2046 if (__copy_to_user(up, p, usglen))
2052 if (ksglen >= num_xfer) {
2053 if (__copy_to_user(up, p, num_xfer))
2057 if (__copy_to_user(up, p, ksglen))
2063 if (k >= schp->k_use_sg)
2072 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
2074 Sg_scatter_hold *schp = &srp->data;
2075 struct scatterlist *sg = schp->buffer;
2078 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
2080 if ((!outp) || (num_read_xfer <= 0))
2083 for (k = 0; (k < schp->k_use_sg) && sg->page; ++k, ++sg) {
2085 if (num > num_read_xfer) {
2086 if (__copy_to_user(outp, page_address(sg->page),
2091 if (__copy_to_user(outp, page_address(sg->page),
2094 num_read_xfer -= num;
2095 if (num_read_xfer <= 0)
2105 sg_build_reserve(Sg_fd * sfp, int req_size)
2107 Sg_scatter_hold *schp = &sfp->reserve;
2109 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
2111 if (req_size < PAGE_SIZE)
2112 req_size = PAGE_SIZE;
2113 if (0 == sg_build_indirect(schp, sfp, req_size))
2116 sg_remove_scat(schp);
2117 req_size >>= 1; /* divide by 2 */
2118 } while (req_size > (PAGE_SIZE / 2));
2122 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2124 Sg_scatter_hold *req_schp = &srp->data;
2125 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2126 struct scatterlist *sg = rsv_schp->buffer;
2130 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
2133 for (k = 0; k < rsv_schp->k_use_sg; ++k, ++sg) {
2136 sfp->save_scat_len = num;
2138 req_schp->k_use_sg = k + 1;
2139 req_schp->sglist_len = rsv_schp->sglist_len;
2140 req_schp->buffer = rsv_schp->buffer;
2142 req_schp->bufflen = size;
2143 req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2149 if (k >= rsv_schp->k_use_sg)
2150 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
2154 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2156 Sg_scatter_hold *req_schp = &srp->data;
2157 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2159 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
2160 (int) req_schp->k_use_sg));
2161 if ((rsv_schp->k_use_sg > 0) && (req_schp->k_use_sg > 0)) {
2162 struct scatterlist *sg = rsv_schp->buffer;
2164 if (sfp->save_scat_len > 0)
2165 (sg + (req_schp->k_use_sg - 1))->length =
2166 (unsigned) sfp->save_scat_len;
2168 SCSI_LOG_TIMEOUT(1, printk ("sg_unlink_reserve: BAD save_scat_len\n"));
2170 req_schp->k_use_sg = 0;
2171 req_schp->bufflen = 0;
2172 req_schp->buffer = NULL;
2173 req_schp->sglist_len = 0;
2174 sfp->save_scat_len = 0;
2179 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2182 unsigned long iflags;
2184 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2185 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2186 /* look for requests that are ready + not SG_IO owned */
2187 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2188 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2189 resp->done = 2; /* guard against other readers */
2193 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2197 #ifdef CONFIG_SCSI_PROC_FS
2199 sg_get_nth_request(Sg_fd * sfp, int nth)
2202 unsigned long iflags;
2205 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2206 for (k = 0, resp = sfp->headrp; resp && (k < nth);
2207 ++k, resp = resp->nextrp) ;
2208 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2213 /* always adds to end of list */
2215 sg_add_request(Sg_fd * sfp)
2218 unsigned long iflags;
2220 Sg_request *rp = sfp->req_arr;
2222 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2225 memset(rp, 0, sizeof (Sg_request));
2230 if (0 == sfp->cmd_q)
2231 resp = NULL; /* command queuing disallowed */
2233 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2237 if (k < SG_MAX_QUEUE) {
2238 memset(rp, 0, sizeof (Sg_request));
2240 while (resp->nextrp)
2241 resp = resp->nextrp;
2249 resp->nextrp = NULL;
2250 resp->header.duration = jiffies_to_msecs(jiffies);
2252 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2256 /* Return of 1 for found; 0 for not found */
2258 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2260 Sg_request *prev_rp;
2262 unsigned long iflags;
2265 if ((!sfp) || (!srp) || (!sfp->headrp))
2267 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2268 prev_rp = sfp->headrp;
2269 if (srp == prev_rp) {
2270 sfp->headrp = prev_rp->nextrp;
2271 prev_rp->parentfp = NULL;
2274 while ((rp = prev_rp->nextrp)) {
2276 prev_rp->nextrp = rp->nextrp;
2277 rp->parentfp = NULL;
2284 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2288 #ifdef CONFIG_SCSI_PROC_FS
2290 sg_get_nth_sfp(Sg_device * sdp, int nth)
2293 unsigned long iflags;
2296 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2297 for (k = 0, resp = sdp->headfp; resp && (k < nth);
2298 ++k, resp = resp->nextfp) ;
2299 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2305 sg_add_sfp(Sg_device * sdp, int dev)
2308 unsigned long iflags;
2310 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2314 init_waitqueue_head(&sfp->read_wait);
2315 rwlock_init(&sfp->rq_list_lock);
2317 sfp->timeout = SG_DEFAULT_TIMEOUT;
2318 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2319 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2320 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2321 sdp->device->host->unchecked_isa_dma : 1;
2322 sfp->cmd_q = SG_DEF_COMMAND_Q;
2323 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2324 sfp->parentdp = sdp;
2325 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2328 else { /* add to tail of existing list */
2329 Sg_fd *pfp = sdp->headfp;
2334 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2335 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2336 sg_build_reserve(sfp, sg_big_buff);
2337 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2338 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2343 __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2348 prev_fp = sdp->headfp;
2350 sdp->headfp = prev_fp->nextfp;
2352 while ((fp = prev_fp->nextfp)) {
2354 prev_fp->nextfp = fp->nextfp;
2360 if (sfp->reserve.bufflen > 0) {
2362 printk("__sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2363 (int) sfp->reserve.bufflen, (int) sfp->reserve.k_use_sg));
2364 sg_remove_scat(&sfp->reserve);
2366 sfp->parentdp = NULL;
2367 SCSI_LOG_TIMEOUT(6, printk("__sg_remove_sfp: sfp=0x%p\n", sfp));
2371 /* Returns 0 in normal case, 1 when detached and sdp object removed */
2373 sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2380 for (srp = sfp->headrp; srp; srp = tsrp) {
2382 if (sg_srp_done(srp, sfp))
2383 sg_finish_rem_req(srp);
2388 unsigned long iflags;
2390 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2391 __sg_remove_sfp(sdp, sfp);
2392 if (sdp->detached && (NULL == sdp->headfp)) {
2396 for (k = 0; k < maxd; ++k) {
2397 if (sdp == sg_dev_arr[k])
2401 sg_dev_arr[k] = NULL;
2402 kfree((char *) sdp);
2405 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2407 /* MOD_INC's to inhibit unloading sg and associated adapter driver */
2408 /* only bump the access_count if we actually succeeded in
2409 * throwing another counter on the host module */
2410 scsi_device_get(sdp->device); /* XXX: retval ignored? */
2411 sfp->closed = 1; /* flag dirty state on this fd */
2412 SCSI_LOG_TIMEOUT(1, printk("sg_remove_sfp: worrisome, %d writes pending\n",
2419 sg_res_in_use(Sg_fd * sfp)
2421 const Sg_request *srp;
2422 unsigned long iflags;
2424 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2425 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2428 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2432 /* If retSzp==NULL want exact size or fail */
2433 static struct page *
2434 sg_page_malloc(int rqSz, int lowDma, int *retSzp)
2436 struct page *resp = NULL;
2445 page_mask = GFP_ATOMIC | GFP_DMA | __GFP_COMP | __GFP_NOWARN;
2447 page_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
2449 for (order = 0, a_size = PAGE_SIZE; a_size < rqSz;
2450 order++, a_size <<= 1) ;
2451 resp = alloc_pages(page_mask, order);
2452 while ((!resp) && order && retSzp) {
2454 a_size >>= 1; /* divide by 2, until PAGE_SIZE */
2455 resp = alloc_pages(page_mask, order); /* try half */
2459 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2460 memset(page_address(resp), 0, resSz);
2468 sg_page_free(struct page *page, int size)
2474 for (order = 0, a_size = PAGE_SIZE; a_size < size;
2475 order++, a_size <<= 1) ;
2476 __free_pages(page, order);
2479 #ifndef MAINTENANCE_IN_CMD
2480 #define MAINTENANCE_IN_CMD 0xa3
2483 static unsigned char allow_ops[] = { TEST_UNIT_READY, REQUEST_SENSE,
2484 INQUIRY, READ_CAPACITY, READ_BUFFER, READ_6, READ_10, READ_12,
2485 READ_16, MODE_SENSE, MODE_SENSE_10, LOG_SENSE, REPORT_LUNS,
2486 SERVICE_ACTION_IN, RECEIVE_DIAGNOSTIC, READ_LONG, MAINTENANCE_IN_CMD
2490 sg_allow_access(unsigned char opcode, char dev_type)
2494 if (TYPE_SCANNER == dev_type) /* TYPE_ROM maybe burner */
2496 for (k = 0; k < sizeof (allow_ops); ++k) {
2497 if (opcode == allow_ops[k])
2503 #ifdef CONFIG_SCSI_PROC_FS
2508 unsigned long iflags;
2510 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2511 for (k = sg_dev_max - 1; k >= 0; --k)
2512 if (sg_dev_arr[k] && sg_dev_arr[k]->device)
2514 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2515 return k + 1; /* origin 1 */
2522 Sg_device *sdp = NULL;
2523 unsigned long iflags;
2525 if (sg_dev_arr && (dev >= 0)) {
2526 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2527 if (dev < sg_dev_max)
2528 sdp = sg_dev_arr[dev];
2529 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2534 #ifdef CONFIG_SCSI_PROC_FS
2536 static struct proc_dir_entry *sg_proc_sgp = NULL;
2538 static char sg_proc_sg_dirname[] = "scsi/sg";
2540 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2542 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2543 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2544 size_t count, loff_t *off);
2545 static struct file_operations adio_fops = {
2546 /* .owner, .read and .llseek added in sg_proc_init() */
2547 .open = sg_proc_single_open_adio,
2548 .write = sg_proc_write_adio,
2549 .release = single_release,
2552 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2553 static ssize_t sg_proc_write_dressz(struct file *filp,
2554 const char __user *buffer, size_t count, loff_t *off);
2555 static struct file_operations dressz_fops = {
2556 .open = sg_proc_single_open_dressz,
2557 .write = sg_proc_write_dressz,
2558 .release = single_release,
2561 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2562 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2563 static struct file_operations version_fops = {
2564 .open = sg_proc_single_open_version,
2565 .release = single_release,
2568 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2569 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2570 static struct file_operations devhdr_fops = {
2571 .open = sg_proc_single_open_devhdr,
2572 .release = single_release,
2575 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2576 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2577 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2578 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2579 static void dev_seq_stop(struct seq_file *s, void *v);
2580 static struct file_operations dev_fops = {
2581 .open = sg_proc_open_dev,
2582 .release = seq_release,
2584 static struct seq_operations dev_seq_ops = {
2585 .start = dev_seq_start,
2586 .next = dev_seq_next,
2587 .stop = dev_seq_stop,
2588 .show = sg_proc_seq_show_dev,
2591 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2592 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2593 static struct file_operations devstrs_fops = {
2594 .open = sg_proc_open_devstrs,
2595 .release = seq_release,
2597 static struct seq_operations devstrs_seq_ops = {
2598 .start = dev_seq_start,
2599 .next = dev_seq_next,
2600 .stop = dev_seq_stop,
2601 .show = sg_proc_seq_show_devstrs,
2604 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2605 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2606 static struct file_operations debug_fops = {
2607 .open = sg_proc_open_debug,
2608 .release = seq_release,
2610 static struct seq_operations debug_seq_ops = {
2611 .start = dev_seq_start,
2612 .next = dev_seq_next,
2613 .stop = dev_seq_stop,
2614 .show = sg_proc_seq_show_debug,
2618 struct sg_proc_leaf {
2620 struct file_operations * fops;
2623 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2624 {"allow_dio", &adio_fops},
2625 {"debug", &debug_fops},
2626 {"def_reserved_size", &dressz_fops},
2627 {"device_hdr", &devhdr_fops},
2628 {"devices", &dev_fops},
2629 {"device_strs", &devstrs_fops},
2630 {"version", &version_fops}
2637 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2638 struct proc_dir_entry *pdep;
2639 struct sg_proc_leaf * leaf;
2641 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2644 for (k = 0; k < num_leaves; ++k) {
2645 leaf = &sg_proc_leaf_arr[k];
2646 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2647 pdep = create_proc_entry(leaf->name, mask, sg_proc_sgp);
2649 leaf->fops->owner = THIS_MODULE,
2650 leaf->fops->read = seq_read,
2651 leaf->fops->llseek = seq_lseek,
2652 pdep->proc_fops = leaf->fops;
2659 sg_proc_cleanup(void)
2662 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2666 for (k = 0; k < num_leaves; ++k)
2667 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2668 remove_proc_entry(sg_proc_sg_dirname, NULL);
2672 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2674 seq_printf(s, "%d\n", *((int *)s->private));
2678 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2680 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2684 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2685 size_t count, loff_t *off)
2690 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2692 num = (count < 10) ? count : 10;
2693 if (copy_from_user(buff, buffer, num))
2696 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2700 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2702 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2706 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2707 size_t count, loff_t *off)
2710 unsigned long k = ULONG_MAX;
2713 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2715 num = (count < 10) ? count : 10;
2716 if (copy_from_user(buff, buffer, num))
2719 k = simple_strtoul(buff, NULL, 10);
2720 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2727 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2729 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2734 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2736 return single_open(file, sg_proc_seq_show_version, NULL);
2739 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2741 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2746 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2748 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2751 struct sg_proc_deviter {
2756 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2758 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2764 if (NULL == sg_dev_arr)
2767 it->max = sg_last_dev();
2768 if (it->index >= it->max)
2773 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2775 struct sg_proc_deviter * it = s->private;
2778 return (it->index < it->max) ? it : NULL;
2781 static void dev_seq_stop(struct seq_file *s, void *v)
2786 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2788 return seq_open(file, &dev_seq_ops);
2791 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2793 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2795 struct scsi_device *scsidp;
2797 sdp = it ? sg_get_dev(it->index) : NULL;
2798 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2799 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2800 scsidp->host->host_no, scsidp->channel,
2801 scsidp->id, scsidp->lun, (int) scsidp->type,
2803 (int) scsidp->queue_depth,
2804 (int) scsidp->device_busy,
2805 (int) scsi_device_online(scsidp));
2807 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2811 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2813 return seq_open(file, &devstrs_seq_ops);
2816 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2818 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2820 struct scsi_device *scsidp;
2822 sdp = it ? sg_get_dev(it->index) : NULL;
2823 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2824 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2825 scsidp->vendor, scsidp->model, scsidp->rev);
2827 seq_printf(s, "<no active device>\n");
2831 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2833 int k, m, new_interface, blen, usg;
2836 const sg_io_hdr_t *hp;
2840 for (k = 0; (fp = sg_get_nth_sfp(sdp, k)); ++k) {
2841 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2842 "(res)sgat=%d low_dma=%d\n", k + 1,
2843 jiffies_to_msecs(fp->timeout),
2844 fp->reserve.bufflen,
2845 (int) fp->reserve.k_use_sg,
2847 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2848 (int) fp->cmd_q, (int) fp->force_packid,
2849 (int) fp->keep_orphan, (int) fp->closed);
2850 for (m = 0; (srp = sg_get_nth_request(fp, m)); ++m) {
2852 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2853 if (srp->res_used) {
2854 if (new_interface &&
2855 (SG_FLAG_MMAP_IO & hp->flags))
2860 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2866 blen = srp->data.bufflen;
2867 usg = srp->data.k_use_sg;
2868 seq_printf(s, srp->done ?
2869 ((1 == srp->done) ? "rcv:" : "fin:")
2871 seq_printf(s, " id=%d blen=%d",
2872 srp->header.pack_id, blen);
2874 seq_printf(s, " dur=%d", hp->duration);
2876 ms = jiffies_to_msecs(jiffies);
2877 seq_printf(s, " t_o/elap=%d/%d",
2878 (new_interface ? hp->timeout :
2879 jiffies_to_msecs(fp->timeout)),
2880 (ms > hp->duration ? ms - hp->duration : 0));
2882 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2883 (int) srp->data.cmd_opcode);
2886 seq_printf(s, " No requests active\n");
2890 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2892 return seq_open(file, &debug_seq_ops);
2895 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2897 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2900 if (it && (0 == it->index)) {
2901 seq_printf(s, "dev_max(currently)=%d max_active_device=%d "
2902 "(origin 1)\n", sg_dev_max, (int)it->max);
2903 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2905 sdp = it ? sg_get_dev(it->index) : NULL;
2907 struct scsi_device *scsidp = sdp->device;
2909 if (NULL == scsidp) {
2910 seq_printf(s, "device %d detached ??\n",
2915 if (sg_get_nth_sfp(sdp, 0)) {
2916 seq_printf(s, " >>> device=%s ",
2917 sdp->disk->disk_name);
2919 seq_printf(s, "detached pending close ");
2922 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2923 scsidp->host->host_no,
2924 scsidp->channel, scsidp->id,
2926 scsidp->host->hostt->emulated);
2927 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2928 sdp->sg_tablesize, sdp->exclude);
2930 sg_proc_debug_helper(s, sdp);
2935 #endif /* CONFIG_SCSI_PROC_FS */
2937 module_init(init_sg);
2938 module_exit(exit_sg);