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