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 - 2004 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 = 30531; /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.31"
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/config.h>
32 #include <linux/module.h>
35 #include <linux/kernel.h>
36 #include <linux/sched.h>
37 #include <linux/string.h>
39 #include <linux/errno.h>
40 #include <linux/mtio.h>
41 #include <linux/ioctl.h>
42 #include <linux/fcntl.h>
43 #include <linux/init.h>
44 #include <linux/poll.h>
45 #include <linux/vmalloc.h>
46 #include <linux/smp_lock.h>
47 #include <linux/moduleparam.h>
48 #include <linux/devfs_fs_kernel.h>
49 #include <linux/cdev.h>
50 #include <linux/seq_file.h>
52 #include <linux/blkdev.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 = "20040513";
65 static int sg_proc_init(void);
66 static void sg_proc_cleanup(void);
69 #ifndef LINUX_VERSION_CODE
70 #include <linux/version.h>
71 #endif /* LINUX_VERSION_CODE */
73 #define SG_ALLOW_DIO_DEF 0
74 #define SG_ALLOW_DIO_CODE /* compile out by commenting this define */
76 #define SG_MAX_DEVS 8192
79 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
80 * Then when using 32 bit integers x * m may overflow during the calculation.
81 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
82 * calculates the same, but prevents the overflow when both m and d
83 * are "small" numbers (like HZ and USER_HZ).
84 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
87 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
89 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
91 int sg_big_buff = SG_DEF_RESERVED_SIZE;
92 /* N.B. This variable is readable and writeable via
93 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
94 of this size (or less if there is not enough memory) will be reserved
95 for use by this file descriptor. [Deprecated usage: this variable is also
96 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
97 the kernel (i.e. it is not a module).] */
98 static int def_reserved_size = -1; /* picks up init parameter */
99 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
101 #define SG_SECTOR_SZ 512
102 #define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
104 #define SG_DEV_ARR_LUMP 32 /* amount to over allocate sg_dev_arr by */
106 static int sg_add(struct class_device *);
107 static void sg_remove(struct class_device *);
109 static Scsi_Request *dummy_cmdp; /* only used for sizeof */
111 static rwlock_t sg_dev_arr_lock = RW_LOCK_UNLOCKED; /* Also used to lock
112 file descriptor list for device */
114 static struct class_interface sg_interface = {
119 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
120 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
121 unsigned short sglist_len; /* size of malloc'd scatter-gather list ++ */
122 unsigned bufflen; /* Size of (aggregate) data buffer */
123 unsigned b_malloc_len; /* actual len malloc'ed in buffer */
124 void *buffer; /* Data buffer or scatter list (k_use_sg>0) */
125 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
126 unsigned char cmd_opcode; /* first byte of command */
129 struct sg_device; /* forward declarations */
132 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
133 Scsi_Request *my_cmdp; /* != 0 when request with lower levels */
134 struct sg_request *nextrp; /* NULL -> tail request (slist) */
135 struct sg_fd *parentfp; /* NULL -> not in use */
136 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
137 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
138 unsigned char sense_b[sizeof (dummy_cmdp->sr_sense_buffer)];
139 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
140 char orphan; /* 1 -> drop on sight, 0 -> normal */
141 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
142 volatile char done; /* 0->before bh, 1->before read, 2->read */
145 typedef struct sg_fd { /* holds the state of a file descriptor */
146 struct sg_fd *nextfp; /* NULL when last opened fd on this device */
147 struct sg_device *parentdp; /* owning device */
148 wait_queue_head_t read_wait; /* queue read until command done */
149 rwlock_t rq_list_lock; /* protect access to list in req_arr */
150 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
151 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
152 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
153 unsigned save_scat_len; /* original length of trunc. scat. element */
154 Sg_request *headrp; /* head of request slist, NULL->empty */
155 struct fasync_struct *async_qp; /* used by asynchronous notification */
156 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
157 char low_dma; /* as in parent but possibly overridden to 1 */
158 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
159 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
160 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
161 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
162 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
163 char mmap_called; /* 0 -> mmap() never called on this fd */
166 typedef struct sg_device { /* holds the state of each scsi generic device */
167 struct scsi_device *device;
168 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
169 int sg_tablesize; /* adapter's max scatter-gather table size */
170 Sg_fd *headfp; /* first open fd belonging to this device */
171 volatile char detached; /* 0->attached, 1->detached pending removal */
172 volatile char exclude; /* opened for exclusive access */
173 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
174 struct gendisk *disk;
175 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
178 static int sg_fasync(int fd, struct file *filp, int mode);
179 static void sg_cmd_done(Scsi_Cmnd * SCpnt); /* tasklet or soft irq callback */
180 static int sg_start_req(Sg_request * srp);
181 static void sg_finish_rem_req(Sg_request * srp);
182 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
183 static int sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp,
185 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
187 static ssize_t sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
188 int blocking, int read_only, Sg_request ** o_srp);
189 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
190 unsigned char *cmnd, int timeout, int blocking);
191 static int sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
192 int wr_xf, int *countp, unsigned char __user **up);
193 static int sg_write_xfer(Sg_request * srp);
194 static int sg_read_xfer(Sg_request * srp);
195 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
196 static void sg_remove_scat(Sg_scatter_hold * schp);
197 static void sg_build_reserve(Sg_fd * sfp, int req_size);
198 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
199 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
200 static char *sg_page_malloc(int rqSz, int lowDma, int *retSzp);
201 static void sg_page_free(char *buff, int size);
202 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
203 static int sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
204 static void __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
205 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
206 static Sg_request *sg_add_request(Sg_fd * sfp);
207 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
208 static int sg_res_in_use(Sg_fd * sfp);
209 static int sg_ms_to_jif(unsigned int msecs);
210 static inline unsigned sg_jif_to_ms(int jifs);
211 static int sg_allow_access(unsigned char opcode, char dev_type);
212 static int sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len);
213 static Sg_device *sg_get_dev(int dev);
214 static inline unsigned char *sg_scatg2virt(const struct scatterlist *sclp);
215 #ifdef CONFIG_SCSI_PROC_FS
216 static int sg_last_dev(void);
219 static Sg_device **sg_dev_arr = NULL;
220 static int sg_dev_max;
221 static int sg_nr_dev;
223 #define SZ_SG_HEADER sizeof(struct sg_header)
224 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
225 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
226 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
229 sg_open(struct inode *inode, struct file *filp)
231 int dev = iminor(inode);
232 int flags = filp->f_flags;
238 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
239 sdp = sg_get_dev(dev);
240 if ((!sdp) || (!sdp->device))
245 /* This driver's module count bumped by fops_get in <linux/fs.h> */
246 /* Prevent the device driver from vanishing while we sleep */
247 retval = scsi_device_get(sdp->device);
251 if (!((flags & O_NONBLOCK) ||
252 scsi_block_when_processing_errors(sdp->device))) {
254 /* we are in error recovery for this device */
258 if (flags & O_EXCL) {
259 if (O_RDONLY == (flags & O_ACCMODE)) {
260 retval = -EPERM; /* Can't lock it with read only access */
263 if (sdp->headfp && (flags & O_NONBLOCK)) {
268 __wait_event_interruptible(sdp->o_excl_wait,
269 ((sdp->headfp || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
271 retval = res; /* -ERESTARTSYS because signal hit process */
274 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
275 if (flags & O_NONBLOCK) {
280 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
283 retval = res; /* -ERESTARTSYS because signal hit process */
291 if (!sdp->headfp) { /* no existing opens on this device */
293 sdp->sg_tablesize = sdp->device->host->sg_tablesize;
295 if ((sfp = sg_add_sfp(sdp, dev)))
296 filp->private_data = sfp;
299 sdp->exclude = 0; /* undo if error */
306 scsi_device_put(sdp->device);
310 /* Following function was formerly called 'sg_close' */
312 sg_release(struct inode *inode, struct file *filp)
317 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
319 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
320 sg_fasync(-1, filp, 0); /* remove filp from async notification list */
321 if (0 == sg_remove_sfp(sdp, sfp)) { /* Returns 1 when sdp gone */
322 if (!sdp->detached) {
323 scsi_device_put(sdp->device);
326 wake_up_interruptible(&sdp->o_excl_wait);
332 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
338 int req_pack_id = -1;
339 struct sg_header old_hdr;
343 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
345 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
346 sdp->disk->disk_name, (int) count));
347 if (ppos != &filp->f_pos) ; /* FIXME: Hmm. Seek to the right place, or fail? */
348 if ((k = verify_area(VERIFY_WRITE, buf, count)))
350 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
351 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
353 if (old_hdr.reply_len < 0) {
354 if (count >= SZ_SG_IO_HDR) {
356 (&new_hdr, buf, SZ_SG_IO_HDR))
358 req_pack_id = new_hdr.pack_id;
361 req_pack_id = old_hdr.pack_id;
363 srp = sg_get_rq_mark(sfp, req_pack_id);
364 if (!srp) { /* now wait on packet to arrive */
367 if (filp->f_flags & O_NONBLOCK)
370 res = 0; /* following is a macro that beats race condition */
371 __wait_event_interruptible(sfp->read_wait,
372 (sdp->detached || (srp = sg_get_rq_mark(sfp, req_pack_id))),
378 return res; /* -ERESTARTSYS because signal hit process */
381 if (srp->header.interface_id != '\0')
382 return sg_new_read(sfp, buf, count, srp);
385 memset(&old_hdr, 0, SZ_SG_HEADER);
386 old_hdr.reply_len = (int) hp->timeout;
387 old_hdr.pack_len = old_hdr.reply_len; /* very old, strange behaviour */
388 old_hdr.pack_id = hp->pack_id;
389 old_hdr.twelve_byte =
390 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
391 old_hdr.target_status = hp->masked_status;
392 old_hdr.host_status = hp->host_status;
393 old_hdr.driver_status = hp->driver_status;
394 if ((CHECK_CONDITION & hp->masked_status) ||
395 (DRIVER_SENSE & hp->driver_status))
396 memcpy(old_hdr.sense_buffer, srp->sense_b,
397 sizeof (old_hdr.sense_buffer));
398 switch (hp->host_status) {
399 /* This setup of 'result' is for backward compatibility and is best
400 ignored by the user who should use target, host + driver status */
402 case DID_PASSTHROUGH:
409 old_hdr.result = EBUSY;
416 old_hdr.result = EIO;
419 old_hdr.result = (srp->sense_b[0] == 0 &&
420 hp->masked_status == GOOD) ? 0 : EIO;
423 old_hdr.result = EIO;
427 /* Now copy the result back to the user buffer. */
428 if (count >= SZ_SG_HEADER) {
429 if (__copy_to_user(buf, &old_hdr, SZ_SG_HEADER))
432 if (count > old_hdr.reply_len)
433 count = old_hdr.reply_len;
434 if (count > SZ_SG_HEADER) {
436 sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)))
440 count = (old_hdr.result == 0) ? 0 : -EIO;
441 sg_finish_rem_req(srp);
446 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
448 sg_io_hdr_t *hp = &srp->header;
452 if (count < SZ_SG_IO_HDR) {
457 if ((hp->mx_sb_len > 0) && hp->sbp) {
458 if ((CHECK_CONDITION & hp->masked_status) ||
459 (DRIVER_SENSE & hp->driver_status)) {
460 int sb_len = sizeof (dummy_cmdp->sr_sense_buffer);
461 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
462 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
463 len = (len > sb_len) ? sb_len : len;
464 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
471 if (hp->masked_status || hp->host_status || hp->driver_status)
472 hp->info |= SG_INFO_CHECK;
473 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
477 err = sg_read_xfer(srp);
479 sg_finish_rem_req(srp);
480 return (0 == err) ? count : err;
484 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
486 int mxsize, cmd_size, k;
487 int input_size, blocking;
488 unsigned char opcode;
492 struct sg_header old_hdr;
494 unsigned char cmnd[sizeof (dummy_cmdp->sr_cmnd)];
496 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
498 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
499 sdp->disk->disk_name, (int) count));
502 if (!((filp->f_flags & O_NONBLOCK) ||
503 scsi_block_when_processing_errors(sdp->device)))
505 if (ppos != &filp->f_pos) ; /* FIXME: Hmm. Seek to the right place, or fail? */
507 if ((k = verify_area(VERIFY_READ, buf, count)))
508 return k; /* protects following copy_from_user()s + get_user()s */
509 if (count < SZ_SG_HEADER)
511 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
513 blocking = !(filp->f_flags & O_NONBLOCK);
514 if (old_hdr.reply_len < 0)
515 return sg_new_write(sfp, buf, count, blocking, 0, NULL);
516 if (count < (SZ_SG_HEADER + 6))
517 return -EIO; /* The minimum scsi command length is 6 bytes. */
519 if (!(srp = sg_add_request(sfp))) {
520 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
524 __get_user(opcode, buf);
525 if (sfp->next_cmd_len > 0) {
526 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
527 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
528 sfp->next_cmd_len = 0;
529 sg_remove_request(sfp, srp);
532 cmd_size = sfp->next_cmd_len;
533 sfp->next_cmd_len = 0; /* reset so only this write() effected */
535 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
536 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
539 SCSI_LOG_TIMEOUT(4, printk(
540 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
541 /* Determine buffer size. */
542 input_size = count - cmd_size;
543 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
544 mxsize -= SZ_SG_HEADER;
545 input_size -= SZ_SG_HEADER;
546 if (input_size < 0) {
547 sg_remove_request(sfp, srp);
548 return -EIO; /* User did not pass enough bytes for this command. */
551 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
552 hp->cmd_len = (unsigned char) cmd_size;
556 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
557 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
559 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
560 hp->dxfer_len = mxsize;
561 hp->dxferp = (char __user *)buf + cmd_size;
563 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
564 hp->flags = input_size; /* structure abuse ... */
565 hp->pack_id = old_hdr.pack_id;
567 if (__copy_from_user(cmnd, buf, cmd_size))
569 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
570 return (k < 0) ? k : count;
574 sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
575 int blocking, int read_only, Sg_request ** o_srp)
580 unsigned char cmnd[sizeof (dummy_cmdp->sr_cmnd)];
583 if (count < SZ_SG_IO_HDR)
585 if ((k = verify_area(VERIFY_READ, buf, count)))
586 return k; /* protects following copy_from_user()s + get_user()s */
588 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
589 if (!(srp = sg_add_request(sfp))) {
590 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
594 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
595 sg_remove_request(sfp, srp);
598 if (hp->interface_id != 'S') {
599 sg_remove_request(sfp, srp);
602 if (hp->flags & SG_FLAG_MMAP_IO) {
603 if (hp->dxfer_len > sfp->reserve.bufflen) {
604 sg_remove_request(sfp, srp);
605 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
607 if (hp->flags & SG_FLAG_DIRECT_IO) {
608 sg_remove_request(sfp, srp);
609 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
611 if (sg_res_in_use(sfp)) {
612 sg_remove_request(sfp, srp);
613 return -EBUSY; /* reserve buffer already being used */
616 timeout = sg_ms_to_jif(srp->header.timeout);
617 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
618 sg_remove_request(sfp, srp);
621 if ((k = verify_area(VERIFY_READ, hp->cmdp, hp->cmd_len))) {
622 sg_remove_request(sfp, srp);
623 return k; /* protects following copy_from_user()s + get_user()s */
625 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
626 sg_remove_request(sfp, srp);
630 (!sg_allow_access(cmnd[0], sfp->parentdp->device->type))) {
631 sg_remove_request(sfp, srp);
634 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
643 sg_common_write(Sg_fd * sfp, Sg_request * srp,
644 unsigned char *cmnd, int timeout, int blocking)
648 Sg_device *sdp = sfp->parentdp;
649 sg_io_hdr_t *hp = &srp->header;
652 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
654 hp->masked_status = 0;
658 hp->driver_status = 0;
660 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
661 (int) cmnd[0], (int) hp->cmd_len));
663 if ((k = sg_start_req(srp))) {
664 SCSI_LOG_TIMEOUT(1, printk("sg_write: start_req err=%d\n", k));
665 sg_finish_rem_req(srp);
666 return k; /* probably out of space --> ENOMEM */
668 if ((k = sg_write_xfer(srp))) {
669 SCSI_LOG_TIMEOUT(1, printk("sg_write: write_xfer, bad address\n"));
670 sg_finish_rem_req(srp);
674 sg_finish_rem_req(srp);
677 SRpnt = scsi_allocate_request(sdp->device, GFP_ATOMIC);
679 SCSI_LOG_TIMEOUT(1, printk("sg_write: no mem\n"));
680 sg_finish_rem_req(srp);
684 srp->my_cmdp = SRpnt;
685 q = SRpnt->sr_device->request_queue;
686 SRpnt->sr_request->rq_disk = sdp->disk;
687 SRpnt->sr_sense_buffer[0] = 0;
688 SRpnt->sr_cmd_len = hp->cmd_len;
689 SRpnt->sr_use_sg = srp->data.k_use_sg;
690 SRpnt->sr_sglist_len = srp->data.sglist_len;
691 SRpnt->sr_bufflen = srp->data.bufflen;
692 SRpnt->sr_underflow = 0;
693 SRpnt->sr_buffer = srp->data.buffer;
694 switch (hp->dxfer_direction) {
695 case SG_DXFER_TO_FROM_DEV:
696 case SG_DXFER_FROM_DEV:
697 SRpnt->sr_data_direction = SCSI_DATA_READ;
699 case SG_DXFER_TO_DEV:
700 SRpnt->sr_data_direction = SCSI_DATA_WRITE;
702 case SG_DXFER_UNKNOWN:
703 SRpnt->sr_data_direction = SCSI_DATA_UNKNOWN;
706 SRpnt->sr_data_direction = SCSI_DATA_NONE;
709 SRpnt->upper_private_data = srp;
710 srp->data.k_use_sg = 0;
711 srp->data.sglist_len = 0;
712 srp->data.bufflen = 0;
713 srp->data.buffer = NULL;
714 hp->duration = jiffies; /* unit jiffies now, millisecs after done */
715 /* Now send everything of to mid-level. The next time we hear about this
716 packet is when sg_cmd_done() is called (i.e. a callback). */
717 scsi_do_req(SRpnt, (void *) cmnd,
718 (void *) SRpnt->sr_buffer, hp->dxfer_len,
719 sg_cmd_done, timeout, SG_DEFAULT_RETRIES);
720 /* dxfer_len overwrites SRpnt->sr_bufflen, hence need for b_malloc_len */
721 generic_unplug_device(q);
726 sg_ioctl(struct inode *inode, struct file *filp,
727 unsigned int cmd_in, unsigned long arg)
729 void __user *p = (void __user *)arg;
731 int result, val, read_only;
735 unsigned long iflags;
737 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
739 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
740 sdp->disk->disk_name, (int) cmd_in));
741 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
746 int blocking = 1; /* ignore O_NONBLOCK flag */
750 if (!scsi_block_when_processing_errors(sdp->device))
752 result = verify_area(VERIFY_WRITE, p, SZ_SG_IO_HDR);
756 sg_new_write(sfp, p, SZ_SG_IO_HDR,
757 blocking, read_only, &srp);
760 srp->sg_io_owned = 1;
762 result = 0; /* following macro to beat race condition */
763 __wait_event_interruptible(sfp->read_wait,
764 (sdp->detached || sfp->closed || srp->done),
769 return 0; /* request packet dropped already */
773 return result; /* -ERESTARTSYS because signal hit process */
776 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
777 return (result < 0) ? result : 0;
780 result = get_user(val, ip);
785 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
786 val = MULDIV (INT_MAX, USER_HZ, HZ);
787 sfp->timeout_user = val;
788 sfp->timeout = MULDIV (val, HZ, USER_HZ);
791 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
792 /* strange ..., for backward compatibility */
793 return sfp->timeout_user;
794 case SG_SET_FORCE_LOW_DMA:
795 result = get_user(val, ip);
800 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
801 val = (int) sfp->reserve.bufflen;
802 sg_remove_scat(&sfp->reserve);
803 sg_build_reserve(sfp, val);
808 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
812 return put_user((int) sfp->low_dma, ip);
815 verify_area(VERIFY_WRITE, p, sizeof (sg_scsi_id_t));
819 sg_scsi_id_t __user *sg_idp = p;
823 __put_user((int) sdp->device->host->host_no,
825 __put_user((int) sdp->device->channel,
827 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
828 __put_user((int) sdp->device->lun, &sg_idp->lun);
829 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
830 __put_user((short) sdp->device->host->cmd_per_lun,
831 &sg_idp->h_cmd_per_lun);
832 __put_user((short) sdp->device->queue_depth,
833 &sg_idp->d_queue_depth);
834 __put_user(0, &sg_idp->unused[0]);
835 __put_user(0, &sg_idp->unused[1]);
838 case SG_SET_FORCE_PACK_ID:
839 result = get_user(val, ip);
842 sfp->force_packid = val ? 1 : 0;
845 result = verify_area(VERIFY_WRITE, ip, sizeof (int));
848 read_lock_irqsave(&sfp->rq_list_lock, iflags);
849 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
850 if ((1 == srp->done) && (!srp->sg_io_owned)) {
851 read_unlock_irqrestore(&sfp->rq_list_lock,
853 __put_user(srp->header.pack_id, ip);
857 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
860 case SG_GET_NUM_WAITING:
861 read_lock_irqsave(&sfp->rq_list_lock, iflags);
862 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
863 if ((1 == srp->done) && (!srp->sg_io_owned))
866 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
867 return put_user(val, ip);
868 case SG_GET_SG_TABLESIZE:
869 return put_user(sdp->sg_tablesize, ip);
870 case SG_SET_RESERVED_SIZE:
871 result = get_user(val, ip);
876 if (val != sfp->reserve.bufflen) {
877 if (sg_res_in_use(sfp) || sfp->mmap_called)
879 sg_remove_scat(&sfp->reserve);
880 sg_build_reserve(sfp, val);
883 case SG_GET_RESERVED_SIZE:
884 val = (int) sfp->reserve.bufflen;
885 return put_user(val, ip);
886 case SG_SET_COMMAND_Q:
887 result = get_user(val, ip);
890 sfp->cmd_q = val ? 1 : 0;
892 case SG_GET_COMMAND_Q:
893 return put_user((int) sfp->cmd_q, ip);
894 case SG_SET_KEEP_ORPHAN:
895 result = get_user(val, ip);
898 sfp->keep_orphan = val;
900 case SG_GET_KEEP_ORPHAN:
901 return put_user((int) sfp->keep_orphan, ip);
902 case SG_NEXT_CMD_LEN:
903 result = get_user(val, ip);
906 sfp->next_cmd_len = (val > 0) ? val : 0;
908 case SG_GET_VERSION_NUM:
909 return put_user(sg_version_num, ip);
910 case SG_GET_ACCESS_COUNT:
911 /* faked - we don't have a real access count anymore */
912 val = (sdp->device ? 1 : 0);
913 return put_user(val, ip);
914 case SG_GET_REQUEST_TABLE:
915 result = verify_area(VERIFY_WRITE, p,
916 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
920 sg_req_info_t rinfo[SG_MAX_QUEUE];
922 read_lock_irqsave(&sfp->rq_list_lock, iflags);
923 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
924 ++val, srp = srp ? srp->nextrp : srp) {
925 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
927 rinfo[val].req_state = srp->done + 1;
929 srp->header.masked_status &
930 srp->header.host_status &
931 srp->header.driver_status;
932 rinfo[val].duration =
933 srp->done ? srp->header.duration :
935 jiffies - srp->header.duration);
936 rinfo[val].orphan = srp->orphan;
937 rinfo[val].sg_io_owned = srp->sg_io_owned;
938 rinfo[val].pack_id = srp->header.pack_id;
939 rinfo[val].usr_ptr = srp->header.usr_ptr;
942 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
943 return (__copy_to_user(p, rinfo,
944 SZ_SG_REQ_INFO * SG_MAX_QUEUE) ? -EFAULT : 0);
946 case SG_EMULATED_HOST:
949 return put_user(sdp->device->host->hostt->emulated, ip);
953 if (filp->f_flags & O_NONBLOCK) {
954 if (test_bit(SHOST_RECOVERY,
955 &sdp->device->host->shost_state))
957 } else if (!scsi_block_when_processing_errors(sdp->device))
959 result = get_user(val, ip);
962 if (SG_SCSI_RESET_NOTHING == val)
965 case SG_SCSI_RESET_DEVICE:
966 val = SCSI_TRY_RESET_DEVICE;
968 case SG_SCSI_RESET_BUS:
969 val = SCSI_TRY_RESET_BUS;
971 case SG_SCSI_RESET_HOST:
972 val = SCSI_TRY_RESET_HOST;
977 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
979 return (scsi_reset_provider(sdp->device, val) ==
981 case SCSI_IOCTL_SEND_COMMAND:
985 unsigned char opcode = WRITE_6;
986 Scsi_Ioctl_Command __user *siocp = p;
988 if (copy_from_user(&opcode, siocp->data, 1))
990 if (!sg_allow_access(opcode, sdp->device->type))
993 return scsi_ioctl_send_command(sdp->device, p);
995 result = get_user(val, ip);
998 sdp->sgdebug = (char) val;
1000 case SCSI_IOCTL_GET_IDLUN:
1001 case SCSI_IOCTL_GET_BUS_NUMBER:
1002 case SCSI_IOCTL_PROBE_HOST:
1003 case SG_GET_TRANSFORM:
1006 return scsi_ioctl(sdp->device, cmd_in, p);
1009 return -EPERM; /* don't know so take safe approach */
1010 return scsi_ioctl(sdp->device, cmd_in, p);
1015 sg_poll(struct file *filp, poll_table * wait)
1017 unsigned int res = 0;
1022 unsigned long iflags;
1024 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1027 poll_wait(filp, &sfp->read_wait, wait);
1028 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1029 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1030 /* if any read waiting, flag it */
1031 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1032 res = POLLIN | POLLRDNORM;
1035 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1039 else if (!sfp->cmd_q) {
1041 res |= POLLOUT | POLLWRNORM;
1042 } else if (count < SG_MAX_QUEUE)
1043 res |= POLLOUT | POLLWRNORM;
1044 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1045 sdp->disk->disk_name, (int) res));
1050 sg_fasync(int fd, struct file *filp, int mode)
1056 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1058 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1059 sdp->disk->disk_name, mode));
1061 retval = fasync_helper(fd, filp, mode, &sfp->async_qp);
1062 return (retval < 0) ? retval : 0;
1065 static inline unsigned char *
1066 sg_scatg2virt(const struct scatterlist *sclp)
1068 return (sclp && sclp->page) ?
1069 (unsigned char *) page_address(sclp->page) + sclp->offset : NULL;
1072 /* When startFinish==1 increments page counts for pages other than the
1073 first of scatter gather elements obtained from __get_free_pages().
1074 When startFinish==0 decrements ... */
1076 sg_rb_correct4mmap(Sg_scatter_hold * rsv_schp, int startFinish)
1082 SCSI_LOG_TIMEOUT(3, printk("sg_rb_correct4mmap: startFinish=%d, scatg=%d\n",
1083 startFinish, rsv_schp->k_use_sg));
1084 /* N.B. correction _not_ applied to base page of each allocation */
1085 if (rsv_schp->k_use_sg) { /* reserve buffer is a scatter gather list */
1086 struct scatterlist *sclp = rsv_schp->buffer;
1088 for (k = 0; k < rsv_schp->k_use_sg; ++k, ++sclp) {
1089 for (m = PAGE_SIZE; m < sclp->length; m += PAGE_SIZE) {
1090 page_ptr = sg_scatg2virt(sclp) + m;
1091 page = virt_to_page(page_ptr);
1095 if (page_count(page) > 0)
1100 } else { /* reserve buffer is just a single allocation */
1101 for (m = PAGE_SIZE; m < rsv_schp->bufflen; m += PAGE_SIZE) {
1102 page_ptr = (unsigned char *) rsv_schp->buffer + m;
1103 page = virt_to_page(page_ptr);
1107 if (page_count(page) > 0)
1114 static struct page *
1115 sg_vma_nopage(struct vm_area_struct *vma, unsigned long addr, int *type)
1118 struct page *page = NOPAGE_SIGBUS;
1119 void *page_ptr = NULL;
1120 unsigned long offset;
1121 Sg_scatter_hold *rsv_schp;
1123 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1125 rsv_schp = &sfp->reserve;
1126 offset = addr - vma->vm_start;
1127 if (offset >= rsv_schp->bufflen)
1129 SCSI_LOG_TIMEOUT(3, printk("sg_vma_nopage: offset=%lu, scatg=%d\n",
1130 offset, rsv_schp->k_use_sg));
1131 if (rsv_schp->k_use_sg) { /* reserve buffer is a scatter gather list */
1133 unsigned long sa = vma->vm_start;
1135 struct scatterlist *sclp = rsv_schp->buffer;
1137 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1139 len = vma->vm_end - sa;
1140 len = (len < sclp->length) ? len : sclp->length;
1142 page_ptr = sg_scatg2virt(sclp) + offset;
1143 page = virt_to_page(page_ptr);
1144 get_page(page); /* increment page count */
1150 } else { /* reserve buffer is just a single allocation */
1151 page_ptr = (unsigned char *) rsv_schp->buffer + offset;
1152 page = virt_to_page(page_ptr);
1153 get_page(page); /* increment page count */
1156 *type = VM_FAULT_MINOR;
1160 static struct vm_operations_struct sg_mmap_vm_ops = {
1161 .nopage = sg_vma_nopage,
1165 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1168 unsigned long req_sz = vma->vm_end - vma->vm_start;
1169 Sg_scatter_hold *rsv_schp;
1171 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1173 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1174 (void *) vma->vm_start, (int) req_sz));
1176 return -EINVAL; /* want no offset */
1177 rsv_schp = &sfp->reserve;
1178 if (req_sz > rsv_schp->bufflen)
1179 return -ENOMEM; /* cannot map more than reserved buffer */
1181 if (rsv_schp->k_use_sg) { /* reserve buffer is a scatter gather list */
1183 unsigned long sa = vma->vm_start;
1185 struct scatterlist *sclp = rsv_schp->buffer;
1187 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1189 if (0 != sclp->offset)
1190 return -EFAULT; /* non page aligned memory ?? */
1191 len = vma->vm_end - sa;
1192 len = (len < sclp->length) ? len : sclp->length;
1195 } else { /* reserve buffer is just a single allocation */
1196 if ((unsigned long) rsv_schp->buffer & (PAGE_SIZE - 1))
1197 return -EFAULT; /* non page aligned memory ?? */
1199 if (0 == sfp->mmap_called) {
1200 sg_rb_correct4mmap(rsv_schp, 1); /* do only once per fd lifetime */
1201 sfp->mmap_called = 1;
1203 vma->vm_flags |= (VM_RESERVED | VM_IO);
1204 vma->vm_private_data = sfp;
1205 vma->vm_ops = &sg_mmap_vm_ops;
1209 /* This function is a "bottom half" handler that is called by the
1210 * mid level when a command is completed (or has failed). */
1212 sg_cmd_done(Scsi_Cmnd * SCpnt)
1214 Scsi_Request *SRpnt = NULL;
1215 Sg_device *sdp = NULL;
1217 Sg_request *srp = NULL;
1219 if (SCpnt && (SRpnt = SCpnt->sc_request))
1220 srp = (Sg_request *) SRpnt->upper_private_data;
1222 printk(KERN_ERR "sg_cmd_done: NULL request\n");
1224 scsi_release_request(SRpnt);
1227 sfp = srp->parentfp;
1229 sdp = sfp->parentdp;
1230 if ((NULL == sdp) || sdp->detached) {
1231 printk(KERN_INFO "sg_cmd_done: device detached\n");
1232 scsi_release_request(SRpnt);
1236 /* First transfer ownership of data buffers to sg_device object. */
1237 srp->data.k_use_sg = SRpnt->sr_use_sg;
1238 srp->data.sglist_len = SRpnt->sr_sglist_len;
1239 srp->data.bufflen = SRpnt->sr_bufflen;
1240 srp->data.buffer = SRpnt->sr_buffer;
1241 /* now clear out request structure */
1242 SRpnt->sr_use_sg = 0;
1243 SRpnt->sr_sglist_len = 0;
1244 SRpnt->sr_bufflen = 0;
1245 SRpnt->sr_buffer = NULL;
1246 SRpnt->sr_underflow = 0;
1247 SRpnt->sr_request->rq_disk = NULL; /* "sg" _disowns_ request blk */
1249 srp->my_cmdp = NULL;
1251 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1252 sdp->disk->disk_name, srp->header.pack_id, (int) SRpnt->sr_result));
1253 srp->header.resid = SCpnt->resid;
1254 /* N.B. unit of duration changes here from jiffies to millisecs */
1255 srp->header.duration =
1256 sg_jif_to_ms(jiffies - (int) srp->header.duration);
1257 if (0 != SRpnt->sr_result) {
1258 memcpy(srp->sense_b, SRpnt->sr_sense_buffer,
1259 sizeof (srp->sense_b));
1260 srp->header.status = 0xff & SRpnt->sr_result;
1261 srp->header.masked_status = status_byte(SRpnt->sr_result);
1262 srp->header.msg_status = msg_byte(SRpnt->sr_result);
1263 srp->header.host_status = host_byte(SRpnt->sr_result);
1264 srp->header.driver_status = driver_byte(SRpnt->sr_result);
1265 if ((sdp->sgdebug > 0) &&
1266 ((CHECK_CONDITION == srp->header.masked_status) ||
1267 (COMMAND_TERMINATED == srp->header.masked_status)))
1268 print_req_sense("sg_cmd_done", SRpnt);
1270 /* Following if statement is a patch supplied by Eric Youngdale */
1271 if (driver_byte(SRpnt->sr_result) != 0
1272 && (SRpnt->sr_sense_buffer[0] & 0x7f) == 0x70
1273 && (SRpnt->sr_sense_buffer[2] & 0xf) == UNIT_ATTENTION
1274 && sdp->device->removable) {
1275 /* Detected disc change. Set the bit - this may be used if */
1276 /* there are filesystems using this device. */
1277 sdp->device->changed = 1;
1280 /* Rely on write phase to clean out srp status values, so no "else" */
1282 scsi_release_request(SRpnt);
1284 if (sfp->closed) { /* whoops this fd already released, cleanup */
1285 SCSI_LOG_TIMEOUT(1, printk("sg_cmd_done: already closed, freeing ...\n"));
1286 sg_finish_rem_req(srp);
1288 if (NULL == sfp->headrp) {
1289 SCSI_LOG_TIMEOUT(1, printk("sg...bh: already closed, final cleanup\n"));
1290 if (0 == sg_remove_sfp(sdp, sfp)) { /* device still present */
1291 scsi_device_put(sdp->device);
1295 } else if (srp && srp->orphan) {
1296 if (sfp->keep_orphan)
1297 srp->sg_io_owned = 0;
1299 sg_finish_rem_req(srp);
1304 /* Now wake up any sg_read() that is waiting for this packet. */
1305 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1307 wake_up_interruptible(&sfp->read_wait);
1311 static struct file_operations sg_fops = {
1312 .owner = THIS_MODULE,
1319 .release = sg_release,
1320 .fasync = sg_fasync,
1323 static struct class_simple * sg_sysfs_class;
1325 static int sg_sysfs_valid = 0;
1327 static int sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1330 unsigned long iflags;
1331 void *old_sg_dev_arr = NULL;
1334 sdp = vmalloc(sizeof(Sg_device));
1338 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1339 if (unlikely(sg_nr_dev >= sg_dev_max)) { /* try to resize */
1341 int tmp_dev_max = sg_nr_dev + SG_DEV_ARR_LUMP;
1342 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1344 tmp_da = vmalloc(tmp_dev_max * sizeof(Sg_device *));
1345 if (unlikely(!tmp_da))
1348 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1349 memset(tmp_da, 0, tmp_dev_max * sizeof(Sg_device *));
1350 memcpy(tmp_da, sg_dev_arr, sg_dev_max * sizeof(Sg_device *));
1351 old_sg_dev_arr = sg_dev_arr;
1352 sg_dev_arr = tmp_da;
1353 sg_dev_max = tmp_dev_max;
1356 for (k = 0; k < sg_dev_max; k++)
1359 if (unlikely(k >= SG_MAX_DEVS))
1362 memset(sdp, 0, sizeof(*sdp));
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 = scsidp->host ? scsidp->host->sg_tablesize : 0;
1372 sg_dev_arr[k] = sdp;
1373 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1379 vfree(old_sg_dev_arr);
1383 printk(KERN_ERR "sg_alloc: device array cannot be resized\n");
1388 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1390 "Unable to attach sg device <%d, %d, %d, %d> type=%d, minor "
1391 "number exceeds %d\n", scsidp->host->host_no, scsidp->channel,
1392 scsidp->id, scsidp->lun, scsidp->type, SG_MAX_DEVS - 1);
1398 sg_add(struct class_device *cl_dev)
1400 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1401 struct gendisk *disk;
1402 Sg_device *sdp = NULL;
1403 struct cdev * cdev = NULL;
1406 disk = alloc_disk(1);
1409 disk->major = SCSI_GENERIC_MAJOR;
1412 cdev = cdev_alloc();
1415 cdev->owner = THIS_MODULE;
1416 cdev->ops = &sg_fops;
1418 error = sg_alloc(disk, scsidp);
1422 sdp = sg_dev_arr[k];
1424 devfs_mk_cdev(MKDEV(SCSI_GENERIC_MAJOR, k),
1425 S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP,
1426 "%s/generic", scsidp->devfs_name);
1427 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, k), 1);
1429 devfs_remove("%s/generic", scsidp->devfs_name);
1433 if (sg_sysfs_valid) {
1434 struct class_device * sg_class_member;
1436 sg_class_member = class_simple_device_add(sg_sysfs_class,
1437 MKDEV(SCSI_GENERIC_MAJOR, k),
1440 if (IS_ERR(sg_class_member))
1441 printk(KERN_WARNING "sg_add: "
1442 "class_simple_device_add failed\n");
1443 class_set_devdata(sg_class_member, sdp);
1444 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1445 &sg_class_member->kobj, "generic");
1447 printk(KERN_ERR "sg_add: unable to make symlink "
1448 "'generic' back to sg%d\n", k);
1450 printk(KERN_WARNING "sg_add: sg_sys INvalid\n");
1453 "Attached scsi generic sg%d at scsi%d, channel"
1454 " %d, id %d, lun %d, type %d\n", k,
1455 scsidp->host->host_no, scsidp->channel, scsidp->id,
1456 scsidp->lun, scsidp->type);
1468 sg_remove(struct class_device *cl_dev)
1470 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1471 Sg_device *sdp = NULL;
1472 unsigned long iflags;
1479 if (NULL == sg_dev_arr)
1482 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1483 for (k = 0; k < sg_dev_max; k++) {
1484 sdp = sg_dev_arr[k];
1485 if ((NULL == sdp) || (sdp->device != scsidp))
1486 continue; /* dirty but lowers nesting */
1489 for (sfp = sdp->headfp; sfp; sfp = tsfp) {
1491 for (srp = sfp->headrp; srp; srp = tsrp) {
1493 if (sfp->closed || (0 == srp->done))
1494 sg_finish_rem_req(srp);
1497 scsi_device_put(sdp->device);
1498 __sg_remove_sfp(sdp, sfp);
1501 wake_up_interruptible(&sfp->read_wait);
1502 kill_fasync(&sfp->async_qp, SIGPOLL,
1506 SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d, dirty\n", k));
1507 if (NULL == sdp->headfp) {
1508 sg_dev_arr[k] = NULL;
1510 } else { /* nothing active, simple case */
1511 SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d\n", k));
1512 sg_dev_arr[k] = NULL;
1517 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1520 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1521 class_simple_device_remove(MKDEV(SCSI_GENERIC_MAJOR, k));
1522 cdev_del(sdp->cdev);
1524 devfs_remove("%s/generic", scsidp->devfs_name);
1525 put_disk(sdp->disk);
1527 if (NULL == sdp->headfp)
1528 vfree((char *) sdp);
1532 scsi_sleep(2); /* dirty detach so delay device destruction */
1535 /* Set 'perm' (4th argument) to 0 to disable module_param's definition
1536 * of sysfs parameters (which module_param doesn't yet support).
1537 * Sysfs parameters defined explicitly below.
1539 module_param_named(def_reserved_size, def_reserved_size, int, 0);
1540 module_param_named(allow_dio, sg_allow_dio, int, 0);
1542 MODULE_AUTHOR("Douglas Gilbert");
1543 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1544 MODULE_LICENSE("GPL");
1545 MODULE_VERSION(SG_VERSION_STR);
1547 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1548 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1555 if (def_reserved_size >= 0)
1556 sg_big_buff = def_reserved_size;
1558 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1562 sg_sysfs_class = class_simple_create(THIS_MODULE, "scsi_generic");
1563 if ( IS_ERR(sg_sysfs_class) ) {
1564 rc = PTR_ERR(sg_sysfs_class);
1568 rc = scsi_register_interface(&sg_interface);
1570 #ifdef CONFIG_SCSI_PROC_FS
1572 #endif /* CONFIG_SCSI_PROC_FS */
1575 class_simple_destroy(sg_sysfs_class);
1577 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1584 #ifdef CONFIG_SCSI_PROC_FS
1586 #endif /* CONFIG_SCSI_PROC_FS */
1587 scsi_unregister_interface(&sg_interface);
1588 class_simple_destroy(sg_sysfs_class);
1590 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1592 if (sg_dev_arr != NULL) {
1593 vfree((char *) sg_dev_arr);
1600 sg_start_req(Sg_request * srp)
1603 Sg_fd *sfp = srp->parentfp;
1604 sg_io_hdr_t *hp = &srp->header;
1605 int dxfer_len = (int) hp->dxfer_len;
1606 int dxfer_dir = hp->dxfer_direction;
1607 Sg_scatter_hold *req_schp = &srp->data;
1608 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1610 SCSI_LOG_TIMEOUT(4, printk("sg_start_req: dxfer_len=%d\n", dxfer_len));
1611 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1613 if (sg_allow_dio && (hp->flags & SG_FLAG_DIRECT_IO) &&
1614 (dxfer_dir != SG_DXFER_UNKNOWN) && (0 == hp->iovec_count) &&
1615 (!sfp->parentdp->device->host->unchecked_isa_dma)) {
1616 res = sg_build_direct(srp, sfp, dxfer_len);
1617 if (res <= 0) /* -ve -> error, 0 -> done, 1 -> try indirect */
1620 if ((!sg_res_in_use(sfp)) && (dxfer_len <= rsv_schp->bufflen))
1621 sg_link_reserve(sfp, srp, dxfer_len);
1623 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1625 sg_remove_scat(req_schp);
1633 sg_finish_rem_req(Sg_request * srp)
1635 Sg_fd *sfp = srp->parentfp;
1636 Sg_scatter_hold *req_schp = &srp->data;
1638 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1640 sg_unlink_reserve(sfp, srp);
1642 sg_remove_scat(req_schp);
1643 sg_remove_request(sfp, srp);
1647 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1650 int elem_sz = sizeof (struct scatterlist);
1651 int sg_bufflen = tablesize * elem_sz;
1652 int mx_sc_elems = tablesize;
1654 schp->buffer = sg_page_malloc(sg_bufflen, sfp->low_dma, &ret_sz);
1657 else if (ret_sz != sg_bufflen) {
1658 sg_bufflen = ret_sz;
1659 mx_sc_elems = sg_bufflen / elem_sz;
1661 schp->sglist_len = sg_bufflen;
1662 memset(schp->buffer, 0, sg_bufflen);
1663 return mx_sc_elems; /* number of scat_gath elements allocated */
1666 #ifdef SG_ALLOW_DIO_CODE
1667 /* vvvvvvvv following code borrowed from st driver's direct IO vvvvvvvvv */
1668 /* hopefully this generic code will moved to a library */
1670 /* Pin down user pages and put them into a scatter gather list. Returns <= 0 if
1671 - mapping of all pages not successful
1672 - any page is above max_pfn
1673 (i.e., either completely successful or fails)
1676 st_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages,
1677 unsigned long uaddr, size_t count, int rw,
1678 unsigned long max_pfn)
1681 unsigned int nr_pages;
1682 struct page **pages;
1684 nr_pages = ((uaddr & ~PAGE_MASK) + count + ~PAGE_MASK) >> PAGE_SHIFT;
1686 /* User attempted Overflow! */
1687 if ((uaddr + count) < uaddr)
1691 if (nr_pages > max_pages)
1698 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_ATOMIC)) == NULL)
1701 /* Try to fault in all of the necessary pages */
1702 down_read(¤t->mm->mmap_sem);
1703 /* rw==READ means read from drive, write into memory area */
1704 res = get_user_pages(
1710 0, /* don't force */
1713 up_read(¤t->mm->mmap_sem);
1715 /* Errors and no page mapped should return here */
1719 for (i=0; i < nr_pages; i++) {
1720 /* FIXME: flush superflous for rw==READ,
1721 * probably wrong function for rw==WRITE
1723 flush_dcache_page(pages[i]);
1724 if (page_to_pfn(pages[i]) > max_pfn)
1726 /* ?? Is locking needed? I don't think so */
1727 /* if (TestSetPageLocked(pages[i]))
1731 /* Populate the scatter/gather list */
1732 sgl[0].page = pages[0];
1733 sgl[0].offset = uaddr & ~PAGE_MASK;
1735 sgl[0].length = PAGE_SIZE - sgl[0].offset;
1736 count -= sgl[0].length;
1737 for (i=1; i < nr_pages ; i++) {
1739 sgl[i].page = pages[i];
1740 sgl[i].length = count < PAGE_SIZE ? count : PAGE_SIZE;
1745 sgl[0].length = count;
1752 /* for (j=0; j < i; j++)
1753 unlock_page(pages[j]); */
1757 for (j=0; j < res; j++)
1758 page_cache_release(pages[j]);
1764 /* And unmap them... */
1766 st_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
1771 for (i=0; i < nr_pages; i++) {
1772 if (dirtied && !PageReserved(sgl[i].page))
1773 SetPageDirty(sgl[i].page);
1774 /* unlock_page(sgl[i].page); */
1775 /* FIXME: cache flush missing for rw==READ
1776 * FIXME: call the correct reference counting function
1778 page_cache_release(sgl[i].page);
1784 /* ^^^^^^^^ above code borrowed from st driver's direct IO ^^^^^^^^^ */
1788 /* Returns: -ve -> error, 0 -> done, 1 -> try indirect */
1790 sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len)
1792 #ifdef SG_ALLOW_DIO_CODE
1793 sg_io_hdr_t *hp = &srp->header;
1794 Sg_scatter_hold *schp = &srp->data;
1795 int sg_tablesize = sfp->parentdp->sg_tablesize;
1796 struct scatterlist *sgl;
1797 int mx_sc_elems, res;
1798 struct scsi_device *sdev = sfp->parentdp->device;
1800 if (((unsigned long)hp->dxferp &
1801 queue_dma_alignment(sdev->request_queue)) != 0)
1803 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1804 if (mx_sc_elems <= 0) {
1807 sgl = (struct scatterlist *)schp->buffer;
1808 res = st_map_user_pages(sgl, mx_sc_elems, (unsigned long)hp->dxferp, dxfer_len,
1809 (SG_DXFER_TO_DEV == hp->dxfer_direction) ? 1 : 0, ULONG_MAX);
1812 schp->k_use_sg = res;
1813 schp->dio_in_use = 1;
1814 hp->info |= SG_INFO_DIRECT_IO;
1822 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1825 int blk_size = buff_size;
1826 unsigned char *p = NULL;
1828 if ((blk_size < 0) || (!sfp))
1831 ++blk_size; /* don't know why */
1832 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1833 blk_size = (blk_size + SG_SECTOR_MSK) & (~SG_SECTOR_MSK);
1834 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1835 buff_size, blk_size));
1836 if (blk_size <= SG_SCATTER_SZ) {
1837 p = sg_page_malloc(blk_size, sfp->low_dma, &ret_sz);
1840 if (blk_size == ret_sz) { /* got it on the first attempt */
1843 schp->bufflen = blk_size;
1844 schp->b_malloc_len = blk_size;
1848 p = sg_page_malloc(SG_SCATTER_SZ, sfp->low_dma, &ret_sz);
1852 /* Want some local declarations, so start new block ... */
1853 { /* lets try and build a scatter gather list */
1854 struct scatterlist *sclp;
1857 int sg_tablesize = sfp->parentdp->sg_tablesize;
1860 /* N.B. ret_sz carried into this block ... */
1861 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1862 if (mx_sc_elems < 0)
1863 return mx_sc_elems; /* most likely -ENOMEM */
1865 for (k = 0, sclp = schp->buffer, rem_sz = blk_size;
1866 (rem_sz > 0) && (k < mx_sc_elems);
1867 ++k, rem_sz -= ret_sz, ++sclp) {
1873 SG_SCATTER_SZ) ? SG_SCATTER_SZ : rem_sz;
1874 p = sg_page_malloc(num, sfp->low_dma, &ret_sz);
1878 sclp->page = virt_to_page(p);
1879 sclp->offset = offset_in_page(p);
1880 sclp->length = ret_sz;
1882 SCSI_LOG_TIMEOUT(5, printk("sg_build_build: k=%d, a=0x%p, len=%d\n",
1883 k, sg_scatg2virt(sclp), ret_sz));
1884 } /* end of for loop */
1886 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, rem_sz=%d\n", k, rem_sz));
1887 schp->bufflen = blk_size;
1888 if (rem_sz > 0) /* must have failed */
1895 sg_write_xfer(Sg_request * srp)
1897 sg_io_hdr_t *hp = &srp->header;
1898 Sg_scatter_hold *schp = &srp->data;
1900 int j, k, onum, usglen, ksglen, res;
1901 int iovec_count = (int) hp->iovec_count;
1902 int dxfer_dir = hp->dxfer_direction;
1904 unsigned char __user *up;
1905 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
1907 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_TO_DEV == dxfer_dir) ||
1908 (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
1909 num_xfer = (int) (new_interface ? hp->dxfer_len : hp->flags);
1910 if (schp->bufflen < num_xfer)
1911 num_xfer = schp->bufflen;
1913 if ((num_xfer <= 0) || (schp->dio_in_use) ||
1915 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
1918 SCSI_LOG_TIMEOUT(4, printk("sg_write_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
1919 num_xfer, iovec_count, schp->k_use_sg));
1922 if ((k = verify_area(VERIFY_READ, hp->dxferp,
1923 SZ_SG_IOVEC * onum)))
1928 if (0 == schp->k_use_sg) { /* kernel has single buffer */
1929 for (j = 0, p = schp->buffer; j < onum; ++j) {
1930 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1933 usglen = (num_xfer > usglen) ? usglen : num_xfer;
1934 if (__copy_from_user(p, up, usglen))
1941 } else { /* kernel using scatter gather list */
1942 struct scatterlist *sclp = (struct scatterlist *) schp->buffer;
1944 ksglen = (int) sclp->length;
1945 p = sg_scatg2virt(sclp);
1946 for (j = 0, k = 0; j < onum; ++j) {
1947 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1951 for (; p; ++sclp, ksglen = (int) sclp->length,
1952 p = sg_scatg2virt(sclp)) {
1955 if (ksglen > usglen) {
1956 if (usglen >= num_xfer) {
1957 if (__copy_from_user
1962 if (__copy_from_user(p, up, usglen))
1968 if (ksglen >= num_xfer) {
1969 if (__copy_from_user
1974 if (__copy_from_user(p, up, ksglen))
1980 if (k >= schp->k_use_sg)
1989 sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
1990 int wr_xf, int *countp, unsigned char __user **up)
1992 int num_xfer = (int) hp->dxfer_len;
1993 unsigned char __user *p = hp->dxferp;
1997 if (wr_xf && ('\0' == hp->interface_id))
1998 count = (int) hp->flags; /* holds "old" input_size */
2003 if (__copy_from_user(&iovec, p + ind*SZ_SG_IOVEC, SZ_SG_IOVEC))
2006 count = (int) iovec.iov_len;
2008 if ((k = verify_area(wr_xf ? VERIFY_READ : VERIFY_WRITE, p, count)))
2018 sg_remove_scat(Sg_scatter_hold * schp)
2020 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
2021 if (schp->buffer && (schp->sglist_len > 0)) {
2022 struct scatterlist *sclp = (struct scatterlist *) schp->buffer;
2024 if (schp->dio_in_use) {
2025 #ifdef SG_ALLOW_DIO_CODE
2026 st_unmap_user_pages(sclp, schp->k_use_sg, TRUE);
2031 for (k = 0; (k < schp->k_use_sg) && sg_scatg2virt(sclp);
2033 SCSI_LOG_TIMEOUT(5, printk(
2034 "sg_remove_scat: k=%d, a=0x%p, len=%d\n",
2035 k, sg_scatg2virt(sclp), sclp->length));
2036 sg_page_free(sg_scatg2virt(sclp), sclp->length);
2042 sg_page_free(schp->buffer, schp->sglist_len);
2043 } else if (schp->buffer)
2044 sg_page_free(schp->buffer, schp->b_malloc_len);
2045 memset(schp, 0, sizeof (*schp));
2049 sg_read_xfer(Sg_request * srp)
2051 sg_io_hdr_t *hp = &srp->header;
2052 Sg_scatter_hold *schp = &srp->data;
2054 int j, k, onum, usglen, ksglen, res;
2055 int iovec_count = (int) hp->iovec_count;
2056 int dxfer_dir = hp->dxfer_direction;
2058 unsigned char __user *up;
2059 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
2061 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_FROM_DEV == dxfer_dir)
2062 || (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
2063 num_xfer = hp->dxfer_len;
2064 if (schp->bufflen < num_xfer)
2065 num_xfer = schp->bufflen;
2067 if ((num_xfer <= 0) || (schp->dio_in_use) ||
2069 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
2072 SCSI_LOG_TIMEOUT(4, printk("sg_read_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
2073 num_xfer, iovec_count, schp->k_use_sg));
2076 if ((k = verify_area(VERIFY_READ, hp->dxferp,
2077 SZ_SG_IOVEC * onum)))
2082 if (0 == schp->k_use_sg) { /* kernel has single buffer */
2083 for (j = 0, p = schp->buffer; j < onum; ++j) {
2084 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2087 usglen = (num_xfer > usglen) ? usglen : num_xfer;
2088 if (__copy_to_user(up, p, usglen))
2095 } else { /* kernel using scatter gather list */
2096 struct scatterlist *sclp = (struct scatterlist *) schp->buffer;
2098 ksglen = (int) sclp->length;
2099 p = sg_scatg2virt(sclp);
2100 for (j = 0, k = 0; j < onum; ++j) {
2101 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2105 for (; p; ++sclp, ksglen = (int) sclp->length,
2106 p = sg_scatg2virt(sclp)) {
2109 if (ksglen > usglen) {
2110 if (usglen >= num_xfer) {
2116 if (__copy_to_user(up, p, usglen))
2122 if (ksglen >= num_xfer) {
2128 if (__copy_to_user(up, p, ksglen))
2134 if (k >= schp->k_use_sg)
2143 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
2145 Sg_scatter_hold *schp = &srp->data;
2147 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
2149 if ((!outp) || (num_read_xfer <= 0))
2151 if (schp->k_use_sg > 0) {
2153 struct scatterlist *sclp = (struct scatterlist *) schp->buffer;
2155 for (k = 0; (k < schp->k_use_sg) && sg_scatg2virt(sclp);
2157 num = (int) sclp->length;
2158 if (num > num_read_xfer) {
2160 (outp, sg_scatg2virt(sclp), num_read_xfer))
2165 (outp, sg_scatg2virt(sclp), num))
2167 num_read_xfer -= num;
2168 if (num_read_xfer <= 0)
2174 if (__copy_to_user(outp, schp->buffer, num_read_xfer))
2181 sg_build_reserve(Sg_fd * sfp, int req_size)
2183 Sg_scatter_hold *schp = &sfp->reserve;
2185 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
2187 if (req_size < PAGE_SIZE)
2188 req_size = PAGE_SIZE;
2189 if (0 == sg_build_indirect(schp, sfp, req_size))
2192 sg_remove_scat(schp);
2193 req_size >>= 1; /* divide by 2 */
2194 } while (req_size > (PAGE_SIZE / 2));
2198 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2200 Sg_scatter_hold *req_schp = &srp->data;
2201 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2204 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
2205 size = (size + 1) & (~1); /* round to even for aha1542 */
2206 if (rsv_schp->k_use_sg > 0) {
2209 struct scatterlist *sclp =
2210 (struct scatterlist *) rsv_schp->buffer;
2212 for (k = 0; k < rsv_schp->k_use_sg; ++k, ++sclp) {
2213 num = (int) sclp->length;
2216 req_schp->k_use_sg = 0;
2217 req_schp->buffer = sg_scatg2virt(sclp);
2219 sfp->save_scat_len = num;
2220 sclp->length = (unsigned) rem;
2221 req_schp->k_use_sg = k + 1;
2222 req_schp->sglist_len =
2223 rsv_schp->sglist_len;
2224 req_schp->buffer = rsv_schp->buffer;
2226 req_schp->bufflen = size;
2227 req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2232 if (k >= rsv_schp->k_use_sg)
2233 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
2235 req_schp->k_use_sg = 0;
2236 req_schp->bufflen = size;
2237 req_schp->buffer = rsv_schp->buffer;
2238 req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2243 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2245 Sg_scatter_hold *req_schp = &srp->data;
2246 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2248 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
2249 (int) req_schp->k_use_sg));
2250 if ((rsv_schp->k_use_sg > 0) && (req_schp->k_use_sg > 0)) {
2251 struct scatterlist *sclp =
2252 (struct scatterlist *) rsv_schp->buffer;
2254 if (sfp->save_scat_len > 0)
2255 (sclp + (req_schp->k_use_sg - 1))->length =
2256 (unsigned) sfp->save_scat_len;
2258 SCSI_LOG_TIMEOUT(1, printk ("sg_unlink_reserve: BAD save_scat_len\n"));
2260 req_schp->k_use_sg = 0;
2261 req_schp->bufflen = 0;
2262 req_schp->buffer = NULL;
2263 req_schp->sglist_len = 0;
2264 sfp->save_scat_len = 0;
2269 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2272 unsigned long iflags;
2274 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2275 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2276 /* look for requests that are ready + not SG_IO owned */
2277 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2278 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2279 resp->done = 2; /* guard against other readers */
2283 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2287 #ifdef CONFIG_SCSI_PROC_FS
2289 sg_get_nth_request(Sg_fd * sfp, int nth)
2292 unsigned long iflags;
2295 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2296 for (k = 0, resp = sfp->headrp; resp && (k < nth);
2297 ++k, resp = resp->nextrp) ;
2298 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2303 /* always adds to end of list */
2305 sg_add_request(Sg_fd * sfp)
2308 unsigned long iflags;
2310 Sg_request *rp = sfp->req_arr;
2312 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2315 memset(rp, 0, sizeof (Sg_request));
2320 if (0 == sfp->cmd_q)
2321 resp = NULL; /* command queuing disallowed */
2323 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2327 if (k < SG_MAX_QUEUE) {
2328 memset(rp, 0, sizeof (Sg_request));
2330 while (resp->nextrp)
2331 resp = resp->nextrp;
2339 resp->nextrp = NULL;
2340 resp->header.duration = jiffies;
2341 resp->my_cmdp = NULL;
2343 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2347 /* Return of 1 for found; 0 for not found */
2349 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2351 Sg_request *prev_rp;
2353 unsigned long iflags;
2356 if ((!sfp) || (!srp) || (!sfp->headrp))
2358 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2359 prev_rp = sfp->headrp;
2360 if (srp == prev_rp) {
2361 sfp->headrp = prev_rp->nextrp;
2362 prev_rp->parentfp = NULL;
2365 while ((rp = prev_rp->nextrp)) {
2367 prev_rp->nextrp = rp->nextrp;
2368 rp->parentfp = NULL;
2375 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2379 #ifdef CONFIG_SCSI_PROC_FS
2381 sg_get_nth_sfp(Sg_device * sdp, int nth)
2384 unsigned long iflags;
2387 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2388 for (k = 0, resp = sdp->headfp; resp && (k < nth);
2389 ++k, resp = resp->nextfp) ;
2390 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2396 sg_add_sfp(Sg_device * sdp, int dev)
2399 unsigned long iflags;
2401 sfp = (Sg_fd *) sg_page_malloc(sizeof (Sg_fd), 0, 0);
2404 memset(sfp, 0, sizeof (Sg_fd));
2405 init_waitqueue_head(&sfp->read_wait);
2406 sfp->rq_list_lock = RW_LOCK_UNLOCKED;
2408 sfp->timeout = SG_DEFAULT_TIMEOUT;
2409 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2410 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2411 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2412 sdp->device->host->unchecked_isa_dma : 1;
2413 sfp->cmd_q = SG_DEF_COMMAND_Q;
2414 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2415 sfp->parentdp = sdp;
2416 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2419 else { /* add to tail of existing list */
2420 Sg_fd *pfp = sdp->headfp;
2425 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2426 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2427 sg_build_reserve(sfp, sg_big_buff);
2428 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2429 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2434 __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2439 prev_fp = sdp->headfp;
2441 sdp->headfp = prev_fp->nextfp;
2443 while ((fp = prev_fp->nextfp)) {
2445 prev_fp->nextfp = fp->nextfp;
2451 if (sfp->reserve.bufflen > 0) {
2453 printk("__sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2454 (int) sfp->reserve.bufflen, (int) sfp->reserve.k_use_sg));
2455 if (sfp->mmap_called)
2456 sg_rb_correct4mmap(&sfp->reserve, 0); /* undo correction */
2457 sg_remove_scat(&sfp->reserve);
2459 sfp->parentdp = NULL;
2460 SCSI_LOG_TIMEOUT(6, printk("__sg_remove_sfp: sfp=0x%p\n", sfp));
2461 sg_page_free((char *) sfp, sizeof (Sg_fd));
2464 /* Returns 0 in normal case, 1 when detached and sdp object removed */
2466 sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2473 for (srp = sfp->headrp; srp; srp = tsrp) {
2476 sg_finish_rem_req(srp);
2481 unsigned long iflags;
2483 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2484 __sg_remove_sfp(sdp, sfp);
2485 if (sdp->detached && (NULL == sdp->headfp)) {
2489 for (k = 0; k < maxd; ++k) {
2490 if (sdp == sg_dev_arr[k])
2494 sg_dev_arr[k] = NULL;
2495 vfree((char *) sdp);
2498 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2500 /* MOD_INC's to inhibit unloading sg and associated adapter driver */
2501 /* only bump the access_count if we actually succeeded in
2502 * throwing another counter on the host module */
2503 scsi_device_get(sdp->device); /* XXX: retval ignored? */
2504 sfp->closed = 1; /* flag dirty state on this fd */
2505 SCSI_LOG_TIMEOUT(1, printk("sg_remove_sfp: worrisome, %d writes pending\n",
2512 sg_res_in_use(Sg_fd * sfp)
2514 const Sg_request *srp;
2515 unsigned long iflags;
2517 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2518 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2521 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2525 /* If retSzp==NULL want exact size or fail */
2527 sg_page_malloc(int rqSz, int lowDma, int *retSzp)
2538 page_mask = GFP_ATOMIC | GFP_DMA | __GFP_NOWARN;
2540 page_mask = GFP_ATOMIC | __GFP_NOWARN;
2542 for (order = 0, a_size = PAGE_SIZE; a_size < rqSz;
2543 order++, a_size <<= 1) ;
2544 resp = (char *) __get_free_pages(page_mask, order);
2545 while ((!resp) && order && retSzp) {
2547 a_size >>= 1; /* divide by 2, until PAGE_SIZE */
2548 resp = (char *) __get_free_pages(page_mask, order); /* try half */
2552 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2553 memset(resp, 0, resSz);
2561 sg_page_free(char *buff, int size)
2567 for (order = 0, a_size = PAGE_SIZE; a_size < size;
2568 order++, a_size <<= 1) ;
2569 free_pages((unsigned long) buff, order);
2573 sg_ms_to_jif(unsigned int msecs)
2575 if ((UINT_MAX / 2U) < msecs)
2576 return INT_MAX; /* special case, set largest possible */
2578 return ((int) msecs <
2579 (INT_MAX / 1000)) ? (((int) msecs * HZ) / 1000)
2580 : (((int) msecs / 1000) * HZ);
2583 static inline unsigned
2584 sg_jif_to_ms(int jifs)
2589 unsigned int j = (unsigned int) jifs;
2591 (UINT_MAX / 1000)) ? ((j * 1000) / HZ) : ((j / HZ) *
2596 static unsigned char allow_ops[] = { TEST_UNIT_READY, REQUEST_SENSE,
2597 INQUIRY, READ_CAPACITY, READ_BUFFER, READ_6, READ_10, READ_12,
2598 MODE_SENSE, MODE_SENSE_10, LOG_SENSE
2602 sg_allow_access(unsigned char opcode, char dev_type)
2606 if (TYPE_SCANNER == dev_type) /* TYPE_ROM maybe burner */
2608 for (k = 0; k < sizeof (allow_ops); ++k) {
2609 if (opcode == allow_ops[k])
2615 #ifdef CONFIG_SCSI_PROC_FS
2620 unsigned long iflags;
2622 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2623 for (k = sg_dev_max - 1; k >= 0; --k)
2624 if (sg_dev_arr[k] && sg_dev_arr[k]->device)
2626 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2627 return k + 1; /* origin 1 */
2634 Sg_device *sdp = NULL;
2635 unsigned long iflags;
2637 if (sg_dev_arr && (dev >= 0)) {
2638 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2639 if (dev < sg_dev_max)
2640 sdp = sg_dev_arr[dev];
2641 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2646 #ifdef CONFIG_SCSI_PROC_FS
2648 static struct proc_dir_entry *sg_proc_sgp = NULL;
2650 static char sg_proc_sg_dirname[] = "scsi/sg";
2652 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2654 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2655 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2656 size_t count, loff_t *off);
2657 static struct file_operations adio_fops = {
2658 /* .owner, .read and .llseek added in sg_proc_init() */
2659 .open = sg_proc_single_open_adio,
2660 .write = sg_proc_write_adio,
2661 .release = single_release,
2664 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2665 static ssize_t sg_proc_write_dressz(struct file *filp,
2666 const char __user *buffer, size_t count, loff_t *off);
2667 static struct file_operations dressz_fops = {
2668 .open = sg_proc_single_open_dressz,
2669 .write = sg_proc_write_dressz,
2670 .release = single_release,
2673 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2674 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2675 static struct file_operations version_fops = {
2676 .open = sg_proc_single_open_version,
2677 .release = single_release,
2680 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2681 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2682 static struct file_operations devhdr_fops = {
2683 .open = sg_proc_single_open_devhdr,
2684 .release = single_release,
2687 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2688 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2689 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2690 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2691 static void dev_seq_stop(struct seq_file *s, void *v);
2692 static struct file_operations dev_fops = {
2693 .open = sg_proc_open_dev,
2694 .release = seq_release,
2696 static struct seq_operations dev_seq_ops = {
2697 .start = dev_seq_start,
2698 .next = dev_seq_next,
2699 .stop = dev_seq_stop,
2700 .show = sg_proc_seq_show_dev,
2703 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2704 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2705 static struct file_operations devstrs_fops = {
2706 .open = sg_proc_open_devstrs,
2707 .release = seq_release,
2709 static struct seq_operations devstrs_seq_ops = {
2710 .start = dev_seq_start,
2711 .next = dev_seq_next,
2712 .stop = dev_seq_stop,
2713 .show = sg_proc_seq_show_devstrs,
2716 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2717 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2718 static struct file_operations debug_fops = {
2719 .open = sg_proc_open_debug,
2720 .release = seq_release,
2722 static struct seq_operations debug_seq_ops = {
2723 .start = dev_seq_start,
2724 .next = dev_seq_next,
2725 .stop = dev_seq_stop,
2726 .show = sg_proc_seq_show_debug,
2730 struct sg_proc_leaf {
2732 struct file_operations * fops;
2735 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2736 {"allow_dio", &adio_fops},
2737 {"debug", &debug_fops},
2738 {"def_reserved_size", &dressz_fops},
2739 {"device_hdr", &devhdr_fops},
2740 {"devices", &dev_fops},
2741 {"device_strs", &devstrs_fops},
2742 {"version", &version_fops}
2750 sizeof (sg_proc_leaf_arr) / sizeof (sg_proc_leaf_arr[0]);
2751 struct proc_dir_entry *pdep;
2752 struct sg_proc_leaf * leaf;
2754 sg_proc_sgp = create_proc_entry(sg_proc_sg_dirname,
2755 S_IFDIR | S_IRUGO | S_IXUGO, NULL);
2758 for (k = 0; k < num_leaves; ++k) {
2759 leaf = &sg_proc_leaf_arr[k];
2760 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2761 pdep = create_proc_entry(leaf->name, mask, sg_proc_sgp);
2763 leaf->fops->owner = THIS_MODULE,
2764 leaf->fops->read = seq_read,
2765 leaf->fops->llseek = seq_lseek,
2766 pdep->proc_fops = leaf->fops;
2773 sg_proc_cleanup(void)
2777 sizeof (sg_proc_leaf_arr) / sizeof (sg_proc_leaf_arr[0]);
2781 for (k = 0; k < num_leaves; ++k)
2782 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2783 remove_proc_entry(sg_proc_sg_dirname, NULL);
2787 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2789 seq_printf(s, "%d\n", *((int *)s->private));
2793 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2795 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2799 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2800 size_t count, loff_t *off)
2805 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2807 num = (count < 10) ? count : 10;
2808 if (copy_from_user(buff, buffer, num))
2811 sg_allow_dio = simple_strtoul(buff, 0, 10) ? 1 : 0;
2815 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2817 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2821 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2822 size_t count, loff_t *off)
2825 unsigned long k = ULONG_MAX;
2828 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2830 num = (count < 10) ? count : 10;
2831 if (copy_from_user(buff, buffer, num))
2834 k = simple_strtoul(buff, 0, 10);
2835 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2842 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2844 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2849 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2851 return single_open(file, sg_proc_seq_show_version, NULL);
2854 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2856 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2861 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2863 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2866 struct sg_proc_deviter {
2871 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2873 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2877 if (NULL == sg_dev_arr)
2880 it->max = sg_last_dev();
2881 if (it->index >= it->max)
2889 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2891 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2894 return (it->index < it->max) ? it : NULL;
2897 static void dev_seq_stop(struct seq_file *s, void *v)
2902 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2904 return seq_open(file, &dev_seq_ops);
2907 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2909 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2911 struct scsi_device *scsidp;
2913 sdp = it ? sg_get_dev(it->index) : NULL;
2914 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2915 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2916 scsidp->host->host_no, scsidp->channel,
2917 scsidp->id, scsidp->lun, (int) scsidp->type,
2919 (int) scsidp->queue_depth,
2920 (int) scsidp->device_busy,
2921 (int) scsi_device_online(scsidp));
2923 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2927 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2929 return seq_open(file, &devstrs_seq_ops);
2932 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2934 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2936 struct scsi_device *scsidp;
2938 sdp = it ? sg_get_dev(it->index) : NULL;
2939 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2940 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2941 scsidp->vendor, scsidp->model, scsidp->rev);
2943 seq_printf(s, "<no active device>\n");
2947 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2949 int k, m, new_interface, blen, usg;
2952 const sg_io_hdr_t *hp;
2955 for (k = 0; (fp = sg_get_nth_sfp(sdp, k)); ++k) {
2956 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2957 "(res)sgat=%d low_dma=%d\n", k + 1,
2958 sg_jif_to_ms(fp->timeout),
2959 fp->reserve.bufflen,
2960 (int) fp->reserve.k_use_sg,
2962 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2963 (int) fp->cmd_q, (int) fp->force_packid,
2964 (int) fp->keep_orphan, (int) fp->closed);
2965 for (m = 0; (srp = sg_get_nth_request(fp, m)); ++m) {
2967 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2968 if (srp->res_used) {
2969 if (new_interface &&
2970 (SG_FLAG_MMAP_IO & hp->flags))
2975 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2981 blen = srp->my_cmdp ?
2982 srp->my_cmdp->sr_bufflen : srp->data.bufflen;
2983 usg = srp->my_cmdp ?
2984 srp->my_cmdp->sr_use_sg : srp->data.k_use_sg;
2985 seq_printf(s, srp->done ?
2986 ((1 == srp->done) ? "rcv:" : "fin:")
2987 : (srp->my_cmdp ? "act:" : "prior:"));
2988 seq_printf(s, " id=%d blen=%d",
2989 srp->header.pack_id, blen);
2991 seq_printf(s, " dur=%d", hp->duration);
2993 seq_printf(s, " t_o/elap=%d/%d",
2994 new_interface ? hp->timeout : sg_jif_to_ms(fp->timeout),
2995 sg_jif_to_ms(hp->duration ? (jiffies - hp->duration) : 0));
2996 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2997 (int) srp->data.cmd_opcode);
3000 seq_printf(s, " No requests active\n");
3004 static int sg_proc_open_debug(struct inode *inode, struct file *file)
3006 return seq_open(file, &debug_seq_ops);
3009 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
3011 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
3014 if (it && (0 == it->index)) {
3015 seq_printf(s, "dev_max(currently)=%d max_active_device=%d "
3016 "(origin 1)\n", sg_dev_max, (int)it->max);
3017 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
3019 sdp = it ? sg_get_dev(it->index) : NULL;
3021 struct scsi_device *scsidp = sdp->device;
3023 if (NULL == scsidp) {
3024 seq_printf(s, "device %d detached ??\n",
3029 if (sg_get_nth_sfp(sdp, 0)) {
3030 seq_printf(s, " >>> device=%s ",
3031 sdp->disk->disk_name);
3033 seq_printf(s, "detached pending close ");
3036 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
3037 scsidp->host->host_no,
3038 scsidp->channel, scsidp->id,
3040 scsidp->host->hostt->emulated);
3041 seq_printf(s, " sg_tablesize=%d excl=%d\n",
3042 sdp->sg_tablesize, sdp->exclude);
3044 sg_proc_debug_helper(s, sdp);
3049 #endif /* CONFIG_SCSI_PROC_FS */
3051 module_init(init_sg);
3052 module_exit(exit_sg);
3053 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);