root/include/linux/cdrom.h

/* [previous][next][first][last][top][bottom][index][help] */

INCLUDED FROM


   1 /*
   2  * -- <linux/cdrom.h>
   3  * general (not only SCSI) header library for linux CDROM drivers
   4  * (C) 1992         David Giller rafetmad@oxy.edu
   5  *     1994, 1995   Eberhard Moenkeberg emoenke@gwdg.de
   6  *
   7  */
   8 
   9 #ifndef _LINUX_CDROM_H
  10 #define _LINUX_CDROM_H
  11 
  12 /*
  13  * some fix numbers
  14  */
  15 #define CD_MINS             74 /* max. minutes per CD, not really a limit */
  16 #define CD_SECS             60 /* seconds per minute */
  17 #define CD_FRAMES           75 /* frames per second */
  18 
  19 #define CD_SYNC_SIZE        12 /* 12 sync bytes per raw data frame, not transfered by the drive */
  20 #define CD_HEAD_SIZE         4 /* header (address) bytes per raw data frame */
  21 #define CD_SUBHEAD_SIZE      8 /* subheader bytes per raw XA data frame */
  22 #define CD_XA_HEAD        (CD_HEAD_SIZE+CD_SUBHEAD_SIZE) /* "before data" part of raw XA frame */
  23 #define CD_XA_SYNC_HEAD   (CD_SYNC_SIZE+CD_XA_HEAD)/* sync bytes + header of XA frame */
  24 
  25 #define CD_FRAMESIZE      2048 /* bytes per frame, "cooked" mode */
  26 #define CD_FRAMESIZE_RAW  2352 /* bytes per frame, "raw" mode */
  27 /* most drives don't deliver everything: */
  28 #define CD_FRAMESIZE_RAW1 (CD_FRAMESIZE_RAW-CD_SYNC_SIZE) /* 2340 */
  29 #define CD_FRAMESIZE_RAW0 (CD_FRAMESIZE_RAW-CD_SYNC_SIZE-CD_HEAD_SIZE) /* 2336 */
  30 /* Optics drive also has a 'read all' mode: */
  31 #define CD_FRAMESIZE_RAWER 2646 /* bytes per frame */
  32 
  33 #define CD_EDC_SIZE         4 /* bytes EDC per most raw data frame types */
  34 #define CD_ZERO_SIZE        8 /* bytes zero per yellow book mode 1 frame */
  35 #define CD_ECC_SIZE       276 /* bytes ECC per most raw data frame types */
  36 #define CD_XA_TAIL        (CD_EDC_SIZE+CD_ECC_SIZE) /* "after data" part of raw XA frame */
  37 
  38 #define CD_FRAMESIZE_SUB    96 /* subchannel data "frame" size */
  39 #define CD_MSF_OFFSET      150 /* MSF numbering offset of first frame */
  40 
  41 #define CD_CHUNK_SIZE       24 /* lowest-level "data bytes piece" */
  42 #define CD_NUM_OF_CHUNKS    98 /* chunks per frame */
  43 
  44 #define CD_FRAMESIZE_XA CD_FRAMESIZE_RAW1 /* obsolete name */
  45 #define CD_BLOCK_OFFSET    CD_MSF_OFFSET /* obsolete name */
  46 
  47 /*
  48  * the raw frame layout:
  49  *
  50  * - audio (red):                  | audio_sample_bytes |
  51  *                                 |        2352        |
  52  *
  53  * - data (yellow, mode1):         | sync - head - data - EDC - zero - ECC |
  54  *                                 |  12  -   4  - 2048 -  4  -   8  - 276 |
  55  *
  56  * - data (yellow, mode2):         | sync - head - data |
  57  *                                 |  12  -   4  - 2336 |
  58  *
  59  * - XA data (green, mode2 form1): | sync - head - sub - data - EDC - ECC |
  60  *                                 |  12  -   4  -  8  - 2048 -  4  - 276 |
  61  *
  62  * - XA data (green, mode2 form2): | sync - head - sub - data - EDC |
  63  *                                 |  12  -   4  -  8  - 2324 -  4  |
  64  */
  65 
  66 /*
  67  * CDROM IOCTL structures
  68  */
  69 
  70 struct cdrom_blk 
  71 {
  72         unsigned from;
  73         unsigned short len;
  74 };
  75 
  76 
  77 struct cdrom_msf 
  78 {
  79         u_char  cdmsf_min0;     /* start minute */
  80         u_char  cdmsf_sec0;     /* start second */
  81         u_char  cdmsf_frame0;   /* start frame */
  82         u_char  cdmsf_min1;     /* end minute */
  83         u_char  cdmsf_sec1;     /* end second */
  84         u_char  cdmsf_frame1;   /* end frame */
  85 };
  86 
  87 struct cdrom_ti 
  88 {
  89         u_char  cdti_trk0;      /* start track */
  90         u_char  cdti_ind0;      /* start index */
  91         u_char  cdti_trk1;      /* end track */
  92         u_char  cdti_ind1;      /* end index */
  93 };
  94 
  95 struct cdrom_tochdr     
  96 {
  97         u_char  cdth_trk0;      /* start track */
  98         u_char  cdth_trk1;      /* end track */
  99 };
 100 
 101 struct cdrom_msf0               /* address in MSF format */
 102 {
 103         u_char  minute;
 104         u_char  second;
 105         u_char  frame;
 106 };
 107 
 108 union cdrom_addr                /* address in either MSF or logical format */
 109 {
 110         struct cdrom_msf0       msf;
 111         int                     lba;
 112 };
 113 
 114 struct cdrom_tocentry 
 115 {
 116         u_char  cdte_track;
 117         u_char  cdte_adr        :4;
 118         u_char  cdte_ctrl       :4;
 119         u_char  cdte_format;
 120         union cdrom_addr cdte_addr;
 121         u_char  cdte_datamode;
 122 };
 123 
 124 /*
 125  * CD-ROM address types (cdrom_tocentry.cdte_format)
 126  */
 127 #define CDROM_LBA 0x01 /* "logical block": first frame is #0 */
 128 #define CDROM_MSF 0x02 /* "minute-second-frame": binary, not bcd here! */
 129 
 130 /*
 131  * bit to tell whether track is data or audio (cdrom_tocentry.cdte_ctrl)
 132  */
 133 #define CDROM_DATA_TRACK        0x04
 134 
 135 /*
 136  * The leadout track is always 0xAA, regardless of # of tracks on disc
 137  */
 138 #define CDROM_LEADOUT   0xAA
 139 
 140 struct cdrom_subchnl 
 141 {
 142         u_char  cdsc_format;
 143         u_char  cdsc_audiostatus;
 144         u_char  cdsc_adr:       4;
 145         u_char  cdsc_ctrl:      4;
 146         u_char  cdsc_trk;
 147         u_char  cdsc_ind;
 148         union cdrom_addr cdsc_absaddr;
 149         union cdrom_addr cdsc_reladdr;
 150 };
 151 
 152 /*
 153  * audio states (from SCSI-2, but seen with other drives, too)
 154  */
 155 #define CDROM_AUDIO_INVALID     0x00    /* audio status not supported */
 156 #define CDROM_AUDIO_PLAY        0x11    /* audio play operation in progress */
 157 #define CDROM_AUDIO_PAUSED      0x12    /* audio play operation paused */
 158 #define CDROM_AUDIO_COMPLETED   0x13    /* audio play successfully completed */
 159 #define CDROM_AUDIO_ERROR       0x14    /* audio play stopped due to error */
 160 #define CDROM_AUDIO_NO_STATUS   0x15    /* no current audio status to return */
 161 
 162 struct cdrom_volctrl
 163 {
 164         u_char  channel0;
 165         u_char  channel1;
 166         u_char  channel2;
 167         u_char  channel3;
 168 };
 169 
 170 struct cdrom_read      
 171 {
 172         int     cdread_lba;
 173         caddr_t cdread_bufaddr;
 174         int     cdread_buflen;
 175 };
 176 
 177 /*
 178  * extensions for transfering audio frames
 179  * currently used by sbpcd.c, cdu31a.c, ide-cd.c
 180  */
 181 struct cdrom_read_audio
 182 {
 183         union cdrom_addr addr; /* frame address */
 184         u_char addr_format; /* CDROM_LBA or CDROM_MSF */
 185         int nframes; /* number of 2352-byte-frames to read at once, limited by the drivers */
 186         u_char *buf; /* frame buffer (size: nframes*2352 bytes) */
 187 };
 188 
 189 /*
 190  * this has to be the "arg" of the CDROMMULTISESSION ioctl
 191  * for obtaining multi session info.
 192  * The returned "addr" is valid only if "xa_flag" is true.
 193  */
 194 struct cdrom_multisession
 195 {
 196         union cdrom_addr addr; /* frame address: start-of-last-session (not the new "frame 16"!)*/
 197         u_char xa_flag; /* 1: "is XA disk" */
 198         u_char addr_format; /* CDROM_LBA or CDROM_MSF */
 199 };
 200 
 201 #ifdef FIVETWELVE
 202 #define CDROM_MODE1_SIZE        512
 203 #else
 204 #define CDROM_MODE1_SIZE        2048
 205 #endif FIVETWELVE
 206 #define CDROM_MODE2_SIZE        2336
 207 
 208 /*
 209  * CD-ROM IOCTL commands
 210  * For IOCTL calls, we will commandeer byte 0x53, or 'S'.
 211  */
 212 
 213 #define CDROMPAUSE              0x5301
 214 #define CDROMRESUME             0x5302
 215 #define CDROMPLAYMSF            0x5303  /* (struct cdrom_msf) */
 216 #define CDROMPLAYTRKIND         0x5304  /* (struct cdrom_ti) */
 217 
 218 #define CDROMREADTOCHDR         0x5305  /* (struct cdrom_tochdr) */
 219 #define CDROMREADTOCENTRY       0x5306  /* (struct cdrom_tocentry) */
 220 
 221 #define CDROMSTOP               0x5307  /* stop the drive motor */
 222 #define CDROMSTART              0x5308  /* turn the motor on */
 223 
 224 #define CDROMEJECT              0x5309  /* eject CD-ROM media */
 225 
 226 #define CDROMVOLCTRL            0x530a  /* (struct cdrom_volctrl) */
 227 
 228 #define CDROMSUBCHNL            0x530b  /* (struct cdrom_subchnl) */
 229 
 230 #define CDROMREADMODE2          0x530c  /* (struct cdrom_read) */
 231                                           /* read type-2 data */
 232 
 233 #define CDROMREADMODE1          0x530d  /* (struct cdrom_read) */
 234                                           /* read type-1 data */
 235 
 236 #define CDROMREADAUDIO          0x530e  /* (struct cdrom_read_audio) */
 237 
 238 /*
 239  * enable (1) / disable (0) auto-ejecting
 240  */
 241 #define CDROMEJECT_SW           0x530f  /* arg: 0 or 1 */
 242  
 243 /*
 244  * obtain the start-of-last-session address of multi session disks
 245  */
 246 #define CDROMMULTISESSION       0x5310  /* (struct cdrom_multisession) */
 247 
 248 /*
 249  * obtain the "universal product code" number
 250  * (only some data disks have it coded)
 251  */
 252 #define CDROM_GET_UPC           0x5311  /* 8 bytes returned */
 253 
 254 #define CDROMRESET              0x5312  /* hard-reset the drive */
 255 #define CDROMVOLREAD            0x5313  /* let the drive tell its volume setting */
 256                                         /* (struct cdrom_volctrl) */
 257 
 258 /* 
 259  * these ioctls are used in aztcd.c and optcd.c
 260  */
 261 #define CDROMREADRAW            0x5314  /* read data in raw mode */
 262 #define CDROMREADCOOKED         0x5315  /* read data in cooked mode */
 263 #define CDROMSEEK               0x5316  /* seek msf address */
 264   
 265 /*
 266  * for playing audio in logical block addressing mode
 267  */
 268 #define CDROMPLAYBLK            0x5317  /* (struct cdrom_blk) */
 269 
 270 /* 
 271  * these ioctls are used in optcd.c
 272  */
 273 #define CDROMREADALL            0x5318  /* read all 2646 bytes */
 274 #define CDROMCLOSETRAY          0x5319  /* pendant of CDROMEJECT */
 275 
 276 
 277 /*
 278  * CD-ROM-specific SCSI command opcodes
 279  */
 280 
 281 /*
 282  * Group 2 (10-byte).  All of these are called 'optional' by SCSI-II.
 283  */
 284 #define SCMD_READ_TOC           0x43    /* read table of contents */
 285 #define SCMD_PLAYAUDIO_MSF      0x47    /* play data at time offset */
 286 #define SCMD_PLAYAUDIO_TI       0x48    /* play data at track/index */
 287 #define SCMD_PAUSE_RESUME       0x4B    /* pause/resume audio */
 288 #define SCMD_READ_SUBCHANNEL    0x42    /* read SC info on playing disc */
 289 #define SCMD_PLAYAUDIO10        0x45    /* play data at logical block */
 290 #define SCMD_READ_HEADER        0x44    /* read TOC header */
 291 
 292 /*
 293  * Group 5
 294  */
 295 #define SCMD_PLAYAUDIO12        0xA5    /* play data at logical block */
 296 #define SCMD_PLAYTRACK_REL12    0xA9    /* play track at relative offset */
 297 
 298 /*
 299  * Group 6 Commands
 300  */
 301 #define SCMD_CD_PLAYBACK_CONTROL 0xC9   /* Sony vendor-specific audio */
 302 #define SCMD_CD_PLAYBACK_STATUS 0xC4    /* control opcodes */
 303 
 304 /*
 305  * CD-ROM capacity structure.
 306  */
 307 struct scsi_capacity 
 308 {
 309         u_long  capacity;
 310         u_long  lbasize;
 311 };
 312 
 313 /*
 314  * CD-ROM MODE_SENSE/MODE_SELECT parameters
 315  */
 316 #define ERR_RECOVERY_PARMS      0x01
 317 #define DISCO_RECO_PARMS        0x02
 318 #define FORMAT_PARMS            0x03
 319 #define GEOMETRY_PARMS          0x04
 320 #define CERTIFICATION_PARMS     0x06
 321 #define CACHE_PARMS             0x38
 322 
 323 /*
 324  * standard mode-select header prepended to all mode-select commands
 325  */
 326 struct ccs_modesel_head 
 327 {
 328         u_char  _r1;    /* reserved */
 329         u_char  medium; /* device-specific medium type */
 330         u_char  _r2;    /* reserved */
 331         u_char  block_desc_length; /* block descriptor length */
 332         u_char  density; /* device-specific density code */
 333         u_char  number_blocks_hi; /* number of blocks in this block desc */
 334         u_char  number_blocks_med;
 335         u_char  number_blocks_lo;
 336         u_char  _r3;
 337         u_char  block_length_hi; /* block length for blocks in this desc */
 338         u_short block_length;
 339 };
 340 
 341 /*
 342  * error recovery parameters
 343  */
 344 struct ccs_err_recovery 
 345 {
 346         u_char  _r1 : 2;        /* reserved */
 347         u_char  page_code : 6;  /* page code */
 348         u_char  page_length;    /* page length */
 349         u_char  awre    : 1;    /* auto write realloc enabled */
 350         u_char  arre    : 1;    /* auto read realloc enabled */
 351         u_char  tb      : 1;    /* transfer block */
 352         u_char  rc      : 1;    /* read continuous */
 353         u_char  eec     : 1;    /* enable early correction */
 354         u_char  per     : 1;    /* post error */
 355         u_char  dte     : 1;    /* disable transfer on error */
 356         u_char  dcr     : 1;    /* disable correction */
 357         u_char  retry_count;    /* error retry count */
 358         u_char  correction_span; /* largest recov. to be attempted, bits */
 359         u_char  head_offset_count; /* head offset (2's C) for each retry */
 360         u_char  strobe_offset_count; /* data strobe */
 361         u_char  recovery_time_limit; /* time limit on recovery attempts */
 362 };
 363 
 364 /*
 365  * disco/reco parameters
 366  */
 367 struct ccs_disco_reco 
 368 {
 369         u_char  _r1     : 2;    /* reserved */
 370         u_char  page_code : 6;  /* page code */
 371         u_char  page_length;    /* page length */
 372         u_char  buffer_full_ratio; /* write buffer reconnect threshold */
 373         u_char  buffer_empty_ratio; /* read */
 374         u_short bus_inactivity_limit; /* limit on bus inactivity time */
 375         u_short disconnect_time_limit; /* minimum disconnect time */
 376         u_short connect_time_limit; /* minimum connect time */
 377         u_short _r2;            /* reserved */
 378 };
 379 
 380 /*
 381  * drive geometry parameters
 382  */
 383 struct ccs_geometry 
 384 {
 385         u_char  _r1     : 2;    /* reserved */
 386         u_char  page_code : 6;  /* page code */
 387         u_char  page_length;    /* page length */
 388         u_char  cyl_ub;         /* #cyls */
 389         u_char  cyl_mb;
 390         u_char  cyl_lb;
 391         u_char  heads;          /* #heads */
 392         u_char  precomp_cyl_ub; /* precomp start */
 393         u_char  precomp_cyl_mb;
 394         u_char  precomp_cyl_lb;
 395         u_char  current_cyl_ub; /* reduced current start */
 396         u_char  current_cyl_mb;
 397         u_char  current_cyl_lb;
 398         u_short step_rate;      /* stepping motor rate */
 399         u_char  landing_cyl_ub; /* landing zone */
 400         u_char  landing_cyl_mb;
 401         u_char  landing_cyl_lb;
 402         u_char  _r2;
 403         u_char  _r3;
 404         u_char  _r4;
 405 };
 406 
 407 /*
 408  * cache parameters
 409  */
 410 struct ccs_cache 
 411 {
 412         u_char  _r1     : 2;    /* reserved */
 413         u_char  page_code : 6;  /* page code */
 414         u_char  page_length;    /* page length */
 415         u_char  mode;           /* cache control byte */
 416         u_char  threshold;      /* prefetch threshold */
 417         u_char  max_prefetch;   /* maximum prefetch size */
 418         u_char  max_multiplier; /* maximum prefetch multiplier */
 419         u_char  min_prefetch;   /* minimum prefetch size */
 420         u_char  min_multiplier; /* minimum prefetch multiplier */
 421         u_char  _r2[8];
 422 };
 423 
 424 #endif  _LINUX_CDROM_H
 425 /*==========================================================================*/
 426 /*
 427  * Overrides for Emacs so that we follow Linus's tabbing style.
 428  * Emacs will notice this stuff at the end of the file and automatically
 429  * adjust the settings for this buffer only.  This must remain at the end
 430  * of the file. 
 431  * ---------------------------------------------------------------------------
 432  * Local variables:
 433  * c-indent-level: 8
 434  * c-brace-imaginary-offset: 0
 435  * c-brace-offset: -8
 436  * c-argdecl-indent: 8
 437  * c-label-offset: -8
 438  * c-continued-statement-offset: 8
 439  * c-continued-brace-offset: 0
 440  * End:
 441  */

/* [previous][next][first][last][top][bottom][index][help] */