srbhelper.h File Reference

#include <scsi.h>
#include <srb.h>

Include dependency graph for srbhelper.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	SRBHELPER_ASSERT   NT_ASSERT
#define	SRB_ALIGN_SIZEOF(x)   (((ULONG_PTR)(sizeof(x) + sizeof(PVOID) - 1)) & ~(sizeof(PVOID) - 1))
#define	SrbMoveMemory(Destination, Source, Length)   memmove(Destination, Source, Length)
#define	SrbCopyMemory(Destination, Source, Length)   memcpy(Destination, Source, Length)
#define	SrbZeroMemory(Destination, Length)   memset(Destination, 0, Length)
#define	SrbEqualMemory(Source1, Source2, Length)   (memcmp(Source1, Source2, Length) == 0)
#define	SrbSetRequestTag   SrbSetQueueTag
#define	SrbGetRequestTag   SrbGetQueueTag
#define	SrbGetQueueAction   SrbGetRequestAttribute
#define	SrbSetQueueAction   SrbSetRequestAttribute

Functions
FORCEINLINE PSRBEX_DATA	SrbGetSrbExDataByIndex (_In_ PSTORAGE_REQUEST_BLOCK Srb, _In_ ULONG SrbExDataIndex)
FORCEINLINE PSRBEX_DATA	SrbGetSrbExDataByType (_In_ PSTORAGE_REQUEST_BLOCK Srb, _In_ SRBEXDATATYPE Type)
FORCEINLINE PSRBEX_DATA	SrbGetPrimarySrbExData (_In_ PSTORAGE_REQUEST_BLOCK Srb)
FORCEINLINE PSTOR_ADDRESS	SrbGetAddress (_In_ PSTORAGE_REQUEST_BLOCK Srb)
FORCEINLINE BOOLEAN	SrbCopySrb (_In_ PVOID DestinationSrb, _In_ ULONG DestinationSrbLength, _In_ PVOID SourceSrb)
FORCEINLINE VOID	SrbZeroSrb (_In_ PVOID Srb)
FORCEINLINE ULONG	SrbGetSrbLength (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetSrbLength (_In_ PVOID Srb, _In_ ULONG Length)
FORCEINLINE ULONG	SrbGetDefaultSrbLengthFromFunction (_In_ ULONG SrbFunction)
FORCEINLINE PCDB	SrbGetScsiData (_In_ PSTORAGE_REQUEST_BLOCK SrbEx, _In_opt_ PUCHAR CdbLength8, _In_opt_ PULONG CdbLength32, _In_opt_ PUCHAR ScsiStatus, _In_opt_ PVOID *SenseInfoBuffer, _In_opt_ PUCHAR SenseInfoBufferLength)
FORCEINLINE VOID	SrbSetScsiData (_In_ PSTORAGE_REQUEST_BLOCK SrbEx, _In_opt_ PUCHAR CdbLength8, _In_opt_ PULONG CdbLength32, _In_opt_ PUCHAR ScsiStatus, _In_opt_ PVOID *SenseInfoBuffer, _In_opt_ PUCHAR SenseInfoBufferLength)
FORCEINLINE PCDB	SrbGetCdb (_In_ PVOID Srb)
FORCEINLINE ULONG	SrbGetSrbFunction (_In_ PVOID Srb)
FORCEINLINE PVOID	SrbGetSenseInfoBuffer (_In_ PVOID Srb)
FORCEINLINE UCHAR	SrbGetSenseInfoBufferLength (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetSenseInfoBuffer (_In_ PVOID Srb, _In_opt_ PVOID SenseInfoBuffer)
FORCEINLINE VOID	SrbSetSenseInfoBufferLength (_In_ PVOID Srb, _In_ UCHAR SenseInfoBufferLength)
FORCEINLINE PVOID	SrbGetOriginalRequest (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetOriginalRequest (_In_ PVOID Srb, _In_opt_ PVOID OriginalRequest)
FORCEINLINE PVOID	SrbGetDataBuffer (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetDataBuffer (_In_ PVOID Srb, _In_opt_ __drv_aliasesMem PVOID DataBuffer)
FORCEINLINE ULONG	SrbGetDataTransferLength (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetDataTransferLength (_In_ PVOID Srb, _In_ ULONG DataTransferLength)
FORCEINLINE ULONG	SrbGetTimeOutValue (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetTimeOutValue (_In_ PVOID Srb, _In_ ULONG TimeOutValue)
FORCEINLINE VOID	SrbSetQueueSortKey (_In_ PVOID Srb, _In_ ULONG QueueSortKey)
FORCEINLINE VOID	SrbSetQueueTag (_In_ PVOID Srb, _In_ ULONG QueueTag)
FORCEINLINE ULONG	SrbGetQueueTag (_In_ PVOID Srb)
FORCEINLINE PVOID	SrbGetNextSrb (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetNextSrb (_In_ PVOID Srb, _In_opt_ PVOID NextSrb)
FORCEINLINE ULONG	SrbGetSrbFlags (_In_ PVOID Srb)
FORCEINLINE VOID	SrbAssignSrbFlags (_In_ PVOID Srb, _In_ ULONG Flags)
FORCEINLINE VOID	SrbSetSrbFlags (_In_ PVOID Srb, _In_ ULONG Flags)
FORCEINLINE VOID	SrbClearSrbFlags (_In_ PVOID Srb, _In_ ULONG Flags)
FORCEINLINE ULONG	SrbGetSystemStatus (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetSystemStatus (_In_ PVOID Srb, _In_ ULONG Status)
FORCEINLINE UCHAR	SrbGetScsiStatus (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetScsiStatus (_In_ PVOID Srb, _In_ UCHAR ScsiStatus)
FORCEINLINE UCHAR	SrbGetCdbLength (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetCdbLength (_In_ PVOID Srb, _In_ UCHAR CdbLength)
FORCEINLINE ULONG	SrbGetRequestAttribute (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetRequestAttribute (_In_ PVOID Srb, _In_ UCHAR RequestAttribute)
FORCEINLINE UCHAR	SrbGetPathId (_In_ PVOID Srb)
FORCEINLINE UCHAR	SrbGetTargetId (_In_ PVOID Srb)
FORCEINLINE UCHAR	SrbGetLun (_In_ PVOID Srb)
FORCEINLINE VOID	SrbGetPathTargetLun (_In_ PVOID Srb, _In_opt_ PUCHAR PathId, _In_opt_ PUCHAR TargetId, _In_opt_ PUCHAR Lun)
FORCEINLINE PVOID	SrbGetMiniportContext (_In_ PVOID Srb)
FORCEINLINE UCHAR	SrbGetSrbStatus (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetSrbStatus (_In_ PVOID Srb, _In_ UCHAR status)
FORCEINLINE PVOID	SrbGetPortContext (_In_ PVOID Srb)
FORCEINLINE VOID	SrbSetPortContext (_In_ PVOID Srb, _In_ PVOID PortContext)

Macro Definition Documentation

SRB_ALIGN_SIZEOF

#define SRB_ALIGN_SIZEOF

(

x

)

(((ULONG_PTR)(sizeof(x) + sizeof(PVOID) - 1)) & ~(sizeof(PVOID) - 1))

Definition at line 16 of file srbhelper.h.

SrbCopyMemory

#define SrbCopyMemory	(		Destination,
			Source,
			Length
	)		memcpy(Destination, Source, Length)

Definition at line 30 of file srbhelper.h.

SrbEqualMemory

#define SrbEqualMemory	(		Source1,
			Source2,
			Length
	)		(memcmp(Source1, Source2, Length) == 0)

Definition at line 42 of file srbhelper.h.

SrbGetQueueAction

#define SrbGetQueueAction   SrbGetRequestAttribute

Definition at line 1135 of file srbhelper.h.

SrbGetRequestTag

#define SrbGetRequestTag   SrbGetQueueTag

Definition at line 896 of file srbhelper.h.

SRBHELPER_ASSERT

#define SRBHELPER_ASSERT   NT_ASSERT

Definition at line 12 of file srbhelper.h.

SrbMoveMemory

#define SrbMoveMemory	(		Destination,
			Source,
			Length
	)		memmove(Destination, Source, Length)

Definition at line 24 of file srbhelper.h.

SrbSetQueueAction

#define SrbSetQueueAction   SrbSetRequestAttribute

Definition at line 1155 of file srbhelper.h.

SrbSetRequestTag

#define SrbSetRequestTag   SrbSetQueueTag

Definition at line 877 of file srbhelper.h.

SrbZeroMemory

#define SrbZeroMemory	(		Destination,
			Length
	)		memset(Destination, 0, Length)

Definition at line 36 of file srbhelper.h.

Function Documentation

SrbAssignSrbFlags()

FORCEINLINE VOID SrbAssignSrbFlags	(	_In_ PVOID	Srb,
		_In_ ULONG	Flags
	)

Definition at line 954 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->SrbFlags = Flags;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->SrbFlags = Flags;
  }
}

Referenced by _IRQL_requires_max_(), _Success_(), ClassGetLBProvisioningLogPage(), ClasspDeviceGetBlockDeviceCharacteristicsVPDPage(), ClasspDeviceGetBlockLimitsVPDPage(), ClasspDeviceGetLBProvisioningVPDPage(), ClasspGetBlockDeviceTokenLimitsInfo(), ClasspGetInquiryVpdSupportInfo(), ClasspPowerDownCompletion(), ClasspPowerUpCompletion(), ClasspWriteCacheProperty(), ClassReadCapacity16(), ClassSendSrbSynchronous(), ClassSendStartUnit(), DeviceProcessDsmTrimRequest(), GetLBAStatus(), SetupDriveCapacityTransferPacket(), SetupEjectionTransferPacket(), SetupModeSelectTransferPacket(), SetupModeSenseTransferPacket(), and SetupReadWriteTransferPacket().

SrbClearSrbFlags()

FORCEINLINE VOID SrbClearSrbFlags	(	_In_ PVOID	Srb,
		_In_ ULONG	Flags
	)

Definition at line 990 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->SrbFlags &= ~Flags;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->SrbFlags &= ~Flags;
  }
}

Referenced by ClassIoComplete(), DeviceProcessDsmTrimRequest(), FREE_PORT_ALLOCATED_SENSE_BUFFER_EX(), RetryRequest(), and RetryTransferPacket().

SrbCopySrb()

FORCEINLINE BOOLEAN SrbCopySrb	(	_In_ PVOID	DestinationSrb,
		_In_ ULONG	DestinationSrbLength,
		_In_ PVOID	SourceSrb
	)

Definition at line 159 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK sourceSrb = (PSTORAGE_REQUEST_BLOCK)SourceSrb;
  BOOLEAN status = FALSE;
 
  if (sourceSrb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    if (DestinationSrbLength >= sourceSrb->SrbLength)
    {
      SrbCopyMemory(DestinationSrb, SourceSrb, sourceSrb->SrbLength);
      status = TRUE;
    }
  }
  else
  {
    if (DestinationSrbLength >= SCSI_REQUEST_BLOCK_SIZE)
    {
      SrbCopyMemory(DestinationSrb, SourceSrb, SCSI_REQUEST_BLOCK_SIZE);
      status = TRUE;
    }
  }
 
  return status;
}

SrbGetAddress()

FORCEINLINE PSTOR_ADDRESS SrbGetAddress

(

_In_ PSTORAGE_REQUEST_BLOCK

Srb

)

Definition at line 139 of file srbhelper.h.

{
  PSTOR_ADDRESS storAddr = NULL;
 
  if (Srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SRBHELPER_ASSERT(Srb->AddressOffset);
 
    if (Srb->AddressOffset)
    {
      storAddr = (PSTOR_ADDRESS)((PUCHAR)Srb + Srb->AddressOffset);
      SRBHELPER_ASSERT(storAddr->Type == STOR_ADDRESS_TYPE_BTL8);
    }
  }
 
  return storAddr;
}

Referenced by SrbGetLun(), SrbGetPathId(), SrbGetPathTargetLun(), and SrbGetTargetId().

SrbGetCdb()

FORCEINLINE PCDB SrbGetCdb

(

_In_ PVOID

Srb

)

Definition at line 591 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  PCDB pCdb = NULL;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return SrbGetScsiData(srb, NULL, NULL, NULL, NULL, NULL);
  }
  else
  {
    pCdb = (PCDB)((PSCSI_REQUEST_BLOCK)srb)->Cdb;
  }
  return pCdb;
}

SrbGetCdbLength()

FORCEINLINE UCHAR SrbGetCdbLength

(

_In_ PVOID

Srb

)

Definition at line 1082 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  UCHAR CdbLength = 0;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SrbGetScsiData(srb, &CdbLength, NULL, NULL, NULL, NULL);
  }
  else
  {
    CdbLength = ((PSCSI_REQUEST_BLOCK)srb)->CdbLength;
  }
  return CdbLength;
}

