userspace-api/ioctl/cdrom.rst

2 Summary of CDROM ioctl calls
9 This document attempts to describe the ioctl(2) calls supported by
13 ioctl values are listed in <linux/cdrom.h>.  As of this writing, they
80 	Unless otherwise specified, all ioctl calls return 0 on success
84 	Unless otherwise specified, all ioctl calls return -1 and set
102 	  ioctl(fd, CDROMPAUSE, 0);
123 	  ioctl(fd, CDROMRESUME, 0);
148 	  ioctl(fd, CDROMPLAYMSF, &msf);
179 	  ioctl(fd, CDROMPLAYTRKIND, &ti);
208 	  ioctl(fd, CDROMREADTOCHDR, &header);
233 	  ioctl(fd, CDROMREADTOCENTRY, &entry);
262 	  ioctl(fd, CDROMSTOP, 0);
277 	  - Exact interpretation of this ioctl depends on the device,
287 	  ioctl(fd, CDROMSTART, 0);
302 	  - Exact interpretation of this ioctl depends on the device,
304 	    Other devices ignore the ioctl completely.
313 	  ioctl(fd, CDROMEJECT, 0);
340 	  ioctl(fd, CDROMCLOSETRAY, 0);
369 	  ioctl(fd, CDROMVOLCTRL, &volume);
394 	  ioctl(fd, CDROMVOLREAD, &volume);
419 	  ioctl(fd, CDROMSUBCHNL, &q);
451 	  ioctl(fd, CDROMREADRAW, &arg);
468 		  ioctl accepts a cdrom_read structure, but actual source code
508 	  ioctl(fd, CDROMREADAUDIO, &ra);
533 	  ioctl(fd, CDROMEJECT_SW, val);
559 	  ioctl(fd, CDROMMULTISESSION, &ms_info);
585 	  ioctl(fd, CDROM_GET_MCN, &mcn);
624 	  ioctl(fd, CDROMRESET, 0);
650 	  ioctl(fd, CDROMREADCOOKED, buffer);
683 	  ioctl(fd, CDROMSEEK, &msf);
705 	  ioctl(fd, CDROMPLAYBLK, &blk);
722 	  ioctl(fd, CDROMGETSPINDOWN, &spindown);
740 	  ioctl(fd, CDROMSETSPINDOWN, &spindown);
762 	  ioctl(fd, CDROM_SET_OPTIONS, options);
777 		ioctl return value.  Returns -1 on error.
802 	  ioctl(fd, CDROM_SELECT_SPEED, speed);
825 	  ioctl(fd, CDROM_SELECT_DISC, disk);
848 	  ioctl(fd, CDROM_MEDIA_CHANGED, slot);
856 		Ioctl return value is 0 or 1 depending on whether the media
875 	  ioctl(fd, CDROM_DRIVE_STATUS, slot);
883 		Ioctl return value will be one of the following values
910 	  ioctl(fd, CDROM_DISC_STATUS, 0);
918 		Ioctl return value will be one of the following values
937 		the CDROM_DISC_STATUS ioctl is flawed.  It makes the false
951 		User level programmers might feel the ioctl is not very
964 	  ioctl(fd, CDROM_CHANGER_NSLOTS, 0);
972 		The ioctl return value will be the number of slots in a
988 	  ioctl(fd, CDROM_LOCKDOOR, lock);
1025 	  ioctl(fd, CDROM_DEBUG, debug);
1032 		The ioctl return value will be the new debug flag.
1046 	  ioctl(fd, CDROM_GET_CAPABILITY, 0);
1054 		The ioctl return value is the current device capability
1067 	  ioctl(fd, CDROMAUDIOBUFSIZ, val);
1074 		The ioctl return value is the new audio buffer size, or -1
1092 	  ioctl(fd, DVD_READ_STRUCT, &s);
1136 	  ioctl(fd, DVD_AUTH, &ai);
1159 	  ioctl(fd, CDROM_SEND_PACKET, &cgc);
1194 	  ioctl(fd, CDROM_NEXT_WRITABLE, &next);
1205 		If the device does not support this ioctl directly, the
1207 	  ioctl will return CDROM_LAST_WRITTEN + 7.
1219 	  ioctl(fd, CDROM_LAST_WRITTEN, &last);
1230 		If the device does not support this ioctl directly, the
1232 		table of contents can't be read, this ioctl returns an