xref: /src/sys/dev/scsipi/scsi_all.h

/*
 * SCSI general  interface description
 */

/*
 * Largely written by Julian Elischer (julian (at) tfs.com)
 * for TRW Financial Systems.
 *
 * TRW Financial Systems, in accordance with their agreement with Carnegie
 * Mellon University, makes this software available to CMU to distribute
 * or use in any manner that they see fit as long as this message is kept with
 * the software. For this reason TFS also grants any other persons or
 * organisations permission to use or modify this software.
 *
 * TFS supplies this software to be publicly redistributed
 * on the understanding that TFS is not responsible for the correct
 * functioning of this software in any circumstances.
 *
 * Ported to run under 386BSD by Julian Elischer (julian (at) tfs.com) Sept 1992
 *
 *	$Id: scsi_all.h,v 1.4 1994/05/09 07:40:50 chopps Exp $
 */

#ifndef	_SCSI_SCSI_ALL_H
#define _SCSI_SCSI_ALL_H 1
/*
 * SCSI command format
 */

/*
 * Define dome bits that are in ALL (or a lot of) scsi commands
 */
#define SCSI_CTL_LINK		0x01
#define SCSI_CTL_FLAG		0x02
#define SCSI_CTL_VENDOR		0xC0
#define	SCSI_CMD_LUN		0xA0	/* these two should not be needed */
#define	SCSI_CMD_LUN_SHIFT	5	/* LUN in the cmd is no longer SCSI */


struct scsi_generic
{
	u_char	opcode;
	u_char	bytes[11];
};

struct scsi_test_unit_ready
{
	u_char	op_code;
	u_char	byte2;
	u_char	unused[3];
	u_char	control;
};

struct scsi_send_diag
{
	u_char	op_code;
	u_char	byte2;
#define	SSD_UOL		0x01
#define	SSD_DOL		0x02
#define	SSD_SELFTEST	0x04
#define	SSD_PF		0x10
	u_char	unused[1];
	u_char	paramlen[2];
	u_char	control;
};

struct scsi_sense
{
	u_char	op_code;
	u_char	byte2;
	u_char	unused[2];
	u_char	length;
	u_char	control;
};

struct scsi_inquiry
{
	u_char	op_code;
	u_char	byte2;
	u_char	unused[2];
	u_char	length;
	u_char	control;
};

struct scsi_mode_sense
{
	u_char	op_code;
	u_char	byte2;
#define	SMS_DBD				0x08
	u_char	page;
#define	SMS_PAGE_CODE 			0x3F
#define	SMS_PAGE_CTRL 			0xC0
#define	SMS_PAGE_CTRL_CURRENT 		0x00
#define	SMS_PAGE_CTRL_CHANGEABLE 	0x40
#define	SMS_PAGE_CTRL_DEFAULT 		0x80
#define	SMS_PAGE_CTRL_SAVED 		0xC0
	u_char	unused;
	u_char	length;
	u_char	control;
};

struct scsi_mode_sense_big
{
	u_char	op_code;
	u_char	byte2; 		/* same bits as small version */
	u_char	page; 		/* same bits as small version */
	u_char	unused[4];
	u_char	length[2];
	u_char	control;
};

struct scsi_mode_select
{
	u_char	op_code;
	u_char	byte2;
#define	SMS_SP	0x01
#define	SMS_PF	0x10
	u_char	unused[2];
	u_char	length;
	u_char	control;
};

struct scsi_mode_select_big
{
	u_char	op_code;
	u_char	byte2;		/* same bits as small version */
	u_char	unused[5];
	u_char	length[2];
	u_char	control;
};

struct scsi_reserve
{
	u_char	op_code;
	u_char	byte2;
	u_char	unused[2];
	u_char	length;
	u_char	control;
};

struct scsi_release
{
	u_char	op_code;
	u_char	byte2;
	u_char	unused[2];
	u_char	length;
	u_char	control;
};

struct scsi_prevent
{
	u_char	op_code;
	u_char	byte2;
	u_char	unused[2];
	u_char	how;
	u_char	control;
};
#define	PR_PREVENT 0x01
#define PR_ALLOW   0x00

struct scsi_changedef
{
	u_char	op_code;
	u_char	byte2;
	u_char	unused1;
	u_char	how;
	u_char	unused[4];
	u_char	datalen;
	u_char	control;
};
#define SC_SCSI_1 0x01
#define SC_SCSI_2 0x03

/*
 * Opcodes
 */

#define	TEST_UNIT_READY		0x00
#define REQUEST_SENSE		0x03
#define INQUIRY			0x12
#define MODE_SELECT		0x15
#define MODE_SENSE		0x1a
#define START_STOP		0x1b
#define RESERVE      		0x16
#define RELEASE      		0x17
#define PREVENT_ALLOW		0x1e
#define POSITION_TO_ELEMENT	0x2b
#define	CHANGE_DEFINITION	0x40
#define	MODE_SENSE_BIG		0x54
#define	MODE_SELECT_BIG		0x55
#define MOVE_MEDIUM     	0xa5
#define READ_ELEMENT_STATUS	0xb8


/*
 * sense data format
 */
