[mirror_edk2.git] / MdePkg / Include / Library / PalCallLib.h

/** @file\r
  PAL Call Services\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
\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 __PAL_CALL_LIB_H__\r
#define __PAL_CALL_LIB_H__\r
\r
\r
#include <Base.h>\r
//\r
// PAL_CALL_RETURN\r
//\r
\r
/**\r
  Makes a PAL procedure call.\r
\r
  This is a wrapper function to make a PAL procedure call.  Based on the Index value,\r
  this API will make static or stacked PAL call. Architected procedures may be designated\r
  as required or optional.  If a PAL procedure is specified as optional, a unique return\r
  code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.\r
  This indicates that the procedure is not present in this PAL implementation.  It is the\r
Commit	Line	Data
fb3df220	1	/** @file\r
	2	PAL Call Services\r
	3	\r
	4	Copyright (c) 2006, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
fb3df220	13	**/\r
	14	\r
	15	#ifndef __PAL_CALL_LIB_H__\r
	16	#define __PAL_CALL_LIB_H__\r
	17	\r
	18	\r
	19	#include <Base.h>\r
	20	//\r
	21	// PAL_CALL_RETURN\r
	22	//\r
	23	\r
	24	/**\r
	25	Makes a PAL procedure call.\r
	26	\r
	27	This is a wrapper function to make a PAL procedure call. Based on the Index value,\r
	28	this API will make static or stacked PAL call. Architected procedures may be designated\r
	29	as required or optional. If a PAL procedure is specified as optional, a unique return\r
	30	code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.\r
	31	This indicates that the procedure is not present in this PAL implementation. It is the\r
	32