[PATCH] sg: use compound pages
[safe/jmp/linux-2.6] / drivers / scsi / sg.c
1 /*
2  *  History:
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
6  *
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
11  *
12  *  Modified  19-JAN-1998  Richard Gooch <rgooch@atnf.csiro.au>  Devfs support
13  *
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)
17  * any later version.
18  *
19  */
20
21 static int sg_version_num = 30533;      /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.33"
23
24 /*
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).
29  *
30  */
31 #include <linux/config.h>
32 #include <linux/module.h>
33
34 #include <linux/fs.h>
35 #include <linux/kernel.h>
36 #include <linux/sched.h>
37 #include <linux/string.h>
38 #include <linux/mm.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/smp_lock.h>
46 #include <linux/moduleparam.h>
47 #include <linux/devfs_fs_kernel.h>
48 #include <linux/cdev.h>
49 #include <linux/seq_file.h>
50 #include <linux/blkdev.h>
51 #include <linux/delay.h>
52 #include <linux/scatterlist.h>
53
54 #include "scsi.h"
55 #include <scsi/scsi_dbg.h>
56 #include <scsi/scsi_host.h>
57 #include <scsi/scsi_driver.h>
58 #include <scsi/scsi_ioctl.h>
59 #include <scsi/sg.h>
60
61 #include "scsi_logging.h"
62
63 #ifdef CONFIG_SCSI_PROC_FS
64 #include <linux/proc_fs.h>
65 static char *sg_version_date = "20050908";
66
67 static int sg_proc_init(void);
68 static void sg_proc_cleanup(void);
69 #endif
70
71 #define SG_ALLOW_DIO_DEF 0
72 #define SG_ALLOW_DIO_CODE /* compile out by commenting this define */
73
74 #define SG_MAX_DEVS 32768
75
76 /*
77  * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
78  * Then when using 32 bit integers x * m may overflow during the calculation.
79  * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
80  * calculates the same, but prevents the overflow when both m and d
81  * are "small" numbers (like HZ and USER_HZ).
82  * Of course an overflow is inavoidable if the result of muldiv doesn't fit
83  * in 32 bits.
84  */
85 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
86
87 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
88
89 int sg_big_buff = SG_DEF_RESERVED_SIZE;
90 /* N.B. This variable is readable and writeable via
91    /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
92    of this size (or less if there is not enough memory) will be reserved
93    for use by this file descriptor. [Deprecated usage: this variable is also
94    readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
95    the kernel (i.e. it is not a module).] */
96 static int def_reserved_size = -1;      /* picks up init parameter */
97 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
98
99 #define SG_SECTOR_SZ 512
100 #define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
101
102 #define SG_DEV_ARR_LUMP 32      /* amount to over allocate sg_dev_arr by */
103
104 static int sg_add(struct class_device *, struct class_interface *);
105 static void sg_remove(struct class_device *, struct class_interface *);
106
107 static DEFINE_RWLOCK(sg_dev_arr_lock);  /* Also used to lock
108                                                            file descriptor list for device */
109
110 static struct class_interface sg_interface = {
111         .add            = sg_add,
112         .remove         = sg_remove,
113 };
114
115 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
116         unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
117         unsigned short sglist_len; /* size of malloc'd scatter-gather list ++ */
118         unsigned bufflen;       /* Size of (aggregate) data buffer */
119         unsigned b_malloc_len;  /* actual len malloc'ed in buffer */
120         struct scatterlist *buffer;/* scatter list */
121         char dio_in_use;        /* 0->indirect IO (or mmap), 1->dio */
122         unsigned char cmd_opcode; /* first byte of command */
123 } Sg_scatter_hold;
124
125 struct sg_device;               /* forward declarations */
126 struct sg_fd;
127
128 typedef struct sg_request {     /* SG_MAX_QUEUE requests outstanding per file */
129         struct sg_request *nextrp;      /* NULL -> tail request (slist) */
130         struct sg_fd *parentfp; /* NULL -> not in use */
131         Sg_scatter_hold data;   /* hold buffer, perhaps scatter list */
132         sg_io_hdr_t header;     /* scsi command+info, see <scsi/sg.h> */
133         unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
134         char res_used;          /* 1 -> using reserve buffer, 0 -> not ... */
135         char orphan;            /* 1 -> drop on sight, 0 -> normal */
136         char sg_io_owned;       /* 1 -> packet belongs to SG_IO */
137         volatile char done;     /* 0->before bh, 1->before read, 2->read */
138 } Sg_request;
139
140 typedef struct sg_fd {          /* holds the state of a file descriptor */
141         struct sg_fd *nextfp;   /* NULL when last opened fd on this device */
142         struct sg_device *parentdp;     /* owning device */
143         wait_queue_head_t read_wait;    /* queue read until command done */
144         rwlock_t rq_list_lock;  /* protect access to list in req_arr */
145         int timeout;            /* defaults to SG_DEFAULT_TIMEOUT      */
146         int timeout_user;       /* defaults to SG_DEFAULT_TIMEOUT_USER */
147         Sg_scatter_hold reserve;        /* buffer held for this file descriptor */
148         unsigned save_scat_len; /* original length of trunc. scat. element */
149         Sg_request *headrp;     /* head of request slist, NULL->empty */
150         struct fasync_struct *async_qp; /* used by asynchronous notification */
151         Sg_request req_arr[SG_MAX_QUEUE];       /* used as singly-linked list */
152         char low_dma;           /* as in parent but possibly overridden to 1 */
153         char force_packid;      /* 1 -> pack_id input to read(), 0 -> ignored */
154         volatile char closed;   /* 1 -> fd closed but request(s) outstanding */
155         char cmd_q;             /* 1 -> allow command queuing, 0 -> don't */
156         char next_cmd_len;      /* 0 -> automatic (def), >0 -> use on next write() */
157         char keep_orphan;       /* 0 -> drop orphan (def), 1 -> keep for read() */
158         char mmap_called;       /* 0 -> mmap() never called on this fd */
159 } Sg_fd;
160
161 typedef struct sg_device { /* holds the state of each scsi generic device */
162         struct scsi_device *device;
163         wait_queue_head_t o_excl_wait;  /* queue open() when O_EXCL in use */
164         int sg_tablesize;       /* adapter's max scatter-gather table size */
165         Sg_fd *headfp;          /* first open fd belonging to this device */
166         volatile char detached; /* 0->attached, 1->detached pending removal */
167         volatile char exclude;  /* opened for exclusive access */
168         char sgdebug;           /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
169         struct gendisk *disk;
170         struct cdev * cdev;     /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
171 } Sg_device;
172
173 static int sg_fasync(int fd, struct file *filp, int mode);
174 /* tasklet or soft irq callback */
175 static void sg_cmd_done(void *data, char *sense, int result, int resid);
176 static int sg_start_req(Sg_request * srp);
177 static void sg_finish_rem_req(Sg_request * srp);
178 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
179 static int sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp,
180                          int tablesize);
181 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
182                            Sg_request * srp);
183 static ssize_t sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
184                             int blocking, int read_only, Sg_request ** o_srp);
185 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
186                            unsigned char *cmnd, int timeout, int blocking);
187 static int sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
188                       int wr_xf, int *countp, unsigned char __user **up);
189 static int sg_write_xfer(Sg_request * srp);
190 static int sg_read_xfer(Sg_request * srp);
191 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
192 static void sg_remove_scat(Sg_scatter_hold * schp);
193 static void sg_build_reserve(Sg_fd * sfp, int req_size);
194 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
195 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
196 static struct page *sg_page_malloc(int rqSz, int lowDma, int *retSzp);
197 static void sg_page_free(struct page *page, int size);
198 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
199 static int sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
200 static void __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
201 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
202 static Sg_request *sg_add_request(Sg_fd * sfp);
203 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
204 static int sg_res_in_use(Sg_fd * sfp);
205 static int sg_allow_access(unsigned char opcode, char dev_type);
206 static int sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len);
207 static Sg_device *sg_get_dev(int dev);
208 #ifdef CONFIG_SCSI_PROC_FS
209 static int sg_last_dev(void);
210 #endif
211
212 static Sg_device **sg_dev_arr = NULL;
213 static int sg_dev_max;
214 static int sg_nr_dev;
215
216 #define SZ_SG_HEADER sizeof(struct sg_header)
217 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
218 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
219 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
220
221 static int
222 sg_open(struct inode *inode, struct file *filp)
223 {
224         int dev = iminor(inode);
225         int flags = filp->f_flags;
226         struct request_queue *q;
227         Sg_device *sdp;
228         Sg_fd *sfp;
229         int res;
230         int retval;
231
232         nonseekable_open(inode, filp);
233         SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
234         sdp = sg_get_dev(dev);
235         if ((!sdp) || (!sdp->device))
236                 return -ENXIO;
237         if (sdp->detached)
238                 return -ENODEV;
239
240         /* This driver's module count bumped by fops_get in <linux/fs.h> */
241         /* Prevent the device driver from vanishing while we sleep */
242         retval = scsi_device_get(sdp->device);
243         if (retval)
244                 return retval;
245
246         if (!((flags & O_NONBLOCK) ||
247               scsi_block_when_processing_errors(sdp->device))) {
248                 retval = -ENXIO;
249                 /* we are in error recovery for this device */
250                 goto error_out;
251         }
252
253         if (flags & O_EXCL) {
254                 if (O_RDONLY == (flags & O_ACCMODE)) {
255                         retval = -EPERM; /* Can't lock it with read only access */
256                         goto error_out;
257                 }
258                 if (sdp->headfp && (flags & O_NONBLOCK)) {
259                         retval = -EBUSY;
260                         goto error_out;
261                 }
262                 res = 0;
263                 __wait_event_interruptible(sdp->o_excl_wait,
264                         ((sdp->headfp || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
265                 if (res) {
266                         retval = res;   /* -ERESTARTSYS because signal hit process */
267                         goto error_out;
268                 }
269         } else if (sdp->exclude) {      /* some other fd has an exclusive lock on dev */
270                 if (flags & O_NONBLOCK) {
271                         retval = -EBUSY;
272                         goto error_out;
273                 }
274                 res = 0;
275                 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
276                                            res);
277                 if (res) {
278                         retval = res;   /* -ERESTARTSYS because signal hit process */
279                         goto error_out;
280                 }
281         }
282         if (sdp->detached) {
283                 retval = -ENODEV;
284                 goto error_out;
285         }
286         if (!sdp->headfp) {     /* no existing opens on this device */
287                 sdp->sgdebug = 0;
288                 q = sdp->device->request_queue;
289                 sdp->sg_tablesize = min(q->max_hw_segments,
290                                         q->max_phys_segments);
291         }
292         if ((sfp = sg_add_sfp(sdp, dev)))
293                 filp->private_data = sfp;
294         else {
295                 if (flags & O_EXCL)
296                         sdp->exclude = 0;       /* undo if error */
297                 retval = -ENOMEM;
298                 goto error_out;
299         }
300         return 0;
301
302       error_out:
303         scsi_device_put(sdp->device);
304         return retval;
305 }
306
307 /* Following function was formerly called 'sg_close' */
308 static int
309 sg_release(struct inode *inode, struct file *filp)
310 {
311         Sg_device *sdp;
312         Sg_fd *sfp;
313
314         if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
315                 return -ENXIO;
316         SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
317         sg_fasync(-1, filp, 0); /* remove filp from async notification list */
318         if (0 == sg_remove_sfp(sdp, sfp)) {     /* Returns 1 when sdp gone */
319                 if (!sdp->detached) {
320                         scsi_device_put(sdp->device);
321                 }
322                 sdp->exclude = 0;
323                 wake_up_interruptible(&sdp->o_excl_wait);
324         }
325         return 0;
326 }
327
328 static ssize_t
329 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
330 {
331         Sg_device *sdp;
332         Sg_fd *sfp;
333         Sg_request *srp;
334         int req_pack_id = -1;
335         sg_io_hdr_t *hp;
336         struct sg_header *old_hdr = NULL;
337         int retval = 0;
338
339         if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
340                 return -ENXIO;
341         SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
342                                    sdp->disk->disk_name, (int) count));
343
344         if (!access_ok(VERIFY_WRITE, buf, count))
345                 return -EFAULT;
346         if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
347                 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
348                 if (!old_hdr)
349                         return -ENOMEM;
350                 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
351                         retval = -EFAULT;
352                         goto free_old_hdr;
353                 }
354                 if (old_hdr->reply_len < 0) {
355                         if (count >= SZ_SG_IO_HDR) {
356                                 sg_io_hdr_t *new_hdr;
357                                 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
358                                 if (!new_hdr) {
359                                         retval = -ENOMEM;
360                                         goto free_old_hdr;
361                                 }
362                                 retval =__copy_from_user
363                                     (new_hdr, buf, SZ_SG_IO_HDR);
364                                 req_pack_id = new_hdr->pack_id;
365                                 kfree(new_hdr);
366                                 if (retval) {
367                                         retval = -EFAULT;
368                                         goto free_old_hdr;
369                                 }
370                         }
371                 } else
372                         req_pack_id = old_hdr->pack_id;
373         }
374         srp = sg_get_rq_mark(sfp, req_pack_id);
375         if (!srp) {             /* now wait on packet to arrive */
376                 if (sdp->detached) {
377                         retval = -ENODEV;
378                         goto free_old_hdr;
379                 }
380                 if (filp->f_flags & O_NONBLOCK) {
381                         retval = -EAGAIN;
382                         goto free_old_hdr;
383                 }
384                 while (1) {
385                         retval = 0; /* following macro beats race condition */
386                         __wait_event_interruptible(sfp->read_wait,
387                                 (sdp->detached ||
388                                 (srp = sg_get_rq_mark(sfp, req_pack_id))), 
389                                 retval);
390                         if (sdp->detached) {
391                                 retval = -ENODEV;
392                                 goto free_old_hdr;
393                         }
394                         if (0 == retval)
395                                 break;
396
397                         /* -ERESTARTSYS as signal hit process */
398                         goto free_old_hdr;
399                 }
400         }
401         if (srp->header.interface_id != '\0') {
402                 retval = sg_new_read(sfp, buf, count, srp);
403                 goto free_old_hdr;
404         }
405
406         hp = &srp->header;
407         if (old_hdr == NULL) {
408                 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
409                 if (! old_hdr) {
410                         retval = -ENOMEM;
411                         goto free_old_hdr;
412                 }
413         }
414         memset(old_hdr, 0, SZ_SG_HEADER);
415         old_hdr->reply_len = (int) hp->timeout;
416         old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
417         old_hdr->pack_id = hp->pack_id;
418         old_hdr->twelve_byte =
419             ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
420         old_hdr->target_status = hp->masked_status;
421         old_hdr->host_status = hp->host_status;
422         old_hdr->driver_status = hp->driver_status;
423         if ((CHECK_CONDITION & hp->masked_status) ||
424             (DRIVER_SENSE & hp->driver_status))
425                 memcpy(old_hdr->sense_buffer, srp->sense_b,
426                        sizeof (old_hdr->sense_buffer));
427         switch (hp->host_status) {
428         /* This setup of 'result' is for backward compatibility and is best
429            ignored by the user who should use target, host + driver status */
430         case DID_OK:
431         case DID_PASSTHROUGH:
432         case DID_SOFT_ERROR:
433                 old_hdr->result = 0;
434                 break;
435         case DID_NO_CONNECT:
436         case DID_BUS_BUSY:
437         case DID_TIME_OUT:
438                 old_hdr->result = EBUSY;
439                 break;
440         case DID_BAD_TARGET:
441         case DID_ABORT:
442         case DID_PARITY:
443         case DID_RESET:
444         case DID_BAD_INTR:
445                 old_hdr->result = EIO;
446                 break;
447         case DID_ERROR:
448                 old_hdr->result = (srp->sense_b[0] == 0 && 
449                                   hp->masked_status == GOOD) ? 0 : EIO;
450                 break;
451         default:
452                 old_hdr->result = EIO;
453                 break;
454         }
455
456         /* Now copy the result back to the user buffer.  */
457         if (count >= SZ_SG_HEADER) {
458                 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
459                         retval = -EFAULT;
460                         goto free_old_hdr;
461                 }
462                 buf += SZ_SG_HEADER;
463                 if (count > old_hdr->reply_len)
464                         count = old_hdr->reply_len;
465                 if (count > SZ_SG_HEADER) {
466                         if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
467                                 retval = -EFAULT;
468                                 goto free_old_hdr;
469                         }
470                 }
471         } else
472                 count = (old_hdr->result == 0) ? 0 : -EIO;
473         sg_finish_rem_req(srp);
474         retval = count;
475 free_old_hdr:
476         kfree(old_hdr);
477         return retval;
478 }
479
480 static ssize_t
481 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
482 {
483         sg_io_hdr_t *hp = &srp->header;
484         int err = 0;
485         int len;
486
487         if (count < SZ_SG_IO_HDR) {
488                 err = -EINVAL;
489                 goto err_out;
490         }
491         hp->sb_len_wr = 0;
492         if ((hp->mx_sb_len > 0) && hp->sbp) {
493                 if ((CHECK_CONDITION & hp->masked_status) ||
494                     (DRIVER_SENSE & hp->driver_status)) {
495                         int sb_len = SCSI_SENSE_BUFFERSIZE;
496                         sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
497                         len = 8 + (int) srp->sense_b[7];        /* Additional sense length field */
498                         len = (len > sb_len) ? sb_len : len;
499                         if (copy_to_user(hp->sbp, srp->sense_b, len)) {
500                                 err = -EFAULT;
501                                 goto err_out;
502                         }
503                         hp->sb_len_wr = len;
504                 }
505         }
506         if (hp->masked_status || hp->host_status || hp->driver_status)
507                 hp->info |= SG_INFO_CHECK;
508         if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
509                 err = -EFAULT;
510                 goto err_out;
511         }
512         err = sg_read_xfer(srp);
513       err_out:
514         sg_finish_rem_req(srp);
515         return (0 == err) ? count : err;
516 }
517
518 static ssize_t
519 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
520 {
521         int mxsize, cmd_size, k;
522         int input_size, blocking;
523         unsigned char opcode;
524         Sg_device *sdp;
525         Sg_fd *sfp;
526         Sg_request *srp;
527         struct sg_header old_hdr;
528         sg_io_hdr_t *hp;
529         unsigned char cmnd[MAX_COMMAND_SIZE];
530
531         if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
532                 return -ENXIO;
533         SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
534                                    sdp->disk->disk_name, (int) count));
535         if (sdp->detached)
536                 return -ENODEV;
537         if (!((filp->f_flags & O_NONBLOCK) ||
538               scsi_block_when_processing_errors(sdp->device)))
539                 return -ENXIO;
540
541         if (!access_ok(VERIFY_READ, buf, count))
542                 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
543         if (count < SZ_SG_HEADER)
544                 return -EIO;
545         if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
546                 return -EFAULT;
547         blocking = !(filp->f_flags & O_NONBLOCK);
548         if (old_hdr.reply_len < 0)
549                 return sg_new_write(sfp, buf, count, blocking, 0, NULL);
550         if (count < (SZ_SG_HEADER + 6))
551                 return -EIO;    /* The minimum scsi command length is 6 bytes. */
552
553         if (!(srp = sg_add_request(sfp))) {
554                 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
555                 return -EDOM;
556         }
557         buf += SZ_SG_HEADER;
558         __get_user(opcode, buf);
559         if (sfp->next_cmd_len > 0) {
560                 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
561                         SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
562                         sfp->next_cmd_len = 0;
563                         sg_remove_request(sfp, srp);
564                         return -EIO;
565                 }
566                 cmd_size = sfp->next_cmd_len;
567                 sfp->next_cmd_len = 0;  /* reset so only this write() effected */
568         } else {
569                 cmd_size = COMMAND_SIZE(opcode);        /* based on SCSI command group */
570                 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
571                         cmd_size = 12;
572         }
573         SCSI_LOG_TIMEOUT(4, printk(
574                 "sg_write:   scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
575 /* Determine buffer size.  */
576         input_size = count - cmd_size;
577         mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
578         mxsize -= SZ_SG_HEADER;
579         input_size -= SZ_SG_HEADER;
580         if (input_size < 0) {
581                 sg_remove_request(sfp, srp);
582                 return -EIO;    /* User did not pass enough bytes for this command. */
583         }
584         hp = &srp->header;
585         hp->interface_id = '\0';        /* indicator of old interface tunnelled */
586         hp->cmd_len = (unsigned char) cmd_size;
587         hp->iovec_count = 0;
588         hp->mx_sb_len = 0;
589         if (input_size > 0)
590                 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
591                     SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
592         else
593                 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
594         hp->dxfer_len = mxsize;
595         hp->dxferp = (char __user *)buf + cmd_size;
596         hp->sbp = NULL;
597         hp->timeout = old_hdr.reply_len;        /* structure abuse ... */
598         hp->flags = input_size; /* structure abuse ... */
599         hp->pack_id = old_hdr.pack_id;
600         hp->usr_ptr = NULL;
601         if (__copy_from_user(cmnd, buf, cmd_size))
602                 return -EFAULT;
603         /*
604          * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
605          * but is is possible that the app intended SG_DXFER_TO_DEV, because there
606          * is a non-zero input_size, so emit a warning.
607          */
608         if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV)
609                 if (printk_ratelimit())
610                         printk(KERN_WARNING
611                                "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
612                                "guessing data in;\n" KERN_WARNING "   "
613                                "program %s not setting count and/or reply_len properly\n",
614                                old_hdr.reply_len - (int)SZ_SG_HEADER,
615                                input_size, (unsigned int) cmnd[0],
616                                current->comm);
617         k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
618         return (k < 0) ? k : count;
619 }
620
621 static ssize_t
622 sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
623              int blocking, int read_only, Sg_request ** o_srp)
624 {
625         int k;
626         Sg_request *srp;
627         sg_io_hdr_t *hp;
628         unsigned char cmnd[MAX_COMMAND_SIZE];
629         int timeout;
630         unsigned long ul_timeout;
631
632         if (count < SZ_SG_IO_HDR)
633                 return -EINVAL;
634         if (!access_ok(VERIFY_READ, buf, count))
635                 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
636
637         sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
638         if (!(srp = sg_add_request(sfp))) {
639                 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
640                 return -EDOM;
641         }
642         hp = &srp->header;
643         if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
644                 sg_remove_request(sfp, srp);
645                 return -EFAULT;
646         }
647         if (hp->interface_id != 'S') {
648                 sg_remove_request(sfp, srp);
649                 return -ENOSYS;
650         }
651         if (hp->flags & SG_FLAG_MMAP_IO) {
652                 if (hp->dxfer_len > sfp->reserve.bufflen) {
653                         sg_remove_request(sfp, srp);
654                         return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
655                 }
656                 if (hp->flags & SG_FLAG_DIRECT_IO) {
657                         sg_remove_request(sfp, srp);
658                         return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
659                 }
660                 if (sg_res_in_use(sfp)) {
661                         sg_remove_request(sfp, srp);
662                         return -EBUSY;  /* reserve buffer already being used */
663                 }
664         }
665         ul_timeout = msecs_to_jiffies(srp->header.timeout);
666         timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
667         if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
668                 sg_remove_request(sfp, srp);
669                 return -EMSGSIZE;
670         }
671         if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
672                 sg_remove_request(sfp, srp);
673                 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
674         }
675         if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
676                 sg_remove_request(sfp, srp);
677                 return -EFAULT;
678         }
679         if (read_only &&
680             (!sg_allow_access(cmnd[0], sfp->parentdp->device->type))) {
681                 sg_remove_request(sfp, srp);
682                 return -EPERM;
683         }
684         k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
685         if (k < 0)
686                 return k;
687         if (o_srp)
688                 *o_srp = srp;
689         return count;
690 }
691
692 static int
693 sg_common_write(Sg_fd * sfp, Sg_request * srp,
694                 unsigned char *cmnd, int timeout, int blocking)
695 {
696         int k, data_dir;
697         Sg_device *sdp = sfp->parentdp;
698         sg_io_hdr_t *hp = &srp->header;
699
700         srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
701         hp->status = 0;
702         hp->masked_status = 0;
703         hp->msg_status = 0;
704         hp->info = 0;
705         hp->host_status = 0;
706         hp->driver_status = 0;
707         hp->resid = 0;
708         SCSI_LOG_TIMEOUT(4, printk("sg_common_write:  scsi opcode=0x%02x, cmd_size=%d\n",
709                           (int) cmnd[0], (int) hp->cmd_len));
710
711         if ((k = sg_start_req(srp))) {
712                 SCSI_LOG_TIMEOUT(1, printk("sg_write: start_req err=%d\n", k));
713                 sg_finish_rem_req(srp);
714                 return k;       /* probably out of space --> ENOMEM */
715         }
716         if ((k = sg_write_xfer(srp))) {
717                 SCSI_LOG_TIMEOUT(1, printk("sg_write: write_xfer, bad address\n"));
718                 sg_finish_rem_req(srp);
719                 return k;
720         }
721         if (sdp->detached) {
722                 sg_finish_rem_req(srp);
723                 return -ENODEV;
724         }
725
726         switch (hp->dxfer_direction) {
727         case SG_DXFER_TO_FROM_DEV:
728         case SG_DXFER_FROM_DEV:
729                 data_dir = DMA_FROM_DEVICE;
730                 break;
731         case SG_DXFER_TO_DEV:
732                 data_dir = DMA_TO_DEVICE;
733                 break;
734         case SG_DXFER_UNKNOWN:
735                 data_dir = DMA_BIDIRECTIONAL;
736                 break;
737         default:
738                 data_dir = DMA_NONE;
739                 break;
740         }
741         hp->duration = jiffies_to_msecs(jiffies);
742 /* Now send everything of to mid-level. The next time we hear about this
743    packet is when sg_cmd_done() is called (i.e. a callback). */
744         if (scsi_execute_async(sdp->device, cmnd, hp->cmd_len, data_dir, srp->data.buffer,
745                                 hp->dxfer_len, srp->data.k_use_sg, timeout,
746                                 SG_DEFAULT_RETRIES, srp, sg_cmd_done,
747                                 GFP_ATOMIC)) {
748                 SCSI_LOG_TIMEOUT(1, printk("sg_write: scsi_execute_async failed\n"));
749                 /*
750                  * most likely out of mem, but could also be a bad map
751                  */
752                 return -ENOMEM;
753         } else
754                 return 0;
755 }
756
757 static int
758 sg_srp_done(Sg_request *srp, Sg_fd *sfp)
759 {
760         unsigned long iflags;
761         int done;
762
763         read_lock_irqsave(&sfp->rq_list_lock, iflags);
764         done = srp->done;
765         read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
766         return done;
767 }
768
769 static int
770 sg_ioctl(struct inode *inode, struct file *filp,
771          unsigned int cmd_in, unsigned long arg)
772 {
773         void __user *p = (void __user *)arg;
774         int __user *ip = p;
775         int result, val, read_only;
776         Sg_device *sdp;
777         Sg_fd *sfp;
778         Sg_request *srp;
779         unsigned long iflags;
780
781         if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
782                 return -ENXIO;
783         SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
784                                    sdp->disk->disk_name, (int) cmd_in));
785         read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
786
787         switch (cmd_in) {
788         case SG_IO:
789                 {
790                         int blocking = 1;       /* ignore O_NONBLOCK flag */
791
792                         if (sdp->detached)
793                                 return -ENODEV;
794                         if (!scsi_block_when_processing_errors(sdp->device))
795                                 return -ENXIO;
796                         if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
797                                 return -EFAULT;
798                         result =
799                             sg_new_write(sfp, p, SZ_SG_IO_HDR,
800                                          blocking, read_only, &srp);
801                         if (result < 0)
802                                 return result;
803                         srp->sg_io_owned = 1;
804                         while (1) {
805                                 result = 0;     /* following macro to beat race condition */
806                                 __wait_event_interruptible(sfp->read_wait,
807                                         (sdp->detached || sfp->closed || sg_srp_done(srp, sfp)),
808                                                            result);
809                                 if (sdp->detached)
810                                         return -ENODEV;
811                                 if (sfp->closed)
812                                         return 0;       /* request packet dropped already */
813                                 if (0 == result)
814                                         break;
815                                 srp->orphan = 1;
816                                 return result;  /* -ERESTARTSYS because signal hit process */
817                         }
818                         write_lock_irqsave(&sfp->rq_list_lock, iflags);
819                         srp->done = 2;
820                         write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
821                         result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
822                         return (result < 0) ? result : 0;
823                 }
824         case SG_SET_TIMEOUT:
825                 result = get_user(val, ip);
826                 if (result)
827                         return result;
828                 if (val < 0)
829                         return -EIO;
830                 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
831                     val = MULDIV (INT_MAX, USER_HZ, HZ);
832                 sfp->timeout_user = val;
833                 sfp->timeout = MULDIV (val, HZ, USER_HZ);
834
835                 return 0;
836         case SG_GET_TIMEOUT:    /* N.B. User receives timeout as return value */
837                                 /* strange ..., for backward compatibility */
838                 return sfp->timeout_user;
839         case SG_SET_FORCE_LOW_DMA:
840                 result = get_user(val, ip);
841                 if (result)
842                         return result;
843                 if (val) {
844                         sfp->low_dma = 1;
845                         if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
846                                 val = (int) sfp->reserve.bufflen;
847                                 sg_remove_scat(&sfp->reserve);
848                                 sg_build_reserve(sfp, val);
849                         }
850                 } else {
851                         if (sdp->detached)
852                                 return -ENODEV;
853                         sfp->low_dma = sdp->device->host->unchecked_isa_dma;
854                 }
855                 return 0;
856         case SG_GET_LOW_DMA:
857                 return put_user((int) sfp->low_dma, ip);
858         case SG_GET_SCSI_ID:
859                 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
860                         return -EFAULT;
861                 else {
862                         sg_scsi_id_t __user *sg_idp = p;
863
864                         if (sdp->detached)
865                                 return -ENODEV;
866                         __put_user((int) sdp->device->host->host_no,
867                                    &sg_idp->host_no);
868                         __put_user((int) sdp->device->channel,
869                                    &sg_idp->channel);
870                         __put_user((int) sdp->device->id, &sg_idp->scsi_id);
871                         __put_user((int) sdp->device->lun, &sg_idp->lun);
872                         __put_user((int) sdp->device->type, &sg_idp->scsi_type);
873                         __put_user((short) sdp->device->host->cmd_per_lun,
874                                    &sg_idp->h_cmd_per_lun);
875                         __put_user((short) sdp->device->queue_depth,
876                                    &sg_idp->d_queue_depth);
877                         __put_user(0, &sg_idp->unused[0]);
878                         __put_user(0, &sg_idp->unused[1]);
879                         return 0;
880                 }
881         case SG_SET_FORCE_PACK_ID:
882                 result = get_user(val, ip);
883                 if (result)
884                         return result;
885                 sfp->force_packid = val ? 1 : 0;
886                 return 0;
887         case SG_GET_PACK_ID:
888                 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
889                         return -EFAULT;
890                 read_lock_irqsave(&sfp->rq_list_lock, iflags);
891                 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
892                         if ((1 == srp->done) && (!srp->sg_io_owned)) {
893                                 read_unlock_irqrestore(&sfp->rq_list_lock,
894                                                        iflags);
895                                 __put_user(srp->header.pack_id, ip);
896                                 return 0;
897                         }
898                 }
899                 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
900                 __put_user(-1, ip);
901                 return 0;
902         case SG_GET_NUM_WAITING:
903                 read_lock_irqsave(&sfp->rq_list_lock, iflags);
904                 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
905                         if ((1 == srp->done) && (!srp->sg_io_owned))
906                                 ++val;
907                 }
908                 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
909                 return put_user(val, ip);
910         case SG_GET_SG_TABLESIZE:
911                 return put_user(sdp->sg_tablesize, ip);
912         case SG_SET_RESERVED_SIZE:
913                 result = get_user(val, ip);
914                 if (result)
915                         return result;
916                 if (val < 0)
917                         return -EINVAL;
918                 if (val != sfp->reserve.bufflen) {
919                         if (sg_res_in_use(sfp) || sfp->mmap_called)
920                                 return -EBUSY;
921                         sg_remove_scat(&sfp->reserve);
922                         sg_build_reserve(sfp, val);
923                 }
924                 return 0;
925         case SG_GET_RESERVED_SIZE:
926                 val = (int) sfp->reserve.bufflen;
927                 return put_user(val, ip);
928         case SG_SET_COMMAND_Q:
929                 result = get_user(val, ip);
930                 if (result)
931                         return result;
932                 sfp->cmd_q = val ? 1 : 0;
933                 return 0;
934         case SG_GET_COMMAND_Q:
935                 return put_user((int) sfp->cmd_q, ip);
936         case SG_SET_KEEP_ORPHAN:
937                 result = get_user(val, ip);
938                 if (result)
939                         return result;
940                 sfp->keep_orphan = val;
941                 return 0;
942         case SG_GET_KEEP_ORPHAN:
943                 return put_user((int) sfp->keep_orphan, ip);
944         case SG_NEXT_CMD_LEN:
945                 result = get_user(val, ip);
946                 if (result)
947                         return result;
948                 sfp->next_cmd_len = (val > 0) ? val : 0;
949                 return 0;
950         case SG_GET_VERSION_NUM:
951                 return put_user(sg_version_num, ip);
952         case SG_GET_ACCESS_COUNT:
953                 /* faked - we don't have a real access count anymore */
954                 val = (sdp->device ? 1 : 0);
955                 return put_user(val, ip);
956         case SG_GET_REQUEST_TABLE:
957                 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
958                         return -EFAULT;
959                 else {
960                         sg_req_info_t *rinfo;
961                         unsigned int ms;
962
963                         rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
964                                                                 GFP_KERNEL);
965                         if (!rinfo)
966                                 return -ENOMEM;
967                         read_lock_irqsave(&sfp->rq_list_lock, iflags);
968                         for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
969                              ++val, srp = srp ? srp->nextrp : srp) {
970                                 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
971                                 if (srp) {
972                                         rinfo[val].req_state = srp->done + 1;
973                                         rinfo[val].problem =
974                                             srp->header.masked_status & 
975                                             srp->header.host_status & 
976                                             srp->header.driver_status;
977                                         if (srp->done)
978                                                 rinfo[val].duration =
979                                                         srp->header.duration;
980                                         else {
981                                                 ms = jiffies_to_msecs(jiffies);
982                                                 rinfo[val].duration =
983                                                     (ms > srp->header.duration) ?
984                                                     (ms - srp->header.duration) : 0;
985                                         }
986                                         rinfo[val].orphan = srp->orphan;
987                                         rinfo[val].sg_io_owned =
988                                                         srp->sg_io_owned;
989                                         rinfo[val].pack_id =
990                                                         srp->header.pack_id;
991                                         rinfo[val].usr_ptr =
992                                                         srp->header.usr_ptr;
993                                 }
994                         }
995                         read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
996                         result = __copy_to_user(p, rinfo, 
997                                                 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
998                         result = result ? -EFAULT : 0;
999                         kfree(rinfo);
1000                         return result;
1001                 }
1002         case SG_EMULATED_HOST:
1003                 if (sdp->detached)
1004                         return -ENODEV;
1005                 return put_user(sdp->device->host->hostt->emulated, ip);
1006         case SG_SCSI_RESET:
1007                 if (sdp->detached)
1008                         return -ENODEV;
1009                 if (filp->f_flags & O_NONBLOCK) {
1010                         if (scsi_host_in_recovery(sdp->device->host))
1011                                 return -EBUSY;
1012                 } else if (!scsi_block_when_processing_errors(sdp->device))
1013                         return -EBUSY;
1014                 result = get_user(val, ip);
1015                 if (result)
1016                         return result;
1017                 if (SG_SCSI_RESET_NOTHING == val)
1018                         return 0;
1019                 switch (val) {
1020                 case SG_SCSI_RESET_DEVICE:
1021                         val = SCSI_TRY_RESET_DEVICE;
1022                         break;
1023                 case SG_SCSI_RESET_BUS:
1024                         val = SCSI_TRY_RESET_BUS;
1025                         break;
1026                 case SG_SCSI_RESET_HOST:
1027                         val = SCSI_TRY_RESET_HOST;
1028                         break;
1029                 default:
1030                         return -EINVAL;
1031                 }
1032                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1033                         return -EACCES;
1034                 return (scsi_reset_provider(sdp->device, val) ==
1035                         SUCCESS) ? 0 : -EIO;
1036         case SCSI_IOCTL_SEND_COMMAND:
1037                 if (sdp->detached)
1038                         return -ENODEV;
1039                 if (read_only) {
1040                         unsigned char opcode = WRITE_6;
1041                         Scsi_Ioctl_Command __user *siocp = p;
1042
1043                         if (copy_from_user(&opcode, siocp->data, 1))
1044                                 return -EFAULT;
1045                         if (!sg_allow_access(opcode, sdp->device->type))
1046                                 return -EPERM;
1047                 }
1048                 return scsi_ioctl_send_command(sdp->device, p);
1049         case SG_SET_DEBUG:
1050                 result = get_user(val, ip);
1051                 if (result)
1052                         return result;
1053                 sdp->sgdebug = (char) val;
1054                 return 0;
1055         case SCSI_IOCTL_GET_IDLUN:
1056         case SCSI_IOCTL_GET_BUS_NUMBER:
1057         case SCSI_IOCTL_PROBE_HOST:
1058         case SG_GET_TRANSFORM:
1059                 if (sdp->detached)
1060                         return -ENODEV;
1061                 return scsi_ioctl(sdp->device, cmd_in, p);
1062         default:
1063                 if (read_only)
1064                         return -EPERM;  /* don't know so take safe approach */
1065                 return scsi_ioctl(sdp->device, cmd_in, p);
1066         }
1067 }
1068
1069 #ifdef CONFIG_COMPAT
1070 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1071 {
1072         Sg_device *sdp;
1073         Sg_fd *sfp;
1074         struct scsi_device *sdev;
1075
1076         if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1077                 return -ENXIO;
1078
1079         sdev = sdp->device;
1080         if (sdev->host->hostt->compat_ioctl) { 
1081                 int ret;
1082
1083                 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1084
1085                 return ret;
1086         }
1087         
1088         return -ENOIOCTLCMD;
1089 }
1090 #endif
1091
1092 static unsigned int
1093 sg_poll(struct file *filp, poll_table * wait)
1094 {
1095         unsigned int res = 0;
1096         Sg_device *sdp;
1097         Sg_fd *sfp;
1098         Sg_request *srp;
1099         int count = 0;
1100         unsigned long iflags;
1101
1102         if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1103             || sfp->closed)
1104                 return POLLERR;
1105         poll_wait(filp, &sfp->read_wait, wait);
1106         read_lock_irqsave(&sfp->rq_list_lock, iflags);
1107         for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1108                 /* if any read waiting, flag it */
1109                 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1110                         res = POLLIN | POLLRDNORM;
1111                 ++count;
1112         }
1113         read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1114
1115         if (sdp->detached)
1116                 res |= POLLHUP;
1117         else if (!sfp->cmd_q) {
1118                 if (0 == count)
1119                         res |= POLLOUT | POLLWRNORM;
1120         } else if (count < SG_MAX_QUEUE)
1121                 res |= POLLOUT | POLLWRNORM;
1122         SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1123                                    sdp->disk->disk_name, (int) res));
1124         return res;
1125 }
1126
1127 static int
1128 sg_fasync(int fd, struct file *filp, int mode)
1129 {
1130         int retval;
1131         Sg_device *sdp;
1132         Sg_fd *sfp;
1133
1134         if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1135                 return -ENXIO;
1136         SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1137                                    sdp->disk->disk_name, mode));
1138
1139         retval = fasync_helper(fd, filp, mode, &sfp->async_qp);
1140         return (retval < 0) ? retval : 0;
1141 }
1142
1143 static struct page *
1144 sg_vma_nopage(struct vm_area_struct *vma, unsigned long addr, int *type)
1145 {
1146         Sg_fd *sfp;
1147         struct page *page = NOPAGE_SIGBUS;
1148         unsigned long offset, len, sa;
1149         Sg_scatter_hold *rsv_schp;
1150         struct scatterlist *sg;
1151         int k;
1152
1153         if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1154                 return page;
1155         rsv_schp = &sfp->reserve;
1156         offset = addr - vma->vm_start;
1157         if (offset >= rsv_schp->bufflen)
1158                 return page;
1159         SCSI_LOG_TIMEOUT(3, printk("sg_vma_nopage: offset=%lu, scatg=%d\n",
1160                                    offset, rsv_schp->k_use_sg));
1161         sg = rsv_schp->buffer;
1162         sa = vma->vm_start;
1163         for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1164              ++k, ++sg) {
1165                 len = vma->vm_end - sa;
1166                 len = (len < sg->length) ? len : sg->length;
1167                 if (offset < len) {
1168                         page = sg->page;
1169                         get_page(page); /* increment page count */
1170                         break;
1171                 }
1172                 sa += len;
1173                 offset -= len;
1174         }
1175
1176         if (type)
1177                 *type = VM_FAULT_MINOR;
1178         return page;
1179 }
1180
1181 static struct vm_operations_struct sg_mmap_vm_ops = {
1182         .nopage = sg_vma_nopage,
1183 };
1184
1185 static int
1186 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1187 {
1188         Sg_fd *sfp;
1189         unsigned long req_sz, len, sa;
1190         Sg_scatter_hold *rsv_schp;
1191         int k;
1192         struct scatterlist *sg;
1193
1194         if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1195                 return -ENXIO;
1196         req_sz = vma->vm_end - vma->vm_start;
1197         SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1198                                    (void *) vma->vm_start, (int) req_sz));
1199         if (vma->vm_pgoff)
1200                 return -EINVAL; /* want no offset */
1201         rsv_schp = &sfp->reserve;
1202         if (req_sz > rsv_schp->bufflen)
1203                 return -ENOMEM; /* cannot map more than reserved buffer */
1204
1205         sa = vma->vm_start;
1206         sg = rsv_schp->buffer;
1207         for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1208              ++k, ++sg) {
1209                 len = vma->vm_end - sa;
1210                 len = (len < sg->length) ? len : sg->length;
1211                 sa += len;
1212         }
1213
1214         sfp->mmap_called = 1;
1215         vma->vm_flags |= VM_RESERVED;
1216         vma->vm_private_data = sfp;
1217         vma->vm_ops = &sg_mmap_vm_ops;
1218         return 0;
1219 }
1220
1221 /* This function is a "bottom half" handler that is called by the
1222  * mid level when a command is completed (or has failed). */
1223 static void
1224 sg_cmd_done(void *data, char *sense, int result, int resid)
1225 {
1226         Sg_request *srp = data;
1227         Sg_device *sdp = NULL;
1228         Sg_fd *sfp;
1229         unsigned long iflags;
1230         unsigned int ms;
1231
1232         if (NULL == srp) {
1233                 printk(KERN_ERR "sg_cmd_done: NULL request\n");
1234                 return;
1235         }
1236         sfp = srp->parentfp;
1237         if (sfp)
1238                 sdp = sfp->parentdp;
1239         if ((NULL == sdp) || sdp->detached) {
1240                 printk(KERN_INFO "sg_cmd_done: device detached\n");
1241                 return;
1242         }
1243
1244
1245         SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1246                 sdp->disk->disk_name, srp->header.pack_id, result));
1247         srp->header.resid = resid;
1248         ms = jiffies_to_msecs(jiffies);
1249         srp->header.duration = (ms > srp->header.duration) ?
1250                                 (ms - srp->header.duration) : 0;
1251         if (0 != result) {
1252                 struct scsi_sense_hdr sshdr;
1253
1254                 memcpy(srp->sense_b, sense, sizeof (srp->sense_b));
1255                 srp->header.status = 0xff & result;
1256                 srp->header.masked_status = status_byte(result);
1257                 srp->header.msg_status = msg_byte(result);
1258                 srp->header.host_status = host_byte(result);
1259                 srp->header.driver_status = driver_byte(result);
1260                 if ((sdp->sgdebug > 0) &&
1261                     ((CHECK_CONDITION == srp->header.masked_status) ||
1262                      (COMMAND_TERMINATED == srp->header.masked_status)))
1263                         __scsi_print_sense("sg_cmd_done", sense,
1264                                            SCSI_SENSE_BUFFERSIZE);
1265
1266                 /* Following if statement is a patch supplied by Eric Youngdale */
1267                 if (driver_byte(result) != 0
1268                     && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1269                     && !scsi_sense_is_deferred(&sshdr)
1270                     && sshdr.sense_key == UNIT_ATTENTION
1271                     && sdp->device->removable) {
1272                         /* Detected possible disc change. Set the bit - this */
1273                         /* may be used if there are filesystems using this device */
1274                         sdp->device->changed = 1;
1275                 }
1276         }
1277         /* Rely on write phase to clean out srp status values, so no "else" */
1278
1279         if (sfp->closed) {      /* whoops this fd already released, cleanup */
1280                 SCSI_LOG_TIMEOUT(1, printk("sg_cmd_done: already closed, freeing ...\n"));
1281                 sg_finish_rem_req(srp);
1282                 srp = NULL;
1283                 if (NULL == sfp->headrp) {
1284                         SCSI_LOG_TIMEOUT(1, printk("sg...bh: already closed, final cleanup\n"));
1285                         if (0 == sg_remove_sfp(sdp, sfp)) {     /* device still present */
1286                                 scsi_device_put(sdp->device);
1287                         }
1288                         sfp = NULL;
1289                 }
1290         } else if (srp && srp->orphan) {
1291                 if (sfp->keep_orphan)
1292                         srp->sg_io_owned = 0;
1293                 else {
1294                         sg_finish_rem_req(srp);
1295                         srp = NULL;
1296                 }
1297         }
1298         if (sfp && srp) {
1299                 /* Now wake up any sg_read() that is waiting for this packet. */
1300                 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1301                 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1302                 srp->done = 1;
1303                 wake_up_interruptible(&sfp->read_wait);
1304                 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1305         }
1306 }
1307
1308 static struct file_operations sg_fops = {
1309         .owner = THIS_MODULE,
1310         .read = sg_read,
1311         .write = sg_write,
1312         .poll = sg_poll,
1313         .ioctl = sg_ioctl,
1314 #ifdef CONFIG_COMPAT
1315         .compat_ioctl = sg_compat_ioctl,
1316 #endif
1317         .open = sg_open,
1318         .mmap = sg_mmap,
1319         .release = sg_release,
1320         .fasync = sg_fasync,
1321 };
1322
1323 static struct class *sg_sysfs_class;
1324
1325 static int sg_sysfs_valid = 0;
1326
1327 static int sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1328 {
1329         struct request_queue *q = scsidp->request_queue;
1330         Sg_device *sdp;
1331         unsigned long iflags;
1332         void *old_sg_dev_arr = NULL;
1333         int k, error;
1334
1335         sdp = kmalloc(sizeof(Sg_device), GFP_KERNEL);
1336         if (!sdp) {
1337                 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1338                 return -ENOMEM;
1339         }
1340
1341         write_lock_irqsave(&sg_dev_arr_lock, iflags);
1342         if (unlikely(sg_nr_dev >= sg_dev_max)) {        /* try to resize */
1343                 Sg_device **tmp_da;
1344                 int tmp_dev_max = sg_nr_dev + SG_DEV_ARR_LUMP;
1345                 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1346
1347                 tmp_da = kmalloc(tmp_dev_max * sizeof(Sg_device *), GFP_KERNEL);
1348                 if (unlikely(!tmp_da))
1349                         goto expand_failed;
1350
1351                 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1352                 memset(tmp_da, 0, tmp_dev_max * sizeof(Sg_device *));
1353                 memcpy(tmp_da, sg_dev_arr, sg_dev_max * sizeof(Sg_device *));
1354                 old_sg_dev_arr = sg_dev_arr;
1355                 sg_dev_arr = tmp_da;
1356                 sg_dev_max = tmp_dev_max;
1357         }
1358
1359         for (k = 0; k < sg_dev_max; k++)
1360                 if (!sg_dev_arr[k])
1361                         break;
1362         if (unlikely(k >= SG_MAX_DEVS))
1363                 goto overflow;
1364
1365         memset(sdp, 0, sizeof(*sdp));
1366         SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1367         sprintf(disk->disk_name, "sg%d", k);
1368         disk->first_minor = k;
1369         sdp->disk = disk;
1370         sdp->device = scsidp;
1371         init_waitqueue_head(&sdp->o_excl_wait);
1372         sdp->sg_tablesize = min(q->max_hw_segments, q->max_phys_segments);
1373
1374         sg_nr_dev++;
1375         sg_dev_arr[k] = sdp;
1376         write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1377         error = k;
1378
1379  out:
1380         if (error < 0)
1381                 kfree(sdp);
1382         kfree(old_sg_dev_arr);
1383         return error;
1384
1385  expand_failed:
1386         printk(KERN_WARNING "sg_alloc: device array cannot be resized\n");
1387         error = -ENOMEM;
1388         goto out;
1389
1390  overflow:
1391         write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1392         sdev_printk(KERN_WARNING, scsidp,
1393                     "Unable to attach sg device type=%d, minor "
1394                     "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1395         error = -ENODEV;
1396         goto out;
1397 }
1398
1399 static int
1400 sg_add(struct class_device *cl_dev, struct class_interface *cl_intf)
1401 {
1402         struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1403         struct gendisk *disk;
1404         Sg_device *sdp = NULL;
1405         struct cdev * cdev = NULL;
1406         int error, k;
1407
1408         disk = alloc_disk(1);
1409         if (!disk) {
1410                 printk(KERN_WARNING "alloc_disk failed\n");
1411                 return -ENOMEM;
1412         }
1413         disk->major = SCSI_GENERIC_MAJOR;
1414
1415         error = -ENOMEM;
1416         cdev = cdev_alloc();
1417         if (!cdev) {
1418                 printk(KERN_WARNING "cdev_alloc failed\n");
1419                 goto out;
1420         }
1421         cdev->owner = THIS_MODULE;
1422         cdev->ops = &sg_fops;
1423
1424         error = sg_alloc(disk, scsidp);
1425         if (error < 0) {
1426                 printk(KERN_WARNING "sg_alloc failed\n");
1427                 goto out;
1428         }
1429         k = error;
1430         sdp = sg_dev_arr[k];
1431
1432         devfs_mk_cdev(MKDEV(SCSI_GENERIC_MAJOR, k),
1433                         S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP,
1434                         "%s/generic", scsidp->devfs_name);
1435         error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, k), 1);
1436         if (error) {
1437                 devfs_remove("%s/generic", scsidp->devfs_name);
1438                 goto out;
1439         }
1440         sdp->cdev = cdev;
1441         if (sg_sysfs_valid) {
1442                 struct class_device * sg_class_member;
1443
1444                 sg_class_member = class_device_create(sg_sysfs_class, NULL,
1445                                 MKDEV(SCSI_GENERIC_MAJOR, k), 
1446                                 cl_dev->dev, "%s", 
1447                                 disk->disk_name);
1448                 if (IS_ERR(sg_class_member))
1449                         printk(KERN_WARNING "sg_add: "
1450                                 "class_device_create failed\n");
1451                 class_set_devdata(sg_class_member, sdp);
1452                 error = sysfs_create_link(&scsidp->sdev_gendev.kobj, 
1453                                           &sg_class_member->kobj, "generic");
1454                 if (error)
1455                         printk(KERN_ERR "sg_add: unable to make symlink "
1456                                         "'generic' back to sg%d\n", k);
1457         } else
1458                 printk(KERN_WARNING "sg_add: sg_sys INvalid\n");
1459
1460         sdev_printk(KERN_NOTICE, scsidp,
1461                     "Attached scsi generic sg%d type %d\n", k,scsidp->type);
1462
1463         return 0;
1464
1465 out:
1466         put_disk(disk);
1467         if (cdev)
1468                 cdev_del(cdev);
1469         return error;
1470 }
1471
1472 static void
1473 sg_remove(struct class_device *cl_dev, struct class_interface *cl_intf)
1474 {
1475         struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1476         Sg_device *sdp = NULL;
1477         unsigned long iflags;
1478         Sg_fd *sfp;
1479         Sg_fd *tsfp;
1480         Sg_request *srp;
1481         Sg_request *tsrp;
1482         int k, delay;
1483
1484         if (NULL == sg_dev_arr)
1485                 return;
1486         delay = 0;
1487         write_lock_irqsave(&sg_dev_arr_lock, iflags);
1488         for (k = 0; k < sg_dev_max; k++) {
1489                 sdp = sg_dev_arr[k];
1490                 if ((NULL == sdp) || (sdp->device != scsidp))
1491                         continue;       /* dirty but lowers nesting */
1492                 if (sdp->headfp) {
1493                         sdp->detached = 1;
1494                         for (sfp = sdp->headfp; sfp; sfp = tsfp) {
1495                                 tsfp = sfp->nextfp;
1496                                 for (srp = sfp->headrp; srp; srp = tsrp) {
1497                                         tsrp = srp->nextrp;
1498                                         if (sfp->closed || (0 == sg_srp_done(srp, sfp)))
1499                                                 sg_finish_rem_req(srp);
1500                                 }
1501                                 if (sfp->closed) {
1502                                         scsi_device_put(sdp->device);
1503                                         __sg_remove_sfp(sdp, sfp);
1504                                 } else {
1505                                         delay = 1;
1506                                         wake_up_interruptible(&sfp->read_wait);
1507                                         kill_fasync(&sfp->async_qp, SIGPOLL,
1508                                                     POLL_HUP);
1509                                 }
1510                         }
1511                         SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d, dirty\n", k));
1512                         if (NULL == sdp->headfp) {
1513                                 sg_dev_arr[k] = NULL;
1514                         }
1515                 } else {        /* nothing active, simple case */
1516                         SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d\n", k));
1517                         sg_dev_arr[k] = NULL;
1518                 }
1519                 sg_nr_dev--;
1520                 break;
1521         }
1522         write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1523
1524         if (sdp) {
1525                 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1526                 class_device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, k));
1527                 cdev_del(sdp->cdev);
1528                 sdp->cdev = NULL;
1529                 devfs_remove("%s/generic", scsidp->devfs_name);
1530                 put_disk(sdp->disk);
1531                 sdp->disk = NULL;
1532                 if (NULL == sdp->headfp)
1533                         kfree((char *) sdp);
1534         }
1535
1536         if (delay)
1537                 msleep(10);     /* dirty detach so delay device destruction */
1538 }
1539
1540 /* Set 'perm' (4th argument) to 0 to disable module_param's definition
1541  * of sysfs parameters (which module_param doesn't yet support).
1542  * Sysfs parameters defined explicitly below.
1543  */
1544 module_param_named(def_reserved_size, def_reserved_size, int, S_IRUGO);
1545 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1546
1547 MODULE_AUTHOR("Douglas Gilbert");
1548 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1549 MODULE_LICENSE("GPL");
1550 MODULE_VERSION(SG_VERSION_STR);
1551
1552 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1553 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1554
1555 static int __init
1556 init_sg(void)
1557 {
1558         int rc;
1559
1560         if (def_reserved_size >= 0)
1561                 sg_big_buff = def_reserved_size;
1562
1563         rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), 
1564                                     SG_MAX_DEVS, "sg");
1565         if (rc)
1566                 return rc;
1567         sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1568         if ( IS_ERR(sg_sysfs_class) ) {
1569                 rc = PTR_ERR(sg_sysfs_class);
1570                 goto err_out;
1571         }
1572         sg_sysfs_valid = 1;
1573         rc = scsi_register_interface(&sg_interface);
1574         if (0 == rc) {
1575 #ifdef CONFIG_SCSI_PROC_FS
1576                 sg_proc_init();
1577 #endif                          /* CONFIG_SCSI_PROC_FS */
1578                 return 0;
1579         }
1580         class_destroy(sg_sysfs_class);
1581 err_out:
1582         unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1583         return rc;
1584 }
1585
1586 static void __exit
1587 exit_sg(void)
1588 {
1589 #ifdef CONFIG_SCSI_PROC_FS
1590         sg_proc_cleanup();
1591 #endif                          /* CONFIG_SCSI_PROC_FS */
1592         scsi_unregister_interface(&sg_interface);
1593         class_destroy(sg_sysfs_class);
1594         sg_sysfs_valid = 0;
1595         unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1596                                  SG_MAX_DEVS);
1597         kfree((char *)sg_dev_arr);
1598         sg_dev_arr = NULL;
1599         sg_dev_max = 0;
1600 }
1601
1602 static int
1603 sg_start_req(Sg_request * srp)
1604 {
1605         int res;
1606         Sg_fd *sfp = srp->parentfp;
1607         sg_io_hdr_t *hp = &srp->header;
1608         int dxfer_len = (int) hp->dxfer_len;
1609         int dxfer_dir = hp->dxfer_direction;
1610         Sg_scatter_hold *req_schp = &srp->data;
1611         Sg_scatter_hold *rsv_schp = &sfp->reserve;
1612
1613         SCSI_LOG_TIMEOUT(4, printk("sg_start_req: dxfer_len=%d\n", dxfer_len));
1614         if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1615                 return 0;
1616         if (sg_allow_dio && (hp->flags & SG_FLAG_DIRECT_IO) &&
1617             (dxfer_dir != SG_DXFER_UNKNOWN) && (0 == hp->iovec_count) &&
1618             (!sfp->parentdp->device->host->unchecked_isa_dma)) {
1619                 res = sg_build_direct(srp, sfp, dxfer_len);
1620                 if (res <= 0)   /* -ve -> error, 0 -> done, 1 -> try indirect */
1621                         return res;
1622         }
1623         if ((!sg_res_in_use(sfp)) && (dxfer_len <= rsv_schp->bufflen))
1624                 sg_link_reserve(sfp, srp, dxfer_len);
1625         else {
1626                 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1627                 if (res) {
1628                         sg_remove_scat(req_schp);
1629                         return res;
1630                 }
1631         }
1632         return 0;
1633 }
1634
1635 static void
1636 sg_finish_rem_req(Sg_request * srp)
1637 {
1638         Sg_fd *sfp = srp->parentfp;
1639         Sg_scatter_hold *req_schp = &srp->data;
1640
1641         SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1642         if (srp->res_used)
1643                 sg_unlink_reserve(sfp, srp);
1644         else
1645                 sg_remove_scat(req_schp);
1646         sg_remove_request(sfp, srp);
1647 }
1648
1649 static int
1650 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1651 {
1652         int sg_bufflen = tablesize * sizeof(struct scatterlist);
1653         gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1654
1655         /*
1656          * TODO: test without low_dma, we should not need it since
1657          * the block layer will bounce the buffer for us
1658          *
1659          * XXX(hch): we shouldn't need GFP_DMA for the actual S/G list.
1660          */
1661         if (sfp->low_dma)
1662                  gfp_flags |= GFP_DMA;
1663         schp->buffer = kzalloc(sg_bufflen, gfp_flags);
1664         if (!schp->buffer)
1665                 return -ENOMEM;
1666         schp->sglist_len = sg_bufflen;
1667         return tablesize;       /* number of scat_gath elements allocated */
1668 }
1669
1670 #ifdef SG_ALLOW_DIO_CODE
1671 /* vvvvvvvv  following code borrowed from st driver's direct IO vvvvvvvvv */
1672         /* TODO: hopefully we can use the generic block layer code */
1673
1674 /* Pin down user pages and put them into a scatter gather list. Returns <= 0 if
1675    - mapping of all pages not successful
1676    (i.e., either completely successful or fails)
1677 */
1678 static int 
1679 st_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages, 
1680                   unsigned long uaddr, size_t count, int rw)
1681 {
1682         unsigned long end = (uaddr + count + PAGE_SIZE - 1) >> PAGE_SHIFT;
1683         unsigned long start = uaddr >> PAGE_SHIFT;
1684         const int nr_pages = end - start;
1685         int res, i, j;
1686         struct page **pages;
1687
1688         /* User attempted Overflow! */
1689         if ((uaddr + count) < uaddr)
1690                 return -EINVAL;
1691
1692         /* Too big */
1693         if (nr_pages > max_pages)
1694                 return -ENOMEM;
1695
1696         /* Hmm? */
1697         if (count == 0)
1698                 return 0;
1699
1700         if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_ATOMIC)) == NULL)
1701                 return -ENOMEM;
1702
1703         /* Try to fault in all of the necessary pages */
1704         down_read(&current->mm->mmap_sem);
1705         /* rw==READ means read from drive, write into memory area */
1706         res = get_user_pages(
1707                 current,
1708                 current->mm,
1709                 uaddr,
1710                 nr_pages,
1711                 rw == READ,
1712                 0, /* don't force */
1713                 pages,
1714                 NULL);
1715         up_read(&current->mm->mmap_sem);
1716
1717         /* Errors and no page mapped should return here */
1718         if (res < nr_pages)
1719                 goto out_unmap;
1720
1721         for (i=0; i < nr_pages; i++) {
1722                 /* FIXME: flush superflous for rw==READ,
1723                  * probably wrong function for rw==WRITE
1724                  */
1725                 flush_dcache_page(pages[i]);
1726                 /* ?? Is locking needed? I don't think so */
1727                 /* if (TestSetPageLocked(pages[i]))
1728                    goto out_unlock; */
1729         }
1730
1731         sgl[0].page = pages[0];
1732         sgl[0].offset = uaddr & ~PAGE_MASK;
1733         if (nr_pages > 1) {
1734                 sgl[0].length = PAGE_SIZE - sgl[0].offset;
1735                 count -= sgl[0].length;
1736                 for (i=1; i < nr_pages ; i++) {
1737                         sgl[i].page = pages[i]; 
1738                         sgl[i].length = count < PAGE_SIZE ? count : PAGE_SIZE;
1739                         count -= PAGE_SIZE;
1740                 }
1741         }
1742         else {
1743                 sgl[0].length = count;
1744         }
1745
1746         kfree(pages);
1747         return nr_pages;
1748
1749  out_unmap:
1750         if (res > 0) {
1751                 for (j=0; j < res; j++)
1752                         page_cache_release(pages[j]);
1753                 res = 0;
1754         }
1755         kfree(pages);
1756         return res;
1757 }
1758
1759
1760 /* And unmap them... */
1761 static int 
1762 st_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
1763                     int dirtied)
1764 {
1765         int i;
1766
1767         for (i=0; i < nr_pages; i++) {
1768                 struct page *page = sgl[i].page;
1769
1770                 if (dirtied)
1771                         SetPageDirty(page);
1772                 /* unlock_page(page); */
1773                 /* FIXME: cache flush missing for rw==READ
1774                  * FIXME: call the correct reference counting function
1775                  */
1776                 page_cache_release(page);
1777         }
1778
1779         return 0;
1780 }
1781
1782 /* ^^^^^^^^  above code borrowed from st driver's direct IO ^^^^^^^^^ */
1783 #endif
1784
1785
1786 /* Returns: -ve -> error, 0 -> done, 1 -> try indirect */
1787 static int
1788 sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len)
1789 {
1790 #ifdef SG_ALLOW_DIO_CODE
1791         sg_io_hdr_t *hp = &srp->header;
1792         Sg_scatter_hold *schp = &srp->data;
1793         int sg_tablesize = sfp->parentdp->sg_tablesize;
1794         int mx_sc_elems, res;
1795         struct scsi_device *sdev = sfp->parentdp->device;
1796
1797         if (((unsigned long)hp->dxferp &
1798                         queue_dma_alignment(sdev->request_queue)) != 0)
1799                 return 1;
1800
1801         mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1802         if (mx_sc_elems <= 0) {
1803                 return 1;
1804         }
1805         res = st_map_user_pages(schp->buffer, mx_sc_elems,
1806                                 (unsigned long)hp->dxferp, dxfer_len, 
1807                                 (SG_DXFER_TO_DEV == hp->dxfer_direction) ? 1 : 0);
1808         if (res <= 0)
1809                 return 1;
1810         schp->k_use_sg = res;
1811         schp->dio_in_use = 1;
1812         hp->info |= SG_INFO_DIRECT_IO;
1813         return 0;
1814 #else
1815         return 1;
1816 #endif
1817 }
1818
1819 static int
1820 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1821 {
1822         struct scatterlist *sg;
1823         int ret_sz = 0, k, rem_sz, num, mx_sc_elems;
1824         int sg_tablesize = sfp->parentdp->sg_tablesize;
1825         int blk_size = buff_size;
1826         struct page *p = NULL;
1827
1828         if ((blk_size < 0) || (!sfp))
1829                 return -EFAULT;
1830         if (0 == blk_size)
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
1837         /* N.B. ret_sz carried into this block ... */
1838         mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1839         if (mx_sc_elems < 0)
1840                 return mx_sc_elems;     /* most likely -ENOMEM */
1841
1842         for (k = 0, sg = schp->buffer, rem_sz = blk_size;
1843              (rem_sz > 0) && (k < mx_sc_elems);
1844              ++k, rem_sz -= ret_sz, ++sg) {
1845                 
1846                 num = (rem_sz > SG_SCATTER_SZ) ? SG_SCATTER_SZ : rem_sz;
1847                 p = sg_page_malloc(num, sfp->low_dma, &ret_sz);
1848                 if (!p)
1849                         return -ENOMEM;
1850
1851                 sg->page = p;
1852                 sg->length = ret_sz;
1853
1854                 SCSI_LOG_TIMEOUT(5, printk("sg_build_build: k=%d, a=0x%p, len=%d\n",
1855                                   k, p, ret_sz));
1856         }               /* end of for loop */
1857
1858         schp->k_use_sg = k;
1859         SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, rem_sz=%d\n", k, rem_sz));
1860
1861         schp->bufflen = blk_size;
1862         if (rem_sz > 0) /* must have failed */
1863                 return -ENOMEM;
1864
1865         return 0;
1866 }
1867
1868 static int
1869 sg_write_xfer(Sg_request * srp)
1870 {
1871         sg_io_hdr_t *hp = &srp->header;
1872         Sg_scatter_hold *schp = &srp->data;
1873         struct scatterlist *sg = schp->buffer;
1874         int num_xfer = 0;
1875         int j, k, onum, usglen, ksglen, res;
1876         int iovec_count = (int) hp->iovec_count;
1877         int dxfer_dir = hp->dxfer_direction;
1878         unsigned char *p;
1879         unsigned char __user *up;
1880         int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
1881
1882         if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_TO_DEV == dxfer_dir) ||
1883             (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
1884                 num_xfer = (int) (new_interface ? hp->dxfer_len : hp->flags);
1885                 if (schp->bufflen < num_xfer)
1886                         num_xfer = schp->bufflen;
1887         }
1888         if ((num_xfer <= 0) || (schp->dio_in_use) ||
1889             (new_interface
1890              && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
1891                 return 0;
1892
1893         SCSI_LOG_TIMEOUT(4, printk("sg_write_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
1894                           num_xfer, iovec_count, schp->k_use_sg));
1895         if (iovec_count) {
1896                 onum = iovec_count;
1897                 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
1898                         return -EFAULT;
1899         } else
1900                 onum = 1;
1901
1902         ksglen = sg->length;
1903         p = page_address(sg->page);
1904         for (j = 0, k = 0; j < onum; ++j) {
1905                 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1906                 if (res)
1907                         return res;
1908
1909                 for (; p; ++sg, ksglen = sg->length,
1910                      p = page_address(sg->page)) {
1911                         if (usglen <= 0)
1912                                 break;
1913                         if (ksglen > usglen) {
1914                                 if (usglen >= num_xfer) {
1915                                         if (__copy_from_user(p, up, num_xfer))
1916                                                 return -EFAULT;
1917                                         return 0;
1918                                 }
1919                                 if (__copy_from_user(p, up, usglen))
1920                                         return -EFAULT;
1921                                 p += usglen;
1922                                 ksglen -= usglen;
1923                                 break;
1924                         } else {
1925                                 if (ksglen >= num_xfer) {
1926                                         if (__copy_from_user(p, up, num_xfer))
1927                                                 return -EFAULT;
1928                                         return 0;
1929                                 }
1930                                 if (__copy_from_user(p, up, ksglen))
1931                                         return -EFAULT;
1932                                 up += ksglen;
1933                                 usglen -= ksglen;
1934                         }
1935                         ++k;
1936                         if (k >= schp->k_use_sg)
1937                                 return 0;
1938                 }
1939         }
1940
1941         return 0;
1942 }
1943
1944 static int
1945 sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
1946            int wr_xf, int *countp, unsigned char __user **up)
1947 {
1948         int num_xfer = (int) hp->dxfer_len;
1949         unsigned char __user *p = hp->dxferp;
1950         int count;
1951
1952         if (0 == sg_num) {
1953                 if (wr_xf && ('\0' == hp->interface_id))
1954                         count = (int) hp->flags;        /* holds "old" input_size */
1955                 else
1956                         count = num_xfer;
1957         } else {
1958                 sg_iovec_t iovec;
1959                 if (__copy_from_user(&iovec, p + ind*SZ_SG_IOVEC, SZ_SG_IOVEC))
1960                         return -EFAULT;
1961                 p = iovec.iov_base;
1962                 count = (int) iovec.iov_len;
1963         }
1964         if (!access_ok(wr_xf ? VERIFY_READ : VERIFY_WRITE, p, count))
1965                 return -EFAULT;
1966         if (up)
1967                 *up = p;
1968         if (countp)
1969                 *countp = count;
1970         return 0;
1971 }
1972
1973 static void
1974 sg_remove_scat(Sg_scatter_hold * schp)
1975 {
1976         SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1977         if (schp->buffer && (schp->sglist_len > 0)) {
1978                 struct scatterlist *sg = schp->buffer;
1979
1980                 if (schp->dio_in_use) {
1981 #ifdef SG_ALLOW_DIO_CODE
1982                         st_unmap_user_pages(sg, schp->k_use_sg, TRUE);
1983 #endif
1984                 } else {
1985                         int k;
1986
1987                         for (k = 0; (k < schp->k_use_sg) && sg->page;
1988                              ++k, ++sg) {
1989                                 SCSI_LOG_TIMEOUT(5, printk(
1990                                     "sg_remove_scat: k=%d, a=0x%p, len=%d\n",
1991                                     k, sg->page, sg->length));
1992                                 sg_page_free(sg->page, sg->length);
1993                         }
1994                 }
1995                 kfree(schp->buffer);
1996         }
1997         memset(schp, 0, sizeof (*schp));
1998 }
1999
2000 static int
2001 sg_read_xfer(Sg_request * srp)
2002 {
2003         sg_io_hdr_t *hp = &srp->header;
2004         Sg_scatter_hold *schp = &srp->data;
2005         struct scatterlist *sg = schp->buffer;
2006         int num_xfer = 0;
2007         int j, k, onum, usglen, ksglen, res;
2008         int iovec_count = (int) hp->iovec_count;
2009         int dxfer_dir = hp->dxfer_direction;
2010         unsigned char *p;
2011         unsigned char __user *up;
2012         int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
2013
2014         if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_FROM_DEV == dxfer_dir)
2015             || (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
2016                 num_xfer = hp->dxfer_len;
2017                 if (schp->bufflen < num_xfer)
2018                         num_xfer = schp->bufflen;
2019         }
2020         if ((num_xfer <= 0) || (schp->dio_in_use) ||
2021             (new_interface
2022              && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
2023                 return 0;
2024
2025         SCSI_LOG_TIMEOUT(4, printk("sg_read_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
2026                           num_xfer, iovec_count, schp->k_use_sg));
2027         if (iovec_count) {
2028                 onum = iovec_count;
2029                 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
2030                         return -EFAULT;
2031         } else
2032                 onum = 1;
2033
2034         p = page_address(sg->page);
2035         ksglen = sg->length;
2036         for (j = 0, k = 0; j < onum; ++j) {
2037                 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2038                 if (res)
2039                         return res;
2040
2041                 for (; p; ++sg, ksglen = sg->length,
2042                      p = page_address(sg->page)) {
2043                         if (usglen <= 0)
2044                                 break;
2045                         if (ksglen > usglen) {
2046                                 if (usglen >= num_xfer) {
2047                                         if (__copy_to_user(up, p, num_xfer))
2048                                                 return -EFAULT;
2049                                         return 0;
2050                                 }
2051                                 if (__copy_to_user(up, p, usglen))
2052                                         return -EFAULT;
2053                                 p += usglen;
2054                                 ksglen -= usglen;
2055                                 break;
2056                         } else {
2057                                 if (ksglen >= num_xfer) {
2058                                         if (__copy_to_user(up, p, num_xfer))
2059                                                 return -EFAULT;
2060                                         return 0;
2061                                 }
2062                                 if (__copy_to_user(up, p, ksglen))
2063                                         return -EFAULT;
2064                                 up += ksglen;
2065                                 usglen -= ksglen;
2066                         }
2067                         ++k;
2068                         if (k >= schp->k_use_sg)
2069                                 return 0;
2070                 }
2071         }
2072
2073         return 0;
2074 }
2075
2076 static int
2077 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
2078 {
2079         Sg_scatter_hold *schp = &srp->data;
2080         struct scatterlist *sg = schp->buffer;
2081         int k, num;
2082
2083         SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
2084                                    num_read_xfer));
2085         if ((!outp) || (num_read_xfer <= 0))
2086                 return 0;
2087
2088         for (k = 0; (k < schp->k_use_sg) && sg->page; ++k, ++sg) {
2089                 num = sg->length;
2090                 if (num > num_read_xfer) {
2091                         if (__copy_to_user(outp, page_address(sg->page),
2092                                            num_read_xfer))
2093                                 return -EFAULT;
2094                         break;
2095                 } else {
2096                         if (__copy_to_user(outp, page_address(sg->page),
2097                                            num))
2098                                 return -EFAULT;
2099                         num_read_xfer -= num;
2100                         if (num_read_xfer <= 0)
2101                                 break;
2102                         outp += num;
2103                 }
2104         }
2105
2106         return 0;
2107 }
2108
2109 static void
2110 sg_build_reserve(Sg_fd * sfp, int req_size)
2111 {
2112         Sg_scatter_hold *schp = &sfp->reserve;
2113
2114         SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
2115         do {
2116                 if (req_size < PAGE_SIZE)
2117                         req_size = PAGE_SIZE;
2118                 if (0 == sg_build_indirect(schp, sfp, req_size))
2119                         return;
2120                 else
2121                         sg_remove_scat(schp);
2122                 req_size >>= 1; /* divide by 2 */
2123         } while (req_size > (PAGE_SIZE / 2));
2124 }
2125
2126 static void
2127 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2128 {
2129         Sg_scatter_hold *req_schp = &srp->data;
2130         Sg_scatter_hold *rsv_schp = &sfp->reserve;
2131         struct scatterlist *sg = rsv_schp->buffer;
2132         int k, num, rem;
2133
2134         srp->res_used = 1;
2135         SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
2136         rem = size;
2137
2138         for (k = 0; k < rsv_schp->k_use_sg; ++k, ++sg) {
2139                 num = sg->length;
2140                 if (rem <= num) {
2141                         sfp->save_scat_len = num;
2142                         sg->length = rem;
2143                         req_schp->k_use_sg = k + 1;
2144                         req_schp->sglist_len = rsv_schp->sglist_len;
2145                         req_schp->buffer = rsv_schp->buffer;
2146
2147                         req_schp->bufflen = size;
2148                         req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2149                         break;
2150                 } else
2151                         rem -= num;
2152         }
2153
2154         if (k >= rsv_schp->k_use_sg)
2155                 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
2156 }
2157
2158 static void
2159 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2160 {
2161         Sg_scatter_hold *req_schp = &srp->data;
2162         Sg_scatter_hold *rsv_schp = &sfp->reserve;
2163
2164         SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
2165                                    (int) req_schp->k_use_sg));
2166         if ((rsv_schp->k_use_sg > 0) && (req_schp->k_use_sg > 0)) {
2167                 struct scatterlist *sg = rsv_schp->buffer;
2168
2169                 if (sfp->save_scat_len > 0)
2170                         (sg + (req_schp->k_use_sg - 1))->length =
2171                             (unsigned) sfp->save_scat_len;
2172                 else
2173                         SCSI_LOG_TIMEOUT(1, printk ("sg_unlink_reserve: BAD save_scat_len\n"));
2174         }
2175         req_schp->k_use_sg = 0;
2176         req_schp->bufflen = 0;
2177         req_schp->buffer = NULL;
2178         req_schp->sglist_len = 0;
2179         sfp->save_scat_len = 0;
2180         srp->res_used = 0;
2181 }
2182
2183 static Sg_request *
2184 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2185 {
2186         Sg_request *resp;
2187         unsigned long iflags;
2188
2189         write_lock_irqsave(&sfp->rq_list_lock, iflags);
2190         for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2191                 /* look for requests that are ready + not SG_IO owned */
2192                 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2193                     ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2194                         resp->done = 2; /* guard against other readers */
2195                         break;
2196                 }
2197         }
2198         write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2199         return resp;
2200 }
2201
2202 #ifdef CONFIG_SCSI_PROC_FS
2203 static Sg_request *
2204 sg_get_nth_request(Sg_fd * sfp, int nth)
2205 {
2206         Sg_request *resp;
2207         unsigned long iflags;
2208         int k;
2209
2210         read_lock_irqsave(&sfp->rq_list_lock, iflags);
2211         for (k = 0, resp = sfp->headrp; resp && (k < nth);
2212              ++k, resp = resp->nextrp) ;
2213         read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2214         return resp;
2215 }
2216 #endif
2217
2218 /* always adds to end of list */
2219 static Sg_request *
2220 sg_add_request(Sg_fd * sfp)
2221 {
2222         int k;
2223         unsigned long iflags;
2224         Sg_request *resp;
2225         Sg_request *rp = sfp->req_arr;
2226
2227         write_lock_irqsave(&sfp->rq_list_lock, iflags);
2228         resp = sfp->headrp;
2229         if (!resp) {
2230                 memset(rp, 0, sizeof (Sg_request));
2231                 rp->parentfp = sfp;
2232                 resp = rp;
2233                 sfp->headrp = resp;
2234         } else {
2235                 if (0 == sfp->cmd_q)
2236                         resp = NULL;    /* command queuing disallowed */
2237                 else {
2238                         for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2239                                 if (!rp->parentfp)
2240                                         break;
2241                         }
2242                         if (k < SG_MAX_QUEUE) {
2243                                 memset(rp, 0, sizeof (Sg_request));
2244                                 rp->parentfp = sfp;
2245                                 while (resp->nextrp)
2246                                         resp = resp->nextrp;
2247                                 resp->nextrp = rp;
2248                                 resp = rp;
2249                         } else
2250                                 resp = NULL;
2251                 }
2252         }
2253         if (resp) {
2254                 resp->nextrp = NULL;
2255                 resp->header.duration = jiffies_to_msecs(jiffies);
2256         }
2257         write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2258         return resp;
2259 }
2260
2261 /* Return of 1 for found; 0 for not found */
2262 static int
2263 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2264 {
2265         Sg_request *prev_rp;
2266         Sg_request *rp;
2267         unsigned long iflags;
2268         int res = 0;
2269
2270         if ((!sfp) || (!srp) || (!sfp->headrp))
2271                 return res;
2272         write_lock_irqsave(&sfp->rq_list_lock, iflags);
2273         prev_rp = sfp->headrp;
2274         if (srp == prev_rp) {
2275                 sfp->headrp = prev_rp->nextrp;
2276                 prev_rp->parentfp = NULL;
2277                 res = 1;
2278         } else {
2279                 while ((rp = prev_rp->nextrp)) {
2280                         if (srp == rp) {
2281                                 prev_rp->nextrp = rp->nextrp;
2282                                 rp->parentfp = NULL;
2283                                 res = 1;
2284                                 break;
2285                         }
2286                         prev_rp = rp;
2287                 }
2288         }
2289         write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2290         return res;
2291 }
2292
2293 #ifdef CONFIG_SCSI_PROC_FS
2294 static Sg_fd *
2295 sg_get_nth_sfp(Sg_device * sdp, int nth)
2296 {
2297         Sg_fd *resp;
2298         unsigned long iflags;
2299         int k;
2300
2301         read_lock_irqsave(&sg_dev_arr_lock, iflags);
2302         for (k = 0, resp = sdp->headfp; resp && (k < nth);
2303              ++k, resp = resp->nextfp) ;
2304         read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2305         return resp;
2306 }
2307 #endif
2308
2309 static Sg_fd *
2310 sg_add_sfp(Sg_device * sdp, int dev)
2311 {
2312         Sg_fd *sfp;
2313         unsigned long iflags;
2314
2315         sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2316         if (!sfp)
2317                 return NULL;
2318
2319         init_waitqueue_head(&sfp->read_wait);
2320         rwlock_init(&sfp->rq_list_lock);
2321
2322         sfp->timeout = SG_DEFAULT_TIMEOUT;
2323         sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2324         sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2325         sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2326             sdp->device->host->unchecked_isa_dma : 1;
2327         sfp->cmd_q = SG_DEF_COMMAND_Q;
2328         sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2329         sfp->parentdp = sdp;
2330         write_lock_irqsave(&sg_dev_arr_lock, iflags);
2331         if (!sdp->headfp)
2332                 sdp->headfp = sfp;
2333         else {                  /* add to tail of existing list */
2334                 Sg_fd *pfp = sdp->headfp;
2335                 while (pfp->nextfp)
2336                         pfp = pfp->nextfp;
2337                 pfp->nextfp = sfp;
2338         }
2339         write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2340         SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2341         sg_build_reserve(sfp, sg_big_buff);
2342         SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp:   bufflen=%d, k_use_sg=%d\n",
2343                            sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2344         return sfp;
2345 }
2346
2347 static void
2348 __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2349 {
2350         Sg_fd *fp;
2351         Sg_fd *prev_fp;
2352
2353         prev_fp = sdp->headfp;
2354         if (sfp == prev_fp)
2355                 sdp->headfp = prev_fp->nextfp;
2356         else {
2357                 while ((fp = prev_fp->nextfp)) {
2358                         if (sfp == fp) {
2359                                 prev_fp->nextfp = fp->nextfp;
2360                                 break;
2361                         }
2362                         prev_fp = fp;
2363                 }
2364         }
2365         if (sfp->reserve.bufflen > 0) {
2366                 SCSI_LOG_TIMEOUT(6, 
2367                         printk("__sg_remove_sfp:    bufflen=%d, k_use_sg=%d\n",
2368                         (int) sfp->reserve.bufflen, (int) sfp->reserve.k_use_sg));
2369                 sg_remove_scat(&sfp->reserve);
2370         }
2371         sfp->parentdp = NULL;
2372         SCSI_LOG_TIMEOUT(6, printk("__sg_remove_sfp:    sfp=0x%p\n", sfp));
2373         kfree(sfp);
2374 }
2375
2376 /* Returns 0 in normal case, 1 when detached and sdp object removed */
2377 static int
2378 sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2379 {
2380         Sg_request *srp;
2381         Sg_request *tsrp;
2382         int dirty = 0;
2383         int res = 0;
2384
2385         for (srp = sfp->headrp; srp; srp = tsrp) {
2386                 tsrp = srp->nextrp;
2387                 if (sg_srp_done(srp, sfp))
2388                         sg_finish_rem_req(srp);
2389                 else
2390                         ++dirty;
2391         }
2392         if (0 == dirty) {
2393                 unsigned long iflags;
2394
2395                 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2396                 __sg_remove_sfp(sdp, sfp);
2397                 if (sdp->detached && (NULL == sdp->headfp)) {
2398                         int k, maxd;
2399
2400                         maxd = sg_dev_max;
2401                         for (k = 0; k < maxd; ++k) {
2402                                 if (sdp == sg_dev_arr[k])
2403                                         break;
2404                         }
2405                         if (k < maxd)
2406                                 sg_dev_arr[k] = NULL;
2407                         kfree((char *) sdp);
2408                         res = 1;
2409                 }
2410                 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2411         } else {
2412                 /* MOD_INC's to inhibit unloading sg and associated adapter driver */
2413                 /* only bump the access_count if we actually succeeded in
2414                  * throwing another counter on the host module */
2415                 scsi_device_get(sdp->device);   /* XXX: retval ignored? */      
2416                 sfp->closed = 1;        /* flag dirty state on this fd */
2417                 SCSI_LOG_TIMEOUT(1, printk("sg_remove_sfp: worrisome, %d writes pending\n",
2418                                   dirty));
2419         }
2420         return res;
2421 }
2422
2423 static int
2424 sg_res_in_use(Sg_fd * sfp)
2425 {
2426         const Sg_request *srp;
2427         unsigned long iflags;
2428
2429         read_lock_irqsave(&sfp->rq_list_lock, iflags);
2430         for (srp = sfp->headrp; srp; srp = srp->nextrp)
2431                 if (srp->res_used)
2432                         break;
2433         read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2434         return srp ? 1 : 0;
2435 }
2436
2437 /* If retSzp==NULL want exact size or fail */
2438 static struct page *
2439 sg_page_malloc(int rqSz, int lowDma, int *retSzp)
2440 {
2441         struct page *resp = NULL;
2442         gfp_t page_mask;
2443         int order, a_size;
2444         int resSz = rqSz;
2445
2446         if (rqSz <= 0)
2447                 return resp;
2448
2449         if (lowDma)
2450                 page_mask = GFP_ATOMIC | GFP_DMA | __GFP_COMP | __GFP_NOWARN;
2451         else
2452                 page_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
2453
2454         for (order = 0, a_size = PAGE_SIZE; a_size < rqSz;
2455              order++, a_size <<= 1) ;
2456         resp = alloc_pages(page_mask, order);
2457         while ((!resp) && order && retSzp) {
2458                 --order;
2459                 a_size >>= 1;   /* divide by 2, until PAGE_SIZE */
2460                 resp =  alloc_pages(page_mask, order);  /* try half */
2461                 resSz = a_size;
2462         }
2463         if (resp) {
2464                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2465                         memset(page_address(resp), 0, resSz);
2466                 if (retSzp)
2467                         *retSzp = resSz;
2468         }
2469         return resp;
2470 }
2471
2472 static void
2473 sg_page_free(struct page *page, int size)
2474 {
2475         int order, a_size;
2476
2477         if (!page)
2478                 return;
2479         for (order = 0, a_size = PAGE_SIZE; a_size < size;
2480              order++, a_size <<= 1) ;
2481         __free_pages(page, order);
2482 }
2483
2484 #ifndef MAINTENANCE_IN_CMD
2485 #define MAINTENANCE_IN_CMD 0xa3
2486 #endif
2487
2488 static unsigned char allow_ops[] = { TEST_UNIT_READY, REQUEST_SENSE,
2489         INQUIRY, READ_CAPACITY, READ_BUFFER, READ_6, READ_10, READ_12,
2490         READ_16, MODE_SENSE, MODE_SENSE_10, LOG_SENSE, REPORT_LUNS,
2491         SERVICE_ACTION_IN, RECEIVE_DIAGNOSTIC, READ_LONG, MAINTENANCE_IN_CMD
2492 };
2493
2494 static int
2495 sg_allow_access(unsigned char opcode, char dev_type)
2496 {
2497         int k;
2498
2499         if (TYPE_SCANNER == dev_type)   /* TYPE_ROM maybe burner */
2500                 return 1;
2501         for (k = 0; k < sizeof (allow_ops); ++k) {
2502                 if (opcode == allow_ops[k])
2503                         return 1;
2504         }
2505         return 0;
2506 }
2507
2508 #ifdef CONFIG_SCSI_PROC_FS
2509 static int
2510 sg_last_dev(void)
2511 {
2512         int k;
2513         unsigned long iflags;
2514
2515         read_lock_irqsave(&sg_dev_arr_lock, iflags);
2516         for (k = sg_dev_max - 1; k >= 0; --k)
2517                 if (sg_dev_arr[k] && sg_dev_arr[k]->device)
2518                         break;
2519         read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2520         return k + 1;           /* origin 1 */
2521 }
2522 #endif
2523
2524 static Sg_device *
2525 sg_get_dev(int dev)
2526 {
2527         Sg_device *sdp = NULL;
2528         unsigned long iflags;
2529
2530         if (sg_dev_arr && (dev >= 0)) {
2531                 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2532                 if (dev < sg_dev_max)
2533                         sdp = sg_dev_arr[dev];
2534                 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2535         }
2536         return sdp;
2537 }
2538
2539 #ifdef CONFIG_SCSI_PROC_FS
2540
2541 static struct proc_dir_entry *sg_proc_sgp = NULL;
2542
2543 static char sg_proc_sg_dirname[] = "scsi/sg";
2544
2545 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2546
2547 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2548 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2549                                   size_t count, loff_t *off);
2550 static struct file_operations adio_fops = {
2551         /* .owner, .read and .llseek added in sg_proc_init() */
2552         .open = sg_proc_single_open_adio,
2553         .write = sg_proc_write_adio,
2554         .release = single_release,
2555 };
2556
2557 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2558 static ssize_t sg_proc_write_dressz(struct file *filp, 
2559                 const char __user *buffer, size_t count, loff_t *off);
2560 static struct file_operations dressz_fops = {
2561         .open = sg_proc_single_open_dressz,
2562         .write = sg_proc_write_dressz,
2563         .release = single_release,
2564 };
2565
2566 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2567 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2568 static struct file_operations version_fops = {
2569         .open = sg_proc_single_open_version,
2570         .release = single_release,
2571 };
2572
2573 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2574 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2575 static struct file_operations devhdr_fops = {
2576         .open = sg_proc_single_open_devhdr,
2577         .release = single_release,
2578 };
2579
2580 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2581 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2582 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2583 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2584 static void dev_seq_stop(struct seq_file *s, void *v);
2585 static struct file_operations dev_fops = {
2586         .open = sg_proc_open_dev,
2587         .release = seq_release,
2588 };
2589 static struct seq_operations dev_seq_ops = {
2590         .start = dev_seq_start,
2591         .next  = dev_seq_next,
2592         .stop  = dev_seq_stop,
2593         .show  = sg_proc_seq_show_dev,
2594 };
2595
2596 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2597 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2598 static struct file_operations devstrs_fops = {
2599         .open = sg_proc_open_devstrs,
2600         .release = seq_release,
2601 };
2602 static struct seq_operations devstrs_seq_ops = {
2603         .start = dev_seq_start,
2604         .next  = dev_seq_next,
2605         .stop  = dev_seq_stop,
2606         .show  = sg_proc_seq_show_devstrs,
2607 };
2608
2609 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2610 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2611 static struct file_operations debug_fops = {
2612         .open = sg_proc_open_debug,
2613         .release = seq_release,
2614 };
2615 static struct seq_operations debug_seq_ops = {
2616         .start = dev_seq_start,
2617         .next  = dev_seq_next,
2618         .stop  = dev_seq_stop,
2619         .show  = sg_proc_seq_show_debug,
2620 };
2621
2622
2623 struct sg_proc_leaf {
2624         const char * name;
2625         struct file_operations * fops;
2626 };
2627
2628 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2629         {"allow_dio", &adio_fops},
2630         {"debug", &debug_fops},
2631         {"def_reserved_size", &dressz_fops},
2632         {"device_hdr", &devhdr_fops},
2633         {"devices", &dev_fops},
2634         {"device_strs", &devstrs_fops},
2635         {"version", &version_fops}
2636 };
2637
2638 static int
2639 sg_proc_init(void)
2640 {
2641         int k, mask;
2642         int num_leaves =
2643             sizeof (sg_proc_leaf_arr) / sizeof (sg_proc_leaf_arr[0]);
2644         struct proc_dir_entry *pdep;
2645         struct sg_proc_leaf * leaf;
2646
2647         sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2648         if (!sg_proc_sgp)
2649                 return 1;
2650         for (k = 0; k < num_leaves; ++k) {
2651                 leaf = &sg_proc_leaf_arr[k];
2652                 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2653                 pdep = create_proc_entry(leaf->name, mask, sg_proc_sgp);
2654                 if (pdep) {
2655                         leaf->fops->owner = THIS_MODULE,
2656                         leaf->fops->read = seq_read,
2657                         leaf->fops->llseek = seq_lseek,
2658                         pdep->proc_fops = leaf->fops;
2659                 }
2660         }
2661         return 0;
2662 }
2663
2664 static void
2665 sg_proc_cleanup(void)
2666 {
2667         int k;
2668         int num_leaves =
2669             sizeof (sg_proc_leaf_arr) / sizeof (sg_proc_leaf_arr[0]);
2670
2671         if (!sg_proc_sgp)
2672                 return;
2673         for (k = 0; k < num_leaves; ++k)
2674                 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2675         remove_proc_entry(sg_proc_sg_dirname, NULL);
2676 }
2677
2678
2679 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2680 {
2681         seq_printf(s, "%d\n", *((int *)s->private));
2682         return 0;
2683 }
2684
2685 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2686 {
2687         return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2688 }
2689
2690 static ssize_t 
2691 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2692                    size_t count, loff_t *off)
2693 {
2694         int num;
2695         char buff[11];
2696
2697         if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2698                 return -EACCES;
2699         num = (count < 10) ? count : 10;
2700         if (copy_from_user(buff, buffer, num))
2701                 return -EFAULT;
2702         buff[num] = '\0';
2703         sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2704         return count;
2705 }
2706
2707 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2708 {
2709         return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2710 }
2711
2712 static ssize_t 
2713 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2714                      size_t count, loff_t *off)
2715 {
2716         int num;
2717         unsigned long k = ULONG_MAX;
2718         char buff[11];
2719
2720         if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2721                 return -EACCES;
2722         num = (count < 10) ? count : 10;
2723         if (copy_from_user(buff, buffer, num))
2724                 return -EFAULT;
2725         buff[num] = '\0';
2726         k = simple_strtoul(buff, NULL, 10);
2727         if (k <= 1048576) {     /* limit "big buff" to 1 MB */
2728                 sg_big_buff = k;
2729                 return count;
2730         }
2731         return -ERANGE;
2732 }
2733
2734 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2735 {
2736         seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2737                    sg_version_date);
2738         return 0;
2739 }
2740
2741 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2742 {
2743         return single_open(file, sg_proc_seq_show_version, NULL);
2744 }
2745
2746 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2747 {
2748         seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2749                    "online\n");
2750         return 0;
2751 }
2752
2753 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2754 {
2755         return single_open(file, sg_proc_seq_show_devhdr, NULL);
2756 }
2757
2758 struct sg_proc_deviter {
2759         loff_t  index;
2760         size_t  max;
2761 };
2762
2763 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2764 {
2765         struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2766
2767         s->private = it;
2768         if (! it)
2769                 return NULL;
2770
2771         if (NULL == sg_dev_arr)
2772                 return NULL;
2773         it->index = *pos;
2774         it->max = sg_last_dev();
2775         if (it->index >= it->max)
2776                 return NULL;
2777         return it;
2778 }
2779
2780 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2781 {
2782         struct sg_proc_deviter * it = s->private;
2783
2784         *pos = ++it->index;
2785         return (it->index < it->max) ? it : NULL;
2786 }
2787
2788 static void dev_seq_stop(struct seq_file *s, void *v)
2789 {
2790         kfree(s->private);
2791 }
2792
2793 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2794 {
2795         return seq_open(file, &dev_seq_ops);
2796 }
2797
2798 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2799 {
2800         struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2801         Sg_device *sdp;
2802         struct scsi_device *scsidp;
2803
2804         sdp = it ? sg_get_dev(it->index) : NULL;
2805         if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2806                 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2807                               scsidp->host->host_no, scsidp->channel,
2808                               scsidp->id, scsidp->lun, (int) scsidp->type,
2809                               1,
2810                               (int) scsidp->queue_depth,
2811                               (int) scsidp->device_busy,
2812                               (int) scsi_device_online(scsidp));
2813         else
2814                 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2815         return 0;
2816 }
2817
2818 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2819 {
2820         return seq_open(file, &devstrs_seq_ops);
2821 }
2822
2823 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2824 {
2825         struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2826         Sg_device *sdp;
2827         struct scsi_device *scsidp;
2828
2829         sdp = it ? sg_get_dev(it->index) : NULL;
2830         if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2831                 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2832                            scsidp->vendor, scsidp->model, scsidp->rev);
2833         else
2834                 seq_printf(s, "<no active device>\n");
2835         return 0;
2836 }
2837
2838 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2839 {
2840         int k, m, new_interface, blen, usg;
2841         Sg_request *srp;
2842         Sg_fd *fp;
2843         const sg_io_hdr_t *hp;
2844         const char * cp;
2845         unsigned int ms;
2846
2847         for (k = 0; (fp = sg_get_nth_sfp(sdp, k)); ++k) {
2848                 seq_printf(s, "   FD(%d): timeout=%dms bufflen=%d "
2849                            "(res)sgat=%d low_dma=%d\n", k + 1,
2850                            jiffies_to_msecs(fp->timeout),
2851                            fp->reserve.bufflen,
2852                            (int) fp->reserve.k_use_sg,
2853                            (int) fp->low_dma);
2854                 seq_printf(s, "   cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2855                            (int) fp->cmd_q, (int) fp->force_packid,
2856                            (int) fp->keep_orphan, (int) fp->closed);
2857                 for (m = 0; (srp = sg_get_nth_request(fp, m)); ++m) {
2858                         hp = &srp->header;
2859                         new_interface = (hp->interface_id == '\0') ? 0 : 1;
2860                         if (srp->res_used) {
2861                                 if (new_interface && 
2862                                     (SG_FLAG_MMAP_IO & hp->flags))
2863                                         cp = "     mmap>> ";
2864                                 else
2865                                         cp = "     rb>> ";
2866                         } else {
2867                                 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2868                                         cp = "     dio>> ";
2869                                 else
2870                                         cp = "     ";
2871                         }
2872                         seq_printf(s, cp);
2873                         blen = srp->data.bufflen;
2874                         usg = srp->data.k_use_sg;
2875                         seq_printf(s, srp->done ? 
2876                                    ((1 == srp->done) ?  "rcv:" : "fin:")
2877                                    : "act:");
2878                         seq_printf(s, " id=%d blen=%d",
2879                                    srp->header.pack_id, blen);
2880                         if (srp->done)
2881                                 seq_printf(s, " dur=%d", hp->duration);
2882                         else {
2883                                 ms = jiffies_to_msecs(jiffies);
2884                                 seq_printf(s, " t_o/elap=%d/%d",
2885                                         (new_interface ? hp->timeout :
2886                                                   jiffies_to_msecs(fp->timeout)),
2887                                         (ms > hp->duration ? ms - hp->duration : 0));
2888                         }
2889                         seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2890                                    (int) srp->data.cmd_opcode);
2891                 }
2892                 if (0 == m)
2893                         seq_printf(s, "     No requests active\n");
2894         }
2895 }
2896
2897 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2898 {
2899         return seq_open(file, &debug_seq_ops);
2900 }
2901
2902 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2903 {
2904         struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2905         Sg_device *sdp;
2906
2907         if (it && (0 == it->index)) {
2908                 seq_printf(s, "dev_max(currently)=%d max_active_device=%d "
2909                            "(origin 1)\n", sg_dev_max, (int)it->max);
2910                 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2911         }
2912         sdp = it ? sg_get_dev(it->index) : NULL;
2913         if (sdp) {
2914                 struct scsi_device *scsidp = sdp->device;
2915
2916                 if (NULL == scsidp) {
2917                         seq_printf(s, "device %d detached ??\n", 
2918                                    (int)it->index);
2919                         return 0;
2920                 }
2921
2922                 if (sg_get_nth_sfp(sdp, 0)) {
2923                         seq_printf(s, " >>> device=%s ",
2924                                 sdp->disk->disk_name);
2925                         if (sdp->detached)
2926                                 seq_printf(s, "detached pending close ");
2927                         else
2928                                 seq_printf
2929                                     (s, "scsi%d chan=%d id=%d lun=%d   em=%d",
2930                                      scsidp->host->host_no,
2931                                      scsidp->channel, scsidp->id,
2932                                      scsidp->lun,
2933                                      scsidp->host->hostt->emulated);
2934                         seq_printf(s, " sg_tablesize=%d excl=%d\n",
2935                                    sdp->sg_tablesize, sdp->exclude);
2936                 }
2937                 sg_proc_debug_helper(s, sdp);
2938         }
2939         return 0;
2940 }
2941
2942 #endif                          /* CONFIG_SCSI_PROC_FS */
2943
2944 module_init(init_sg);
2945 module_exit(exit_sg);
2946 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);