xref: /illumos-gate/usr/src/uts/common/sys/scsi/generic/status.h (revision 2d6eb4a5)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_SYS_SCSI_GENERIC_STATUS_H
#define	_SYS_SCSI_GENERIC_STATUS_H

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * SCSI status completion block
 *
 * The SCSI standard specifies one byte of status.
 */

/*
 * The definition of of the Status block as a bitfield
 */

struct scsi_status {
#if defined(_BIT_FIELDS_LTOH)
	uchar_t	sts_vu0		: 1,	/* vendor unique 		*/
		sts_chk		: 1,	/* check condition 		*/
		sts_cm		: 1,	/* condition met 		*/
		sts_busy	: 1,	/* device busy or reserved 	*/
		sts_is		: 1,	/* intermediate status sent 	*/
		sts_vu6		: 1,	/* vendor unique 		*/
		sts_vu7		: 1,	/* vendor unique 		*/
		sts_resvd	: 1;	/* reserved 			*/
#elif defined(_BIT_FIELDS_HTOL)
	uchar_t	sts_resvd	: 1,	/* reserved */
		sts_vu7		: 1,	/* vendor unique */
		sts_vu6		: 1,	/* vendor unique */
		sts_is		: 1,	/* intermediate status sent */
		sts_busy	: 1,	/* device busy or reserved */
		sts_cm		: 1,	/* condition met */
		sts_chk		: 1,	/* check condition */
		sts_vu0		: 1;	/* vendor unique */
#else
#error	One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined
#endif	/* _BIT_FIELDS_LTOH */
};
#define	sts_scsi2	sts_vu6		/* SCSI modifier bit */

/*
 * if auto request sense has been enabled, then use this structure
 */
struct scsi_arq_status {
	struct scsi_status	sts_status;
	struct scsi_status	sts_rqpkt_status;
	uchar_t			sts_rqpkt_reason;	/* reason completion */
	uchar_t			sts_rqpkt_resid;	/* residue */
	uint_t			sts_rqpkt_state;	/* state of command */
	uint_t			sts_rqpkt_statistics;	/* statistics */
	struct scsi_extended_sense sts_sensedata;
};

#define	SECMDS_STATUS_SIZE  (sizeof (struct scsi_arq_status))

/*
 * Bit Mask definitions, for use accessing the status as a byte.
 */

#define	STATUS_MASK			0x3E
#define	STATUS_GOOD			0x00
#define	STATUS_CHECK			0x02
#define	STATUS_MET			0x04
#define	STATUS_BUSY			0x08
#define	STATUS_INTERMEDIATE		0x10
#define	STATUS_SCSI2			0x20
#define	STATUS_INTERMEDIATE_MET		0x14
#define	STATUS_RESERVATION_CONFLICT	0x18
#define	STATUS_TERMINATED		0x22
#define	STATUS_QFULL			0x28
#define	STATUS_ACA_ACTIVE		0x30
#define	STATUS_TASK_ABORT		0x40

#ifdef	__cplusplus
}
#endif

/*
 * Some deviations from the one byte of Status are known. Each
 * implementation will define them specifically
 */

#include <sys/scsi/impl/status.h>

#endif	/* _SYS_SCSI_GENERIC_STATUS_H */