[mirror_edk2.git] / OvmfPkg / PvScsiDxe / PvScsi.c

/** @file\r
\r
  This driver produces Extended SCSI Pass Thru Protocol instances for\r
  pvscsi devices.\r
\r
  Copyright (C) 2020, Oracle and/or its affiliates.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <IndustryStandard/Pci.h>\r
#include <IndustryStandard/PvScsi.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Protocol/PciIo.h>\r
#include <Uefi/UefiSpec.h>\r
\r
#include "PvScsi.h"\r
\r
//\r
// Higher versions will be used before lower, 0x10-0xffffffef is the version\r
// range for IHV (Indie Hardware Vendors)\r
//\r
#define PVSCSI_BINDING_VERSION      0x10\r
\r
//\r
// Ext SCSI Pass Thru utilities\r
//\r
\r
/**\r
  Check if Target argument to EXT_SCSI_PASS_THRU.GetNextTarget() and\r
  EXT_SCSI_PASS_THRU.GetNextTargetLun() is initialized\r
**/\r
STATIC\r
BOOLEAN\r
IsTargetInitialized (\r
  IN UINT8                                          *Target\r
  )\r
{\r
  UINTN Idx;\r
\r
  for (Idx = 0; Idx < TARGET_MAX_BYTES; ++Idx) {\r
    if (Target[Idx] != 0xFF) {\r
      return TRUE;\r
    }\r
  }\r
  return FALSE;\r
}\r
\r
//\r
// Ext SCSI Pass Thru\r
//\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiPassThru (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
  IN UINT8                                          *Target,\r
  IN UINT64                                         Lun,\r
  IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
  IN EFI_EVENT                                      Event    OPTIONAL\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiGetNextTargetLun (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
  IN OUT UINT8                                      **Target,\r
  IN OUT UINT64                                     *Lun\r
  )\r
{\r
  UINT8      *TargetPtr;\r
  UINT8      LastTarget;\r
  PVSCSI_DEV *Dev;\r
\r
  if (Target == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // The Target input parameter is unnecessarily a pointer-to-pointer\r
  //\r
  TargetPtr = *Target;\r
\r
  //\r
  // If target not initialized, return first target & LUN\r
  //\r
  if (!IsTargetInitialized (TargetPtr)) {\r
    ZeroMem (TargetPtr, TARGET_MAX_BYTES);\r
    *Lun = 0;\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // We only use first byte of target identifer\r
  //\r
  LastTarget = *TargetPtr;\r
\r
  //\r
  // Increment (target, LUN) pair if valid on input\r
  //\r
  Dev = PVSCSI_FROM_PASS_THRU (This);\r
  if (LastTarget > Dev->MaxTarget || *Lun > Dev->MaxLun) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (*Lun < Dev->MaxLun) {\r
    ++*Lun;\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (LastTarget < Dev->MaxTarget) {\r
    *Lun = 0;\r
    ++LastTarget;\r
    *TargetPtr = LastTarget;\r
    return EFI_SUCCESS;\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiBuildDevicePath (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
  IN UINT8                                          *Target,\r
  IN UINT64                                         Lun,\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL                   **DevicePath\r
  )\r
{\r
  UINT8             TargetValue;\r
  PVSCSI_DEV        *Dev;\r
  SCSI_DEVICE_PATH  *ScsiDevicePath;\r
\r
  if (DevicePath == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // We only use first byte of target identifer\r
  //\r
  TargetValue = *Target;\r
\r
  Dev = PVSCSI_FROM_PASS_THRU (This);\r
  if (TargetValue > Dev->MaxTarget || Lun > Dev->MaxLun) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  ScsiDevicePath = AllocatePool (sizeof (*ScsiDevicePath));\r
  if (ScsiDevicePath == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  ScsiDevicePath->Header.Type      = MESSAGING_DEVICE_PATH;\r
  ScsiDevicePath->Header.SubType   = MSG_SCSI_DP;\r
  ScsiDevicePath->Header.Length[0] = (UINT8)sizeof (*ScsiDevicePath);\r
  ScsiDevicePath->Header.Length[1] = (UINT8)(sizeof (*ScsiDevicePath) >> 8);\r
  ScsiDevicePath->Pun              = TargetValue;\r
  ScsiDevicePath->Lun              = (UINT16)Lun;\r
\r
  *DevicePath = &ScsiDevicePath->Header;\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiGetTargetLun (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
  IN EFI_DEVICE_PATH_PROTOCOL                       *DevicePath,\r
  OUT UINT8                                         **Target,\r
  OUT UINT64                                        *Lun\r
  )\r
{\r
  SCSI_DEVICE_PATH *ScsiDevicePath;\r
  PVSCSI_DEV       *Dev;\r
\r
  if (DevicePath == NULL || Target == NULL || *Target == NULL || Lun == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (DevicePath->Type    != MESSAGING_DEVICE_PATH ||\r
      DevicePath->SubType != MSG_SCSI_DP) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  ScsiDevicePath = (SCSI_DEVICE_PATH *)DevicePath;\r
  Dev = PVSCSI_FROM_PASS_THRU (This);\r
  if (ScsiDevicePath->Pun > Dev->MaxTarget ||\r
      ScsiDevicePath->Lun > Dev->MaxLun) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // We only use first byte of target identifer\r
  //\r
  **Target = (UINT8)ScsiDevicePath->Pun;\r
  ZeroMem (*Target + 1, TARGET_MAX_BYTES - 1);\r
  *Lun = ScsiDevicePath->Lun;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiResetChannel (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiResetTargetLun (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
  IN UINT8                                          *Target,\r
  IN UINT64                                         Lun\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiGetNextTarget (\r
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
  IN OUT UINT8                                      **Target\r
  )\r
{\r
  UINT8      *TargetPtr;\r
  UINT8      LastTarget;\r
  PVSCSI_DEV *Dev;\r
\r
  if (Target == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // The Target input parameter is unnecessarily a pointer-to-pointer\r
  //\r
  TargetPtr = *Target;\r
\r
  //\r
  // If target not initialized, return first target\r
  //\r
  if (!IsTargetInitialized (TargetPtr)) {\r
    ZeroMem (TargetPtr, TARGET_MAX_BYTES);\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // We only use first byte of target identifer\r
  //\r
  LastTarget = *TargetPtr;\r
\r
  //\r
  // Increment target if valid on input\r
  //\r
  Dev = PVSCSI_FROM_PASS_THRU (This);\r
  if (LastTarget > Dev->MaxTarget) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (LastTarget < Dev->MaxTarget) {\r
    ++LastTarget;\r
    *TargetPtr = LastTarget;\r
    return EFI_SUCCESS;\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
STATIC\r
EFI_STATUS\r
PvScsiInit (\r
  IN OUT PVSCSI_DEV *Dev\r
  )\r
{\r
  //\r
  // Init configuration\r
  //\r
  Dev->MaxTarget = PcdGet8 (PcdPvScsiMaxTargetLimit);\r
  Dev->MaxLun = PcdGet8 (PcdPvScsiMaxLunLimit);\r
\r
  //\r
  // Populate the exported interface's attributes\r
  //\r
  Dev->PassThru.Mode             = &Dev->PassThruMode;\r
  Dev->PassThru.PassThru         = &PvScsiPassThru;\r
  Dev->PassThru.GetNextTargetLun = &PvScsiGetNextTargetLun;\r
  Dev->PassThru.BuildDevicePath  = &PvScsiBuildDevicePath;\r
  Dev->PassThru.GetTargetLun     = &PvScsiGetTargetLun;\r
  Dev->PassThru.ResetChannel     = &PvScsiResetChannel;\r
  Dev->PassThru.ResetTargetLun   = &PvScsiResetTargetLun;\r
  Dev->PassThru.GetNextTarget    = &PvScsiGetNextTarget;\r
\r
  //\r
  // AdapterId is a target for which no handle will be created during bus scan.\r
  // Prevent any conflict with real devices.\r
  //\r
  Dev->PassThruMode.AdapterId = MAX_UINT32;\r
\r
  //\r
  // Set both physical and logical attributes for non-RAID SCSI channel\r
  //\r
  Dev->PassThruMode.Attributes = EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL |\r
                                 EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL;\r
\r
  //\r
  // No restriction on transfer buffer alignment\r
  //\r
  Dev->PassThruMode.IoAlign = 0;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
VOID\r
PvScsiUninit (\r
  IN OUT PVSCSI_DEV *Dev\r
  )\r
{\r
  // Currently nothing to do here\r
}\r
\r
//\r
// Driver Binding\r
//\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS          Status;\r
  EFI_PCI_IO_PROTOCOL *PciIo;\r
  PCI_TYPE00          Pci;\r
\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiPciIoProtocolGuid,\r
                  (VOID **)&PciIo,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = PciIo->Pci.Read (\r
                        PciIo,\r
                        EfiPciIoWidthUint32,\r
                        0,\r
                        sizeof (Pci) / sizeof (UINT32),\r
                        &Pci\r
                        );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if ((Pci.Hdr.VendorId != PCI_VENDOR_ID_VMWARE) ||\r
      (Pci.Hdr.DeviceId != PCI_DEVICE_ID_VMWARE_PVSCSI)) {\r
    Status = EFI_UNSUPPORTED;\r
    goto Done;\r
  }\r
\r
  Status = EFI_SUCCESS;\r
\r
Done:\r
  gBS->CloseProtocol (\r
         ControllerHandle,\r
         &gEfiPciIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         ControllerHandle\r
         );\r
\r
  return Status;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  PVSCSI_DEV *Dev;\r
  EFI_STATUS Status;\r
\r
  Dev = (PVSCSI_DEV *) AllocateZeroPool (sizeof (*Dev));\r
  if (Dev == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = PvScsiInit (Dev);\r
  if (EFI_ERROR (Status)) {\r
    goto FreePvScsi;\r
  }\r
\r
  //\r
  // Setup complete, attempt to export the driver instance's PassThru interface\r
  //\r
  Dev->Signature = PVSCSI_SIG;\r
  Status = gBS->InstallProtocolInterface (\r
                  &ControllerHandle,\r
                  &gEfiExtScsiPassThruProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  &Dev->PassThru\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto UninitDev;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
UninitDev:\r
  PvScsiUninit (Dev);\r
\r
FreePvScsi:\r
  FreePool (Dev);\r
\r
  return Status;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  ControllerHandle,\r
  IN UINTN                       NumberOfChildren,\r
  IN EFI_HANDLE                  *ChildHandleBuffer\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru;\r
  PVSCSI_DEV                      *Dev;\r
\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiExtScsiPassThruProtocolGuid,\r
                  (VOID **)&PassThru,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL // Lookup only\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Dev = PVSCSI_FROM_PASS_THRU (PassThru);\r
\r
  Status = gBS->UninstallProtocolInterface (\r
                  ControllerHandle,\r
                  &gEfiExtScsiPassThruProtocolGuid,\r
                  &Dev->PassThru\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  PvScsiUninit (Dev);\r
\r
  FreePool (Dev);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC EFI_DRIVER_BINDING_PROTOCOL mPvScsiDriverBinding = {\r
  &PvScsiDriverBindingSupported,\r
  &PvScsiDriverBindingStart,\r
  &PvScsiDriverBindingStop,\r
  PVSCSI_BINDING_VERSION,\r
  NULL, // ImageHandle, filled by EfiLibInstallDriverBindingComponentName2()\r
  NULL  // DriverBindingHandle, filled as well\r
};\r
\r
//\r
// Component Name\r
//\r
\r
STATIC EFI_UNICODE_STRING_TABLE mDriverNameTable[] = {\r
  { "eng;en", L"PVSCSI Host Driver" },\r
  { NULL,     NULL                  }\r
};\r
\r
STATIC EFI_COMPONENT_NAME_PROTOCOL mComponentName;\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL *This,\r
  IN  CHAR8                       *Language,\r
  OUT CHAR16                      **DriverName\r
  )\r
{\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           mDriverNameTable,\r
           DriverName,\r
           (BOOLEAN)(This == &mComponentName) // Iso639Language\r
           );\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PvScsiGetDeviceName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL *This,\r
  IN  EFI_HANDLE                  DeviceHandle,\r
  IN  EFI_HANDLE                  ChildHandle,\r
  IN  CHAR8                       *Language,\r
  OUT CHAR16                      **ControllerName\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
STATIC EFI_COMPONENT_NAME_PROTOCOL mComponentName = {\r
  &PvScsiGetDriverName,\r
  &PvScsiGetDeviceName,\r
  "eng" // SupportedLanguages, ISO 639-2 language codes\r
};\r
\r
STATIC EFI_COMPONENT_NAME2_PROTOCOL mComponentName2 = {\r
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)     &PvScsiGetDriverName,\r
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) &PvScsiGetDeviceName,\r
  "en" // SupportedLanguages, RFC 4646 language codes\r
};\r
\r
//\r
// Entry Point\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
PvScsiEntryPoint (\r
  IN EFI_HANDLE       ImageHandle,\r
  IN EFI_SYSTEM_TABLE *SystemTable\r
  )\r
{\r
  return EfiLibInstallDriverBindingComponentName2 (\r
           ImageHandle,\r
           SystemTable,\r
           &mPvScsiDriverBinding,\r
           ImageHandle,\r
           &mComponentName,\r
           &mComponentName2\r
           );\r
}\r
Commit	Line	Data
478c07d4 LA	1	/** @file\r
	2	\r
	3	This driver produces Extended SCSI Pass Thru Protocol instances for\r
	4	pvscsi devices.\r
	5	\r
	6	Copyright (C) 2020, Oracle and/or its affiliates.\r
	7	\r
	8	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	9	\r
	10	**/\r
	11	\r
a9f9d5cf LA	12	#include <IndustryStandard/Pci.h>\r
a9f9d5cf LA	13	#include <IndustryStandard/PvScsi.h>\r
7efce2e5	14	#include <Library/BaseMemoryLib.h>\r
e497432c	15	#include <Library/MemoryAllocationLib.h>\r
a9f9d5cf	16	#include <Library/UefiBootServicesTableLib.h>\r
ed08c571	17	#include <Library/UefiLib.h>\r
a9f9d5cf	18	#include <Protocol/PciIo.h>\r
478c07d4 LA	19	#include <Uefi/UefiSpec.h>\r
478c07d4 LA	20	\r
e497432c LA	21	#include "PvScsi.h"\r
e497432c LA	22	\r
ed08c571 LA	23	//\r
	24	// Higher versions will be used before lower, 0x10-0xffffffef is the version\r
	25	// range for IHV (Indie Hardware Vendors)\r
	26	//\r
	27	#define PVSCSI_BINDING_VERSION 0x10\r
	28	\r
7efce2e5 LA	29	//\r
	30	// Ext SCSI Pass Thru utilities\r
	31	//\r
	32	\r
	33	/**\r
	34	Check if Target argument to EXT_SCSI_PASS_THRU.GetNextTarget() and\r
	35	EXT_SCSI_PASS_THRU.GetNextTargetLun() is initialized\r
	36	**/\r
	37	STATIC\r
	38	BOOLEAN\r
	39	IsTargetInitialized (\r
	40	IN UINT8 *Target\r
	41	)\r
	42	{\r
	43	UINTN Idx;\r
	44	\r
	45	for (Idx = 0; Idx < TARGET_MAX_BYTES; ++Idx) {\r
	46	if (Target[Idx] != 0xFF) {\r
	47	return TRUE;\r
	48	}\r
	49	}\r
	50	return FALSE;\r
	51	}\r
	52	\r
e497432c LA	53	//\r
	54	// Ext SCSI Pass Thru\r
	55	//\r
	56	\r
	57	STATIC\r
	58	EFI_STATUS\r
	59	EFIAPI\r
	60	PvScsiPassThru (\r
	61	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
	62	IN UINT8 *Target,\r
	63	IN UINT64 Lun,\r
	64	IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
	65	IN EFI_EVENT Event OPTIONAL\r
	66	)\r
	67	{\r
	68	return EFI_UNSUPPORTED;\r
	69	}\r
	70	\r
	71	STATIC\r
	72	EFI_STATUS\r
	73	EFIAPI\r
	74	PvScsiGetNextTargetLun (\r
	75	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
	76	IN OUT UINT8 **Target,\r
	77	IN OUT UINT64 *Lun\r
	78	)\r
	79	{\r
7efce2e5 LA	80	UINT8 *TargetPtr;\r
	81	UINT8 LastTarget;\r
	82	PVSCSI_DEV *Dev;\r
	83	\r
	84	if (Target == NULL) {\r
	85	return EFI_INVALID_PARAMETER;\r
	86	}\r
	87	\r
	88	//\r
	89	// The Target input parameter is unnecessarily a pointer-to-pointer\r
	90	//\r
	91	TargetPtr = *Target;\r
	92	\r
	93	//\r
	94	// If target not initialized, return first target & LUN\r
	95	//\r
	96	if (!IsTargetInitialized (TargetPtr)) {\r
	97	ZeroMem (TargetPtr, TARGET_MAX_BYTES);\r
	98	*Lun = 0;\r
	99	return EFI_SUCCESS;\r
	100	}\r
	101	\r
	102	//\r
	103	// We only use first byte of target identifer\r
	104	//\r
	105	LastTarget = *TargetPtr;\r
	106	\r
	107	//\r
	108	// Increment (target, LUN) pair if valid on input\r
	109	//\r
	110	Dev = PVSCSI_FROM_PASS_THRU (This);\r
	111	if (LastTarget > Dev->MaxTarget \|\| *Lun > Dev->MaxLun) {\r
	112	return EFI_INVALID_PARAMETER;\r
	113	}\r
	114	\r
	115	if (*Lun < Dev->MaxLun) {\r
	116	++*Lun;\r
	117	return EFI_SUCCESS;\r
	118	}\r
	119	\r
	120	if (LastTarget < Dev->MaxTarget) {\r
	121	*Lun = 0;\r
	122	++LastTarget;\r
	123	*TargetPtr = LastTarget;\r
	124	return EFI_SUCCESS;\r
	125	}\r
	126	\r
	127	return EFI_NOT_FOUND;\r
e497432c LA	128	}\r
	129	\r
	130	STATIC\r
	131	EFI_STATUS\r
	132	EFIAPI\r
	133	PvScsiBuildDevicePath (\r
	134	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
	135	IN UINT8 *Target,\r
	136	IN UINT64 Lun,\r
	137	IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r
	138	)\r
	139	{\r
9c2d8281 LA	140	UINT8 TargetValue;\r
	141	PVSCSI_DEV *Dev;\r
	142	SCSI_DEVICE_PATH *ScsiDevicePath;\r
	143	\r
	144	if (DevicePath == NULL) {\r
	145	return EFI_INVALID_PARAMETER;\r
	146	}\r
	147	\r
	148	//\r
	149	// We only use first byte of target identifer\r
	150	//\r
	151	TargetValue = *Target;\r
	152	\r
	153	Dev = PVSCSI_FROM_PASS_THRU (This);\r
	154	if (TargetValue > Dev->MaxTarget \|\| Lun > Dev->MaxLun) {\r
	155	return EFI_NOT_FOUND;\r
	156	}\r
	157	\r
	158	ScsiDevicePath = AllocatePool (sizeof (*ScsiDevicePath));\r
	159	if (ScsiDevicePath == NULL) {\r
	160	return EFI_OUT_OF_RESOURCES;\r
	161	}\r
	162	\r
	163	ScsiDevicePath->Header.Type = MESSAGING_DEVICE_PATH;\r
	164	ScsiDevicePath->Header.SubType = MSG_SCSI_DP;\r
	165	ScsiDevicePath->Header.Length[0] = (UINT8)sizeof (*ScsiDevicePath);\r
	166	ScsiDevicePath->Header.Length[1] = (UINT8)(sizeof (*ScsiDevicePath) >> 8);\r
	167	ScsiDevicePath->Pun = TargetValue;\r
	168	ScsiDevicePath->Lun = (UINT16)Lun;\r
	169	\r
	170	*DevicePath = &ScsiDevicePath->Header;\r
	171	return EFI_SUCCESS;\r
e497432c LA	172	}\r
	173	\r
	174	STATIC\r
	175	EFI_STATUS\r
	176	EFIAPI\r
	177	PvScsiGetTargetLun (\r
	178	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
	179	IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
	180	OUT UINT8 **Target,\r
	181	OUT UINT64 *Lun\r
	182	)\r
	183	{\r
9c2d8281 LA	184	SCSI_DEVICE_PATH *ScsiDevicePath;\r
	185	PVSCSI_DEV *Dev;\r
	186	\r
	187	if (DevicePath == NULL \|\| Target == NULL \|\| *Target == NULL \|\| Lun == NULL) {\r
	188	return EFI_INVALID_PARAMETER;\r
	189	}\r
	190	\r
	191	if (DevicePath->Type != MESSAGING_DEVICE_PATH \|\|\r
	192	DevicePath->SubType != MSG_SCSI_DP) {\r
	193	return EFI_UNSUPPORTED;\r
	194	}\r
	195	\r
	196	ScsiDevicePath = (SCSI_DEVICE_PATH *)DevicePath;\r
	197	Dev = PVSCSI_FROM_PASS_THRU (This);\r
	198	if (ScsiDevicePath->Pun > Dev->MaxTarget \|\|\r
	199	ScsiDevicePath->Lun > Dev->MaxLun) {\r
	200	return EFI_NOT_FOUND;\r
	201	}\r
	202	\r
	203	//\r
	204	// We only use first byte of target identifer\r
	205	//\r
	206	**Target = (UINT8)ScsiDevicePath->Pun;\r
	207	ZeroMem (*Target + 1, TARGET_MAX_BYTES - 1);\r
	208	*Lun = ScsiDevicePath->Lun;\r
	209	\r
	210	return EFI_SUCCESS;\r
e497432c LA	211	}\r
	212	\r
	213	STATIC\r
	214	EFI_STATUS\r
	215	EFIAPI\r
	216	PvScsiResetChannel (\r
	217	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This\r
	218	)\r
	219	{\r
	220	return EFI_UNSUPPORTED;\r
	221	}\r
	222	\r
	223	STATIC\r
	224	EFI_STATUS\r
	225	EFIAPI\r
	226	PvScsiResetTargetLun (\r
	227	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
	228	IN UINT8 *Target,\r
	229	IN UINT64 Lun\r
	230	)\r
	231	{\r
	232	return EFI_UNSUPPORTED;\r
	233	}\r
	234	\r
	235	STATIC\r
	236	EFI_STATUS\r
	237	EFIAPI\r
	238	PvScsiGetNextTarget (\r
	239	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r
	240	IN OUT UINT8 **Target\r
	241	)\r
	242	{\r
7efce2e5 LA	243	UINT8 *TargetPtr;\r
	244	UINT8 LastTarget;\r
	245	PVSCSI_DEV *Dev;\r
	246	\r
	247	if (Target == NULL) {\r
	248	return EFI_INVALID_PARAMETER;\r
	249	}\r
	250	\r
	251	//\r
	252	// The Target input parameter is unnecessarily a pointer-to-pointer\r
	253	//\r
	254	TargetPtr = *Target;\r
	255	\r
	256	//\r
	257	// If target not initialized, return first target\r
	258	//\r
	259	if (!IsTargetInitialized (TargetPtr)) {\r
	260	ZeroMem (TargetPtr, TARGET_MAX_BYTES);\r
	261	return EFI_SUCCESS;\r
	262	}\r
	263	\r
	264	//\r
	265	// We only use first byte of target identifer\r
	266	//\r
	267	LastTarget = *TargetPtr;\r
	268	\r
	269	//\r
	270	// Increment target if valid on input\r
	271	//\r
	272	Dev = PVSCSI_FROM_PASS_THRU (This);\r
	273	if (LastTarget > Dev->MaxTarget) {\r
	274	return EFI_INVALID_PARAMETER;\r
	275	}\r
	276	\r
	277	if (LastTarget < Dev->MaxTarget) {\r
	278	++LastTarget;\r
	279	*TargetPtr = LastTarget;\r
	280	return EFI_SUCCESS;\r
	281	}\r
	282	\r
	283	return EFI_NOT_FOUND;\r
e497432c LA	284	}\r
	285	\r
	286	STATIC\r
	287	EFI_STATUS\r
	288	PvScsiInit (\r
	289	IN OUT PVSCSI_DEV *Dev\r
	290	)\r
	291	{\r
7efce2e5 LA	292	//\r
	293	// Init configuration\r
	294	//\r
	295	Dev->MaxTarget = PcdGet8 (PcdPvScsiMaxTargetLimit);\r
	296	Dev->MaxLun = PcdGet8 (PcdPvScsiMaxLunLimit);\r
	297	\r
e497432c LA	298	//\r
	299	// Populate the exported interface's attributes\r
	300	//\r
	301	Dev->PassThru.Mode = &Dev->PassThruMode;\r
	302	Dev->PassThru.PassThru = &PvScsiPassThru;\r
	303	Dev->PassThru.GetNextTargetLun = &PvScsiGetNextTargetLun;\r
	304	Dev->PassThru.BuildDevicePath = &PvScsiBuildDevicePath;\r
	305	Dev->PassThru.GetTargetLun = &PvScsiGetTargetLun;\r
	306	Dev->PassThru.ResetChannel = &PvScsiResetChannel;\r
	307	Dev->PassThru.ResetTargetLun = &PvScsiResetTargetLun;\r
	308	Dev->PassThru.GetNextTarget = &PvScsiGetNextTarget;\r
	309	\r
	310	//\r
	311	// AdapterId is a target for which no handle will be created during bus scan.\r
	312	// Prevent any conflict with real devices.\r
	313	//\r
	314	Dev->PassThruMode.AdapterId = MAX_UINT32;\r
	315	\r
	316	//\r
	317	// Set both physical and logical attributes for non-RAID SCSI channel\r
	318	//\r
	319	Dev->PassThruMode.Attributes = EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL \|\r
	320	EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL;\r
	321	\r
	322	//\r
	323	// No restriction on transfer buffer alignment\r
	324	//\r
	325	Dev->PassThruMode.IoAlign = 0;\r
	326	\r
	327	return EFI_SUCCESS;\r
	328	}\r
	329	\r
	330	STATIC\r
	331	VOID\r
	332	PvScsiUninit (\r
	333	IN OUT PVSCSI_DEV *Dev\r
	334	)\r
	335	{\r
	336	// Currently nothing to do here\r
	337	}\r
	338	\r
ed08c571 LA	339	//\r
	340	// Driver Binding\r
	341	//\r
	342	\r
	343	STATIC\r
	344	EFI_STATUS\r
	345	EFIAPI\r
	346	PvScsiDriverBindingSupported (\r
	347	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	348	IN EFI_HANDLE ControllerHandle,\r
	349	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
	350	)\r
	351	{\r
a9f9d5cf LA	352	EFI_STATUS Status;\r
	353	EFI_PCI_IO_PROTOCOL *PciIo;\r
	354	PCI_TYPE00 Pci;\r
	355	\r
	356	Status = gBS->OpenProtocol (\r
	357	ControllerHandle,\r
	358	&gEfiPciIoProtocolGuid,\r
	359	(VOID **)&PciIo,\r
	360	This->DriverBindingHandle,\r
	361	ControllerHandle,\r
	362	EFI_OPEN_PROTOCOL_BY_DRIVER\r
	363	);\r
	364	if (EFI_ERROR (Status)) {\r
	365	return Status;\r
	366	}\r
	367	\r
	368	Status = PciIo->Pci.Read (\r
	369	PciIo,\r
	370	EfiPciIoWidthUint32,\r
	371	0,\r
	372	sizeof (Pci) / sizeof (UINT32),\r
	373	&Pci\r
	374	);\r
	375	if (EFI_ERROR (Status)) {\r
	376	goto Done;\r
	377	}\r
	378	\r
	379	if ((Pci.Hdr.VendorId != PCI_VENDOR_ID_VMWARE) \|\|\r
	380	(Pci.Hdr.DeviceId != PCI_DEVICE_ID_VMWARE_PVSCSI)) {\r
	381	Status = EFI_UNSUPPORTED;\r
	382	goto Done;\r
	383	}\r
	384	\r
	385	Status = EFI_SUCCESS;\r
	386	\r
	387	Done:\r
	388	gBS->CloseProtocol (\r
	389	ControllerHandle,\r
	390	&gEfiPciIoProtocolGuid,\r
	391	This->DriverBindingHandle,\r
	392	ControllerHandle\r
	393	);\r
	394	\r
	395	return Status;\r
ed08c571 LA	396	}\r
	397	\r
	398	STATIC\r
	399	EFI_STATUS\r
	400	EFIAPI\r
	401	PvScsiDriverBindingStart (\r
	402	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	403	IN EFI_HANDLE ControllerHandle,\r
	404	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
	405	)\r
	406	{\r
e497432c LA	407	PVSCSI_DEV *Dev;\r
	408	EFI_STATUS Status;\r
	409	\r
	410	Dev = (PVSCSI_DEV ) AllocateZeroPool (sizeof (Dev));\r
	411	if (Dev == NULL) {\r
	412	return EFI_OUT_OF_RESOURCES;\r
	413	}\r
	414	\r
	415	Status = PvScsiInit (Dev);\r
	416	if (EFI_ERROR (Status)) {\r
	417	goto FreePvScsi;\r
	418	}\r
	419	\r
	420	//\r
	421	// Setup complete, attempt to export the driver instance's PassThru interface\r
	422	//\r
	423	Dev->Signature = PVSCSI_SIG;\r
	424	Status = gBS->InstallProtocolInterface (\r
	425	&ControllerHandle,\r
	426	&gEfiExtScsiPassThruProtocolGuid,\r
	427	EFI_NATIVE_INTERFACE,\r
	428	&Dev->PassThru\r
	429	);\r
	430	if (EFI_ERROR (Status)) {\r
	431	goto UninitDev;\r
	432	}\r
	433	\r
	434	return EFI_SUCCESS;\r
	435	\r
	436	UninitDev:\r
	437	PvScsiUninit (Dev);\r
	438	\r
	439	FreePvScsi:\r
	440	FreePool (Dev);\r
	441	\r
	442	return Status;\r
ed08c571 LA	443	}\r
	444	\r
	445	STATIC\r
	446	EFI_STATUS\r
	447	EFIAPI\r
	448	PvScsiDriverBindingStop (\r
	449	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	450	IN EFI_HANDLE ControllerHandle,\r
	451	IN UINTN NumberOfChildren,\r
	452	IN EFI_HANDLE *ChildHandleBuffer\r
	453	)\r
	454	{\r
e497432c LA	455	EFI_STATUS Status;\r
	456	EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru;\r
	457	PVSCSI_DEV *Dev;\r
	458	\r
	459	Status = gBS->OpenProtocol (\r
	460	ControllerHandle,\r
	461	&gEfiExtScsiPassThruProtocolGuid,\r
	462	(VOID **)&PassThru,\r
	463	This->DriverBindingHandle,\r
	464	ControllerHandle,\r
	465	EFI_OPEN_PROTOCOL_GET_PROTOCOL // Lookup only\r
	466	);\r
	467	if (EFI_ERROR (Status)) {\r
	468	return Status;\r
	469	}\r
	470	\r
	471	Dev = PVSCSI_FROM_PASS_THRU (PassThru);\r
	472	\r
	473	Status = gBS->UninstallProtocolInterface (\r
	474	ControllerHandle,\r
	475	&gEfiExtScsiPassThruProtocolGuid,\r
	476	&Dev->PassThru\r
	477	);\r
	478	if (EFI_ERROR (Status)) {\r
	479	return Status;\r
	480	}\r
	481	\r
	482	PvScsiUninit (Dev);\r
	483	\r
	484	FreePool (Dev);\r
	485	\r
	486	return EFI_SUCCESS;\r
ed08c571 LA	487	}\r
	488	\r
	489	STATIC EFI_DRIVER_BINDING_PROTOCOL mPvScsiDriverBinding = {\r
	490	&PvScsiDriverBindingSupported,\r
	491	&PvScsiDriverBindingStart,\r
	492	&PvScsiDriverBindingStop,\r
	493	PVSCSI_BINDING_VERSION,\r
	494	NULL, // ImageHandle, filled by EfiLibInstallDriverBindingComponentName2()\r
	495	NULL // DriverBindingHandle, filled as well\r
	496	};\r
	497	\r
419b30d6 LA	498	//\r
	499	// Component Name\r
	500	//\r
	501	\r
	502	STATIC EFI_UNICODE_STRING_TABLE mDriverNameTable[] = {\r
	503	{ "eng;en", L"PVSCSI Host Driver" },\r
	504	{ NULL, NULL }\r
	505	};\r
	506	\r
	507	STATIC EFI_COMPONENT_NAME_PROTOCOL mComponentName;\r
	508	\r
	509	STATIC\r
	510	EFI_STATUS\r
	511	EFIAPI\r
	512	PvScsiGetDriverName (\r
	513	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	514	IN CHAR8 *Language,\r
	515	OUT CHAR16 **DriverName\r
	516	)\r
	517	{\r
	518	return LookupUnicodeString2 (\r
	519	Language,\r
	520	This->SupportedLanguages,\r
	521	mDriverNameTable,\r
	522	DriverName,\r
	523	(BOOLEAN)(This == &mComponentName) // Iso639Language\r
	524	);\r
	525	}\r
	526	\r
	527	STATIC\r
	528	EFI_STATUS\r
	529	EFIAPI\r
	530	PvScsiGetDeviceName (\r
	531	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	532	IN EFI_HANDLE DeviceHandle,\r
	533	IN EFI_HANDLE ChildHandle,\r
	534	IN CHAR8 *Language,\r
	535	OUT CHAR16 **ControllerName\r
	536	)\r
	537	{\r
	538	return EFI_UNSUPPORTED;\r
	539	}\r
	540	\r
	541	STATIC EFI_COMPONENT_NAME_PROTOCOL mComponentName = {\r
	542	&PvScsiGetDriverName,\r
	543	&PvScsiGetDeviceName,\r
	544	"eng" // SupportedLanguages, ISO 639-2 language codes\r
	545	};\r
	546	\r
	547	STATIC EFI_COMPONENT_NAME2_PROTOCOL mComponentName2 = {\r
	548	(EFI_COMPONENT_NAME2_GET_DRIVER_NAME) &PvScsiGetDriverName,\r
	549	(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) &PvScsiGetDeviceName,\r
	550	"en" // SupportedLanguages, RFC 4646 language codes\r
	551	};\r
	552	\r
478c07d4 LA	553	//\r
	554	// Entry Point\r
	555	//\r
	556	\r
	557	EFI_STATUS\r
	558	EFIAPI\r
	559	PvScsiEntryPoint (\r
	560	IN EFI_HANDLE ImageHandle,\r
	561	IN EFI_SYSTEM_TABLE *SystemTable\r
	562	)\r
	563	{\r
ed08c571 LA	564	return EfiLibInstallDriverBindingComponentName2 (\r
	565	ImageHandle,\r
	566	SystemTable,\r
	567	&mPvScsiDriverBinding,\r
	568	ImageHandle,\r
419b30d6 LA	569	&mComponentName,\r
419b30d6 LA	570	&mComponentName2\r
ed08c571	571	);\r
478c07d4	572	}\r