GNU Linux-libre 4.4.288-gnu1
[releases.git] / drivers / ide / ide-cd.h
1 /*
2  *  Copyright (C) 1996-98  Erik Andersen
3  *  Copyright (C) 1998-2000 Jens Axboe
4  */
5 #ifndef _IDE_CD_H
6 #define _IDE_CD_H
7
8 #include <linux/cdrom.h>
9 #include <asm/byteorder.h>
10
11 #define IDECD_DEBUG_LOG         0
12
13 #if IDECD_DEBUG_LOG
14 #define ide_debug_log(lvl, fmt, args...) __ide_debug_log(lvl, fmt, ## args)
15 #else
16 #define ide_debug_log(lvl, fmt, args...) do {} while (0)
17 #endif
18
19 #define ATAPI_WAIT_WRITE_BUSY   (10 * HZ)
20
21 /************************************************************************/
22
23 #define SECTORS_PER_FRAME       (CD_FRAMESIZE >> SECTOR_SHIFT)
24 #define SECTOR_BUFFER_SIZE      (CD_FRAMESIZE * 32)
25
26 /* Capabilities Page size including 8 bytes of Mode Page Header */
27 #define ATAPI_CAPABILITIES_PAGE_SIZE            (8 + 20)
28 #define ATAPI_CAPABILITIES_PAGE_PAD_SIZE        4
29
30 /* Structure of a MSF cdrom address. */
31 struct atapi_msf {
32         u8 reserved;
33         u8 minute;
34         u8 second;
35         u8 frame;
36 };
37
38 /* Space to hold the disk TOC. */
39 #define MAX_TRACKS 99
40 struct atapi_toc_header {
41         unsigned short toc_length;
42         u8 first_track;
43         u8 last_track;
44 };
45
46 struct atapi_toc_entry {
47         u8 reserved1;
48 #if defined(__BIG_ENDIAN_BITFIELD)
49         u8 adr     : 4;
50         u8 control : 4;
51 #elif defined(__LITTLE_ENDIAN_BITFIELD)
52         u8 control : 4;
53         u8 adr     : 4;
54 #else
55 #error "Please fix <asm/byteorder.h>"
56 #endif
57         u8 track;
58         u8 reserved2;
59         union {
60                 unsigned lba;
61                 struct atapi_msf msf;
62         } addr;
63 };
64
65 struct atapi_toc {
66         int    last_session_lba;
67         int    xa_flag;
68         unsigned long capacity;
69         struct atapi_toc_header hdr;
70         struct atapi_toc_entry  ent[MAX_TRACKS+1];
71           /* One extra for the leadout. */
72 };
73
74 /* Extra per-device info for cdrom drives. */
75 struct cdrom_info {
76         ide_drive_t             *drive;
77         struct ide_driver       *driver;
78         struct gendisk          *disk;
79         struct device           dev;
80
81         /* Buffer for table of contents.  NULL if we haven't allocated
82            a TOC buffer for this device yet. */
83
84         struct atapi_toc *toc;
85
86         u8 max_speed;           /* Max speed of the drive. */
87         u8 current_speed;       /* Current speed of the drive. */
88
89         /* Per-device info needed by cdrom.c generic driver. */
90         struct cdrom_device_info devinfo;
91
92         unsigned long write_timeout;
93 };
94
95 /* ide-cd_verbose.c */
96 void ide_cd_log_error(const char *, struct request *, struct request_sense *);
97
98 /* ide-cd.c functions used by ide-cd_ioctl.c */
99 int ide_cd_queue_pc(ide_drive_t *, const unsigned char *, int, void *,
100                     unsigned *, struct request_sense *, int, unsigned int);
101 int ide_cd_read_toc(ide_drive_t *, struct request_sense *);
102 int ide_cdrom_get_capabilities(ide_drive_t *, u8 *);
103 void ide_cdrom_update_speed(ide_drive_t *, u8 *);
104 int cdrom_check_status(ide_drive_t *, struct request_sense *);
105
106 /* ide-cd_ioctl.c */
107 int ide_cdrom_open_real(struct cdrom_device_info *, int);
108 void ide_cdrom_release_real(struct cdrom_device_info *);
109 int ide_cdrom_drive_status(struct cdrom_device_info *, int);
110 unsigned int ide_cdrom_check_events_real(struct cdrom_device_info *,
111                                          unsigned int clearing, int slot_nr);
112 int ide_cdrom_tray_move(struct cdrom_device_info *, int);
113 int ide_cdrom_lock_door(struct cdrom_device_info *, int);
114 int ide_cdrom_select_speed(struct cdrom_device_info *, int);
115 int ide_cdrom_get_last_session(struct cdrom_device_info *,
116                                struct cdrom_multisession *);
117 int ide_cdrom_get_mcn(struct cdrom_device_info *, struct cdrom_mcn *);
118 int ide_cdrom_reset(struct cdrom_device_info *cdi);
119 int ide_cdrom_audio_ioctl(struct cdrom_device_info *, unsigned int, void *);
120 int ide_cdrom_packet(struct cdrom_device_info *, struct packet_command *);
121
122 #endif /* _IDE_CD_H */