MdePkg: Fix OUT parameters marked as IN OUT

[mirror_edk2.git] / MdePkg / Include / Protocol / Bds.h

diff --git a/MdePkg/Include/Protocol/Bds.h b/MdePkg/Include/Protocol/Bds.h
index 843c5e9445be5d30cfb2f7b500420775754765be..bda2c37c08cebc95f4885ffff2dc241a396b2324 100644 (file)
--- a/MdePkg/Include/Protocol/Bds.h
+++ b/MdePkg/Include/Protocol/Bds.h
@@ -3,14 +3,8 @@
 \r
   When the DXE core is done it calls the BDS via this protocol.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. 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
 **/\r
 \r
@@ -29,19 +23,19 @@
 typedef struct _EFI_BDS_ARCH_PROTOCOL   EFI_BDS_ARCH_PROTOCOL;\r
 \r
 /**\r
-  This function uses policy data from the platform to determine what operating \r
-  system or system utility should be loaded and invoked.  This function call \r
-  also optionally make the use of user input to determine the operating system \r
-  or system utility to be loaded and invoked.  When the DXE Core has dispatched \r
-  all the drivers on the dispatch queue, this function is called.  This \r
-  function will attempt to connect the boot devices required to load and invoke \r
-  the selected operating system or system utility.  During this process, \r
-  additional firmware volumes may be discovered that may contain addition DXE \r
-  drivers that can be dispatched by the DXE Core.   If a boot device cannot be \r
-  fully connected, this function calls the DXE Service Dispatch() to allow the \r
-  DXE drivers from any newly discovered firmware volumes to be dispatched.  \r
-  Then the boot device connection can be attempted again.  If the same boot \r
-  device connection operation fails twice in a row, then that boot device has \r
+  This function uses policy data from the platform to determine what operating\r
+  system or system utility should be loaded and invoked.  This function call\r
+  also optionally make the use of user input to determine the operating system\r
+  or system utility to be loaded and invoked.  When the DXE Core has dispatched\r
+  all the drivers on the dispatch queue, this function is called.  This\r
+  function will attempt to connect the boot devices required to load and invoke\r
+  the selected operating system or system utility.  During this process,\r
+  additional firmware volumes may be discovered that may contain addition DXE\r
+  drivers that can be dispatched by the DXE Core.   If a boot device cannot be\r
+  fully connected, this function calls the DXE Service Dispatch() to allow the\r
+  DXE drivers from any newly discovered firmware volumes to be dispatched.\r
+  Then the boot device connection can be attempted again.  If the same boot\r
+  device connection operation fails twice in a row, then that boot device has\r
   failed, and should be skipped.  This function should never return.\r
 \r
   @param  This             The EFI_BDS_ARCH_PROTOCOL instance.\r
@@ -55,24 +49,14 @@ VOID
   IN EFI_BDS_ARCH_PROTOCOL  *This\r
   );\r
 \r
-/**\r
-  Interface stucture for the BDS Architectural Protocol.\r
-\r
-  @par Protocol Description:\r
-  The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating \r
-  system or a system utility.  If there are not enough drivers initialized \r
-  when this protocol is used to access the required boot device(s), then \r
-  this protocol should add drivers to the dispatch queue and return control \r
-  back to the dispatcher.  Once the required boot devices are available, then \r
-  the boot device can be used to load and invoke an OS or a system utility.\r
-\r
-  @par Protocol Parameters:\r
-  Entry - The entry point to BDS.  This call does not take any parameters, \r
-  and the return value can be ignored.  If it returns, then the \r
-  dispatcher must be invoked again, if it never returns, then an \r
-  operating system or a system utility have been invoked.\r
-\r
-**/\r
+///\r
+/// The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating\r
+/// system or a system utility.  If there are not enough drivers initialized\r
+/// when this protocol is used to access the required boot device(s), then\r
+/// this protocol should add drivers to the dispatch queue and return control\r
+/// back to the dispatcher.  Once the required boot devices are available, then\r
+/// the boot device can be used to load and invoke an OS or a system utility.\r
+///\r
 struct _EFI_BDS_ARCH_PROTOCOL {\r
   EFI_BDS_ENTRY Entry;\r
 };\r