MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbSupportFile.c

diff --git a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbSupportFile.c b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbSupportFile.c
index 617a5a844ff0cdb428c2f76f94117fb4fca94cdc..ee2f8fc2f2011a5cdccbfb41a943edb18093631c 100644 (file)
--- a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbSupportFile.c
+++ b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbSupportFile.c
@@ -1,25 +1,25 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, 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
+Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\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
 \r
-Module Name:\r
+**/\r
 \r
-  EdbSupportFile.c\r
-\r
-Abstract:\r
+#include "Edb.h"\r
 \r
+/**\r
+  Read a file.\r
 \r
---*/\r
+  @param  Vol             - File System Volume\r
+  @param  FileName        - The file to be read.\r
+  @param  BufferSize      - The file buffer size\r
+  @param  Buffer          - The file buffer\r
 \r
-#include "Edb.h"\r
+  @retval EFI_SUCCESS    - read file successfully\r
+  @retval EFI_NOT_FOUND  - file not found\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 ReadFileFromVol (\r
@@ -28,25 +28,6 @@ ReadFileFromVol (
   OUT UINTN                       *BufferSize,\r
   OUT VOID                        **Buffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Read a file.\r
-\r
-Arguments:\r
-\r
-  Vol             - File System Volume\r
-  FileName        - The file to be read.\r
-  BufferSize      - The file buffer size\r
-  Buffer          - The file buffer\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS    - read file successfully\r
-  EFI_NOT_FOUND  - file not found\r
-\r
---*/\r
 {\r
   EFI_STATUS                        Status;\r
   EFI_FILE_HANDLE                   RootDir;\r
@@ -138,6 +119,25 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+\r
+  Read a file.\r
+  If ScanFs is FLASE, it will use DebuggerPrivate->Vol as default Fs.\r
+  If ScanFs is TRUE, it will scan all FS and check the file.\r
+  If there is only one file match the name, it will be read.\r
+  If there is more than one file match the name, it will return Error.\r
+\r
+  @param  DebuggerPrivate - EBC Debugger private data structure\r
+  @param  FileName        - The file to be read.\r
+  @param  BufferSize      - The file buffer size\r
+  @param  Buffer          - The file buffer\r
+  @param  ScanFs          - Need Scan all FS\r
+\r
+  @retval EFI_SUCCESS    - read file successfully\r
+  @retval EFI_NOT_FOUND  - file not found\r
+  @retval EFI_NO_MAPPING - there is duplicated files found\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 ReadFileToBuffer (\r
@@ -147,31 +147,6 @@ ReadFileToBuffer (
   OUT VOID                        **Buffer,\r
   IN  BOOLEAN                     ScanFs\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Read a file.\r
-  If ScanFs is FLASE, it will use DebuggerPrivate->Vol as default Fs.\r
-  If ScanFs is TRUE, it will scan all FS and check the file.\r
-    If there is only one file match the name, it will be read.\r
-    If there is more than one file match the name, it will return Error.\r
-\r
-Arguments:\r
-\r
-  DebuggerPrivate - EBC Debugger private data structure\r
-  FileName        - The file to be read.\r
-  BufferSize      - The file buffer size\r
-  Buffer          - The file buffer\r
-  ScanFs          - Need Scan all FS\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS    - read file successfully\r
-  EFI_NOT_FOUND  - file not found\r
-  EFI_NO_MAPPING - there is duplicated files found\r
-\r
---*/\r
 {\r
   EFI_STATUS                        Status;\r
   EFI_SIMPLE_FILE_SYSTEM_PROTOCOL   *Vol;\r
@@ -272,6 +247,18 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+\r
+  Get file name under this dir with index\r
+\r
+  @param  DebuggerPrivate - EBC Debugger private data structure\r
+  @param  DirName         - The dir to be read.\r
+  @param  FileName        - The file name pattern under this dir\r
+  @param  Index           - The file index under this dir\r
+\r
+  @return File Name which match the pattern and index.\r
+\r
+**/\r
 CHAR16 *\r
 EFIAPI\r
 GetFileNameUnderDir (\r
@@ -280,24 +267,6 @@ GetFileNameUnderDir (
   IN  CHAR16                      *FileName,\r
   IN OUT UINTN                    *Index\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Get file name under this dir with index\r
-\r
-Arguments:\r
-\r
-  DebuggerPrivate - EBC Debugger private data structure\r
-  DirName         - The dir to be read.\r
-  FileName        - The file name pattern under this dir\r
-  Index           - The file index under this dir\r
-\r
-Returns:\r
-\r
-  File Name which match the pattern and index.\r
-\r
---*/\r
 {\r
   EFI_STATUS                        Status;\r
   EFI_FILE_HANDLE                   RootDir;\r