MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMassStorageDxe / UsbMassDiskInfo.c

/** @file\r
  This file is used to implement the EFI_DISK_INFO_PROTOCOL interface.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UsbMass.h"\r
\r
EFI_DISK_INFO_PROTOCOL gUsbDiskInfoProtocolTemplate = {\r
  EFI_DISK_INFO_USB_INTERFACE_GUID,\r
  UsbDiskInfoInquiry,\r
  UsbDiskInfoIdentify,\r
  UsbDiskInfoSenseData,\r
  UsbDiskInfoWhichIde\r
};\r
\r
/**\r
  Initialize the installation of DiskInfo protocol.\r
\r
  This function prepares for the installation of DiskInfo protocol on the child handle.\r
  By default, it installs DiskInfo protocol with USB interface GUID.\r
\r
  @param[in]  UsbMass  The pointer of USB_MASS_DEVICE.\r
\r
**/\r
VOID\r
InitializeDiskInfo (\r
  IN  USB_MASS_DEVICE   *UsbMass\r
  )\r
{\r
  CopyMem (&UsbMass->DiskInfo, &gUsbDiskInfoProtocolTemplate, sizeof (gUsbDiskInfoProtocolTemplate));\r
}\r
\r
\r
/**\r
  Provides inquiry information for the controller type.\r
\r
  This function is used to get inquiry data.  Data format\r
  of Identify data is defined by the Interface GUID.\r
\r
  @param[in]      This              Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
  @param[in, out] InquiryData       Pointer to a buffer for the inquiry data.\r
  @param[in, out] InquiryDataSize   Pointer to the value for the inquiry data size.\r
\r
  @retval EFI_SUCCESS            The command was accepted without any errors.\r
  @retval EFI_NOT_FOUND          Device does not support this data class\r
  @retval EFI_DEVICE_ERROR       Error reading InquiryData from device\r
  @retval EFI_BUFFER_TOO_SMALL   InquiryDataSize not big enough\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbDiskInfoInquiry (\r
  IN     EFI_DISK_INFO_PROTOCOL   *This,\r
  IN OUT VOID                     *InquiryData,\r
  IN OUT UINT32                   *InquiryDataSize\r
  )\r
{\r
  EFI_STATUS        Status;\r
  USB_MASS_DEVICE   *UsbMass;\r
\r
  UsbMass  = USB_MASS_DEVICE_FROM_DISK_INFO (This);\r
\r
  Status = EFI_BUFFER_TOO_SMALL;\r
  if (*InquiryDataSize >= sizeof (UsbMass->InquiryData)) {\r
    Status = EFI_SUCCESS;\r
    CopyMem (InquiryData, &UsbMass->InquiryData, sizeof (UsbMass->InquiryData));\r
  }\r
  *InquiryDataSize = sizeof (UsbMass->InquiryData);\r
  return Status;\r
}\r
\r
\r
/**\r
  Provides identify information for the controller type.\r
\r
  This function is used to get identify data.  Data format\r
  of Identify data is defined by the Interface GUID.\r
\r
  @param[in]      This              Pointer to the EFI_DISK_INFO_PROTOCOL\r
                                    instance.\r
  @param[in, out] IdentifyData      Pointer to a buffer for the identify data.\r
  @param[in, out] IdentifyDataSize  Pointer to the value for the identify data\r
                                    size.\r
\r
  @retval EFI_SUCCESS            The command was accepted without any errors.\r
  @retval EFI_NOT_FOUND          Device does not support this data class\r
  @retval EFI_DEVICE_ERROR       Error reading IdentifyData from device\r
  @retval EFI_BUFFER_TOO_SMALL   IdentifyDataSize not big enough\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbDiskInfoIdentify (\r
  IN     EFI_DISK_INFO_PROTOCOL   *This,\r
  IN OUT VOID                     *IdentifyData,\r
  IN OUT UINT32                   *IdentifyDataSize\r
  )\r
{\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Provides sense data information for the controller type.\r
\r
  This function is used to get sense data.\r
  Data format of Sense data is defined by the Interface GUID.\r
\r
  @param[in]      This              Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
  @param[in, out] SenseData         Pointer to the SenseData.\r
  @param[in, out] SenseDataSize     Size of SenseData in bytes.\r
  @param[out]     SenseDataNumber   Pointer to the value for the sense data size.\r
\r
  @retval EFI_SUCCESS            The command was accepted without any errors.\r
  @retval EFI_NOT_FOUND          Device does not support this data class.\r
  @retval EFI_DEVICE_ERROR       Error reading SenseData from device.\r
  @retval EFI_BUFFER_TOO_SMALL   SenseDataSize not big enough.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbDiskInfoSenseData (\r
  IN     EFI_DISK_INFO_PROTOCOL   *This,\r
  IN OUT VOID                     *SenseData,\r
  IN OUT UINT32                   *SenseDataSize,\r
  OUT    UINT8                    *SenseDataNumber\r
  )\r
{\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
/**\r
  This function is used to get controller information.\r
\r
  @param[in]  This         Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
  @param[out] IdeChannel   Pointer to the Ide Channel number.  Primary or secondary.\r
  @param[out] IdeDevice    Pointer to the Ide Device number.  Master or slave.\r
\r
  @retval EFI_SUCCESS       IdeChannel and IdeDevice are valid.\r
  @retval EFI_UNSUPPORTED   This is not an IDE device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbDiskInfoWhichIde (\r
  IN  EFI_DISK_INFO_PROTOCOL   *This,\r
  OUT UINT32                   *IdeChannel,\r
  OUT UINT32                   *IdeDevice\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r