Edit

Share via

ScsiPortLogError function (srb.h)

  • Article

The ScsiPortLogError routine logs errors to the system event log when a miniport driver or its HBA detects a SCSI error condition.

Note

The SCSI port driver and SCSI miniport driver models may be altered or unavailable in the future. Use the Storport driver and Storport miniport driver models instead.

Syntax

SCSIPORT_API VOID ScsiPortLogError(
  PVOID               HwDeviceExtension,
  PSCSI_REQUEST_BLOCK Srb,
  UCHAR               PathId,
  UCHAR               TargetId,
  UCHAR               Lun,
  ULONG               ErrorCode,
  ULONG               UniqueId
);

Parameters

HwDeviceExtension

[in] Pointer to the hardware device extension. This is a per-HBA storage area that the port driver allocates and initializes on behalf of the miniport driver. Miniport drivers usually store HBA-specific information in this extension, such as the state of the HBA and the HBA's mapped access ranges. This area is available to the miniport driver in the DeviceExtension->HwDeviceExtension member of the HBA's device object immediately after the miniport driver calls ScsiPortInitialize. The port driver frees this memory when it removes the device.

Srb

[in, optional] Pointer to a SCSI request block if one is associated with the error. Otherwise, this parameter is NULL.

PathId

[in] Identifies the SCSI bus.

TargetId

[in] Identifies the target controller or device on the bus.

Lun

[in] Identifies the logical unit number of the target device.

ErrorCode

[in] Specifies an error code. This parameter can be one of the following values as the type of error.

Value Meaning
SP_BAD_FW_ERROR Indicates the driver has detected bad or old firmware. The device will not be used.
SP_BAD_FW_WARNING Indicates the driver has detected a card with old or bad firmware, which can result in reduced performance or functionality.
SP_BUS_PARITY_ERROR Indicates a SCSI bus parity error was detected.
SP_BUS_TIME_OUT Indicates a SCSI bus connection to a logical unit timed out.
SP_INTERNAL_ADAPTER_ERROR Indicates an internal HBA error was detected.
SP_INVALID_RESELECTION Indicates a logical unit reselected unexpectedly or with an invalid queue tag.
SP_IRQ_NOT_RESPONDING Indicates the HBA is not interrupting when expected.
SP_PROTOCOL_ERROR Indicates the miniport driver detected a SCSI bus protocol error.
SP_REQUEST_TIMEOUT Indicates an operation to the controller has timed out.
SP_UNEXPECTED_DISCONNECT Indicates that a target disconnected unexpectedly.

UniqueId

[in] Specifies a unique identifier for the error. This value differentiates the current error from other errors with the same ErrorCode. For some miniport drivers, this identifies the line of code where the error was detected. For others, it is additional information returned by the HBA.

Return value

None

Remarks

A miniport driver should log all real hardware errors. However, it should not log common operational errors, such as selection time-outs or bus resets.

Requirements

Requirement Value
Target Platform Desktop
Header srb.h (include Miniport.h, Scsi.h)
Library Scsiport.lib

See also

ScsiPortNotification