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