MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Library / BaseLib / Unaligned.c

diff --git a/MdePkg/Library/BaseLib/Unaligned.c b/MdePkg/Library/BaseLib/Unaligned.c
index a54a99e7e60d4c177d7a54b2ce0f72082e583599..a419cb85e53c42275d181d3e6d1ea04c42231a92 100644 (file)
--- a/MdePkg/Library/BaseLib/Unaligned.c
+++ b/MdePkg/Library/BaseLib/Unaligned.c
@@ -1,18 +1,14 @@
 /** @file\r
   Unaligned access functions of BaseLib.\r
 \r
-  Copyright (c) 2006, 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) 2006 - 2010, 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
 \r
-  Module Name:  Unaligned.c\r
 \r
-**/\r
+#include "BaseLibInternals.h"\r
+\r
 \r
 /**\r
   Reads a 16-bit value from memory that may be unaligned.\r
@@ -22,15 +18,15 @@
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 16-bit value that may be unaligned.\r
+  @param  Buffer  A pointer to a 16-bit value that may be unaligned.\r
 \r
-  @return *Uint16\r
+  @return The 16-bit value read from Buffer.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 ReadUnaligned16 (\r
-  IN      CONST UINT16              *Buffer\r
+  IN CONST UINT16              *Buffer\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -47,17 +43,17 @@ ReadUnaligned16 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 16-bit value that may be unaligned.\r
+  @param  Buffer  A pointer to a 16-bit value that may be unaligned.\r
   @param  Value   16-bit value to write to Buffer.\r
 \r
-  @return Value\r
+  @return The 16-bit value to write to Buffer.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 WriteUnaligned16 (\r
-  OUT     UINT16                    *Buffer,\r
-  IN      UINT16                    Value\r
+  OUT UINT16                    *Buffer,\r
+  IN  UINT16                    Value\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -73,15 +69,15 @@ WriteUnaligned16 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 24-bit value that may be unaligned.\r
+  @param  Buffer  A pointer to a 24-bit value that may be unaligned.\r
 \r
-  @return The value read.\r
+  @return The 24-bit value read from Buffer.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 ReadUnaligned24 (\r
-  IN      CONST UINT32              *Buffer\r
+  IN CONST UINT32              *Buffer\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -98,22 +94,23 @@ ReadUnaligned24 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 24-bit value that may be unaligned.\r
+  @param  Buffer  A pointer to a 24-bit value that may be unaligned.\r
   @param  Value   24-bit value to write to Buffer.\r
 \r
-  @return The value written.\r
+  @return The 24-bit value to write to Buffer.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 WriteUnaligned24 (\r
-  OUT     UINT32                    *Buffer,\r
-  IN      UINT32                    Value\r
+  OUT UINT32                    *Buffer,\r
+  IN  UINT32                    Value\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
 \r
-  return *Buffer = BitFieldWrite32 (*Buffer, 0, 23, Value);\r
+  *Buffer = BitFieldWrite32 (*Buffer, 0, 23, Value);\r
+  return Value;\r
 }\r
 \r
 /**\r
@@ -124,15 +121,15 @@ WriteUnaligned24 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 32-bit value that may be unaligned.\r
+  @param  Buffer  A pointer to a 32-bit value that may be unaligned.\r
 \r
-  @return *Uint32\r
+  @return The 32-bit value read from Buffer.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 ReadUnaligned32 (\r
-  IN      CONST UINT32              *Buffer\r
+  IN CONST UINT32              *Buffer\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -149,17 +146,17 @@ ReadUnaligned32 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 32-bit value that may be unaligned.\r
-  @param  Value   32-bit value to write to Buffer.\r
+  @param  Buffer  A pointer to a 32-bit value that may be unaligned.\r
+  @param  Value   The 32-bit value to write to Buffer.\r
 \r
-  @return Value\r
+  @return The 32-bit value to write to Buffer.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 WriteUnaligned32 (\r
-  OUT     UINT32                    *Buffer,\r
-  IN      UINT32                    Value\r
+  OUT UINT32                    *Buffer,\r
+  IN  UINT32                    Value\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -175,15 +172,15 @@ WriteUnaligned32 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 64-bit value that may be unaligned.\r
+  @param  Buffer  A pointer to a 64-bit value that may be unaligned.\r
 \r
-  @return *Uint64\r
+  @return The 64-bit value read from Buffer.\r
 \r
 **/\r
 UINT64\r
 EFIAPI\r
 ReadUnaligned64 (\r
-  IN      CONST UINT64              *Buffer\r
+  IN CONST UINT64              *Buffer\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -200,17 +197,17 @@ ReadUnaligned64 (
 \r
   If the Buffer is NULL, then ASSERT().\r
 \r
-  @param  Buffer  Pointer to a 64-bit value that may be unaligned.\r
-  @param  Value   64-bit value to write to Buffer.\r
+  @param  Buffer  A pointer to a 64-bit value that may be unaligned.\r
+  @param  Value   The 64-bit value to write to Buffer.\r
 \r
-  @return Value\r
+  @return The 64-bit value to write to Buffer.\r
 \r
 **/\r
 UINT64\r
 EFIAPI\r
 WriteUnaligned64 (\r
-  OUT     UINT64                    *Buffer,\r
-  IN      UINT64                    Value\r
+  OUT UINT64                    *Buffer,\r
+  IN  UINT64                    Value\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r