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;
|
2013-09-25 15:55:56 +00:00
|
|
|
typedef union {
|
|
|
|
|
u_int64_t lun64;
|
|
|
|
|
u_int8_t lun[8];
|
|
|
|
|
} lun64_id_t;
|
1998-09-15 06:33:23 +00:00
|
|
|
|
|
|
|
|
#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)
|
|
|
|
|
|
MFC r257345,257382,257388:
Implement extended LUN support. If PIM_EXTLUNS is set by a SIM, encode
the upper 32-bits of the LUN, if possible, into the target_lun field as
passed directly from the REPORT LUNs response. This allows extended LUN
support to work for all LUNs with zeros in the lower 32-bits, which covers
most addressing modes without breaking KBI. Behavior for drivers not
setting PIM_EXTLUNS is unchanged. No user-facing interfaces are modified.
Extended LUNs are stored with swizzled 16-bit word order so that, for
devices implementing LUN addressing (like SCSI-2), the numerical
representation of the LUN is identical with and without PIM_EXTLUNS. Thus
setting PIM_EXTLUNS keeps most behavior, and user-facing LUN IDs, unchanged.
This follows the strategy used in Solaris. A macro (CAM_EXTLUN_BYTE_SWIZZLE)
is provided to transform a lun_id_t into a uint64_t ordered for the wire.
This is the second part of work for full 64-bit extended LUN support and is
designed to a bridge for stable/10 to the final 64-bit LUN code. The
third and final part will involve widening lun_id_t to 64 bits and will
not be MFCed. This third part will break the KBI but will keep the KPI
unchanged so that all drivers that will care about this can be updated now
and not require code changes between HEAD and stable/10.
Reviewed by: scottl
2013-12-10 22:55:22 +00:00
|
|
|
#define CAM_EXTLUN_BYTE_SWIZZLE(lun) ( \
|
|
|
|
|
((((u_int64_t)lun) & 0xffff000000000000L) >> 48) | \
|
|
|
|
|
((((u_int64_t)lun) & 0x0000ffff00000000L) >> 16) | \
|
|
|
|
|
((((u_int64_t)lun) & 0x00000000ffff0000L) << 16) | \
|
|
|
|
|
((((u_int64_t)lun) & 0x000000000000ffffL) << 48))
|
|
|
|
|
|
1998-09-15 06:33:23 +00:00
|
|
|
/*
|
|
|
|
|
* 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;
|
|
|
|
|
|
|
|
|
|
/*
|
MFp4: Large set of CAM inprovements.
- Unify bus reset/probe sequence. Whenever bus attached at boot or later,
CAM will automatically reset and scan it. It allows to remove duplicate
code from many drivers.
- Any bus, attached before CAM completed it's boot-time initialization,
will equally join to the process, delaying boot if needed.
- New kern.cam.boot_delay loader tunable should help controllers that
are still unable to register their buses in time (such as slow USB/
PCCard/ CardBus devices), by adding one more event to wait on boot.
- To allow synchronization between different CAM levels, concept of
requests priorities was extended. Priorities now split between several
"run levels". Device can be freezed at specified level, allowing higher
priority requests to pass. For example, no payload requests allowed,
until PMP driver enable port. ATA XPT negotiate transfer parameters,
periph driver configure caching and so on.
- Frozen requests are no more counted by request allocation scheduler.
It fixes deadlocks, when frozen low priority payload requests occupying
slots, required by higher levels to manage theit execution.
- Two last changes were holding proper ATA reinitialization and error
recovery implementation. Now it is done: SATA controllers and Port
Multipliers now implement automatic hot-plug and should correctly
recover from timeouts and bus resets.
- Improve SCSI error recovery for devices on buses without automatic sense
reporting, such as ATAPI or USB. For example, it allows CAM to wait, while
CD drive loads disk, instead of immediately return error status.
- Decapitalize diagnostic messages and make them more readable and sensible.
- Teach PMP driver to limit maximum speed on fan-out ports.
- Make boot wait for PMP scan completes, and make rescan more reliable.
- Fix pass driver, to return CCB to user level in case of error.
- Increase number of retries in cd driver, as device may return several UAs.
2010-01-28 08:41:30 +00:00
|
|
|
* Priority information for a CAM structure.
|
|
|
|
|
*/
|
|
|
|
|
typedef enum {
|
|
|
|
|
CAM_RL_HOST,
|
|
|
|
|
CAM_RL_BUS,
|
|
|
|
|
CAM_RL_XPT,
|
|
|
|
|
CAM_RL_DEV,
|
|
|
|
|
CAM_RL_NORMAL,
|
|
|
|
|
CAM_RL_VALUES
|
|
|
|
|
} cam_rl;
|
|
|
|
|
/*
|
|
|
|
|
* The generation number is incremented everytime a new entry is entered into
|
|
|
|
|
* the queue giving round robin per priority level scheduling.
|
1998-09-15 06:33:23 +00:00
|
|
|
*/
|
|
|
|
|
typedef struct {
|
|
|
|
|
u_int32_t priority;
|
MFp4: Large set of CAM inprovements.
- Unify bus reset/probe sequence. Whenever bus attached at boot or later,
CAM will automatically reset and scan it. It allows to remove duplicate
code from many drivers.
- Any bus, attached before CAM completed it's boot-time initialization,
will equally join to the process, delaying boot if needed.
- New kern.cam.boot_delay loader tunable should help controllers that
are still unable to register their buses in time (such as slow USB/
PCCard/ CardBus devices), by adding one more event to wait on boot.
- To allow synchronization between different CAM levels, concept of
requests priorities was extended. Priorities now split between several
"run levels". Device can be freezed at specified level, allowing higher
priority requests to pass. For example, no payload requests allowed,
until PMP driver enable port. ATA XPT negotiate transfer parameters,
periph driver configure caching and so on.
- Frozen requests are no more counted by request allocation scheduler.
It fixes deadlocks, when frozen low priority payload requests occupying
slots, required by higher levels to manage theit execution.
- Two last changes were holding proper ATA reinitialization and error
recovery implementation. Now it is done: SATA controllers and Port
Multipliers now implement automatic hot-plug and should correctly
recover from timeouts and bus resets.
- Improve SCSI error recovery for devices on buses without automatic sense
reporting, such as ATAPI or USB. For example, it allows CAM to wait, while
CD drive loads disk, instead of immediately return error status.
- Decapitalize diagnostic messages and make them more readable and sensible.
- Teach PMP driver to limit maximum speed on fan-out ports.
- Make boot wait for PMP scan completes, and make rescan more reliable.
- Fix pass driver, to return CCB to user level in case of error.
- Increase number of retries in cd driver, as device may return several UAs.
2010-01-28 08:41:30 +00:00
|
|
|
#define CAM_PRIORITY_HOST ((CAM_RL_HOST << 8) + 0x80)
|
|
|
|
|
#define CAM_PRIORITY_BUS ((CAM_RL_BUS << 8) + 0x80)
|
|
|
|
|
#define CAM_PRIORITY_XPT ((CAM_RL_XPT << 8) + 0x80)
|
|
|
|
|
#define CAM_PRIORITY_DEV ((CAM_RL_DEV << 8) + 0x80)
|
MFprojects/camlock r248890, r248897, r248898, r248900, r248903, r248905,
r248917, r248918, r248978, r249001, r249014, r249030:
Remove multilevel freezing mechanism, implemented to handle specifics of
the ATA/SATA error recovery, when post-reset recovery commands should be
allocated when queues are already full of payload requests. Instead of
removing frozen CCBs with specified range of priorities from the queue
to provide free openings, use simple hack, allowing explicit CCBs over-
allocation for requests with priority higher (numerically lower) then
CAM_PRIORITY_OOB threshold.
Simplify CCB allocation logic by removing SIM-level allocation queue.
After that SIM-level queue manages only CCBs execution, while allocation
logic is localized within each single device.
Suggested by: gibbs
2013-04-14 09:28:14 +00:00
|
|
|
#define CAM_PRIORITY_OOB (CAM_RL_DEV << 8)
|
MFp4: Large set of CAM inprovements.
- Unify bus reset/probe sequence. Whenever bus attached at boot or later,
CAM will automatically reset and scan it. It allows to remove duplicate
code from many drivers.
- Any bus, attached before CAM completed it's boot-time initialization,
will equally join to the process, delaying boot if needed.
- New kern.cam.boot_delay loader tunable should help controllers that
are still unable to register their buses in time (such as slow USB/
PCCard/ CardBus devices), by adding one more event to wait on boot.
- To allow synchronization between different CAM levels, concept of
requests priorities was extended. Priorities now split between several
"run levels". Device can be freezed at specified level, allowing higher
priority requests to pass. For example, no payload requests allowed,
until PMP driver enable port. ATA XPT negotiate transfer parameters,
periph driver configure caching and so on.
- Frozen requests are no more counted by request allocation scheduler.
It fixes deadlocks, when frozen low priority payload requests occupying
slots, required by higher levels to manage theit execution.
- Two last changes were holding proper ATA reinitialization and error
recovery implementation. Now it is done: SATA controllers and Port
Multipliers now implement automatic hot-plug and should correctly
recover from timeouts and bus resets.
- Improve SCSI error recovery for devices on buses without automatic sense
reporting, such as ATAPI or USB. For example, it allows CAM to wait, while
CD drive loads disk, instead of immediately return error status.
- Decapitalize diagnostic messages and make them more readable and sensible.
- Teach PMP driver to limit maximum speed on fan-out ports.
- Make boot wait for PMP scan completes, and make rescan more reliable.
- Fix pass driver, to return CCB to user level in case of error.
- Increase number of retries in cd driver, as device may return several UAs.
2010-01-28 08:41:30 +00:00
|
|
|
#define CAM_PRIORITY_NORMAL ((CAM_RL_NORMAL << 8) + 0x80)
|
1998-09-15 06:33:23 +00:00
|
|
|
#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
|
2013-08-05 11:48:40 +00:00
|
|
|
#define CAM_EXTRAQ_INDEX INT_MAX
|
1998-09-15 06:33:23 +00:00
|
|
|
} 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;
|
|
|
|
|
|
One more major cam_periph_error() rewrite to improve error handling and
reporting. It includes:
- removing of error messages controlled by bootverbose, replacing them
with more universal and informative debugging on CAM_DEBUG_INFO level,
that is now built into the kernel by default;
- more close following to the arguments submitted by caller, such as
SF_PRINT_ALWAYS, SF_QUIET_IR and SF_NO_PRINT; consumer knows better which
errors are usual/expected at this point and which are really informative;
- adding two new flags SF_NO_RECOVERY and SF_NO_RETRY to allow caller
specify how much assistance it needs at this point; previously consumers
controlled that by not calling cam_periph_error() at all, but that made
behavior inconsistent and debugging complicated;
- tuning debug messages and taken actions order to make debugging output
more readable and cause-effect relationships visible;
- making camperiphdone() (common device recovery completion handler) to
also use cam_periph_error() in most cases, instead of own dumb code;
- removing manual sense fetching code from cam_periph_error(); I was told
by number of people that it is SIM obligation to fetch sense data, so this
code is useless and only significantly complicates recovery logic;
- making ada, da and pass driver to use cam_periph_error() with new limited
recovery options to handle error recovery and debugging in common way;
as one of results, CAM_REQUEUE_REQ and other retrying statuses are now
working fine with pass driver, that caused many problems before.
- reverting r186891 by raj@ to avoid burning few seconds in tight DELAY()
loops on device probe, while device simply loads media; I think that problem
may already be fixed in other way, and even if it is not, solution must be
different.
Sponsored by: iXsystems, Inc.
MFC after: 2 weeks
2012-06-09 13:07:44 +00:00
|
|
|
enum {
|
|
|
|
|
SF_RETRY_UA = 0x01, /* Retry UNIT ATTENTION conditions. */
|
|
|
|
|
SF_NO_PRINT = 0x02, /* Never print error status. */
|
|
|
|
|
SF_QUIET_IR = 0x04, /* Be quiet about Illegal Request reponses */
|
|
|
|
|
SF_PRINT_ALWAYS = 0x08, /* Always print error status. */
|
|
|
|
|
SF_NO_RECOVERY = 0x10, /* Don't do active error recovery. */
|
|
|
|
|
SF_NO_RETRY = 0x20 /* Don't do any retries. */
|
|
|
|
|
};
|
|
|
|
|
|
1998-09-15 06:33:23 +00:00
|
|
|
/* CAM Status field values */
|
|
|
|
|
typedef enum {
|
2013-09-25 15:55:56 +00:00
|
|
|
/* CCB request is in progress */
|
|
|
|
|
CAM_REQ_INPROG = 0x00,
|
|
|
|
|
|
|
|
|
|
/* CCB request completed without error */
|
|
|
|
|
CAM_REQ_CMP = 0x01,
|
|
|
|
|
|
|
|
|
|
/* CCB request aborted by the host */
|
|
|
|
|
CAM_REQ_ABORTED = 0x02,
|
|
|
|
|
|
|
|
|
|
/* Unable to abort CCB request */
|
|
|
|
|
CAM_UA_ABORT = 0x03,
|
|
|
|
|
|
|
|
|
|
/* CCB request completed with an error */
|
|
|
|
|
CAM_REQ_CMP_ERR = 0x04,
|
|
|
|
|
|
|
|
|
|
/* CAM subsystem is busy */
|
|
|
|
|
CAM_BUSY = 0x05,
|
|
|
|
|
|
|
|
|
|
/* CCB request was invalid */
|
|
|
|
|
CAM_REQ_INVALID = 0x06,
|
|
|
|
|
|
|
|
|
|
/* Supplied Path ID is invalid */
|
|
|
|
|
CAM_PATH_INVALID = 0x07,
|
|
|
|
|
|
|
|
|
|
/* SCSI Device Not Installed/there */
|
|
|
|
|
CAM_DEV_NOT_THERE = 0x08,
|
|
|
|
|
|
|
|
|
|
/* Unable to terminate I/O CCB request */
|
|
|
|
|
CAM_UA_TERMIO = 0x09,
|
|
|
|
|
|
|
|
|
|
/* Target Selection Timeout */
|
|
|
|
|
CAM_SEL_TIMEOUT = 0x0a,
|
|
|
|
|
|
|
|
|
|
/* Command timeout */
|
|
|
|
|
CAM_CMD_TIMEOUT = 0x0b,
|
|
|
|
|
|
|
|
|
|
/* SCSI error, look at error code in CCB */
|
|
|
|
|
CAM_SCSI_STATUS_ERROR = 0x0c,
|
|
|
|
|
|
|
|
|
|
/* Message Reject Received */
|
|
|
|
|
CAM_MSG_REJECT_REC = 0x0d,
|
|
|
|
|
|
|
|
|
|
/* SCSI Bus Reset Sent/Received */
|
|
|
|
|
CAM_SCSI_BUS_RESET = 0x0e,
|
|
|
|
|
|
|
|
|
|
/* Uncorrectable parity error occurred */
|
|
|
|
|
CAM_UNCOR_PARITY = 0x0f,
|
|
|
|
|
|
|
|
|
|
/* Autosense: request sense cmd fail */
|
|
|
|
|
CAM_AUTOSENSE_FAIL = 0x10,
|
|
|
|
|
|
|
|
|
|
/* No HBA Detected error */
|
|
|
|
|
CAM_NO_HBA = 0x11,
|
|
|
|
|
|
|
|
|
|
/* Data Overrun error */
|
|
|
|
|
CAM_DATA_RUN_ERR = 0x12,
|
|
|
|
|
|
|
|
|
|
/* Unexpected Bus Free */
|
|
|
|
|
CAM_UNEXP_BUSFREE = 0x13,
|
|
|
|
|
|
|
|
|
|
/* Target Bus Phase Sequence Failure */
|
|
|
|
|
CAM_SEQUENCE_FAIL = 0x14,
|
|
|
|
|
|
|
|
|
|
/* CCB length supplied is inadequate */
|
|
|
|
|
CAM_CCB_LEN_ERR = 0x15,
|
|
|
|
|
|
|
|
|
|
/* Unable to provide requested capability*/
|
|
|
|
|
CAM_PROVIDE_FAIL = 0x16,
|
|
|
|
|
|
|
|
|
|
/* A SCSI BDR msg was sent to target */
|
|
|
|
|
CAM_BDR_SENT = 0x17,
|
|
|
|
|
|
|
|
|
|
/* CCB request terminated by the host */
|
|
|
|
|
CAM_REQ_TERMIO = 0x18,
|
|
|
|
|
|
|
|
|
|
/* Unrecoverable Host Bus Adapter Error */
|
|
|
|
|
CAM_UNREC_HBA_ERROR = 0x19,
|
|
|
|
|
|
|
|
|
|
/* Request was too large for this host */
|
|
|
|
|
CAM_REQ_TOO_BIG = 0x1a,
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* 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.
|
|
|
|
|
*/
|
|
|
|
|
CAM_REQUEUE_REQ = 0x1b,
|
|
|
|
|
|
|
|
|
|
/* ATA error, look at error code in CCB */
|
|
|
|
|
CAM_ATA_STATUS_ERROR = 0x1c,
|
|
|
|
|
|
|
|
|
|
/* Initiator/Target Nexus lost. */
|
|
|
|
|
CAM_SCSI_IT_NEXUS_LOST = 0x1d,
|
|
|
|
|
|
|
|
|
|
/* SMP error, look at error code in CCB */
|
|
|
|
|
CAM_SMP_STATUS_ERROR = 0x1e,
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Command completed without error but exceeded the soft
|
|
|
|
|
* timeout threshold.
|
|
|
|
|
*/
|
|
|
|
|
CAM_REQ_SOFTTIMEOUT = 0x1f,
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* 0x20 - 0x32 are unassigned
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/* Initiator Detected Error */
|
|
|
|
|
CAM_IDE = 0x33,
|
|
|
|
|
|
|
|
|
|
/* Resource Unavailable */
|
|
|
|
|
CAM_RESRC_UNAVAIL = 0x34,
|
|
|
|
|
|
|
|
|
|
/* Unacknowledged Event by Host */
|
|
|
|
|
CAM_UNACKED_EVENT = 0x35,
|
|
|
|
|
|
|
|
|
|
/* Message Received in Host Target Mode */
|
|
|
|
|
CAM_MESSAGE_RECV = 0x36,
|
|
|
|
|
|
|
|
|
|
/* Invalid CDB received in Host Target Mode */
|
|
|
|
|
CAM_INVALID_CDB = 0x37,
|
|
|
|
|
|
|
|
|
|
/* Lun supplied is invalid */
|
|
|
|
|
CAM_LUN_INVALID = 0x38,
|
|
|
|
|
|
|
|
|
|
/* Target ID supplied is invalid */
|
|
|
|
|
CAM_TID_INVALID = 0x39,
|
|
|
|
|
|
|
|
|
|
/* The requested function is not available */
|
|
|
|
|
CAM_FUNC_NOTAVAIL = 0x3a,
|
|
|
|
|
|
|
|
|
|
/* Nexus is not established */
|
|
|
|
|
CAM_NO_NEXUS = 0x3b,
|
|
|
|
|
|
|
|
|
|
/* The initiator ID is invalid */
|
|
|
|
|
CAM_IID_INVALID = 0x3c,
|
|
|
|
|
|
|
|
|
|
/* The SCSI CDB has been received */
|
|
|
|
|
CAM_CDB_RECVD = 0x3d,
|
|
|
|
|
|
|
|
|
|
/* The LUN is already enabled for target mode */
|
|
|
|
|
CAM_LUN_ALRDY_ENA = 0x3e,
|
|
|
|
|
|
|
|
|
|
/* SCSI Bus Busy */
|
|
|
|
|
CAM_SCSI_BUSY = 0x3f,
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Flags
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/* The DEV queue is frozen w/this err */
|
|
|
|
|
CAM_DEV_QFRZN = 0x40,
|
|
|
|
|
|
|
|
|
|
/* Autosense data valid for target */
|
|
|
|
|
CAM_AUTOSNS_VALID = 0x80,
|
|
|
|
|
|
|
|
|
|
/* SIM ready to take more commands */
|
|
|
|
|
CAM_RELEASE_SIMQ = 0x100,
|
|
|
|
|
|
|
|
|
|
/* SIM has this command in it's queue */
|
|
|
|
|
CAM_SIM_QUEUED = 0x200,
|
|
|
|
|
|
|
|
|
|
/* Quality of service data is valid */
|
|
|
|
|
CAM_QOS_VALID = 0x400,
|
|
|
|
|
|
|
|
|
|
/* Mask bits for just the status # */
|
|
|
|
|
CAM_STATUS_MASK = 0x3F,
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Target Specific Adjunct Status
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/* sent sense with status */
|
|
|
|
|
CAM_SENT_SENSE = 0x40000000
|
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;
|
|
|
|
|
|
Add Serial Management Protocol (SMP) passthrough support to CAM.
This includes support in the kernel, camcontrol(8), libcam and the mps(4)
driver for SMP passthrough.
The CAM SCSI probe code has been modified to fetch Inquiry VPD page 0x00
to determine supported pages, and will now fetch page 0x83 in addition to
page 0x80 if supported.
Add two new CAM CCBs, XPT_SMP_IO, and XPT_GDEV_ADVINFO. The SMP CCB is
intended for SMP requests and responses. The ADVINFO is currently used to
fetch cached VPD page 0x83 data from the transport layer, but is intended
to be extensible to fetch other types of device-specific data.
SMP-only devices are not currently represented in the CAM topology, and so
the current semantics are that the SIM will route SMP CCBs to either the
addressed device, if it contains an SMP target, or its parent, if it
contains an SMP target. (This is noted in cam_ccb.h, since it will change
later once we have the ability to have SMP-only devices in CAM's topology.)
smp_all.c,
smp_all.h: New helper routines for SMP. This includes
SMP request building routines, response parsing
routines, error decoding routines, and structure
definitions for a number of SMP commands.
libcam/Makefile: Add smp_all.c to libcam, so that SMP functionality
is available to userland applications.
camcontrol.8,
camcontrol.c: Add smp passthrough support to camcontrol. Several
new subcommands are now available:
'smpcmd' functions much like 'cmd', except that it
allows the user to send generic SMP commands.
'smprg' sends the SMP report general command, and
displays the decoded output. It will automatically
fetch extended output if it is available.
'smppc' sends the SMP phy control command, with any
number of potential options. Among other things,
this allows the user to reset a phy on a SAS
expander, or disable a phy on an expander.
'smpmaninfo' sends the SMP report manufacturer
information and displays the decoded output.
'smpphylist' displays a list of phys on an
expander, and the CAM devices attached to those
phys, if any.
cam.h,
cam.c: Add a status value for SMP errors
(CAM_SMP_STATUS_ERROR).
Add a missing description for CAM_SCSI_IT_NEXUS_LOST.
Add support for SMP commands to cam_error_string().
cam_ccb.h: Rename the CAM_DIR_RESV flag to CAM_DIR_BOTH. SMP
commands are by nature bi-directional, and we may
need to support bi-directional SCSI commands later.
Add the XPT_SMP_IO CCB. Since SMP commands are
bi-directional, there are pointers for both the
request and response.
Add a fill routine for SMP CCBs.
Add the XPT_GDEV_ADVINFO CCB. This is currently
used to fetch cached page 0x83 data from the
transport later, but is extensible to fetch many
other types of data.
cam_periph.c: Add support in cam_periph_mapmem() for XPT_SMP_IO
and XPT_GDEV_ADVINFO CCBs.
cam_xpt.c: Add support for executing XPT_SMP_IO CCBs.
cam_xpt_internal.h: Add fields for VPD pages 0x00 and 0x83 in struct
cam_ed.
scsi_all.c: Add scsi_get_sas_addr(), a function that parses
VPD page 0x83 data and pulls out a SAS address.
scsi_all.h: Add VPD page 0x00 and 0x83 structures, and a
prototype for scsi_get_sas_addr().
scsi_pass.c: Add support for mapping buffers in XPT_SMP_IO and
XPT_GDEV_ADVINFO CCBs.
scsi_xpt.c: In the SCSI probe code, first ask the device for
VPD page 0x00. If any VPD pages are supported,
that page is required to be implemented. Based on
the response, we may probe for the serial number
(page 0x80) or device id (page 0x83).
Add support for the XPT_GDEV_ADVINFO CCB.
sys/conf/files: Add smp_all.c.
mps.c: Add support for passing in a uio in mps_map_command(),
so we can map a S/G list at once.
Add support for SMP passthrough commands in
mps_data_cb(). SMP is a special case, because the
first buffer in the S/G list is outbound and the
second buffer is inbound.
Add support for warning the user if the busdma code
comes back with more buffers than will work for the
command. This will, for example, help the user
determine why an SMP command failed if busdma comes
back with three buffers.
mps_pci.c: Add sys/uio.h.
mps_sas.c: Add the SAS address and the parent handle to the
list of fields we pull from device page 0 and cache
in struct mpssas_target. These are needed for SMP
passthrough.
Add support for the XPT_SMP_IO CCB. For now, this
CCB is routed to the addressed device if it supports
SMP, or to its parent if it does not and the parent
does. This is necessary because CAM does not
currently support SMP-only nodes in the topology.
Make SMP passthrough support conditional on
__FreeBSD_version >= 900026. This will make it
easier to MFC this change to the driver without
MFCing the CAM changes as well.
mps_user.c: Un-staticize mpi_init_sge() so we can use it for
the SMP passthrough code.
mpsvar.h: Add a uio and iovecs into struct mps_command for
SMP passthrough commands.
Add a cm_max_segs field to struct mps_command so
that we can warn the user if busdma comes back with
too many segments.
Clear the cm_reply when a command gets freed. If
it is not cleared, reply frames will eventually get
freed into the pool multiple times and corrupt the
pool. (This fix is from scottl.)
Add a prototype for mpi_init_sge().
sys/param.h: Bump __FreeBSD_version to 900026 for the for the
inclusion of the XPT_GDEV_ADVINFO and XPT_SMP_IO
CAM CCBs.
2010-11-30 22:39:46 +00:00
|
|
|
typedef enum {
|
|
|
|
|
CAM_ESMF_PRINT_NONE = 0x00,
|
|
|
|
|
CAM_ESMF_PRINT_STATUS = 0x10,
|
|
|
|
|
CAM_ESMF_PRINT_FULL_CMD = 0x20,
|
|
|
|
|
} cam_error_smp_flags;
|
|
|
|
|
|
2009-11-03 11:19:05 +00:00
|
|
|
typedef enum {
|
|
|
|
|
CAM_EAF_PRINT_NONE = 0x00,
|
|
|
|
|
CAM_EAF_PRINT_STATUS = 0x10,
|
|
|
|
|
CAM_EAF_PRINT_RESULT = 0x20
|
|
|
|
|
} cam_error_ata_flags;
|
|
|
|
|
|
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
|
|
|
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;
|
2013-03-29 22:58:15 +00:00
|
|
|
#ifdef _KERNEL
|
|
|
|
|
extern int cam_sort_io_queues;
|
|
|
|
|
#endif
|
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
|
|
|
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 */
|