Referenced by ClassInterpretSenseInfo(), ClasspReceivePopulateTokenInformation(), and ClasspReceiveWriteUsingTokenInformation().

SrbGetDataBuffer()

FORCEINLINE PVOID SrbGetDataBuffer

(

_In_ PVOID

Srb

)

Definition at line 736 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  PVOID DataBuffer;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    DataBuffer = srb->DataBuffer;
  }
  else
  {
    DataBuffer = ((PSCSI_REQUEST_BLOCK)srb)->DataBuffer;
  }
  return DataBuffer;
}

Referenced by RetryRequest(), and SubmitTransferPacket().

SrbGetDataTransferLength()

FORCEINLINE ULONG SrbGetDataTransferLength

(

_In_ PVOID

Srb

)

Definition at line 773 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  ULONG DataTransferLength;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    DataTransferLength = srb->DataTransferLength;
  }
  else
  {
    DataTransferLength = ((PSCSI_REQUEST_BLOCK)srb)->DataTransferLength;
  }
  return DataTransferLength;
}

Referenced by ClassGetLBProvisioningLogPage(), ClassInterpretSenseInfo(), ClasspBuildRequestEx(), ClasspDeviceGetBlockDeviceCharacteristicsVPDPage(), ClasspDeviceGetBlockLimitsVPDPage(), ClasspDeviceGetLBProvisioningVPDPage(), ClasspGetBlockDeviceTokenLimitsInfo(), ClasspGetInquiryVpdSupportInfo(), ClassReadCapacity16(), GetLBAStatus(), RetryRequest(), SubmitTransferPacket(), and TransferPktComplete().

