xref: /linux/include/linux/cdrom.h (revision 7aacf86b75bc5523d20fd9127104384fce51ce9c)
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 Mönkeberg, 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 #ifndef	_LINUX_CDROM_H
11 #define	_LINUX_CDROM_H
12 
13 #include <linux/fs.h>		/* not really needed, later.. */
14 #include <linux/list.h>
15 #include <uapi/linux/cdrom.h>
16 
17 struct packet_command
18 {
19 	unsigned char 		cmd[CDROM_PACKET_SIZE];
20 	unsigned char 		*buffer;
21 	unsigned int 		buflen;
22 	int			stat;
23 	struct request_sense	*sense;
24 	unsigned char		data_direction;
25 	int			quiet;
26 	int			timeout;
27 	void			*reserved[1];
28 };
29 
30 /*
31  * _OLD will use PIO transfer on atapi devices, _BPC_* will use DMA
32  */
33 #define CDDA_OLD		0	/* old style */
34 #define CDDA_BPC_SINGLE		1	/* single frame block pc */
35 #define CDDA_BPC_FULL		2	/* multi frame block pc */
36 
37 /* Uniform cdrom data structures for cdrom.c */
38 struct cdrom_device_info {
39 	const struct cdrom_device_ops *ops; /* link to device_ops */
40 	struct list_head list;		/* linked list of all device_info */
41 	struct gendisk *disk;		/* matching block layer disk */
42 	void *handle;		        /* driver-dependent data */
43 /* specifications */
44 	int mask;                       /* mask of capability: disables them */
45 	int speed;			/* maximum speed for reading data */
46 	int capacity;			/* number of discs in jukebox */
47 /* device-related storage */
48 	unsigned int options	: 30;	/* options flags */
49 	unsigned mc_flags	: 2;	/* media change buffer flags */
50 	unsigned int vfs_events;	/* cached events for vfs path */
51 	unsigned int ioctl_events;	/* cached events for ioctl path */
52     	int use_count;                  /* number of times device opened */
53     	char name[20];                  /* name of the device type */
54 /* per-device flags */
55         __u8 sanyo_slot		: 2;	/* Sanyo 3 CD changer support */
56         __u8 keeplocked		: 1;	/* CDROM_LOCKDOOR status */
57         __u8 reserved		: 5;	/* not used yet */
58 	int cdda_method;		/* see flags */
59 	__u8 last_sense;
60 	__u8 media_written;		/* dirty flag, DVD+RW bookkeeping */
61 	unsigned short mmc3_profile;	/* current MMC3 profile */
62 	int for_data;
63 	int (*exit)(struct cdrom_device_info *);
64 	int mrw_mode_page;
65 };
66 
67 struct cdrom_device_ops {
68 /* routines */
69 	int (*open) (struct cdrom_device_info *, int);
70 	void (*release) (struct cdrom_device_info *);
71 	int (*drive_status) (struct cdrom_device_info *, int);
72 	unsigned int (*check_events) (struct cdrom_device_info *cdi,
73 				      unsigned int clearing, int slot);
74 	int (*media_changed) (struct cdrom_device_info *, int);
75 	int (*tray_move) (struct cdrom_device_info *, int);
76 	int (*lock_door) (struct cdrom_device_info *, int);
77 	int (*select_speed) (struct cdrom_device_info *, int);
78 	int (*select_disc) (struct cdrom_device_info *, int);
79 	int (*get_last_session) (struct cdrom_device_info *,
80 				 struct cdrom_multisession *);
81 	int (*get_mcn) (struct cdrom_device_info *,
82 			struct cdrom_mcn *);
83 	/* hard reset device */
84 	int (*reset) (struct cdrom_device_info *);
85 	/* play stuff */
86 	int (*audio_ioctl) (struct cdrom_device_info *,unsigned int, void *);
87 
88 /* driver specifications */
89 	const int capability;   /* capability flags */
90 	/* handle uniform packets for scsi type devices (scsi,atapi) */
91 	int (*generic_packet) (struct cdrom_device_info *,
92 			       struct packet_command *);
93 };
94 
95 /* the general block_device operations structure: */
96 extern int cdrom_open(struct cdrom_device_info *cdi, struct block_device *bdev,
97 			fmode_t mode);
98 extern void cdrom_release(struct cdrom_device_info *cdi, fmode_t mode);
99 extern int cdrom_ioctl(struct cdrom_device_info *cdi, struct block_device *bdev,
100 		       fmode_t mode, unsigned int cmd, unsigned long arg);
101 extern unsigned int cdrom_check_events(struct cdrom_device_info *cdi,
102 				       unsigned int clearing);
103 extern int cdrom_media_changed(struct cdrom_device_info *);
104 
105 extern int register_cdrom(struct cdrom_device_info *cdi);
106 extern void unregister_cdrom(struct cdrom_device_info *cdi);
107 
108 typedef struct {
109     int data;
110     int audio;
111     int cdi;
112     int xa;
113     long error;
114 } tracktype;
115 
116 extern int cdrom_get_last_written(struct cdrom_device_info *cdi, long *last_written);
117 extern int cdrom_number_of_slots(struct cdrom_device_info *cdi);
118 extern int cdrom_mode_select(struct cdrom_device_info *cdi,
119 			     struct packet_command *cgc);
120 extern int cdrom_mode_sense(struct cdrom_device_info *cdi,
121 			    struct packet_command *cgc,
122 			    int page_code, int page_control);
123 extern void init_cdrom_command(struct packet_command *cgc,
124 			       void *buffer, int len, int type);
125 extern int cdrom_dummy_generic_packet(struct cdrom_device_info *cdi,
126 				      struct packet_command *cgc);
127 
128 /* The SCSI spec says there could be 256 slots. */
129 #define CDROM_MAX_SLOTS	256
130 
131 struct cdrom_mechstat_header {
132 #if defined(__BIG_ENDIAN_BITFIELD)
133 	__u8 fault         : 1;
134 	__u8 changer_state : 2;
135 	__u8 curslot       : 5;
136 	__u8 mech_state    : 3;
137 	__u8 door_open     : 1;
138 	__u8 reserved1     : 4;
139 #elif defined(__LITTLE_ENDIAN_BITFIELD)
140 	__u8 curslot       : 5;
141 	__u8 changer_state : 2;
142 	__u8 fault         : 1;
143 	__u8 reserved1     : 4;
144 	__u8 door_open     : 1;
145 	__u8 mech_state    : 3;
146 #endif
147 	__u8     curlba[3];
148 	__u8     nslots;
149 	__u16 slot_tablelen;
150 };
151 
152 struct cdrom_slot {
153 #if defined(__BIG_ENDIAN_BITFIELD)
154 	__u8 disc_present : 1;
155 	__u8 reserved1    : 6;
156 	__u8 change       : 1;
157 #elif defined(__LITTLE_ENDIAN_BITFIELD)
158 	__u8 change       : 1;
159 	__u8 reserved1    : 6;
160 	__u8 disc_present : 1;
161 #endif
162 	__u8 reserved2[3];
163 };
164 
165 struct cdrom_changer_info {
166 	struct cdrom_mechstat_header hdr;
167 	struct cdrom_slot slots[CDROM_MAX_SLOTS];
168 };
169 
170 typedef enum {
171 	mechtype_caddy = 0,
172 	mechtype_tray  = 1,
173 	mechtype_popup = 2,
174 	mechtype_individual_changer = 4,
175 	mechtype_cartridge_changer  = 5
176 } mechtype_t;
177 
178 typedef struct {
179 #if defined(__BIG_ENDIAN_BITFIELD)
180 	__u8 ps			: 1;
181 	__u8 reserved1		: 1;
182 	__u8 page_code		: 6;
183         __u8 page_length;
184 	__u8 reserved2		: 1;
185 	__u8 bufe		: 1;
186 	__u8 ls_v		: 1;
187 	__u8 test_write		: 1;
188         __u8 write_type		: 4;
189 	__u8 multi_session	: 2; /* or border, DVD */
190 	__u8 fp			: 1;
191 	__u8 copy		: 1;
192 	__u8 track_mode		: 4;
193 	__u8 reserved3		: 4;
194 	__u8 data_block_type	: 4;
195 #elif defined(__LITTLE_ENDIAN_BITFIELD)
196 	__u8 page_code		: 6;
197 	__u8 reserved1		: 1;
198 	__u8 ps			: 1;
199         __u8 page_length;
200         __u8 write_type		: 4;
201 	__u8 test_write		: 1;
202 	__u8 ls_v		: 1;
203 	__u8 bufe		: 1;
204 	__u8 reserved2		: 1;
205 	__u8 track_mode		: 4;
206 	__u8 copy		: 1;
207 	__u8 fp			: 1;
208 	__u8 multi_session	: 2; /* or border, DVD */
209 	__u8 data_block_type	: 4;
210 	__u8 reserved3		: 4;
211 #endif
212 	__u8 link_size;
213 	__u8 reserved4;
214 #if defined(__BIG_ENDIAN_BITFIELD)
215 	__u8 reserved5		: 2;
216 	__u8 app_code		: 6;
217 #elif defined(__LITTLE_ENDIAN_BITFIELD)
218 	__u8 app_code		: 6;
219 	__u8 reserved5		: 2;
220 #endif
221 	__u8 session_format;
222 	__u8 reserved6;
223 	__be32 packet_size;
224 	__u16 audio_pause;
225 	__u8 mcn[16];
226 	__u8 isrc[16];
227 	__u8 subhdr0;
228 	__u8 subhdr1;
229 	__u8 subhdr2;
230 	__u8 subhdr3;
231 } __attribute__((packed)) write_param_page;
232 
233 struct modesel_head
234 {
235 	__u8	reserved1;
236 	__u8	medium;
237 	__u8	reserved2;
238 	__u8	block_desc_length;
239 	__u8	density;
240 	__u8	number_of_blocks_hi;
241 	__u8	number_of_blocks_med;
242 	__u8	number_of_blocks_lo;
243 	__u8	reserved3;
244 	__u8	block_length_hi;
245 	__u8	block_length_med;
246 	__u8	block_length_lo;
247 };
248 
249 typedef struct {
250 	__u16 report_key_length;
251 	__u8 reserved1;
252 	__u8 reserved2;
253 #if defined(__BIG_ENDIAN_BITFIELD)
254 	__u8 type_code			: 2;
255 	__u8 vra			: 3;
256 	__u8 ucca			: 3;
257 #elif defined(__LITTLE_ENDIAN_BITFIELD)
258 	__u8 ucca			: 3;
259 	__u8 vra			: 3;
260 	__u8 type_code			: 2;
261 #endif
262 	__u8 region_mask;
263 	__u8 rpc_scheme;
264 	__u8 reserved3;
265 } rpc_state_t;
266 
267 struct event_header {
268 	__be16 data_len;
269 #if defined(__BIG_ENDIAN_BITFIELD)
270 	__u8 nea		: 1;
271 	__u8 reserved1		: 4;
272 	__u8 notification_class	: 3;
273 #elif defined(__LITTLE_ENDIAN_BITFIELD)
274 	__u8 notification_class	: 3;
275 	__u8 reserved1		: 4;
276 	__u8 nea		: 1;
277 #endif
278 	__u8 supp_event_class;
279 };
280 
281 struct media_event_desc {
282 #if defined(__BIG_ENDIAN_BITFIELD)
283 	__u8 reserved1		: 4;
284 	__u8 media_event_code	: 4;
285 	__u8 reserved2		: 6;
286 	__u8 media_present	: 1;
287 	__u8 door_open		: 1;
288 #elif defined(__LITTLE_ENDIAN_BITFIELD)
289 	__u8 media_event_code	: 4;
290 	__u8 reserved1		: 4;
291 	__u8 door_open		: 1;
292 	__u8 media_present	: 1;
293 	__u8 reserved2		: 6;
294 #endif
295 	__u8 start_slot;
296 	__u8 end_slot;
297 };
298 
299 extern int cdrom_get_media_event(struct cdrom_device_info *cdi, struct media_event_desc *med);
300 
301 static inline void lba_to_msf(int lba, u8 *m, u8 *s, u8 *f)
302 {
303 	lba += CD_MSF_OFFSET;
304 	lba &= 0xffffff;  /* negative lbas use only 24 bits */
305 	*m = lba / (CD_SECS * CD_FRAMES);
306 	lba %= (CD_SECS * CD_FRAMES);
307 	*s = lba / CD_FRAMES;
308 	*f = lba % CD_FRAMES;
309 }
310 
311 static inline int msf_to_lba(u8 m, u8 s, u8 f)
312 {
313 	return (((m * CD_SECS) + s) * CD_FRAMES + f) - CD_MSF_OFFSET;
314 }
315 #endif  /* _LINUX_CDROM_H */
316