Update the comments.

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

/** @file\r
  IA-32/x64 AsmFxSave()\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
// Include common header file for this module.\r
//\r
\r
\r
#include "BaseLibInternals.h"\r
\r
/**\r
  Save the current floating point/SSE/SSE2 context to a buffer.\r
\r
  Saves the current floating point/SSE/SSE2 state to the buffer specified by\r
  Buffer. Buffer must be aligned on a 16-byte boundary. This function is only\r
  available on IA-32 and X64.\r
\r
  If Buffer is NULL, then ASSERT().\r
  If Buffer is not aligned on a 16-byte boundary, then ASSERT().\r
\r
  @param  Buffer  Pointer to a buffer to save the floating point/SSE/SSE2 context.\r
\r
**/\r
VOID\r
EFIAPI\r
AsmFxSave (\r
  OUT     IA32_FX_BUFFER            *Buffer\r
  )\r
{\r
  ASSERT (Buffer != NULL);\r
  ASSERT (0 == ((UINTN)Buffer & 0xf));\r
\r
  InternalX86FxSave (Buffer);\r
\r
  //\r
  // Mark one flag at end of Buffer, it will be check by AsmFxRestor()\r
  //\r
  *(UINT32 *) (&Buffer[sizeof (IA32_FX_BUFFER) - 4]) = 0xAA5555AA;\r
}\r