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