#define T_DIRECT	0
#define T_SEQUENTIAL	1
#define T_PRINTER	2
#define T_PROCESSOR	3
#define T_WORM		4
#define T_READONLY	5
#define T_SCANNER 	6
#define T_OPTICAL 	7
#define T_NODEVICE	0x1F

#define T_CHANGER	8
#define T_COMM		9

#define T_REMOV		1
#define	T_FIXED		0

struct scsi_inquiry_data
{
	u_char	device;
#define	SID_TYPE	0x1F
#define	SID_QUAL	0xE0
#define	SID_QUAL_LU_OK	0x00
#define	SID_QUAL_LU_OFFLINE	0x20
#define	SID_QUAL_RSVD	0x40
#define	SID_QUAL_BAD_LU	0x60
	u_char	dev_qual2;
#define	SID_QUAL2	0x7F
#define	SID_REMOVABLE	0x80
	u_char	version;
#define SID_ANSII	0x07
#define SID_ECMA	0x38
#define SID_ISO		0xC0
	u_char	response_format;
	u_char	additional_length;
	u_char	unused[2];
	u_char	flags;
#define	SID_SftRe	0x01
#define	SID_CmdQue	0x02
#define	SID_Linked	0x08
#define	SID_Sync	0x10
#define	SID_WBus16	0x20
#define	SID_WBus32	0x40
#define	SID_RelAdr	0x80
	char	vendor[8];
	char	product[16];
	char	revision[4];
	u_char	extra[8];
};

/*
 * The union had to die.  It caused a padding problem with
 * m68k gcc, specifically `ext.extended.segment' was being
 * read at byte 2 not 1.
 */
struct	scsi_sense_data_old	/* XXXX The union had to die. */
{
/* 1*/	u_char	error_code;	/* same bits as new version */
	union
	{
		struct
		{
/* 2*/			u_char	blockhi;
/* 3*/			u_char	blockmed;
/* 4*/			u_char	blocklow;
		} unextended;
		struct
		{
/* 2*/			u_char	segment;
/* 3*/			u_char	flags;	/* same bits as new version */
/* 7*/			u_char	info[4];
/* 8*/			u_char	extra_len;
			/* allocate enough room to hold new stuff
			( by increasing 16 to 24 below) */
/*32*/			u_char	extra_bytes[24];
		} extended;
	}ext;
};	/* total of 32 bytes */

/*
 * This looks bad, and it is.  However it fixes padding problems
 * caused by using unions.  This *needs* to be an array, if this code
 * is to work on any architecture.
 */
struct	scsi_sense_data
{
/* 1*/	u_char	error_code;	/* same bits as new version */
#define XXX_unextended_blockhi	extended_segment
#define XXX_unextended_blockmed	extended_flags
#define XXX_unextended_blocklow	extended_info[0]
/* 2*/	u_char	extended_segment;
/* 3*/	u_char	extended_flags;		/* same bits as new version */
/* 7*/	u_char	extended_info[4];
/* 8*/	u_char	extended_extra_len;
	/*
	 * allocate enough room to hold new stuff
	 * (by increasing 16 to 24 below)
	 */
/*32*/	u_char	extended_extra_bytes[24];
};	/* total of 32 bytes */

struct	scsi_sense_data_new
{
/* 1*/	u_char	error_code;
#define	SSD_ERRCODE		0x7F
#define	SSD_ERRCODE_VALID	0x80
	union
	{
		struct	/* this is deprecated, the standard says "DON'T"*/
		{
/* 2*/			u_char	blockhi;
/* 3*/			u_char	blockmed;
/* 4*/			u_char	blocklow;
		} unextended;
		struct
		{
/* 2*/			u_char	segment;
/* 3*/			u_char	flags;
#define	SSD_KEY		0x0F
#define	SSD_ILI		0x20
#define	SSD_EOM		0x40
#define	SSD_FILEMARK	0x80
/* 7*/			u_char	info[4];
/* 8*/			u_char	extra_len;
/*12*/			u_char	cmd_spec_info[4];
/*13*/			u_char	add_sense_code;
/*14*/			u_char	add_sense_code_qual;
/*15*/			u_char	fru;
/*16*/			u_char	sense_key_spec_1;
#define	SSD_SCS_VALID		0x80
/*17*/			u_char	sense_key_spec_2;
/*18*/			u_char	sense_key_spec_3;
/*32*/			u_char	extra_bytes[14];
		} extended;
	}ext;
}; /* total of 32 bytes */

struct	blk_desc
{
	u_char	density;
	u_char	nblocks[3];
	u_char	reserved;
	u_char	blklen[3];
};

struct scsi_mode_header
{
	u_char	data_length;	/* Sense data length */
	u_char	medium_type;
	u_char	dev_spec;
	u_char	blk_desc_len;
};

struct scsi_mode_header_big
{
	u_char	data_length[2];	/* Sense data length */
	u_char	medium_type;
	u_char	dev_spec;
	u_char	unused[2];
	u_char	blk_desc_len[2];
};


/*
 * Status Byte
 */
#define	SCSI_OK		0x00
#define	SCSI_CHECK		0x02
#define	SCSI_BUSY		0x08
#define SCSI_INTERM		0x10
#endif /*_SCSI_SCSI_ALL_H*/