[mirror_ubuntu-bionic-kernel.git] / drivers / ide / ide-cd.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  Copyright (C) 1996-98  Erik Andersen
 *  Copyright (C) 1998-2000 Jens Axboe
 */
#ifndef _IDE_CD_H
#define _IDE_CD_H

#include <linux/cdrom.h>
#include <asm/byteorder.h>

#define IDECD_DEBUG_LOG		0

#if IDECD_DEBUG_LOG
#define ide_debug_log(lvl, fmt, args...) __ide_debug_log(lvl, fmt, ## args)
#else
#define ide_debug_log(lvl, fmt, args...) do {} while (0)
#endif

#define ATAPI_WAIT_WRITE_BUSY	(10 * HZ)

/************************************************************************/

#define SECTOR_BITS 		9
#ifndef SECTOR_SIZE
#define SECTOR_SIZE		(1 << SECTOR_BITS)
#endif
#define SECTORS_PER_FRAME	(CD_FRAMESIZE >> SECTOR_BITS)
#define SECTOR_BUFFER_SIZE	(CD_FRAMESIZE * 32)

/* Capabilities Page size including 8 bytes of Mode Page Header */
#define ATAPI_CAPABILITIES_PAGE_SIZE		(8 + 20)
#define ATAPI_CAPABILITIES_PAGE_PAD_SIZE	4

/* Structure of a MSF cdrom address. */
struct atapi_msf {
	u8 reserved;
	u8 minute;
	u8 second;
	u8 frame;
};

/* Space to hold the disk TOC. */
#define MAX_TRACKS 99
struct atapi_toc_header {
	unsigned short toc_length;
	u8 first_track;
	u8 last_track;
};

struct atapi_toc_entry {
	u8 reserved1;
#if defined(__BIG_ENDIAN_BITFIELD)
	u8 adr     : 4;
	u8 control : 4;
#elif defined(__LITTLE_ENDIAN_BITFIELD)
	u8 control : 4;
	u8 adr     : 4;
#else
#error "Please fix <asm/byteorder.h>"
#endif
	u8 track;
	u8 reserved2;
	union {
		unsigned lba;
		struct atapi_msf msf;
	} addr;
};

struct atapi_toc {
	int    last_session_lba;
	int    xa_flag;
	unsigned long capacity;
	struct atapi_toc_header hdr;
	struct atapi_toc_entry  ent[MAX_TRACKS+1];
	  /* One extra for the leadout. */
};

/* Extra per-device info for cdrom drives. */
struct cdrom_info {
	ide_drive_t		*drive;
	struct ide_driver	*driver;
	struct gendisk		*disk;
	struct device		dev;

	/* Buffer for table of contents.  NULL if we haven't allocated
	   a TOC buffer for this device yet. */

	struct atapi_toc *toc;

	u8 max_speed;		/* Max speed of the drive. */
	u8 current_speed;	/* Current speed of the drive. */

        /* Per-device info needed by cdrom.c generic driver. */
        struct cdrom_device_info devinfo;

	unsigned long write_timeout;
};

/* ide-cd_verbose.c */
void ide_cd_log_error(const char *, struct request *, struct request_sense *);

/* ide-cd.c functions used by ide-cd_ioctl.c */
int ide_cd_queue_pc(ide_drive_t *, const unsigned char *, int, void *,
		    unsigned *, struct request_sense *, int, req_flags_t);
int ide_cd_read_toc(ide_drive_t *, struct request_sense *);
int ide_cdrom_get_capabilities(ide_drive_t *, u8 *);
void ide_cdrom_update_speed(ide_drive_t *, u8 *);
int cdrom_check_status(ide_drive_t *, struct request_sense *);

/* ide-cd_ioctl.c */
int ide_cdrom_open_real(struct cdrom_device_info *, int);
void ide_cdrom_release_real(struct cdrom_device_info *);
int ide_cdrom_drive_status(struct cdrom_device_info *, int);
unsigned int ide_cdrom_check_events_real(struct cdrom_device_info *,
					 unsigned int clearing, int slot_nr);
int ide_cdrom_tray_move(struct cdrom_device_info *, int);
int ide_cdrom_lock_door(struct cdrom_device_info *, int);
int ide_cdrom_select_speed(struct cdrom_device_info *, int);
int ide_cdrom_get_last_session(struct cdrom_device_info *,
			       struct cdrom_multisession *);
int ide_cdrom_get_mcn(struct cdrom_device_info *, struct cdrom_mcn *);
int ide_cdrom_reset(struct cdrom_device_info *cdi);
int ide_cdrom_audio_ioctl(struct cdrom_device_info *, unsigned int, void *);
int ide_cdrom_packet(struct cdrom_device_info *, struct packet_command *);

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