[mirror_ubuntu-bionic-kernel.git] / drivers / scsi / sr.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *      sr.h by David Giller
 *      CD-ROM disk driver header file
 *      
 *      adapted from:
 *      sd.h Copyright (C) 1992 Drew Eckhardt 
 *      SCSI disk driver header file by
 *              Drew Eckhardt 
 *
 *      <drew@colorado.edu>
 *
 *       Modified by Eric Youngdale eric@andante.org to
 *       add scatter-gather, multiple outstanding request, and other
 *       enhancements.
 */

#ifndef _SR_H
#define _SR_H

#include <linux/genhd.h>
#include <linux/kref.h>

#define MAX_RETRIES	3
#define SR_TIMEOUT	(30 * HZ)

struct scsi_device;

/* The CDROM is fairly slow, so we need a little extra time */
/* In fact, it is very slow if it has to spin up first */
#define IOCTL_TIMEOUT 30*HZ


typedef struct scsi_cd {
	struct scsi_driver *driver;
	unsigned capacity;	/* size in blocks                       */
	struct scsi_device *device;
	unsigned int vendor;	/* vendor code, see sr_vendor.c         */
	unsigned long ms_offset;	/* for reading multisession-CD's        */
	unsigned writeable : 1;
	unsigned use:1;		/* is this device still supportable     */
	unsigned xa_flag:1;	/* CD has XA sectors ? */
	unsigned readcd_known:1;	/* drive supports READ_CD (0xbe) */
	unsigned readcd_cdda:1;	/* reading audio data using READ_CD */
	unsigned media_present:1;	/* media is present */

	/* GET_EVENT spurious event handling, blk layer guarantees exclusion */
	int tur_mismatch;		/* nr of get_event TUR mismatches */
	bool tur_changed:1;		/* changed according to TUR */
	bool get_event_changed:1;	/* changed according to GET_EVENT */
	bool ignore_get_event:1;	/* GET_EVENT is unreliable, use TUR */

	struct cdrom_device_info cdi;
	/* We hold gendisk and scsi_device references on probe and use
	 * the refs on this kref to decide when to release them */
	struct kref kref;
	struct gendisk *disk;
} Scsi_CD;

#define sr_printk(prefix, cd, fmt, a...) \
	sdev_prefix_printk(prefix, (cd)->device, (cd)->cdi.name, fmt, ##a)

int sr_do_ioctl(Scsi_CD *, struct packet_command *);

int sr_lock_door(struct cdrom_device_info *, int);
int sr_tray_move(struct cdrom_device_info *, int);
int sr_drive_status(struct cdrom_device_info *, int);
int sr_disk_status(struct cdrom_device_info *);
int sr_get_last_session(struct cdrom_device_info *, struct cdrom_multisession *);
int sr_get_mcn(struct cdrom_device_info *, struct cdrom_mcn *);
int sr_reset(struct cdrom_device_info *);
int sr_select_speed(struct cdrom_device_info *cdi, int speed);
int sr_audio_ioctl(struct cdrom_device_info *, unsigned int, void *);

int sr_is_xa(Scsi_CD *);

/* sr_vendor.c */
void sr_vendor_init(Scsi_CD *);
int sr_cd_check(struct cdrom_device_info *);
int sr_set_blocklength(Scsi_CD *, int blocklength);

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* sr.h by David Giller
	4	* CD-ROM disk driver header file
	5	*
	6	* adapted from:
	7	* sd.h Copyright (C) 1992 Drew Eckhardt
	8	* SCSI disk driver header file by
	9	* Drew Eckhardt
	10	*
	11	* <drew@colorado.edu>
	12	*
	13	* Modified by Eric Youngdale eric@andante.org to
	14	* add scatter-gather, multiple outstanding request, and other
	15	* enhancements.
	16	*/
	17
	18	#ifndef _SR_H
	19	#define _SR_H
	20
	21	#include <linux/genhd.h>
	22	#include <linux/kref.h>
	23
210ba1d1 JB	24	#define MAX_RETRIES 3
	25	#define SR_TIMEOUT (30 * HZ)
	26
1da177e4 LT	27	struct scsi_device;
	28
	29	/* The CDROM is fairly slow, so we need a little extra time */
	30	/* In fact, it is very slow if it has to spin up first */
	31	#define IOCTL_TIMEOUT 30*HZ
	32
	33
	34	typedef struct scsi_cd {
	35	struct scsi_driver *driver;
	36	unsigned capacity; /* size in blocks */
	37	struct scsi_device *device;
	38	unsigned int vendor; /* vendor code, see sr_vendor.c */
	39	unsigned long ms_offset; /* for reading multisession-CD's */
fd2eb903	40	unsigned writeable : 1;
1da177e4 LT	41	unsigned use:1; /* is this device still supportable */
	42	unsigned xa_flag:1; /* CD has XA sectors ? */
	43	unsigned readcd_known:1; /* drive supports READ_CD (0xbe) */
	44	unsigned readcd_cdda:1; /* reading audio data using READ_CD */
93aae17a	45	unsigned media_present:1; /* media is present */
79b9677d KS	46
	47	/* GET_EVENT spurious event handling, blk layer guarantees exclusion */
	48	int tur_mismatch; /* nr of get_event TUR mismatches */
	49	bool tur_changed:1; /* changed according to TUR */
	50	bool get_event_changed:1; /* changed according to GET_EVENT */
	51	bool ignore_get_event:1; /* GET_EVENT is unreliable, use TUR */
	52
1da177e4 LT	53	struct cdrom_device_info cdi;
	54	/* We hold gendisk and scsi_device references on probe and use
	55	* the refs on this kref to decide when to release them */
	56	struct kref kref;
	57	struct gendisk *disk;
	58	} Scsi_CD;
	59
96eefad2	60	#define sr_printk(prefix, cd, fmt, a...) \
22e0d994	61	sdev_prefix_printk(prefix, (cd)->device, (cd)->cdi.name, fmt, ##a)
96eefad2	62
1da177e4 LT	63	int sr_do_ioctl(Scsi_CD , struct packet_command );
	64
	65	int sr_lock_door(struct cdrom_device_info *, int);
	66	int sr_tray_move(struct cdrom_device_info *, int);
	67	int sr_drive_status(struct cdrom_device_info *, int);
	68	int sr_disk_status(struct cdrom_device_info *);
	69	int sr_get_last_session(struct cdrom_device_info , struct cdrom_multisession );
	70	int sr_get_mcn(struct cdrom_device_info , struct cdrom_mcn );
	71	int sr_reset(struct cdrom_device_info *);
	72	int sr_select_speed(struct cdrom_device_info *cdi, int speed);
	73	int sr_audio_ioctl(struct cdrom_device_info , unsigned int, void );
1da177e4 LT	74
	75	int sr_is_xa(Scsi_CD *);
	76
	77	/* sr_vendor.c */
	78	void sr_vendor_init(Scsi_CD *);
	79	int sr_cd_check(struct cdrom_device_info *);
	80	int sr_set_blocklength(Scsi_CD *, int blocklength);
	81
	82	#endif