man/man9f/scsi_sense_key.9f

         te
 Copyright (c) 2006, Sun Microsystems, Inc., All Rights Reserved
 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]
 scsi_sense_key 9F "28 Jun 2006" "SunOS 5.11" "Kernel Functions for Drivers"
 NAME
scsi_sense_key, scsi_sense_asc, scsi_sense_ascq - retrieve fields from SCSI
sense data
 SYNOPSIS

#include <sys/scsi/scsi.h>


uint8_t scsi_sense_key(uint8_t *sense_buffer);


uint8_t scsi_sense_asc(uint8_t *sense_buffer);


uint8_t scsi_sense_ascq(uint8_t *sense_buffer);


 INTERFACE LEVEL

Solaris DDI specific (Solaris DDI).
 PARAMETERS

sense_buffer

Pointer to a buffer containing SCSI sense data. The sense data is
expected in wire format starting at the response code. It can be in either
fixed or descriptor format.


 DESCRIPTION

The scsi_sense_key() function returns the sense key value from the sense
data contained in the sense_buffer.

The scsi_sense_asc() function returns the additional sense code
(ASC) value from the sense data contained in the sense_buffer.

The scsi_sense_ascq() function returns the additional sense code
qualifier (ASCQ) value from the sense data contained in the sense_buffer.

The scsi_sense_key(), scsi_sense_asc(), and scsi_sense_ascq()
functions are used to retrieve values from SCSI sense data, regardles of
whether the sense data is in fixed format or descriptor format.

Drivers should use scsi_validate_sense(9F) to ensure that valid sense
key, asc, and ascq values are present in the sense data.
 RETURN VALUES

The scsi_sense_key() function returns the sense key value from the sense
buffer. The scsi_sense_asc() function returns the additional sense code
(ASC) from the sense buffer and the scsi_sense_ascq() function
returns the additional sense code qualifier (ASCQ) from the sense buffer.
 CONTEXT

The scsi_sense_key(), scsi_sense_asc(), and scsi_sense_ascq()
functions can be called from user or interrupt context.
 SEE ALSO

scsi_ext_sense_fields(9F), scsi_find_sense_descr(9F),
scsi_sense_cmdspecific_uint64(9F), scsi_sense_info_uint64(9F),
scsi_validate_sense(9F)