blob: b098942445ec0c43a31b041d1d25e943d28ad55e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
cb59e842005-04-02 13:51:23 -060021static int sg_version_num = 30533; /* 2 digits for each component */
22#define SG_VERSION_STR "3.5.33"
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/cdev.h>
48#include <linux/seq_file.h>
49#include <linux/blkdev.h>
50#include <linux/delay.h>
David Hardeman378f0582005-09-17 17:55:31 +100051#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53#include "scsi.h"
db9dff32005-04-03 14:53:59 -050054#include <scsi/scsi_dbg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <scsi/scsi_host.h>
56#include <scsi/scsi_driver.h>
57#include <scsi/scsi_ioctl.h>
58#include <scsi/sg.h>
59
60#include "scsi_logging.h"
61
62#ifdef CONFIG_SCSI_PROC_FS
63#include <linux/proc_fs.h>
Douglas Gilbert1c8e71d2005-09-09 17:18:57 +100064static char *sg_version_date = "20050908";
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66static int sg_proc_init(void);
67static void sg_proc_cleanup(void);
68#endif
69
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#define SG_ALLOW_DIO_DEF 0
71#define SG_ALLOW_DIO_CODE /* compile out by commenting this define */
72
73#define SG_MAX_DEVS 32768
74
75/*
76 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
77 * Then when using 32 bit integers x * m may overflow during the calculation.
78 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
79 * calculates the same, but prevents the overflow when both m and d
80 * are "small" numbers (like HZ and USER_HZ).
81 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
82 * in 32 bits.
83 */
84#define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
85
86#define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
87
88int sg_big_buff = SG_DEF_RESERVED_SIZE;
89/* N.B. This variable is readable and writeable via
90 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
91 of this size (or less if there is not enough memory) will be reserved
92 for use by this file descriptor. [Deprecated usage: this variable is also
93 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
94 the kernel (i.e. it is not a module).] */
95static int def_reserved_size = -1; /* picks up init parameter */
96static int sg_allow_dio = SG_ALLOW_DIO_DEF;
97
98#define SG_SECTOR_SZ 512
99#define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
100
101#define SG_DEV_ARR_LUMP 32 /* amount to over allocate sg_dev_arr by */
102
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500103static int sg_add(struct class_device *, struct class_interface *);
104static void sg_remove(struct class_device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106static DEFINE_RWLOCK(sg_dev_arr_lock); /* Also used to lock
107 file descriptor list for device */
108
109static struct class_interface sg_interface = {
110 .add = sg_add,
111 .remove = sg_remove,
112};
113
114typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
115 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
116 unsigned short sglist_len; /* size of malloc'd scatter-gather list ++ */
117 unsigned bufflen; /* Size of (aggregate) data buffer */
118 unsigned b_malloc_len; /* actual len malloc'ed in buffer */
Mike Christied6b10342005-11-08 04:06:41 -0600119 struct scatterlist *buffer;/* scatter list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
121 unsigned char cmd_opcode; /* first byte of command */
122} Sg_scatter_hold;
123
124struct sg_device; /* forward declarations */
125struct sg_fd;
126
127typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 struct sg_request *nextrp; /* NULL -> tail request (slist) */
129 struct sg_fd *parentfp; /* NULL -> not in use */
130 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
131 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
Mike Christied6b10342005-11-08 04:06:41 -0600132 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
134 char orphan; /* 1 -> drop on sight, 0 -> normal */
135 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
136 volatile char done; /* 0->before bh, 1->before read, 2->read */
137} Sg_request;
138
139typedef struct sg_fd { /* holds the state of a file descriptor */
140 struct sg_fd *nextfp; /* NULL when last opened fd on this device */
141 struct sg_device *parentdp; /* owning device */
142 wait_queue_head_t read_wait; /* queue read until command done */
143 rwlock_t rq_list_lock; /* protect access to list in req_arr */
144 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
145 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
146 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
147 unsigned save_scat_len; /* original length of trunc. scat. element */
148 Sg_request *headrp; /* head of request slist, NULL->empty */
149 struct fasync_struct *async_qp; /* used by asynchronous notification */
150 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
151 char low_dma; /* as in parent but possibly overridden to 1 */
152 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
153 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
154 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
155 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
156 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
157 char mmap_called; /* 0 -> mmap() never called on this fd */
158} Sg_fd;
159
160typedef struct sg_device { /* holds the state of each scsi generic device */
161 struct scsi_device *device;
162 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
163 int sg_tablesize; /* adapter's max scatter-gather table size */
164 Sg_fd *headfp; /* first open fd belonging to this device */
165 volatile char detached; /* 0->attached, 1->detached pending removal */
166 volatile char exclude; /* opened for exclusive access */
167 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
168 struct gendisk *disk;
169 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
170} Sg_device;
171
172static int sg_fasync(int fd, struct file *filp, int mode);
Mike Christied6b10342005-11-08 04:06:41 -0600173/* tasklet or soft irq callback */
174static void sg_cmd_done(void *data, char *sense, int result, int resid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175static int sg_start_req(Sg_request * srp);
176static void sg_finish_rem_req(Sg_request * srp);
177static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
178static int sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp,
179 int tablesize);
180static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
181 Sg_request * srp);
182static ssize_t sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
183 int blocking, int read_only, Sg_request ** o_srp);
184static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
185 unsigned char *cmnd, int timeout, int blocking);
186static int sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
187 int wr_xf, int *countp, unsigned char __user **up);
188static int sg_write_xfer(Sg_request * srp);
189static int sg_read_xfer(Sg_request * srp);
190static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
191static void sg_remove_scat(Sg_scatter_hold * schp);
192static void sg_build_reserve(Sg_fd * sfp, int req_size);
193static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
194static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
Mike Christied6b10342005-11-08 04:06:41 -0600195static struct page *sg_page_malloc(int rqSz, int lowDma, int *retSzp);
196static void sg_page_free(struct page *page, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
198static int sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
199static void __sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp);
200static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
201static Sg_request *sg_add_request(Sg_fd * sfp);
202static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
203static int sg_res_in_use(Sg_fd * sfp);
204static int sg_allow_access(unsigned char opcode, char dev_type);
205static int sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len);
206static Sg_device *sg_get_dev(int dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207#ifdef CONFIG_SCSI_PROC_FS
208static int sg_last_dev(void);
209#endif
210
211static Sg_device **sg_dev_arr = NULL;
212static int sg_dev_max;
213static int sg_nr_dev;
214
215#define SZ_SG_HEADER sizeof(struct sg_header)
216#define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
217#define SZ_SG_IOVEC sizeof(sg_iovec_t)
218#define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
219
220static int
221sg_open(struct inode *inode, struct file *filp)
222{
223 int dev = iminor(inode);
224 int flags = filp->f_flags;
Mike Christied6b10342005-11-08 04:06:41 -0600225 struct request_queue *q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 Sg_device *sdp;
227 Sg_fd *sfp;
228 int res;
229 int retval;
230
231 nonseekable_open(inode, filp);
232 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
233 sdp = sg_get_dev(dev);
234 if ((!sdp) || (!sdp->device))
235 return -ENXIO;
236 if (sdp->detached)
237 return -ENODEV;
238
239 /* This driver's module count bumped by fops_get in <linux/fs.h> */
240 /* Prevent the device driver from vanishing while we sleep */
241 retval = scsi_device_get(sdp->device);
242 if (retval)
243 return retval;
244
245 if (!((flags & O_NONBLOCK) ||
246 scsi_block_when_processing_errors(sdp->device))) {
247 retval = -ENXIO;
248 /* we are in error recovery for this device */
249 goto error_out;
250 }
251
252 if (flags & O_EXCL) {
253 if (O_RDONLY == (flags & O_ACCMODE)) {
254 retval = -EPERM; /* Can't lock it with read only access */
255 goto error_out;
256 }
257 if (sdp->headfp && (flags & O_NONBLOCK)) {
258 retval = -EBUSY;
259 goto error_out;
260 }
261 res = 0;
262 __wait_event_interruptible(sdp->o_excl_wait,
263 ((sdp->headfp || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
264 if (res) {
265 retval = res; /* -ERESTARTSYS because signal hit process */
266 goto error_out;
267 }
268 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
269 if (flags & O_NONBLOCK) {
270 retval = -EBUSY;
271 goto error_out;
272 }
273 res = 0;
274 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
275 res);
276 if (res) {
277 retval = res; /* -ERESTARTSYS because signal hit process */
278 goto error_out;
279 }
280 }
281 if (sdp->detached) {
282 retval = -ENODEV;
283 goto error_out;
284 }
285 if (!sdp->headfp) { /* no existing opens on this device */
286 sdp->sgdebug = 0;
Mike Christied6b10342005-11-08 04:06:41 -0600287 q = sdp->device->request_queue;
288 sdp->sg_tablesize = min(q->max_hw_segments,
289 q->max_phys_segments);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 }
291 if ((sfp = sg_add_sfp(sdp, dev)))
292 filp->private_data = sfp;
293 else {
294 if (flags & O_EXCL)
295 sdp->exclude = 0; /* undo if error */
296 retval = -ENOMEM;
297 goto error_out;
298 }
299 return 0;
300
301 error_out:
302 scsi_device_put(sdp->device);
303 return retval;
304}
305
306/* Following function was formerly called 'sg_close' */
307static int
308sg_release(struct inode *inode, struct file *filp)
309{
310 Sg_device *sdp;
311 Sg_fd *sfp;
312
313 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
314 return -ENXIO;
315 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
316 sg_fasync(-1, filp, 0); /* remove filp from async notification list */
317 if (0 == sg_remove_sfp(sdp, sfp)) { /* Returns 1 when sdp gone */
318 if (!sdp->detached) {
319 scsi_device_put(sdp->device);
320 }
321 sdp->exclude = 0;
322 wake_up_interruptible(&sdp->o_excl_wait);
323 }
324 return 0;
325}
326
327static ssize_t
328sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
329{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 Sg_device *sdp;
331 Sg_fd *sfp;
332 Sg_request *srp;
333 int req_pack_id = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 sg_io_hdr_t *hp;
cb59e842005-04-02 13:51:23 -0600335 struct sg_header *old_hdr = NULL;
336 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
339 return -ENXIO;
340 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
341 sdp->disk->disk_name, (int) count));
Mike Christied6b10342005-11-08 04:06:41 -0600342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 if (!access_ok(VERIFY_WRITE, buf, count))
344 return -EFAULT;
345 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
cb59e842005-04-02 13:51:23 -0600346 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
347 if (!old_hdr)
348 return -ENOMEM;
349 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
350 retval = -EFAULT;
351 goto free_old_hdr;
352 }
353 if (old_hdr->reply_len < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 if (count >= SZ_SG_IO_HDR) {
cb59e842005-04-02 13:51:23 -0600355 sg_io_hdr_t *new_hdr;
356 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
357 if (!new_hdr) {
358 retval = -ENOMEM;
359 goto free_old_hdr;
360 }
361 retval =__copy_from_user
362 (new_hdr, buf, SZ_SG_IO_HDR);
363 req_pack_id = new_hdr->pack_id;
364 kfree(new_hdr);
365 if (retval) {
366 retval = -EFAULT;
367 goto free_old_hdr;
368 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 }
370 } else
cb59e842005-04-02 13:51:23 -0600371 req_pack_id = old_hdr->pack_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 }
373 srp = sg_get_rq_mark(sfp, req_pack_id);
374 if (!srp) { /* now wait on packet to arrive */
cb59e842005-04-02 13:51:23 -0600375 if (sdp->detached) {
376 retval = -ENODEV;
377 goto free_old_hdr;
378 }
379 if (filp->f_flags & O_NONBLOCK) {
380 retval = -EAGAIN;
381 goto free_old_hdr;
382 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 while (1) {
cb59e842005-04-02 13:51:23 -0600384 retval = 0; /* following macro beats race condition */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 __wait_event_interruptible(sfp->read_wait,
cb59e842005-04-02 13:51:23 -0600386 (sdp->detached ||
387 (srp = sg_get_rq_mark(sfp, req_pack_id))),
388 retval);
389 if (sdp->detached) {
390 retval = -ENODEV;
391 goto free_old_hdr;
392 }
393 if (0 == retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 break;
cb59e842005-04-02 13:51:23 -0600395
396 /* -ERESTARTSYS as signal hit process */
397 goto free_old_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 }
399 }
cb59e842005-04-02 13:51:23 -0600400 if (srp->header.interface_id != '\0') {
401 retval = sg_new_read(sfp, buf, count, srp);
402 goto free_old_hdr;
403 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 hp = &srp->header;
cb59e842005-04-02 13:51:23 -0600406 if (old_hdr == NULL) {
407 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
408 if (! old_hdr) {
409 retval = -ENOMEM;
410 goto free_old_hdr;
411 }
412 }
413 memset(old_hdr, 0, SZ_SG_HEADER);
414 old_hdr->reply_len = (int) hp->timeout;
415 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
416 old_hdr->pack_id = hp->pack_id;
417 old_hdr->twelve_byte =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
cb59e842005-04-02 13:51:23 -0600419 old_hdr->target_status = hp->masked_status;
420 old_hdr->host_status = hp->host_status;
421 old_hdr->driver_status = hp->driver_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 if ((CHECK_CONDITION & hp->masked_status) ||
423 (DRIVER_SENSE & hp->driver_status))
cb59e842005-04-02 13:51:23 -0600424 memcpy(old_hdr->sense_buffer, srp->sense_b,
425 sizeof (old_hdr->sense_buffer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 switch (hp->host_status) {
427 /* This setup of 'result' is for backward compatibility and is best
428 ignored by the user who should use target, host + driver status */
429 case DID_OK:
430 case DID_PASSTHROUGH:
431 case DID_SOFT_ERROR:
cb59e842005-04-02 13:51:23 -0600432 old_hdr->result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 break;
434 case DID_NO_CONNECT:
435 case DID_BUS_BUSY:
436 case DID_TIME_OUT:
cb59e842005-04-02 13:51:23 -0600437 old_hdr->result = EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 break;
439 case DID_BAD_TARGET:
440 case DID_ABORT:
441 case DID_PARITY:
442 case DID_RESET:
443 case DID_BAD_INTR:
cb59e842005-04-02 13:51:23 -0600444 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 break;
446 case DID_ERROR:
cb59e842005-04-02 13:51:23 -0600447 old_hdr->result = (srp->sense_b[0] == 0 &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 hp->masked_status == GOOD) ? 0 : EIO;
449 break;
450 default:
cb59e842005-04-02 13:51:23 -0600451 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 break;
453 }
454
455 /* Now copy the result back to the user buffer. */
456 if (count >= SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600457 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
458 retval = -EFAULT;
459 goto free_old_hdr;
460 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 buf += SZ_SG_HEADER;
cb59e842005-04-02 13:51:23 -0600462 if (count > old_hdr->reply_len)
463 count = old_hdr->reply_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 if (count > SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600465 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
466 retval = -EFAULT;
467 goto free_old_hdr;
468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 }
470 } else
cb59e842005-04-02 13:51:23 -0600471 count = (old_hdr->result == 0) ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 sg_finish_rem_req(srp);
cb59e842005-04-02 13:51:23 -0600473 retval = count;
474free_old_hdr:
Jesper Juhlc9475cb2005-11-07 01:01:26 -0800475 kfree(old_hdr);
cb59e842005-04-02 13:51:23 -0600476 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477}
478
479static ssize_t
480sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
481{
482 sg_io_hdr_t *hp = &srp->header;
483 int err = 0;
484 int len;
485
486 if (count < SZ_SG_IO_HDR) {
487 err = -EINVAL;
488 goto err_out;
489 }
490 hp->sb_len_wr = 0;
491 if ((hp->mx_sb_len > 0) && hp->sbp) {
492 if ((CHECK_CONDITION & hp->masked_status) ||
493 (DRIVER_SENSE & hp->driver_status)) {
Mike Christied6b10342005-11-08 04:06:41 -0600494 int sb_len = SCSI_SENSE_BUFFERSIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
496 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
497 len = (len > sb_len) ? sb_len : len;
498 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
499 err = -EFAULT;
500 goto err_out;
501 }
502 hp->sb_len_wr = len;
503 }
504 }
505 if (hp->masked_status || hp->host_status || hp->driver_status)
506 hp->info |= SG_INFO_CHECK;
507 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
508 err = -EFAULT;
509 goto err_out;
510 }
511 err = sg_read_xfer(srp);
512 err_out:
513 sg_finish_rem_req(srp);
514 return (0 == err) ? count : err;
515}
516
517static ssize_t
518sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
519{
520 int mxsize, cmd_size, k;
521 int input_size, blocking;
522 unsigned char opcode;
523 Sg_device *sdp;
524 Sg_fd *sfp;
525 Sg_request *srp;
526 struct sg_header old_hdr;
527 sg_io_hdr_t *hp;
Mike Christied6b10342005-11-08 04:06:41 -0600528 unsigned char cmnd[MAX_COMMAND_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
530 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
531 return -ENXIO;
532 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
533 sdp->disk->disk_name, (int) count));
534 if (sdp->detached)
535 return -ENODEV;
536 if (!((filp->f_flags & O_NONBLOCK) ||
537 scsi_block_when_processing_errors(sdp->device)))
538 return -ENXIO;
539
540 if (!access_ok(VERIFY_READ, buf, count))
541 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
542 if (count < SZ_SG_HEADER)
543 return -EIO;
544 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
545 return -EFAULT;
546 blocking = !(filp->f_flags & O_NONBLOCK);
547 if (old_hdr.reply_len < 0)
548 return sg_new_write(sfp, buf, count, blocking, 0, NULL);
549 if (count < (SZ_SG_HEADER + 6))
550 return -EIO; /* The minimum scsi command length is 6 bytes. */
551
552 if (!(srp = sg_add_request(sfp))) {
553 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
554 return -EDOM;
555 }
556 buf += SZ_SG_HEADER;
557 __get_user(opcode, buf);
558 if (sfp->next_cmd_len > 0) {
559 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
560 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
561 sfp->next_cmd_len = 0;
562 sg_remove_request(sfp, srp);
563 return -EIO;
564 }
565 cmd_size = sfp->next_cmd_len;
566 sfp->next_cmd_len = 0; /* reset so only this write() effected */
567 } else {
568 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
569 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
570 cmd_size = 12;
571 }
572 SCSI_LOG_TIMEOUT(4, printk(
573 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
574/* Determine buffer size. */
575 input_size = count - cmd_size;
576 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
577 mxsize -= SZ_SG_HEADER;
578 input_size -= SZ_SG_HEADER;
579 if (input_size < 0) {
580 sg_remove_request(sfp, srp);
581 return -EIO; /* User did not pass enough bytes for this command. */
582 }
583 hp = &srp->header;
584 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
585 hp->cmd_len = (unsigned char) cmd_size;
586 hp->iovec_count = 0;
587 hp->mx_sb_len = 0;
588 if (input_size > 0)
589 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
590 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
591 else
592 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
593 hp->dxfer_len = mxsize;
594 hp->dxferp = (char __user *)buf + cmd_size;
595 hp->sbp = NULL;
596 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
597 hp->flags = input_size; /* structure abuse ... */
598 hp->pack_id = old_hdr.pack_id;
599 hp->usr_ptr = NULL;
600 if (__copy_from_user(cmnd, buf, cmd_size))
601 return -EFAULT;
602 /*
603 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
604 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
605 * is a non-zero input_size, so emit a warning.
606 */
607 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV)
608 if (printk_ratelimit())
609 printk(KERN_WARNING
610 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
611 "guessing data in;\n" KERN_WARNING " "
612 "program %s not setting count and/or reply_len properly\n",
613 old_hdr.reply_len - (int)SZ_SG_HEADER,
614 input_size, (unsigned int) cmnd[0],
615 current->comm);
616 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
617 return (k < 0) ? k : count;
618}
619
620static ssize_t
621sg_new_write(Sg_fd * sfp, const char __user *buf, size_t count,
622 int blocking, int read_only, Sg_request ** o_srp)
623{
624 int k;
625 Sg_request *srp;
626 sg_io_hdr_t *hp;
Mike Christied6b10342005-11-08 04:06:41 -0600627 unsigned char cmnd[MAX_COMMAND_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 int timeout;
629 unsigned long ul_timeout;
630
631 if (count < SZ_SG_IO_HDR)
632 return -EINVAL;
633 if (!access_ok(VERIFY_READ, buf, count))
634 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
635
636 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
637 if (!(srp = sg_add_request(sfp))) {
638 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
639 return -EDOM;
640 }
641 hp = &srp->header;
642 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
643 sg_remove_request(sfp, srp);
644 return -EFAULT;
645 }
646 if (hp->interface_id != 'S') {
647 sg_remove_request(sfp, srp);
648 return -ENOSYS;
649 }
650 if (hp->flags & SG_FLAG_MMAP_IO) {
651 if (hp->dxfer_len > sfp->reserve.bufflen) {
652 sg_remove_request(sfp, srp);
653 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
654 }
655 if (hp->flags & SG_FLAG_DIRECT_IO) {
656 sg_remove_request(sfp, srp);
657 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
658 }
659 if (sg_res_in_use(sfp)) {
660 sg_remove_request(sfp, srp);
661 return -EBUSY; /* reserve buffer already being used */
662 }
663 }
664 ul_timeout = msecs_to_jiffies(srp->header.timeout);
665 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
666 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
667 sg_remove_request(sfp, srp);
668 return -EMSGSIZE;
669 }
670 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
671 sg_remove_request(sfp, srp);
672 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
673 }
674 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
675 sg_remove_request(sfp, srp);
676 return -EFAULT;
677 }
678 if (read_only &&
679 (!sg_allow_access(cmnd[0], sfp->parentdp->device->type))) {
680 sg_remove_request(sfp, srp);
681 return -EPERM;
682 }
683 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
684 if (k < 0)
685 return k;
686 if (o_srp)
687 *o_srp = srp;
688 return count;
689}
690
691static int
692sg_common_write(Sg_fd * sfp, Sg_request * srp,
693 unsigned char *cmnd, int timeout, int blocking)
694{
Mike Christied6b10342005-11-08 04:06:41 -0600695 int k, data_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 Sg_device *sdp = sfp->parentdp;
697 sg_io_hdr_t *hp = &srp->header;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
699 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
700 hp->status = 0;
701 hp->masked_status = 0;
702 hp->msg_status = 0;
703 hp->info = 0;
704 hp->host_status = 0;
705 hp->driver_status = 0;
706 hp->resid = 0;
707 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
708 (int) cmnd[0], (int) hp->cmd_len));
709
710 if ((k = sg_start_req(srp))) {
711 SCSI_LOG_TIMEOUT(1, printk("sg_write: start_req err=%d\n", k));
712 sg_finish_rem_req(srp);
713 return k; /* probably out of space --> ENOMEM */
714 }
715 if ((k = sg_write_xfer(srp))) {
716 SCSI_LOG_TIMEOUT(1, printk("sg_write: write_xfer, bad address\n"));
717 sg_finish_rem_req(srp);
718 return k;
719 }
720 if (sdp->detached) {
721 sg_finish_rem_req(srp);
722 return -ENODEV;
723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 switch (hp->dxfer_direction) {
726 case SG_DXFER_TO_FROM_DEV:
727 case SG_DXFER_FROM_DEV:
Mike Christied6b10342005-11-08 04:06:41 -0600728 data_dir = DMA_FROM_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 break;
730 case SG_DXFER_TO_DEV:
Mike Christied6b10342005-11-08 04:06:41 -0600731 data_dir = DMA_TO_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 break;
733 case SG_DXFER_UNKNOWN:
Mike Christied6b10342005-11-08 04:06:41 -0600734 data_dir = DMA_BIDIRECTIONAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 break;
736 default:
Mike Christied6b10342005-11-08 04:06:41 -0600737 data_dir = DMA_NONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 break;
739 }
cb59e842005-04-02 13:51:23 -0600740 hp->duration = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741/* Now send everything of to mid-level. The next time we hear about this
742 packet is when sg_cmd_done() is called (i.e. a callback). */
brking@us.ibm.combb1d1072006-01-23 15:03:22 -0600743 if (scsi_execute_async(sdp->device, cmnd, hp->cmd_len, data_dir, srp->data.buffer,
Mike Christied6b10342005-11-08 04:06:41 -0600744 hp->dxfer_len, srp->data.k_use_sg, timeout,
745 SG_DEFAULT_RETRIES, srp, sg_cmd_done,
746 GFP_ATOMIC)) {
747 SCSI_LOG_TIMEOUT(1, printk("sg_write: scsi_execute_async failed\n"));
748 /*
749 * most likely out of mem, but could also be a bad map
750 */
Mike Christie18c49b82006-03-22 16:04:38 -0600751 sg_finish_rem_req(srp);
Mike Christied6b10342005-11-08 04:06:41 -0600752 return -ENOMEM;
753 } else
754 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755}
756
757static int
758sg_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
769static int
770sg_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 {
cb59e842005-04-02 13:51:23 -0600960 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 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;
cb59e842005-04-02 13:51:23 -0600977 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 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 rinfo[val].orphan = srp->orphan;
cb59e842005-04-02 13:51:23 -0600987 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 }
994 }
995 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
cb59e842005-04-02 13:51:23 -0600996 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 }
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) {
James Bottomley939647e2005-09-18 15:05:20 -05001010 if (scsi_host_in_recovery(sdp->device->host))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 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 }
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +01001048 return sg_scsi_ioctl(filp, sdp->device->request_queue, NULL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 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
1070static 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
1092static unsigned int
1093sg_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
1127static int
1128sg_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
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143static struct page *
1144sg_vma_nopage(struct vm_area_struct *vma, unsigned long addr, int *type)
1145{
1146 Sg_fd *sfp;
1147 struct page *page = NOPAGE_SIGBUS;
Mike Christied6b10342005-11-08 04:06:41 -06001148 unsigned long offset, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 Sg_scatter_hold *rsv_schp;
Mike Christied6b10342005-11-08 04:06:41 -06001150 struct scatterlist *sg;
1151 int k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
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));
Mike Christied6b10342005-11-08 04:06:41 -06001161 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 }
Mike Christied6b10342005-11-08 04:06:41 -06001172 sa += len;
1173 offset -= len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 }
Mike Christied6b10342005-11-08 04:06:41 -06001175
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 if (type)
1177 *type = VM_FAULT_MINOR;
1178 return page;
1179}
1180
1181static struct vm_operations_struct sg_mmap_vm_ops = {
1182 .nopage = sg_vma_nopage,
1183};
1184
1185static int
1186sg_mmap(struct file *filp, struct vm_area_struct *vma)
1187{
1188 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001189 unsigned long req_sz, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 Sg_scatter_hold *rsv_schp;
Mike Christied6b10342005-11-08 04:06:41 -06001191 int k;
1192 struct scatterlist *sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193
1194 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1195 return -ENXIO;
cb59e842005-04-02 13:51:23 -06001196 req_sz = vma->vm_end - vma->vm_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 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
Mike Christied6b10342005-11-08 04:06:41 -06001205 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 }
Mike Christied6b10342005-11-08 04:06:41 -06001213
Nick Pigginf9aed0e2006-03-22 00:08:30 -08001214 sfp->mmap_called = 1;
Douglas Gilbert1c8e71d2005-09-09 17:18:57 +10001215 vma->vm_flags |= VM_RESERVED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 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). */
1223static void
Mike Christied6b10342005-11-08 04:06:41 -06001224sg_cmd_done(void *data, char *sense, int result, int resid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225{
Mike Christied6b10342005-11-08 04:06:41 -06001226 Sg_request *srp = data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 Sg_device *sdp = NULL;
1228 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 unsigned long iflags;
cb59e842005-04-02 13:51:23 -06001230 unsigned int ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 if (NULL == srp) {
1233 printk(KERN_ERR "sg_cmd_done: NULL request\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 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");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 return;
1242 }
1243
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244
1245 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
Mike Christied6b10342005-11-08 04:06:41 -06001246 sdp->disk->disk_name, srp->header.pack_id, result));
1247 srp->header.resid = resid;
cb59e842005-04-02 13:51:23 -06001248 ms = jiffies_to_msecs(jiffies);
1249 srp->header.duration = (ms > srp->header.duration) ?
1250 (ms - srp->header.duration) : 0;
Mike Christied6b10342005-11-08 04:06:41 -06001251 if (0 != result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 struct scsi_sense_hdr sshdr;
1253
Mike Christied6b10342005-11-08 04:06:41 -06001254 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 if ((sdp->sgdebug > 0) &&
1261 ((CHECK_CONDITION == srp->header.masked_status) ||
1262 (COMMAND_TERMINATED == srp->header.masked_status)))
Mike Christied6b10342005-11-08 04:06:41 -06001263 __scsi_print_sense("sg_cmd_done", sense,
1264 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
1266 /* Following if statement is a patch supplied by Eric Youngdale */
Mike Christied6b10342005-11-08 04:06:41 -06001267 if (driver_byte(result) != 0
1268 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 && !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
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 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
1308static 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
gregkh@suse.ded2538782005-03-23 09:55:22 -08001323static struct class *sg_sysfs_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
1325static int sg_sysfs_valid = 0;
1326
1327static int sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1328{
Mike Christied6b10342005-11-08 04:06:41 -06001329 struct request_queue *q = scsidp->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 Sg_device *sdp;
1331 unsigned long iflags;
1332 void *old_sg_dev_arr = NULL;
1333 int k, error;
1334
Jes Sorensen24669f752006-01-16 10:31:18 -05001335 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 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
Jes Sorensen24669f752006-01-16 10:31:18 -05001347 tmp_da = kzalloc(tmp_dev_max * sizeof(Sg_device *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 if (unlikely(!tmp_da))
1349 goto expand_failed;
1350
1351 write_lock_irqsave(&sg_dev_arr_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 memcpy(tmp_da, sg_dev_arr, sg_dev_max * sizeof(Sg_device *));
1353 old_sg_dev_arr = sg_dev_arr;
1354 sg_dev_arr = tmp_da;
1355 sg_dev_max = tmp_dev_max;
1356 }
1357
1358 for (k = 0; k < sg_dev_max; k++)
1359 if (!sg_dev_arr[k])
1360 break;
1361 if (unlikely(k >= SG_MAX_DEVS))
1362 goto overflow;
1363
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1365 sprintf(disk->disk_name, "sg%d", k);
1366 disk->first_minor = k;
1367 sdp->disk = disk;
1368 sdp->device = scsidp;
1369 init_waitqueue_head(&sdp->o_excl_wait);
Mike Christied6b10342005-11-08 04:06:41 -06001370 sdp->sg_tablesize = min(q->max_hw_segments, q->max_phys_segments);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
1372 sg_nr_dev++;
1373 sg_dev_arr[k] = sdp;
1374 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1375 error = k;
1376
1377 out:
1378 if (error < 0)
1379 kfree(sdp);
1380 kfree(old_sg_dev_arr);
1381 return error;
1382
1383 expand_failed:
1384 printk(KERN_WARNING "sg_alloc: device array cannot be resized\n");
1385 error = -ENOMEM;
1386 goto out;
1387
1388 overflow:
1389 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
James Bottomley9ccfc752005-10-02 11:45:08 -05001390 sdev_printk(KERN_WARNING, scsidp,
1391 "Unable to attach sg device type=%d, minor "
1392 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 error = -ENODEV;
1394 goto out;
1395}
1396
1397static int
Dmitry Torokhovd8539d82005-09-15 02:01:36 -05001398sg_add(struct class_device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399{
1400 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1401 struct gendisk *disk;
1402 Sg_device *sdp = NULL;
1403 struct cdev * cdev = NULL;
1404 int error, k;
1405
1406 disk = alloc_disk(1);
1407 if (!disk) {
1408 printk(KERN_WARNING "alloc_disk failed\n");
1409 return -ENOMEM;
1410 }
1411 disk->major = SCSI_GENERIC_MAJOR;
1412
1413 error = -ENOMEM;
1414 cdev = cdev_alloc();
1415 if (!cdev) {
1416 printk(KERN_WARNING "cdev_alloc failed\n");
1417 goto out;
1418 }
1419 cdev->owner = THIS_MODULE;
1420 cdev->ops = &sg_fops;
1421
1422 error = sg_alloc(disk, scsidp);
1423 if (error < 0) {
1424 printk(KERN_WARNING "sg_alloc failed\n");
1425 goto out;
1426 }
1427 k = error;
1428 sdp = sg_dev_arr[k];
1429
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, k), 1);
Greg KH5e3c34c2006-01-18 16:17:46 -08001431 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 goto out;
Greg KH5e3c34c2006-01-18 16:17:46 -08001433
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 sdp->cdev = cdev;
1435 if (sg_sysfs_valid) {
1436 struct class_device * sg_class_member;
1437
Greg Kroah-Hartman53f46542005-10-27 22:25:43 -07001438 sg_class_member = class_device_create(sg_sysfs_class, NULL,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 MKDEV(SCSI_GENERIC_MAJOR, k),
1440 cl_dev->dev, "%s",
1441 disk->disk_name);
1442 if (IS_ERR(sg_class_member))
1443 printk(KERN_WARNING "sg_add: "
gregkh@suse.ded2538782005-03-23 09:55:22 -08001444 "class_device_create failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 class_set_devdata(sg_class_member, sdp);
1446 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1447 &sg_class_member->kobj, "generic");
1448 if (error)
1449 printk(KERN_ERR "sg_add: unable to make symlink "
1450 "'generic' back to sg%d\n", k);
1451 } else
1452 printk(KERN_WARNING "sg_add: sg_sys INvalid\n");
1453
James Bottomley9ccfc752005-10-02 11:45:08 -05001454 sdev_printk(KERN_NOTICE, scsidp,
1455 "Attached scsi generic sg%d type %d\n", k,scsidp->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
1457 return 0;
1458
1459out:
1460 put_disk(disk);
1461 if (cdev)
1462 cdev_del(cdev);
1463 return error;
1464}
1465
1466static void
Dmitry Torokhovd8539d82005-09-15 02:01:36 -05001467sg_remove(struct class_device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468{
1469 struct scsi_device *scsidp = to_scsi_device(cl_dev->dev);
1470 Sg_device *sdp = NULL;
1471 unsigned long iflags;
1472 Sg_fd *sfp;
1473 Sg_fd *tsfp;
1474 Sg_request *srp;
1475 Sg_request *tsrp;
1476 int k, delay;
1477
1478 if (NULL == sg_dev_arr)
1479 return;
1480 delay = 0;
1481 write_lock_irqsave(&sg_dev_arr_lock, iflags);
1482 for (k = 0; k < sg_dev_max; k++) {
1483 sdp = sg_dev_arr[k];
1484 if ((NULL == sdp) || (sdp->device != scsidp))
1485 continue; /* dirty but lowers nesting */
1486 if (sdp->headfp) {
1487 sdp->detached = 1;
1488 for (sfp = sdp->headfp; sfp; sfp = tsfp) {
1489 tsfp = sfp->nextfp;
1490 for (srp = sfp->headrp; srp; srp = tsrp) {
1491 tsrp = srp->nextrp;
1492 if (sfp->closed || (0 == sg_srp_done(srp, sfp)))
1493 sg_finish_rem_req(srp);
1494 }
1495 if (sfp->closed) {
1496 scsi_device_put(sdp->device);
1497 __sg_remove_sfp(sdp, sfp);
1498 } else {
1499 delay = 1;
1500 wake_up_interruptible(&sfp->read_wait);
1501 kill_fasync(&sfp->async_qp, SIGPOLL,
1502 POLL_HUP);
1503 }
1504 }
1505 SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d, dirty\n", k));
1506 if (NULL == sdp->headfp) {
1507 sg_dev_arr[k] = NULL;
1508 }
1509 } else { /* nothing active, simple case */
1510 SCSI_LOG_TIMEOUT(3, printk("sg_detach: dev=%d\n", k));
1511 sg_dev_arr[k] = NULL;
1512 }
1513 sg_nr_dev--;
1514 break;
1515 }
1516 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
1517
1518 if (sdp) {
1519 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
gregkh@suse.ded2538782005-03-23 09:55:22 -08001520 class_device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, k));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 cdev_del(sdp->cdev);
1522 sdp->cdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 put_disk(sdp->disk);
1524 sdp->disk = NULL;
1525 if (NULL == sdp->headfp)
1526 kfree((char *) sdp);
1527 }
1528
1529 if (delay)
1530 msleep(10); /* dirty detach so delay device destruction */
1531}
1532
1533/* Set 'perm' (4th argument) to 0 to disable module_param's definition
1534 * of sysfs parameters (which module_param doesn't yet support).
1535 * Sysfs parameters defined explicitly below.
1536 */
1537module_param_named(def_reserved_size, def_reserved_size, int, S_IRUGO);
1538module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1539
1540MODULE_AUTHOR("Douglas Gilbert");
1541MODULE_DESCRIPTION("SCSI generic (sg) driver");
1542MODULE_LICENSE("GPL");
1543MODULE_VERSION(SG_VERSION_STR);
Rene Hermanf018fa52006-03-08 00:14:20 -08001544MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
1546MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1547MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1548
1549static int __init
1550init_sg(void)
1551{
1552 int rc;
1553
1554 if (def_reserved_size >= 0)
1555 sg_big_buff = def_reserved_size;
1556
1557 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1558 SG_MAX_DEVS, "sg");
1559 if (rc)
1560 return rc;
gregkh@suse.ded2538782005-03-23 09:55:22 -08001561 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 if ( IS_ERR(sg_sysfs_class) ) {
1563 rc = PTR_ERR(sg_sysfs_class);
1564 goto err_out;
1565 }
1566 sg_sysfs_valid = 1;
1567 rc = scsi_register_interface(&sg_interface);
1568 if (0 == rc) {
1569#ifdef CONFIG_SCSI_PROC_FS
1570 sg_proc_init();
1571#endif /* CONFIG_SCSI_PROC_FS */
1572 return 0;
1573 }
gregkh@suse.ded2538782005-03-23 09:55:22 -08001574 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575err_out:
1576 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1577 return rc;
1578}
1579
1580static void __exit
1581exit_sg(void)
1582{
1583#ifdef CONFIG_SCSI_PROC_FS
1584 sg_proc_cleanup();
1585#endif /* CONFIG_SCSI_PROC_FS */
1586 scsi_unregister_interface(&sg_interface);
gregkh@suse.ded2538782005-03-23 09:55:22 -08001587 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 sg_sysfs_valid = 0;
1589 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1590 SG_MAX_DEVS);
Jesper Juhlc9475cb2005-11-07 01:01:26 -08001591 kfree((char *)sg_dev_arr);
1592 sg_dev_arr = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 sg_dev_max = 0;
1594}
1595
1596static int
1597sg_start_req(Sg_request * srp)
1598{
1599 int res;
1600 Sg_fd *sfp = srp->parentfp;
1601 sg_io_hdr_t *hp = &srp->header;
1602 int dxfer_len = (int) hp->dxfer_len;
1603 int dxfer_dir = hp->dxfer_direction;
1604 Sg_scatter_hold *req_schp = &srp->data;
1605 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1606
1607 SCSI_LOG_TIMEOUT(4, printk("sg_start_req: dxfer_len=%d\n", dxfer_len));
1608 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1609 return 0;
1610 if (sg_allow_dio && (hp->flags & SG_FLAG_DIRECT_IO) &&
1611 (dxfer_dir != SG_DXFER_UNKNOWN) && (0 == hp->iovec_count) &&
1612 (!sfp->parentdp->device->host->unchecked_isa_dma)) {
1613 res = sg_build_direct(srp, sfp, dxfer_len);
1614 if (res <= 0) /* -ve -> error, 0 -> done, 1 -> try indirect */
1615 return res;
1616 }
1617 if ((!sg_res_in_use(sfp)) && (dxfer_len <= rsv_schp->bufflen))
1618 sg_link_reserve(sfp, srp, dxfer_len);
1619 else {
1620 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1621 if (res) {
1622 sg_remove_scat(req_schp);
1623 return res;
1624 }
1625 }
1626 return 0;
1627}
1628
1629static void
1630sg_finish_rem_req(Sg_request * srp)
1631{
1632 Sg_fd *sfp = srp->parentfp;
1633 Sg_scatter_hold *req_schp = &srp->data;
1634
1635 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1636 if (srp->res_used)
1637 sg_unlink_reserve(sfp, srp);
1638 else
1639 sg_remove_scat(req_schp);
1640 sg_remove_request(sfp, srp);
1641}
1642
1643static int
1644sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1645{
Mike Christied6b10342005-11-08 04:06:41 -06001646 int sg_bufflen = tablesize * sizeof(struct scatterlist);
Al Viro2d20eaf2006-02-01 06:31:40 -05001647 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
Mike Christied6b10342005-11-08 04:06:41 -06001649 /*
1650 * TODO: test without low_dma, we should not need it since
1651 * the block layer will bounce the buffer for us
1652 *
1653 * XXX(hch): we shouldn't need GFP_DMA for the actual S/G list.
1654 */
1655 if (sfp->low_dma)
1656 gfp_flags |= GFP_DMA;
1657 schp->buffer = kzalloc(sg_bufflen, gfp_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 if (!schp->buffer)
1659 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 schp->sglist_len = sg_bufflen;
Mike Christied6b10342005-11-08 04:06:41 -06001661 return tablesize; /* number of scat_gath elements allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662}
1663
1664#ifdef SG_ALLOW_DIO_CODE
1665/* vvvvvvvv following code borrowed from st driver's direct IO vvvvvvvvv */
Mike Christied6b10342005-11-08 04:06:41 -06001666 /* TODO: hopefully we can use the generic block layer code */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
1668/* Pin down user pages and put them into a scatter gather list. Returns <= 0 if
1669 - mapping of all pages not successful
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 (i.e., either completely successful or fails)
1671*/
1672static int
1673st_map_user_pages(struct scatterlist *sgl, const unsigned int max_pages,
Mike Christied6b10342005-11-08 04:06:41 -06001674 unsigned long uaddr, size_t count, int rw)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675{
Douglas Gilbertdeb92b72005-09-01 21:50:02 +10001676 unsigned long end = (uaddr + count + PAGE_SIZE - 1) >> PAGE_SHIFT;
1677 unsigned long start = uaddr >> PAGE_SHIFT;
1678 const int nr_pages = end - start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 int res, i, j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 struct page **pages;
1681
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 /* User attempted Overflow! */
1683 if ((uaddr + count) < uaddr)
1684 return -EINVAL;
1685
1686 /* Too big */
1687 if (nr_pages > max_pages)
1688 return -ENOMEM;
1689
1690 /* Hmm? */
1691 if (count == 0)
1692 return 0;
1693
1694 if ((pages = kmalloc(max_pages * sizeof(*pages), GFP_ATOMIC)) == NULL)
1695 return -ENOMEM;
1696
1697 /* Try to fault in all of the necessary pages */
1698 down_read(&current->mm->mmap_sem);
1699 /* rw==READ means read from drive, write into memory area */
1700 res = get_user_pages(
1701 current,
1702 current->mm,
1703 uaddr,
1704 nr_pages,
1705 rw == READ,
1706 0, /* don't force */
1707 pages,
1708 NULL);
1709 up_read(&current->mm->mmap_sem);
1710
1711 /* Errors and no page mapped should return here */
1712 if (res < nr_pages)
1713 goto out_unmap;
1714
1715 for (i=0; i < nr_pages; i++) {
1716 /* FIXME: flush superflous for rw==READ,
1717 * probably wrong function for rw==WRITE
1718 */
1719 flush_dcache_page(pages[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 /* ?? Is locking needed? I don't think so */
1721 /* if (TestSetPageLocked(pages[i]))
1722 goto out_unlock; */
1723 }
1724
Mike Christied6b10342005-11-08 04:06:41 -06001725 sgl[0].page = pages[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 sgl[0].offset = uaddr & ~PAGE_MASK;
1727 if (nr_pages > 1) {
1728 sgl[0].length = PAGE_SIZE - sgl[0].offset;
1729 count -= sgl[0].length;
1730 for (i=1; i < nr_pages ; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 sgl[i].page = pages[i];
1732 sgl[i].length = count < PAGE_SIZE ? count : PAGE_SIZE;
1733 count -= PAGE_SIZE;
1734 }
1735 }
1736 else {
1737 sgl[0].length = count;
1738 }
1739
1740 kfree(pages);
1741 return nr_pages;
1742
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 out_unmap:
Hugh Dickins4d5cda02005-12-02 15:58:09 +00001744 if (res > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 for (j=0; j < res; j++)
1746 page_cache_release(pages[j]);
Hugh Dickins4d5cda02005-12-02 15:58:09 +00001747 res = 0;
1748 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 kfree(pages);
1750 return res;
1751}
1752
1753
1754/* And unmap them... */
1755static int
1756st_unmap_user_pages(struct scatterlist *sgl, const unsigned int nr_pages,
1757 int dirtied)
1758{
1759 int i;
1760
1761 for (i=0; i < nr_pages; i++) {
Nick Pigginb5810032005-10-29 18:16:12 -07001762 struct page *page = sgl[i].page;
1763
Nick Pigginb5810032005-10-29 18:16:12 -07001764 if (dirtied)
1765 SetPageDirty(page);
1766 /* unlock_page(page); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 /* FIXME: cache flush missing for rw==READ
1768 * FIXME: call the correct reference counting function
1769 */
Nick Pigginb5810032005-10-29 18:16:12 -07001770 page_cache_release(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 }
1772
1773 return 0;
1774}
1775
1776/* ^^^^^^^^ above code borrowed from st driver's direct IO ^^^^^^^^^ */
1777#endif
1778
1779
1780/* Returns: -ve -> error, 0 -> done, 1 -> try indirect */
1781static int
1782sg_build_direct(Sg_request * srp, Sg_fd * sfp, int dxfer_len)
1783{
1784#ifdef SG_ALLOW_DIO_CODE
1785 sg_io_hdr_t *hp = &srp->header;
1786 Sg_scatter_hold *schp = &srp->data;
1787 int sg_tablesize = sfp->parentdp->sg_tablesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 int mx_sc_elems, res;
1789 struct scsi_device *sdev = sfp->parentdp->device;
1790
1791 if (((unsigned long)hp->dxferp &
1792 queue_dma_alignment(sdev->request_queue)) != 0)
1793 return 1;
Mike Christied6b10342005-11-08 04:06:41 -06001794
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1796 if (mx_sc_elems <= 0) {
1797 return 1;
1798 }
Mike Christied6b10342005-11-08 04:06:41 -06001799 res = st_map_user_pages(schp->buffer, mx_sc_elems,
1800 (unsigned long)hp->dxferp, dxfer_len,
1801 (SG_DXFER_TO_DEV == hp->dxfer_direction) ? 1 : 0);
Douglas Gilbertc06bb7f2006-03-28 14:48:22 -05001802 if (res <= 0) {
1803 sg_remove_scat(schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 return 1;
Douglas Gilbertc06bb7f2006-03-28 14:48:22 -05001805 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 schp->k_use_sg = res;
1807 schp->dio_in_use = 1;
1808 hp->info |= SG_INFO_DIRECT_IO;
1809 return 0;
1810#else
1811 return 1;
1812#endif
1813}
1814
1815static int
1816sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1817{
Mike Christied6b10342005-11-08 04:06:41 -06001818 struct scatterlist *sg;
1819 int ret_sz = 0, k, rem_sz, num, mx_sc_elems;
1820 int sg_tablesize = sfp->parentdp->sg_tablesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 int blk_size = buff_size;
Mike Christied6b10342005-11-08 04:06:41 -06001822 struct page *p = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823
1824 if ((blk_size < 0) || (!sfp))
1825 return -EFAULT;
1826 if (0 == blk_size)
1827 ++blk_size; /* don't know why */
1828/* round request up to next highest SG_SECTOR_SZ byte boundary */
1829 blk_size = (blk_size + SG_SECTOR_MSK) & (~SG_SECTOR_MSK);
1830 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1831 buff_size, blk_size));
Mike Christied6b10342005-11-08 04:06:41 -06001832
1833 /* N.B. ret_sz carried into this block ... */
1834 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1835 if (mx_sc_elems < 0)
1836 return mx_sc_elems; /* most likely -ENOMEM */
1837
1838 for (k = 0, sg = schp->buffer, rem_sz = blk_size;
1839 (rem_sz > 0) && (k < mx_sc_elems);
1840 ++k, rem_sz -= ret_sz, ++sg) {
1841
1842 num = (rem_sz > SG_SCATTER_SZ) ? SG_SCATTER_SZ : rem_sz;
1843 p = sg_page_malloc(num, sfp->low_dma, &ret_sz);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 if (!p)
1845 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846
Mike Christied6b10342005-11-08 04:06:41 -06001847 sg->page = p;
1848 sg->length = ret_sz;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849
Mike Christied6b10342005-11-08 04:06:41 -06001850 SCSI_LOG_TIMEOUT(5, printk("sg_build_build: k=%d, a=0x%p, len=%d\n",
1851 k, p, ret_sz));
1852 } /* end of for loop */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
Mike Christied6b10342005-11-08 04:06:41 -06001854 schp->k_use_sg = k;
1855 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, rem_sz=%d\n", k, rem_sz));
1856
1857 schp->bufflen = blk_size;
1858 if (rem_sz > 0) /* must have failed */
1859 return -ENOMEM;
1860
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 return 0;
1862}
1863
1864static int
1865sg_write_xfer(Sg_request * srp)
1866{
1867 sg_io_hdr_t *hp = &srp->header;
1868 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06001869 struct scatterlist *sg = schp->buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 int num_xfer = 0;
1871 int j, k, onum, usglen, ksglen, res;
1872 int iovec_count = (int) hp->iovec_count;
1873 int dxfer_dir = hp->dxfer_direction;
1874 unsigned char *p;
1875 unsigned char __user *up;
1876 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
1877
1878 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_TO_DEV == dxfer_dir) ||
1879 (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
1880 num_xfer = (int) (new_interface ? hp->dxfer_len : hp->flags);
1881 if (schp->bufflen < num_xfer)
1882 num_xfer = schp->bufflen;
1883 }
1884 if ((num_xfer <= 0) || (schp->dio_in_use) ||
1885 (new_interface
1886 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
1887 return 0;
1888
1889 SCSI_LOG_TIMEOUT(4, printk("sg_write_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
1890 num_xfer, iovec_count, schp->k_use_sg));
1891 if (iovec_count) {
1892 onum = iovec_count;
1893 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
1894 return -EFAULT;
1895 } else
1896 onum = 1;
1897
Mike Christied6b10342005-11-08 04:06:41 -06001898 ksglen = sg->length;
1899 p = page_address(sg->page);
1900 for (j = 0, k = 0; j < onum; ++j) {
1901 res = sg_u_iovec(hp, iovec_count, j, 1, &usglen, &up);
1902 if (res)
1903 return res;
1904
1905 for (; p; ++sg, ksglen = sg->length,
1906 p = page_address(sg->page)) {
1907 if (usglen <= 0)
1908 break;
1909 if (ksglen > usglen) {
1910 if (usglen >= num_xfer) {
1911 if (__copy_from_user(p, up, num_xfer))
1912 return -EFAULT;
1913 return 0;
1914 }
1915 if (__copy_from_user(p, up, usglen))
1916 return -EFAULT;
1917 p += usglen;
1918 ksglen -= usglen;
1919 break;
1920 } else {
1921 if (ksglen >= num_xfer) {
1922 if (__copy_from_user(p, up, num_xfer))
1923 return -EFAULT;
1924 return 0;
1925 }
1926 if (__copy_from_user(p, up, ksglen))
1927 return -EFAULT;
1928 up += ksglen;
1929 usglen -= ksglen;
1930 }
1931 ++k;
1932 if (k >= schp->k_use_sg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 return 0;
1934 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 }
Mike Christied6b10342005-11-08 04:06:41 -06001936
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 return 0;
1938}
1939
1940static int
1941sg_u_iovec(sg_io_hdr_t * hp, int sg_num, int ind,
1942 int wr_xf, int *countp, unsigned char __user **up)
1943{
1944 int num_xfer = (int) hp->dxfer_len;
1945 unsigned char __user *p = hp->dxferp;
1946 int count;
1947
1948 if (0 == sg_num) {
1949 if (wr_xf && ('\0' == hp->interface_id))
1950 count = (int) hp->flags; /* holds "old" input_size */
1951 else
1952 count = num_xfer;
1953 } else {
1954 sg_iovec_t iovec;
1955 if (__copy_from_user(&iovec, p + ind*SZ_SG_IOVEC, SZ_SG_IOVEC))
1956 return -EFAULT;
1957 p = iovec.iov_base;
1958 count = (int) iovec.iov_len;
1959 }
1960 if (!access_ok(wr_xf ? VERIFY_READ : VERIFY_WRITE, p, count))
1961 return -EFAULT;
1962 if (up)
1963 *up = p;
1964 if (countp)
1965 *countp = count;
1966 return 0;
1967}
1968
1969static void
1970sg_remove_scat(Sg_scatter_hold * schp)
1971{
1972 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1973 if (schp->buffer && (schp->sglist_len > 0)) {
Mike Christied6b10342005-11-08 04:06:41 -06001974 struct scatterlist *sg = schp->buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975
1976 if (schp->dio_in_use) {
1977#ifdef SG_ALLOW_DIO_CODE
Mike Christied6b10342005-11-08 04:06:41 -06001978 st_unmap_user_pages(sg, schp->k_use_sg, TRUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979#endif
1980 } else {
1981 int k;
1982
Mike Christied6b10342005-11-08 04:06:41 -06001983 for (k = 0; (k < schp->k_use_sg) && sg->page;
1984 ++k, ++sg) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 SCSI_LOG_TIMEOUT(5, printk(
1986 "sg_remove_scat: k=%d, a=0x%p, len=%d\n",
Mike Christied6b10342005-11-08 04:06:41 -06001987 k, sg->page, sg->length));
1988 sg_page_free(sg->page, sg->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 }
1990 }
Mike Christied6b10342005-11-08 04:06:41 -06001991 kfree(schp->buffer);
1992 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 memset(schp, 0, sizeof (*schp));
1994}
1995
1996static int
1997sg_read_xfer(Sg_request * srp)
1998{
1999 sg_io_hdr_t *hp = &srp->header;
2000 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06002001 struct scatterlist *sg = schp->buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 int num_xfer = 0;
2003 int j, k, onum, usglen, ksglen, res;
2004 int iovec_count = (int) hp->iovec_count;
2005 int dxfer_dir = hp->dxfer_direction;
2006 unsigned char *p;
2007 unsigned char __user *up;
2008 int new_interface = ('\0' == hp->interface_id) ? 0 : 1;
2009
2010 if ((SG_DXFER_UNKNOWN == dxfer_dir) || (SG_DXFER_FROM_DEV == dxfer_dir)
2011 || (SG_DXFER_TO_FROM_DEV == dxfer_dir)) {
2012 num_xfer = hp->dxfer_len;
2013 if (schp->bufflen < num_xfer)
2014 num_xfer = schp->bufflen;
2015 }
2016 if ((num_xfer <= 0) || (schp->dio_in_use) ||
2017 (new_interface
2018 && ((SG_FLAG_NO_DXFER | SG_FLAG_MMAP_IO) & hp->flags)))
2019 return 0;
2020
2021 SCSI_LOG_TIMEOUT(4, printk("sg_read_xfer: num_xfer=%d, iovec_count=%d, k_use_sg=%d\n",
2022 num_xfer, iovec_count, schp->k_use_sg));
2023 if (iovec_count) {
2024 onum = iovec_count;
2025 if (!access_ok(VERIFY_READ, hp->dxferp, SZ_SG_IOVEC * onum))
2026 return -EFAULT;
2027 } else
2028 onum = 1;
2029
Mike Christied6b10342005-11-08 04:06:41 -06002030 p = page_address(sg->page);
2031 ksglen = sg->length;
2032 for (j = 0, k = 0; j < onum; ++j) {
2033 res = sg_u_iovec(hp, iovec_count, j, 0, &usglen, &up);
2034 if (res)
2035 return res;
2036
2037 for (; p; ++sg, ksglen = sg->length,
2038 p = page_address(sg->page)) {
2039 if (usglen <= 0)
2040 break;
2041 if (ksglen > usglen) {
2042 if (usglen >= num_xfer) {
2043 if (__copy_to_user(up, p, num_xfer))
2044 return -EFAULT;
2045 return 0;
2046 }
2047 if (__copy_to_user(up, p, usglen))
2048 return -EFAULT;
2049 p += usglen;
2050 ksglen -= usglen;
2051 break;
2052 } else {
2053 if (ksglen >= num_xfer) {
2054 if (__copy_to_user(up, p, num_xfer))
2055 return -EFAULT;
2056 return 0;
2057 }
2058 if (__copy_to_user(up, p, ksglen))
2059 return -EFAULT;
2060 up += ksglen;
2061 usglen -= ksglen;
2062 }
2063 ++k;
2064 if (k >= schp->k_use_sg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 return 0;
2066 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 }
Mike Christied6b10342005-11-08 04:06:41 -06002068
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 return 0;
2070}
2071
2072static int
2073sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
2074{
2075 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06002076 struct scatterlist *sg = schp->buffer;
2077 int k, num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078
2079 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
2080 num_read_xfer));
2081 if ((!outp) || (num_read_xfer <= 0))
2082 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083
Mike Christied6b10342005-11-08 04:06:41 -06002084 for (k = 0; (k < schp->k_use_sg) && sg->page; ++k, ++sg) {
2085 num = sg->length;
2086 if (num > num_read_xfer) {
2087 if (__copy_to_user(outp, page_address(sg->page),
2088 num_read_xfer))
2089 return -EFAULT;
2090 break;
2091 } else {
2092 if (__copy_to_user(outp, page_address(sg->page),
2093 num))
2094 return -EFAULT;
2095 num_read_xfer -= num;
2096 if (num_read_xfer <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 break;
Mike Christied6b10342005-11-08 04:06:41 -06002098 outp += num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 }
Mike Christied6b10342005-11-08 04:06:41 -06002101
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 return 0;
2103}
2104
2105static void
2106sg_build_reserve(Sg_fd * sfp, int req_size)
2107{
2108 Sg_scatter_hold *schp = &sfp->reserve;
2109
2110 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
2111 do {
2112 if (req_size < PAGE_SIZE)
2113 req_size = PAGE_SIZE;
2114 if (0 == sg_build_indirect(schp, sfp, req_size))
2115 return;
2116 else
2117 sg_remove_scat(schp);
2118 req_size >>= 1; /* divide by 2 */
2119 } while (req_size > (PAGE_SIZE / 2));
2120}
2121
2122static void
2123sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2124{
2125 Sg_scatter_hold *req_schp = &srp->data;
2126 Sg_scatter_hold *rsv_schp = &sfp->reserve;
Mike Christied6b10342005-11-08 04:06:41 -06002127 struct scatterlist *sg = rsv_schp->buffer;
2128 int k, num, rem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129
2130 srp->res_used = 1;
2131 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
Brian Kingeca7be52006-02-14 12:42:24 -06002132 rem = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133
Mike Christied6b10342005-11-08 04:06:41 -06002134 for (k = 0; k < rsv_schp->k_use_sg; ++k, ++sg) {
2135 num = sg->length;
2136 if (rem <= num) {
2137 sfp->save_scat_len = num;
2138 sg->length = rem;
2139 req_schp->k_use_sg = k + 1;
2140 req_schp->sglist_len = rsv_schp->sglist_len;
2141 req_schp->buffer = rsv_schp->buffer;
2142
2143 req_schp->bufflen = size;
2144 req_schp->b_malloc_len = rsv_schp->b_malloc_len;
2145 break;
2146 } else
2147 rem -= num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 }
Mike Christied6b10342005-11-08 04:06:41 -06002149
2150 if (k >= rsv_schp->k_use_sg)
2151 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152}
2153
2154static void
2155sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2156{
2157 Sg_scatter_hold *req_schp = &srp->data;
2158 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2159
2160 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
2161 (int) req_schp->k_use_sg));
2162 if ((rsv_schp->k_use_sg > 0) && (req_schp->k_use_sg > 0)) {
Mike Christied6b10342005-11-08 04:06:41 -06002163 struct scatterlist *sg = rsv_schp->buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164
2165 if (sfp->save_scat_len > 0)
Mike Christied6b10342005-11-08 04:06:41 -06002166 (sg + (req_schp->k_use_sg - 1))->length =
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 (unsigned) sfp->save_scat_len;
2168 else
2169 SCSI_LOG_TIMEOUT(1, printk ("sg_unlink_reserve: BAD save_scat_len\n"));
2170 }
2171 req_schp->k_use_sg = 0;
2172 req_schp->bufflen = 0;
2173 req_schp->buffer = NULL;
2174 req_schp->sglist_len = 0;
2175 sfp->save_scat_len = 0;
2176 srp->res_used = 0;
2177}
2178
2179static Sg_request *
2180sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2181{
2182 Sg_request *resp;
2183 unsigned long iflags;
2184
2185 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2186 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2187 /* look for requests that are ready + not SG_IO owned */
2188 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2189 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2190 resp->done = 2; /* guard against other readers */
2191 break;
2192 }
2193 }
2194 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2195 return resp;
2196}
2197
2198#ifdef CONFIG_SCSI_PROC_FS
2199static Sg_request *
2200sg_get_nth_request(Sg_fd * sfp, int nth)
2201{
2202 Sg_request *resp;
2203 unsigned long iflags;
2204 int k;
2205
2206 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2207 for (k = 0, resp = sfp->headrp; resp && (k < nth);
2208 ++k, resp = resp->nextrp) ;
2209 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2210 return resp;
2211}
2212#endif
2213
2214/* always adds to end of list */
2215static Sg_request *
2216sg_add_request(Sg_fd * sfp)
2217{
2218 int k;
2219 unsigned long iflags;
2220 Sg_request *resp;
2221 Sg_request *rp = sfp->req_arr;
2222
2223 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2224 resp = sfp->headrp;
2225 if (!resp) {
2226 memset(rp, 0, sizeof (Sg_request));
2227 rp->parentfp = sfp;
2228 resp = rp;
2229 sfp->headrp = resp;
2230 } else {
2231 if (0 == sfp->cmd_q)
2232 resp = NULL; /* command queuing disallowed */
2233 else {
2234 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2235 if (!rp->parentfp)
2236 break;
2237 }
2238 if (k < SG_MAX_QUEUE) {
2239 memset(rp, 0, sizeof (Sg_request));
2240 rp->parentfp = sfp;
2241 while (resp->nextrp)
2242 resp = resp->nextrp;
2243 resp->nextrp = rp;
2244 resp = rp;
2245 } else
2246 resp = NULL;
2247 }
2248 }
2249 if (resp) {
2250 resp->nextrp = NULL;
cb59e842005-04-02 13:51:23 -06002251 resp->header.duration = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 }
2253 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2254 return resp;
2255}
2256
2257/* Return of 1 for found; 0 for not found */
2258static int
2259sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2260{
2261 Sg_request *prev_rp;
2262 Sg_request *rp;
2263 unsigned long iflags;
2264 int res = 0;
2265
2266 if ((!sfp) || (!srp) || (!sfp->headrp))
2267 return res;
2268 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2269 prev_rp = sfp->headrp;
2270 if (srp == prev_rp) {
2271 sfp->headrp = prev_rp->nextrp;
2272 prev_rp->parentfp = NULL;
2273 res = 1;
2274 } else {
2275 while ((rp = prev_rp->nextrp)) {
2276 if (srp == rp) {
2277 prev_rp->nextrp = rp->nextrp;
2278 rp->parentfp = NULL;
2279 res = 1;
2280 break;
2281 }
2282 prev_rp = rp;
2283 }
2284 }
2285 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2286 return res;
2287}
2288
2289#ifdef CONFIG_SCSI_PROC_FS
2290static Sg_fd *
2291sg_get_nth_sfp(Sg_device * sdp, int nth)
2292{
2293 Sg_fd *resp;
2294 unsigned long iflags;
2295 int k;
2296
2297 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2298 for (k = 0, resp = sdp->headfp; resp && (k < nth);
2299 ++k, resp = resp->nextfp) ;
2300 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2301 return resp;
2302}
2303#endif
2304
2305static Sg_fd *
2306sg_add_sfp(Sg_device * sdp, int dev)
2307{
2308 Sg_fd *sfp;
2309 unsigned long iflags;
2310
Mike Christied6b10342005-11-08 04:06:41 -06002311 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 if (!sfp)
2313 return NULL;
Mike Christied6b10342005-11-08 04:06:41 -06002314
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 init_waitqueue_head(&sfp->read_wait);
2316 rwlock_init(&sfp->rq_list_lock);
2317
2318 sfp->timeout = SG_DEFAULT_TIMEOUT;
2319 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2320 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2321 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2322 sdp->device->host->unchecked_isa_dma : 1;
2323 sfp->cmd_q = SG_DEF_COMMAND_Q;
2324 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2325 sfp->parentdp = sdp;
2326 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2327 if (!sdp->headfp)
2328 sdp->headfp = sfp;
2329 else { /* add to tail of existing list */
2330 Sg_fd *pfp = sdp->headfp;
2331 while (pfp->nextfp)
2332 pfp = pfp->nextfp;
2333 pfp->nextfp = sfp;
2334 }
2335 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2336 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2337 sg_build_reserve(sfp, sg_big_buff);
2338 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2339 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2340 return sfp;
2341}
2342
2343static void
2344__sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2345{
2346 Sg_fd *fp;
2347 Sg_fd *prev_fp;
2348
2349 prev_fp = sdp->headfp;
2350 if (sfp == prev_fp)
2351 sdp->headfp = prev_fp->nextfp;
2352 else {
2353 while ((fp = prev_fp->nextfp)) {
2354 if (sfp == fp) {
2355 prev_fp->nextfp = fp->nextfp;
2356 break;
2357 }
2358 prev_fp = fp;
2359 }
2360 }
2361 if (sfp->reserve.bufflen > 0) {
2362 SCSI_LOG_TIMEOUT(6,
2363 printk("__sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2364 (int) sfp->reserve.bufflen, (int) sfp->reserve.k_use_sg));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 sg_remove_scat(&sfp->reserve);
2366 }
2367 sfp->parentdp = NULL;
2368 SCSI_LOG_TIMEOUT(6, printk("__sg_remove_sfp: sfp=0x%p\n", sfp));
Mike Christied6b10342005-11-08 04:06:41 -06002369 kfree(sfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370}
2371
2372/* Returns 0 in normal case, 1 when detached and sdp object removed */
2373static int
2374sg_remove_sfp(Sg_device * sdp, Sg_fd * sfp)
2375{
2376 Sg_request *srp;
2377 Sg_request *tsrp;
2378 int dirty = 0;
2379 int res = 0;
2380
2381 for (srp = sfp->headrp; srp; srp = tsrp) {
2382 tsrp = srp->nextrp;
2383 if (sg_srp_done(srp, sfp))
2384 sg_finish_rem_req(srp);
2385 else
2386 ++dirty;
2387 }
2388 if (0 == dirty) {
2389 unsigned long iflags;
2390
2391 write_lock_irqsave(&sg_dev_arr_lock, iflags);
2392 __sg_remove_sfp(sdp, sfp);
2393 if (sdp->detached && (NULL == sdp->headfp)) {
2394 int k, maxd;
2395
2396 maxd = sg_dev_max;
2397 for (k = 0; k < maxd; ++k) {
2398 if (sdp == sg_dev_arr[k])
2399 break;
2400 }
2401 if (k < maxd)
2402 sg_dev_arr[k] = NULL;
2403 kfree((char *) sdp);
2404 res = 1;
2405 }
2406 write_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2407 } else {
2408 /* MOD_INC's to inhibit unloading sg and associated adapter driver */
2409 /* only bump the access_count if we actually succeeded in
2410 * throwing another counter on the host module */
2411 scsi_device_get(sdp->device); /* XXX: retval ignored? */
2412 sfp->closed = 1; /* flag dirty state on this fd */
2413 SCSI_LOG_TIMEOUT(1, printk("sg_remove_sfp: worrisome, %d writes pending\n",
2414 dirty));
2415 }
2416 return res;
2417}
2418
2419static int
2420sg_res_in_use(Sg_fd * sfp)
2421{
2422 const Sg_request *srp;
2423 unsigned long iflags;
2424
2425 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2426 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2427 if (srp->res_used)
2428 break;
2429 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2430 return srp ? 1 : 0;
2431}
2432
2433/* If retSzp==NULL want exact size or fail */
Mike Christied6b10342005-11-08 04:06:41 -06002434static struct page *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435sg_page_malloc(int rqSz, int lowDma, int *retSzp)
2436{
Mike Christied6b10342005-11-08 04:06:41 -06002437 struct page *resp = NULL;
Al Viroc53033f2005-10-21 03:22:08 -04002438 gfp_t page_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 int order, a_size;
2440 int resSz = rqSz;
2441
2442 if (rqSz <= 0)
2443 return resp;
2444
2445 if (lowDma)
Nick Pigginf9aed0e2006-03-22 00:08:30 -08002446 page_mask = GFP_ATOMIC | GFP_DMA | __GFP_COMP | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 else
Nick Pigginf9aed0e2006-03-22 00:08:30 -08002448 page_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449
2450 for (order = 0, a_size = PAGE_SIZE; a_size < rqSz;
2451 order++, a_size <<= 1) ;
Mike Christied6b10342005-11-08 04:06:41 -06002452 resp = alloc_pages(page_mask, order);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453 while ((!resp) && order && retSzp) {
2454 --order;
2455 a_size >>= 1; /* divide by 2, until PAGE_SIZE */
Mike Christied6b10342005-11-08 04:06:41 -06002456 resp = alloc_pages(page_mask, order); /* try half */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 resSz = a_size;
2458 }
2459 if (resp) {
2460 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
Hugh Dickins41ed16f2006-01-09 20:46:49 +00002461 memset(page_address(resp), 0, resSz);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 if (retSzp)
2463 *retSzp = resSz;
2464 }
2465 return resp;
2466}
2467
2468static void
Mike Christied6b10342005-11-08 04:06:41 -06002469sg_page_free(struct page *page, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470{
2471 int order, a_size;
2472
Mike Christied6b10342005-11-08 04:06:41 -06002473 if (!page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 return;
2475 for (order = 0, a_size = PAGE_SIZE; a_size < size;
2476 order++, a_size <<= 1) ;
Mike Christied6b10342005-11-08 04:06:41 -06002477 __free_pages(page, order);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478}
2479
2480#ifndef MAINTENANCE_IN_CMD
2481#define MAINTENANCE_IN_CMD 0xa3
2482#endif
2483
2484static unsigned char allow_ops[] = { TEST_UNIT_READY, REQUEST_SENSE,
2485 INQUIRY, READ_CAPACITY, READ_BUFFER, READ_6, READ_10, READ_12,
2486 READ_16, MODE_SENSE, MODE_SENSE_10, LOG_SENSE, REPORT_LUNS,
2487 SERVICE_ACTION_IN, RECEIVE_DIAGNOSTIC, READ_LONG, MAINTENANCE_IN_CMD
2488};
2489
2490static int
2491sg_allow_access(unsigned char opcode, char dev_type)
2492{
2493 int k;
2494
2495 if (TYPE_SCANNER == dev_type) /* TYPE_ROM maybe burner */
2496 return 1;
2497 for (k = 0; k < sizeof (allow_ops); ++k) {
2498 if (opcode == allow_ops[k])
2499 return 1;
2500 }
2501 return 0;
2502}
2503
2504#ifdef CONFIG_SCSI_PROC_FS
2505static int
2506sg_last_dev(void)
2507{
2508 int k;
2509 unsigned long iflags;
2510
2511 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2512 for (k = sg_dev_max - 1; k >= 0; --k)
2513 if (sg_dev_arr[k] && sg_dev_arr[k]->device)
2514 break;
2515 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2516 return k + 1; /* origin 1 */
2517}
2518#endif
2519
2520static Sg_device *
2521sg_get_dev(int dev)
2522{
2523 Sg_device *sdp = NULL;
2524 unsigned long iflags;
2525
2526 if (sg_dev_arr && (dev >= 0)) {
2527 read_lock_irqsave(&sg_dev_arr_lock, iflags);
2528 if (dev < sg_dev_max)
2529 sdp = sg_dev_arr[dev];
2530 read_unlock_irqrestore(&sg_dev_arr_lock, iflags);
2531 }
2532 return sdp;
2533}
2534
2535#ifdef CONFIG_SCSI_PROC_FS
2536
2537static struct proc_dir_entry *sg_proc_sgp = NULL;
2538
2539static char sg_proc_sg_dirname[] = "scsi/sg";
2540
2541static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2542
2543static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2544static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2545 size_t count, loff_t *off);
2546static struct file_operations adio_fops = {
2547 /* .owner, .read and .llseek added in sg_proc_init() */
2548 .open = sg_proc_single_open_adio,
2549 .write = sg_proc_write_adio,
2550 .release = single_release,
2551};
2552
2553static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2554static ssize_t sg_proc_write_dressz(struct file *filp,
2555 const char __user *buffer, size_t count, loff_t *off);
2556static struct file_operations dressz_fops = {
2557 .open = sg_proc_single_open_dressz,
2558 .write = sg_proc_write_dressz,
2559 .release = single_release,
2560};
2561
2562static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2563static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2564static struct file_operations version_fops = {
2565 .open = sg_proc_single_open_version,
2566 .release = single_release,
2567};
2568
2569static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2570static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2571static struct file_operations devhdr_fops = {
2572 .open = sg_proc_single_open_devhdr,
2573 .release = single_release,
2574};
2575
2576static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2577static int sg_proc_open_dev(struct inode *inode, struct file *file);
2578static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2579static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2580static void dev_seq_stop(struct seq_file *s, void *v);
2581static struct file_operations dev_fops = {
2582 .open = sg_proc_open_dev,
2583 .release = seq_release,
2584};
2585static struct seq_operations dev_seq_ops = {
2586 .start = dev_seq_start,
2587 .next = dev_seq_next,
2588 .stop = dev_seq_stop,
2589 .show = sg_proc_seq_show_dev,
2590};
2591
2592static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2593static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2594static struct file_operations devstrs_fops = {
2595 .open = sg_proc_open_devstrs,
2596 .release = seq_release,
2597};
2598static struct seq_operations devstrs_seq_ops = {
2599 .start = dev_seq_start,
2600 .next = dev_seq_next,
2601 .stop = dev_seq_stop,
2602 .show = sg_proc_seq_show_devstrs,
2603};
2604
2605static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2606static int sg_proc_open_debug(struct inode *inode, struct file *file);
2607static struct file_operations debug_fops = {
2608 .open = sg_proc_open_debug,
2609 .release = seq_release,
2610};
2611static struct seq_operations debug_seq_ops = {
2612 .start = dev_seq_start,
2613 .next = dev_seq_next,
2614 .stop = dev_seq_stop,
2615 .show = sg_proc_seq_show_debug,
2616};
2617
2618
2619struct sg_proc_leaf {
2620 const char * name;
2621 struct file_operations * fops;
2622};
2623
2624static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2625 {"allow_dio", &adio_fops},
2626 {"debug", &debug_fops},
2627 {"def_reserved_size", &dressz_fops},
2628 {"device_hdr", &devhdr_fops},
2629 {"devices", &dev_fops},
2630 {"device_strs", &devstrs_fops},
2631 {"version", &version_fops}
2632};
2633
2634static int
2635sg_proc_init(void)
2636{
2637 int k, mask;
2638 int num_leaves =
2639 sizeof (sg_proc_leaf_arr) / sizeof (sg_proc_leaf_arr[0]);
2640 struct proc_dir_entry *pdep;
2641 struct sg_proc_leaf * leaf;
2642
Al Viro66600222005-09-28 22:32:57 +01002643 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644 if (!sg_proc_sgp)
2645 return 1;
2646 for (k = 0; k < num_leaves; ++k) {
2647 leaf = &sg_proc_leaf_arr[k];
2648 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2649 pdep = create_proc_entry(leaf->name, mask, sg_proc_sgp);
2650 if (pdep) {
2651 leaf->fops->owner = THIS_MODULE,
2652 leaf->fops->read = seq_read,
2653 leaf->fops->llseek = seq_lseek,
2654 pdep->proc_fops = leaf->fops;
2655 }
2656 }
2657 return 0;
2658}
2659
2660static void
2661sg_proc_cleanup(void)
2662{
2663 int k;
2664 int num_leaves =
2665 sizeof (sg_proc_leaf_arr) / sizeof (sg_proc_leaf_arr[0]);
2666
2667 if (!sg_proc_sgp)
2668 return;
2669 for (k = 0; k < num_leaves; ++k)
2670 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2671 remove_proc_entry(sg_proc_sg_dirname, NULL);
2672}
2673
2674
2675static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2676{
2677 seq_printf(s, "%d\n", *((int *)s->private));
2678 return 0;
2679}
2680
2681static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2682{
2683 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2684}
2685
2686static ssize_t
2687sg_proc_write_adio(struct file *filp, const char __user *buffer,
2688 size_t count, loff_t *off)
2689{
2690 int num;
2691 char buff[11];
2692
2693 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2694 return -EACCES;
2695 num = (count < 10) ? count : 10;
2696 if (copy_from_user(buff, buffer, num))
2697 return -EFAULT;
2698 buff[num] = '\0';
2699 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2700 return count;
2701}
2702
2703static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2704{
2705 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2706}
2707
2708static ssize_t
2709sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2710 size_t count, loff_t *off)
2711{
2712 int num;
2713 unsigned long k = ULONG_MAX;
2714 char buff[11];
2715
2716 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2717 return -EACCES;
2718 num = (count < 10) ? count : 10;
2719 if (copy_from_user(buff, buffer, num))
2720 return -EFAULT;
2721 buff[num] = '\0';
2722 k = simple_strtoul(buff, NULL, 10);
2723 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2724 sg_big_buff = k;
2725 return count;
2726 }
2727 return -ERANGE;
2728}
2729
2730static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2731{
2732 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2733 sg_version_date);
2734 return 0;
2735}
2736
2737static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2738{
2739 return single_open(file, sg_proc_seq_show_version, NULL);
2740}
2741
2742static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2743{
2744 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2745 "online\n");
2746 return 0;
2747}
2748
2749static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2750{
2751 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2752}
2753
2754struct sg_proc_deviter {
2755 loff_t index;
2756 size_t max;
2757};
2758
2759static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2760{
2761 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2762
Jan Blunck729d70f2005-08-27 11:07:52 -07002763 s->private = it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 if (! it)
2765 return NULL;
Jan Blunck729d70f2005-08-27 11:07:52 -07002766
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767 if (NULL == sg_dev_arr)
Jan Blunck729d70f2005-08-27 11:07:52 -07002768 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 it->index = *pos;
2770 it->max = sg_last_dev();
2771 if (it->index >= it->max)
Jan Blunck729d70f2005-08-27 11:07:52 -07002772 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 return it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774}
2775
2776static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2777{
Jan Blunck729d70f2005-08-27 11:07:52 -07002778 struct sg_proc_deviter * it = s->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779
2780 *pos = ++it->index;
2781 return (it->index < it->max) ? it : NULL;
2782}
2783
2784static void dev_seq_stop(struct seq_file *s, void *v)
2785{
Jan Blunck729d70f2005-08-27 11:07:52 -07002786 kfree(s->private);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787}
2788
2789static int sg_proc_open_dev(struct inode *inode, struct file *file)
2790{
2791 return seq_open(file, &dev_seq_ops);
2792}
2793
2794static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2795{
2796 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2797 Sg_device *sdp;
2798 struct scsi_device *scsidp;
2799
2800 sdp = it ? sg_get_dev(it->index) : NULL;
2801 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2802 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2803 scsidp->host->host_no, scsidp->channel,
2804 scsidp->id, scsidp->lun, (int) scsidp->type,
2805 1,
2806 (int) scsidp->queue_depth,
2807 (int) scsidp->device_busy,
2808 (int) scsi_device_online(scsidp));
2809 else
2810 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2811 return 0;
2812}
2813
2814static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2815{
2816 return seq_open(file, &devstrs_seq_ops);
2817}
2818
2819static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2820{
2821 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2822 Sg_device *sdp;
2823 struct scsi_device *scsidp;
2824
2825 sdp = it ? sg_get_dev(it->index) : NULL;
2826 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2827 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2828 scsidp->vendor, scsidp->model, scsidp->rev);
2829 else
2830 seq_printf(s, "<no active device>\n");
2831 return 0;
2832}
2833
2834static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2835{
2836 int k, m, new_interface, blen, usg;
2837 Sg_request *srp;
2838 Sg_fd *fp;
2839 const sg_io_hdr_t *hp;
2840 const char * cp;
cb59e842005-04-02 13:51:23 -06002841 unsigned int ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842
2843 for (k = 0; (fp = sg_get_nth_sfp(sdp, k)); ++k) {
2844 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2845 "(res)sgat=%d low_dma=%d\n", k + 1,
2846 jiffies_to_msecs(fp->timeout),
2847 fp->reserve.bufflen,
2848 (int) fp->reserve.k_use_sg,
2849 (int) fp->low_dma);
2850 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2851 (int) fp->cmd_q, (int) fp->force_packid,
2852 (int) fp->keep_orphan, (int) fp->closed);
2853 for (m = 0; (srp = sg_get_nth_request(fp, m)); ++m) {
2854 hp = &srp->header;
2855 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2856 if (srp->res_used) {
2857 if (new_interface &&
2858 (SG_FLAG_MMAP_IO & hp->flags))
2859 cp = " mmap>> ";
2860 else
2861 cp = " rb>> ";
2862 } else {
2863 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2864 cp = " dio>> ";
2865 else
2866 cp = " ";
2867 }
2868 seq_printf(s, cp);
Mike Christied6b10342005-11-08 04:06:41 -06002869 blen = srp->data.bufflen;
2870 usg = srp->data.k_use_sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871 seq_printf(s, srp->done ?
2872 ((1 == srp->done) ? "rcv:" : "fin:")
Mike Christied6b10342005-11-08 04:06:41 -06002873 : "act:");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874 seq_printf(s, " id=%d blen=%d",
2875 srp->header.pack_id, blen);
2876 if (srp->done)
2877 seq_printf(s, " dur=%d", hp->duration);
cb59e842005-04-02 13:51:23 -06002878 else {
2879 ms = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 seq_printf(s, " t_o/elap=%d/%d",
cb59e842005-04-02 13:51:23 -06002881 (new_interface ? hp->timeout :
2882 jiffies_to_msecs(fp->timeout)),
2883 (ms > hp->duration ? ms - hp->duration : 0));
2884 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002885 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2886 (int) srp->data.cmd_opcode);
2887 }
2888 if (0 == m)
2889 seq_printf(s, " No requests active\n");
2890 }
2891}
2892
2893static int sg_proc_open_debug(struct inode *inode, struct file *file)
2894{
2895 return seq_open(file, &debug_seq_ops);
2896}
2897
2898static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2899{
2900 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2901 Sg_device *sdp;
2902
2903 if (it && (0 == it->index)) {
2904 seq_printf(s, "dev_max(currently)=%d max_active_device=%d "
2905 "(origin 1)\n", sg_dev_max, (int)it->max);
2906 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2907 }
2908 sdp = it ? sg_get_dev(it->index) : NULL;
2909 if (sdp) {
2910 struct scsi_device *scsidp = sdp->device;
2911
2912 if (NULL == scsidp) {
2913 seq_printf(s, "device %d detached ??\n",
2914 (int)it->index);
2915 return 0;
2916 }
2917
2918 if (sg_get_nth_sfp(sdp, 0)) {
2919 seq_printf(s, " >>> device=%s ",
2920 sdp->disk->disk_name);
2921 if (sdp->detached)
2922 seq_printf(s, "detached pending close ");
2923 else
2924 seq_printf
2925 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2926 scsidp->host->host_no,
2927 scsidp->channel, scsidp->id,
2928 scsidp->lun,
2929 scsidp->host->hostt->emulated);
2930 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2931 sdp->sg_tablesize, sdp->exclude);
2932 }
2933 sg_proc_debug_helper(s, sdp);
2934 }
2935 return 0;
2936}
2937
2938#endif /* CONFIG_SCSI_PROC_FS */
2939
2940module_init(init_sg);
2941module_exit(exit_sg);