Update IndustryStandard according to code review comments.

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Sal.h

/** @file\r
  Main SAL API's defined in Intel Itanium Processor Family System Abstraction\r
  Layer Specification Revision 3.2 (December 2003)\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
\r
**/\r
\r
#ifndef __SAL_API_H__\r
#define __SAL_API_H__\r
\r
///\r
/// SAL return status type \r
///\r
typedef UINTN EFI_SAL_STATUS;\r
\r
///\r
/// Call completed without error. \r
///\r
#define EFI_SAL_SUCCESS               ((EFI_SAL_STATUS) 0)\r
///\r
/// Call completed without error but some information was lost due to overflow. \r
///\r
#define EFI_SAL_OVERFLOW              ((EFI_SAL_STATUS) 1)\r
///\r
/// Call completed without error; effect a warm boot of the system to complete the update.\r
///\r
#define EFI_SAL_WARM_BOOT_NEEDED      ((EFI_SAL_STATUS) 2)\r
///\r
/// More information is available for retrieval. \r
///\r
#define EFI_SAL_MORE_RECORDS          ((EFI_SAL_STATUS) 3)\r
///\r
/// Not implemented.\r
///\r
#define EFI_SAL_NOT_IMPLEMENTED       ((EFI_SAL_STATUS) - 1)\r
///\r
/// Invalid Argument.\r
///\r
#define EFI_SAL_INVALID_ARGUMENT      ((EFI_SAL_STATUS) - 2)\r
///\r
/// Call completed without error. \r
///\r
#define EFI_SAL_ERROR                 ((EFI_SAL_STATUS) - 3)\r
///\r
/// Virtual address not registered. \r
///\r
#define EFI_SAL_VIRTUAL_ADDRESS_ERROR ((EFI_SAL_STATUS) - 4)\r
///\r
/// No information available. \r
///\r
#define EFI_SAL_NO_INFORMATION        ((EFI_SAL_STATUS) - 5)\r
///\r
/// Scratch buffer required.\r
///\r
#define EFI_SAL_NOT_ENOUGH_SCRATCH    ((EFI_SAL_STATUS) - 9)\r
\r
///\r
/// Return registers from SAL\r
///\r
typedef struct {\r
  ///\r
  /// SAL return status value in r8\r
  ///\r
  EFI_SAL_STATUS  Status;\r
  ///\r
  /// SAL returned value in r9\r
  ///\r
  UINTN           r9;\r
  ///\r
  /// SAL returned value in r10\r
  ///\r
  UINTN           r10;\r
  ///\r
  /// SAL returned value in r11\r
  ///\r
  UINTN           r11;\r
} SAL_RETURN_REGS;\r
\r
/**\r
  Prototype of SAL procedures.\r
\r
  @param  Arg0               Functional identifier.\r
                             The upper 32 bits are ignored and only the lower 32 bits\r
                             are used. The following functional identifiers are defined:\r