MdeModulePkg/Bus/Usb/UsbMassStorageDxe/UsbMassDiskInfo.h

   1 /** @file
   2   Header file for EFI_DISK_INFO_PROTOCOL interface.
   3
   4 Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 /**
  16   Initialize the installation of DiskInfo protocol.
  17
  18   This function prepares for the installation of DiskInfo protocol on the child handle.
  19   By default, it installs DiskInfo protocol with USB interface GUID.
  20
  21   @param  UsbMass  The pointer of USB_MASS_DEVICE.
  22
  23 **/
  24 VOID
  25 InitializeDiskInfo (
  26   IN  USB_MASS_DEVICE   *UsbMass
  27   );
  28
  29
  30 /**
  31   Provides inquiry information for the controller type.
  32
  33   This function is used to get inquiry data.  Data format
  34   of Identify data is defined by the Interface GUID.
  35
  36   @param[in]      This              Pointer to the EFI_DISK_INFO_PROTOCOL instance.
  37   @param[in, out] InquiryData       Pointer to a buffer for the inquiry data.
  38   @param[in, out] InquiryDataSize   Pointer to the value for the inquiry data size.
  39
  40   @retval EFI_SUCCESS            The command was accepted without any errors.
  41   @retval EFI_NOT_FOUND          Device does not support this data class
  42   @retval EFI_DEVICE_ERROR       Error reading InquiryData from device
  43   @retval EFI_BUFFER_TOO_SMALL   InquiryDataSize not big enough
  44
  45 **/
  46 EFI_STATUS
  47 EFIAPI
  48 UsbDiskInfoInquiry (
  49   IN     EFI_DISK_INFO_PROTOCOL   *This,
  50   IN OUT VOID                     *InquiryData,
  51   IN OUT UINT32                   *InquiryDataSize
  52   );
  53
  54 /**
  55   Provides identify information for the controller type.
  56
  57   This function is used to get identify data.  Data format
  58   of Identify data is defined by the Interface GUID.
  59
  60   @param[in]      This              Pointer to the EFI_DISK_INFO_PROTOCOL
  61                                     instance.
  62   @param[in, out] IdentifyData      Pointer to a buffer for the identify data.
  63   @param[in, out] IdentifyDataSize  Pointer to the value for the identify data
  64                                     size.
  65
  66   @retval EFI_SUCCESS            The command was accepted without any errors.
  67   @retval EFI_NOT_FOUND          Device does not support this data class
  68   @retval EFI_DEVICE_ERROR       Error reading IdentifyData from device
  69   @retval EFI_BUFFER_TOO_SMALL   IdentifyDataSize not big enough
  70
  71 **/
  72 EFI_STATUS
  73 EFIAPI
  74 UsbDiskInfoIdentify (
  75   IN     EFI_DISK_INFO_PROTOCOL   *This,
  76   IN OUT VOID                     *IdentifyData,
  77   IN OUT UINT32                   *IdentifyDataSize
  78   );
  79
  80 /**
  81   Provides sense data information for the controller type.
  82
  83   This function is used to get sense data.
  84   Data format of Sense data is defined by the Interface GUID.
  85
  86   @param[in]      This              Pointer to the EFI_DISK_INFO_PROTOCOL instance.
  87   @param[in, out] SenseData         Pointer to the SenseData.
  88   @param[in, out] SenseDataSize     Size of SenseData in bytes.
  89   @param[out]     SenseDataNumber   Pointer to the value for the sense data size.
  90
  91   @retval EFI_SUCCESS            The command was accepted without any errors.
  92   @retval EFI_NOT_FOUND          Device does not support this data class.
  93   @retval EFI_DEVICE_ERROR       Error reading SenseData from device.
  94   @retval EFI_BUFFER_TOO_SMALL   SenseDataSize not big enough.
  95
  96 **/
  97 EFI_STATUS
  98 EFIAPI
  99 UsbDiskInfoSenseData (
 100   IN     EFI_DISK_INFO_PROTOCOL   *This,
 101   IN OUT VOID                     *SenseData,
 102   IN OUT UINT32                   *SenseDataSize,
 103   OUT    UINT8                    *SenseDataNumber
 104   );
 105
 106
 107 /**
 108   This function is used to get controller information.
 109
 110   @param[in]  This         Pointer to the EFI_DISK_INFO_PROTOCOL instance.
 111   @param[out] IdeChannel   Pointer to the Ide Channel number.  Primary or secondary.
 112   @param[out] IdeDevice    Pointer to the Ide Device number.  Master or slave.
 113
 114   @retval EFI_SUCCESS       IdeChannel and IdeDevice are valid.
 115   @retval EFI_UNSUPPORTED   This is not an IDE device.
 116
 117 **/
 118 EFI_STATUS
 119 EFIAPI
 120 UsbDiskInfoWhichIde (
 121   IN  EFI_DISK_INFO_PROTOCOL   *This,
 122   OUT UINT32                   *IdeChannel,
 123   OUT UINT32                   *IdeDevice
 124   );
 125