SrbGetDefaultSrbLengthFromFunction()

FORCEINLINE ULONG SrbGetDefaultSrbLengthFromFunction

(

_In_ ULONG

SrbFunction

)

Definition at line 246 of file srbhelper.h.

{
  switch (SrbFunction)
  {
  case SRB_FUNCTION_PNP:
    return SRB_ALIGN_SIZEOF(STORAGE_REQUEST_BLOCK) + SRB_ALIGN_SIZEOF(STOR_ADDR_BTL8) +
           SRB_ALIGN_SIZEOF(SRBEX_DATA_PNP);
  case SRB_FUNCTION_POWER:
    return SRB_ALIGN_SIZEOF(STORAGE_REQUEST_BLOCK) + SRB_ALIGN_SIZEOF(STOR_ADDR_BTL8) +
           SRB_ALIGN_SIZEOF(SRBEX_DATA_POWER);
  case SRB_FUNCTION_WMI:
    return SRB_ALIGN_SIZEOF(STORAGE_REQUEST_BLOCK) + SRB_ALIGN_SIZEOF(STOR_ADDR_BTL8) +
           SRB_ALIGN_SIZEOF(SRBEX_DATA_WMI);
  case SRB_FUNCTION_EXECUTE_SCSI:
    return SRB_ALIGN_SIZEOF(STORAGE_REQUEST_BLOCK) + SRB_ALIGN_SIZEOF(STOR_ADDR_BTL8) +
           SRB_ALIGN_SIZEOF(SRBEX_DATA_SCSI_CDB16);
  case SRB_FUNCTION_IO_CONTROL:
    return SRB_ALIGN_SIZEOF(STORAGE_REQUEST_BLOCK) + SRB_ALIGN_SIZEOF(STOR_ADDR_BTL8);
  default:
    return SRB_ALIGN_SIZEOF(STORAGE_REQUEST_BLOCK) + SRB_ALIGN_SIZEOF(STOR_ADDR_BTL8);
  }
}

SrbGetLun()

FORCEINLINE UCHAR SrbGetLun

(

_In_ PVOID

Srb

)

Definition at line 1225 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  UCHAR Lun = 0;
  PSTOR_ADDRESS storAddr = NULL;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    storAddr = (PSTOR_ADDRESS)SrbGetAddress(srb);
    if (storAddr)
    {
      switch (storAddr->Type)
      {
        case STOR_ADDRESS_TYPE_BTL8:
          Lun = ((PSTOR_ADDR_BTL8)storAddr)->Lun;
          break;
 
        default:
          SRBHELPER_ASSERT(FALSE);
          break;
      }
    }
  }
  else
  {
    Lun = ((PSCSI_REQUEST_BLOCK)srb)->Lun;
  }
  return Lun;
}

Referenced by ClassInterpretSenseInfo().

SrbGetMiniportContext()

FORCEINLINE PVOID SrbGetMiniportContext

(

_In_ PVOID

Srb

)

Definition at line 1321 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return srb->MiniportContext;
  }
  else
  {
    return ((PSCSI_REQUEST_BLOCK)srb)->SrbExtension;
  }
}

SrbGetNextSrb()

FORCEINLINE PVOID SrbGetNextSrb

(

_In_ PVOID

Srb

)

Definition at line 900 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return (PVOID)srb->NextSrb;
  }
  else
  {
    return (PVOID)((PSCSI_REQUEST_BLOCK)srb)->NextSrb;
  }
}

SrbGetOriginalRequest()

FORCEINLINE PVOID SrbGetOriginalRequest

(

_In_ PVOID

Srb

)

Definition at line 701 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return srb->OriginalRequest;
  }
  else
  {
    return ((PSCSI_REQUEST_BLOCK)srb)->OriginalRequest;
  }
}

SrbGetPathId()

FORCEINLINE UCHAR SrbGetPathId

(

_In_ PVOID

Srb

)

Definition at line 1159 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  UCHAR PathId = 0;
  PSTOR_ADDRESS storAddr = NULL;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    storAddr = (PSTOR_ADDRESS)SrbGetAddress(srb);
    if (storAddr)
    {
      switch (storAddr->Type)
      {
        case STOR_ADDRESS_TYPE_BTL8:
          PathId = ((PSTOR_ADDR_BTL8)storAddr)->Path;
          break;
 
        default:
          SRBHELPER_ASSERT(FALSE);
          break;
      }
    }
  }
  else
  {
    PathId = ((PSCSI_REQUEST_BLOCK)srb)->PathId;
  }
  return PathId;
}

Referenced by ClassInterpretSenseInfo().

SrbGetPathTargetLun()

FORCEINLINE VOID SrbGetPathTargetLun	(	_In_ PVOID	Srb,
		_In_opt_ PUCHAR	PathId,
		_In_opt_ PUCHAR	TargetId,
		_In_opt_ PUCHAR	Lun
	)

Definition at line 1258 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  PSTOR_ADDRESS storAddr = NULL;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    storAddr = (PSTOR_ADDRESS)SrbGetAddress(srb);
    if (storAddr)
    {
      switch (storAddr->Type)
      {
        case STOR_ADDRESS_TYPE_BTL8:
          if (PathId != NULL)
          {
            *PathId = ((PSTOR_ADDR_BTL8)storAddr)->Path;
          }
 
          if (TargetId != NULL)
          {
            *TargetId = ((PSTOR_ADDR_BTL8)storAddr)->Target;
          }
 
          if (Lun != NULL)
          {
            *Lun = ((PSTOR_ADDR_BTL8)storAddr)->Lun;
          }
 
          break;
 
        default:
          SRBHELPER_ASSERT(FALSE);
          break;
      }
    }
  }
  else
  {
    if (PathId != NULL)
    {
      *PathId = ((PSCSI_REQUEST_BLOCK)srb)->PathId;
    }
 
    if (TargetId != NULL)
    {
      *TargetId = ((PSCSI_REQUEST_BLOCK)srb)->TargetId;
    }
 
    if (Lun != NULL)
    {
      *Lun = ((PSCSI_REQUEST_BLOCK)srb)->Lun;
    }
  }
 
  return;
}

SrbGetPortContext()

FORCEINLINE PVOID SrbGetPortContext

(

_In_ PVOID

Srb

)

Definition at line 1387 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return srb->PortContext;
  }
  else
  {
    SRBHELPER_ASSERT(FALSE);
    return NULL;
  }
}

SrbGetPrimarySrbExData()

