MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / NvmExpressPei / NvmExpressPeiBlockIo.c

/** @file\r
  The NvmExpressPei driver is used to manage non-volatile memory subsystem\r
  which follows NVM Express specification at PEI phase.\r
\r
  Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "NvmExpressPei.h"\r
\r
/**\r
  Read some sectors from the device.\r
\r
  @param  NamespaceInfo    The pointer to the PEI_NVME_NAMESPACE_INFO data structure.\r
  @param  Buffer           The buffer used to store the data read from the device.\r
  @param  Lba              The start block number.\r
  @param  Blocks           Total block number to be read.\r
\r
  @retval EFI_SUCCESS            Data are read from the device.\r
  @retval Others                 Fail to read all the data.\r
\r
**/\r
EFI_STATUS\r
ReadSectors (\r
  IN  PEI_NVME_NAMESPACE_INFO    *NamespaceInfo,\r
  OUT UINTN                      Buffer,\r
  IN  UINT64                     Lba,\r
  IN  UINT32                     Blocks\r
  )\r
{\r
  EFI_STATUS                                        Status;\r
  UINT32                                            BlockSize;\r
  PEI_NVME_CONTROLLER_PRIVATE_DATA                  *Private;\r
  UINT32                                            Bytes;\r
  EDKII_PEI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET    CommandPacket;\r
  EDKII_PEI_NVM_EXPRESS_COMMAND                     Command;\r
  EDKII_PEI_NVM_EXPRESS_COMPLETION                  Completion;\r
\r
  Private   = NamespaceInfo->Controller;\r
  BlockSize = NamespaceInfo->Media.BlockSize;\r
  Bytes     = Blocks * BlockSize;\r
\r
  ZeroMem (&CommandPacket, sizeof(EDKII_PEI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
  ZeroMem (&Command, sizeof(EDKII_PEI_NVM_EXPRESS_COMMAND));\r
  ZeroMem (&Completion, sizeof(EDKII_PEI_NVM_EXPRESS_COMPLETION));\r
\r
  CommandPacket.NvmeCmd        = &Command;\r
  CommandPacket.NvmeCompletion = &Completion;\r
\r
  CommandPacket.NvmeCmd->Cdw0.Opcode = NVME_IO_READ_OPC;\r
  CommandPacket.NvmeCmd->Nsid        = NamespaceInfo->NamespaceId;\r
  CommandPacket.TransferBuffer       = (VOID *)Buffer;\r
\r
  CommandPacket.TransferLength = Bytes;\r
  CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;\r
  CommandPacket.QueueType      = NVME_IO_QUEUE;\r
\r
  CommandPacket.NvmeCmd->Cdw10 = (UINT32)Lba;\r
  CommandPacket.NvmeCmd->Cdw11 = (UINT32)RShiftU64(Lba, 32);\r
  CommandPacket.NvmeCmd->Cdw12 = (Blocks - 1) & 0xFFFF;\r
\r
  CommandPacket.NvmeCmd->Flags = CDW10_VALID | CDW11_VALID | CDW12_VALID;\r
\r
  Status = NvmePassThru (\r
             Private,\r
             NamespaceInfo->NamespaceId,\r
             &CommandPacket\r
             );\r
  return Status;\r
}\r
\r
/**\r
  Read some blocks from the device.\r
\r
  @param[in]  NamespaceInfo    The pointer to the PEI_NVME_NAMESPACE_INFO data structure.\r
  @param[out] Buffer           The Buffer used to store the Data read from the device.\r
  @param[in]  Lba              The start block number.\r
  @param[in]  Blocks           Total block number to be read.\r
\r
  @retval EFI_SUCCESS          Data are read from the device.\r
  @retval Others               Fail to read all the data.\r
\r
**/\r
EFI_STATUS\r
NvmeRead (\r
  IN  PEI_NVME_NAMESPACE_INFO    *NamespaceInfo,\r
  OUT UINTN                      Buffer,\r
  IN  UINT64                     Lba,\r
  IN  UINTN                      Blocks\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  UINT32                              Retries;\r
  UINT32                              BlockSize;\r
  PEI_NVME_CONTROLLER_PRIVATE_DATA    *Private;\r
  UINT32                              MaxTransferBlocks;\r
  UINTN                               OrginalBlocks;\r
\r
  Status        = EFI_SUCCESS;\r
  Retries       = 0;\r
  Private       = NamespaceInfo->Controller;\r
  BlockSize     = NamespaceInfo->Media.BlockSize;\r
  OrginalBlocks = Blocks;\r
\r
  if (Private->ControllerData->Mdts != 0) {\r
    MaxTransferBlocks = (1 << (Private->ControllerData->Mdts)) * (1 << (Private->Cap.Mpsmin + 12)) / BlockSize;\r
  } else {\r
    MaxTransferBlocks = 1024;\r
  }\r
\r
  while (Blocks > 0) {\r
    Status = ReadSectors (\r
               NamespaceInfo,\r
               Buffer,\r
               Lba,\r
               Blocks > MaxTransferBlocks ? MaxTransferBlocks : (UINT32)Blocks\r
               );\r
    if (EFI_ERROR(Status)) {\r
      Retries++;\r
      MaxTransferBlocks = MaxTransferBlocks >> 1;\r
\r
      if (Retries > NVME_READ_MAX_RETRY || MaxTransferBlocks < 1) {\r
        DEBUG ((DEBUG_ERROR, "%a: ReadSectors fail, Status - %r\n", __FUNCTION__, Status));\r
        break;\r
      }\r
      DEBUG ((\r
        DEBUG_BLKIO,\r
        "%a: ReadSectors fail, retry with smaller transfer block number - 0x%x\n",\r
        __FUNCTION__,\r
        MaxTransferBlocks\r
        ));\r
      continue;\r
    }\r
\r
    if (Blocks > MaxTransferBlocks) {\r
      Blocks -= MaxTransferBlocks;\r
      Buffer += (MaxTransferBlocks * BlockSize);\r
      Lba    += MaxTransferBlocks;\r
    } else {\r
      Blocks  = 0;\r
    }\r
  }\r
\r
  DEBUG ((DEBUG_BLKIO, "%a: Lba = 0x%08Lx, Original = 0x%08Lx, "\r
    "Remaining = 0x%08Lx, BlockSize = 0x%x, Status = %r\n", __FUNCTION__, Lba,\r
    (UINT64)OrginalBlocks, (UINT64)Blocks, BlockSize, Status));\r
  return Status;\r
}\r
\r
/**\r
  Gets the count of block I/O devices that one specific block driver detects.\r
\r
  This function is used for getting the count of block I/O devices that one\r
  specific block driver detects. If no device is detected, then the function\r
  will return zero.\r
\r
  @param[in]  PeiServices          General-purpose services that are available\r
                                   to every PEIM.\r
  @param[in]  This                 Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI\r
                                   instance.\r
  @param[out] NumberBlockDevices   The number of block I/O devices discovered.\r
\r
  @retval     EFI_SUCCESS          The operation performed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
NvmeBlockIoPeimGetDeviceNo (\r
  IN  EFI_PEI_SERVICES               **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,\r
  OUT UINTN                          *NumberBlockDevices\r
  )\r
{\r
  PEI_NVME_CONTROLLER_PRIVATE_DATA    *Private;\r
\r
  if (This == NULL || NumberBlockDevices == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GET_NVME_PEIM_HC_PRIVATE_DATA_FROM_THIS_BLKIO (This);\r
  *NumberBlockDevices = Private->ActiveNamespaceNum;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Gets a block device's media information.\r
\r
  This function will provide the caller with the specified block device's media\r
  information. If the media changes, calling this function will update the media\r
  information accordingly.\r
\r
  @param[in]  PeiServices   General-purpose services that are available to every\r
                            PEIM\r
  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
  @param[in]  DeviceIndex   Specifies the block device to which the function wants\r
                            to talk. Because the driver that implements Block I/O\r
                            PPIs will manage multiple block devices, the PPIs that\r
                            want to talk to a single device must specify the\r
                            device index that was assigned during the enumeration\r
                            process. This index is a number from one to\r
                            NumberBlockDevices.\r
  @param[out] MediaInfo     The media information of the specified block media.\r
                            The caller is responsible for the ownership of this\r
                            data structure.\r
\r
  @par Note:\r
      The MediaInfo structure describes an enumeration of possible block device\r
      types.  This enumeration exists because no device paths are actually passed\r
      across interfaces that describe the type or class of hardware that is publishing\r
      the block I/O interface. This enumeration will allow for policy decisions\r
      in the Recovery PEIM, such as "Try to recover from legacy floppy first,\r
      LS-120 second, CD-ROM third." If there are multiple partitions abstracted\r
      by a given device type, they should be reported in ascending order; this\r
      order also applies to nested partitions, such as legacy MBR, where the\r
      outermost partitions would have precedence in the reporting order. The\r
      same logic applies to systems such as IDE that have precedence relationships\r
      like "Master/Slave" or "Primary/Secondary". The master device should be\r
      reported first, the slave second.\r
\r
  @retval EFI_SUCCESS        Media information about the specified block device\r
                             was obtained successfully.\r
  @retval EFI_DEVICE_ERROR   Cannot get the media information due to a hardware\r
                             error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
NvmeBlockIoPeimGetMediaInfo (\r
  IN  EFI_PEI_SERVICES               **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,\r
  IN  UINTN                          DeviceIndex,\r
  OUT EFI_PEI_BLOCK_IO_MEDIA         *MediaInfo\r
  )\r
{\r
  PEI_NVME_CONTROLLER_PRIVATE_DATA    *Private;\r
\r
  if (This == NULL || MediaInfo == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GET_NVME_PEIM_HC_PRIVATE_DATA_FROM_THIS_BLKIO (This);\r
\r
  if ((DeviceIndex == 0) || (DeviceIndex > Private->ActiveNamespaceNum)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  MediaInfo->DeviceType   = (EFI_PEI_BLOCK_DEVICE_TYPE) EDKII_PEI_BLOCK_DEVICE_TYPE_NVME;\r
  MediaInfo->MediaPresent = TRUE;\r
  MediaInfo->LastBlock    = (UINTN)Private->NamespaceInfo[DeviceIndex-1].Media.LastBlock;\r
  MediaInfo->BlockSize    = Private->NamespaceInfo[DeviceIndex-1].Media.BlockSize;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Reads the requested number of blocks from the specified block device.\r
\r
  The function reads the requested number of blocks from the device. All the\r
  blocks are read, or an error is returned. If there is no media in the device,\r
  the function returns EFI_NO_MEDIA.\r
\r
  @param[in]  PeiServices   General-purpose services that are available to\r
                            every PEIM.\r
  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
  @param[in]  DeviceIndex   Specifies the block device to which the function wants\r
                            to talk. Because the driver that implements Block I/O\r
                            PPIs will manage multiple block devices, PPIs that\r
                            want to talk to a single device must specify the device\r
                            index that was assigned during the enumeration process.\r
                            This index is a number from one to NumberBlockDevices.\r
  @param[in]  StartLBA      The starting logical block address (LBA) to read from\r
                            on the device\r
  @param[in]  BufferSize    The size of the Buffer in bytes. This number must be\r
                            a multiple of the intrinsic block size of the device.\r
  @param[out] Buffer        A pointer to the destination buffer for the data.\r
                            The caller is responsible for the ownership of the\r
                            buffer.\r
\r
  @retval EFI_SUCCESS             The data was read correctly from the device.\r
  @retval EFI_DEVICE_ERROR        The device reported an error while attempting\r
                                  to perform the read operation.\r
  @retval EFI_INVALID_PARAMETER   The read request contains LBAs that are not\r
                                  valid, or the buffer is not properly aligned.\r
  @retval EFI_NO_MEDIA            There is no media in the device.\r
  @retval EFI_BAD_BUFFER_SIZE     The BufferSize parameter is not a multiple of\r
                                  the intrinsic block size of the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
NvmeBlockIoPeimReadBlocks (\r
  IN  EFI_PEI_SERVICES               **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,\r
  IN  UINTN                          DeviceIndex,\r
  IN  EFI_PEI_LBA                    StartLBA,\r
  IN  UINTN                          BufferSize,\r
  OUT VOID                           *Buffer\r
  )\r
{\r
  PEI_NVME_CONTROLLER_PRIVATE_DATA    *Private;\r
  PEI_NVME_NAMESPACE_INFO             *NamespaceInfo;\r
  UINT32                              BlockSize;\r
  UINTN                               NumberOfBlocks;\r
\r
  Private = GET_NVME_PEIM_HC_PRIVATE_DATA_FROM_THIS_BLKIO (This);\r
\r
  //\r
  // Check parameters\r
  //\r
  if (This == NULL || Buffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (BufferSize == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if ((DeviceIndex == 0) || (DeviceIndex > Private->ActiveNamespaceNum)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check BufferSize and StartLBA\r
  //\r
  NamespaceInfo = &(Private->NamespaceInfo[DeviceIndex - 1]);\r
  BlockSize = NamespaceInfo->Media.BlockSize;\r
  if (BufferSize % BlockSize != 0) {\r
    return EFI_BAD_BUFFER_SIZE;\r
  }\r
\r
  if (StartLBA > NamespaceInfo->Media.LastBlock) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  NumberOfBlocks = BufferSize / BlockSize;\r
  if (NumberOfBlocks - 1 > NamespaceInfo->Media.LastBlock - StartLBA) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return NvmeRead (NamespaceInfo, (UINTN)Buffer, StartLBA, NumberOfBlocks);\r
}\r
\r
/**\r
  Gets the count of block I/O devices that one specific block driver detects.\r
\r
  This function is used for getting the count of block I/O devices that one\r
  specific block driver detects. If no device is detected, then the function\r
  will return zero.\r
\r
  @param[in]  PeiServices          General-purpose services that are available\r
                                   to every PEIM.\r
  @param[in]  This                 Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI\r
                                   instance.\r
  @param[out] NumberBlockDevices   The number of block I/O devices discovered.\r
\r
  @retval     EFI_SUCCESS          The operation performed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
NvmeBlockIoPeimGetDeviceNo2 (\r
  IN  EFI_PEI_SERVICES                **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,\r
  OUT UINTN                           *NumberBlockDevices\r
  )\r
{\r
  PEI_NVME_CONTROLLER_PRIVATE_DATA    *Private;\r
\r
  if (This == NULL || NumberBlockDevices == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GET_NVME_PEIM_HC_PRIVATE_DATA_FROM_THIS_BLKIO2 (This);\r
  *NumberBlockDevices = Private->ActiveNamespaceNum;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Gets a block device's media information.\r
\r
  This function will provide the caller with the specified block device's media\r
  information. If the media changes, calling this function will update the media\r
  information accordingly.\r
\r
  @param[in]  PeiServices   General-purpose services that are available to every\r
                            PEIM\r
  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.\r
  @param[in]  DeviceIndex   Specifies the block device to which the function wants\r
                            to talk. Because the driver that implements Block I/O\r
                            PPIs will manage multiple block devices, the PPIs that\r
                            want to talk to a single device must specify the\r
                            device index that was assigned during the enumeration\r
                            process. This index is a number from one to\r
                            NumberBlockDevices.\r
  @param[out] MediaInfo     The media information of the specified block media.\r
                            The caller is responsible for the ownership of this\r
                            data structure.\r
\r
  @par Note:\r
      The MediaInfo structure describes an enumeration of possible block device\r
      types.  This enumeration exists because no device paths are actually passed\r
      across interfaces that describe the type or class of hardware that is publishing\r
      the block I/O interface. This enumeration will allow for policy decisions\r
      in the Recovery PEIM, such as "Try to recover from legacy floppy first,\r
      LS-120 second, CD-ROM third." If there are multiple partitions abstracted\r
      by a given device type, they should be reported in ascending order; this\r
      order also applies to nested partitions, such as legacy MBR, where the\r
      outermost partitions would have precedence in the reporting order. The\r
      same logic applies to systems such as IDE that have precedence relationships\r
      like "Master/Slave" or "Primary/Secondary". The master device should be\r
      reported first, the slave second.\r
\r
  @retval EFI_SUCCESS        Media information about the specified block device\r
                             was obtained successfully.\r
  @retval EFI_DEVICE_ERROR   Cannot get the media information due to a hardware\r
                             error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
NvmeBlockIoPeimGetMediaInfo2 (\r
  IN  EFI_PEI_SERVICES                **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,\r
  IN  UINTN                           DeviceIndex,\r
  OUT EFI_PEI_BLOCK_IO2_MEDIA         *MediaInfo\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  PEI_NVME_CONTROLLER_PRIVATE_DATA    *Private;\r
  EFI_PEI_BLOCK_IO_MEDIA              Media;\r
\r
  if (This == NULL || MediaInfo == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GET_NVME_PEIM_HC_PRIVATE_DATA_FROM_THIS_BLKIO2 (This);\r
\r
  Status  = NvmeBlockIoPeimGetMediaInfo (\r
              PeiServices,\r
              &Private->BlkIoPpi,\r
              DeviceIndex,\r
              &Media\r
              );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  CopyMem (\r
    MediaInfo,\r
    &(Private->NamespaceInfo[DeviceIndex - 1].Media),\r
    sizeof (EFI_PEI_BLOCK_IO2_MEDIA)\r
    );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Reads the requested number of blocks from the specified block device.\r
\r
  The function reads the requested number of blocks from the device. All the\r
  blocks are read, or an error is returned. If there is no media in the device,\r
  the function returns EFI_NO_MEDIA.\r
\r
  @param[in]  PeiServices   General-purpose services that are available to\r
                            every PEIM.\r
  @param[in]  This          Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.\r
  @param[in]  DeviceIndex   Specifies the block device to which the function wants\r
                            to talk. Because the driver that implements Block I/O\r
                            PPIs will manage multiple block devices, PPIs that\r
                            want to talk to a single device must specify the device\r
                            index that was assigned during the enumeration process.\r
                            This index is a number from one to NumberBlockDevices.\r
  @param[in]  StartLBA      The starting logical block address (LBA) to read from\r
                            on the device\r
  @param[in]  BufferSize    The size of the Buffer in bytes. This number must be\r
                            a multiple of the intrinsic block size of the device.\r
  @param[out] Buffer        A pointer to the destination buffer for the data.\r
                            The caller is responsible for the ownership of the\r
                            buffer.\r
\r
  @retval EFI_SUCCESS             The data was read correctly from the device.\r
  @retval EFI_DEVICE_ERROR        The device reported an error while attempting\r
                                  to perform the read operation.\r
  @retval EFI_INVALID_PARAMETER   The read request contains LBAs that are not\r
                                  valid, or the buffer is not properly aligned.\r
  @retval EFI_NO_MEDIA            There is no media in the device.\r
  @retval EFI_BAD_BUFFER_SIZE     The BufferSize parameter is not a multiple of\r
                                  the intrinsic block size of the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
NvmeBlockIoPeimReadBlocks2 (\r
  IN  EFI_PEI_SERVICES                **PeiServices,\r
  IN  EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,\r
  IN  UINTN                           DeviceIndex,\r
  IN  EFI_PEI_LBA                     StartLBA,\r
  IN  UINTN                           BufferSize,\r
  OUT VOID                            *Buffer\r
  )\r
{\r
  PEI_NVME_CONTROLLER_PRIVATE_DATA    *Private;\r
\r
  if (This == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = GET_NVME_PEIM_HC_PRIVATE_DATA_FROM_THIS_BLKIO2 (This);\r
  return NvmeBlockIoPeimReadBlocks (\r
           PeiServices,\r
           &Private->BlkIoPpi,\r
           DeviceIndex,\r
           StartLBA,\r
           BufferSize,\r
           Buffer\r
           );\r
}\r