blob: b68fdf1f31562aba500b37a8dbdb4af0ee2e8321 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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-2002 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 compatibility */
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 */
153struct cdrom_msf0
154{
155 __u8 minute;
156 __u8 second;
157 __u8 frame;
158};
159
160/* Address in either MSF or logical format */
161union cdrom_addr
162{
163 struct cdrom_msf0 msf;
164 int lba;
165};
166
167/* This struct is used by the CDROMPLAYMSF ioctl */
168struct 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 */
179struct 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 */
188struct 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 */
195struct 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 */
204struct 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 */
218struct 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 */
229struct 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 */
237struct 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 __user *buf; /* frame buffer (size: nframes*2352 bytes) */
243};
244
245/* This struct is used with the CDROMMULTISESSION ioctl */
246struct 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 */
260struct cdrom_mcn
261{
262 __u8 medium_catalog_number[14]; /* 13 ASCII digits, null-terminated */
263};
264
265/* This is used by the CDROMPLAYBLK ioctl */
266struct 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 */
280struct cdrom_generic_command
281{
282 unsigned char cmd[CDROM_PACKET_SIZE];
283 unsigned char __user *buffer;
284 unsigned int buflen;
285 int stat;
286 struct request_sense __user *sense;
287 unsigned char data_direction;
288 int quiet;
289 int timeout;
290 void __user *reserved[1]; /* unused, actually */
291};
292
293/*
294 * A CD-ROM physical sector size is 2048, 2052, 2056, 2324, 2332, 2336,
295 * 2340, or 2352 bytes long.
296
297* Sector types of the standard CD-ROM data formats:
298 *
299 * format sector type user data size (bytes)
300 * -----------------------------------------------------------------------------
301 * 1 (Red Book) CD-DA 2352 (CD_FRAMESIZE_RAW)
302 * 2 (Yellow Book) Mode1 Form1 2048 (CD_FRAMESIZE)
303 * 3 (Yellow Book) Mode1 Form2 2336 (CD_FRAMESIZE_RAW0)
304 * 4 (Green Book) Mode2 Form1 2048 (CD_FRAMESIZE)
305 * 5 (Green Book) Mode2 Form2 2328 (2324+4 spare bytes)
306 *
307 *
308 * The layout of the standard CD-ROM data formats:
309 * -----------------------------------------------------------------------------
310 * - audio (red): | audio_sample_bytes |
311 * | 2352 |
312 *
313 * - data (yellow, mode1): | sync - head - data - EDC - zero - ECC |
314 * | 12 - 4 - 2048 - 4 - 8 - 276 |
315 *
316 * - data (yellow, mode2): | sync - head - data |
317 * | 12 - 4 - 2336 |
318 *
319 * - XA data (green, mode2 form1): | sync - head - sub - data - EDC - ECC |
320 * | 12 - 4 - 8 - 2048 - 4 - 276 |
321 *
322 * - XA data (green, mode2 form2): | sync - head - sub - data - Spare |
323 * | 12 - 4 - 8 - 2324 - 4 |
324 *
325 */
326
327/* Some generally useful CD-ROM information -- mostly based on the above */
328#define CD_MINS 74 /* max. minutes per CD, not really a limit */
329#define CD_SECS 60 /* seconds per minute */
330#define CD_FRAMES 75 /* frames per second */
331#define CD_SYNC_SIZE 12 /* 12 sync bytes per raw data frame */
332#define CD_MSF_OFFSET 150 /* MSF numbering offset of first frame */
333#define CD_CHUNK_SIZE 24 /* lowest-level "data bytes piece" */
334#define CD_NUM_OF_CHUNKS 98 /* chunks per frame */
335#define CD_FRAMESIZE_SUB 96 /* subchannel data "frame" size */
336#define CD_HEAD_SIZE 4 /* header (address) bytes per raw data frame */
337#define CD_SUBHEAD_SIZE 8 /* subheader bytes per raw XA data frame */
338#define CD_EDC_SIZE 4 /* bytes EDC per most raw data frame types */
339#define CD_ZERO_SIZE 8 /* bytes zero per yellow book mode 1 frame */
340#define CD_ECC_SIZE 276 /* bytes ECC per most raw data frame types */
341#define CD_FRAMESIZE 2048 /* bytes per frame, "cooked" mode */
342#define CD_FRAMESIZE_RAW 2352 /* bytes per frame, "raw" mode */
343#define CD_FRAMESIZE_RAWER 2646 /* The maximum possible returned bytes */
344/* most drives don't deliver everything: */
345#define CD_FRAMESIZE_RAW1 (CD_FRAMESIZE_RAW-CD_SYNC_SIZE) /*2340*/
346#define CD_FRAMESIZE_RAW0 (CD_FRAMESIZE_RAW-CD_SYNC_SIZE-CD_HEAD_SIZE) /*2336*/
347
348#define CD_XA_HEAD (CD_HEAD_SIZE+CD_SUBHEAD_SIZE) /* "before data" part of raw XA frame */
349#define CD_XA_TAIL (CD_EDC_SIZE+CD_ECC_SIZE) /* "after data" part of raw XA frame */
350#define CD_XA_SYNC_HEAD (CD_SYNC_SIZE+CD_XA_HEAD) /* sync bytes + header of XA frame */
351
352/* CD-ROM address types (cdrom_tocentry.cdte_format) */
353#define CDROM_LBA 0x01 /* "logical block": first frame is #0 */
354#define CDROM_MSF 0x02 /* "minute-second-frame": binary, not bcd here! */
355
356/* bit to tell whether track is data or audio (cdrom_tocentry.cdte_ctrl) */
357#define CDROM_DATA_TRACK 0x04
358
359/* The leadout track is always 0xAA, regardless of # of tracks on disc */
360#define CDROM_LEADOUT 0xAA
361
362/* audio states (from SCSI-2, but seen with other drives, too) */
363#define CDROM_AUDIO_INVALID 0x00 /* audio status not supported */
364#define CDROM_AUDIO_PLAY 0x11 /* audio play operation in progress */
365#define CDROM_AUDIO_PAUSED 0x12 /* audio play operation paused */
366#define CDROM_AUDIO_COMPLETED 0x13 /* audio play successfully completed */
367#define CDROM_AUDIO_ERROR 0x14 /* audio play stopped due to error */
368#define CDROM_AUDIO_NO_STATUS 0x15 /* no current audio status to return */
369
370/* capability flags used with the uniform CD-ROM driver */
371#define CDC_CLOSE_TRAY 0x1 /* caddy systems _can't_ close */
372#define CDC_OPEN_TRAY 0x2 /* but _can_ eject. */
373#define CDC_LOCK 0x4 /* disable manual eject */
374#define CDC_SELECT_SPEED 0x8 /* programmable speed */
375#define CDC_SELECT_DISC 0x10 /* select disc from juke-box */
376#define CDC_MULTI_SESSION 0x20 /* read sessions>1 */
377#define CDC_MCN 0x40 /* Medium Catalog Number */
378#define CDC_MEDIA_CHANGED 0x80 /* media changed */
379#define CDC_PLAY_AUDIO 0x100 /* audio functions */
380#define CDC_RESET 0x200 /* hard reset device */
381#define CDC_IOCTLS 0x400 /* driver has non-standard ioctls */
382#define CDC_DRIVE_STATUS 0x800 /* driver implements drive status */
383#define CDC_GENERIC_PACKET 0x1000 /* driver implements generic packets */
384#define CDC_CD_R 0x2000 /* drive is a CD-R */
385#define CDC_CD_RW 0x4000 /* drive is a CD-RW */
386#define CDC_DVD 0x8000 /* drive is a DVD */
387#define CDC_DVD_R 0x10000 /* drive can write DVD-R */
388#define CDC_DVD_RAM 0x20000 /* drive can write DVD-RAM */
389#define CDC_MO_DRIVE 0x40000 /* drive is an MO device */
390#define CDC_MRW 0x80000 /* drive can read MRW */
391#define CDC_MRW_W 0x100000 /* drive can write MRW */
392#define CDC_RAM 0x200000 /* ok to open for WRITE */
393
394/* drive status possibilities returned by CDROM_DRIVE_STATUS ioctl */
395#define CDS_NO_INFO 0 /* if not implemented */
396#define CDS_NO_DISC 1
397#define CDS_TRAY_OPEN 2
398#define CDS_DRIVE_NOT_READY 3
399#define CDS_DISC_OK 4
400
401/* return values for the CDROM_DISC_STATUS ioctl */
402/* can also return CDS_NO_[INFO|DISC], from above */
403#define CDS_AUDIO 100
404#define CDS_DATA_1 101
405#define CDS_DATA_2 102
406#define CDS_XA_2_1 103
407#define CDS_XA_2_2 104
408#define CDS_MIXED 105
409
410/* User-configurable behavior options for the uniform CD-ROM driver */
411#define CDO_AUTO_CLOSE 0x1 /* close tray on first open() */
412#define CDO_AUTO_EJECT 0x2 /* open tray on last release() */
413#define CDO_USE_FFLAGS 0x4 /* use O_NONBLOCK information on open */
414#define CDO_LOCK 0x8 /* lock tray on open files */
415#define CDO_CHECK_TYPE 0x10 /* check type on open for data */
416
417/* Special codes used when specifying changer slots. */
418#define CDSL_NONE ((int) (~0U>>1)-1)
419#define CDSL_CURRENT ((int) (~0U>>1))
420
421/* For partition based multisession access. IDE can handle 64 partitions
422 * per drive - SCSI CD-ROM's use minors to differentiate between the
423 * various drives, so we can't do multisessions the same way there.
424 * Use the -o session=x option to mount on them.
425 */
426#define CD_PART_MAX 64
427#define CD_PART_MASK (CD_PART_MAX - 1)
428
429/*********************************************************************
430 * Generic Packet commands, MMC commands, and such
431 *********************************************************************/
432
433 /* The generic packet command opcodes for CD/DVD Logical Units,
434 * From Table 57 of the SFF8090 Ver. 3 (Mt. Fuji) draft standard. */
435#define GPCMD_BLANK 0xa1
436#define GPCMD_CLOSE_TRACK 0x5b
437#define GPCMD_FLUSH_CACHE 0x35
438#define GPCMD_FORMAT_UNIT 0x04
439#define GPCMD_GET_CONFIGURATION 0x46
440#define GPCMD_GET_EVENT_STATUS_NOTIFICATION 0x4a
441#define GPCMD_GET_PERFORMANCE 0xac
442#define GPCMD_INQUIRY 0x12
443#define GPCMD_LOAD_UNLOAD 0xa6
444#define GPCMD_MECHANISM_STATUS 0xbd
445#define GPCMD_MODE_SELECT_10 0x55
446#define GPCMD_MODE_SENSE_10 0x5a
447#define GPCMD_PAUSE_RESUME 0x4b
448#define GPCMD_PLAY_AUDIO_10 0x45
449#define GPCMD_PLAY_AUDIO_MSF 0x47
450#define GPCMD_PLAY_AUDIO_TI 0x48
451#define GPCMD_PLAY_CD 0xbc
452#define GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
453#define GPCMD_READ_10 0x28
454#define GPCMD_READ_12 0xa8
455#define GPCMD_READ_BUFFER_CAPACITY 0x5c
456#define GPCMD_READ_CDVD_CAPACITY 0x25
457#define GPCMD_READ_CD 0xbe
458#define GPCMD_READ_CD_MSF 0xb9
459#define GPCMD_READ_DISC_INFO 0x51
460#define GPCMD_READ_DVD_STRUCTURE 0xad
461#define GPCMD_READ_FORMAT_CAPACITIES 0x23
462#define GPCMD_READ_HEADER 0x44
463#define GPCMD_READ_TRACK_RZONE_INFO 0x52
464#define GPCMD_READ_SUBCHANNEL 0x42
465#define GPCMD_READ_TOC_PMA_ATIP 0x43
466#define GPCMD_REPAIR_RZONE_TRACK 0x58
467#define GPCMD_REPORT_KEY 0xa4
468#define GPCMD_REQUEST_SENSE 0x03
469#define GPCMD_RESERVE_RZONE_TRACK 0x53
470#define GPCMD_SEND_CUE_SHEET 0x5d
471#define GPCMD_SCAN 0xba
472#define GPCMD_SEEK 0x2b
473#define GPCMD_SEND_DVD_STRUCTURE 0xbf
474#define GPCMD_SEND_EVENT 0xa2
475#define GPCMD_SEND_KEY 0xa3
476#define GPCMD_SEND_OPC 0x54
477#define GPCMD_SET_READ_AHEAD 0xa7
478#define GPCMD_SET_STREAMING 0xb6
479#define GPCMD_START_STOP_UNIT 0x1b
480#define GPCMD_STOP_PLAY_SCAN 0x4e
481#define GPCMD_TEST_UNIT_READY 0x00
482#define GPCMD_VERIFY_10 0x2f
483#define GPCMD_WRITE_10 0x2a
484#define GPCMD_WRITE_AND_VERIFY_10 0x2e
485/* This is listed as optional in ATAPI 2.6, but is (curiously)
486 * missing from Mt. Fuji, Table 57. It _is_ mentioned in Mt. Fuji
487 * Table 377 as an MMC command for SCSi devices though... Most ATAPI
488 * drives support it. */
489#define GPCMD_SET_SPEED 0xbb
490/* This seems to be a SCSI specific CD-ROM opcode
491 * to play data at track/index */
492#define GPCMD_PLAYAUDIO_TI 0x48
493/*
494 * From MS Media Status Notification Support Specification. For
495 * older drives only.
496 */
497#define GPCMD_GET_MEDIA_STATUS 0xda
498
499/* Mode page codes for mode sense/set */
500#define GPMODE_VENDOR_PAGE 0x00
501#define GPMODE_R_W_ERROR_PAGE 0x01
502#define GPMODE_WRITE_PARMS_PAGE 0x05
503#define GPMODE_WCACHING_PAGE 0x08
504#define GPMODE_AUDIO_CTL_PAGE 0x0e
505#define GPMODE_POWER_PAGE 0x1a
506#define GPMODE_FAULT_FAIL_PAGE 0x1c
507#define GPMODE_TO_PROTECT_PAGE 0x1d
508#define GPMODE_CAPABILITIES_PAGE 0x2a
509#define GPMODE_ALL_PAGES 0x3f
510/* Not in Mt. Fuji, but in ATAPI 2.6 -- depricated now in favor
511 * of MODE_SENSE_POWER_PAGE */
512#define GPMODE_CDROM_PAGE 0x0d
513
514
515
516/* DVD struct types */
517#define DVD_STRUCT_PHYSICAL 0x00
518#define DVD_STRUCT_COPYRIGHT 0x01
519#define DVD_STRUCT_DISCKEY 0x02
520#define DVD_STRUCT_BCA 0x03
521#define DVD_STRUCT_MANUFACT 0x04
522
523struct dvd_layer {
524 __u8 book_version : 4;
525 __u8 book_type : 4;
526 __u8 min_rate : 4;
527 __u8 disc_size : 4;
528 __u8 layer_type : 4;
529 __u8 track_path : 1;
530 __u8 nlayers : 2;
531 __u8 track_density : 4;
532 __u8 linear_density : 4;
533 __u8 bca : 1;
534 __u32 start_sector;
535 __u32 end_sector;
536 __u32 end_sector_l0;
537};
538
539#define DVD_LAYERS 4
540
541struct dvd_physical {
542 __u8 type;
543 __u8 layer_num;
544 struct dvd_layer layer[DVD_LAYERS];
545};
546
547struct dvd_copyright {
548 __u8 type;
549
550 __u8 layer_num;
551 __u8 cpst;
552 __u8 rmi;
553};
554
555struct dvd_disckey {
556 __u8 type;
557
558 unsigned agid : 2;
559 __u8 value[2048];
560};
561
562struct dvd_bca {
563 __u8 type;
564
565 int len;
566 __u8 value[188];
567};
568
569struct dvd_manufact {
570 __u8 type;
571
572 __u8 layer_num;
573 int len;
574 __u8 value[2048];
575};
576
577typedef union {
578 __u8 type;
579
580 struct dvd_physical physical;
581 struct dvd_copyright copyright;
582 struct dvd_disckey disckey;
583 struct dvd_bca bca;
584 struct dvd_manufact manufact;
585} dvd_struct;
586
587/*
588 * DVD authentication ioctl
589 */
590
591/* Authentication states */
592#define DVD_LU_SEND_AGID 0
593#define DVD_HOST_SEND_CHALLENGE 1
594#define DVD_LU_SEND_KEY1 2
595#define DVD_LU_SEND_CHALLENGE 3
596#define DVD_HOST_SEND_KEY2 4
597
598/* Termination states */
599#define DVD_AUTH_ESTABLISHED 5
600#define DVD_AUTH_FAILURE 6
601
602/* Other functions */
603#define DVD_LU_SEND_TITLE_KEY 7
604#define DVD_LU_SEND_ASF 8
605#define DVD_INVALIDATE_AGID 9
606#define DVD_LU_SEND_RPC_STATE 10
607#define DVD_HOST_SEND_RPC_STATE 11
608
609/* State data */
610typedef __u8 dvd_key[5]; /* 40-bit value, MSB is first elem. */
611typedef __u8 dvd_challenge[10]; /* 80-bit value, MSB is first elem. */
612
613struct dvd_lu_send_agid {
614 __u8 type;
615 unsigned agid : 2;
616};
617
618struct dvd_host_send_challenge {
619 __u8 type;
620 unsigned agid : 2;
621
622 dvd_challenge chal;
623};
624
625struct dvd_send_key {
626 __u8 type;
627 unsigned agid : 2;
628
629 dvd_key key;
630};
631
632struct dvd_lu_send_challenge {
633 __u8 type;
634 unsigned agid : 2;
635
636 dvd_challenge chal;
637};
638
639#define DVD_CPM_NO_COPYRIGHT 0
640#define DVD_CPM_COPYRIGHTED 1
641
642#define DVD_CP_SEC_NONE 0
643#define DVD_CP_SEC_EXIST 1
644
645#define DVD_CGMS_UNRESTRICTED 0
646#define DVD_CGMS_SINGLE 2
647#define DVD_CGMS_RESTRICTED 3
648
649struct dvd_lu_send_title_key {
650 __u8 type;
651 unsigned agid : 2;
652
653 dvd_key title_key;
654 int lba;
655 unsigned cpm : 1;
656 unsigned cp_sec : 1;
657 unsigned cgms : 2;
658};
659
660struct dvd_lu_send_asf {
661 __u8 type;
662 unsigned agid : 2;
663
664 unsigned asf : 1;
665};
666
667struct dvd_host_send_rpcstate {
668 __u8 type;
669 __u8 pdrc;
670};
671
672struct dvd_lu_send_rpcstate {
673 __u8 type : 2;
674 __u8 vra : 3;
675 __u8 ucca : 3;
676 __u8 region_mask;
677 __u8 rpc_scheme;
678};
679
680typedef union {
681 __u8 type;
682
683 struct dvd_lu_send_agid lsa;
684 struct dvd_host_send_challenge hsc;
685 struct dvd_send_key lsk;
686 struct dvd_lu_send_challenge lsc;
687 struct dvd_send_key hsk;
688 struct dvd_lu_send_title_key lstk;
689 struct dvd_lu_send_asf lsasf;
690 struct dvd_host_send_rpcstate hrpcs;
691 struct dvd_lu_send_rpcstate lrpcs;
692} dvd_authinfo;
693
694struct request_sense {
695#if defined(__BIG_ENDIAN_BITFIELD)
696 __u8 valid : 1;
697 __u8 error_code : 7;
698#elif defined(__LITTLE_ENDIAN_BITFIELD)
699 __u8 error_code : 7;
700 __u8 valid : 1;
701#endif
702 __u8 segment_number;
703#if defined(__BIG_ENDIAN_BITFIELD)
704 __u8 reserved1 : 2;
705 __u8 ili : 1;
706 __u8 reserved2 : 1;
707 __u8 sense_key : 4;
708#elif defined(__LITTLE_ENDIAN_BITFIELD)
709 __u8 sense_key : 4;
710 __u8 reserved2 : 1;
711 __u8 ili : 1;
712 __u8 reserved1 : 2;
713#endif
714 __u8 information[4];
715 __u8 add_sense_len;
716 __u8 command_info[4];
717 __u8 asc;
718 __u8 ascq;
719 __u8 fruc;
720 __u8 sks[3];
721 __u8 asb[46];
722};
723
724/*
725 * feature profile
726 */
727#define CDF_RWRT 0x0020 /* "Random Writable" */
728#define CDF_HWDM 0x0024 /* "Hardware Defect Management" */
729#define CDF_MRW 0x0028
730
731/*
732 * media status bits
733 */
734#define CDM_MRW_NOTMRW 0
735#define CDM_MRW_BGFORMAT_INACTIVE 1
736#define CDM_MRW_BGFORMAT_ACTIVE 2
737#define CDM_MRW_BGFORMAT_COMPLETE 3
738
739/*
740 * mrw address spaces
741 */
742#define MRW_LBA_DMA 0
743#define MRW_LBA_GAA 1
744
745/*
746 * mrw mode pages (first is deprecated) -- probed at init time and
747 * cdi->mrw_mode_page is set
748 */
749#define MRW_MODE_PC_PRE1 0x2c
750#define MRW_MODE_PC 0x03
751
752struct mrw_feature_desc {
753 __u16 feature_code;
754#if defined(__BIG_ENDIAN_BITFIELD)
755 __u8 reserved1 : 2;
756 __u8 feature_version : 4;
757 __u8 persistent : 1;
758 __u8 curr : 1;
759#elif defined(__LITTLE_ENDIAN_BITFIELD)
760 __u8 curr : 1;
761 __u8 persistent : 1;
762 __u8 feature_version : 4;
763 __u8 reserved1 : 2;
764#endif
765 __u8 add_len;
766#if defined(__BIG_ENDIAN_BITFIELD)
767 __u8 reserved2 : 7;
768 __u8 write : 1;
769#elif defined(__LITTLE_ENDIAN_BITFIELD)
770 __u8 write : 1;
771 __u8 reserved2 : 7;
772#endif
773 __u8 reserved3;
774 __u8 reserved4;
775 __u8 reserved5;
776};
777
778/* cf. mmc4r02g.pdf 5.3.10 Random Writable Feature (0020h) pg 197 of 635 */
779struct rwrt_feature_desc {
780 __u16 feature_code;
781#if defined(__BIG_ENDIAN_BITFIELD)
782 __u8 reserved1 : 2;
783 __u8 feature_version : 4;
784 __u8 persistent : 1;
785 __u8 curr : 1;
786#elif defined(__LITTLE_ENDIAN_BITFIELD)
787 __u8 curr : 1;
788 __u8 persistent : 1;
789 __u8 feature_version : 4;
790 __u8 reserved1 : 2;
791#endif
792 __u8 add_len;
793 __u32 last_lba;
794 __u32 block_size;
795 __u16 blocking;
796#if defined(__BIG_ENDIAN_BITFIELD)
797 __u8 reserved2 : 7;
798 __u8 page_present : 1;
799#elif defined(__LITTLE_ENDIAN_BITFIELD)
800 __u8 page_present : 1;
801 __u8 reserved2 : 7;
802#endif
803 __u8 reserved3;
804};
805
806typedef struct {
807 __u16 disc_information_length;
808#if defined(__BIG_ENDIAN_BITFIELD)
809 __u8 reserved1 : 3;
810 __u8 erasable : 1;
811 __u8 border_status : 2;
812 __u8 disc_status : 2;
813#elif defined(__LITTLE_ENDIAN_BITFIELD)
814 __u8 disc_status : 2;
815 __u8 border_status : 2;
816 __u8 erasable : 1;
817 __u8 reserved1 : 3;
818#else
819#error "Please fix <asm/byteorder.h>"
820#endif
821 __u8 n_first_track;
822 __u8 n_sessions_lsb;
823 __u8 first_track_lsb;
824 __u8 last_track_lsb;
825#if defined(__BIG_ENDIAN_BITFIELD)
826 __u8 did_v : 1;
827 __u8 dbc_v : 1;
828 __u8 uru : 1;
829 __u8 reserved2 : 2;
830 __u8 dbit : 1;
831 __u8 mrw_status : 2;
832#elif defined(__LITTLE_ENDIAN_BITFIELD)
833 __u8 mrw_status : 2;
834 __u8 dbit : 1;
835 __u8 reserved2 : 2;
836 __u8 uru : 1;
837 __u8 dbc_v : 1;
838 __u8 did_v : 1;
839#endif
840 __u8 disc_type;
841 __u8 n_sessions_msb;
842 __u8 first_track_msb;
843 __u8 last_track_msb;
844 __u32 disc_id;
845 __u32 lead_in;
846 __u32 lead_out;
847 __u8 disc_bar_code[8];
848 __u8 reserved3;
849 __u8 n_opc;
850} disc_information;
851
852typedef struct {
853 __u16 track_information_length;
854 __u8 track_lsb;
855 __u8 session_lsb;
856 __u8 reserved1;
857#if defined(__BIG_ENDIAN_BITFIELD)
858 __u8 reserved2 : 2;
859 __u8 damage : 1;
860 __u8 copy : 1;
861 __u8 track_mode : 4;
862 __u8 rt : 1;
863 __u8 blank : 1;
864 __u8 packet : 1;
865 __u8 fp : 1;
866 __u8 data_mode : 4;
867 __u8 reserved3 : 6;
868 __u8 lra_v : 1;
869 __u8 nwa_v : 1;
870#elif defined(__LITTLE_ENDIAN_BITFIELD)
871 __u8 track_mode : 4;
872 __u8 copy : 1;
873 __u8 damage : 1;
874 __u8 reserved2 : 2;
875 __u8 data_mode : 4;
876 __u8 fp : 1;
877 __u8 packet : 1;
878 __u8 blank : 1;
879 __u8 rt : 1;
880 __u8 nwa_v : 1;
881 __u8 lra_v : 1;
882 __u8 reserved3 : 6;
883#endif
884 __u32 track_start;
885 __u32 next_writable;
886 __u32 free_blocks;
887 __u32 fixed_packet_size;
888 __u32 track_size;
889 __u32 last_rec_address;
890} track_information;
891
892struct feature_header {
893 __u32 data_len;
894 __u8 reserved1;
895 __u8 reserved2;
896 __u16 curr_profile;
897};
898
899struct mode_page_header {
900 __u16 mode_data_length;
901 __u8 medium_type;
902 __u8 reserved1;
903 __u8 reserved2;
904 __u8 reserved3;
905 __u16 desc_length;
906};
907
908#ifdef __KERNEL__
909#include <linux/fs.h> /* not really needed, later.. */
910#include <linux/device.h>
911
912struct packet_command
913{
914 unsigned char cmd[CDROM_PACKET_SIZE];
915 unsigned char *buffer;
916 unsigned int buflen;
917 int stat;
918 struct request_sense *sense;
919 unsigned char data_direction;
920 int quiet;
921 int timeout;
922 void *reserved[1];
923};
924
925/*
926 * _OLD will use PIO transfer on atapi devices, _BPC_* will use DMA
927 */
928#define CDDA_OLD 0 /* old style */
929#define CDDA_BPC_SINGLE 1 /* single frame block pc */
930#define CDDA_BPC_FULL 2 /* multi frame block pc */
931
932/* Uniform cdrom data structures for cdrom.c */
933struct cdrom_device_info {
934 struct cdrom_device_ops *ops; /* link to device_ops */
935 struct cdrom_device_info *next; /* next device_info for this major */
936 struct gendisk *disk; /* matching block layer disk */
937 void *handle; /* driver-dependent data */
938/* specifications */
939 int mask; /* mask of capability: disables them */
940 int speed; /* maximum speed for reading data */
941 int capacity; /* number of discs in jukebox */
942/* device-related storage */
943 int options : 30; /* options flags */
944 unsigned mc_flags : 2; /* media change buffer flags */
945 int use_count; /* number of times device opened */
946 char name[20]; /* name of the device type */
947/* per-device flags */
948 __u8 sanyo_slot : 2; /* Sanyo 3 CD changer support */
949 __u8 reserved : 6; /* not used yet */
950 int cdda_method; /* see flags */
951 __u8 last_sense;
952 __u8 media_written; /* dirty flag, DVD+RW bookkeeping */
953 unsigned short mmc3_profile; /* current MMC3 profile */
954 int for_data;
955 int (*exit)(struct cdrom_device_info *);
956 int mrw_mode_page;
957};
958
959struct cdrom_device_ops {
960/* routines */
961 int (*open) (struct cdrom_device_info *, int);
962 void (*release) (struct cdrom_device_info *);
963 int (*drive_status) (struct cdrom_device_info *, int);
964 int (*media_changed) (struct cdrom_device_info *, int);
965 int (*tray_move) (struct cdrom_device_info *, int);
966 int (*lock_door) (struct cdrom_device_info *, int);
967 int (*select_speed) (struct cdrom_device_info *, int);
968 int (*select_disc) (struct cdrom_device_info *, int);
969 int (*get_last_session) (struct cdrom_device_info *,
970 struct cdrom_multisession *);
971 int (*get_mcn) (struct cdrom_device_info *,
972 struct cdrom_mcn *);
973 /* hard reset device */
974 int (*reset) (struct cdrom_device_info *);
975 /* play stuff */
976 int (*audio_ioctl) (struct cdrom_device_info *,unsigned int, void *);
977 /* dev-specific */
978 int (*dev_ioctl) (struct cdrom_device_info *,
979 unsigned int, unsigned long);
980/* driver specifications */
981 const int capability; /* capability flags */
982 int n_minors; /* number of active minor devices */
983 /* handle uniform packets for scsi type devices (scsi,atapi) */
984 int (*generic_packet) (struct cdrom_device_info *,
985 struct packet_command *);
986};
987
988/* the general block_device operations structure: */
989extern int cdrom_open(struct cdrom_device_info *cdi, struct inode *ip,
990 struct file *fp);
991extern int cdrom_release(struct cdrom_device_info *cdi, struct file *fp);
992extern int cdrom_ioctl(struct file *file, struct cdrom_device_info *cdi,
993 struct inode *ip, unsigned int cmd, unsigned long arg);
994extern int cdrom_media_changed(struct cdrom_device_info *);
995
996extern int register_cdrom(struct cdrom_device_info *cdi);
997extern int unregister_cdrom(struct cdrom_device_info *cdi);
998
999typedef struct {
1000 int data;
1001 int audio;
1002 int cdi;
1003 int xa;
1004 long error;
1005} tracktype;
1006
1007extern int cdrom_get_last_written(struct cdrom_device_info *cdi, long *last_written);
1008extern int cdrom_number_of_slots(struct cdrom_device_info *cdi);
1009extern int cdrom_mode_select(struct cdrom_device_info *cdi,
1010 struct packet_command *cgc);
1011extern int cdrom_mode_sense(struct cdrom_device_info *cdi,
1012 struct packet_command *cgc,
1013 int page_code, int page_control);
1014extern void init_cdrom_command(struct packet_command *cgc,
1015 void *buffer, int len, int type);
1016
1017/* The SCSI spec says there could be 256 slots. */
1018#define CDROM_MAX_SLOTS 256
1019
1020struct cdrom_mechstat_header {
1021#if defined(__BIG_ENDIAN_BITFIELD)
1022 __u8 fault : 1;
1023 __u8 changer_state : 2;
1024 __u8 curslot : 5;
1025 __u8 mech_state : 3;
1026 __u8 door_open : 1;
1027 __u8 reserved1 : 4;
1028#elif defined(__LITTLE_ENDIAN_BITFIELD)
1029 __u8 curslot : 5;
1030 __u8 changer_state : 2;
1031 __u8 fault : 1;
1032 __u8 reserved1 : 4;
1033 __u8 door_open : 1;
1034 __u8 mech_state : 3;
1035#endif
1036 __u8 curlba[3];
1037 __u8 nslots;
1038 __u16 slot_tablelen;
1039};
1040
1041struct cdrom_slot {
1042#if defined(__BIG_ENDIAN_BITFIELD)
1043 __u8 disc_present : 1;
1044 __u8 reserved1 : 6;
1045 __u8 change : 1;
1046#elif defined(__LITTLE_ENDIAN_BITFIELD)
1047 __u8 change : 1;
1048 __u8 reserved1 : 6;
1049 __u8 disc_present : 1;
1050#endif
1051 __u8 reserved2[3];
1052};
1053
1054struct cdrom_changer_info {
1055 struct cdrom_mechstat_header hdr;
1056 struct cdrom_slot slots[CDROM_MAX_SLOTS];
1057};
1058
1059typedef enum {
1060 mechtype_caddy = 0,
1061 mechtype_tray = 1,
1062 mechtype_popup = 2,
1063 mechtype_individual_changer = 4,
1064 mechtype_cartridge_changer = 5
1065} mechtype_t;
1066
1067typedef struct {
1068#if defined(__BIG_ENDIAN_BITFIELD)
1069 __u8 ps : 1;
1070 __u8 reserved1 : 1;
1071 __u8 page_code : 6;
1072 __u8 page_length;
1073 __u8 reserved2 : 1;
1074 __u8 bufe : 1;
1075 __u8 ls_v : 1;
1076 __u8 test_write : 1;
1077 __u8 write_type : 4;
1078 __u8 multi_session : 2; /* or border, DVD */
1079 __u8 fp : 1;
1080 __u8 copy : 1;
1081 __u8 track_mode : 4;
1082 __u8 reserved3 : 4;
1083 __u8 data_block_type : 4;
1084#elif defined(__LITTLE_ENDIAN_BITFIELD)
1085 __u8 page_code : 6;
1086 __u8 reserved1 : 1;
1087 __u8 ps : 1;
1088 __u8 page_length;
1089 __u8 write_type : 4;
1090 __u8 test_write : 1;
1091 __u8 ls_v : 1;
1092 __u8 bufe : 1;
1093 __u8 reserved2 : 1;
1094 __u8 track_mode : 4;
1095 __u8 copy : 1;
1096 __u8 fp : 1;
1097 __u8 multi_session : 2; /* or border, DVD */
1098 __u8 data_block_type : 4;
1099 __u8 reserved3 : 4;
1100#endif
1101 __u8 link_size;
1102 __u8 reserved4;
1103#if defined(__BIG_ENDIAN_BITFIELD)
1104 __u8 reserved5 : 2;
1105 __u8 app_code : 6;
1106#elif defined(__LITTLE_ENDIAN_BITFIELD)
1107 __u8 app_code : 6;
1108 __u8 reserved5 : 2;
1109#endif
1110 __u8 session_format;
1111 __u8 reserved6;
1112 __u32 packet_size;
1113 __u16 audio_pause;
1114 __u8 mcn[16];
1115 __u8 isrc[16];
1116 __u8 subhdr0;
1117 __u8 subhdr1;
1118 __u8 subhdr2;
1119 __u8 subhdr3;
1120} __attribute__((packed)) write_param_page;
1121
1122struct modesel_head
1123{
1124 __u8 reserved1;
1125 __u8 medium;
1126 __u8 reserved2;
1127 __u8 block_desc_length;
1128 __u8 density;
1129 __u8 number_of_blocks_hi;
1130 __u8 number_of_blocks_med;
1131 __u8 number_of_blocks_lo;
1132 __u8 reserved3;
1133 __u8 block_length_hi;
1134 __u8 block_length_med;
1135 __u8 block_length_lo;
1136};
1137
1138typedef struct {
1139 __u16 report_key_length;
1140 __u8 reserved1;
1141 __u8 reserved2;
1142#if defined(__BIG_ENDIAN_BITFIELD)
1143 __u8 type_code : 2;
1144 __u8 vra : 3;
1145 __u8 ucca : 3;
1146#elif defined(__LITTLE_ENDIAN_BITFIELD)
1147 __u8 ucca : 3;
1148 __u8 vra : 3;
1149 __u8 type_code : 2;
1150#endif
1151 __u8 region_mask;
1152 __u8 rpc_scheme;
1153 __u8 reserved3;
1154} rpc_state_t;
1155
1156struct event_header {
1157 __u16 data_len;
1158#if defined(__BIG_ENDIAN_BITFIELD)
1159 __u8 nea : 1;
1160 __u8 reserved1 : 4;
1161 __u8 notification_class : 3;
1162#elif defined(__LITTLE_ENDIAN_BITFIELD)
1163 __u8 notification_class : 3;
1164 __u8 reserved1 : 4;
1165 __u8 nea : 1;
1166#endif
1167 __u8 supp_event_class;
1168};
1169
1170struct media_event_desc {
1171#if defined(__BIG_ENDIAN_BITFIELD)
1172 __u8 reserved1 : 4;
1173 __u8 media_event_code : 4;
1174 __u8 reserved2 : 6;
1175 __u8 media_present : 1;
1176 __u8 door_open : 1;
1177#elif defined(__LITTLE_ENDIAN_BITFIELD)
1178 __u8 media_event_code : 4;
1179 __u8 reserved1 : 4;
1180 __u8 door_open : 1;
1181 __u8 media_present : 1;
1182 __u8 reserved2 : 6;
1183#endif
1184 __u8 start_slot;
1185 __u8 end_slot;
1186};
1187
1188extern int cdrom_get_media_event(struct cdrom_device_info *cdi, struct media_event_desc *med);
1189
1190#endif /* End of kernel only stuff */
1191
1192#endif /* _LINUX_CDROM_H */