5f399c9c68ee8165a950f321dd3c74685b50a3e9
[linux-2.6.git] / drivers / scsi / scsi_ioctl.c
1 /*
2  * Changes:
3  * Arnaldo Carvalho de Melo <acme@conectiva.com.br> 08/23/2000
4  * - get rid of some verify_areas and use __copy*user and __get/put_user
5  *   for the ones that remain
6  */
7 #include <linux/module.h>
8 #include <linux/blkdev.h>
9 #include <linux/interrupt.h>
10 #include <linux/errno.h>
11 #include <linux/kernel.h>
12 #include <linux/sched.h>
13 #include <linux/mm.h>
14 #include <linux/string.h>
15 #include <asm/uaccess.h>
16
17 #include <scsi/scsi.h>
18 #include <scsi/scsi_device.h>
19 #include <scsi/scsi_eh.h>
20 #include <scsi/scsi_host.h>
21 #include <scsi/scsi_ioctl.h>
22 #include <scsi/scsi_request.h>
23 #include <scsi/sg.h>
24 #include <scsi/scsi_dbg.h>
25
26 #include "scsi_logging.h"
27
28 #define NORMAL_RETRIES                  5
29 #define IOCTL_NORMAL_TIMEOUT                    (10 * HZ)
30
31 #define MAX_BUF PAGE_SIZE
32
33 /*
34  * If we are told to probe a host, we will return 0 if  the host is not
35  * present, 1 if the host is present, and will return an identifying
36  * string at *arg, if arg is non null, filling to the length stored at
37  * (int *) arg
38  */
39
40 static int ioctl_probe(struct Scsi_Host *host, void __user *buffer)
41 {
42         unsigned int len, slen;
43         const char *string;
44         int temp = host->hostt->present;
45
46         if (temp && buffer) {
47                 if (get_user(len, (unsigned int __user *) buffer))
48                         return -EFAULT;
49
50                 if (host->hostt->info)
51                         string = host->hostt->info(host);
52                 else
53                         string = host->hostt->name;
54                 if (string) {
55                         slen = strlen(string);
56                         if (len > slen)
57                                 len = slen + 1;
58                         if (copy_to_user(buffer, string, len))
59                                 return -EFAULT;
60                 }
61         }
62         return temp;
63 }
64
65 /*
66
67  * The SCSI_IOCTL_SEND_COMMAND ioctl sends a command out to the SCSI host.
68  * The IOCTL_NORMAL_TIMEOUT and NORMAL_RETRIES  variables are used.  
69  * 
70  * dev is the SCSI device struct ptr, *(int *) arg is the length of the
71  * input data, if any, not including the command string & counts, 
72  * *((int *)arg + 1) is the output buffer size in bytes.
73  * 
74  * *(char *) ((int *) arg)[2] the actual command byte.   
75  * 
76  * Note that if more than MAX_BUF bytes are requested to be transferred,
77  * the ioctl will fail with error EINVAL.
78  * 
79  * This size *does not* include the initial lengths that were passed.
80  * 
81  * The SCSI command is read from the memory location immediately after the
82  * length words, and the input data is right after the command.  The SCSI
83  * routines know the command size based on the opcode decode.  
84  * 
85  * The output area is then filled in starting from the command byte. 
86  */
87
88 static int ioctl_internal_command(struct scsi_device *sdev, char *cmd,
89                                   int timeout, int retries)
90 {
91         int result;
92         struct scsi_sense_hdr sshdr;
93         char sense[SCSI_SENSE_BUFFERSIZE];
94
95         SCSI_LOG_IOCTL(1, printk("Trying ioctl with scsi command %d\n", *cmd));
96
97
98         memset(sense, 0, sizeof(*sense));
99         result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0,
100                                   sense, timeout, retries);
101
102         SCSI_LOG_IOCTL(2, printk("Ioctl returned  0x%x\n", result));
103
104         if ((driver_byte(result) & DRIVER_SENSE) &&
105             (scsi_normalize_sense(sense, sizeof(*sense), &sshdr))) {
106                 switch (sshdr.sense_key) {
107                 case ILLEGAL_REQUEST:
108                         if (cmd[0] == ALLOW_MEDIUM_REMOVAL)
109                                 sdev->lockable = 0;
110                         else
111                                 printk(KERN_INFO "ioctl_internal_command: "
112                                        "ILLEGAL REQUEST asc=0x%x ascq=0x%x\n",
113                                        sshdr.asc, sshdr.ascq);
114                         break;
115                 case NOT_READY: /* This happens if there is no disc in drive */
116                         if (sdev->removable && (cmd[0] != TEST_UNIT_READY)) {
117                                 printk(KERN_INFO "Device not ready. Make sure"
118                                        " there is a disc in the drive.\n");
119                                 break;
120                         }
121                 case UNIT_ATTENTION:
122                         if (sdev->removable) {
123                                 sdev->changed = 1;
124                                 result = 0;     /* This is no longer considered an error */
125                                 break;
126                         }
127                 default:        /* Fall through for non-removable media */
128                         printk(KERN_INFO "ioctl_internal_command: <%d %d %d "
129                                "%d> return code = %x\n",
130                                sdev->host->host_no,
131                                sdev->channel,
132                                sdev->id,
133                                sdev->lun,
134                                result);
135                         __scsi_print_sense("   ", sense, sizeof(*sense));
136                         break;
137                 }
138         }
139
140         SCSI_LOG_IOCTL(2, printk("IOCTL Releasing command\n"));
141         return result;
142 }
143
144 int scsi_set_medium_removal(struct scsi_device *sdev, char state)
145 {
146         char scsi_cmd[MAX_COMMAND_SIZE];
147         int ret;
148
149         if (!sdev->removable || !sdev->lockable)
150                return 0;
151
152         scsi_cmd[0] = ALLOW_MEDIUM_REMOVAL;
153         scsi_cmd[1] = 0;
154         scsi_cmd[2] = 0;
155         scsi_cmd[3] = 0;
156         scsi_cmd[4] = state;
157         scsi_cmd[5] = 0;
158
159         ret = ioctl_internal_command(sdev, scsi_cmd,
160                         IOCTL_NORMAL_TIMEOUT, NORMAL_RETRIES);
161         if (ret == 0)
162                 sdev->locked = (state == SCSI_REMOVAL_PREVENT);
163         return ret;
164 }
165 EXPORT_SYMBOL(scsi_set_medium_removal);
166
167 /*
168  * This interface is deprecated - users should use the scsi generic (sg)
169  * interface instead, as this is a more flexible approach to performing
170  * generic SCSI commands on a device.
171  *
172  * The structure that we are passed should look like:
173  *
174  * struct sdata {
175  *  unsigned int inlen;      [i] Length of data to be written to device 
176  *  unsigned int outlen;     [i] Length of data to be read from device 
177  *  unsigned char cmd[x];    [i] SCSI command (6 <= x <= 12).
178  *                           [o] Data read from device starts here.
179  *                           [o] On error, sense buffer starts here.
180  *  unsigned char wdata[y];  [i] Data written to device starts here.
181  * };
182  * Notes:
183  *   -  The SCSI command length is determined by examining the 1st byte
184  *      of the given command. There is no way to override this.
185  *   -  Data transfers are limited to PAGE_SIZE (4K on i386, 8K on alpha).
186  *   -  The length (x + y) must be at least OMAX_SB_LEN bytes long to
187  *      accommodate the sense buffer when an error occurs.
188  *      The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
189  *      old code will not be surprised.
190  *   -  If a Unix error occurs (e.g. ENOMEM) then the user will receive
191  *      a negative return and the Unix error code in 'errno'. 
192  *      If the SCSI command succeeds then 0 is returned.
193  *      Positive numbers returned are the compacted SCSI error codes (4 
194  *      bytes in one int) where the lowest byte is the SCSI status.
195  *      See the drivers/scsi/scsi.h file for more information on this.
196  *
197  */
198 #define OMAX_SB_LEN 16          /* Old sense buffer length */
199
200 int scsi_ioctl_send_command(struct scsi_device *sdev,
201                             struct scsi_ioctl_command __user *sic)
202 {
203         char *buf;
204         unsigned char cmd[MAX_COMMAND_SIZE];
205         unsigned char sense[SCSI_SENSE_BUFFERSIZE];
206         char __user *cmd_in;
207         unsigned char opcode;
208         unsigned int inlen, outlen, cmdlen;
209         unsigned int needed, buf_needed;
210         int timeout, retries, result;
211         int data_direction, gfp_mask = GFP_KERNEL;
212
213         if (!sic)
214                 return -EINVAL;
215
216         if (sdev->host->unchecked_isa_dma)
217                 gfp_mask |= GFP_DMA;
218
219         /*
220          * Verify that we can read at least this much.
221          */
222         if (!access_ok(VERIFY_READ, sic, sizeof(Scsi_Ioctl_Command)))
223                 return -EFAULT;
224
225         if(__get_user(inlen, &sic->inlen))
226                 return -EFAULT;
227                 
228         if(__get_user(outlen, &sic->outlen))
229                 return -EFAULT;
230
231         /*
232          * We do not transfer more than MAX_BUF with this interface.
233          * If the user needs to transfer more data than this, they
234          * should use scsi_generics (sg) instead.
235          */
236         if (inlen > MAX_BUF)
237                 return -EINVAL;
238         if (outlen > MAX_BUF)
239                 return -EINVAL;
240
241         cmd_in = sic->data;
242         if(get_user(opcode, cmd_in))
243                 return -EFAULT;
244
245         needed = buf_needed = (inlen > outlen ? inlen : outlen);
246         if (buf_needed) {
247                 buf_needed = (buf_needed + 511) & ~511;
248                 if (buf_needed > MAX_BUF)
249                         buf_needed = MAX_BUF;
250                 buf = kmalloc(buf_needed, gfp_mask);
251                 if (!buf)
252                         return -ENOMEM;
253                 memset(buf, 0, buf_needed);
254                 if (inlen == 0) {
255                         data_direction = DMA_FROM_DEVICE;
256                 } else if (outlen == 0 ) {
257                         data_direction = DMA_TO_DEVICE;
258                 } else {
259                         /*
260                          * Can this ever happen?
261                          */
262                         data_direction = DMA_BIDIRECTIONAL;
263                 }
264
265         } else {
266                 buf = NULL;
267                 data_direction = DMA_NONE;
268         }
269
270         /*
271          * Obtain the command from the user's address space.
272          */
273         cmdlen = COMMAND_SIZE(opcode);
274         
275         result = -EFAULT;
276
277         if (!access_ok(VERIFY_READ, cmd_in, cmdlen + inlen))
278                 goto error;
279
280         if(__copy_from_user(cmd, cmd_in, cmdlen))
281                 goto error;
282
283         /*
284          * Obtain the data to be sent to the device (if any).
285          */
286
287         if(copy_from_user(buf, cmd_in + cmdlen, inlen))
288                 goto error;
289
290         switch (opcode) {
291         case SEND_DIAGNOSTIC:
292         case FORMAT_UNIT:
293                 timeout = FORMAT_UNIT_TIMEOUT;
294                 retries = 1;
295                 break;
296         case START_STOP:
297                 timeout = START_STOP_TIMEOUT;
298                 retries = NORMAL_RETRIES;
299                 break;
300         case MOVE_MEDIUM:
301                 timeout = MOVE_MEDIUM_TIMEOUT;
302                 retries = NORMAL_RETRIES;
303                 break;
304         case READ_ELEMENT_STATUS:
305                 timeout = READ_ELEMENT_STATUS_TIMEOUT;
306                 retries = NORMAL_RETRIES;
307                 break;
308         case READ_DEFECT_DATA:
309                 timeout = READ_DEFECT_DATA_TIMEOUT;
310                 retries = 1;
311                 break;
312         default:
313                 timeout = IOCTL_NORMAL_TIMEOUT;
314                 retries = NORMAL_RETRIES;
315                 break;
316         }
317
318         result = scsi_execute_req(sdev, cmd, data_direction, buf, needed,
319                                   sense, timeout, retries);
320                                   
321         /* 
322          * If there was an error condition, pass the info back to the user. 
323          */
324         if (result) {
325                 int sb_len = sizeof(*sense);
326
327                 sb_len = (sb_len > OMAX_SB_LEN) ? OMAX_SB_LEN : sb_len;
328                 if (copy_to_user(cmd_in, sense, sb_len))
329                         result = -EFAULT;
330         } else {
331                 if (copy_to_user(cmd_in, buf, outlen))
332                         result = -EFAULT;
333         }       
334
335 error:
336         kfree(buf);
337         return result;
338 }
339 EXPORT_SYMBOL(scsi_ioctl_send_command);
340
341 /*
342  * The scsi_ioctl_get_pci() function places into arg the value
343  * pci_dev::slot_name (8 characters) for the PCI device (if any).
344  * Returns: 0 on success
345  *          -ENXIO if there isn't a PCI device pointer
346  *                 (could be because the SCSI driver hasn't been
347  *                  updated yet, or because it isn't a SCSI
348  *                  device)
349  *          any copy_to_user() error on failure there
350  */
351 static int scsi_ioctl_get_pci(struct scsi_device *sdev, void __user *arg)
352 {
353         struct device *dev = scsi_get_device(sdev->host);
354
355         if (!dev)
356                 return -ENXIO;
357         return copy_to_user(arg, dev->bus_id, sizeof(dev->bus_id))? -EFAULT: 0;
358 }
359
360
361 /*
362  * the scsi_ioctl() function differs from most ioctls in that it does
363  * not take a major/minor number as the dev field.  Rather, it takes
364  * a pointer to a scsi_devices[] element, a structure. 
365  */
366 int scsi_ioctl(struct scsi_device *sdev, int cmd, void __user *arg)
367 {
368         char scsi_cmd[MAX_COMMAND_SIZE];
369
370         /* No idea how this happens.... */
371         if (!sdev)
372                 return -ENXIO;
373
374         /*
375          * If we are in the middle of error recovery, don't let anyone
376          * else try and use this device.  Also, if error recovery fails, it
377          * may try and take the device offline, in which case all further
378          * access to the device is prohibited.
379          */
380         if (!scsi_block_when_processing_errors(sdev))
381                 return -ENODEV;
382
383         /* Check for deprecated ioctls ... all the ioctls which don't
384          * follow the new unique numbering scheme are deprecated */
385         switch (cmd) {
386         case SCSI_IOCTL_SEND_COMMAND:
387         case SCSI_IOCTL_TEST_UNIT_READY:
388         case SCSI_IOCTL_BENCHMARK_COMMAND:
389         case SCSI_IOCTL_SYNC:
390         case SCSI_IOCTL_START_UNIT:
391         case SCSI_IOCTL_STOP_UNIT:
392                 printk(KERN_WARNING "program %s is using a deprecated SCSI "
393                        "ioctl, please convert it to SG_IO\n", current->comm);
394                 break;
395         default:
396                 break;
397         }
398
399         switch (cmd) {
400         case SCSI_IOCTL_GET_IDLUN:
401                 if (!access_ok(VERIFY_WRITE, arg, sizeof(struct scsi_idlun)))
402                         return -EFAULT;
403
404                 __put_user((sdev->id & 0xff)
405                          + ((sdev->lun & 0xff) << 8)
406                          + ((sdev->channel & 0xff) << 16)
407                          + ((sdev->host->host_no & 0xff) << 24),
408                          &((struct scsi_idlun __user *)arg)->dev_id);
409                 __put_user(sdev->host->unique_id,
410                          &((struct scsi_idlun __user *)arg)->host_unique_id);
411                 return 0;
412         case SCSI_IOCTL_GET_BUS_NUMBER:
413                 return put_user(sdev->host->host_no, (int __user *)arg);
414         case SCSI_IOCTL_PROBE_HOST:
415                 return ioctl_probe(sdev->host, arg);
416         case SCSI_IOCTL_SEND_COMMAND:
417                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
418                         return -EACCES;
419                 return scsi_ioctl_send_command(sdev, arg);
420         case SCSI_IOCTL_DOORLOCK:
421                 return scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
422         case SCSI_IOCTL_DOORUNLOCK:
423                 return scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
424         case SCSI_IOCTL_TEST_UNIT_READY:
425                 return scsi_test_unit_ready(sdev, IOCTL_NORMAL_TIMEOUT,
426                                             NORMAL_RETRIES);
427         case SCSI_IOCTL_START_UNIT:
428                 scsi_cmd[0] = START_STOP;
429                 scsi_cmd[1] = 0;
430                 scsi_cmd[2] = scsi_cmd[3] = scsi_cmd[5] = 0;
431                 scsi_cmd[4] = 1;
432                 return ioctl_internal_command(sdev, scsi_cmd,
433                                      START_STOP_TIMEOUT, NORMAL_RETRIES);
434         case SCSI_IOCTL_STOP_UNIT:
435                 scsi_cmd[0] = START_STOP;
436                 scsi_cmd[1] = 0;
437                 scsi_cmd[2] = scsi_cmd[3] = scsi_cmd[5] = 0;
438                 scsi_cmd[4] = 0;
439                 return ioctl_internal_command(sdev, scsi_cmd,
440                                      START_STOP_TIMEOUT, NORMAL_RETRIES);
441         case SCSI_IOCTL_GET_PCI:
442                 return scsi_ioctl_get_pci(sdev, arg);
443         default:
444                 if (sdev->host->hostt->ioctl)
445                         return sdev->host->hostt->ioctl(sdev, cmd, arg);
446         }
447         return -EINVAL;
448 }
449 EXPORT_SYMBOL(scsi_ioctl);
450
451 /*
452  * the scsi_nonblock_ioctl() function is designed for ioctls which may
453  * be executed even if the device is in recovery.
454  */
455 int scsi_nonblockable_ioctl(struct scsi_device *sdev, int cmd,
456                             void __user *arg, struct file *filp)
457 {
458         int val, result;
459
460         /* The first set of iocts may be executed even if we're doing
461          * error processing, as long as the device was opened
462          * non-blocking */
463         if (filp && filp->f_flags & O_NONBLOCK) {
464                 if (sdev->host->shost_state == SHOST_RECOVERY)
465                         return -ENODEV;
466         } else if (!scsi_block_when_processing_errors(sdev))
467                 return -ENODEV;
468
469         switch (cmd) {
470         case SG_SCSI_RESET:
471                 result = get_user(val, (int __user *)arg);
472                 if (result)
473                         return result;
474                 if (val == SG_SCSI_RESET_NOTHING)
475                         return 0;
476                 switch (val) {
477                 case SG_SCSI_RESET_DEVICE:
478                         val = SCSI_TRY_RESET_DEVICE;
479                         break;
480                 case SG_SCSI_RESET_BUS:
481                         val = SCSI_TRY_RESET_BUS;
482                         break;
483                 case SG_SCSI_RESET_HOST:
484                         val = SCSI_TRY_RESET_HOST;
485                         break;
486                 default:
487                         return -EINVAL;
488                 }
489                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
490                         return -EACCES;
491                 return (scsi_reset_provider(sdev, val) ==
492                         SUCCESS) ? 0 : -EIO;
493         }
494         return -ENODEV;
495 }
496 EXPORT_SYMBOL(scsi_nonblockable_ioctl);