2005-01-05 22:34:37 +00:00
|
|
|
/*-
|
1998-09-15 06:33:23 +00:00
|
|
|
* Data structures and definitions for the CAM system.
|
|
|
|
|
*
|
|
|
|
|
* Copyright (c) 1997 Justin T. Gibbs.
|
|
|
|
|
* All rights reserved.
|
|
|
|
|
*
|
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
|
* are met:
|
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
* notice, this list of conditions, and the following disclaimer,
|
|
|
|
|
* without modification, immediately at the beginning of the file.
|
|
|
|
|
* 2. The name of the author may not be used to endorse or promote products
|
|
|
|
|
* derived from this software without specific prior written permission.
|
|
|
|
|
*
|
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
|
|
|
|
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
|
*
|
1999-08-28 01:08:13 +00:00
|
|
|
* $FreeBSD$
|
1998-09-15 06:33:23 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _CAM_CAM_H
|
|
|
|
|
#define _CAM_CAM_H 1
|
|
|
|
|
|
1999-12-29 05:07:58 +00:00
|
|
|
#ifdef _KERNEL
|
1998-09-15 06:33:23 +00:00
|
|
|
#include <opt_cam.h>
|
1999-12-29 05:07:58 +00:00
|
|
|
#endif
|
1998-09-15 06:33:23 +00:00
|
|
|
|
|
|
|
|
#include <sys/cdefs.h>
|
|
|
|
|
|
|
|
|
|
typedef u_int path_id_t;
|
|
|
|
|
typedef u_int target_id_t;
|
|
|
|
|
typedef u_int lun_id_t;
|
|
|
|
|
|
|
|
|
|
#define CAM_XPT_PATH_ID ((path_id_t)~0)
|
|
|
|
|
#define CAM_BUS_WILDCARD ((path_id_t)~0)
|
|
|
|
|
#define CAM_TARGET_WILDCARD ((target_id_t)~0)
|
|
|
|
|
#define CAM_LUN_WILDCARD ((lun_id_t)~0)
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Maximum length for a CAM CDB.
|
|
|
|
|
*/
|
|
|
|
|
#define CAM_MAX_CDBLEN 16
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Definition of a CAM peripheral driver entry. Peripheral drivers instantiate
|
|
|
|
|
* one of these for each device they wish to communicate with and pass it into
|
|
|
|
|
* the xpt layer when they wish to schedule work on that device via the
|
2000-03-15 21:55:48 +00:00
|
|
|
* xpt_schedule API.
|
1998-09-15 06:33:23 +00:00
|
|
|
*/
|
|
|
|
|
struct cam_periph;
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Priority information for a CAM structure. The generation number is
|
|
|
|
|
* incremented everytime a new entry is entered into the queue giving round
|
|
|
|
|
* robin per priority level scheduling.
|
|
|
|
|
*/
|
|
|
|
|
typedef struct {
|
|
|
|
|
u_int32_t priority;
|
|
|
|
|
#define CAM_PRIORITY_NONE (u_int32_t)-1
|
|
|
|
|
u_int32_t generation;
|
|
|
|
|
int index;
|
|
|
|
|
#define CAM_UNQUEUED_INDEX -1
|
|
|
|
|
#define CAM_ACTIVE_INDEX -2
|
|
|
|
|
#define CAM_DONEQ_INDEX -3
|
|
|
|
|
} cam_pinfo;
|
|
|
|
|
|
1999-04-07 22:57:48 +00:00
|
|
|
/*
|
|
|
|
|
* Macro to compare two generation numbers. It is used like this:
|
|
|
|
|
*
|
|
|
|
|
* if (GENERATIONCMP(a, >=, b))
|
|
|
|
|
* ...;
|
|
|
|
|
*
|
|
|
|
|
* GERERATIONCMP uses modular arithmetic to guard against wraps
|
|
|
|
|
* wraps in the generation number.
|
|
|
|
|
*/
|
|
|
|
|
#define GENERATIONCMP(x, op, y) ((int32_t)((x) - (y)) op 0)
|
|
|
|
|
|
Rewrite of the CAM error recovery code.
Some of the major changes include:
- The SCSI error handling portion of cam_periph_error() has
been broken out into a number of subfunctions to better
modularize the code that handles the hierarchy of SCSI errors.
As a result, the code is now much easier to read.
- String handling and error printing has been significantly
revamped. We now use sbufs to do string formatting instead
of using printfs (for the kernel) and snprintf/strncat (for
userland) as before.
There is a new catchall error printing routine,
cam_error_print() and its string-based counterpart,
cam_error_string() that allow the kernel and userland
applications to pass in a CCB and have errors printed out
properly, whether or not they're SCSI errors. Among other
things, this helped eliminate a fair amount of duplicate code
in camcontrol.
We now print out more information than before, including
the CAM status and SCSI status and the error recovery action
taken to remedy the problem.
- sbufs are now available in userland, via libsbuf. This
change was necessary since most of the error printing code
is shared between libcam and the kernel.
- A new transfer settings interface is included in this checkin.
This code is #ifdef'ed out, and is primarily intended to aid
discussion with HBA driver authors on the final form the
interface should take. There is example code in the ahc(4)
driver that implements the HBA driver side of the new
interface. The new transfer settings code won't be enabled
until we're ready to switch all HBA drivers over to the new
interface.
src/Makefile.inc1,
lib/Makefile: Add libsbuf. It must be built before libcam,
since libcam uses sbuf routines.
libcam/Makefile: libcam now depends on libsbuf.
libsbuf/Makefile: Add a makefile for libsbuf. This pulls in the
sbuf sources from sys/kern.
bsd.libnames.mk: Add LIBSBUF.
camcontrol/Makefile: Add -lsbuf. Since camcontrol is statically
linked, we can't depend on the dynamic linker
to pull in libsbuf.
camcontrol.c: Use cam_error_print() instead of checking for
CAM_SCSI_STATUS_ERROR on every failed CCB.
sbuf.9: Change the prototypes for sbuf_cat() and
sbuf_cpy() so that the source string is now a
const char *. This is more in line wth the
standard system string functions, and helps
eliminate warnings when dealing with a const
source buffer.
Fix a typo.
cam.c: Add description strings for the various CAM
error status values, as well as routines to
look up those strings.
Add new cam_error_string() and
cam_error_print() routines for userland and
the kernel.
cam.h: Add a new CAM flag, CAM_RETRY_SELTO.
Add enumerated types for the various options
available with cam_error_print() and
cam_error_string().
cam_ccb.h: Add new transfer negotiation structures/types.
Change inq_len in the ccb_getdev structure to
be "reserved". This field has never been
filled in, and will be removed when we next
bump the CAM version.
cam_debug.h: Fix typo.
cam_periph.c: Modularize cam_periph_error(). The SCSI error
handling part of cam_periph_error() is now
in camperiphscsistatuserror() and
camperiphscsisenseerror().
In cam_periph_lock(), increase the reference
count on the periph while we wait for our lock
attempt to succeed so that the periph won't go
away while we're sleeping.
cam_xpt.c: Add new transfer negotiation code. (ifdefed
out)
Add a new function, xpt_path_string(). This
is a string/sbuf analog to xpt_print_path().
scsi_all.c: Revamp string handing and error printing code.
We now use sbufs for much of the string
formatting code. More of that code is shared
between userland the kernel.
scsi_all.h: Get rid of SS_TURSTART, it wasn't terribly
useful in the first place.
Add a new error action, SS_REQSENSE. (Send a
request sense and then retry the command.)
This is useful when the controller hasn't
performed autosense for some reason.
Change the default actions around a bit.
scsi_cd.c,
scsi_da.c,
scsi_pt.c,
scsi_ses.c: SF_RETRY_SELTO -> CAM_RETRY_SELTO. Selection
timeouts shouldn't be covered by a sense flag.
scsi_pass.[ch]: SF_RETRY_SELTO -> CAM_RETRY_SELTO.
Get rid of the last vestiges of a read/write
interface.
libkern/bsearch.c,
sys/libkern.h,
conf/files: Add bsearch.c, which is needed for some of the
new table lookup routines.
aic7xxx_freebsd.c: Define AHC_NEW_TRAN_SETTINGS if
CAM_NEW_TRAN_CODE is defined.
sbuf.h,
subr_sbuf.c: Add the appropriate #ifdefs so sbufs can
compile and run in userland.
Change sbuf_printf() to use vsnprintf()
instead of kvprintf(), which is only available
in the kernel.
Change the source string for sbuf_cpy() and
sbuf_cat() to be a const char *.
Add __BEGIN_DECLS and __END_DECLS around
function prototypes since they're now exported
to userland.
kdump/mkioctls: Include stdio.h before cam.h since cam.h now
includes a function with a FILE * argument.
Submitted by: gibbs (mostly)
Reviewed by: jdp, marcel (libsbuf makefile changes)
Reviewed by: des (sbuf changes)
Reviewed by: ken
2001-03-27 05:45:52 +00:00
|
|
|
/* CAM flags XXX Move to cam_periph.h ??? */
|
1998-09-15 06:33:23 +00:00
|
|
|
typedef enum {
|
|
|
|
|
CAM_FLAG_NONE = 0x00,
|
Rewrite of the CAM error recovery code.
Some of the major changes include:
- The SCSI error handling portion of cam_periph_error() has
been broken out into a number of subfunctions to better
modularize the code that handles the hierarchy of SCSI errors.
As a result, the code is now much easier to read.
- String handling and error printing has been significantly
revamped. We now use sbufs to do string formatting instead
of using printfs (for the kernel) and snprintf/strncat (for
userland) as before.
There is a new catchall error printing routine,
cam_error_print() and its string-based counterpart,
cam_error_string() that allow the kernel and userland
applications to pass in a CCB and have errors printed out
properly, whether or not they're SCSI errors. Among other
things, this helped eliminate a fair amount of duplicate code
in camcontrol.
We now print out more information than before, including
the CAM status and SCSI status and the error recovery action
taken to remedy the problem.
- sbufs are now available in userland, via libsbuf. This
change was necessary since most of the error printing code
is shared between libcam and the kernel.
- A new transfer settings interface is included in this checkin.
This code is #ifdef'ed out, and is primarily intended to aid
discussion with HBA driver authors on the final form the
interface should take. There is example code in the ahc(4)
driver that implements the HBA driver side of the new
interface. The new transfer settings code won't be enabled
until we're ready to switch all HBA drivers over to the new
interface.
src/Makefile.inc1,
lib/Makefile: Add libsbuf. It must be built before libcam,
since libcam uses sbuf routines.
libcam/Makefile: libcam now depends on libsbuf.
libsbuf/Makefile: Add a makefile for libsbuf. This pulls in the
sbuf sources from sys/kern.
bsd.libnames.mk: Add LIBSBUF.
camcontrol/Makefile: Add -lsbuf. Since camcontrol is statically
linked, we can't depend on the dynamic linker
to pull in libsbuf.
camcontrol.c: Use cam_error_print() instead of checking for
CAM_SCSI_STATUS_ERROR on every failed CCB.
sbuf.9: Change the prototypes for sbuf_cat() and
sbuf_cpy() so that the source string is now a
const char *. This is more in line wth the
standard system string functions, and helps
eliminate warnings when dealing with a const
source buffer.
Fix a typo.
cam.c: Add description strings for the various CAM
error status values, as well as routines to
look up those strings.
Add new cam_error_string() and
cam_error_print() routines for userland and
the kernel.
cam.h: Add a new CAM flag, CAM_RETRY_SELTO.
Add enumerated types for the various options
available with cam_error_print() and
cam_error_string().
cam_ccb.h: Add new transfer negotiation structures/types.
Change inq_len in the ccb_getdev structure to
be "reserved". This field has never been
filled in, and will be removed when we next
bump the CAM version.
cam_debug.h: Fix typo.
cam_periph.c: Modularize cam_periph_error(). The SCSI error
handling part of cam_periph_error() is now
in camperiphscsistatuserror() and
camperiphscsisenseerror().
In cam_periph_lock(), increase the reference
count on the periph while we wait for our lock
attempt to succeed so that the periph won't go
away while we're sleeping.
cam_xpt.c: Add new transfer negotiation code. (ifdefed
out)
Add a new function, xpt_path_string(). This
is a string/sbuf analog to xpt_print_path().
scsi_all.c: Revamp string handing and error printing code.
We now use sbufs for much of the string
formatting code. More of that code is shared
between userland the kernel.
scsi_all.h: Get rid of SS_TURSTART, it wasn't terribly
useful in the first place.
Add a new error action, SS_REQSENSE. (Send a
request sense and then retry the command.)
This is useful when the controller hasn't
performed autosense for some reason.
Change the default actions around a bit.
scsi_cd.c,
scsi_da.c,
scsi_pt.c,
scsi_ses.c: SF_RETRY_SELTO -> CAM_RETRY_SELTO. Selection
timeouts shouldn't be covered by a sense flag.
scsi_pass.[ch]: SF_RETRY_SELTO -> CAM_RETRY_SELTO.
Get rid of the last vestiges of a read/write
interface.
libkern/bsearch.c,
sys/libkern.h,
conf/files: Add bsearch.c, which is needed for some of the
new table lookup routines.
aic7xxx_freebsd.c: Define AHC_NEW_TRAN_SETTINGS if
CAM_NEW_TRAN_CODE is defined.
sbuf.h,
subr_sbuf.c: Add the appropriate #ifdefs so sbufs can
compile and run in userland.
Change sbuf_printf() to use vsnprintf()
instead of kvprintf(), which is only available
in the kernel.
Change the source string for sbuf_cpy() and
sbuf_cat() to be a const char *.
Add __BEGIN_DECLS and __END_DECLS around
function prototypes since they're now exported
to userland.
kdump/mkioctls: Include stdio.h before cam.h since cam.h now
includes a function with a FILE * argument.
Submitted by: gibbs (mostly)
Reviewed by: jdp, marcel (libsbuf makefile changes)
Reviewed by: des (sbuf changes)
Reviewed by: ken
2001-03-27 05:45:52 +00:00
|
|
|
CAM_EXPECT_INQ_CHANGE = 0x01,
|
|
|
|
|
CAM_RETRY_SELTO = 0x02 /* Retry Selection Timeouts */
|
1998-09-15 06:33:23 +00:00
|
|
|
} cam_flags;
|
|
|
|
|
|
|
|
|
|
/* CAM Status field values */
|
|
|
|
|
typedef enum {
|
|
|
|
|
CAM_REQ_INPROG, /* CCB request is in progress */
|
|
|
|
|
CAM_REQ_CMP, /* CCB request completed without error */
|
|
|
|
|
CAM_REQ_ABORTED, /* CCB request aborted by the host */
|
|
|
|
|
CAM_UA_ABORT, /* Unable to abort CCB request */
|
|
|
|
|
CAM_REQ_CMP_ERR, /* CCB request completed with an error */
|
2001-03-31 04:34:15 +00:00
|
|
|
CAM_BUSY, /* CAM subsystem is busy */
|
1998-09-15 06:33:23 +00:00
|
|
|
CAM_REQ_INVALID, /* CCB request was invalid */
|
|
|
|
|
CAM_PATH_INVALID, /* Supplied Path ID is invalid */
|
|
|
|
|
CAM_DEV_NOT_THERE, /* SCSI Device Not Installed/there */
|
|
|
|
|
CAM_UA_TERMIO, /* Unable to terminate I/O CCB request */
|
|
|
|
|
CAM_SEL_TIMEOUT, /* Target Selection Timeout */
|
|
|
|
|
CAM_CMD_TIMEOUT, /* Command timeout */
|
|
|
|
|
CAM_SCSI_STATUS_ERROR, /* SCSI error, look at error code in CCB */
|
2000-03-15 21:55:48 +00:00
|
|
|
CAM_MSG_REJECT_REC, /* Message Reject Received */
|
1998-09-15 06:33:23 +00:00
|
|
|
CAM_SCSI_BUS_RESET, /* SCSI Bus Reset Sent/Received */
|
|
|
|
|
CAM_UNCOR_PARITY, /* Uncorrectable parity error occurred */
|
|
|
|
|
CAM_AUTOSENSE_FAIL = 0x10,/* Autosense: request sense cmd fail */
|
|
|
|
|
CAM_NO_HBA, /* No HBA Detected error */
|
|
|
|
|
CAM_DATA_RUN_ERR, /* Data Overrun error */
|
|
|
|
|
CAM_UNEXP_BUSFREE, /* Unexpected Bus Free */
|
|
|
|
|
CAM_SEQUENCE_FAIL, /* Target Bus Phase Sequence Failure */
|
|
|
|
|
CAM_CCB_LEN_ERR, /* CCB length supplied is inadequate */
|
|
|
|
|
CAM_PROVIDE_FAIL, /* Unable to provide requested capability */
|
|
|
|
|
CAM_BDR_SENT, /* A SCSI BDR msg was sent to target */
|
|
|
|
|
CAM_REQ_TERMIO, /* CCB request terminated by the host */
|
|
|
|
|
CAM_UNREC_HBA_ERROR, /* Unrecoverable Host Bus Adapter Error */
|
|
|
|
|
CAM_REQ_TOO_BIG, /* The request was too large for this host */
|
|
|
|
|
CAM_REQUEUE_REQ, /*
|
|
|
|
|
* This request should be requeued to preserve
|
|
|
|
|
* transaction ordering. This typically occurs
|
|
|
|
|
* when the SIM recognizes an error that should
|
|
|
|
|
* freeze the queue and must place additional
|
|
|
|
|
* requests for the target at the sim level
|
|
|
|
|
* back into the XPT queue.
|
|
|
|
|
*/
|
Separate the parallel scsi knowledge out of the core of the XPT, and
modularize it so that new transports can be created.
Add a transport for SATA
Add a periph+protocol layer for ATA
Add a driver for AHCI-compliant hardware.
Add a maxio field to CAM so that drivers can advertise their max
I/O capability. Modify various drivers so that they are insulated
from the value of MAXPHYS.
The new ATA/SATA code supports AHCI-compliant hardware, and will override
the classic ATA driver if it is loaded as a module at boot time or compiled
into the kernel. The stack now support NCQ (tagged queueing) for increased
performance on modern SATA drives. It also supports port multipliers.
ATA drives are accessed via 'ada' device nodes. ATAPI drives are
accessed via 'cd' device nodes. They can all be enumerated and manipulated
via camcontrol, just like SCSI drives. SCSI commands are not translated to
their ATA equivalents; ATA native commands are used throughout the entire
stack, including camcontrol. See the camcontrol manpage for further
details. Testing this code may require that you update your fstab, and
possibly modify your BIOS to enable AHCI functionality, if available.
This code is very experimental at the moment. The userland ABI/API has
changed, so applications will need to be recompiled. It may change
further in the near future. The 'ada' device name may also change as
more infrastructure is completed in this project. The goal is to
eventually put all CAM busses and devices until newbus, allowing for
interesting topology and management options.
Few functional changes will be seen with existing SCSI/SAS/FC drivers,
though the userland ABI has still changed. In the future, transports
specific modules for SAS and FC may appear in order to better support
the topologies and capabilities of these technologies.
The modularization of CAM and the addition of the ATA/SATA modules is
meant to break CAM out of the mold of being specific to SCSI, letting it
grow to be a framework for arbitrary transports and protocols. It also
allows drivers to be written to support discrete hardware without
jeopardizing the stability of non-related hardware. While only an AHCI
driver is provided now, a Silicon Image driver is also in the works.
Drivers for ICH1-4, ICH5-6, PIIX, classic IDE, and any other hardware
is possible and encouraged. Help with new transports is also encouraged.
Submitted by: scottl, mav
Approved by: re
2009-07-10 08:18:08 +00:00
|
|
|
CAM_ATA_STATUS_ERROR, /* ATA error, look at error code in CCB */
|
2008-09-18 14:48:46 +00:00
|
|
|
CAM_SCSI_IT_NEXUS_LOST, /* Initiator/Target Nexus lost. */
|
1998-09-15 06:33:23 +00:00
|
|
|
CAM_IDE = 0x33, /* Initiator Detected Error */
|
|
|
|
|
CAM_RESRC_UNAVAIL, /* Resource Unavailable */
|
|
|
|
|
CAM_UNACKED_EVENT, /* Unacknowledged Event by Host */
|
|
|
|
|
CAM_MESSAGE_RECV, /* Message Received in Host Target Mode */
|
|
|
|
|
CAM_INVALID_CDB, /* Invalid CDB received in Host Target Mode */
|
|
|
|
|
CAM_LUN_INVALID, /* Lun supplied is invalid */
|
|
|
|
|
CAM_TID_INVALID, /* Target ID supplied is invalid */
|
|
|
|
|
CAM_FUNC_NOTAVAIL, /* The requested function is not available */
|
|
|
|
|
CAM_NO_NEXUS, /* Nexus is not established */
|
|
|
|
|
CAM_IID_INVALID, /* The initiator ID is invalid */
|
|
|
|
|
CAM_CDB_RECVD, /* The SCSI CDB has been received */
|
Rewrite of the CAM error recovery code.
Some of the major changes include:
- The SCSI error handling portion of cam_periph_error() has
been broken out into a number of subfunctions to better
modularize the code that handles the hierarchy of SCSI errors.
As a result, the code is now much easier to read.
- String handling and error printing has been significantly
revamped. We now use sbufs to do string formatting instead
of using printfs (for the kernel) and snprintf/strncat (for
userland) as before.
There is a new catchall error printing routine,
cam_error_print() and its string-based counterpart,
cam_error_string() that allow the kernel and userland
applications to pass in a CCB and have errors printed out
properly, whether or not they're SCSI errors. Among other
things, this helped eliminate a fair amount of duplicate code
in camcontrol.
We now print out more information than before, including
the CAM status and SCSI status and the error recovery action
taken to remedy the problem.
- sbufs are now available in userland, via libsbuf. This
change was necessary since most of the error printing code
is shared between libcam and the kernel.
- A new transfer settings interface is included in this checkin.
This code is #ifdef'ed out, and is primarily intended to aid
discussion with HBA driver authors on the final form the
interface should take. There is example code in the ahc(4)
driver that implements the HBA driver side of the new
interface. The new transfer settings code won't be enabled
until we're ready to switch all HBA drivers over to the new
interface.
src/Makefile.inc1,
lib/Makefile: Add libsbuf. It must be built before libcam,
since libcam uses sbuf routines.
libcam/Makefile: libcam now depends on libsbuf.
libsbuf/Makefile: Add a makefile for libsbuf. This pulls in the
sbuf sources from sys/kern.
bsd.libnames.mk: Add LIBSBUF.
camcontrol/Makefile: Add -lsbuf. Since camcontrol is statically
linked, we can't depend on the dynamic linker
to pull in libsbuf.
camcontrol.c: Use cam_error_print() instead of checking for
CAM_SCSI_STATUS_ERROR on every failed CCB.
sbuf.9: Change the prototypes for sbuf_cat() and
sbuf_cpy() so that the source string is now a
const char *. This is more in line wth the
standard system string functions, and helps
eliminate warnings when dealing with a const
source buffer.
Fix a typo.
cam.c: Add description strings for the various CAM
error status values, as well as routines to
look up those strings.
Add new cam_error_string() and
cam_error_print() routines for userland and
the kernel.
cam.h: Add a new CAM flag, CAM_RETRY_SELTO.
Add enumerated types for the various options
available with cam_error_print() and
cam_error_string().
cam_ccb.h: Add new transfer negotiation structures/types.
Change inq_len in the ccb_getdev structure to
be "reserved". This field has never been
filled in, and will be removed when we next
bump the CAM version.
cam_debug.h: Fix typo.
cam_periph.c: Modularize cam_periph_error(). The SCSI error
handling part of cam_periph_error() is now
in camperiphscsistatuserror() and
camperiphscsisenseerror().
In cam_periph_lock(), increase the reference
count on the periph while we wait for our lock
attempt to succeed so that the periph won't go
away while we're sleeping.
cam_xpt.c: Add new transfer negotiation code. (ifdefed
out)
Add a new function, xpt_path_string(). This
is a string/sbuf analog to xpt_print_path().
scsi_all.c: Revamp string handing and error printing code.
We now use sbufs for much of the string
formatting code. More of that code is shared
between userland the kernel.
scsi_all.h: Get rid of SS_TURSTART, it wasn't terribly
useful in the first place.
Add a new error action, SS_REQSENSE. (Send a
request sense and then retry the command.)
This is useful when the controller hasn't
performed autosense for some reason.
Change the default actions around a bit.
scsi_cd.c,
scsi_da.c,
scsi_pt.c,
scsi_ses.c: SF_RETRY_SELTO -> CAM_RETRY_SELTO. Selection
timeouts shouldn't be covered by a sense flag.
scsi_pass.[ch]: SF_RETRY_SELTO -> CAM_RETRY_SELTO.
Get rid of the last vestiges of a read/write
interface.
libkern/bsearch.c,
sys/libkern.h,
conf/files: Add bsearch.c, which is needed for some of the
new table lookup routines.
aic7xxx_freebsd.c: Define AHC_NEW_TRAN_SETTINGS if
CAM_NEW_TRAN_CODE is defined.
sbuf.h,
subr_sbuf.c: Add the appropriate #ifdefs so sbufs can
compile and run in userland.
Change sbuf_printf() to use vsnprintf()
instead of kvprintf(), which is only available
in the kernel.
Change the source string for sbuf_cpy() and
sbuf_cat() to be a const char *.
Add __BEGIN_DECLS and __END_DECLS around
function prototypes since they're now exported
to userland.
kdump/mkioctls: Include stdio.h before cam.h since cam.h now
includes a function with a FILE * argument.
Submitted by: gibbs (mostly)
Reviewed by: jdp, marcel (libsbuf makefile changes)
Reviewed by: des (sbuf changes)
Reviewed by: ken
2001-03-27 05:45:52 +00:00
|
|
|
CAM_LUN_ALRDY_ENA, /* The LUN is already enabled for target mode */
|
1998-09-15 06:33:23 +00:00
|
|
|
CAM_SCSI_BUSY, /* SCSI Bus Busy */
|
|
|
|
|
|
|
|
|
|
CAM_DEV_QFRZN = 0x40, /* The DEV queue is frozen w/this err */
|
|
|
|
|
|
|
|
|
|
/* Autosense data valid for target */
|
|
|
|
|
CAM_AUTOSNS_VALID = 0x80,
|
|
|
|
|
CAM_RELEASE_SIMQ = 0x100,/* SIM ready to take more commands */
|
|
|
|
|
CAM_SIM_QUEUED = 0x200,/* SIM has this command in it's queue */
|
|
|
|
|
|
2000-01-17 06:11:33 +00:00
|
|
|
CAM_STATUS_MASK = 0x3F, /* Mask bits for just the status # */
|
|
|
|
|
|
|
|
|
|
/* Target Specific Adjunct Status */
|
|
|
|
|
CAM_SENT_SENSE = 0x40000000 /* sent sense with status */
|
1998-09-15 06:33:23 +00:00
|
|
|
} cam_status;
|
|
|
|
|
|
Rewrite of the CAM error recovery code.
Some of the major changes include:
- The SCSI error handling portion of cam_periph_error() has
been broken out into a number of subfunctions to better
modularize the code that handles the hierarchy of SCSI errors.
As a result, the code is now much easier to read.
- String handling and error printing has been significantly
revamped. We now use sbufs to do string formatting instead
of using printfs (for the kernel) and snprintf/strncat (for
userland) as before.
There is a new catchall error printing routine,
cam_error_print() and its string-based counterpart,
cam_error_string() that allow the kernel and userland
applications to pass in a CCB and have errors printed out
properly, whether or not they're SCSI errors. Among other
things, this helped eliminate a fair amount of duplicate code
in camcontrol.
We now print out more information than before, including
the CAM status and SCSI status and the error recovery action
taken to remedy the problem.
- sbufs are now available in userland, via libsbuf. This
change was necessary since most of the error printing code
is shared between libcam and the kernel.
- A new transfer settings interface is included in this checkin.
This code is #ifdef'ed out, and is primarily intended to aid
discussion with HBA driver authors on the final form the
interface should take. There is example code in the ahc(4)
driver that implements the HBA driver side of the new
interface. The new transfer settings code won't be enabled
until we're ready to switch all HBA drivers over to the new
interface.
src/Makefile.inc1,
lib/Makefile: Add libsbuf. It must be built before libcam,
since libcam uses sbuf routines.
libcam/Makefile: libcam now depends on libsbuf.
libsbuf/Makefile: Add a makefile for libsbuf. This pulls in the
sbuf sources from sys/kern.
bsd.libnames.mk: Add LIBSBUF.
camcontrol/Makefile: Add -lsbuf. Since camcontrol is statically
linked, we can't depend on the dynamic linker
to pull in libsbuf.
camcontrol.c: Use cam_error_print() instead of checking for
CAM_SCSI_STATUS_ERROR on every failed CCB.
sbuf.9: Change the prototypes for sbuf_cat() and
sbuf_cpy() so that the source string is now a
const char *. This is more in line wth the
standard system string functions, and helps
eliminate warnings when dealing with a const
source buffer.
Fix a typo.
cam.c: Add description strings for the various CAM
error status values, as well as routines to
look up those strings.
Add new cam_error_string() and
cam_error_print() routines for userland and
the kernel.
cam.h: Add a new CAM flag, CAM_RETRY_SELTO.
Add enumerated types for the various options
available with cam_error_print() and
cam_error_string().
cam_ccb.h: Add new transfer negotiation structures/types.
Change inq_len in the ccb_getdev structure to
be "reserved". This field has never been
filled in, and will be removed when we next
bump the CAM version.
cam_debug.h: Fix typo.
cam_periph.c: Modularize cam_periph_error(). The SCSI error
handling part of cam_periph_error() is now
in camperiphscsistatuserror() and
camperiphscsisenseerror().
In cam_periph_lock(), increase the reference
count on the periph while we wait for our lock
attempt to succeed so that the periph won't go
away while we're sleeping.
cam_xpt.c: Add new transfer negotiation code. (ifdefed
out)
Add a new function, xpt_path_string(). This
is a string/sbuf analog to xpt_print_path().
scsi_all.c: Revamp string handing and error printing code.
We now use sbufs for much of the string
formatting code. More of that code is shared
between userland the kernel.
scsi_all.h: Get rid of SS_TURSTART, it wasn't terribly
useful in the first place.
Add a new error action, SS_REQSENSE. (Send a
request sense and then retry the command.)
This is useful when the controller hasn't
performed autosense for some reason.
Change the default actions around a bit.
scsi_cd.c,
scsi_da.c,
scsi_pt.c,
scsi_ses.c: SF_RETRY_SELTO -> CAM_RETRY_SELTO. Selection
timeouts shouldn't be covered by a sense flag.
scsi_pass.[ch]: SF_RETRY_SELTO -> CAM_RETRY_SELTO.
Get rid of the last vestiges of a read/write
interface.
libkern/bsearch.c,
sys/libkern.h,
conf/files: Add bsearch.c, which is needed for some of the
new table lookup routines.
aic7xxx_freebsd.c: Define AHC_NEW_TRAN_SETTINGS if
CAM_NEW_TRAN_CODE is defined.
sbuf.h,
subr_sbuf.c: Add the appropriate #ifdefs so sbufs can
compile and run in userland.
Change sbuf_printf() to use vsnprintf()
instead of kvprintf(), which is only available
in the kernel.
Change the source string for sbuf_cpy() and
sbuf_cat() to be a const char *.
Add __BEGIN_DECLS and __END_DECLS around
function prototypes since they're now exported
to userland.
kdump/mkioctls: Include stdio.h before cam.h since cam.h now
includes a function with a FILE * argument.
Submitted by: gibbs (mostly)
Reviewed by: jdp, marcel (libsbuf makefile changes)
Reviewed by: des (sbuf changes)
Reviewed by: ken
2001-03-27 05:45:52 +00:00
|
|
|
typedef enum {
|
|
|
|
|
CAM_ESF_NONE = 0x00,
|
|
|
|
|
CAM_ESF_COMMAND = 0x01,
|
|
|
|
|
CAM_ESF_CAM_STATUS = 0x02,
|
|
|
|
|
CAM_ESF_PROTO_STATUS = 0x04,
|
|
|
|
|
CAM_ESF_ALL = 0xff
|
|
|
|
|
} cam_error_string_flags;
|
|
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
|
CAM_EPF_NONE = 0x00,
|
|
|
|
|
CAM_EPF_MINIMAL = 0x01,
|
|
|
|
|
CAM_EPF_NORMAL = 0x02,
|
|
|
|
|
CAM_EPF_ALL = 0x03,
|
|
|
|
|
CAM_EPF_LEVEL_MASK = 0x0f
|
|
|
|
|
/* All bits above bit 3 are protocol-specific */
|
|
|
|
|
} cam_error_proto_flags;
|
|
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
|
CAM_ESF_PRINT_NONE = 0x00,
|
|
|
|
|
CAM_ESF_PRINT_STATUS = 0x10,
|
|
|
|
|
CAM_ESF_PRINT_SENSE = 0x20
|
|
|
|
|
} cam_error_scsi_flags;
|
|
|
|
|
|
|
|
|
|
struct cam_status_entry
|
|
|
|
|
{
|
|
|
|
|
cam_status status_code;
|
|
|
|
|
const char *status_text;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
extern const struct cam_status_entry cam_status_table[];
|
|
|
|
|
extern const int num_cam_status_entries;
|
|
|
|
|
union ccb;
|
|
|
|
|
|
2002-01-09 03:39:04 +00:00
|
|
|
#ifdef SYSCTL_DECL /* from sysctl.h */
|
|
|
|
|
SYSCTL_DECL(_kern_cam);
|
|
|
|
|
#endif
|
|
|
|
|
|
1998-09-15 06:33:23 +00:00
|
|
|
__BEGIN_DECLS
|
|
|
|
|
typedef int (cam_quirkmatch_t)(caddr_t, caddr_t);
|
|
|
|
|
|
|
|
|
|
caddr_t cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
|
|
|
|
|
int entry_size, cam_quirkmatch_t *comp_func);
|
|
|
|
|
|
|
|
|
|
void cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen);
|
|
|
|
|
|
|
|
|
|
int cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len);
|
Rewrite of the CAM error recovery code.
Some of the major changes include:
- The SCSI error handling portion of cam_periph_error() has
been broken out into a number of subfunctions to better
modularize the code that handles the hierarchy of SCSI errors.
As a result, the code is now much easier to read.
- String handling and error printing has been significantly
revamped. We now use sbufs to do string formatting instead
of using printfs (for the kernel) and snprintf/strncat (for
userland) as before.
There is a new catchall error printing routine,
cam_error_print() and its string-based counterpart,
cam_error_string() that allow the kernel and userland
applications to pass in a CCB and have errors printed out
properly, whether or not they're SCSI errors. Among other
things, this helped eliminate a fair amount of duplicate code
in camcontrol.
We now print out more information than before, including
the CAM status and SCSI status and the error recovery action
taken to remedy the problem.
- sbufs are now available in userland, via libsbuf. This
change was necessary since most of the error printing code
is shared between libcam and the kernel.
- A new transfer settings interface is included in this checkin.
This code is #ifdef'ed out, and is primarily intended to aid
discussion with HBA driver authors on the final form the
interface should take. There is example code in the ahc(4)
driver that implements the HBA driver side of the new
interface. The new transfer settings code won't be enabled
until we're ready to switch all HBA drivers over to the new
interface.
src/Makefile.inc1,
lib/Makefile: Add libsbuf. It must be built before libcam,
since libcam uses sbuf routines.
libcam/Makefile: libcam now depends on libsbuf.
libsbuf/Makefile: Add a makefile for libsbuf. This pulls in the
sbuf sources from sys/kern.
bsd.libnames.mk: Add LIBSBUF.
camcontrol/Makefile: Add -lsbuf. Since camcontrol is statically
linked, we can't depend on the dynamic linker
to pull in libsbuf.
camcontrol.c: Use cam_error_print() instead of checking for
CAM_SCSI_STATUS_ERROR on every failed CCB.
sbuf.9: Change the prototypes for sbuf_cat() and
sbuf_cpy() so that the source string is now a
const char *. This is more in line wth the
standard system string functions, and helps
eliminate warnings when dealing with a const
source buffer.
Fix a typo.
cam.c: Add description strings for the various CAM
error status values, as well as routines to
look up those strings.
Add new cam_error_string() and
cam_error_print() routines for userland and
the kernel.
cam.h: Add a new CAM flag, CAM_RETRY_SELTO.
Add enumerated types for the various options
available with cam_error_print() and
cam_error_string().
cam_ccb.h: Add new transfer negotiation structures/types.
Change inq_len in the ccb_getdev structure to
be "reserved". This field has never been
filled in, and will be removed when we next
bump the CAM version.
cam_debug.h: Fix typo.
cam_periph.c: Modularize cam_periph_error(). The SCSI error
handling part of cam_periph_error() is now
in camperiphscsistatuserror() and
camperiphscsisenseerror().
In cam_periph_lock(), increase the reference
count on the periph while we wait for our lock
attempt to succeed so that the periph won't go
away while we're sleeping.
cam_xpt.c: Add new transfer negotiation code. (ifdefed
out)
Add a new function, xpt_path_string(). This
is a string/sbuf analog to xpt_print_path().
scsi_all.c: Revamp string handing and error printing code.
We now use sbufs for much of the string
formatting code. More of that code is shared
between userland the kernel.
scsi_all.h: Get rid of SS_TURSTART, it wasn't terribly
useful in the first place.
Add a new error action, SS_REQSENSE. (Send a
request sense and then retry the command.)
This is useful when the controller hasn't
performed autosense for some reason.
Change the default actions around a bit.
scsi_cd.c,
scsi_da.c,
scsi_pt.c,
scsi_ses.c: SF_RETRY_SELTO -> CAM_RETRY_SELTO. Selection
timeouts shouldn't be covered by a sense flag.
scsi_pass.[ch]: SF_RETRY_SELTO -> CAM_RETRY_SELTO.
Get rid of the last vestiges of a read/write
interface.
libkern/bsearch.c,
sys/libkern.h,
conf/files: Add bsearch.c, which is needed for some of the
new table lookup routines.
aic7xxx_freebsd.c: Define AHC_NEW_TRAN_SETTINGS if
CAM_NEW_TRAN_CODE is defined.
sbuf.h,
subr_sbuf.c: Add the appropriate #ifdefs so sbufs can
compile and run in userland.
Change sbuf_printf() to use vsnprintf()
instead of kvprintf(), which is only available
in the kernel.
Change the source string for sbuf_cpy() and
sbuf_cat() to be a const char *.
Add __BEGIN_DECLS and __END_DECLS around
function prototypes since they're now exported
to userland.
kdump/mkioctls: Include stdio.h before cam.h since cam.h now
includes a function with a FILE * argument.
Submitted by: gibbs (mostly)
Reviewed by: jdp, marcel (libsbuf makefile changes)
Reviewed by: des (sbuf changes)
Reviewed by: ken
2001-03-27 05:45:52 +00:00
|
|
|
const struct cam_status_entry*
|
|
|
|
|
cam_fetch_status_entry(cam_status status);
|
|
|
|
|
#ifdef _KERNEL
|
|
|
|
|
char * cam_error_string(union ccb *ccb, char *str, int str_len,
|
|
|
|
|
cam_error_string_flags flags,
|
|
|
|
|
cam_error_proto_flags proto_flags);
|
|
|
|
|
void cam_error_print(union ccb *ccb, cam_error_string_flags flags,
|
|
|
|
|
cam_error_proto_flags proto_flags);
|
|
|
|
|
#else /* _KERNEL */
|
|
|
|
|
struct cam_device;
|
|
|
|
|
|
|
|
|
|
char * cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
|
|
|
|
|
int str_len, cam_error_string_flags flags,
|
|
|
|
|
cam_error_proto_flags proto_flags);
|
|
|
|
|
void cam_error_print(struct cam_device *device, union ccb *ccb,
|
|
|
|
|
cam_error_string_flags flags,
|
|
|
|
|
cam_error_proto_flags proto_flags, FILE *ofile);
|
|
|
|
|
#endif /* _KERNEL */
|
1998-09-15 06:33:23 +00:00
|
|
|
__END_DECLS
|
|
|
|
|
|
1999-12-29 05:07:58 +00:00
|
|
|
#ifdef _KERNEL
|
1998-09-15 06:33:23 +00:00
|
|
|
static __inline void cam_init_pinfo(cam_pinfo *pinfo);
|
|
|
|
|
|
|
|
|
|
static __inline void cam_init_pinfo(cam_pinfo *pinfo)
|
|
|
|
|
{
|
|
|
|
|
pinfo->priority = CAM_PRIORITY_NONE;
|
|
|
|
|
pinfo->index = CAM_UNQUEUED_INDEX;
|
|
|
|
|
}
|
1999-12-29 05:07:58 +00:00
|
|
|
#endif
|
1998-09-15 06:33:23 +00:00
|
|
|
|
|
|
|
|
#endif /* _CAM_CAM_H */
|