FORCEINLINE PSRBEX_DATA SrbGetPrimarySrbExData

(

_In_ PSTORAGE_REQUEST_BLOCK

Srb

)

Definition at line 94 of file srbhelper.h.

{
  if (Srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    switch (Srb->SrbFunction)
    {
    case SRB_FUNCTION_POWER:
      return SrbGetSrbExDataByType(Srb, SrbExDataTypePower);
 
    case SRB_FUNCTION_PNP:
      return SrbGetSrbExDataByType(Srb, SrbExDataTypePnP);
 
    case SRB_FUNCTION_WMI:
      return SrbGetSrbExDataByType(Srb, SrbExDataTypeWmi);
 
    case SRB_FUNCTION_EXECUTE_SCSI: {
      PSRBEX_DATA srbExData = NULL;
      UCHAR i = 0;
 
      for (i = 0; i < Srb->NumSrbExData; i++)
      {
        if (Srb->SrbExDataOffset[i] >= sizeof(STORAGE_REQUEST_BLOCK) &&
            Srb->SrbExDataOffset[i] < Srb->SrbLength)
        {
          srbExData = (PSRBEX_DATA)((PUCHAR)Srb + Srb->SrbExDataOffset[i]);
          if (srbExData->Type == SrbExDataTypeScsiCdb16 ||
              srbExData->Type == SrbExDataTypeScsiCdb32 ||
              srbExData->Type == SrbExDataTypeScsiCdbVar)
          {
            return srbExData;
          }
        }
      }
      return NULL;
    }
 
    default:
      return NULL;
    }
  }
 
  return NULL;
}

SrbGetQueueTag()

FORCEINLINE ULONG SrbGetQueueTag

(

_In_ PVOID

Srb

)

Definition at line 881 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return srb->RequestTag;
  }
  else
  {
    return ((PSCSI_REQUEST_BLOCK)srb)->QueueTag;
  }
}

SrbGetRequestAttribute()

FORCEINLINE ULONG SrbGetRequestAttribute

(

_In_ PVOID

Srb

)

Definition at line 1119 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  ULONG RequestAttribute;
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    RequestAttribute = srb->RequestAttribute;
  }
  else
  {
    RequestAttribute = ((PSCSI_REQUEST_BLOCK)srb)->QueueAction;
  }
  return RequestAttribute;
}

Referenced by _Success_().

SrbGetScsiData()

FORCEINLINE PCDB SrbGetScsiData	(	_In_ PSTORAGE_REQUEST_BLOCK	SrbEx,
		_In_opt_ PUCHAR	CdbLength8,
		_In_opt_ PULONG	CdbLength32,
		_In_opt_ PUCHAR	ScsiStatus,
		_In_opt_ PVOID *	SenseInfoBuffer,
		_In_opt_ PUCHAR	SenseInfoBufferLength
	)

Definition at line 272 of file srbhelper.h.

