/** @file\r
Definition of Extended SAL Boot Service Protocol\r
\r
- The Extended SAL Boot Service Protocol provides a mechanisms for platform specific \r
+ The Extended SAL Boot Service Protocol provides a mechanisms for platform specific\r
drivers to update the SAL System Table and register Extended SAL Procedures that are\r
callable in physical or virtual mode using the SAL calling convention.\r
\r
- Copyright (c) 2009, 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) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ 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
+ 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
the major revision and the lower byte contains the minor revision.\r
@param OemId A pointer to a Null-terminated ASCII string that contains OEM unique string.\r
The string cannot be longer than 32 bytes in total length\r
- @param ProductId A pointer to a Null-terminated ASCII string that uniquely identifies a family of \r
+ @param ProductId A pointer to a Null-terminated ASCII string that uniquely identifies a family of\r
compatible products. The string cannot be longer than 32 bytes in total length.\r
\r
@retval EFI_SUCCESS The SAL System Table header was updated successfully.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EXTENDED_SAL_ADD_SST_INFO) (\r
+(EFIAPI *EXTENDED_SAL_ADD_SST_INFO)(\r
IN EXTENDED_SAL_BOOT_SERVICE_PROTOCOL *This,\r
IN UINT16 SalAVersion,\r
IN UINT16 SalBVersion,\r
to the SAL System Table.\r
\r
@param This A pointer to the EXTENDED_SAL_BOOT_SERVICE_PROTOCOL instance.\r
- @param TableEntry Pointer to a buffer containing a SAL System Table entry that is EntrySize bytes \r
+ @param TableEntry Pointer to a buffer containing a SAL System Table entry that is EntrySize bytes\r
in length. The first byte of the TableEntry describes the type of entry.\r
@param EntrySize The size, in bytes, of TableEntry.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EXTENDED_SAL_ADD_SST_ENTRY) (\r
+(EFIAPI *EXTENDED_SAL_ADD_SST_ENTRY)(\r
IN EXTENDED_SAL_BOOT_SERVICE_PROTOCOL *This,\r
IN UINT8 *TableEntry,\r
IN UINTN EntrySize\r
@param Arg8 Eighth argument to the Extended SAL procedure.\r
@param VirtualMode TRUE if the Extended SAL Procedure is being invoked in virtual mode.\r
FALSE if the Extended SAL Procedure is being invoked in physical mode.\r
- @param ModuleGlobal A pointer to the global context associated with this Extended SAL Procedure. \r
+ @param ModuleGlobal A pointer to the global context associated with this Extended SAL Procedure.\r
\r
@return The result returned from the specified Extended SAL Procedure\r
\r
**/\r
typedef\r
SAL_RETURN_REGS\r
-(EFIAPI *SAL_INTERNAL_EXTENDED_SAL_PROC) (\r
+(EFIAPI *SAL_INTERNAL_EXTENDED_SAL_PROC)(\r
IN UINT64 FunctionId,\r
IN UINT64 Arg2,\r
IN UINT64 Arg3,\r
IN UINT64 Arg8,\r
IN BOOLEAN VirtualMode,\r
IN VOID *ModuleGlobal OPTIONAL\r
- ); \r
+ );\r
\r
/**\r
Registers an Extended SAL Procedure.\r
ClassGuidHi, and FunctionId is added to the set of available Extended SAL Procedures.\r
\r
@param This A pointer to the EXTENDED_SAL_BOOT_SERVICE_PROTOCOL instance.\r
- @param ClassGuidLo The lower 64-bits of the class GUID for the Extended SAL Procedure being added. \r
+ @param ClassGuidLo The lower 64-bits of the class GUID for the Extended SAL Procedure being added.\r
Each class GUID contains one or more functions specified by a Function ID.\r
- @param ClassGuidHi The upper 64-bits of the class GUID for the Extended SAL Procedure being added. \r
+ @param ClassGuidHi The upper 64-bits of the class GUID for the Extended SAL Procedure being added.\r
Each class GUID contains one or more functions specified by a Function ID.\r
- @param FunctionId The Function ID for the Extended SAL Procedure that is being added. This Function \r
- ID is a member of the Extended SAL Procedure class specified by ClassGuidLo \r
+ @param FunctionId The Function ID for the Extended SAL Procedure that is being added. This Function\r
+ ID is a member of the Extended SAL Procedure class specified by ClassGuidLo\r
and ClassGuidHi.\r
@param InternalSalProc A pointer to the Extended SAL Procedure being added.\r
@param PhysicalModuleGlobal Pointer to a module global structure. This is a physical mode pointer.\r
- This pointer is passed to the Extended SAL Procedure specified by ClassGuidLo, \r
+ This pointer is passed to the Extended SAL Procedure specified by ClassGuidLo,\r
ClassGuidHi, FunctionId, and InternalSalProc. If the system is in physical mode,\r
then this pointer is passed unmodified to InternalSalProc. If the system is in\r
virtual mode, then the virtual address associated with this pointer is passed to\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EXTENDED_SAL_REGISTER_INTERNAL_PROC) (\r
+(EFIAPI *EXTENDED_SAL_REGISTER_INTERNAL_PROC)(\r
IN EXTENDED_SAL_BOOT_SERVICE_PROTOCOL *This,\r
IN UINT64 ClassGuidLo,\r
IN UINT64 ClassGuidHi,\r
/**\r
Calls a previously registered Extended SAL Procedure.\r
\r
- This function calls the Extended SAL Procedure specified by ClassGuidLo, ClassGuidHi, \r
- and FunctionId. The set of previously registered Extended SAL Procedures is searched for a \r
- matching ClassGuidLo, ClassGuidHi, and FunctionId. If a match is not found, then \r
+ This function calls the Extended SAL Procedure specified by ClassGuidLo, ClassGuidHi,\r
+ and FunctionId. The set of previously registered Extended SAL Procedures is searched for a\r
+ matching ClassGuidLo, ClassGuidHi, and FunctionId. If a match is not found, then\r
EFI_SAL_NOT_IMPLEMENTED is returned.\r
\r
@param ClassGuidLo The lower 64-bits of the class GUID for the Extended SAL Procedure\r
@param Arg7 Seventh argument to the Extended SAL procedure.\r
@param Arg8 Eighth argument to the Extended SAL procedure.\r
\r
- @retval EFI_SAL_NOT_IMPLEMENTED The Extended SAL Procedure specified by ClassGuidLo, \r
+ @retval EFI_SAL_NOT_IMPLEMENTED The Extended SAL Procedure specified by ClassGuidLo,\r
ClassGuidHi, and FunctionId has not been registered.\r
- @retval EFI_SAL_VIRTUAL_ADDRESS_ERROR This function was called in virtual mode before virtual mappings \r
+ @retval EFI_SAL_VIRTUAL_ADDRESS_ERROR This function was called in virtual mode before virtual mappings\r
for the specified Extended SAL Procedure are available.\r
@retval Other The result returned from the specified Extended SAL Procedure\r
\r
**/\r
typedef\r
SAL_RETURN_REGS\r
-(EFIAPI *EXTENDED_SAL_PROC) (\r
+(EFIAPI *EXTENDED_SAL_PROC)(\r
IN UINT64 ClassGuidLo,\r
IN UINT64 ClassGuidHi,\r
IN UINT64 FunctionId,\r
);\r
\r
///\r
-/// The EXTENDED_SAL_BOOT_SERVICE_PROTOCOL provides a mechanisms for platform specific \r
+/// The EXTENDED_SAL_BOOT_SERVICE_PROTOCOL provides a mechanisms for platform specific\r
/// drivers to update the SAL System Table and register Extended SAL Procedures that are\r
/// callable in physical or virtual mode using the SAL calling convention.\r
///\r
struct _EXTENDED_SAL_BOOT_SERVICE_PROTOCOL {\r
EXTENDED_SAL_ADD_SST_INFO AddSalSystemTableInfo;\r
EXTENDED_SAL_ADD_SST_ENTRY AddSalSystemTableEntry;\r
- EXTENDED_SAL_REGISTER_INTERNAL_PROC RegisterExtendedSalProc; \r
+ EXTENDED_SAL_REGISTER_INTERNAL_PROC RegisterExtendedSalProc;\r
EXTENDED_SAL_PROC ExtendedSalProc;\r
};\r
\r
projects / mirror_edk2.git / blobdiff