[PATCH] v4l: keep tvaudio driver away from saa7146
[linux-2.6/history.git] / drivers / scsi / sg.c
blobb4267f6500c0d4de1b47865ff8e57f21bef95f92
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
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
10 * Copyright (C) 1998 - 2004 Douglas Gilbert
12 * Modified 19-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
17 * any later version.
21 static int sg_version_num = 30531; /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.31"
25 * D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
26 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
27 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
28 * (otherwise the macros compile to empty statements).
31 #include <linux/config.h>
32 #include <linux/module.h>
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>
53 #include "scsi.h"
54 #include <scsi/scsi_host.h>
55 #include <scsi/scsi_driver.h>
56 #include <scsi/scsi_ioctl.h>
57 #include <scsi/sg.h>
59 #include "scsi_logging.h"
61 #ifdef CONFIG_SCSI_PROC_FS
62 #include <linux/proc_fs.h>
63 static char *sg_version_date = "20040516";
65 static int sg_proc_init(void);
66 static void sg_proc_cleanup(void);
67 #endif
69 #ifndef LINUX_VERSION_CODE
70 #include <linux/version.h>
71 #endif /* LINUX_VERSION_CODE */
73 #define SG_ALLOW_DIO_DEF 0
74 #define SG_ALLOW_DIO_CODE /* compile out by commenting this define */
76 #define SG_MAX_DEVS 32768
79 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
80 * Then when using 32 bit integers x * m may overflow during the calculation.
81 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
82 * calculates the same, but prevents the overflow when both m and d
83 * are "small" numbers (like HZ and USER_HZ).
84 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
85 * in 32 bits.
87 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
89 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
91 int sg_big_buff = SG_DEF_RESERVED_SIZE;
92 /* N.B. This variable is readable and writeable via
93 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
94 of this size (or less if there is not enough memory) will be reserved
95 for use by this file descriptor. [Deprecated usage: this variable is also
96 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
97 the kernel (i.e. it is not a module).] */
98 static int def_reserved_size = -1; /* picks up init parameter */
99 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
101 #define SG_SECTOR_SZ 512
102 #define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
104 #define SG_DEV_ARR_LUMP 32 /* amount to over allocate sg_dev_arr by */
106 static int sg_add(struct class_device *);
107 static void sg_remove(struct class_device *);
109 static Scsi_Request *dummy_cmdp; /* only used for sizeof */
111 static rwlock_t sg_dev_arr_lock = RW_LOCK_UNLOCKED; /* Also used to lock
112 file descriptor list for device */
114 static struct class_interface sg_interface = {
115 .add = sg_add,
116 .remove = sg_remove,
119 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
120 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
121 unsigned short sglist_len; /* size of malloc'd scatter-gather list ++ */
122 unsigned bufflen; /* Size of (aggregate) data buffer */
123 unsigned b_malloc_len; /* actual len malloc'ed in buffer */
124 void *buffer; /* Data buffer or scatter list (k_use_sg>0) */
125 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
126 unsigned char cmd_opcode; /* first byte of command */
127 } Sg_scatter_hold;
129 struct sg_device; /* forward declarations */
130 struct sg_fd;
132 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
133 Scsi_Request *my_cmdp; /* != 0 when request with lower levels */
134 struct sg_request *nextrp; /* NULL -> tail request (slist) */
135 struct sg_fd *parentfp; /* NULL -> not in use */
136 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
137 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
138 unsigned char sense_b[sizeof (dummy_cmdp->sr_sense_buffer)];
139 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
140 char orphan; /* 1 -> drop on sight, 0 -> normal */
141 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
142 volatile char done; /* 0->before bh, 1->before read, 2->read */
143 } Sg_request;
145 typedef struct sg_fd { /* holds the state of a file descriptor */
146 struct sg_fd *nextfp; /* NULL when last opened fd on this device */
147 struct sg_device *parentdp; /* owning device */
148 wait_queue_head_t read_wait; /* queue read until command done */
149 rwlock_t rq_list_lock; /* protect access to list in req_arr */
150 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
151 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
152 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
153 unsigned save_scat_len; /* original length of trunc. scat. element */
154 Sg_request *headrp; /* head of request slist, NULL->empty */
155 struct fasync_struct *async_qp; /* used by asynchronous notification */
156 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
157 char low_dma; /* as in parent but possibly overridden to 1 */
158 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
159 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
160 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
161 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
162 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
163 char mmap_called; /* 0 -> mmap() never called on this fd */
164 } Sg_fd;
166 typedef struct sg_device { /* holds the state of each scsi generic device */
167 struct scsi_device *device;
168 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
169 int sg_tablesize; /* adapter's max scatter-gather table size */
170 Sg_fd *headfp; /* first open fd belonging to this device */
171 volatile char detached; /* 0->attached, 1->detached pending removal */
172 volatile char exclude; /* opened for exclusive access */
173 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
174 struct gendisk *disk;
175 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
176 } Sg_device;
178 static int sg_fasync(int fd, struct file *filp, int mode);
179 static void sg_cmd_done(Scsi_Cmnd * SCpnt); /* tasklet or soft irq callback */
180 static int sg_start_req(Sg_request * srp);
181 static void sg_finish_rem_req(Sg_request * srp);
182 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
183 static int sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp,
184 int tablesize);
185 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
186 Sg_request * srp);
187 static ssize_t sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
188 int blocking, int read_only, Sg_request ** o_srp);
189 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
190 unsigned char *cmnd, int timeout, int blocking);
191 static int sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
192 int wr_xf, int *countp, unsigned char __user **up);
193 static int sg_write_xfer(Sg_request * srp);
194 static int sg_read_xfer(Sg_request * srp);
195 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
196 static void sg_remove_scat(Sg_scatter_hold * schp);
197 static void sg_build_reserve(Sg_fd * sfp, int req_size);
198 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
199 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
200 static char *sg_page_malloc(int rqSz, int lowDma, int *retSzp);
201 static void sg_page_free(char *buff, int size);
202 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
203 static int sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
204 static void __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
205 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
206 static Sg_request *sg_add_request(Sg_fd * sfp);
207 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
208 static int sg_res_in_use(Sg_fd * sfp);
209 static int sg_allow_access(unsigned char opcode, char dev_type);
210 static int sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len);
211 static Sg_device *sg_get_dev(int dev);
212 static inline unsigned char *sg_scatg2virt(const struct scatterlist *sclp);
213 #ifdef CONFIG_SCSI_PROC_FS
214 static int sg_last_dev(void);
215 #endif
217 static Sg_device **sg_dev_arr = NULL;
218 static int sg_dev_max;
219 static int sg_nr_dev;
221 #define SZ_SG_HEADER sizeof(struct sg_header)
222 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
223 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
224 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
226 static int
227 sg_open(struct inode *inode, struct file *filp)
229 int dev = iminor(inode);
230 int flags = filp->f_flags;
231 Sg_device *sdp;
232 Sg_fd *sfp;
233 int res;
234 int retval;
236 nonseekable_open(inode, filp);
237 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
238 sdp = sg_get_dev(dev);
239 if ((!sdp) || (!sdp->device))
240 return -ENXIO;
241 if (sdp->detached)
242 return -ENODEV;
244 /* This driver's module count bumped by fops_get in <linux/fs.h> */
245 /* Prevent the device driver from vanishing while we sleep */
246 retval = scsi_device_get(sdp->device);
247 if (retval)
248 return retval;
250 if (!((flags & O_NONBLOCK) ||
251 scsi_block_when_processing_errors(sdp->device))) {
252 retval = -ENXIO;
253 /* we are in error recovery for this device */
254 goto error_out;
257 if (flags & O_EXCL) {
258 if (O_RDONLY == (flags & O_ACCMODE)) {
259 retval = -EPERM; /* Can't lock it with read only access */
260 goto error_out;
262 if (sdp->headfp && (flags & O_NONBLOCK)) {
263 retval = -EBUSY;
264 goto error_out;
266 res = 0;
267 __wait_event_interruptible(sdp->o_excl_wait,
268 ((sdp->headfp || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
269 if (res) {
270 retval = res; /* -ERESTARTSYS because signal hit process */
271 goto error_out;
273 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
274 if (flags & O_NONBLOCK) {
275 retval = -EBUSY;
276 goto error_out;
278 res = 0;
279 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
280 res);
281 if (res) {
282 retval = res; /* -ERESTARTSYS because signal hit process */
283 goto error_out;
286 if (sdp->detached) {
287 retval = -ENODEV;
288 goto error_out;
290 if (!sdp->headfp) { /* no existing opens on this device */
291 sdp->sgdebug = 0;
292 sdp->sg_tablesize = sdp->device->host->sg_tablesize;
294 if ((sfp = sg_add_sfp(sdp, dev)))
295 filp->private_data = sfp;
296 else {
297 if (flags & O_EXCL)
298 sdp->exclude = 0; /* undo if error */
299 retval = -ENOMEM;
300 goto error_out;
302 return 0;
304 error_out:
305 scsi_device_put(sdp->device);
306 return retval;
309 /* Following function was formerly called 'sg_close' */
310 static int
311 sg_release(struct inode *inode, struct file *filp)
313 Sg_device *sdp;
314 Sg_fd *sfp;
316 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
317 return -ENXIO;
318 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
319 sg_fasync(-1, filp, 0); /* remove filp from async notification list */
320 if (0 == sg_remove_sfp(sdp, sfp)) { /* Returns 1 when sdp gone */
321 if (!sdp->detached) {
322 scsi_device_put(sdp->device);
324 sdp->exclude = 0;
325 wake_up_interruptible(&sdp->o_excl_wait);
327 return 0;
330 static ssize_t
331 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
333 int k, res;
334 Sg_device *sdp;
335 Sg_fd *sfp;
336 Sg_request *srp;
337 int req_pack_id = -1;
338 struct sg_header old_hdr;
339 sg_io_hdr_t new_hdr;
340 sg_io_hdr_t *hp;
342 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
343 return -ENXIO;
344 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
345 sdp->disk->disk_name, (int) count));
346 if ((k = verify_area(VERIFY_WRITE, buf, count)))
347 return k;
348 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
349 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
350 return -EFAULT;
351 if (old_hdr.reply_len < 0) {
352 if (count >= SZ_SG_IO_HDR) {
353 if (__copy_from_user
354 (&new_hdr, buf, SZ_SG_IO_HDR))
355 return -EFAULT;
356 req_pack_id = new_hdr.pack_id;
358 } else
359 req_pack_id = old_hdr.pack_id;
361 srp = sg_get_rq_mark(sfp, req_pack_id);
362 if (!srp) { /* now wait on packet to arrive */
363 if (sdp->detached)
364 return -ENODEV;
365 if (filp->f_flags & O_NONBLOCK)
366 return -EAGAIN;
367 while (1) {
368 res = 0; /* following is a macro that beats race condition */
369 __wait_event_interruptible(sfp->read_wait,
370 (sdp->detached || (srp = sg_get_rq_mark(sfp, req_pack_id))),
371 res);
372 if (sdp->detached)
373 return -ENODEV;
374 if (0 == res)
375 break;
376 return res; /* -ERESTARTSYS because signal hit process */
379 if (srp->header.interface_id != '\0')
380 return sg_new_read(sfp, buf, count, srp);
382 hp = &srp->header;
383 memset(&old_hdr, 0, SZ_SG_HEADER);
384 old_hdr.reply_len = (int) hp->timeout;
385 old_hdr.pack_len = old_hdr.reply_len; /* very old, strange behaviour */
386 old_hdr.pack_id = hp->pack_id;
387 old_hdr.twelve_byte =
388 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
389 old_hdr.target_status = hp->masked_status;
390 old_hdr.host_status = hp->host_status;
391 old_hdr.driver_status = hp->driver_status;
392 if ((CHECK_CONDITION & hp->masked_status) ||
393 (DRIVER_SENSE & hp->driver_status))
394 memcpy(old_hdr.sense_buffer, srp->sense_b,
395 sizeof (old_hdr.sense_buffer));
396 switch (hp->host_status) {
397 /* This setup of 'result' is for backward compatibility and is best
398 ignored by the user who should use target, host + driver status */
399 case DID_OK:
400 case DID_PASSTHROUGH:
401 case DID_SOFT_ERROR:
402 old_hdr.result = 0;
403 break;
404 case DID_NO_CONNECT:
405 case DID_BUS_BUSY:
406 case DID_TIME_OUT:
407 old_hdr.result = EBUSY;
408 break;
409 case DID_BAD_TARGET:
410 case DID_ABORT:
411 case DID_PARITY:
412 case DID_RESET:
413 case DID_BAD_INTR:
414 old_hdr.result = EIO;
415 break;
416 case DID_ERROR:
417 old_hdr.result = (srp->sense_b[0] == 0 &&
418 hp->masked_status == GOOD) ? 0 : EIO;
419 break;
420 default:
421 old_hdr.result = EIO;
422 break;
425 /* Now copy the result back to the user buffer. */
426 if (count >= SZ_SG_HEADER) {
427 if (__copy_to_user(buf, &old_hdr, SZ_SG_HEADER))
428 return -EFAULT;
429 buf += SZ_SG_HEADER;
430 if (count > old_hdr.reply_len)
431 count = old_hdr.reply_len;
432 if (count > SZ_SG_HEADER) {
433 if ((res =
434 sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)))
435 return -EFAULT;
437 } else
438 count = (old_hdr.result == 0) ? 0 : -EIO;
439 sg_finish_rem_req(srp);
440 return count;
443 static ssize_t
444 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
446 sg_io_hdr_t *hp = &srp->header;
447 int err = 0;
448 int len;
450 if (count < SZ_SG_IO_HDR) {
451 err = -EINVAL;
452 goto err_out;
454 hp->sb_len_wr = 0;
455 if ((hp->mx_sb_len > 0) && hp->sbp) {
456 if ((CHECK_CONDITION & hp->masked_status) ||
457 (DRIVER_SENSE & hp->driver_status)) {
458 int sb_len = sizeof (dummy_cmdp->sr_sense_buffer);
459 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
460 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
461 len = (len > sb_len) ? sb_len : len;
462 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
463 err = -EFAULT;
464 goto err_out;
466 hp->sb_len_wr = len;
469 if (hp->masked_status || hp->host_status || hp->driver_status)
470 hp->info |= SG_INFO_CHECK;
471 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
472 err = -EFAULT;
473 goto err_out;
475 err = sg_read_xfer(srp);
476 err_out:
477 sg_finish_rem_req(srp);
478 return (0 == err) ? count : err;
481 static ssize_t
482 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
484 int mxsize, cmd_size, k;
485 int input_size, blocking;
486 unsigned char opcode;
487 Sg_device *sdp;
488 Sg_fd *sfp;
489 Sg_request *srp;
490 struct sg_header old_hdr;
491 sg_io_hdr_t *hp;
492 unsigned char cmnd[sizeof (dummy_cmdp->sr_cmnd)];
494 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
495 return -ENXIO;
496 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
497 sdp->disk->disk_name, (int) count));
498 if (sdp->detached)
499 return -ENODEV;
500 if (!((filp->f_flags & O_NONBLOCK) ||
501 scsi_block_when_processing_errors(sdp->device)))
502 return -ENXIO;
504 if ((k = verify_area(VERIFY_READ, buf, count)))
505 return k; /* protects following copy_from_user()s + get_user()s */
506 if (count < SZ_SG_HEADER)
507 return -EIO;
508 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
509 return -EFAULT;
510 blocking = !(filp->f_flags & O_NONBLOCK);
511 if (old_hdr.reply_len < 0)
512 return sg_new_write(sfp, buf, count, blocking, 0, NULL);
513 if (count < (SZ_SG_HEADER + 6))
514 return -EIO; /* The minimum scsi command length is 6 bytes. */
516 if (!(srp = sg_add_request(sfp))) {
517 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
518 return -EDOM;
520 buf += SZ_SG_HEADER;
521 __get_user(opcode, buf);
522 if (sfp->next_cmd_len > 0) {
523 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
524 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
525 sfp->next_cmd_len = 0;
526 sg_remove_request(sfp, srp);
527 return -EIO;
529 cmd_size = sfp->next_cmd_len;
530 sfp->next_cmd_len = 0; /* reset so only this write() effected */
531 } else {
532 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
533 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
534 cmd_size = 12;
536 SCSI_LOG_TIMEOUT(4, printk(
537 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
538 /* Determine buffer size. */
539 input_size = count - cmd_size;
540 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
541 mxsize -= SZ_SG_HEADER;
542 input_size -= SZ_SG_HEADER;
543 if (input_size < 0) {
544 sg_remove_request(sfp, srp);
545 return -EIO; /* User did not pass enough bytes for this command. */
547 hp = &srp->header;
548 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
549 hp->cmd_len = (unsigned char) cmd_size;
550 hp->iovec_count = 0;
551 hp->mx_sb_len = 0;
552 if (input_size > 0)
553 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
554 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
555 else
556 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
557 hp->dxfer_len = mxsize;
558 hp->dxferp = (char __user *)buf + cmd_size;
559 hp->sbp = NULL;
560 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
561 hp->flags = input_size; /* structure abuse ... */
562 hp->pack_id = old_hdr.pack_id;
563 hp->usr_ptr = NULL;
564 if (__copy_from_user(cmnd, buf, cmd_size))
565 return -EFAULT;
567 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
568 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
569 * is a non-zero input_size, so emit a warning.
571 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV)
572 if (printk_ratelimit())
573 printk(KERN_WARNING
574 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
575 "guessing data in;\n" KERN_WARNING " "
576 "program %s not setting count and/or reply_len properly\n",
577 old_hdr.reply_len - (int)SZ_SG_HEADER,
578 input_size, (unsigned int) cmnd[0],
579 current->comm);
580 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
581 return (k < 0) ? k : count;
584 static ssize_t
585 sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
586 int blocking, int read_only, Sg_request ** o_srp)
588 int k;
589 Sg_request *srp;
590 sg_io_hdr_t *hp;
591 unsigned char cmnd[sizeof (dummy_cmdp->sr_cmnd)];
592 int timeout;
593 unsigned long ul_timeout;
595 if (count < SZ_SG_IO_HDR)
596 return -EINVAL;
597 if ((k = verify_area(VERIFY_READ, buf, count)))
598 return k; /* protects following copy_from_user()s + get_user()s */
600 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
601 if (!(srp = sg_add_request(sfp))) {
602 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
603 return -EDOM;
605 hp = &srp->header;
606 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
607 sg_remove_request(sfp, srp);
608 return -EFAULT;
610 if (hp->interface_id != 'S') {
611 sg_remove_request(sfp, srp);
612 return -ENOSYS;
614 if (hp->flags & SG_FLAG_MMAP_IO) {
615 if (hp->dxfer_len > sfp->reserve.bufflen) {
616 sg_remove_request(sfp, srp);
617 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
619 if (hp->flags & SG_FLAG_DIRECT_IO) {
620 sg_remove_request(sfp, srp);
621 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
623 if (sg_res_in_use(sfp)) {
624 sg_remove_request(sfp, srp);
625 return -EBUSY; /* reserve buffer already being used */
628 ul_timeout = msecs_to_jiffies(srp->header.timeout);
629 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
630 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
631 sg_remove_request(sfp, srp);
632 return -EMSGSIZE;
634 if ((k = verify_area(VERIFY_READ, hp->cmdp, hp->cmd_len))) {
635 sg_remove_request(sfp, srp);
636 return k; /* protects following copy_from_user()s + get_user()s */
638 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
639 sg_remove_request(sfp, srp);
640 return -EFAULT;
642 if (read_only &&
643 (!sg_allow_access(cmnd[0], sfp->parentdp->device->type))) {
644 sg_remove_request(sfp, srp);
645 return -EPERM;
647 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
648 if (k < 0)
649 return k;
650 if (o_srp)
651 *o_srp = srp;
652 return count;
655 static int
656 sg_common_write(Sg_fd * sfp, Sg_request * srp,
657 unsigned char *cmnd, int timeout, int blocking)
659 int k;
660 Scsi_Request *SRpnt;
661 Sg_device *sdp = sfp->parentdp;
662 sg_io_hdr_t *hp = &srp->header;
663 request_queue_t *q;
665 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
666 hp->status = 0;
667 hp->masked_status = 0;
668 hp->msg_status = 0;
669 hp->info = 0;
670 hp->host_status = 0;
671 hp->driver_status = 0;
672 hp->resid = 0;
673 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
674 (int) cmnd[0], (int) hp->cmd_len));
676 if ((k = sg_start_req(srp))) {
677 SCSI_LOG_TIMEOUT(1, printk("sg_write: start_req err=%d\n", k));
678 sg_finish_rem_req(srp);
679 return k; /* probably out of space --> ENOMEM */
681 if ((k = sg_write_xfer(srp))) {
682 SCSI_LOG_TIMEOUT(1, printk("sg_write: write_xfer, bad address\n"));
683 sg_finish_rem_req(srp);
684 return k;
686 if (sdp->detached) {
687 sg_finish_rem_req(srp);
688 return -ENODEV;
690 SRpnt = scsi_allocate_request(sdp->device, GFP_ATOMIC);
691 if (SRpnt == NULL) {
692 SCSI_LOG_TIMEOUT(1, printk("sg_write: no mem\n"));
693 sg_finish_rem_req(srp);
694 return -ENOMEM;
697 srp->my_cmdp = SRpnt;
698 q = SRpnt->sr_device->request_queue;
699 SRpnt->sr_request->rq_disk = sdp->disk;
700 SRpnt->sr_sense_buffer[0] = 0;
701 SRpnt->sr_cmd_len = hp->cmd_len;
702 SRpnt->sr_use_sg = srp->data.k_use_sg;
703 SRpnt->sr_sglist_len = srp->data.sglist_len;
704 SRpnt->sr_bufflen = srp->data.bufflen;
705 SRpnt->sr_underflow = 0;
706 SRpnt->sr_buffer = srp->data.buffer;
707 switch (hp->dxfer_direction) {
708 case SG_DXFER_TO_FROM_DEV:
709 case SG_DXFER_FROM_DEV:
710 SRpnt->sr_data_direction = SCSI_DATA_READ;
711 break;
712 case SG_DXFER_TO_DEV:
713 SRpnt->sr_data_direction = SCSI_DATA_WRITE;
714 break;
715 case SG_DXFER_UNKNOWN:
716 SRpnt->sr_data_direction = SCSI_DATA_UNKNOWN;
717 break;
718 default:
719 SRpnt->sr_data_direction = SCSI_DATA_NONE;
720 break;
722 SRpnt->upper_private_data = srp;
723 srp->data.k_use_sg = 0;
724 srp->data.sglist_len = 0;
725 srp->data.bufflen = 0;
726 srp->data.buffer = NULL;
727 hp->duration = jiffies; /* unit jiffies now, millisecs after done */
728 /* Now send everything of to mid-level. The next time we hear about this
729 packet is when sg_cmd_done() is called (i.e. a callback). */
730 scsi_do_req(SRpnt, (void *) cmnd,
731 (void *) SRpnt->sr_buffer, hp->dxfer_len,
732 sg_cmd_done, timeout, SG_DEFAULT_RETRIES);
733 /* dxfer_len overwrites SRpnt->sr_bufflen, hence need for b_malloc_len */
734 return 0;
737 static int
738 sg_ioctl(struct inode *inode, struct file *filp,
739 unsigned int cmd_in, unsigned long arg)
741 void __user *p = (void __user *)arg;
742 int __user *ip = p;
743 int result, val, read_only;
744 Sg_device *sdp;
745 Sg_fd *sfp;
746 Sg_request *srp;
747 unsigned long iflags;
749 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
750 return -ENXIO;
751 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
752 sdp->disk->disk_name, (int) cmd_in));
753 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
755 switch (cmd_in) {
756 case SG_IO:
758 int blocking = 1; /* ignore O_NONBLOCK flag */
760 if (sdp->detached)
761 return -ENODEV;
762 if (!scsi_block_when_processing_errors(sdp->device))
763 return -ENXIO;
764 result = verify_area(VERIFY_WRITE, p, SZ_SG_IO_HDR);
765 if (result)
766 return result;
767 result =
768 sg_new_write(sfp, p, SZ_SG_IO_HDR,
769 blocking, read_only, &srp);
770 if (result < 0)
771 return result;
772 srp->sg_io_owned = 1;
773 while (1) {
774 result = 0; /* following macro to beat race condition */
775 __wait_event_interruptible(sfp->read_wait,
776 (sdp->detached || sfp->closed || srp->done),
777 result);
778 if (sdp->detached)
779 return -ENODEV;
780 if (sfp->closed)
781 return 0; /* request packet dropped already */
782 if (0 == result)
783 break;
784 srp->orphan = 1;
785 return result; /* -ERESTARTSYS because signal hit process */
787 srp->done = 2;
788 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
789 return (result < 0) ? result : 0;
791 case SG_SET_TIMEOUT:
792 result = get_user(val, ip);
793 if (result)
794 return result;
795 if (val < 0)
796 return -EIO;
797 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
798 val = MULDIV (INT_MAX, USER_HZ, HZ);
799 sfp->timeout_user = val;
800 sfp->timeout = MULDIV (val, HZ, USER_HZ);
802 return 0;
803 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
804 /* strange ..., for backward compatibility */
805 return sfp->timeout_user;
806 case SG_SET_FORCE_LOW_DMA:
807 result = get_user(val, ip);
808 if (result)
809 return result;
810 if (val) {
811 sfp->low_dma = 1;
812 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
813 val = (int) sfp->reserve.bufflen;
814 sg_remove_scat(&sfp->reserve);
815 sg_build_reserve(sfp, val);
817 } else {
818 if (sdp->detached)
819 return -ENODEV;
820 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
822 return 0;
823 case SG_GET_LOW_DMA:
824 return put_user((int) sfp->low_dma, ip);
825 case SG_GET_SCSI_ID:
826 result =
827 verify_area(VERIFY_WRITE, p, sizeof (sg_scsi_id_t));
828 if (result)
829 return result;
830 else {
831 sg_scsi_id_t __user *sg_idp = p;
833 if (sdp->detached)
834 return -ENODEV;
835 __put_user((int) sdp->device->host->host_no,
836 &sg_idp->host_no);
837 __put_user((int) sdp->device->channel,
838 &sg_idp->channel);
839 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
840 __put_user((int) sdp->device->lun, &sg_idp->lun);
841 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
842 __put_user((short) sdp->device->host->cmd_per_lun,
843 &sg_idp->h_cmd_per_lun);
844 __put_user((short) sdp->device->queue_depth,
845 &sg_idp->d_queue_depth);
846 __put_user(0, &sg_idp->unused[0]);
847 __put_user(0, &sg_idp->unused[1]);
848 return 0;
850 case SG_SET_FORCE_PACK_ID:
851 result = get_user(val, ip);
852 if (result)
853 return result;
854 sfp->force_packid = val ? 1 : 0;
855 return 0;
856 case SG_GET_PACK_ID:
857 result = verify_area(VERIFY_WRITE, ip, sizeof (int));
858 if (result)
859 return result;
860 read_lock_irqsave(&sfp->rq_list_lock, iflags);
861 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
862 if ((1 == srp->done) && (!srp->sg_io_owned)) {
863 read_unlock_irqrestore(&sfp->rq_list_lock,
864 iflags);
865 __put_user(srp->header.pack_id, ip);
866 return 0;
869 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
870 __put_user(-1, ip);
871 return 0;
872 case SG_GET_NUM_WAITING:
873 read_lock_irqsave(&sfp->rq_list_lock, iflags);
874 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
875 if ((1 == srp->done) && (!srp->sg_io_owned))
876 ++val;
878 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
879 return put_user(val, ip);
880 case SG_GET_SG_TABLESIZE:
881 return put_user(sdp->sg_tablesize, ip);
882 case SG_SET_RESERVED_SIZE:
883 result = get_user(val, ip);
884 if (result)
885 return result;
886 if (val < 0)
887 return -EINVAL;
888 if (val != sfp->reserve.bufflen) {
889 if (sg_res_in_use(sfp) || sfp->mmap_called)
890 return -EBUSY;
891 sg_remove_scat(&sfp->reserve);
892 sg_build_reserve(sfp, val);
894 return 0;
895 case SG_GET_RESERVED_SIZE:
896 val = (int) sfp->reserve.bufflen;
897 return put_user(val, ip);
898 case SG_SET_COMMAND_Q:
899 result = get_user(val, ip);
900 if (result)
901 return result;
902 sfp->cmd_q = val ? 1 : 0;
903 return 0;
904 case SG_GET_COMMAND_Q:
905 return put_user((int) sfp->cmd_q, ip);
906 case SG_SET_KEEP_ORPHAN:
907 result = get_user(val, ip);
908 if (result)
909 return result;
910 sfp->keep_orphan = val;
911 return 0;
912 case SG_GET_KEEP_ORPHAN:
913 return put_user((int) sfp->keep_orphan, ip);
914 case SG_NEXT_CMD_LEN:
915 result = get_user(val, ip);
916 if (result)
917 return result;
918 sfp->next_cmd_len = (val > 0) ? val : 0;
919 return 0;
920 case SG_GET_VERSION_NUM:
921 return put_user(sg_version_num, ip);
922 case SG_GET_ACCESS_COUNT:
923 /* faked - we don't have a real access count anymore */
924 val = (sdp->device ? 1 : 0);
925 return put_user(val, ip);
926 case SG_GET_REQUEST_TABLE:
927 result = verify_area(VERIFY_WRITE, p,
928 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
929 if (result)
930 return result;
931 else {
932 sg_req_info_t rinfo[SG_MAX_QUEUE];
933 Sg_request *srp;
934 read_lock_irqsave(&sfp->rq_list_lock, iflags);
935 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
936 ++val, srp = srp ? srp->nextrp : srp) {
937 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
938 if (srp) {
939 rinfo[val].req_state = srp->done + 1;
940 rinfo[val].problem =
941 srp->header.masked_status &
942 srp->header.host_status &
943 srp->header.driver_status;
944 rinfo[val].duration =
945 srp->done ? srp->header.duration :
946 jiffies_to_msecs(
947 jiffies - srp->header.duration);
948 rinfo[val].orphan = srp->orphan;
949 rinfo[val].sg_io_owned = srp->sg_io_owned;
950 rinfo[val].pack_id = srp->header.pack_id;
951 rinfo[val].usr_ptr = srp->header.usr_ptr;
954 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
955 return (__copy_to_user(p, rinfo,
956 SZ_SG_REQ_INFO * SG_MAX_QUEUE) ? -EFAULT : 0);
958 case SG_EMULATED_HOST:
959 if (sdp->detached)
960 return -ENODEV;
961 return put_user(sdp->device->host->hostt->emulated, ip);
962 case SG_SCSI_RESET:
963 if (sdp->detached)
964 return -ENODEV;
965 if (filp->f_flags & O_NONBLOCK) {
966 if (test_bit(SHOST_RECOVERY,
967 &sdp->device->host->shost_state))
968 return -EBUSY;
969 } else if (!scsi_block_when_processing_errors(sdp->device))
970 return -EBUSY;
971 result = get_user(val, ip);
972 if (result)
973 return result;
974 if (SG_SCSI_RESET_NOTHING == val)
975 return 0;
976 switch (val) {
977 case SG_SCSI_RESET_DEVICE:
978 val = SCSI_TRY_RESET_DEVICE;
979 break;
980 case SG_SCSI_RESET_BUS:
981 val = SCSI_TRY_RESET_BUS;
982 break;
983 case SG_SCSI_RESET_HOST:
984 val = SCSI_TRY_RESET_HOST;
985 break;
986 default:
987 return -EINVAL;
989 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
990 return -EACCES;
991 return (scsi_reset_provider(sdp->device, val) ==
992 SUCCESS) ? 0 : -EIO;
993 case SCSI_IOCTL_SEND_COMMAND:
994 if (sdp->detached)
995 return -ENODEV;
996 if (read_only) {
997 unsigned char opcode = WRITE_6;
998 Scsi_Ioctl_Command __user *siocp = p;
1000 if (copy_from_user(&opcode, siocp->data, 1))
1001 return -EFAULT;
1002 if (!sg_allow_access(opcode, sdp->device->type))
1003 return -EPERM;
1005 return scsi_ioctl_send_command(sdp->device, p);
1006 case SG_SET_DEBUG:
1007 result = get_user(val, ip);
1008 if (result)
1009 return result;
1010 sdp->sgdebug = (char) val;
1011 return 0;
1012 case SCSI_IOCTL_GET_IDLUN:
1013 case SCSI_IOCTL_GET_BUS_NUMBER:
1014 case SCSI_IOCTL_PROBE_HOST:
1015 case SG_GET_TRANSFORM:
1016 if (sdp->detached)
1017 return -ENODEV;
1018 return scsi_ioctl(sdp->device, cmd_in, p);
1019 default:
1020 if (read_only)
1021 return -EPERM; /* don't know so take safe approach */
1022 return scsi_ioctl(sdp->device, cmd_in, p);
1026 static unsigned int
1027 sg_poll(struct file *filp, poll_table * wait)
1029 unsigned int res = 0;
1030 Sg_device *sdp;
1031 Sg_fd *sfp;
1032 Sg_request *srp;
1033 int count = 0;
1034 unsigned long iflags;
1036 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1037 || sfp->closed)
1038 return POLLERR;
1039 poll_wait(filp, &sfp->read_wait, wait);
1040 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1041 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1042 /* if any read waiting, flag it */
1043 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1044 res = POLLIN | POLLRDNORM;
1045 ++count;
1047 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1049 if (sdp->detached)
1050 res |= POLLHUP;
1051 else if (!sfp->cmd_q) {
1052 if (0 == count)
1053 res |= POLLOUT | POLLWRNORM;
1054 } else if (count < SG_MAX_QUEUE)
1055 res |= POLLOUT | POLLWRNORM;
1056 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1057 sdp->disk->disk_name, (int) res));
1058 return res;
1061 static int
1062 sg_fasync(int fd, struct file *filp, int mode)
1064 int retval;
1065 Sg_device *sdp;
1066 Sg_fd *sfp;
1068 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1069 return -ENXIO;
1070 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1071 sdp->disk->disk_name, mode));
1073 retval = fasync_helper(fd, filp, mode, &sfp->async_qp);
1074 return (retval < 0) ? retval : 0;
1077 static inline unsigned char *
1078 sg_scatg2virt(const struct scatterlist *sclp)
1080 return (sclp && sclp->page) ?
1081 (unsigned char *) page_address(sclp->page) + sclp->offset : NULL;
1084 /* When startFinish==1 increments page counts for pages other than the
1085 first of scatter gather elements obtained from __get_free_pages().
1086 When startFinish==0 decrements ... */
1087 static void
1088 sg_rb_correct4mmap(Sg_scatter_hold * rsv_schp, int startFinish)
1090 void *page_ptr;
1091 struct page *page;
1092 int k, m;
1094 SCSI_LOG_TIMEOUT(3, printk("sg_rb_correct4mmap: startFinish=%d, scatg=%d\n",
1095 startFinish, rsv_schp->k_use_sg));
1096 /* N.B. correction _not_ applied to base page of each allocation */
1097 if (rsv_schp->k_use_sg) { /* reserve buffer is a scatter gather list */
1098 struct scatterlist *sclp = rsv_schp->buffer;
1100 for (k = 0; k < rsv_schp->k_use_sg; ++k, ++sclp) {
1101 for (m = PAGE_SIZE; m < sclp->length; m += PAGE_SIZE) {
1102 page_ptr = sg_scatg2virt(sclp) + m;
1103 page = virt_to_page(page_ptr);
1104 if (startFinish)
1105 get_page(page);
1106 else {
1107 if (page_count(page) > 0)
1108 __put_page(page);
1112 } else { /* reserve buffer is just a single allocation */
1113 for (m = PAGE_SIZE; m < rsv_schp->bufflen; m += PAGE_SIZE) {
1114 page_ptr = (unsigned char *) rsv_schp->buffer + m;
1115 page = virt_to_page(page_ptr);
1116 if (startFinish)
1117 get_page(page);
1118 else {
1119 if (page_count(page) > 0)
1120 __put_page(page);
1126 static struct page *
1127 sg_vma_nopage(struct vm_area_struct *vma, unsigned long addr, int *type)
1129 Sg_fd *sfp;
1130 struct page *page = NOPAGE_SIGBUS;
1131 void *page_ptr = NULL;
1132 unsigned long offset;
1133 Sg_scatter_hold *rsv_schp;
1135 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1136 return page;
1137 rsv_schp = &sfp->reserve;
1138 offset = addr - vma->vm_start;
1139 if (offset >= rsv_schp->bufflen)
1140 return page;
1141 SCSI_LOG_TIMEOUT(3, printk("sg_vma_nopage: offset=%lu, scatg=%d\n",
1142 offset, rsv_schp->k_use_sg));
1143 if (rsv_schp->k_use_sg) { /* reserve buffer is a scatter gather list */
1144 int k;
1145 unsigned long sa = vma->vm_start;
1146 unsigned long len;
1147 struct scatterlist *sclp = rsv_schp->buffer;
1149 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1150 ++k, ++sclp) {
1151 len = vma->vm_end - sa;
1152 len = (len < sclp->length) ? len : sclp->length;
1153 if (offset < len) {
1154 page_ptr = sg_scatg2virt(sclp) + offset;
1155 page = virt_to_page(page_ptr);
1156 get_page(page); /* increment page count */
1157 break;
1159 sa += len;
1160 offset -= len;
1162 } else { /* reserve buffer is just a single allocation */
1163 page_ptr = (unsigned char *) rsv_schp->buffer + offset;
1164 page = virt_to_page(page_ptr);
1165 get_page(page); /* increment page count */
1167 if (type)
1168 *type = VM_FAULT_MINOR;
1169 return page;
1172 static struct vm_operations_struct sg_mmap_vm_ops = {
1173 .nopage = sg_vma_nopage,
1176 static int
1177 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1179 Sg_fd *sfp;
1180 unsigned long req_sz = vma->vm_end - vma->vm_start;
1181 Sg_scatter_hold *rsv_schp;
1183 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1184 return -ENXIO;
1185 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1186 (void *) vma->vm_start, (int) req_sz));
1187 if (vma->vm_pgoff)
1188 return -EINVAL; /* want no offset */
1189 rsv_schp = &sfp->reserve;
1190 if (req_sz > rsv_schp->bufflen)
1191 return -ENOMEM; /* cannot map more than reserved buffer */
1193 if (rsv_schp->k_use_sg) { /* reserve buffer is a scatter gather list */
1194 int k;
1195 unsigned long sa = vma->vm_start;
1196 unsigned long len;
1197 struct scatterlist *sclp = rsv_schp->buffer;
1199 for (k = 0; (k < rsv_schp->k_use_sg) && (sa < vma->vm_end);
1200 ++k, ++sclp) {
1201 if (0 != sclp->offset)
1202 return -EFAULT; /* non page aligned memory ?? */
1203 len = vma->vm_end - sa;
1204 len = (len < sclp->length) ? len : sclp->length;
1205 sa += len;
1207 } else { /* reserve buffer is just a single allocation */
1208 if ((unsigned long) rsv_schp->buffer & (PAGE_SIZE - 1))
1209 return -EFAULT; /* non page aligned memory ?? */
1211 if (0 == sfp->mmap_called) {
1212 sg_rb_correct4mmap(rsv_schp, 1); /* do only once per fd lifetime */
1213 sfp->mmap_called = 1;
1215 vma->vm_flags |= (VM_RESERVED | VM_IO);
1216 vma->vm_private_data = sfp;
1217 vma->vm_ops = &sg_mmap_vm_ops;
1218 return 0;
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(Scsi_Cmnd * SCpnt)
1226 Scsi_Request *SRpnt = NULL;
1227 Sg_device *sdp = NULL;
1228 Sg_fd *sfp;
1229 Sg_request *srp = NULL;
1231 if (SCpnt && (SRpnt = SCpnt->sc_request))
1232 srp = (Sg_request *) SRpnt->upper_private_data;
1233 if (NULL == srp) {
1234 printk(KERN_ERR "sg_cmd_done: NULL request\n");
1235 if (SRpnt)
1236 scsi_release_request(SRpnt);
1237 return;
1239 sfp = srp->parentfp;
1240 if (sfp)
1241 sdp = sfp->parentdp;
1242 if ((NULL == sdp) || sdp->detached) {
1243 printk(KERN_INFO "sg_cmd_done: device detached\n");
1244 scsi_release_request(SRpnt);
1245 return;
1248 /* First transfer ownership of data buffers to sg_device object. */
1249 srp->data.k_use_sg = SRpnt->sr_use_sg;
1250 srp->data.sglist_len = SRpnt->sr_sglist_len;
1251 srp->data.bufflen = SRpnt->sr_bufflen;
1252 srp->data.buffer = SRpnt->sr_buffer;
1253 /* now clear out request structure */
1254 SRpnt->sr_use_sg = 0;
1255 SRpnt->sr_sglist_len = 0;
1256 SRpnt->sr_bufflen = 0;
1257 SRpnt->sr_buffer = NULL;
1258 SRpnt->sr_underflow = 0;
1259 SRpnt->sr_request->rq_disk = NULL; /* "sg" _disowns_ request blk */
1261 srp->my_cmdp = NULL;
1263 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1264 sdp->disk->disk_name, srp->header.pack_id, (int) SRpnt->sr_result));
1265 srp->header.resid = SCpnt->resid;
1266 /* N.B. unit of duration changes here from jiffies to millisecs */
1267 srp->header.duration =
1268 jiffies_to_msecs(jiffies - srp->header.duration);
1269 if (0 != SRpnt->sr_result) {
1270 memcpy(srp->sense_b, SRpnt->sr_sense_buffer,
1271 sizeof (srp->sense_b));
1272 srp->header.status = 0xff & SRpnt->sr_result;
1273 srp->header.masked_status = status_byte(SRpnt->sr_result);
1274 srp->header.msg_status = msg_byte(SRpnt->sr_result);
1275 srp->header.host_status = host_byte(SRpnt->sr_result);
1276 srp->header.driver_status = driver_byte(SRpnt->sr_result);
1277 if ((sdp->sgdebug > 0) &&
1278 ((CHECK_CONDITION == srp->header.masked_status) ||
1279 (COMMAND_TERMINATED == srp->header.masked_status)))
1280 print_req_sense("sg_cmd_done", SRpnt);
1282 /* Following if statement is a patch supplied by Eric Youngdale */
1283 if (driver_byte(SRpnt->sr_result) != 0
1284 && (SRpnt->sr_sense_buffer[0] & 0x7f) == 0x70
1285 && (SRpnt->sr_sense_buffer[2] & 0xf) == UNIT_ATTENTION
1286 && sdp->device->removable) {
1287 /* Detected disc change. Set the bit - this may be used if */
1288 /* there are filesystems using this device. */
1289 sdp->device->changed = 1;
1292 /* Rely on write phase to clean out srp status values, so no "else" */
1294 scsi_release_request(SRpnt);
1295 SRpnt = NULL;
1296 if (sfp->closed) { /* whoops this fd already released, cleanup */
1297 SCSI_LOG_TIMEOUT(1, printk("sg_cmd_done: already closed, freeing ...\n"));
1298 sg_finish_rem_req(srp);
1299 srp = NULL;
1300 if (NULL == sfp->headrp) {
1301 SCSI_LOG_TIMEOUT(1, printk("sg...bh: already closed, final cleanup\n"));
1302 if (0 == sg_remove_sfp(sdp, sfp)) { /* device still present */
1303 scsi_device_put(sdp->device);
1305 sfp = NULL;
1307 } else if (srp && srp->orphan) {
1308 if (sfp->keep_orphan)
1309 srp->sg_io_owned = 0;
1310 else {
1311 sg_finish_rem_req(srp);
1312 srp = NULL;
1315 if (sfp && srp) {
1316 /* Now wake up any sg_read() that is waiting for this packet. */
1317 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1318 srp->done = 1;
1319 wake_up_interruptible(&sfp->read_wait);
1323 static struct file_operations sg_fops = {
1324 .owner = THIS_MODULE,
1325 .read = sg_read,
1326 .write = sg_write,
1327 .poll = sg_poll,
1328 .ioctl = sg_ioctl,
1329 .open = sg_open,
1330 .mmap = sg_mmap,
1331 .release = sg_release,
1332 .fasync = sg_fasync,
1335 static struct class_simple * sg_sysfs_class;
1337 static int sg_sysfs_valid = 0;
1339 static int sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1341 Sg_device *sdp;
1342 unsigned long iflags;
1343 void *old_sg_dev_arr = NULL;
1344 int k, error;
1346 sdp = kmalloc(sizeof(Sg_device), GFP_KERNEL);
1347 if (!sdp) {
1348 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1349 return -ENOMEM;
1352 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1353 if (unlikely(sg_nr_dev >= sg_dev_max)) { /* try to resize */
1354 Sg_device **tmp_da;
1355 int tmp_dev_max = sg_nr_dev + SG_DEV_ARR_LUMP;
1356 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1358 tmp_da = kmalloc(tmp_dev_max * sizeof(Sg_device *), GFP_KERNEL);
1359 if (unlikely(!tmp_da))
1360 goto expand_failed;
1362 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1363 memset(tmp_da, 0, tmp_dev_max * sizeof(Sg_device *));
1364 memcpy(tmp_da, sg_dev_arr, sg_dev_max * sizeof(Sg_device *));
1365 old_sg_dev_arr = sg_dev_arr;
1366 sg_dev_arr = tmp_da;
1367 sg_dev_max = tmp_dev_max;
1370 for (k = 0; k < sg_dev_max; k++)
1371 if (!sg_dev_arr[k])
1372 break;
1373 if (unlikely(k >= SG_MAX_DEVS))
1374 goto overflow;
1376 memset(sdp, 0, sizeof(*sdp));
1377 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1378 sprintf(disk->disk_name, "sg%d", k);
1379 disk->first_minor = k;
1380 sdp->disk = disk;
1381 sdp->device = scsidp;
1382 init_waitqueue_head(&sdp->o_excl_wait);
1383 sdp->sg_tablesize = scsidp->host ? scsidp->host->sg_tablesize : 0;
1385 sg_nr_dev++;
1386 sg_dev_arr[k] = sdp;
1387 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1388 error = k;
1390 out:
1391 if (error < 0)
1392 kfree(sdp);
1393 kfree(old_sg_dev_arr);
1394 return error;
1396 expand_failed:
1397 printk(KERN_WARNING "sg_alloc: device array cannot be resized\n");
1398 error = -ENOMEM;
1399 goto out;
1401 overflow:
1402 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1403 printk(KERN_WARNING
1404 "Unable to attach sg device <%d, %d, %d, %d> type=%d, minor "
1405 "number exceeds %d\n", scsidp->host->host_no, scsidp->channel,
1406 scsidp->id, scsidp->lun, scsidp->type, SG_MAX_DEVS - 1);
1407 error = -ENODEV;
1408 goto out;
1411 static int
1412 sg_add(struct class_device *cl_dev)
1414 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1415 struct gendisk *disk;
1416 Sg_device *sdp = NULL;
1417 struct cdev * cdev = NULL;
1418 int error, k;
1420 disk = alloc_disk(1);
1421 if (!disk) {
1422 printk(KERN_WARNING "alloc_disk failed\n");
1423 return -ENOMEM;
1425 disk->major = SCSI_GENERIC_MAJOR;
1427 error = -ENOMEM;
1428 cdev = cdev_alloc();
1429 if (!cdev) {
1430 printk(KERN_WARNING "cdev_alloc failed\n");
1431 goto out;
1433 cdev->owner = THIS_MODULE;
1434 cdev->ops = &sg_fops;
1436 error = sg_alloc(disk, scsidp);
1437 if (error < 0) {
1438 printk(KERN_WARNING "sg_alloc failed\n");
1439 goto out;
1441 k = error;
1442 sdp = sg_dev_arr[k];
1444 devfs_mk_cdev(MKDEV(SCSI_GENERIC_MAJOR, k),
1445 S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP,
1446 "%s/generic", scsidp->devfs_name);
1447 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, k), 1);
1448 if (error) {
1449 devfs_remove("%s/generic", scsidp->devfs_name);
1450 goto out;
1452 sdp->cdev = cdev;
1453 if (sg_sysfs_valid) {
1454 struct class_device * sg_class_member;
1456 sg_class_member = class_simple_device_add(sg_sysfs_class,
1457 MKDEV(SCSI_GENERIC_MAJOR, k),
1458 cl_dev->dev, "%s",
1459 disk->disk_name);
1460 if (IS_ERR(sg_class_member))
1461 printk(KERN_WARNING "sg_add: "
1462 "class_simple_device_add failed\n");
1463 class_set_devdata(sg_class_member, sdp);
1464 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1465 &sg_class_member->kobj, "generic");
1466 if (error)
1467 printk(KERN_ERR "sg_add: unable to make symlink "
1468 "'generic' back to sg%d\n", k);
1469 } else
1470 printk(KERN_WARNING "sg_add: sg_sys INvalid\n");
1472 printk(KERN_NOTICE
1473 "Attached scsi generic sg%d at scsi%d, channel"
1474 " %d, id %d, lun %d, type %d\n", k,
1475 scsidp->host->host_no, scsidp->channel, scsidp->id,
1476 scsidp->lun, scsidp->type);
1478 return 0;
1480 out:
1481 put_disk(disk);
1482 if (cdev)
1483 cdev_del(cdev);
1484 return error;
1487 static void
1488 sg_remove(struct class_device *cl_dev)
1490 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1491 Sg_device *sdp = NULL;
1492 unsigned long iflags;
1493 Sg_fd *sfp;
1494 Sg_fd *tsfp;
1495 Sg_request *srp;
1496 Sg_request *tsrp;
1497 int k, delay;
1499 if (NULL == sg_dev_arr)
1500 return;
1501 delay = 0;
1502 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1503 for (k = 0; k < sg_dev_max; k++) {
1504 sdp = sg_dev_arr[k];
1505 if ((NULL == sdp) || (sdp->device != scsidp))
1506 continue; /* dirty but lowers nesting */
1507 if (sdp->headfp) {
1508 sdp->detached = 1;
1509 for (sfp = sdp->headfp; sfp; sfp = tsfp) {
1510 tsfp = sfp->nextfp;
1511 for (srp = sfp->headrp; srp; srp = tsrp) {
1512 tsrp = srp->nextrp;
1513 if (sfp->closed || (0 == srp->done))
1514 sg_finish_rem_req(srp);
1516 if (sfp->closed) {
1517 scsi_device_put(sdp->device);
1518 __sg_remove_sfp(sdp, sfp);
1519 } else {
1520 delay = 1;
1521 wake_up_interruptible(&sfp->read_wait);
1522 kill_fasync(&sfp->async_qp, SIGPOLL,
1523 POLL_HUP);
1526 SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d, dirty\n", k));
1527 if (NULL == sdp->headfp) {
1528 sg_dev_arr[k] = NULL;
1530 } else { /* nothing active, simple case */
1531 SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d\n", k));
1532 sg_dev_arr[k] = NULL;
1534 sg_nr_dev--;
1535 break;
1537 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1539 if (sdp) {
1540 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1541 class_simple_device_remove(MKDEV(SCSI_GENERIC_MAJOR, k));
1542 cdev_del(sdp->cdev);
1543 sdp->cdev = NULL;
1544 devfs_remove("%s/generic", scsidp->devfs_name);
1545 put_disk(sdp->disk);
1546 sdp->disk = NULL;
1547 if (NULL == sdp->headfp)
1548 kfree((char *) sdp);
1551 if (delay)
1552 msleep(10); /* dirty detach so delay device destruction */
1555 /* Set 'perm' (4th argument) to 0 to disable module_param's definition
1556 * of sysfs parameters (which module_param doesn't yet support).
1557 * Sysfs parameters defined explicitly below.
1559 module_param_named(def_reserved_size, def_reserved_size, int, 0);
1560 module_param_named(allow_dio, sg_allow_dio, int, 0);
1562 MODULE_AUTHOR("Douglas Gilbert");
1563 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1564 MODULE_LICENSE("GPL");
1565 MODULE_VERSION(SG_VERSION_STR);
1567 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1568 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1570 static int __init
1571 init_sg(void)
1573 int rc;
1575 if (def_reserved_size >= 0)
1576 sg_big_buff = def_reserved_size;
1578 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1579 SG_MAX_DEVS, "sg");
1580 if (rc)
1581 return rc;
1582 sg_sysfs_class = class_simple_create(THIS_MODULE, "scsi_generic");
1583 if ( IS_ERR(sg_sysfs_class) ) {
1584 rc = PTR_ERR(sg_sysfs_class);
1585 goto err_out;
1587 sg_sysfs_valid = 1;
1588 rc = scsi_register_interface(&sg_interface);
1589 if (0 == rc) {
1590 #ifdef CONFIG_SCSI_PROC_FS
1591 sg_proc_init();
1592 #endif /* CONFIG_SCSI_PROC_FS */
1593 return 0;
1595 class_simple_destroy(sg_sysfs_class);
1596 err_out:
1597 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1598 return rc;
1601 static void __exit
1602 exit_sg(void)
1604 #ifdef CONFIG_SCSI_PROC_FS
1605 sg_proc_cleanup();
1606 #endif /* CONFIG_SCSI_PROC_FS */
1607 scsi_unregister_interface(&sg_interface);
1608 class_simple_destroy(sg_sysfs_class);
1609 sg_sysfs_valid = 0;
1610 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1611 SG_MAX_DEVS);
1612 if (sg_dev_arr != NULL) {
1613 kfree((char *) sg_dev_arr);
1614 sg_dev_arr = NULL;
1616 sg_dev_max = 0;
1619 static int
1620 sg_start_req(Sg_request * srp)
1622 int res;
1623 Sg_fd *sfp = srp->parentfp;
1624 sg_io_hdr_t *hp = &srp->header;
1625 int dxfer_len = (int) hp->dxfer_len;
1626 int dxfer_dir = hp->dxfer_direction;
1627 Sg_scatter_hold *req_schp = &srp->data;
1628 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1630 SCSI_LOG_TIMEOUT(4, printk("sg_start_req: dxfer_len=%d\n", dxfer_len));
1631 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1632 return 0;
1633 if (sg_allow_dio && (hp->flags & SG_FLAG_DIRECT_IO) &&
1634 (dxfer_dir != SG_DXFER_UNKNOWN) && (0 == hp->iovec_count) &&
1635 (!sfp->parentdp->device->host->unchecked_isa_dma)) {
1636 res = sg_build_direct(srp, sfp, dxfer_len);
1637 if (res <= 0) /* -ve -> error, 0 -> done, 1 -> try indirect */
1638 return res;
1640 if ((!sg_res_in_use(sfp)) && (dxfer_len <= rsv_schp->bufflen))
1641 sg_link_reserve(sfp, srp, dxfer_len);
1642 else {
1643 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1644 if (res) {
1645 sg_remove_scat(req_schp);
1646 return res;
1649 return 0;
1652 static void
1653 sg_finish_rem_req(Sg_request * srp)
1655 Sg_fd *sfp = srp->parentfp;
1656 Sg_scatter_hold *req_schp = &srp->data;
1658 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1659 if (srp->res_used)
1660 sg_unlink_reserve(sfp, srp);
1661 else
1662 sg_remove_scat(req_schp);
1663 sg_remove_request(sfp, srp);
1666 static int
1667 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1669 int ret_sz;
1670 int elem_sz = sizeof (struct scatterlist);
1671 int sg_bufflen = tablesize * elem_sz;
1672 int mx_sc_elems = tablesize;
1674 schp->buffer = sg_page_malloc(sg_bufflen, sfp->low_dma, &ret_sz);
1675 if (!schp->buffer)
1676 return -ENOMEM;
1677 else if (ret_sz != sg_bufflen) {
1678 sg_bufflen = ret_sz;
1679 mx_sc_elems = sg_bufflen / elem_sz;
1681 schp->sglist_len = sg_bufflen;
1682 memset(schp->buffer, 0, sg_bufflen);
1683 return mx_sc_elems; /* number of scat_gath elements allocated */
1686 #ifdef SG_ALLOW_DIO_CODE
1687 /* vvvvvvvv following code borrowed from st driver's direct IO vvvvvvvvv */
1688 /* hopefully this generic code will moved to a library */
1690 /* Pin down user pages and put them into a scatter gather list. Returns <= 0 if
1691 - mapping of all pages not successful
1692 - any page is above max_pfn
1693 (i.e., either completely successful or fails)
1695 static int
1696 st_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages,
1697 unsigned long uaddr, size_t count, int rw,
1698 unsigned long max_pfn)
1700 int res, i, j;
1701 unsigned int nr_pages;
1702 struct page **pages;
1704 nr_pages = ((uaddr & ~PAGE_MASK) + count + ~PAGE_MASK) >> PAGE_SHIFT;
1706 /* User attempted Overflow! */
1707 if ((uaddr + count) < uaddr)
1708 return -EINVAL;
1710 /* Too big */
1711 if (nr_pages > max_pages)
1712 return -ENOMEM;
1714 /* Hmm? */
1715 if (count == 0)
1716 return 0;
1718 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_ATOMIC)) == NULL)
1719 return -ENOMEM;
1721 /* Try to fault in all of the necessary pages */
1722 down_read(&current->mm->mmap_sem);
1723 /* rw==READ means read from drive, write into memory area */
1724 res = get_user_pages(
1725 current,
1726 current->mm,
1727 uaddr,
1728 nr_pages,
1729 rw == READ,
1730 0, /* don't force */
1731 pages,
1732 NULL);
1733 up_read(&current->mm->mmap_sem);
1735 /* Errors and no page mapped should return here */
1736 if (res < nr_pages)
1737 goto out_unmap;
1739 for (i=0; i < nr_pages; i++) {
1740 /* FIXME: flush superflous for rw==READ,
1741 * probably wrong function for rw==WRITE
1743 flush_dcache_page(pages[i]);
1744 if (page_to_pfn(pages[i]) > max_pfn)
1745 goto out_unlock;
1746 /* ?? Is locking needed? I don't think so */
1747 /* if (TestSetPageLocked(pages[i]))
1748 goto out_unlock; */
1751 /* Populate the scatter/gather list */
1752 sgl[0].page = pages[0];
1753 sgl[0].offset = uaddr & ~PAGE_MASK;
1754 if (nr_pages > 1) {
1755 sgl[0].length = PAGE_SIZE - sgl[0].offset;
1756 count -= sgl[0].length;
1757 for (i=1; i < nr_pages ; i++) {
1758 sgl[i].offset = 0;
1759 sgl[i].page = pages[i];
1760 sgl[i].length = count < PAGE_SIZE ? count : PAGE_SIZE;
1761 count -= PAGE_SIZE;
1764 else {
1765 sgl[0].length = count;
1768 kfree(pages);
1769 return nr_pages;
1771 out_unlock:
1772 /* for (j=0; j < i; j++)
1773 unlock_page(pages[j]); */
1774 res = 0;
1775 out_unmap:
1776 if (res > 0)
1777 for (j=0; j < res; j++)
1778 page_cache_release(pages[j]);
1779 kfree(pages);
1780 return res;
1784 /* And unmap them... */
1785 static int
1786 st_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
1787 int dirtied)
1789 int i;
1791 for (i=0; i < nr_pages; i++) {
1792 if (dirtied && !PageReserved(sgl[i].page))
1793 SetPageDirty(sgl[i].page);
1794 /* unlock_page(sgl[i].page); */
1795 /* FIXME: cache flush missing for rw==READ
1796 * FIXME: call the correct reference counting function
1798 page_cache_release(sgl[i].page);
1801 return 0;
1804 /* ^^^^^^^^ above code borrowed from st driver's direct IO ^^^^^^^^^ */
1805 #endif
1808 /* Returns: -ve -> error, 0 -> done, 1 -> try indirect */
1809 static int
1810 sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len)
1812 #ifdef SG_ALLOW_DIO_CODE
1813 sg_io_hdr_t *hp = &srp->header;
1814 Sg_scatter_hold *schp = &srp->data;
1815 int sg_tablesize = sfp->parentdp->sg_tablesize;
1816 struct scatterlist *sgl;
1817 int mx_sc_elems, res;
1818 struct scsi_device *sdev = sfp->parentdp->device;
1820 if (((unsigned long)hp->dxferp &
1821 queue_dma_alignment(sdev->request_queue)) != 0)
1822 return 1;
1823 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1824 if (mx_sc_elems <= 0) {
1825 return 1;
1827 sgl = (struct scatterlist *)schp->buffer;
1828 res = st_map_user_pages(sgl, mx_sc_elems, (unsigned long)hp->dxferp, dxfer_len,
1829 (SG_DXFER_TO_DEV == hp->dxfer_direction) ? 1 : 0, ULONG_MAX);
1830 if (res <= 0)
1831 return 1;
1832 schp->k_use_sg = res;
1833 schp->dio_in_use = 1;
1834 hp->info |= SG_INFO_DIRECT_IO;
1835 return 0;
1836 #else
1837 return 1;
1838 #endif
1841 static int
1842 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1844 int ret_sz;
1845 int blk_size = buff_size;
1846 unsigned char *p = NULL;
1848 if ((blk_size < 0) || (!sfp))
1849 return -EFAULT;
1850 if (0 == blk_size)
1851 ++blk_size; /* don't know why */
1852 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1853 blk_size = (blk_size + SG_SECTOR_MSK) & (~SG_SECTOR_MSK);
1854 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1855 buff_size, blk_size));
1856 if (blk_size <= SG_SCATTER_SZ) {
1857 p = sg_page_malloc(blk_size, sfp->low_dma, &ret_sz);
1858 if (!p)
1859 return -ENOMEM;
1860 if (blk_size == ret_sz) { /* got it on the first attempt */
1861 schp->k_use_sg = 0;
1862 schp->buffer = p;
1863 schp->bufflen = blk_size;
1864 schp->b_malloc_len = blk_size;
1865 return 0;
1867 } else {
1868 p = sg_page_malloc(SG_SCATTER_SZ, sfp->low_dma, &ret_sz);
1869 if (!p)
1870 return -ENOMEM;
1872 /* Want some local declarations, so start new block ... */
1873 { /* lets try and build a scatter gather list */
1874 struct scatterlist *sclp;
1875 int k, rem_sz, num;
1876 int mx_sc_elems;
1877 int sg_tablesize = sfp->parentdp->sg_tablesize;
1878 int first = 1;
1880 /* N.B. ret_sz carried into this block ... */
1881 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1882 if (mx_sc_elems < 0)
1883 return mx_sc_elems; /* most likely -ENOMEM */
1885 for (k = 0, sclp = schp->buffer, rem_sz = blk_size;
1886 (rem_sz > 0) && (k < mx_sc_elems);
1887 ++k, rem_sz -= ret_sz, ++sclp) {
1888 if (first)
1889 first = 0;
1890 else {
1891 num =
1892 (rem_sz >
1893 SG_SCATTER_SZ) ? SG_SCATTER_SZ : rem_sz;
1894 p = sg_page_malloc(num, sfp->low_dma, &ret_sz);
1895 if (!p)
1896 break;
1898 sclp->page = virt_to_page(p);
1899 sclp->offset = offset_in_page(p);
1900 sclp->length = ret_sz;
1902 SCSI_LOG_TIMEOUT(5, printk("sg_build_build: k=%d, a=0x%p, len=%d\n",
1903 k, sg_scatg2virt(sclp), ret_sz));
1904 } /* end of for loop */
1905 schp->k_use_sg = k;
1906 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, rem_sz=%d\n", k, rem_sz));
1907 schp->bufflen = blk_size;
1908 if (rem_sz > 0) /* must have failed */
1909 return -ENOMEM;
1911 return 0;
1914 static int
1915 sg_write_xfer(Sg_request * srp)
1917 sg_io_hdr_t *hp = &srp->header;
1918 Sg_scatter_hold *schp = &srp->data;
1919 int num_xfer = 0;
1920 int j, k, onum, usglen, ksglen, res;
1921 int iovec_count = (int) hp->iovec_count;
1922 int dxfer_dir = hp->dxfer_direction;
1923 unsigned char *p;
1924 unsigned char __user *up;
1925 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
1927 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_TO_DEV == dxfer_dir) ||
1928 (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
1929 num_xfer = (int) (new_interface ? hp->dxfer_len : hp->flags);
1930 if (schp->bufflen < num_xfer)
1931 num_xfer = schp->bufflen;
1933 if ((num_xfer <= 0) || (schp->dio_in_use) ||
1934 (new_interface
1935 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
1936 return 0;
1938 SCSI_LOG_TIMEOUT(4, printk("sg_write_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
1939 num_xfer, iovec_count, schp->k_use_sg));
1940 if (iovec_count) {
1941 onum = iovec_count;
1942 if ((k = verify_area(VERIFY_READ, hp->dxferp,
1943 SZ_SG_IOVEC * onum)))
1944 return k;
1945 } else
1946 onum = 1;
1948 if (0 == schp->k_use_sg) { /* kernel has single buffer */
1949 for (j = 0, p = schp->buffer; j < onum; ++j) {
1950 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1951 if (res)
1952 return res;
1953 usglen = (num_xfer > usglen) ? usglen : num_xfer;
1954 if (__copy_from_user(p, up, usglen))
1955 return -EFAULT;
1956 p += usglen;
1957 num_xfer -= usglen;
1958 if (num_xfer <= 0)
1959 return 0;
1961 } else { /* kernel using scatter gather list */
1962 struct scatterlist *sclp = (struct scatterlist *) schp->buffer;
1964 ksglen = (int) sclp->length;
1965 p = sg_scatg2virt(sclp);
1966 for (j = 0, k = 0; j < onum; ++j) {
1967 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1968 if (res)
1969 return res;
1971 for (; p; ++sclp, ksglen = (int) sclp->length,
1972 p = sg_scatg2virt(sclp)) {
1973 if (usglen <= 0)
1974 break;
1975 if (ksglen > usglen) {
1976 if (usglen >= num_xfer) {
1977 if (__copy_from_user
1978 (p, up, num_xfer))
1979 return -EFAULT;
1980 return 0;
1982 if (__copy_from_user(p, up, usglen))
1983 return -EFAULT;
1984 p += usglen;
1985 ksglen -= usglen;
1986 break;
1987 } else {
1988 if (ksglen >= num_xfer) {
1989 if (__copy_from_user
1990 (p, up, num_xfer))
1991 return -EFAULT;
1992 return 0;
1994 if (__copy_from_user(p, up, ksglen))
1995 return -EFAULT;
1996 up += ksglen;
1997 usglen -= ksglen;
1999 ++k;
2000 if (k >= schp->k_use_sg)
2001 return 0;
2005 return 0;
2008 static int
2009 sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
2010 int wr_xf, int *countp, unsigned char __user **up)
2012 int num_xfer = (int) hp->dxfer_len;
2013 unsigned char __user *p = hp->dxferp;
2014 int count, k;
2016 if (0 == sg_num) {
2017 if (wr_xf && ('\0' == hp->interface_id))
2018 count = (int) hp->flags; /* holds "old" input_size */
2019 else
2020 count = num_xfer;
2021 } else {
2022 sg_iovec_t iovec;
2023 if (__copy_from_user(&iovec, p + ind*SZ_SG_IOVEC, SZ_SG_IOVEC))
2024 return -EFAULT;
2025 p = iovec.iov_base;
2026 count = (int) iovec.iov_len;
2028 if ((k = verify_area(wr_xf ? VERIFY_READ : VERIFY_WRITE, p, count)))
2029 return k;
2030 if (up)
2031 *up = p;
2032 if (countp)
2033 *countp = count;
2034 return 0;
2037 static void
2038 sg_remove_scat(Sg_scatter_hold * schp)
2040 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
2041 if (schp->buffer && (schp->sglist_len > 0)) {
2042 struct scatterlist *sclp = (struct scatterlist *) schp->buffer;
2044 if (schp->dio_in_use) {
2045 #ifdef SG_ALLOW_DIO_CODE
2046 st_unmap_user_pages(sclp, schp->k_use_sg, TRUE);
2047 #endif
2048 } else {
2049 int k;
2051 for (k = 0; (k < schp->k_use_sg) && sg_scatg2virt(sclp);
2052 ++k, ++sclp) {
2053 SCSI_LOG_TIMEOUT(5, printk(
2054 "sg_remove_scat: k=%d, a=0x%p, len=%d\n",
2055 k, sg_scatg2virt(sclp), sclp->length));
2056 sg_page_free(sg_scatg2virt(sclp), sclp->length);
2057 sclp->page = NULL;
2058 sclp->offset = 0;
2059 sclp->length = 0;
2062 sg_page_free(schp->buffer, schp->sglist_len);
2063 } else if (schp->buffer)
2064 sg_page_free(schp->buffer, schp->b_malloc_len);
2065 memset(schp, 0, sizeof (*schp));
2068 static int
2069 sg_read_xfer(Sg_request * srp)
2071 sg_io_hdr_t *hp = &srp->header;
2072 Sg_scatter_hold *schp = &srp->data;
2073 int num_xfer = 0;
2074 int j, k, onum, usglen, ksglen, res;
2075 int iovec_count = (int) hp->iovec_count;
2076 int dxfer_dir = hp->dxfer_direction;
2077 unsigned char *p;
2078 unsigned char __user *up;
2079 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
2081 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_FROM_DEV == dxfer_dir)
2082 || (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
2083 num_xfer = hp->dxfer_len;
2084 if (schp->bufflen < num_xfer)
2085 num_xfer = schp->bufflen;
2087 if ((num_xfer <= 0) || (schp->dio_in_use) ||
2088 (new_interface
2089 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
2090 return 0;
2092 SCSI_LOG_TIMEOUT(4, printk("sg_read_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
2093 num_xfer, iovec_count, schp->k_use_sg));
2094 if (iovec_count) {
2095 onum = iovec_count;
2096 if ((k = verify_area(VERIFY_READ, hp->dxferp,
2097 SZ_SG_IOVEC * onum)))
2098 return k;
2099 } else
2100 onum = 1;
2102 if (0 == schp->k_use_sg) { /* kernel has single buffer */
2103 for (j = 0, p = schp->buffer; j < onum; ++j) {
2104 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2105 if (res)
2106 return res;
2107 usglen = (num_xfer > usglen) ? usglen : num_xfer;
2108 if (__copy_to_user(up, p, usglen))
2109 return -EFAULT;
2110 p += usglen;
2111 num_xfer -= usglen;
2112 if (num_xfer <= 0)
2113 return 0;
2115 } else { /* kernel using scatter gather list */
2116 struct scatterlist *sclp = (struct scatterlist *) schp->buffer;
2118 ksglen = (int) sclp->length;
2119 p = sg_scatg2virt(sclp);
2120 for (j = 0, k = 0; j < onum; ++j) {
2121 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2122 if (res)
2123 return res;
2125 for (; p; ++sclp, ksglen = (int) sclp->length,
2126 p = sg_scatg2virt(sclp)) {
2127 if (usglen <= 0)
2128 break;
2129 if (ksglen > usglen) {
2130 if (usglen >= num_xfer) {
2131 if (__copy_to_user
2132 (up, p, num_xfer))
2133 return -EFAULT;
2134 return 0;
2136 if (__copy_to_user(up, p, usglen))
2137 return -EFAULT;
2138 p += usglen;
2139 ksglen -= usglen;
2140 break;
2141 } else {
2142 if (ksglen >= num_xfer) {
2143 if (__copy_to_user
2144 (up, p, num_xfer))
2145 return -EFAULT;
2146 return 0;
2148 if (__copy_to_user(up, p, ksglen))
2149 return -EFAULT;
2150 up += ksglen;
2151 usglen -= ksglen;
2153 ++k;
2154 if (k >= schp->k_use_sg)
2155 return 0;
2159 return 0;
2162 static int
2163 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
2165 Sg_scatter_hold *schp = &srp->data;
2167 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
2168 num_read_xfer));
2169 if ((!outp) || (num_read_xfer <= 0))
2170 return 0;
2171 if (schp->k_use_sg > 0) {
2172 int k, num;
2173 struct scatterlist *sclp = (struct scatterlist *) schp->buffer;
2175 for (k = 0; (k < schp->k_use_sg) && sg_scatg2virt(sclp);
2176 ++k, ++sclp) {
2177 num = (int) sclp->length;
2178 if (num > num_read_xfer) {
2179 if (__copy_to_user
2180 (outp, sg_scatg2virt(sclp), num_read_xfer))
2181 return -EFAULT;
2182 break;
2183 } else {
2184 if (__copy_to_user
2185 (outp, sg_scatg2virt(sclp), num))
2186 return -EFAULT;
2187 num_read_xfer -= num;
2188 if (num_read_xfer <= 0)
2189 break;
2190 outp += num;
2193 } else {
2194 if (__copy_to_user(outp, schp->buffer, num_read_xfer))
2195 return -EFAULT;
2197 return 0;
2200 static void
2201 sg_build_reserve(Sg_fd * sfp, int req_size)
2203 Sg_scatter_hold *schp = &sfp->reserve;
2205 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
2206 do {
2207 if (req_size < PAGE_SIZE)
2208 req_size = PAGE_SIZE;
2209 if (0 == sg_build_indirect(schp, sfp, req_size))
2210 return;
2211 else
2212 sg_remove_scat(schp);
2213 req_size >>= 1; /* divide by 2 */
2214 } while (req_size > (PAGE_SIZE / 2));
2217 static void
2218 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2220 Sg_scatter_hold *req_schp = &srp->data;
2221 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2223 srp->res_used = 1;
2224 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
2225 size = (size + 1) & (~1); /* round to even for aha1542 */
2226 if (rsv_schp->k_use_sg > 0) {
2227 int k, num;
2228 int rem = size;
2229 struct scatterlist *sclp =
2230 (struct scatterlist *) rsv_schp->buffer;
2232 for (k = 0; k < rsv_schp->k_use_sg; ++k, ++sclp) {
2233 num = (int) sclp->length;
2234 if (rem <= num) {
2235 if (0 == k) {
2236 req_schp->k_use_sg = 0;
2237 req_schp->buffer = sg_scatg2virt(sclp);
2238 } else {
2239 sfp->save_scat_len = num;
2240 sclp->length = (unsigned) rem;
2241 req_schp->k_use_sg = k + 1;
2242 req_schp->sglist_len =
2243 rsv_schp->sglist_len;
2244 req_schp->buffer = rsv_schp->buffer;
2246 req_schp->bufflen = size;
2247 req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2248 break;
2249 } else
2250 rem -= num;
2252 if (k >= rsv_schp->k_use_sg)
2253 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
2254 } else {
2255 req_schp->k_use_sg = 0;
2256 req_schp->bufflen = size;
2257 req_schp->buffer = rsv_schp->buffer;
2258 req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2262 static void
2263 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2265 Sg_scatter_hold *req_schp = &srp->data;
2266 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2268 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
2269 (int) req_schp->k_use_sg));
2270 if ((rsv_schp->k_use_sg > 0) && (req_schp->k_use_sg > 0)) {
2271 struct scatterlist *sclp =
2272 (struct scatterlist *) rsv_schp->buffer;
2274 if (sfp->save_scat_len > 0)
2275 (sclp + (req_schp->k_use_sg - 1))->length =
2276 (unsigned) sfp->save_scat_len;
2277 else
2278 SCSI_LOG_TIMEOUT(1, printk ("sg_unlink_reserve: BAD save_scat_len\n"));
2280 req_schp->k_use_sg = 0;
2281 req_schp->bufflen = 0;
2282 req_schp->buffer = NULL;
2283 req_schp->sglist_len = 0;
2284 sfp->save_scat_len = 0;
2285 srp->res_used = 0;
2288 static Sg_request *
2289 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2291 Sg_request *resp;
2292 unsigned long iflags;
2294 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2295 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2296 /* look for requests that are ready + not SG_IO owned */
2297 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2298 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2299 resp->done = 2; /* guard against other readers */
2300 break;
2303 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2304 return resp;
2307 #ifdef CONFIG_SCSI_PROC_FS
2308 static Sg_request *
2309 sg_get_nth_request(Sg_fd * sfp, int nth)
2311 Sg_request *resp;
2312 unsigned long iflags;
2313 int k;
2315 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2316 for (k = 0, resp = sfp->headrp; resp && (k < nth);
2317 ++k, resp = resp->nextrp) ;
2318 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2319 return resp;
2321 #endif
2323 /* always adds to end of list */
2324 static Sg_request *
2325 sg_add_request(Sg_fd * sfp)
2327 int k;
2328 unsigned long iflags;
2329 Sg_request *resp;
2330 Sg_request *rp = sfp->req_arr;
2332 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2333 resp = sfp->headrp;
2334 if (!resp) {
2335 memset(rp, 0, sizeof (Sg_request));
2336 rp->parentfp = sfp;
2337 resp = rp;
2338 sfp->headrp = resp;
2339 } else {
2340 if (0 == sfp->cmd_q)
2341 resp = NULL; /* command queuing disallowed */
2342 else {
2343 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2344 if (!rp->parentfp)
2345 break;
2347 if (k < SG_MAX_QUEUE) {
2348 memset(rp, 0, sizeof (Sg_request));
2349 rp->parentfp = sfp;
2350 while (resp->nextrp)
2351 resp = resp->nextrp;
2352 resp->nextrp = rp;
2353 resp = rp;
2354 } else
2355 resp = NULL;
2358 if (resp) {
2359 resp->nextrp = NULL;
2360 resp->header.duration = jiffies;
2361 resp->my_cmdp = NULL;
2363 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2364 return resp;
2367 /* Return of 1 for found; 0 for not found */
2368 static int
2369 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2371 Sg_request *prev_rp;
2372 Sg_request *rp;
2373 unsigned long iflags;
2374 int res = 0;
2376 if ((!sfp) || (!srp) || (!sfp->headrp))
2377 return res;
2378 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2379 prev_rp = sfp->headrp;
2380 if (srp == prev_rp) {
2381 sfp->headrp = prev_rp->nextrp;
2382 prev_rp->parentfp = NULL;
2383 res = 1;
2384 } else {
2385 while ((rp = prev_rp->nextrp)) {
2386 if (srp == rp) {
2387 prev_rp->nextrp = rp->nextrp;
2388 rp->parentfp = NULL;
2389 res = 1;
2390 break;
2392 prev_rp = rp;
2395 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2396 return res;
2399 #ifdef CONFIG_SCSI_PROC_FS
2400 static Sg_fd *
2401 sg_get_nth_sfp(Sg_device * sdp, int nth)
2403 Sg_fd *resp;
2404 unsigned long iflags;
2405 int k;
2407 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2408 for (k = 0, resp = sdp->headfp; resp && (k < nth);
2409 ++k, resp = resp->nextfp) ;
2410 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2411 return resp;
2413 #endif
2415 static Sg_fd *
2416 sg_add_sfp(Sg_device * sdp, int dev)
2418 Sg_fd *sfp;
2419 unsigned long iflags;
2421 sfp = (Sg_fd *) sg_page_malloc(sizeof (Sg_fd), 0, NULL);
2422 if (!sfp)
2423 return NULL;
2424 memset(sfp, 0, sizeof (Sg_fd));
2425 init_waitqueue_head(&sfp->read_wait);
2426 sfp->rq_list_lock = RW_LOCK_UNLOCKED;
2428 sfp->timeout = SG_DEFAULT_TIMEOUT;
2429 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2430 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2431 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2432 sdp->device->host->unchecked_isa_dma : 1;
2433 sfp->cmd_q = SG_DEF_COMMAND_Q;
2434 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2435 sfp->parentdp = sdp;
2436 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2437 if (!sdp->headfp)
2438 sdp->headfp = sfp;
2439 else { /* add to tail of existing list */
2440 Sg_fd *pfp = sdp->headfp;
2441 while (pfp->nextfp)
2442 pfp = pfp->nextfp;
2443 pfp->nextfp = sfp;
2445 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2446 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2447 sg_build_reserve(sfp, sg_big_buff);
2448 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2449 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2450 return sfp;
2453 static void
2454 __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2456 Sg_fd *fp;
2457 Sg_fd *prev_fp;
2459 prev_fp = sdp->headfp;
2460 if (sfp == prev_fp)
2461 sdp->headfp = prev_fp->nextfp;
2462 else {
2463 while ((fp = prev_fp->nextfp)) {
2464 if (sfp == fp) {
2465 prev_fp->nextfp = fp->nextfp;
2466 break;
2468 prev_fp = fp;
2471 if (sfp->reserve.bufflen > 0) {
2472 SCSI_LOG_TIMEOUT(6,
2473 printk("__sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2474 (int) sfp->reserve.bufflen, (int) sfp->reserve.k_use_sg));
2475 if (sfp->mmap_called)
2476 sg_rb_correct4mmap(&sfp->reserve, 0); /* undo correction */
2477 sg_remove_scat(&sfp->reserve);
2479 sfp->parentdp = NULL;
2480 SCSI_LOG_TIMEOUT(6, printk("__sg_remove_sfp: sfp=0x%p\n", sfp));
2481 sg_page_free((char *) sfp, sizeof (Sg_fd));
2484 /* Returns 0 in normal case, 1 when detached and sdp object removed */
2485 static int
2486 sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2488 Sg_request *srp;
2489 Sg_request *tsrp;
2490 int dirty = 0;
2491 int res = 0;
2493 for (srp = sfp->headrp; srp; srp = tsrp) {
2494 tsrp = srp->nextrp;
2495 if (srp->done)
2496 sg_finish_rem_req(srp);
2497 else
2498 ++dirty;
2500 if (0 == dirty) {
2501 unsigned long iflags;
2503 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2504 __sg_remove_sfp(sdp, sfp);
2505 if (sdp->detached && (NULL == sdp->headfp)) {
2506 int k, maxd;
2508 maxd = sg_dev_max;
2509 for (k = 0; k < maxd; ++k) {
2510 if (sdp == sg_dev_arr[k])
2511 break;
2513 if (k < maxd)
2514 sg_dev_arr[k] = NULL;
2515 kfree((char *) sdp);
2516 res = 1;
2518 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2519 } else {
2520 /* MOD_INC's to inhibit unloading sg and associated adapter driver */
2521 /* only bump the access_count if we actually succeeded in
2522 * throwing another counter on the host module */
2523 scsi_device_get(sdp->device); /* XXX: retval ignored? */
2524 sfp->closed = 1; /* flag dirty state on this fd */
2525 SCSI_LOG_TIMEOUT(1, printk("sg_remove_sfp: worrisome, %d writes pending\n",
2526 dirty));
2528 return res;
2531 static int
2532 sg_res_in_use(Sg_fd * sfp)
2534 const Sg_request *srp;
2535 unsigned long iflags;
2537 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2538 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2539 if (srp->res_used)
2540 break;
2541 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2542 return srp ? 1 : 0;
2545 /* If retSzp==NULL want exact size or fail */
2546 static char *
2547 sg_page_malloc(int rqSz, int lowDma, int *retSzp)
2549 char *resp = NULL;
2550 int page_mask;
2551 int order, a_size;
2552 int resSz = rqSz;
2554 if (rqSz <= 0)
2555 return resp;
2557 if (lowDma)
2558 page_mask = GFP_ATOMIC | GFP_DMA | __GFP_NOWARN;
2559 else
2560 page_mask = GFP_ATOMIC | __GFP_NOWARN;
2562 for (order = 0, a_size = PAGE_SIZE; a_size < rqSz;
2563 order++, a_size <<= 1) ;
2564 resp = (char *) __get_free_pages(page_mask, order);
2565 while ((!resp) && order && retSzp) {
2566 --order;
2567 a_size >>= 1; /* divide by 2, until PAGE_SIZE */
2568 resp = (char *) __get_free_pages(page_mask, order); /* try half */
2569 resSz = a_size;
2571 if (resp) {
2572 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2573 memset(resp, 0, resSz);
2574 if (retSzp)
2575 *retSzp = resSz;
2577 return resp;
2580 static void
2581 sg_page_free(char *buff, int size)
2583 int order, a_size;
2585 if (!buff)
2586 return;
2587 for (order = 0, a_size = PAGE_SIZE; a_size < size;
2588 order++, a_size <<= 1) ;
2589 free_pages((unsigned long) buff, order);
2592 static unsigned char allow_ops[] = { TEST_UNIT_READY, REQUEST_SENSE,
2593 INQUIRY, READ_CAPACITY, READ_BUFFER, READ_6, READ_10, READ_12,
2594 MODE_SENSE, MODE_SENSE_10, LOG_SENSE
2597 static int
2598 sg_allow_access(unsigned char opcode, char dev_type)
2600 int k;
2602 if (TYPE_SCANNER == dev_type) /* TYPE_ROM maybe burner */
2603 return 1;
2604 for (k = 0; k < sizeof (allow_ops); ++k) {
2605 if (opcode == allow_ops[k])
2606 return 1;
2608 return 0;
2611 #ifdef CONFIG_SCSI_PROC_FS
2612 static int
2613 sg_last_dev(void)
2615 int k;
2616 unsigned long iflags;
2618 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2619 for (k = sg_dev_max - 1; k >= 0; --k)
2620 if (sg_dev_arr[k] && sg_dev_arr[k]->device)
2621 break;
2622 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2623 return k + 1; /* origin 1 */
2625 #endif
2627 static Sg_device *
2628 sg_get_dev(int dev)
2630 Sg_device *sdp = NULL;
2631 unsigned long iflags;
2633 if (sg_dev_arr && (dev >= 0)) {
2634 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2635 if (dev < sg_dev_max)
2636 sdp = sg_dev_arr[dev];
2637 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2639 return sdp;
2642 #ifdef CONFIG_SCSI_PROC_FS
2644 static struct proc_dir_entry *sg_proc_sgp = NULL;
2646 static char sg_proc_sg_dirname[] = "scsi/sg";
2648 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2650 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2651 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2652 size_t count, loff_t *off);
2653 static struct file_operations adio_fops = {
2654 /* .owner, .read and .llseek added in sg_proc_init() */
2655 .open = sg_proc_single_open_adio,
2656 .write = sg_proc_write_adio,
2657 .release = single_release,
2660 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2661 static ssize_t sg_proc_write_dressz(struct file *filp,
2662 const char __user *buffer, size_t count, loff_t *off);
2663 static struct file_operations dressz_fops = {
2664 .open = sg_proc_single_open_dressz,
2665 .write = sg_proc_write_dressz,
2666 .release = single_release,
2669 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2670 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2671 static struct file_operations version_fops = {
2672 .open = sg_proc_single_open_version,
2673 .release = single_release,
2676 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2677 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2678 static struct file_operations devhdr_fops = {
2679 .open = sg_proc_single_open_devhdr,
2680 .release = single_release,
2683 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2684 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2685 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2686 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2687 static void dev_seq_stop(struct seq_file *s, void *v);
2688 static struct file_operations dev_fops = {
2689 .open = sg_proc_open_dev,
2690 .release = seq_release,
2692 static struct seq_operations dev_seq_ops = {
2693 .start = dev_seq_start,
2694 .next = dev_seq_next,
2695 .stop = dev_seq_stop,
2696 .show = sg_proc_seq_show_dev,
2699 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2700 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2701 static struct file_operations devstrs_fops = {
2702 .open = sg_proc_open_devstrs,
2703 .release = seq_release,
2705 static struct seq_operations devstrs_seq_ops = {
2706 .start = dev_seq_start,
2707 .next = dev_seq_next,
2708 .stop = dev_seq_stop,
2709 .show = sg_proc_seq_show_devstrs,
2712 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2713 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2714 static struct file_operations debug_fops = {
2715 .open = sg_proc_open_debug,
2716 .release = seq_release,
2718 static struct seq_operations debug_seq_ops = {
2719 .start = dev_seq_start,
2720 .next = dev_seq_next,
2721 .stop = dev_seq_stop,
2722 .show = sg_proc_seq_show_debug,
2726 struct sg_proc_leaf {
2727 const char * name;
2728 struct file_operations * fops;
2731 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2732 {"allow_dio", &adio_fops},
2733 {"debug", &debug_fops},
2734 {"def_reserved_size", &dressz_fops},
2735 {"device_hdr", &devhdr_fops},
2736 {"devices", &dev_fops},
2737 {"device_strs", &devstrs_fops},
2738 {"version", &version_fops}
2741 static int
2742 sg_proc_init(void)
2744 int k, mask;
2745 int num_leaves =
2746 sizeof (sg_proc_leaf_arr) / sizeof (sg_proc_leaf_arr[0]);
2747 struct proc_dir_entry *pdep;
2748 struct sg_proc_leaf * leaf;
2750 sg_proc_sgp = create_proc_entry(sg_proc_sg_dirname,
2751 S_IFDIR | S_IRUGO | S_IXUGO, NULL);
2752 if (!sg_proc_sgp)
2753 return 1;
2754 for (k = 0; k < num_leaves; ++k) {
2755 leaf = &sg_proc_leaf_arr[k];
2756 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2757 pdep = create_proc_entry(leaf->name, mask, sg_proc_sgp);
2758 if (pdep) {
2759 leaf->fops->owner = THIS_MODULE,
2760 leaf->fops->read = seq_read,
2761 leaf->fops->llseek = seq_lseek,
2762 pdep->proc_fops = leaf->fops;
2765 return 0;
2768 static void
2769 sg_proc_cleanup(void)
2771 int k;
2772 int num_leaves =
2773 sizeof (sg_proc_leaf_arr) / sizeof (sg_proc_leaf_arr[0]);
2775 if (!sg_proc_sgp)
2776 return;
2777 for (k = 0; k < num_leaves; ++k)
2778 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2779 remove_proc_entry(sg_proc_sg_dirname, NULL);
2783 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2785 seq_printf(s, "%d\n", *((int *)s->private));
2786 return 0;
2789 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2791 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2794 static ssize_t
2795 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2796 size_t count, loff_t *off)
2798 int num;
2799 char buff[11];
2801 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2802 return -EACCES;
2803 num = (count < 10) ? count : 10;
2804 if (copy_from_user(buff, buffer, num))
2805 return -EFAULT;
2806 buff[num] = '\0';
2807 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2808 return count;
2811 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2813 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2816 static ssize_t
2817 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2818 size_t count, loff_t *off)
2820 int num;
2821 unsigned long k = ULONG_MAX;
2822 char buff[11];
2824 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2825 return -EACCES;
2826 num = (count < 10) ? count : 10;
2827 if (copy_from_user(buff, buffer, num))
2828 return -EFAULT;
2829 buff[num] = '\0';
2830 k = simple_strtoul(buff, NULL, 10);
2831 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2832 sg_big_buff = k;
2833 return count;
2835 return -ERANGE;
2838 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2840 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2841 sg_version_date);
2842 return 0;
2845 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2847 return single_open(file, sg_proc_seq_show_version, NULL);
2850 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2852 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2853 "online\n");
2854 return 0;
2857 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2859 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2862 struct sg_proc_deviter {
2863 loff_t index;
2864 size_t max;
2867 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2869 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2871 if (! it)
2872 return NULL;
2873 if (NULL == sg_dev_arr)
2874 goto err1;
2875 it->index = *pos;
2876 it->max = sg_last_dev();
2877 if (it->index >= it->max)
2878 goto err1;
2879 return it;
2880 err1:
2881 kfree(it);
2882 return NULL;
2885 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2887 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2889 *pos = ++it->index;
2890 return (it->index < it->max) ? it : NULL;
2893 static void dev_seq_stop(struct seq_file *s, void *v)
2895 kfree (v);
2898 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2900 return seq_open(file, &dev_seq_ops);
2903 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2905 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2906 Sg_device *sdp;
2907 struct scsi_device *scsidp;
2909 sdp = it ? sg_get_dev(it->index) : NULL;
2910 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2911 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2912 scsidp->host->host_no, scsidp->channel,
2913 scsidp->id, scsidp->lun, (int) scsidp->type,
2915 (int) scsidp->queue_depth,
2916 (int) scsidp->device_busy,
2917 (int) scsi_device_online(scsidp));
2918 else
2919 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2920 return 0;
2923 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2925 return seq_open(file, &devstrs_seq_ops);
2928 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2930 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2931 Sg_device *sdp;
2932 struct scsi_device *scsidp;
2934 sdp = it ? sg_get_dev(it->index) : NULL;
2935 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2936 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2937 scsidp->vendor, scsidp->model, scsidp->rev);
2938 else
2939 seq_printf(s, "<no active device>\n");
2940 return 0;
2943 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2945 int k, m, new_interface, blen, usg;
2946 Sg_request *srp;
2947 Sg_fd *fp;
2948 const sg_io_hdr_t *hp;
2949 const char * cp;
2951 for (k = 0; (fp = sg_get_nth_sfp(sdp, k)); ++k) {
2952 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2953 "(res)sgat=%d low_dma=%d\n", k + 1,
2954 jiffies_to_msecs(fp->timeout),
2955 fp->reserve.bufflen,
2956 (int) fp->reserve.k_use_sg,
2957 (int) fp->low_dma);
2958 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2959 (int) fp->cmd_q, (int) fp->force_packid,
2960 (int) fp->keep_orphan, (int) fp->closed);
2961 for (m = 0; (srp = sg_get_nth_request(fp, m)); ++m) {
2962 hp = &srp->header;
2963 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2964 if (srp->res_used) {
2965 if (new_interface &&
2966 (SG_FLAG_MMAP_IO & hp->flags))
2967 cp = " mmap>> ";
2968 else
2969 cp = " rb>> ";
2970 } else {
2971 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2972 cp = " dio>> ";
2973 else
2974 cp = " ";
2976 seq_printf(s, cp);
2977 blen = srp->my_cmdp ?
2978 srp->my_cmdp->sr_bufflen : srp->data.bufflen;
2979 usg = srp->my_cmdp ?
2980 srp->my_cmdp->sr_use_sg : srp->data.k_use_sg;
2981 seq_printf(s, srp->done ?
2982 ((1 == srp->done) ? "rcv:" : "fin:")
2983 : (srp->my_cmdp ? "act:" : "prior:"));
2984 seq_printf(s, " id=%d blen=%d",
2985 srp->header.pack_id, blen);
2986 if (srp->done)
2987 seq_printf(s, " dur=%d", hp->duration);
2988 else
2989 seq_printf(s, " t_o/elap=%d/%d",
2990 new_interface ? hp->timeout : jiffies_to_msecs(fp->timeout),
2991 jiffies_to_msecs(hp->duration ? (jiffies - hp->duration) : 0));
2992 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2993 (int) srp->data.cmd_opcode);
2995 if (0 == m)
2996 seq_printf(s, " No requests active\n");
3000 static int sg_proc_open_debug(struct inode *inode, struct file *file)
3002 return seq_open(file, &debug_seq_ops);
3005 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
3007 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
3008 Sg_device *sdp;
3010 if (it && (0 == it->index)) {
3011 seq_printf(s, "dev_max(currently)=%d max_active_device=%d "
3012 "(origin 1)\n", sg_dev_max, (int)it->max);
3013 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
3015 sdp = it ? sg_get_dev(it->index) : NULL;
3016 if (sdp) {
3017 struct scsi_device *scsidp = sdp->device;
3019 if (NULL == scsidp) {
3020 seq_printf(s, "device %d detached ??\n",
3021 (int)it->index);
3022 return 0;
3025 if (sg_get_nth_sfp(sdp, 0)) {
3026 seq_printf(s, " >>> device=%s ",
3027 sdp->disk->disk_name);
3028 if (sdp->detached)
3029 seq_printf(s, "detached pending close ");
3030 else
3031 seq_printf
3032 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
3033 scsidp->host->host_no,
3034 scsidp->channel, scsidp->id,
3035 scsidp->lun,
3036 scsidp->host->hostt->emulated);
3037 seq_printf(s, " sg_tablesize=%d excl=%d\n",
3038 sdp->sg_tablesize, sdp->exclude);
3040 sg_proc_debug_helper(s, sdp);
3042 return 0;
3045 #endif /* CONFIG_SCSI_PROC_FS */
3047 module_init(init_sg);
3048 module_exit(exit_sg);
3049 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);