{
  PCDB Cdb = NULL;
  ULONG i;
  PSRBEX_DATA SrbExData = NULL;
  BOOLEAN FoundEntry = FALSE;
 
  if ((SrbEx->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK) &&
      (SrbEx->SrbFunction == SRB_FUNCTION_EXECUTE_SCSI))
  {
    SRBHELPER_ASSERT(SrbEx->NumSrbExData > 0);
 
    for (i = 0; i < SrbEx->NumSrbExData; i++)
    {
      if ((SrbEx->SrbExDataOffset[i] < sizeof(STORAGE_REQUEST_BLOCK)) ||
          (SrbEx->SrbExDataOffset[i] >= SrbEx->SrbLength))
      {
        SRBHELPER_ASSERT(FALSE);
        continue;
      }
 
      SrbExData = (PSRBEX_DATA)((PUCHAR)SrbEx + SrbEx->SrbExDataOffset[i]);
 
      switch (SrbExData->Type)
      {
          case SrbExDataTypeScsiCdb16:
            if (SrbEx->SrbExDataOffset[i] + sizeof(SRBEX_DATA_SCSI_CDB16) <= SrbEx->SrbLength)
            {
              FoundEntry = TRUE;
              if (CdbLength8)
              {
                *CdbLength8 = ((PSRBEX_DATA_SCSI_CDB16)SrbExData)->CdbLength;
              }
 
              if (((PSRBEX_DATA_SCSI_CDB16)SrbExData)->CdbLength > 0)
              {
                Cdb = (PCDB)((PSRBEX_DATA_SCSI_CDB16)SrbExData)->Cdb;
              }
 
              if (ScsiStatus)
              {
                *ScsiStatus = ((PSRBEX_DATA_SCSI_CDB16)SrbExData)->ScsiStatus;
              }
 
              if (SenseInfoBuffer)
              {
                *SenseInfoBuffer = ((PSRBEX_DATA_SCSI_CDB16)SrbExData)->SenseInfoBuffer;
              }
 
              if (SenseInfoBufferLength)
              {
                *SenseInfoBufferLength = ((PSRBEX_DATA_SCSI_CDB16)SrbExData)->SenseInfoBufferLength;
              }
            }
            else
            {
              // Catch invalid offset
              SRBHELPER_ASSERT(FALSE);
            }
            break;
 
          case SrbExDataTypeScsiCdb32:
            if (SrbEx->SrbExDataOffset[i] + sizeof(SRBEX_DATA_SCSI_CDB32) <= SrbEx->SrbLength)
            {
              FoundEntry = TRUE;
              if (CdbLength8)
              {
                *CdbLength8 = ((PSRBEX_DATA_SCSI_CDB32)SrbExData)->CdbLength;
              }
 
              if (((PSRBEX_DATA_SCSI_CDB32)SrbExData)->CdbLength > 0)
              {
                Cdb = (PCDB)((PSRBEX_DATA_SCSI_CDB32)SrbExData)->Cdb;
              }
 
              if (ScsiStatus)
              {
                *ScsiStatus = ((PSRBEX_DATA_SCSI_CDB32)SrbExData)->ScsiStatus;
              }
 
              if (SenseInfoBuffer)
              {
                *SenseInfoBuffer = ((PSRBEX_DATA_SCSI_CDB32)SrbExData)->SenseInfoBuffer;
              }
 
              if (SenseInfoBufferLength)
              {
                *SenseInfoBufferLength = ((PSRBEX_DATA_SCSI_CDB32)SrbExData)->SenseInfoBufferLength;
              }
            }
            else
            {
              // Catch invalid offset
              SRBHELPER_ASSERT(FALSE);
            }
            break;
 
          case SrbExDataTypeScsiCdbVar:
            if (SrbEx->SrbExDataOffset[i] + sizeof(SRBEX_DATA_SCSI_CDB_VAR) <= SrbEx->SrbLength)
            {
              FoundEntry = TRUE;
              if (CdbLength32)
              {
                *CdbLength32 = ((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->CdbLength;
              }
 
              if (((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->CdbLength > 0)
              {
                Cdb = (PCDB)((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->Cdb;
              }
 
              if (ScsiStatus)
              {
                *ScsiStatus = ((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->ScsiStatus;
              }
 
              if (SenseInfoBuffer)
              {
                *SenseInfoBuffer = ((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->SenseInfoBuffer;
              }
 
              if (SenseInfoBufferLength)
              {
                *SenseInfoBufferLength = ((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->SenseInfoBufferLength;
              }
            }
            else
            {
              SRBHELPER_ASSERT(FALSE);
            }
            break;
 
          default:
            /* Nothing else carries a command */
            break;
      }
 
      if (FoundEntry)
      {
        break;
      }
    }
  }
  else
  {
 
    if (CdbLength8)
    {
      *CdbLength8 = 0;
    }
 
    if (CdbLength32)
    {
      *CdbLength32 = 0;
    }
 
    if (ScsiStatus)
    {
      *ScsiStatus = SCSISTAT_GOOD;
    }
 
    if (SenseInfoBuffer)
    {
      *SenseInfoBuffer = NULL;
    }
 
    if (SenseInfoBufferLength)
    {
      *SenseInfoBufferLength = 0;
    }
  }
 
  return Cdb;
}

Referenced by SrbGetCdb(), SrbGetCdbLength(), SrbGetScsiStatus(), SrbGetSenseInfoBuffer(), and SrbGetSenseInfoBufferLength().

SrbGetScsiStatus()

FORCEINLINE UCHAR SrbGetScsiStatus

(

_In_ PVOID

Srb

)

Definition at line 1045 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  UCHAR scsiStatus = 0;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SrbGetScsiData(srb, NULL, NULL, &scsiStatus, NULL, NULL);
  }
  else
  {
    scsiStatus = ((PSCSI_REQUEST_BLOCK)srb)->ScsiStatus;
  }
  return scsiStatus;
}

Referenced by ClassInterpretSenseInfo().

SrbGetSenseInfoBuffer()

FORCEINLINE PVOID SrbGetSenseInfoBuffer

(

_In_ PVOID

Srb

)

Definition at line 627 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  PVOID pSenseInfoBuffer = NULL;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SrbGetScsiData(srb, NULL, NULL, NULL, &pSenseInfoBuffer, NULL);
  }
  else
  {
    pSenseInfoBuffer = ((PSCSI_REQUEST_BLOCK)srb)->SenseInfoBuffer;
  }
  return pSenseInfoBuffer;
}

Referenced by ClassInterpretSenseInfo(), ClasspIsThinProvisioningError(), ClasspMediaChangeDetectionCompletion(), ClasspPowerDownCompletion(), ClasspTransferPacketGetSenseInfoBuffer(), DbgGetAdditionalSenseCodeQualifierStr(), DbgGetAdditionalSenseCodeStr(), DbgGetSenseCodeStr(), FREE_PORT_ALLOCATED_SENSE_BUFFER_EX(), PORT_ALLOCATED_SENSE_EX(), TransferPacketRetryTimerDpc(), and TransferPktComplete().

SrbGetSenseInfoBufferLength()

FORCEINLINE UCHAR SrbGetSenseInfoBufferLength

(

_In_ PVOID

Srb

)

Definition at line 646 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  UCHAR SenseInfoBufferLength = 0;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SrbGetScsiData(srb, NULL, NULL, NULL, NULL, &SenseInfoBufferLength);
  }
  else
  {
    SenseInfoBufferLength = ((PSCSI_REQUEST_BLOCK)srb)->SenseInfoBufferLength;
  }
  return SenseInfoBufferLength;
}

Referenced by ClassInterpretSenseInfo(), ClasspIsThinProvisioningError(), ClasspMediaChangeDetectionCompletion(), ClasspPowerDownCompletion(), ClasspTransferPacketGetSenseInfoBufferLength(), ClassSendSrbSynchronous(), DbgGetAdditionalSenseCodeQualifierStr(), DbgGetAdditionalSenseCodeStr(), DbgGetSenseCodeStr(), InterpretTransferPacketError(), TransferPacketRetryTimerDpc(), and TransferPktComplete().

SrbGetSrbExDataByIndex()

FORCEINLINE PSRBEX_DATA SrbGetSrbExDataByIndex	(	_In_ PSTORAGE_REQUEST_BLOCK	Srb,
		_In_ ULONG	SrbExDataIndex
	)

Definition at line 47 of file srbhelper.h.

{
  PSRBEX_DATA srbExData = NULL;
 
  if ((Srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK) &&
      (SrbExDataIndex < Srb->NumSrbExData) && (Srb->SrbExDataOffset[SrbExDataIndex]) &&
      (Srb->SrbExDataOffset[SrbExDataIndex] >= sizeof(STORAGE_REQUEST_BLOCK)) &&
      (Srb->SrbExDataOffset[SrbExDataIndex] < Srb->SrbLength))
  {
    srbExData = (PSRBEX_DATA)((PUCHAR)Srb + Srb->SrbExDataOffset[SrbExDataIndex]);
  }
 
  return srbExData;
}

SrbGetSrbExDataByType()

FORCEINLINE PSRBEX_DATA SrbGetSrbExDataByType	(	_In_ PSTORAGE_REQUEST_BLOCK	Srb,
		_In_ SRBEXDATATYPE	Type
	)

Definition at line 66 of file srbhelper.h.

{
  if ((Srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK) && (Srb->NumSrbExData > 0))
  {
    PSRBEX_DATA srbExData = NULL;
    UCHAR i = 0;
 
    for (i = 0; i < Srb->NumSrbExData; i++)
    {
      if (Srb->SrbExDataOffset[i] >= sizeof(STORAGE_REQUEST_BLOCK) &&
          Srb->SrbExDataOffset[i] < Srb->SrbLength)
      {
        srbExData = (PSRBEX_DATA)((PUCHAR)Srb + Srb->SrbExDataOffset[i]);
        if (srbExData->Type == Type)
        {
          return srbExData;
        }
      }
    }
  }
 
  return NULL;
}

Referenced by SrbGetPrimarySrbExData().

SrbGetSrbFlags()

FORCEINLINE ULONG SrbGetSrbFlags

(

_In_ PVOID

Srb

)

Definition at line 935 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  ULONG srbFlags;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srbFlags = srb->SrbFlags;
  }
  else
  {
    srbFlags = ((PSCSI_REQUEST_BLOCK)srb)->SrbFlags;
  }
  return srbFlags;
}

Referenced by _Success_(), ClassFreeOrReuseSrb(), ClassInterpretSenseInfo(), ClasspPowerDownCompletion(), ClasspPowerHandler(), ClasspPowerUpCompletion(), FREE_PORT_ALLOCATED_SENSE_BUFFER_EX(), PORT_ALLOCATED_SENSE_EX(), RetryPowerRequest(), RetryRequest(), and TransferPktComplete().

SrbGetSrbFunction()

FORCEINLINE ULONG SrbGetSrbFunction

(

_In_ PVOID

Srb

)

Definition at line 610 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return srb->SrbFunction;
  }
  else
  {
    return (ULONG)((PSCSI_REQUEST_BLOCK)srb)->Function;
  }
}

SrbGetSrbLength()

FORCEINLINE ULONG SrbGetSrbLength

(

_In_ PVOID

Srb

)

Definition at line 215 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return srb->SrbLength;
  }
  else
  {
    return sizeof(SCSI_REQUEST_BLOCK);
  }
}

