]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/DiskInfo.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Protocol / DiskInfo.h
index a04c13b5269ec3bfa65ce3960ed0316400b9f653..32fe7140da601804ef0b20c3819bda3d484a1ef6 100644 (file)
@@ -1,20 +1,14 @@
 /** @file\r
-  Provides the basic interfaces to abstract platform information regarding an \r
-  IDE controller.  \r
+  Provides the basic interfaces to abstract platform information regarding an\r
+  IDE controller.\r
 \r
-  Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
-  This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference:\r
-  This Protocol is defined in UEFI Platform Initialization Specification 1.\r
+  This Protocol is defined in UEFI Platform Initialization Specification 1.6\r
   Volume 5: Standards\r
-  \r
+\r
 **/\r
 \r
 #ifndef __DISK_INFO_H__\r
@@ -31,7 +25,7 @@
 ///\r
 /// Forward declaration for EFI_DISK_INFO_PROTOCOL\r
 ///\r
-typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;\r
+typedef struct _EFI_DISK_INFO_PROTOCOL EFI_DISK_INFO_PROTOCOL;\r
 \r
 ///\r
 /// Global ID for an IDE interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r
@@ -73,9 +67,25 @@ typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
     0x3ab14680, 0x5d3f, 0x4a4d, {0xbc, 0xdc, 0xcc, 0x38, 0x0, 0x18, 0xc7, 0xf7 } \\r
   }\r
 \r
+///\r
+/// Global ID for a UFS interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r
+///\r
+#define EFI_DISK_INFO_UFS_INTERFACE_GUID \\r
+  { \\r
+    0x4b3029cc, 0x6b98, 0x47fb, { 0xbc, 0x96, 0x76, 0xdc, 0xb8, 0x4, 0x41, 0xf0 } \\r
+  }\r
+\r
+///\r
+/// Global ID for an SD/MMC interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r
+///\r
+#define EFI_DISK_INFO_SD_MMC_INTERFACE_GUID \\r
+  { \\r
+    0x8deec992, 0xd39c, 0x4a5c, { 0xab, 0x6b, 0x98, 0x6e, 0x14, 0x24, 0x2b, 0x9d } \\r
+  }\r
+\r
 /**\r
   Provides inquiry information for the controller type.\r
-  \r
+\r
   This function is used by the IDE bus driver to get inquiry data.  Data format\r
   of Identify data is defined by the Interface GUID.\r
 \r
@@ -84,9 +94,9 @@ typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
   @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
+  @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
 typedef\r
@@ -103,16 +113,16 @@ EFI_STATUS
   This function is used by the IDE bus driver 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
+  @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
+  @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
 typedef\r
@@ -125,8 +135,8 @@ EFI_STATUS
 \r
 /**\r
   Provides sense data information for the controller type.\r
-  \r
-  This function is used by the IDE bus driver to get sense data. \r
+\r
+  This function is used by the IDE bus driver 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
@@ -152,7 +162,7 @@ EFI_STATUS
 /**\r
   This function is used by the IDE bus driver to get controller information.\r
 \r
-  @param[in]  This         Pointer to the EFI_DISK_INFO_PROTOCOL instance. \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
@@ -173,36 +183,39 @@ EFI_STATUS
 ///\r
 struct _EFI_DISK_INFO_PROTOCOL {\r
   ///\r
-  /// A GUID that defines the format of buffers for the other member functions \r
+  /// A GUID that defines the format of buffers for the other member functions\r
   /// of this protocol.\r
   ///\r
-  EFI_GUID                  Interface;\r
+  EFI_GUID                    Interface;\r
   ///\r
   /// Return the results of the Inquiry command to a drive in InquiryData. Data\r
   /// format of Inquiry data is defined by the Interface GUID.\r
   ///\r
-  EFI_DISK_INFO_INQUIRY     Inquiry;\r
+  EFI_DISK_INFO_INQUIRY       Inquiry;\r
   ///\r
   /// Return the results of the Identify command to a drive in IdentifyData. Data\r
   /// format of Identify data is defined by the Interface GUID.\r
   ///\r
-  EFI_DISK_INFO_IDENTIFY    Identify;\r
+  EFI_DISK_INFO_IDENTIFY      Identify;\r
   ///\r
   /// Return the results of the Request Sense command to a drive in SenseData. Data\r
   /// format of Sense data is defined by the Interface GUID.\r
   ///\r
-  EFI_DISK_INFO_SENSE_DATA  SenseData;\r
+  EFI_DISK_INFO_SENSE_DATA    SenseData;\r
   ///\r
-  /// Specific controller. \r
+  /// Specific controller.\r
   ///\r
-  EFI_DISK_INFO_WHICH_IDE   WhichIde;\r
+  EFI_DISK_INFO_WHICH_IDE     WhichIde;\r
 };\r
 \r
-extern EFI_GUID gEfiDiskInfoProtocolGuid;\r
+extern EFI_GUID  gEfiDiskInfoProtocolGuid;\r
 \r
-extern EFI_GUID gEfiDiskInfoIdeInterfaceGuid;\r
-extern EFI_GUID gEfiDiskInfoScsiInterfaceGuid;\r
-extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;\r
-extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;\r
+extern EFI_GUID  gEfiDiskInfoIdeInterfaceGuid;\r
+extern EFI_GUID  gEfiDiskInfoScsiInterfaceGuid;\r
+extern EFI_GUID  gEfiDiskInfoUsbInterfaceGuid;\r
+extern EFI_GUID  gEfiDiskInfoAhciInterfaceGuid;\r
+extern EFI_GUID  gEfiDiskInfoNvmeInterfaceGuid;\r
+extern EFI_GUID  gEfiDiskInfoUfsInterfaceGuid;\r
+extern EFI_GUID  gEfiDiskInfoSdMmcInterfaceGuid;\r
 \r
 #endif\r