[SCSI] ses: add subenclosure support
[linux-2.6.git] / drivers / scsi / sr_ioctl.c
1 #include <linux/kernel.h>
2 #include <linux/mm.h>
3 #include <linux/fs.h>
4 #include <linux/errno.h>
5 #include <linux/string.h>
6 #include <linux/blkdev.h>
7 #include <linux/blkpg.h>
8 #include <linux/cdrom.h>
9 #include <linux/delay.h>
10 #include <linux/slab.h>
11 #include <asm/io.h>
12 #include <asm/uaccess.h>
13
14 #include <scsi/scsi.h>
15 #include <scsi/scsi_dbg.h>
16 #include <scsi/scsi_device.h>
17 #include <scsi/scsi_eh.h>
18 #include <scsi/scsi_host.h>
19 #include <scsi/scsi_ioctl.h>
20 #include <scsi/scsi_cmnd.h>
21
22 #include "sr.h"
23
24 #if 0
25 #define DEBUG
26 #endif
27
28 /* The sr_is_xa() seems to trigger firmware bugs with some drives :-(
29  * It is off by default and can be turned on with this module parameter */
30 static int xa_test = 0;
31
32 module_param(xa_test, int, S_IRUGO | S_IWUSR);
33
34 /* primitive to determine whether we need to have GFP_DMA set based on
35  * the status of the unchecked_isa_dma flag in the host structure */
36 #define SR_GFP_DMA(cd) (((cd)->device->host->unchecked_isa_dma) ? GFP_DMA : 0)
37
38
39 static int sr_read_tochdr(struct cdrom_device_info *cdi,
40                 struct cdrom_tochdr *tochdr)
41 {
42         struct scsi_cd *cd = cdi->handle;
43         struct packet_command cgc;
44         int result;
45         unsigned char *buffer;
46
47         buffer = kmalloc(32, GFP_KERNEL | SR_GFP_DMA(cd));
48         if (!buffer)
49                 return -ENOMEM;
50
51         memset(&cgc, 0, sizeof(struct packet_command));
52         cgc.timeout = IOCTL_TIMEOUT;
53         cgc.cmd[0] = GPCMD_READ_TOC_PMA_ATIP;
54         cgc.cmd[8] = 12;                /* LSB of length */
55         cgc.buffer = buffer;
56         cgc.buflen = 12;
57         cgc.quiet = 1;
58         cgc.data_direction = DMA_FROM_DEVICE;
59
60         result = sr_do_ioctl(cd, &cgc);
61
62         tochdr->cdth_trk0 = buffer[2];
63         tochdr->cdth_trk1 = buffer[3];
64
65         kfree(buffer);
66         return result;
67 }
68
69 static int sr_read_tocentry(struct cdrom_device_info *cdi,
70                 struct cdrom_tocentry *tocentry)
71 {
72         struct scsi_cd *cd = cdi->handle;
73         struct packet_command cgc;
74         int result;
75         unsigned char *buffer;
76
77         buffer = kmalloc(32, GFP_KERNEL | SR_GFP_DMA(cd));
78         if (!buffer)
79                 return -ENOMEM;
80
81         memset(&cgc, 0, sizeof(struct packet_command));
82         cgc.timeout = IOCTL_TIMEOUT;
83         cgc.cmd[0] = GPCMD_READ_TOC_PMA_ATIP;
84         cgc.cmd[1] |= (tocentry->cdte_format == CDROM_MSF) ? 0x02 : 0;
85         cgc.cmd[6] = tocentry->cdte_track;
86         cgc.cmd[8] = 12;                /* LSB of length */
87         cgc.buffer = buffer;
88         cgc.buflen = 12;
89         cgc.data_direction = DMA_FROM_DEVICE;
90
91         result = sr_do_ioctl(cd, &cgc);
92
93         tocentry->cdte_ctrl = buffer[5] & 0xf;
94         tocentry->cdte_adr = buffer[5] >> 4;
95         tocentry->cdte_datamode = (tocentry->cdte_ctrl & 0x04) ? 1 : 0;
96         if (tocentry->cdte_format == CDROM_MSF) {
97                 tocentry->cdte_addr.msf.minute = buffer[9];
98                 tocentry->cdte_addr.msf.second = buffer[10];
99                 tocentry->cdte_addr.msf.frame = buffer[11];
100         } else
101                 tocentry->cdte_addr.lba = (((((buffer[8] << 8) + buffer[9]) << 8)
102                         + buffer[10]) << 8) + buffer[11];
103
104         kfree(buffer);
105         return result;
106 }
107
108 #define IOCTL_RETRIES 3
109
110 /* ATAPI drives don't have a SCMD_PLAYAUDIO_TI command.  When these drives
111    are emulating a SCSI device via the idescsi module, they need to have
112    CDROMPLAYTRKIND commands translated into CDROMPLAYMSF commands for them */
113
114 static int sr_fake_playtrkind(struct cdrom_device_info *cdi, struct cdrom_ti *ti)
115 {
116         struct cdrom_tocentry trk0_te, trk1_te;
117         struct cdrom_tochdr tochdr;
118         struct packet_command cgc;
119         int ntracks, ret;
120
121         ret = sr_read_tochdr(cdi, &tochdr);
122         if (ret)
123                 return ret;
124
125         ntracks = tochdr.cdth_trk1 - tochdr.cdth_trk0 + 1;
126         
127         if (ti->cdti_trk1 == ntracks) 
128                 ti->cdti_trk1 = CDROM_LEADOUT;
129         else if (ti->cdti_trk1 != CDROM_LEADOUT)
130                 ti->cdti_trk1 ++;
131
132         trk0_te.cdte_track = ti->cdti_trk0;
133         trk0_te.cdte_format = CDROM_MSF;
134         trk1_te.cdte_track = ti->cdti_trk1;
135         trk1_te.cdte_format = CDROM_MSF;
136         
137         ret = sr_read_tocentry(cdi, &trk0_te);
138         if (ret)
139                 return ret;
140         ret = sr_read_tocentry(cdi, &trk1_te);
141         if (ret)
142                 return ret;
143
144         memset(&cgc, 0, sizeof(struct packet_command));
145         cgc.cmd[0] = GPCMD_PLAY_AUDIO_MSF;
146         cgc.cmd[3] = trk0_te.cdte_addr.msf.minute;
147         cgc.cmd[4] = trk0_te.cdte_addr.msf.second;
148         cgc.cmd[5] = trk0_te.cdte_addr.msf.frame;
149         cgc.cmd[6] = trk1_te.cdte_addr.msf.minute;
150         cgc.cmd[7] = trk1_te.cdte_addr.msf.second;
151         cgc.cmd[8] = trk1_te.cdte_addr.msf.frame;
152         cgc.data_direction = DMA_NONE;
153         cgc.timeout = IOCTL_TIMEOUT;
154         return sr_do_ioctl(cdi->handle, &cgc);
155 }
156
157 static int sr_play_trkind(struct cdrom_device_info *cdi,
158                 struct cdrom_ti *ti)
159
160 {
161         struct scsi_cd *cd = cdi->handle;
162         struct packet_command cgc;
163         int result;
164
165         memset(&cgc, 0, sizeof(struct packet_command));
166         cgc.timeout = IOCTL_TIMEOUT;
167         cgc.cmd[0] = GPCMD_PLAYAUDIO_TI;
168         cgc.cmd[4] = ti->cdti_trk0;
169         cgc.cmd[5] = ti->cdti_ind0;
170         cgc.cmd[7] = ti->cdti_trk1;
171         cgc.cmd[8] = ti->cdti_ind1;
172         cgc.data_direction = DMA_NONE;
173
174         result = sr_do_ioctl(cd, &cgc);
175         if (result == -EDRIVE_CANT_DO_THIS)
176                 result = sr_fake_playtrkind(cdi, ti);
177
178         return result;
179 }
180
181 /* We do our own retries because we want to know what the specific
182    error code is.  Normally the UNIT_ATTENTION code will automatically
183    clear after one error */
184
185 int sr_do_ioctl(Scsi_CD *cd, struct packet_command *cgc)
186 {
187         struct scsi_device *SDev;
188         struct scsi_sense_hdr sshdr;
189         int result, err = 0, retries = 0;
190         struct request_sense *sense = cgc->sense;
191
192         SDev = cd->device;
193
194         if (!sense) {
195                 sense = kmalloc(SCSI_SENSE_BUFFERSIZE, GFP_KERNEL);
196                 if (!sense) {
197                         err = -ENOMEM;
198                         goto out;
199                 }
200         }
201
202       retry:
203         if (!scsi_block_when_processing_errors(SDev)) {
204                 err = -ENODEV;
205                 goto out;
206         }
207
208         memset(sense, 0, sizeof(*sense));
209         result = scsi_execute(SDev, cgc->cmd, cgc->data_direction,
210                               cgc->buffer, cgc->buflen, (char *)sense,
211                               cgc->timeout, IOCTL_RETRIES, 0, NULL);
212
213         scsi_normalize_sense((char *)sense, sizeof(*sense), &sshdr);
214
215         /* Minimal error checking.  Ignore cases we know about, and report the rest. */
216         if (driver_byte(result) != 0) {
217                 switch (sshdr.sense_key) {
218                 case UNIT_ATTENTION:
219                         SDev->changed = 1;
220                         if (!cgc->quiet)
221                                 printk(KERN_INFO "%s: disc change detected.\n", cd->cdi.name);
222                         if (retries++ < 10)
223                                 goto retry;
224                         err = -ENOMEDIUM;
225                         break;
226                 case NOT_READY: /* This happens if there is no disc in drive */
227                         if (sshdr.asc == 0x04 &&
228                             sshdr.ascq == 0x01) {
229                                 /* sense: Logical unit is in process of becoming ready */
230                                 if (!cgc->quiet)
231                                         printk(KERN_INFO "%s: CDROM not ready yet.\n", cd->cdi.name);
232                                 if (retries++ < 10) {
233                                         /* sleep 2 sec and try again */
234                                         ssleep(2);
235                                         goto retry;
236                                 } else {
237                                         /* 20 secs are enough? */
238                                         err = -ENOMEDIUM;
239                                         break;
240                                 }
241                         }
242                         if (!cgc->quiet)
243                                 printk(KERN_INFO "%s: CDROM not ready.  Make sure there is a disc in the drive.\n", cd->cdi.name);
244 #ifdef DEBUG
245                         scsi_print_sense_hdr("sr", &sshdr);
246 #endif
247                         err = -ENOMEDIUM;
248                         break;
249                 case ILLEGAL_REQUEST:
250                         err = -EIO;
251                         if (sshdr.asc == 0x20 &&
252                             sshdr.ascq == 0x00)
253                                 /* sense: Invalid command operation code */
254                                 err = -EDRIVE_CANT_DO_THIS;
255 #ifdef DEBUG
256                         __scsi_print_command(cgc->cmd);
257                         scsi_print_sense_hdr("sr", &sshdr);
258 #endif
259                         break;
260                 default:
261                         printk(KERN_ERR "%s: CDROM (ioctl) error, command: ", cd->cdi.name);
262                         __scsi_print_command(cgc->cmd);
263                         scsi_print_sense_hdr("sr", &sshdr);
264                         err = -EIO;
265                 }
266         }
267
268         /* Wake up a process waiting for device */
269       out:
270         if (!cgc->sense)
271                 kfree(sense);
272         cgc->stat = err;
273         return err;
274 }
275
276 /* ---------------------------------------------------------------------- */
277 /* interface to cdrom.c                                                   */
278
279 int sr_tray_move(struct cdrom_device_info *cdi, int pos)
280 {
281         Scsi_CD *cd = cdi->handle;
282         struct packet_command cgc;
283
284         memset(&cgc, 0, sizeof(struct packet_command));
285         cgc.cmd[0] = GPCMD_START_STOP_UNIT;
286         cgc.cmd[4] = (pos == 0) ? 0x03 /* close */ : 0x02 /* eject */ ;
287         cgc.data_direction = DMA_NONE;
288         cgc.timeout = IOCTL_TIMEOUT;
289         return sr_do_ioctl(cd, &cgc);
290 }
291
292 int sr_lock_door(struct cdrom_device_info *cdi, int lock)
293 {
294         Scsi_CD *cd = cdi->handle;
295
296         return scsi_set_medium_removal(cd->device, lock ?
297                        SCSI_REMOVAL_PREVENT : SCSI_REMOVAL_ALLOW);
298 }
299
300 int sr_drive_status(struct cdrom_device_info *cdi, int slot)
301 {
302         struct scsi_cd *cd = cdi->handle;
303         struct scsi_sense_hdr sshdr;
304         struct media_event_desc med;
305
306         if (CDSL_CURRENT != slot) {
307                 /* we have no changer support */
308                 return -EINVAL;
309         }
310         if (!scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr))
311                 return CDS_DISC_OK;
312
313         /* SK/ASC/ASCQ of 2/4/1 means "unit is becoming ready" */
314         if (scsi_sense_valid(&sshdr) && sshdr.sense_key == NOT_READY
315                         && sshdr.asc == 0x04 && sshdr.ascq == 0x01)
316                 return CDS_DRIVE_NOT_READY;
317
318         if (!cdrom_get_media_event(cdi, &med)) {
319                 if (med.media_present)
320                         return CDS_DISC_OK;
321                 else if (med.door_open)
322                         return CDS_TRAY_OPEN;
323                 else
324                         return CDS_NO_DISC;
325         }
326
327         /*
328          * SK/ASC/ASCQ of 2/4/2 means "initialization required"
329          * Using CD_TRAY_OPEN results in an START_STOP_UNIT to close
330          * the tray, which resolves the initialization requirement.
331          */
332         if (scsi_sense_valid(&sshdr) && sshdr.sense_key == NOT_READY
333                         && sshdr.asc == 0x04 && sshdr.ascq == 0x02)
334                 return CDS_TRAY_OPEN;
335
336         /*
337          * 0x04 is format in progress .. but there must be a disc present!
338          */
339         if (sshdr.sense_key == NOT_READY && sshdr.asc == 0x04)
340                 return CDS_DISC_OK;
341
342         /*
343          * If not using Mt Fuji extended media tray reports,
344          * just return TRAY_OPEN since ATAPI doesn't provide
345          * any other way to detect this...
346          */
347         if (scsi_sense_valid(&sshdr) &&
348             /* 0x3a is medium not present */
349             sshdr.asc == 0x3a)
350                 return CDS_NO_DISC;
351         else
352                 return CDS_TRAY_OPEN;
353
354         return CDS_DRIVE_NOT_READY;
355 }
356
357 int sr_disk_status(struct cdrom_device_info *cdi)
358 {
359         Scsi_CD *cd = cdi->handle;
360         struct cdrom_tochdr toc_h;
361         struct cdrom_tocentry toc_e;
362         int i, rc, have_datatracks = 0;
363
364         /* look for data tracks */
365         rc = sr_read_tochdr(cdi, &toc_h);
366         if (rc)
367                 return (rc == -ENOMEDIUM) ? CDS_NO_DISC : CDS_NO_INFO;
368
369         for (i = toc_h.cdth_trk0; i <= toc_h.cdth_trk1; i++) {
370                 toc_e.cdte_track = i;
371                 toc_e.cdte_format = CDROM_LBA;
372                 if (sr_read_tocentry(cdi, &toc_e))
373                         return CDS_NO_INFO;
374                 if (toc_e.cdte_ctrl & CDROM_DATA_TRACK) {
375                         have_datatracks = 1;
376                         break;
377                 }
378         }
379         if (!have_datatracks)
380                 return CDS_AUDIO;
381
382         if (cd->xa_flag)
383                 return CDS_XA_2_1;
384         else
385                 return CDS_DATA_1;
386 }
387
388 int sr_get_last_session(struct cdrom_device_info *cdi,
389                         struct cdrom_multisession *ms_info)
390 {
391         Scsi_CD *cd = cdi->handle;
392
393         ms_info->addr.lba = cd->ms_offset;
394         ms_info->xa_flag = cd->xa_flag || cd->ms_offset > 0;
395
396         return 0;
397 }
398
399 int sr_get_mcn(struct cdrom_device_info *cdi, struct cdrom_mcn *mcn)
400 {
401         Scsi_CD *cd = cdi->handle;
402         struct packet_command cgc;
403         char *buffer = kmalloc(32, GFP_KERNEL | SR_GFP_DMA(cd));
404         int result;
405
406         if (!buffer)
407                 return -ENOMEM;
408
409         memset(&cgc, 0, sizeof(struct packet_command));
410         cgc.cmd[0] = GPCMD_READ_SUBCHANNEL;
411         cgc.cmd[2] = 0x40;      /* I do want the subchannel info */
412         cgc.cmd[3] = 0x02;      /* Give me medium catalog number info */
413         cgc.cmd[8] = 24;
414         cgc.buffer = buffer;
415         cgc.buflen = 24;
416         cgc.data_direction = DMA_FROM_DEVICE;
417         cgc.timeout = IOCTL_TIMEOUT;
418         result = sr_do_ioctl(cd, &cgc);
419
420         memcpy(mcn->medium_catalog_number, buffer + 9, 13);
421         mcn->medium_catalog_number[13] = 0;
422
423         kfree(buffer);
424         return result;
425 }
426
427 int sr_reset(struct cdrom_device_info *cdi)
428 {
429         return 0;
430 }
431
432 int sr_select_speed(struct cdrom_device_info *cdi, int speed)
433 {
434         Scsi_CD *cd = cdi->handle;
435         struct packet_command cgc;
436
437         if (speed == 0)
438                 speed = 0xffff; /* set to max */
439         else
440                 speed *= 177;   /* Nx to kbyte/s */
441
442         memset(&cgc, 0, sizeof(struct packet_command));
443         cgc.cmd[0] = GPCMD_SET_SPEED;   /* SET CD SPEED */
444         cgc.cmd[2] = (speed >> 8) & 0xff;       /* MSB for speed (in kbytes/sec) */
445         cgc.cmd[3] = speed & 0xff;      /* LSB */
446         cgc.data_direction = DMA_NONE;
447         cgc.timeout = IOCTL_TIMEOUT;
448
449         if (sr_do_ioctl(cd, &cgc))
450                 return -EIO;
451         return 0;
452 }
453
454 /* ----------------------------------------------------------------------- */
455 /* this is called by the generic cdrom driver. arg is a _kernel_ pointer,  */
456 /* because the generic cdrom driver does the user access stuff for us.     */
457 /* only cdromreadtochdr and cdromreadtocentry are left - for use with the  */
458 /* sr_disk_status interface for the generic cdrom driver.                  */
459
460 int sr_audio_ioctl(struct cdrom_device_info *cdi, unsigned int cmd, void *arg)
461 {
462         switch (cmd) {
463         case CDROMREADTOCHDR:
464                 return sr_read_tochdr(cdi, arg);
465         case CDROMREADTOCENTRY:
466                 return sr_read_tocentry(cdi, arg);
467         case CDROMPLAYTRKIND:
468                 return sr_play_trkind(cdi, arg);
469         default:
470                 return -EINVAL;
471         }
472 }
473
474 /* -----------------------------------------------------------------------
475  * a function to read all sorts of funny cdrom sectors using the READ_CD
476  * scsi-3 mmc command
477  *
478  * lba:     linear block address
479  * format:  0 = data (anything)
480  *          1 = audio
481  *          2 = data (mode 1)
482  *          3 = data (mode 2)
483  *          4 = data (mode 2 form1)
484  *          5 = data (mode 2 form2)
485  * blksize: 2048 | 2336 | 2340 | 2352
486  */
487
488 static int sr_read_cd(Scsi_CD *cd, unsigned char *dest, int lba, int format, int blksize)
489 {
490         struct packet_command cgc;
491
492 #ifdef DEBUG
493         printk("%s: sr_read_cd lba=%d format=%d blksize=%d\n",
494                cd->cdi.name, lba, format, blksize);
495 #endif
496
497         memset(&cgc, 0, sizeof(struct packet_command));
498         cgc.cmd[0] = GPCMD_READ_CD;     /* READ_CD */
499         cgc.cmd[1] = ((format & 7) << 2);
500         cgc.cmd[2] = (unsigned char) (lba >> 24) & 0xff;
501         cgc.cmd[3] = (unsigned char) (lba >> 16) & 0xff;
502         cgc.cmd[4] = (unsigned char) (lba >> 8) & 0xff;
503         cgc.cmd[5] = (unsigned char) lba & 0xff;
504         cgc.cmd[8] = 1;
505         switch (blksize) {
506         case 2336:
507                 cgc.cmd[9] = 0x58;
508                 break;
509         case 2340:
510                 cgc.cmd[9] = 0x78;
511                 break;
512         case 2352:
513                 cgc.cmd[9] = 0xf8;
514                 break;
515         default:
516                 cgc.cmd[9] = 0x10;
517                 break;
518         }
519         cgc.buffer = dest;
520         cgc.buflen = blksize;
521         cgc.data_direction = DMA_FROM_DEVICE;
522         cgc.timeout = IOCTL_TIMEOUT;
523         return sr_do_ioctl(cd, &cgc);
524 }
525
526 /*
527  * read sectors with blocksizes other than 2048
528  */
529
530 static int sr_read_sector(Scsi_CD *cd, int lba, int blksize, unsigned char *dest)
531 {
532         struct packet_command cgc;
533         int rc;
534
535         /* we try the READ CD command first... */
536         if (cd->readcd_known) {
537                 rc = sr_read_cd(cd, dest, lba, 0, blksize);
538                 if (-EDRIVE_CANT_DO_THIS != rc)
539                         return rc;
540                 cd->readcd_known = 0;
541                 printk("CDROM does'nt support READ CD (0xbe) command\n");
542                 /* fall & retry the other way */
543         }
544         /* ... if this fails, we switch the blocksize using MODE SELECT */
545         if (blksize != cd->device->sector_size) {
546                 if (0 != (rc = sr_set_blocklength(cd, blksize)))
547                         return rc;
548         }
549 #ifdef DEBUG
550         printk("%s: sr_read_sector lba=%d blksize=%d\n", cd->cdi.name, lba, blksize);
551 #endif
552
553         memset(&cgc, 0, sizeof(struct packet_command));
554         cgc.cmd[0] = GPCMD_READ_10;
555         cgc.cmd[2] = (unsigned char) (lba >> 24) & 0xff;
556         cgc.cmd[3] = (unsigned char) (lba >> 16) & 0xff;
557         cgc.cmd[4] = (unsigned char) (lba >> 8) & 0xff;
558         cgc.cmd[5] = (unsigned char) lba & 0xff;
559         cgc.cmd[8] = 1;
560         cgc.buffer = dest;
561         cgc.buflen = blksize;
562         cgc.data_direction = DMA_FROM_DEVICE;
563         cgc.timeout = IOCTL_TIMEOUT;
564         rc = sr_do_ioctl(cd, &cgc);
565
566         return rc;
567 }
568
569 /*
570  * read a sector in raw mode to check the sector format
571  * ret: 1 == mode2 (XA), 0 == mode1, <0 == error 
572  */
573
574 int sr_is_xa(Scsi_CD *cd)
575 {
576         unsigned char *raw_sector;
577         int is_xa;
578
579         if (!xa_test)
580                 return 0;
581
582         raw_sector = kmalloc(2048, GFP_KERNEL | SR_GFP_DMA(cd));
583         if (!raw_sector)
584                 return -ENOMEM;
585         if (0 == sr_read_sector(cd, cd->ms_offset + 16,
586                                 CD_FRAMESIZE_RAW1, raw_sector)) {
587                 is_xa = (raw_sector[3] == 0x02) ? 1 : 0;
588         } else {
589                 /* read a raw sector failed for some reason. */
590                 is_xa = -1;
591         }
592         kfree(raw_sector);
593 #ifdef DEBUG
594         printk("%s: sr_is_xa: %d\n", cd->cdi.name, is_xa);
595 #endif
596         return is_xa;
597 }