SrbGetSrbStatus()

FORCEINLINE UCHAR SrbGetSrbStatus

(

_In_ PVOID

Srb

)

Definition at line 1338 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    return srb->SrbStatus;
  }
  else
  {
    return ((PSCSI_REQUEST_BLOCK)srb)->SrbStatus;
  }
}

SrbGetSystemStatus()

FORCEINLINE ULONG SrbGetSystemStatus

(

_In_ PVOID

Srb

)

Definition at line 1008 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  ULONG systemStatus;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    systemStatus = srb->SystemStatus;
  }
  else
  {
    systemStatus = ((PSCSI_REQUEST_BLOCK)srb)->InternalStatus;
  }
  return systemStatus;
}

Referenced by ClassInterpretSenseInfo().

SrbGetTargetId()

FORCEINLINE UCHAR SrbGetTargetId

(

_In_ PVOID

Srb

)

Definition at line 1192 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  UCHAR TargetId = 0;
  PSTOR_ADDRESS storAddr = NULL;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    storAddr = (PSTOR_ADDRESS)SrbGetAddress(srb);
    if (storAddr)
    {
      switch (storAddr->Type)
      {
        case STOR_ADDRESS_TYPE_BTL8:
          TargetId = ((PSTOR_ADDR_BTL8)storAddr)->Target;
          break;
 
        default:
          SRBHELPER_ASSERT(FALSE);
          break;
      }
    }
  }
  else
  {
    TargetId = ((PSCSI_REQUEST_BLOCK)srb)->TargetId;
  }
  return TargetId;
}

Referenced by ClassInterpretSenseInfo().

SrbGetTimeOutValue()

FORCEINLINE ULONG SrbGetTimeOutValue

(

_In_ PVOID

Srb

)

Definition at line 810 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  ULONG timeOutValue;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    timeOutValue = srb->TimeOutValue;
  }
  else
  {
    timeOutValue = ((PSCSI_REQUEST_BLOCK)srb)->TimeOutValue;
  }
  return timeOutValue;
}

SrbSetCdbLength()

FORCEINLINE VOID SrbSetCdbLength	(	_In_ PVOID	Srb,
		_In_ UCHAR	CdbLength
	)

Definition at line 1101 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SrbSetScsiData(srb, &CdbLength, NULL, NULL, NULL, NULL);
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->CdbLength = CdbLength;
  }
}

Referenced by _IRQL_requires_max_(), ClassDeviceControl(), ClassDeviceHwFirmwareActivateProcess(), ClassDeviceHwFirmwareDownloadProcess(), ClassGetLBProvisioningLogPage(), ClassInterpretSenseInfo(), ClasspBuildRequestEx(), ClasspCleanupProtectedLocks(), ClasspDeviceGetBlockDeviceCharacteristicsVPDPage(), ClasspDeviceGetBlockLimitsVPDPage(), ClasspDeviceGetLBProvisioningVPDPage(), ClasspEjectionControl(), ClasspGetBlockDeviceTokenLimitsInfo(), ClasspGetInquiryVpdSupportInfo(), ClasspInterpretGesnData(), ClasspPersistentReserve(), ClasspPowerDownCompletion(), ClasspPowerUpCompletion(), ClasspPrepareMcnIrp(), ClasspWriteCacheProperty(), ClassReadCapacity16(), ClassSendStartUnit(), DeviceProcessDsmTrimRequest(), GetLBAStatus(), InitializeTransferPackets(), SetupDriveCapacityTransferPacket(), SetupEjectionTransferPacket(), SetupModeSelectTransferPacket(), SetupModeSenseTransferPacket(), and SetupReadWriteTransferPacket().

SrbSetDataBuffer()

FORCEINLINE VOID SrbSetDataBuffer	(	_In_ PVOID	Srb,
		_In_opt_ __drv_aliasesMem PVOID	DataBuffer
	)

Definition at line 755 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->DataBuffer = DataBuffer;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->DataBuffer = DataBuffer;
  }
}

Referenced by _IRQL_requires_max_(), _Success_(), ClasspBuildRequestEx(), ClassSendSrbSynchronous(), RetryTransferPacket(), SetupDriveCapacityTransferPacket(), SetupModeSelectTransferPacket(), SetupModeSenseTransferPacket(), and SetupReadWriteTransferPacket().

SrbSetDataTransferLength()

FORCEINLINE VOID SrbSetDataTransferLength	(	_In_ PVOID	Srb,
		_In_ ULONG	DataTransferLength
	)

Definition at line 792 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->DataTransferLength = DataTransferLength;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->DataTransferLength = DataTransferLength;
  }
}

Referenced by _IRQL_requires_max_(), _Success_(), ClasspBuildRequestEx(), ClassSendSrbSynchronous(), RetryPowerRequest(), RetryRequest(), RetryTransferPacket(), SetupDriveCapacityTransferPacket(), SetupModeSelectTransferPacket(), SetupModeSenseTransferPacket(), and SetupReadWriteTransferPacket().

SrbSetNextSrb()

FORCEINLINE VOID SrbSetNextSrb	(	_In_ PVOID	Srb,
		_In_opt_ PVOID	NextSrb
	)

Definition at line 917 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->NextSrb = (PSTORAGE_REQUEST_BLOCK)NextSrb;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->NextSrb = (PSCSI_REQUEST_BLOCK)NextSrb;
  }
}

Referenced by _Success_(), and ClassSendSrbSynchronous().

SrbSetOriginalRequest()

FORCEINLINE VOID SrbSetOriginalRequest	(	_In_ PVOID	Srb,
		_In_opt_ PVOID	OriginalRequest
	)

Definition at line 718 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->OriginalRequest = OriginalRequest;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->OriginalRequest = OriginalRequest;
  }
}

Referenced by _IRQL_requires_max_(), _Success_(), ClasspBuildRequestEx(), ClasspPowerDownCompletion(), ClasspPowerHandler(), ClasspPowerUpCompletion(), ClasspReleaseQueue(), ClassSendSrbSynchronous(), ClassSendStartUnit(), SetupDriveCapacityTransferPacket(), SetupEjectionTransferPacket(), SetupModeSelectTransferPacket(), SetupModeSenseTransferPacket(), and SetupReadWriteTransferPacket().

SrbSetPortContext()

FORCEINLINE VOID SrbSetPortContext	(	_In_ PVOID	Srb,
		_In_ PVOID	PortContext
	)

Definition at line 1405 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->PortContext = PortContext;
  }
  else
  {
    SRBHELPER_ASSERT(FALSE);
  }
}

SrbSetQueueSortKey()

FORCEINLINE VOID SrbSetQueueSortKey	(	_In_ PVOID	Srb,
		_In_ ULONG	QueueSortKey
	)

