include/linux/cdrom.h

   1 /*
   2  * -- <linux/cdrom.h>
   3  * General header file for linux CD-ROM drivers
   4  * Copyright (C) 1992         David Giller, rafetmad@oxy.edu
   5  *               1994, 1995   Eberhard Moenkeberg, emoenke@gwdg.de
   6  *               1996         David van Leeuwen, david@tm.tno.nl
   7  *               1997, 1998   Erik Andersen, andersee@debian.org
   8  *               1998-2000    Jens Axboe, axboe@suse.de
   9  */
  10
  11 #ifndef _LINUX_CDROM_H
  12 #define _LINUX_CDROM_H
  13
  14 #include <asm/byteorder.h>
  15
  16 /*******************************************************
  17  * As of Linux 2.1.x, all Linux CD-ROM application programs will use this
  18  * (and only this) include file.  It is my hope to provide Linux with
  19  * a uniform interface between software accessing CD-ROMs and the various
  20  * device drivers that actually talk to the drives.  There may still be
  21  * 23 different kinds of strange CD-ROM drives, but at least there will
  22  * now be one, and only one, Linux CD-ROM interface.
  23  *
  24  * Additionally, as of Linux 2.1.x, all Linux application programs
  25  * should use the O_NONBLOCK option when opening a CD-ROM device
  26  * for subsequent ioctl commands.  This allows for neat system errors
  27  * like "No medium found" or "Wrong medium type" upon attempting to
  28  * mount or play an empty slot, mount an audio disc, or play a data disc.
  29  * Generally, changing an application program to support O_NONBLOCK
  30  * is as easy as the following:
  31  *       -    drive = open("/dev/cdrom", O_RDONLY);
  32  *       +    drive = open("/dev/cdrom", O_RDONLY | O_NONBLOCK);
  33  * It is worth the small change.
  34  *
  35  *  Patches for many common CD programs (provided by David A. van Leeuwen)
  36  *  can be found at:  ftp://ftp.gwdg.de/pub/linux/cdrom/drivers/cm206/
  37  *
  38  *******************************************************/
  39
  40 /* When a driver supports a certain function, but the cdrom drive we are
  41  * using doesn't, we will return the error EDRIVE_CANT_DO_THIS.  We will
  42  * borrow the "Operation not supported" error from the network folks to
  43  * accomplish this.  Maybe someday we will get a more targeted error code,
  44  * but this will do for now... */
  45 #define EDRIVE_CANT_DO_THIS  EOPNOTSUPP
  46
  47 /*******************************************************
  48  * The CD-ROM IOCTL commands  -- these should be supported by
  49  * all the various cdrom drivers.  For the CD-ROM ioctls, we
  50  * will commandeer byte 0x53, or 'S'.
  51  *******************************************************/
  52 #define CDROMPAUSE              0x5301 /* Pause Audio Operation */
  53 #define CDROMRESUME             0x5302 /* Resume paused Audio Operation */
  54 #define CDROMPLAYMSF            0x5303 /* Play Audio MSF (struct cdrom_msf) */
  55 #define CDROMPLAYTRKIND         0x5304 /* Play Audio Track/index
  56                                            (struct cdrom_ti) */
  57 #define CDROMREADTOCHDR         0x5305 /* Read TOC header
  58                                            (struct cdrom_tochdr) */
  59 #define CDROMREADTOCENTRY       0x5306 /* Read TOC entry
  60                                            (struct cdrom_tocentry) */
  61 #define CDROMSTOP               0x5307 /* Stop the cdrom drive */
  62 #define CDROMSTART              0x5308 /* Start the cdrom drive */
  63 #define CDROMEJECT              0x5309 /* Ejects the cdrom media */
  64 #define CDROMVOLCTRL            0x530a /* Control output volume
  65                                            (struct cdrom_volctrl) */
  66 #define CDROMSUBCHNL            0x530b /* Read subchannel data
  67                                            (struct cdrom_subchnl) */
  68 #define CDROMREADMODE2          0x530c /* Read CDROM mode 2 data (2336 Bytes)
  69                                            (struct cdrom_read) */
  70 #define CDROMREADMODE1          0x530d /* Read CDROM mode 1 data (2048 Bytes)
  71                                            (struct cdrom_read) */
  72 #define CDROMREADAUDIO          0x530e /* (struct cdrom_read_audio) */
  73 #define CDROMEJECT_SW           0x530f /* enable(1)/disable(0) auto-ejecting */
  74 #define CDROMMULTISESSION       0x5310 /* Obtain the start-of-last-session
  75                                            address of multi session disks
  76                                            (struct cdrom_multisession) */
  77 #define CDROM_GET_MCN           0x5311 /* Obtain the "Universal Product Code"
  78                                            if available (struct cdrom_mcn) */
  79 #define CDROM_GET_UPC           CDROM_GET_MCN  /* This one is depricated,
  80                                           but here anyway for compatability */
  81 #define CDROMRESET              0x5312 /* hard-reset the drive */
  82 #define CDROMVOLREAD            0x5313 /* Get the drive's volume setting
  83                                           (struct cdrom_volctrl) */
  84 #define CDROMREADRAW            0x5314  /* read data in raw mode (2352 Bytes)
  85                                            (struct cdrom_read) */
  86 /*
  87  * These ioctls are used only used in aztcd.c and optcd.c
  88  */
  89 #define CDROMREADCOOKED         0x5315  /* read data in cooked mode */
  90 #define CDROMSEEK               0x5316  /* seek msf address */
  91
  92 /*
  93  * This ioctl is only used by the scsi-cd driver.
  94    It is for playing audio in logical block addressing mode.
  95  */
  96 #define CDROMPLAYBLK            0x5317  /* (struct cdrom_blk) */
  97
  98 /*
  99  * These ioctls are only used in optcd.c
 100  */
 101 #define CDROMREADALL            0x5318  /* read all 2646 bytes */
 102
 103 /*
 104  * These ioctls are (now) only in ide-cd.c for controlling
 105  * drive spindown time.  They should be implemented in the
 106  * Uniform driver, via generic packet commands, GPCMD_MODE_SELECT_10,
 107  * GPCMD_MODE_SENSE_10 and the GPMODE_POWER_PAGE...
 108  *  -Erik
 109  */
 110 #define CDROMGETSPINDOWN        0x531d
 111 #define CDROMSETSPINDOWN        0x531e
 112
 113 /*
 114  * These ioctls are implemented through the uniform CD-ROM driver
 115  * They _will_ be adopted by all CD-ROM drivers, when all the CD-ROM
 116  * drivers are eventually ported to the uniform CD-ROM driver interface.
 117  */
 118 #define CDROMCLOSETRAY          0x5319  /* pendant of CDROMEJECT */
 119 #define CDROM_SET_OPTIONS       0x5320  /* Set behavior options */
 120 #define CDROM_CLEAR_OPTIONS     0x5321  /* Clear behavior options */
 121 #define CDROM_SELECT_SPEED      0x5322  /* Set the CD-ROM speed */
 122 #define CDROM_SELECT_DISC       0x5323  /* Select disc (for juke-boxes) */
 123 #define CDROM_MEDIA_CHANGED     0x5325  /* Check is media changed  */
 124 #define CDROM_DRIVE_STATUS      0x5326  /* Get tray position, etc. */
 125 #define CDROM_DISC_STATUS       0x5327  /* Get disc type, etc. */
 126 #define CDROM_CHANGER_NSLOTS    0x5328  /* Get number of slots */
 127 #define CDROM_LOCKDOOR          0x5329  /* lock or unlock door */
 128 #define CDROM_DEBUG             0x5330  /* Turn debug messages on/off */
 129 #define CDROM_GET_CAPABILITY    0x5331  /* get capabilities */
 130
 131 /* This ioctl is only used by sbpcd at the moment */
 132 #define CDROMAUDIOBUFSIZ        0x5382  /* set the audio buffer size */
 133
 134 /* DVD-ROM Specific ioctls */
 135 #define DVD_READ_STRUCT         0x5390  /* Read structure */
 136 #define DVD_WRITE_STRUCT        0x5391  /* Write structure */
 137 #define DVD_AUTH                0x5392  /* Authentication */
 138
 139 #define CDROM_SEND_PACKET       0x5393  /* send a packet to the drive */
 140 #define CDROM_NEXT_WRITABLE     0x5394  /* get next writable block */
 141 #define CDROM_LAST_WRITTEN      0x5395  /* get last block written on disc */
 142
 143 /*******************************************************
 144  * CDROM IOCTL structures
 145  *******************************************************/
 146
 147 /* Address in MSF format */
 148 struct cdrom_msf0
 149 {
 150         __u8    minute;
 151         __u8    second;
 152         __u8    frame;
 153 };
 154
 155 /* Address in either MSF or logical format */
 156 union cdrom_addr
 157 {
 158         struct cdrom_msf0       msf;
 159         int                     lba;
 160 };
 161
 162 /* This struct is used by the CDROMPLAYMSF ioctl */
 163 struct cdrom_msf
 164 {
 165         __u8    cdmsf_min0;     /* start minute */
 166         __u8    cdmsf_sec0;     /* start second */
 167         __u8    cdmsf_frame0;   /* start frame */
 168         __u8    cdmsf_min1;     /* end minute */
 169         __u8    cdmsf_sec1;     /* end second */
 170         __u8    cdmsf_frame1;   /* end frame */
 171 };
 172
 173 /* This struct is used by the CDROMPLAYTRKIND ioctl */
 174 struct cdrom_ti
 175 {
 176         __u8    cdti_trk0;      /* start track */
 177         __u8    cdti_ind0;      /* start index */
 178         __u8    cdti_trk1;      /* end track */
 179         __u8    cdti_ind1;      /* end index */
 180 };
 181
 182 /* This struct is used by the CDROMREADTOCHDR ioctl */
 183 struct cdrom_tochdr
 184 {
 185         __u8    cdth_trk0;      /* start track */
 186         __u8    cdth_trk1;      /* end track */
 187 };
 188
 189 /* This struct is used by the CDROMVOLCTRL and CDROMVOLREAD ioctls */
 190 struct cdrom_volctrl
 191 {
 192         __u8    channel0;
 193         __u8    channel1;
 194         __u8    channel2;
 195         __u8    channel3;
 196 };
 197
 198 /* This struct is used by the CDROMSUBCHNL ioctl */
 199 struct cdrom_subchnl
 200 {
 201         __u8    cdsc_format;
 202         __u8    cdsc_audiostatus;
 203         __u8    cdsc_adr:       4;
 204         __u8    cdsc_ctrl:      4;
 205         __u8    cdsc_trk;
 206         __u8    cdsc_ind;
 207         union cdrom_addr cdsc_absaddr;
 208         union cdrom_addr cdsc_reladdr;
 209 };
 210
 211
 212 /* This struct is used by the CDROMREADTOCENTRY ioctl */
 213 struct cdrom_tocentry
 214 {
 215         __u8    cdte_track;
 216         __u8    cdte_adr        :4;
 217         __u8    cdte_ctrl       :4;
 218         __u8    cdte_format;
 219         union cdrom_addr cdte_addr;
 220         __u8    cdte_datamode;
 221 };
 222
 223 /* This struct is used by the CDROMREADMODE1, and CDROMREADMODE2 ioctls */
 224 struct cdrom_read
 225 {
 226         int     cdread_lba;
 227         char    *cdread_bufaddr;
 228         int     cdread_buflen;
 229 };
 230
 231 /* This struct is used by the CDROMREADAUDIO ioctl */
 232 struct cdrom_read_audio
 233 {
 234         union cdrom_addr addr; /* frame address */
 235         __u8 addr_format;    /* CDROM_LBA or CDROM_MSF */
 236         int nframes;           /* number of 2352-byte-frames to read at once */
 237         __u8 *buf;           /* frame buffer (size: nframes*2352 bytes) */
 238 };
 239
 240 /* This struct is used with the CDROMMULTISESSION ioctl */
 241 struct cdrom_multisession
 242 {
 243         union cdrom_addr addr; /* frame address: start-of-last-session
 244                                    (not the new "frame 16"!).  Only valid
 245                                    if the "xa_flag" is true. */
 246         __u8 xa_flag;        /* 1: "is XA disk" */
 247         __u8 addr_format;    /* CDROM_LBA or CDROM_MSF */
 248 };
 249
 250 /* This struct is used with the CDROM_GET_MCN ioctl.
 251  * Very few audio discs actually have Universal Product Code information,
 252  * which should just be the Medium Catalog Number on the box.  Also note
 253  * that the way the codeis written on CD is _not_ uniform across all discs!
 254  */
 255 struct cdrom_mcn
 256 {
 257   __u8 medium_catalog_number[14]; /* 13 ASCII digits, null-terminated */
 258 };
 259
 260 /* This is used by the CDROMPLAYBLK ioctl */
 261 struct cdrom_blk
 262 {
 263         unsigned from;
 264         unsigned short len;
 265 };
 266
 267 #define CDROM_PACKET_SIZE       12
 268
 269 #define CGC_DATA_UNKNOWN        0
 270 #define CGC_DATA_WRITE          1
 271 #define CGC_DATA_READ           2
 272 #define CGC_DATA_NONE           3
 273
 274 /* for CDROM_PACKET_COMMAND ioctl */
 275 struct cdrom_generic_command
 276 {
 277         unsigned char           cmd[CDROM_PACKET_SIZE];
 278         unsigned char           *buffer;
 279         unsigned int            buflen;
 280         int                     stat;
 281         struct request_sense    *sense;
 282         unsigned char           data_direction;
 283         int                     quiet;
 284         int                     timeout;
 285         void                    *reserved[1];
 286 };
 287
 288
 289 /*
 290  * A CD-ROM physical sector size is 2048, 2052, 2056, 2324, 2332, 2336,
 291  * 2340, or 2352 bytes long.
 292
 293 *         Sector types of the standard CD-ROM data formats:
 294  *
 295  * format   sector type               user data size (bytes)
 296  * -----------------------------------------------------------------------------
 297  *   1     (Red Book)    CD-DA          2352    (CD_FRAMESIZE_RAW)
 298  *   2     (Yellow Book) Mode1 Form1    2048    (CD_FRAMESIZE)
 299  *   3     (Yellow Book) Mode1 Form2    2336    (CD_FRAMESIZE_RAW0)
 300  *   4     (Green Book)  Mode2 Form1    2048    (CD_FRAMESIZE)
 301  *   5     (Green Book)  Mode2 Form2    2328    (2324+4 spare bytes)
 302  *
 303  *
 304  *       The layout of the standard CD-ROM data formats:
 305  * -----------------------------------------------------------------------------
 306  * - audio (red):                  | audio_sample_bytes |
 307  *                                 |        2352        |
 308  *
 309  * - data (yellow, mode1):         | sync - head - data - EDC - zero - ECC |
 310  *                                 |  12  -   4  - 2048 -  4  -   8  - 276 |
 311  *
 312  * - data (yellow, mode2):         | sync - head - data |
 313  *                                 |  12  -   4  - 2336 |
 314  *
 315  * - XA data (green, mode2 form1): | sync - head - sub - data - EDC - ECC |
 316  *                                 |  12  -   4  -  8  - 2048 -  4  - 276 |
 317  *
 318  * - XA data (green, mode2 form2): | sync - head - sub - data - Spare |
 319  *                                 |  12  -   4  -  8  - 2324 -  4    |
 320  *
 321  */
 322
 323 /* Some generally useful CD-ROM information -- mostly based on the above */
 324 #define CD_MINS              74 /* max. minutes per CD, not really a limit */
 325 #define CD_SECS              60 /* seconds per minute */
 326 #define CD_FRAMES            75 /* frames per second */
 327 #define CD_SYNC_SIZE         12 /* 12 sync bytes per raw data frame */
 328 #define CD_MSF_OFFSET       150 /* MSF numbering offset of first frame */
 329 #define CD_CHUNK_SIZE        24 /* lowest-level "data bytes piece" */
 330 #define CD_NUM_OF_CHUNKS     98 /* chunks per frame */
 331 #define CD_FRAMESIZE_SUB     96 /* subchannel data "frame" size */
 332 #define CD_HEAD_SIZE          4 /* header (address) bytes per raw data frame */
 333 #define CD_SUBHEAD_SIZE       8 /* subheader bytes per raw XA data frame */
 334 #define CD_EDC_SIZE           4 /* bytes EDC per most raw data frame types */
 335 #define CD_ZERO_SIZE          8 /* bytes zero per yellow book mode 1 frame */
 336 #define CD_ECC_SIZE         276 /* bytes ECC per most raw data frame types */
 337 #define CD_FRAMESIZE       2048 /* bytes per frame, "cooked" mode */
 338 #define CD_FRAMESIZE_RAW   2352 /* bytes per frame, "raw" mode */
 339 #define CD_FRAMESIZE_RAWER 2646 /* The maximum possible returned bytes */
 340 /* most drives don't deliver everything: */
 341 #define CD_FRAMESIZE_RAW1 (CD_FRAMESIZE_RAW-CD_SYNC_SIZE) /*2340*/
 342 #define CD_FRAMESIZE_RAW0 (CD_FRAMESIZE_RAW-CD_SYNC_SIZE-CD_HEAD_SIZE) /*2336*/
 343
 344 #define CD_XA_HEAD        (CD_HEAD_SIZE+CD_SUBHEAD_SIZE) /* "before data" part of raw XA frame */
 345 #define CD_XA_TAIL        (CD_EDC_SIZE+CD_ECC_SIZE) /* "after data" part of raw XA frame */
 346 #define CD_XA_SYNC_HEAD   (CD_SYNC_SIZE+CD_XA_HEAD) /* sync bytes + header of XA frame */
 347
 348 /* CD-ROM address types (cdrom_tocentry.cdte_format) */
 349 #define CDROM_LBA 0x01 /* "logical block": first frame is #0 */
 350 #define CDROM_MSF 0x02 /* "minute-second-frame": binary, not bcd here! */
 351
 352 /* bit to tell whether track is data or audio (cdrom_tocentry.cdte_ctrl) */
 353 #define CDROM_DATA_TRACK        0x04
 354
 355 /* The leadout track is always 0xAA, regardless of # of tracks on disc */
 356 #define CDROM_LEADOUT           0xAA
 357
 358 /* audio states (from SCSI-2, but seen with other drives, too) */
 359 #define CDROM_AUDIO_INVALID     0x00    /* audio status not supported */
 360 #define CDROM_AUDIO_PLAY        0x11    /* audio play operation in progress */
 361 #define CDROM_AUDIO_PAUSED      0x12    /* audio play operation paused */
 362 #define CDROM_AUDIO_COMPLETED   0x13    /* audio play successfully completed */
 363 #define CDROM_AUDIO_ERROR       0x14    /* audio play stopped due to error */
 364 #define CDROM_AUDIO_NO_STATUS   0x15    /* no current audio status to return */
 365
 366 /* capability flags used with the uniform CD-ROM driver */
 367 #define CDC_CLOSE_TRAY          0x1     /* caddy systems _can't_ close */
 368 #define CDC_OPEN_TRAY           0x2     /* but _can_ eject.  */
 369 #define CDC_LOCK                0x4     /* disable manual eject */
 370 #define CDC_SELECT_SPEED        0x8     /* programmable speed */
 371 #define CDC_SELECT_DISC         0x10    /* select disc from juke-box */
 372 #define CDC_MULTI_SESSION       0x20    /* read sessions>1 */
 373 #define CDC_MCN                 0x40    /* Medium Catalog Number */
 374 #define CDC_MEDIA_CHANGED       0x80    /* media changed */
 375 #define CDC_PLAY_AUDIO          0x100   /* audio functions */
 376 #define CDC_RESET               0x200   /* hard reset device */
 377 #define CDC_IOCTLS              0x400   /* driver has non-standard ioctls */
 378 #define CDC_DRIVE_STATUS        0x800   /* driver implements drive status */
 379 #define CDC_GENERIC_PACKET      0x1000  /* driver implements generic packets */
 380 #define CDC_CD_R                0x2000  /* drive is a CD-R */
 381 #define CDC_CD_RW               0x4000  /* drive is a CD-RW */
 382 #define CDC_DVD                 0x8000  /* drive is a DVD */
 383 #define CDC_DVD_R               0x10000 /* drive can write DVD-R */
 384 #define CDC_DVD_RAM             0x20000 /* drive can write DVD-RAM */
 385
 386 /* drive status possibilities returned by CDROM_DRIVE_STATUS ioctl */
 387 #define CDS_NO_INFO             0       /* if not implemented */
 388 #define CDS_NO_DISC             1
 389 #define CDS_TRAY_OPEN           2
 390 #define CDS_DRIVE_NOT_READY     3
 391 #define CDS_DISC_OK             4
 392
 393 /* return values for the CDROM_DISC_STATUS ioctl */
 394 /* can also return CDS_NO_[INFO|DISC], from above */
 395 #define CDS_AUDIO               100
 396 #define CDS_DATA_1              101
 397 #define CDS_DATA_2              102
 398 #define CDS_XA_2_1              103
 399 #define CDS_XA_2_2              104
 400 #define CDS_MIXED               105
 401
 402 /* User-configurable behavior options for the uniform CD-ROM driver */
 403 #define CDO_AUTO_CLOSE          0x1     /* close tray on first open() */
 404 #define CDO_AUTO_EJECT          0x2     /* open tray on last release() */
 405 #define CDO_USE_FFLAGS          0x4     /* use O_NONBLOCK information on open */
 406 #define CDO_LOCK                0x8     /* lock tray on open files */
 407 #define CDO_CHECK_TYPE          0x10    /* check type on open for data */
 408
 409 /* Special codes used when specifying changer slots. */
 410 #define CDSL_NONE               ((int) (~0U>>1)-1)
 411 #define CDSL_CURRENT            ((int) (~0U>>1))
 412
 413 /* For partition based multisession access. IDE can handle 64 partitions
 414  * per drive - SCSI CD-ROM's use minors to differentiate between the
 415  * various drives, so we can't do multisessions the same way there.
 416  * Use the -o session=x option to mount on them.
 417  */
 418 #define CD_PART_MAX             64
 419 #define CD_PART_MASK            (CD_PART_MAX - 1)
 420
 421 /*********************************************************************
 422  * Generic Packet commands, MMC commands, and such
 423  *********************************************************************/
 424
 425  /* The generic packet command opcodes for CD/DVD Logical Units,
 426  * From Table 57 of the SFF8090 Ver. 3 (Mt. Fuji) draft standard. */
 427 #define GPCMD_BLANK                         0xa1
 428 #define GPCMD_CLOSE_TRACK                   0x5b
 429 #define GPCMD_FLUSH_CACHE                   0x35
 430 #define GPCMD_FORMAT_UNIT                   0x04
 431 #define GPCMD_GET_CONFIGURATION             0x46
 432 #define GPCMD_GET_EVENT_STATUS_NOTIFICATION 0x4a
 433 #define GPCMD_GET_PERFORMANCE               0xac
 434 #define GPCMD_INQUIRY                       0x12
 435 #define GPCMD_LOAD_UNLOAD                   0xa6
 436 #define GPCMD_MECHANISM_STATUS              0xbd
 437 #define GPCMD_MODE_SELECT_10                0x55
 438 #define GPCMD_MODE_SENSE_10                 0x5a
 439 #define GPCMD_PAUSE_RESUME                  0x4b
 440 #define GPCMD_PLAY_AUDIO_10                 0x45
 441 #define GPCMD_PLAY_AUDIO_MSF                0x47
 442 #define GPCMD_PLAY_AUDIO_TI                 0x48
 443 #define GPCMD_PLAY_CD                       0xbc
 444 #define GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL  0x1e
 445 #define GPCMD_READ_10                       0x28
 446 #define GPCMD_READ_12                       0xa8
 447 #define GPCMD_READ_CDVD_CAPACITY            0x25
 448 #define GPCMD_READ_CD                       0xbe
 449 #define GPCMD_READ_CD_MSF                   0xb9
 450 #define GPCMD_READ_DISC_INFO                0x51
 451 #define GPCMD_READ_DVD_STRUCTURE            0xad
 452 #define GPCMD_READ_FORMAT_CAPACITIES        0x23
 453 #define GPCMD_READ_HEADER                   0x44
 454 #define GPCMD_READ_TRACK_RZONE_INFO         0x52
 455 #define GPCMD_READ_SUBCHANNEL               0x42
 456 #define GPCMD_READ_TOC_PMA_ATIP             0x43
 457 #define GPCMD_REPAIR_RZONE_TRACK            0x58
 458 #define GPCMD_REPORT_KEY                    0xa4
 459 #define GPCMD_REQUEST_SENSE                 0x03
 460 #define GPCMD_RESERVE_RZONE_TRACK           0x53
 461 #define GPCMD_SCAN                          0xba
 462 #define GPCMD_SEEK                          0x2b
 463 #define GPCMD_SEND_DVD_STRUCTURE            0xad
 464 #define GPCMD_SEND_EVENT                    0xa2
 465 #define GPCMD_SEND_KEY                      0xa3
 466 #define GPCMD_SEND_OPC                      0x54
 467 #define GPCMD_SET_READ_AHEAD                0xa7
 468 #define GPCMD_SET_STREAMING                 0xb6
 469 #define GPCMD_START_STOP_UNIT               0x1b
 470 #define GPCMD_STOP_PLAY_SCAN                0x4e
 471 #define GPCMD_TEST_UNIT_READY               0x00
 472 #define GPCMD_VERIFY_10                     0x2f
 473 #define GPCMD_WRITE_10                      0x2a
 474 #define GPCMD_WRITE_AND_VERIFY_10           0x2e
 475 /* This is listed as optional in ATAPI 2.6, but is (curiously)
 476  * missing from Mt. Fuji, Table 57.  It _is_ mentioned in Mt. Fuji
 477  * Table 377 as an MMC command for SCSi devices though...  Most ATAPI
 478  * drives support it. */
 479 #define GPCMD_SET_SPEED                     0xbb
 480 /* This seems to be a SCSI specific CD-ROM opcode
 481  * to play data at track/index */
 482 #define GPCMD_PLAYAUDIO_TI                  0x48
 483 /*
 484  * From MS Media Status Notification Support Specification. For
 485  * older drives only.
 486  */
 487 #define GPCMD_GET_MEDIA_STATUS              0xda
 488
 489 /* Mode page codes for mode sense/set */
 490 #define GPMODE_R_W_ERROR_PAGE           0x01
 491 #define GPMODE_WRITE_PARMS_PAGE         0x05
 492 #define GPMODE_AUDIO_CTL_PAGE           0x0e
 493 #define GPMODE_POWER_PAGE               0x1a
 494 #define GPMODE_FAULT_FAIL_PAGE          0x1c
 495 #define GPMODE_TO_PROTECT_PAGE          0x1d
 496 #define GPMODE_CAPABILITIES_PAGE        0x2a
 497 #define GPMODE_ALL_PAGES                0x3f
 498 /* Not in Mt. Fuji, but in ATAPI 2.6 -- depricated now in favor
 499  * of MODE_SENSE_POWER_PAGE */
 500 #define GPMODE_CDROM_PAGE               0x0d
 501
 502
 503
 504 /* DVD struct types */
 505 #define DVD_STRUCT_PHYSICAL     0x00
 506 #define DVD_STRUCT_COPYRIGHT    0x01
 507 #define DVD_STRUCT_DISCKEY      0x02
 508 #define DVD_STRUCT_BCA          0x03
 509 #define DVD_STRUCT_MANUFACT     0x04
 510
 511 struct dvd_layer {
 512         __u8 book_version       : 4;
 513         __u8 book_type          : 4;
 514         __u8 min_rate           : 4;
 515         __u8 disc_size          : 4;
 516         __u8 layer_type         : 4;
 517         __u8 track_path         : 1;
 518         __u8 nlayers            : 2;
 519         __u8 track_density      : 4;
 520         __u8 linear_density     : 4;
 521         __u8 bca                : 1;
 522         __u32 start_sector;
 523         __u32 end_sector;
 524         __u32 end_sector_l0;
 525 };
 526
 527 struct dvd_physical {
 528         __u8 type;
 529         __u8 layer_num;
 530         struct dvd_layer layer[4];
 531 };
 532
 533 struct dvd_copyright {
 534         __u8 type;
 535
 536         __u8 layer_num;
 537         __u8 cpst;
 538         __u8 rmi;
 539 };
 540
 541 struct dvd_disckey {
 542         __u8 type;
 543
 544         unsigned agid           : 2;
 545         __u8 value[2048];
 546 };
 547
 548 struct dvd_bca {
 549         __u8 type;
 550
 551         int len;
 552         __u8 value[188];
 553 };
 554
 555 struct dvd_manufact {
 556         __u8 type;
 557
 558         __u8 layer_num;
 559         int len;
 560         __u8 value[2048];
 561 };
 562
 563 typedef union {
 564         __u8 type;
 565
 566         struct dvd_physical     physical;
 567         struct dvd_copyright    copyright;
 568         struct dvd_disckey      disckey;
 569         struct dvd_bca          bca;
 570         struct dvd_manufact     manufact;
 571 } dvd_struct;
 572
 573 /*
 574  * DVD authentication ioctl
 575  */
 576
 577 /* Authentication states */
 578 #define DVD_LU_SEND_AGID        0
 579 #define DVD_HOST_SEND_CHALLENGE 1
 580 #define DVD_LU_SEND_KEY1        2
 581 #define DVD_LU_SEND_CHALLENGE   3
 582 #define DVD_HOST_SEND_KEY2      4
 583
 584 /* Termination states */
 585 #define DVD_AUTH_ESTABLISHED    5
 586 #define DVD_AUTH_FAILURE        6
 587
 588 /* Other functions */
 589 #define DVD_LU_SEND_TITLE_KEY   7
 590 #define DVD_LU_SEND_ASF         8
 591 #define DVD_INVALIDATE_AGID     9
 592 #define DVD_LU_SEND_RPC_STATE   10
 593 #define DVD_HOST_SEND_RPC_STATE 11
 594
 595 /* State data */
 596 typedef __u8 dvd_key[5];                /* 40-bit value, MSB is first elem. */
 597 typedef __u8 dvd_challenge[10]; /* 80-bit value, MSB is first elem. */
 598
 599 struct dvd_lu_send_agid {
 600         __u8 type;
 601         unsigned agid           : 2;
 602 };
 603
 604 struct dvd_host_send_challenge {
 605         __u8 type;
 606         unsigned agid           : 2;
 607
 608         dvd_challenge chal;
 609 };
 610
 611 struct dvd_send_key {
 612         __u8 type;
 613         unsigned agid           : 2;
 614
 615         dvd_key key;
 616 };
 617
 618 struct dvd_lu_send_challenge {
 619         __u8 type;
 620         unsigned agid           : 2;
 621
 622         dvd_challenge chal;
 623 };
 624
 625 #define DVD_CPM_NO_COPYRIGHT    0
 626 #define DVD_CPM_COPYRIGHTED     1
 627
 628 #define DVD_CP_SEC_NONE         0
 629 #define DVD_CP_SEC_EXIST        1
 630
 631 #define DVD_CGMS_UNRESTRICTED   0
 632 #define DVD_CGMS_SINGLE         2
 633 #define DVD_CGMS_RESTRICTED     3
 634
 635 struct dvd_lu_send_title_key {
 636         __u8 type;
 637         unsigned agid           : 2;
 638
 639         dvd_key title_key;
 640         int lba;
 641         unsigned cpm            : 1;
 642         unsigned cp_sec         : 1;
 643         unsigned cgms           : 2;
 644 };
 645
 646 struct dvd_lu_send_asf {
 647         __u8 type;
 648         unsigned agid           : 2;
 649
 650         unsigned asf            : 1;
 651 };
 652
 653 struct dvd_host_send_rpcstate {
 654         __u8 type;
 655         __u8 pdrc;
 656 };
 657
 658 struct dvd_lu_send_rpcstate {
 659         __u8 type               : 2;
 660         __u8 vra                : 3;
 661         __u8 ucca               : 3;
 662         __u8 region_mask;
 663         __u8 rpc_scheme;
 664 };
 665
 666 typedef union {
 667         __u8 type;
 668
 669         struct dvd_lu_send_agid         lsa;
 670         struct dvd_host_send_challenge  hsc;
 671         struct dvd_send_key             lsk;
 672         struct dvd_lu_send_challenge    lsc;
 673         struct dvd_send_key             hsk;
 674         struct dvd_lu_send_title_key    lstk;
 675         struct dvd_lu_send_asf          lsasf;
 676         struct dvd_host_send_rpcstate   hrpcs;
 677         struct dvd_lu_send_rpcstate     lrpcs;
 678 } dvd_authinfo;
 679
 680 struct request_sense {
 681 #if defined(__BIG_ENDIAN_BITFIELD)
 682         __u8 valid              : 1;
 683         __u8 error_code         : 7;
 684 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 685         __u8 error_code         : 7;
 686         __u8 valid              : 1;
 687 #endif
 688         __u8 segment_number;
 689 #if defined(__BIG_ENDIAN_BITFIELD)
 690         __u8 reserved1          : 2;
 691         __u8 ili                : 1;
 692         __u8 reserved2          : 1;
 693         __u8 sense_key          : 4;
 694 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 695         __u8 sense_key          : 4;
 696         __u8 reserved2          : 1;
 697         __u8 ili                : 1;
 698         __u8 reserved1          : 2;
 699 #endif
 700         __u8 information[4];
 701         __u8 add_sense_len;
 702         __u8 command_info[4];
 703         __u8 asc;
 704         __u8 ascq;
 705         __u8 fruc;
 706         __u8 sks[3];
 707         __u8 asb[46];
 708 };
 709
 710 #ifdef __KERNEL__
 711 #include <linux/devfs_fs_kernel.h>
 712
 713 struct cdrom_write_settings {
 714         unsigned char fpacket;          /* fixed/variable packets */
 715         unsigned long packet_size;      /* write out this number of packets */
 716         unsigned long nwa;              /* next writeable address */
 717         unsigned char writeable;        /* cdrom is writeable */
 718 };
 719
 720 /* Uniform cdrom data structures for cdrom.c */
 721 struct cdrom_device_info {
 722         struct cdrom_device_ops  *ops;  /* link to device_ops */
 723         struct cdrom_device_info *next; /* next device_info for this major */
 724         void *handle;                   /* driver-dependent data */
 725         devfs_handle_t de;              /* real driver creates this  */
 726 /* specifications */
 727         kdev_t dev;                     /* device number */
 728         int mask;                       /* mask of capability: disables them */
 729         int speed;                      /* maximum speed for reading data */
 730         int capacity;                   /* number of discs in jukebox */
 731 /* device-related storage */
 732         int options             : 30;   /* options flags */
 733         unsigned mc_flags       : 2;    /* media change buffer flags */
 734         int use_count;                  /* number of times device opened */
 735         char name[20];                  /* name of the device type */
 736 /* per-device flags */
 737         __u8 sanyo_slot         : 2;    /* Sanyo 3 CD changer support */
 738         __u8 reserved           : 6;    /* not used yet */
 739         struct cdrom_write_settings write;
 740 };
 741
 742 struct cdrom_device_ops {
 743 /* routines */
 744         int (*open) (struct cdrom_device_info *, int);
 745         void (*release) (struct cdrom_device_info *);
 746         int (*drive_status) (struct cdrom_device_info *, int);
 747         int (*media_changed) (struct cdrom_device_info *, int);
 748         int (*tray_move) (struct cdrom_device_info *, int);
 749         int (*lock_door) (struct cdrom_device_info *, int);
 750         int (*select_speed) (struct cdrom_device_info *, int);
 751         int (*select_disc) (struct cdrom_device_info *, int);
 752         int (*get_last_session) (struct cdrom_device_info *,
 753                                  struct cdrom_multisession *);
 754         int (*get_mcn) (struct cdrom_device_info *,
 755                         struct cdrom_mcn *);
 756         /* hard reset device */
 757         int (*reset) (struct cdrom_device_info *);
 758         /* play stuff */
 759         int (*audio_ioctl) (struct cdrom_device_info *,unsigned int, void *);
 760         /* dev-specific */
 761         int (*dev_ioctl) (struct cdrom_device_info *,
 762                           unsigned int, unsigned long);
 763 /* driver specifications */
 764         const int capability;   /* capability flags */
 765         int n_minors;           /* number of active minor devices */
 766         /* handle uniform packets for scsi type devices (scsi,atapi) */
 767         int (*generic_packet) (struct cdrom_device_info *,
 768                                struct cdrom_generic_command *);
 769 };
 770
 771 /* the general block_device operations structure: */
 772 extern struct block_device_operations cdrom_fops;
 773
 774 extern int register_cdrom(struct cdrom_device_info *cdi);
 775 extern int unregister_cdrom(struct cdrom_device_info *cdi);
 776
 777 typedef struct {
 778     int data;
 779     int audio;
 780     int cdi;
 781     int xa;
 782     long error;
 783 } tracktype;
 784
 785 extern void cdrom_count_tracks(struct cdrom_device_info *cdi,tracktype* tracks);
 786 extern int cdrom_get_next_writable(kdev_t dev, long *next_writable);
 787 extern int cdrom_get_last_written(kdev_t dev, long *last_written);
 788 extern int cdrom_number_of_slots(struct cdrom_device_info *cdi);
 789 extern int cdrom_select_disc(struct cdrom_device_info *cdi, int slot);
 790 extern int cdrom_mode_select(struct cdrom_device_info *cdi,
 791                              struct cdrom_generic_command *cgc);
 792 extern int cdrom_mode_sense(struct cdrom_device_info *cdi,
 793                             struct cdrom_generic_command *cgc,
 794                             int page_code, int page_control);
 795 extern void init_cdrom_command(struct cdrom_generic_command *cgc,
 796                                void *buffer, int len, int type);
 797 extern struct cdrom_device_info *cdrom_find_device(kdev_t dev);
 798
 799 typedef struct {
 800         __u16 disc_information_length;
 801 #if defined(__BIG_ENDIAN_BITFIELD)
 802         __u8 reserved1                  : 3;
 803         __u8 erasable                   : 1;
 804         __u8 border_status              : 2;
 805         __u8 disc_status                : 2;
 806 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 807         __u8 disc_status                : 2;
 808         __u8 border_status              : 2;
 809         __u8 erasable                   : 1;
 810         __u8 reserved1                  : 3;
 811 #else
 812 #error "Please fix <asm/byteorder.h>"
 813 #endif
 814         __u8 n_first_track;
 815         __u8 n_sessions_lsb;
 816         __u8 first_track_lsb;
 817         __u8 last_track_lsb;
 818 #if defined(__BIG_ENDIAN_BITFIELD)
 819         __u8 did_v                      : 1;
 820         __u8 dbc_v                      : 1;
 821         __u8 uru                        : 1;
 822         __u8 reserved2                  : 5;
 823 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 824         __u8 reserved2                  : 5;
 825         __u8 uru                        : 1;
 826         __u8 dbc_v                      : 1;
 827         __u8 did_v                      : 1;
 828 #endif
 829         __u8 disc_type;
 830         __u8 n_sessions_msb;
 831         __u8 first_track_msb;
 832         __u8 last_track_msb;
 833         __u32 disc_id;
 834         __u32 lead_in;
 835         __u32 lead_out;
 836         __u8 disc_bar_code[8];
 837         __u8 reserved3;
 838         __u8 n_opc;
 839 } disc_information;
 840
 841 typedef struct {
 842         __u16 track_information_length;
 843         __u8 track_lsb;
 844         __u8 session_lsb;
 845         __u8 reserved1;
 846 #if defined(__BIG_ENDIAN_BITFIELD)
 847         __u8 reserved2                  : 2;
 848         __u8 damage                     : 1;
 849         __u8 copy                       : 1;
 850         __u8 track_mode                 : 4;
 851         __u8 rt                         : 1;
 852         __u8 blank                      : 1;
 853         __u8 packet                     : 1;
 854         __u8 fp                         : 1;
 855         __u8 data_mode                  : 4;
 856         __u8 reserved3                  : 6;
 857         __u8 lra_v                      : 1;
 858         __u8 nwa_v                      : 1;
 859 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 860         __u8 track_mode                 : 4;
 861         __u8 copy                       : 1;
 862         __u8 damage                     : 1;
 863         __u8 reserved2                  : 2;
 864         __u8 data_mode                  : 4;
 865         __u8 fp                         : 1;
 866         __u8 packet                     : 1;
 867         __u8 blank                      : 1;
 868         __u8 rt                         : 1;
 869         __u8 nwa_v                      : 1;
 870         __u8 lra_v                      : 1;
 871         __u8 reserved3                  : 6;
 872 #endif
 873         __u32 track_start;
 874         __u32 next_writable;
 875         __u32 free_blocks;
 876         __u32 fixed_packet_size;
 877         __u32 track_size;
 878         __u32 last_rec_address;
 879 } track_information;
 880
 881 extern int cdrom_get_disc_info(kdev_t dev, disc_information *di);
 882 extern int cdrom_get_track_info(kdev_t dev, __u16 track, __u8 type,
 883                                 track_information *ti);
 884
 885 /* The SCSI spec says there could be 256 slots. */
 886 #define CDROM_MAX_SLOTS 256
 887
 888 struct cdrom_mechstat_header {
 889 #if defined(__BIG_ENDIAN_BITFIELD)
 890         __u8 fault         : 1;
 891         __u8 changer_state : 2;
 892         __u8 curslot       : 5;
 893         __u8 mech_state    : 3;
 894         __u8 door_open     : 1;
 895         __u8 reserved1     : 4;
 896 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 897         __u8 curslot       : 5;
 898         __u8 changer_state : 2;
 899         __u8 fault         : 1;
 900         __u8 reserved1     : 4;
 901         __u8 door_open     : 1;
 902         __u8 mech_state    : 3;
 903 #endif
 904         __u8     curlba[3];
 905         __u8     nslots;
 906         __u16 slot_tablelen;
 907 };
 908
 909 struct cdrom_slot {
 910 #if defined(__BIG_ENDIAN_BITFIELD)
 911         __u8 disc_present : 1;
 912         __u8 reserved1    : 6;
 913         __u8 change       : 1;
 914 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 915         __u8 change       : 1;
 916         __u8 reserved1    : 6;
 917         __u8 disc_present : 1;
 918 #endif
 919         __u8 reserved2[3];
 920 };
 921
 922 struct cdrom_changer_info {
 923         struct cdrom_mechstat_header hdr;
 924         struct cdrom_slot slots[CDROM_MAX_SLOTS];
 925 };
 926
 927 typedef enum {
 928         mechtype_caddy = 0,
 929         mechtype_tray  = 1,
 930         mechtype_popup = 2,
 931         mechtype_individual_changer = 4,
 932         mechtype_cartridge_changer  = 5
 933 } mechtype_t;
 934
 935 struct mode_page_header {
 936         __u16 mode_data_length;
 937         __u8 medium_type;
 938         __u8 reserved1;
 939         __u8 reserved2;
 940         __u8 reserved3;
 941         __u16 desc_length;
 942 };
 943
 944 typedef struct {
 945 #if defined(__BIG_ENDIAN_BITFIELD)
 946         __u8 ps                 : 1;
 947         __u8 reserved1          : 1;
 948         __u8 page_code          : 6;
 949         __u8 page_length;
 950         __u8 reserved2          : 1;
 951         __u8 bufe               : 1;
 952         __u8 ls_v               : 1;
 953         __u8 test_write         : 1;
 954         __u8 write_type         : 4;
 955         __u8 multi_session      : 2; /* or border, DVD */
 956         __u8 fp                 : 1;
 957         __u8 copy               : 1;
 958         __u8 track_mode         : 4;
 959         __u8 reserved3          : 4;
 960         __u8 data_block_type    : 4;
 961 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 962         __u8 page_code          : 6;
 963         __u8 reserved1          : 1;
 964         __u8 ps                 : 1;
 965         __u8 page_length;
 966         __u8 write_type         : 4;
 967         __u8 test_write         : 1;
 968         __u8 ls_v               : 1;
 969         __u8 bufe               : 1;
 970         __u8 reserved2          : 1;
 971         __u8 track_mode         : 4;
 972         __u8 copy               : 1;
 973         __u8 fp                 : 1;
 974         __u8 multi_session      : 2; /* or border, DVD */
 975         __u8 data_block_type    : 4;
 976         __u8 reserved3          : 4;
 977 #endif
 978         __u8 link_size;
 979         __u8 reserved4;
 980 #if defined(__BIG_ENDIAN_BITFIELD)
 981         __u8 reserved5          : 2;
 982         __u8 app_code           : 6;
 983 #elif defined(__LITTLE_ENDIAN_BITFIELD)
 984         __u8 app_code           : 6;
 985         __u8 reserved5          : 2;
 986 #endif
 987         __u8 session_format;
 988         __u8 reserved6;
 989         __u32 packet_size;
 990         __u16 audio_pause;
 991         __u8 mcn[16];
 992         __u8 isrc[16];
 993         __u8 subhdr0;
 994         __u8 subhdr1;
 995         __u8 subhdr2;
 996         __u8 subhdr3;
 997 } __attribute__((packed)) write_param_page;
 998
 999 struct modesel_head
1000 {
1001         __u8    reserved1;
1002         __u8    medium;
1003         __u8    reserved2;
1004         __u8    block_desc_length;
1005         __u8    density;
1006         __u8    number_of_blocks_hi;
1007         __u8    number_of_blocks_med;
1008         __u8    number_of_blocks_lo;
1009         __u8    reserved3;
1010         __u8    block_length_hi;
1011         __u8    block_length_med;
1012         __u8    block_length_lo;
1013 };
1014
1015 typedef struct {
1016         __u16 report_key_length;
1017         __u8 reserved1;
1018         __u8 reserved2;
1019 #if defined(__BIG_ENDIAN_BITFIELD)
1020         __u8 type_code                  : 2;
1021         __u8 vra                        : 3;
1022         __u8 ucca                       : 3;
1023 #elif defined(__LITTLE_ENDIAN_BITFIELD)
1024         __u8 ucca                       : 3;
1025         __u8 vra                        : 3;
1026         __u8 type_code                  : 2;
1027 #endif
1028         __u8 region_mask;
1029         __u8 rpc_scheme;
1030         __u8 reserved3;
1031 } rpc_state_t;
1032
1033 #endif  /* End of kernel only stuff */
1034
1035 #endif  /* _LINUX_CDROM_H */