Synchronize function comment in MdePkg\Library\BaseLib.h with the instance of this...

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

/** @file\r
  Math worker functions.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\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
\r
**/\r
\r
\r
\r
\r
#include "BaseLibInternals.h"\r
\r
/**\r
  Switches the endianess of a 16-bit integer.\r
\r
  This function swaps the bytes in a 16-bit unsigned value to switch the value\r
  from little endian to big endian or vice versa. The byte swapped value is\r
  returned.\r
\r
  @param  Value Operand A 16-bit unsigned value.\r
\r
  @return The byte swapped Operand.\r
\r
**/\r
UINT16\r
EFIAPI\r
SwapBytes16 (\r
  IN      UINT16                    Operand\r
  )\r
{\r
  return (UINT16) ((Operand << 8) | (Operand >> 8));\r
}\r