Definition at line 847 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function != SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    ((PSCSI_REQUEST_BLOCK)srb)->QueueSortKey = QueueSortKey;
  }
}

Referenced by ClasspBuildRequestEx(), and SetupReadWriteTransferPacket().

SrbSetQueueTag()

FORCEINLINE VOID SrbSetQueueTag	(	_In_ PVOID	Srb,
		_In_ ULONG	QueueTag
	)

Definition at line 861 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->RequestTag = QueueTag;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->QueueTag = (UCHAR)QueueTag;
  }
}

Referenced by RetryRequest().

SrbSetRequestAttribute()

FORCEINLINE VOID SrbSetRequestAttribute	(	_In_ PVOID	Srb,
		_In_ UCHAR	RequestAttribute
	)

Definition at line 1139 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->RequestAttribute = RequestAttribute;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->QueueAction = RequestAttribute;
  }
}

Referenced by _IRQL_requires_max_(), ClassDeviceControl(), ClassDeviceHwFirmwareDownloadProcess(), ClassGetLBProvisioningLogPage(), ClasspBuildRequestEx(), ClasspDeviceGetBlockDeviceCharacteristicsVPDPage(), ClasspDeviceGetBlockLimitsVPDPage(), ClasspDeviceGetLBProvisioningVPDPage(), ClasspGetBlockDeviceTokenLimitsInfo(), ClasspGetInquiryVpdSupportInfo(), ClasspPersistentReserve(), ClasspWriteCacheProperty(), ClassReadCapacity16(), ClassSendSrbSynchronous(), DeviceProcessDsmTrimRequest(), GetLBAStatus(), InitializeTransferPackets(), SetupDriveCapacityTransferPacket(), SetupEjectionTransferPacket(), SetupModeSelectTransferPacket(), and SetupModeSenseTransferPacket().

SrbSetScsiData()

FORCEINLINE VOID SrbSetScsiData	(	_In_ PSTORAGE_REQUEST_BLOCK	SrbEx,
		_In_opt_ PUCHAR	CdbLength8,
		_In_opt_ PULONG	CdbLength32,
		_In_opt_ PUCHAR	ScsiStatus,
		_In_opt_ PVOID *	SenseInfoBuffer,
		_In_opt_ PUCHAR	SenseInfoBufferLength
	)

Definition at line 455 of file srbhelper.h.

{
  ULONG i;
  PSRBEX_DATA SrbExData = NULL;
  BOOLEAN FoundEntry = FALSE;
 
  if ((SrbEx->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK) &&
      (SrbEx->SrbFunction == SRB_FUNCTION_EXECUTE_SCSI))
  {
    SRBHELPER_ASSERT(SrbEx->NumSrbExData > 0);
 
    for (i = 0; i < SrbEx->NumSrbExData; i++)
    {
      if ((SrbEx->SrbExDataOffset[i] < sizeof(STORAGE_REQUEST_BLOCK)) ||
          (SrbEx->SrbExDataOffset[i] >= SrbEx->SrbLength))
      {
        SRBHELPER_ASSERT(FALSE);
        continue;
      }
 
      SrbExData = (PSRBEX_DATA)((PUCHAR)SrbEx + SrbEx->SrbExDataOffset[i]);
 
      switch (SrbExData->Type)
      {
          case SrbExDataTypeScsiCdb16:
            if (SrbEx->SrbExDataOffset[i] + sizeof(SRBEX_DATA_SCSI_CDB16) <= SrbEx->SrbLength)
            {
              FoundEntry = TRUE;
              if (CdbLength8)
              {
                ((PSRBEX_DATA_SCSI_CDB16)SrbExData)->CdbLength = *CdbLength8;
              }
 
              if (ScsiStatus)
              {
                ((PSRBEX_DATA_SCSI_CDB16)SrbExData)->ScsiStatus = *ScsiStatus;
              }
 
              if (SenseInfoBuffer)
              {
                ((PSRBEX_DATA_SCSI_CDB16)SrbExData)->SenseInfoBuffer = *SenseInfoBuffer;
              }
 
              if (SenseInfoBufferLength)
              {
                ((PSRBEX_DATA_SCSI_CDB16)SrbExData)->SenseInfoBufferLength = *SenseInfoBufferLength;
              }
            }
            else
            {
              // Catch invalid offset
              SRBHELPER_ASSERT(FALSE);
            }
            break;
 
          case SrbExDataTypeScsiCdb32:
            if (SrbEx->SrbExDataOffset[i] + sizeof(SRBEX_DATA_SCSI_CDB32) <= SrbEx->SrbLength)
            {
              FoundEntry = TRUE;
              if (CdbLength8)
              {
                ((PSRBEX_DATA_SCSI_CDB32)SrbExData)->CdbLength = *CdbLength8;
              }
 
              if (ScsiStatus)
              {
                ((PSRBEX_DATA_SCSI_CDB32)SrbExData)->ScsiStatus = *ScsiStatus;
              }
 
              if (SenseInfoBuffer)
              {
                ((PSRBEX_DATA_SCSI_CDB32)SrbExData)->SenseInfoBuffer = *SenseInfoBuffer;
              }
 
              if (SenseInfoBufferLength)
              {
                ((PSRBEX_DATA_SCSI_CDB32)SrbExData)->SenseInfoBufferLength = *SenseInfoBufferLength;
              }
            }
            else
            {
              SRBHELPER_ASSERT(FALSE);
            }
            break;
 
          case SrbExDataTypeScsiCdbVar:
            if (SrbEx->SrbExDataOffset[i] + sizeof(SRBEX_DATA_SCSI_CDB_VAR) <= SrbEx->SrbLength)
            {
              FoundEntry = TRUE;
              if (CdbLength32)
              {
                ((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->CdbLength = *CdbLength32;
              }
 
              if (ScsiStatus)
              {
                ((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->ScsiStatus = *ScsiStatus;
              }
 
              if (SenseInfoBuffer)
              {
                ((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->SenseInfoBuffer = *SenseInfoBuffer;
              }
 
              if (SenseInfoBufferLength)
              {
                ((PSRBEX_DATA_SCSI_CDB_VAR)SrbExData)->SenseInfoBufferLength = *SenseInfoBufferLength;
              }
            }
            else
            {
              SRBHELPER_ASSERT(FALSE);
            }
            break;
 
          default:
            /* Nothing else carries a command */
            break;
      }
 
      if (FoundEntry)
      {
        break;
      }
    }
  }
}

Referenced by SrbSetCdbLength(), SrbSetScsiStatus(), SrbSetSenseInfoBuffer(), and SrbSetSenseInfoBufferLength().

SrbSetScsiStatus()

FORCEINLINE VOID SrbSetScsiStatus	(	_In_ PVOID	Srb,
		_In_ UCHAR	ScsiStatus
	)

Definition at line 1064 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SrbSetScsiData(srb, NULL, NULL, &ScsiStatus, NULL, NULL);
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->ScsiStatus = ScsiStatus;
  }
}

Referenced by _Success_(), ClasspPrepareMcnIrp(), ClasspReceivePopulateTokenInformationTransferPacketDone(), ClasspReceiveWriteUsingTokenInformationTransferPacketDone(), ClassSendSrbSynchronous(), RetryPowerRequest(), RetryRequest(), and SubmitTransferPacket().

SrbSetSenseInfoBuffer()

FORCEINLINE VOID SrbSetSenseInfoBuffer	(	_In_ PVOID	Srb,
		_In_opt_ PVOID	SenseInfoBuffer
	)

Definition at line 665 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SrbSetScsiData(srb, NULL, NULL, NULL, &SenseInfoBuffer, NULL);
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->SenseInfoBuffer = SenseInfoBuffer;
  }
}

Referenced by _IRQL_requires_max_(), _Success_(), ClasspBuildRequestEx(), ClasspInterpretGesnData(), ClasspPowerDownCompletion(), ClasspPowerUpCompletion(), ClasspPrepareMcnIrp(), ClasspReceivePopulateTokenInformationTransferPacketDone(), ClasspReceiveWriteUsingTokenInformationTransferPacketDone(), ClassSendSrbSynchronous(), FREE_PORT_ALLOCATED_SENSE_BUFFER_EX(), SetupDriveCapacityTransferPacket(), SetupEjectionTransferPacket(), SetupModeSelectTransferPacket(), SetupModeSenseTransferPacket(), SetupReadWriteTransferPacket(), TransferPacketRetryTimerDpc(), and TransferPktComplete().

SrbSetSenseInfoBufferLength()

FORCEINLINE VOID SrbSetSenseInfoBufferLength	(	_In_ PVOID	Srb,
		_In_ UCHAR	SenseInfoBufferLength
	)

Definition at line 683 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    SrbSetScsiData(srb, NULL, NULL, NULL, NULL, &SenseInfoBufferLength);
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->SenseInfoBufferLength = SenseInfoBufferLength;
  }
}

Referenced by _IRQL_requires_max_(), _Success_(), ClasspBuildRequestEx(), ClasspInterpretGesnData(), ClasspPowerDownCompletion(), ClasspPowerUpCompletion(), ClasspPrepareMcnIrp(), ClasspReceivePopulateTokenInformationTransferPacketDone(), ClasspReceiveWriteUsingTokenInformationTransferPacketDone(), ClassSendSrbSynchronous(), FREE_PORT_ALLOCATED_SENSE_BUFFER_EX(), InitializeTransferPackets(), SetupDriveCapacityTransferPacket(), SetupEjectionTransferPacket(), SetupModeSelectTransferPacket(), SetupModeSenseTransferPacket(), SubmitTransferPacket(), TransferPacketRetryTimerDpc(), and TransferPktComplete().

SrbSetSrbFlags()

FORCEINLINE VOID SrbSetSrbFlags	(	_In_ PVOID	Srb,
		_In_ ULONG	Flags
	)

Definition at line 972 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->SrbFlags |= Flags;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->SrbFlags |= Flags;
  }
}

Referenced by _Success_(), ClassDeviceControl(), ClassDeviceHwFirmwareDownloadProcess(), ClasspBuildRequestEx(), ClasspPersistentReserve(), ClasspPowerHandler(), ClasspPowerUpCompletion(), ClassSendSrbSynchronous(), DeviceProcessDsmTrimRequest(), RetryRequest(), RetryTransferPacket(), and SetupReadWriteTransferPacket().

SrbSetSrbLength()

FORCEINLINE VOID SrbSetSrbLength	(	_In_ PVOID	Srb,
		_In_ ULONG	Length
	)

Definition at line 232 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->SrbLength = Length;
  }
}

SrbSetSrbStatus()

FORCEINLINE VOID SrbSetSrbStatus	(	_In_ PVOID	Srb,
		_In_ UCHAR	status
	)

Definition at line 1355 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    if (srb->SrbStatus & SRB_STATUS_AUTOSENSE_VALID)
    {
      srb->SrbStatus = status | SRB_STATUS_AUTOSENSE_VALID;
    }
    else
    {
      srb->SrbStatus = status;
    }
  }
  else
  {
    if (((PSCSI_REQUEST_BLOCK)srb)->SrbStatus & SRB_STATUS_AUTOSENSE_VALID)
    {
      ((PSCSI_REQUEST_BLOCK)srb)->SrbStatus = status | SRB_STATUS_AUTOSENSE_VALID;
    }
    else
    {
      ((PSCSI_REQUEST_BLOCK)srb)->SrbStatus = status;
    }
  }
}

SrbSetSystemStatus()

FORCEINLINE VOID SrbSetSystemStatus	(	_In_ PVOID	Srb,
		_In_ ULONG	Status
	)

Definition at line 1027 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->SystemStatus = Status;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->InternalStatus = Status;
  }
}

SrbSetTimeOutValue()

FORCEINLINE VOID SrbSetTimeOutValue	(	_In_ PVOID	Srb,
		_In_ ULONG	TimeOutValue
	)

Definition at line 829 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    srb->TimeOutValue = TimeOutValue;
  }
  else
  {
    ((PSCSI_REQUEST_BLOCK)srb)->TimeOutValue = TimeOutValue;
  }
}

Referenced by _IRQL_requires_max_(), ClassDeviceControl(), ClassDeviceHwFirmwareActivateProcess(), ClassDeviceHwFirmwareDownloadProcess(), ClassGetLBProvisioningLogPage(), ClasspBuildRequestEx(), ClasspDeviceGetBlockDeviceCharacteristicsVPDPage(), ClasspDeviceGetBlockLimitsVPDPage(), ClasspDeviceGetLBProvisioningVPDPage(), ClasspEjectionControl(), ClasspGetBlockDeviceTokenLimitsInfo(), ClasspGetInquiryVpdSupportInfo(), ClasspPersistentReserve(), ClasspPowerDownCompletion(), ClasspPowerUpCompletion(), ClasspWriteCacheProperty(), ClassReadCapacity16(), ClassSendStartUnit(), DeviceProcessDsmTrimRequest(), GetLBAStatus(), SetupDriveCapacityTransferPacket(), SetupEjectionTransferPacket(), SetupModeSelectTransferPacket(), SetupModeSenseTransferPacket(), and SetupReadWriteTransferPacket().

SrbZeroSrb()

FORCEINLINE VOID SrbZeroSrb

(

_In_ PVOID

Srb

)

Definition at line 189 of file srbhelper.h.

{
  PSTORAGE_REQUEST_BLOCK srb = (PSTORAGE_REQUEST_BLOCK)Srb;
  UCHAR function = srb->Function;
  USHORT length = srb->Length;
 
  if (srb->Function == SRB_FUNCTION_STORAGE_REQUEST_BLOCK)
  {
    ULONG srbLength = srb->SrbLength;
 
    SrbZeroMemory(Srb, srb->SrbLength);
 
    srb->SrbLength = srbLength;
  }
  else
  {
    SrbZeroMemory(Srb, sizeof(SCSI_REQUEST_BLOCK));
  }
 
  srb->Function = function;
  srb->Length = length;
}