EdkModulePkg/Include/Library/EdkDxeSalLib.h

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   EdkDxeSalLib.h
  15
  16 Abstract:
  17
  18 --*/
  19
  20 #ifndef _ESAL_SERVICE_LIB_H__
  21 #define _ESAL_SERVICE_LIB_H__
  22
  23 EFI_STATUS
  24 EFIAPI
  25 RegisterEsalFunction (
  26   IN  UINT64                                    FunctionId,
  27   IN  EFI_GUID                                  *ClassGuid,
  28   IN  SAL_INTERNAL_EXTENDED_SAL_PROC            Function,
  29   IN  VOID                                      *ModuleGlobal
  30   )
  31 /*++
  32
  33 Routine Description:
  34
  35   Register ESAL Class Function and it's asociated global.
  36   This function is boot service only!
  37
  38 Arguments:
  39   FunctionId    - ID of function to register
  40   ClassGuid     - GUID of function class
  41   Function      - Function to register under ClassGuid/FunctionId pair
  42   ModuleGlobal  - Module global for Function.
  43
  44 Returns:
  45   EFI_SUCCESS - If ClassGuid/FunctionId Function was registered.
  46
  47 --*/
  48 ;
  49
  50 EFI_STATUS
  51 EFIAPI
  52 RegisterEsalClass (
  53   IN  EFI_GUID                                  *ClassGuid,
  54   IN  VOID                                      *ModuleGlobal,
  55   ...
  56   )
  57 /*++
  58
  59 Routine Description:
  60
  61   Register ESAL Class and it's asociated global.
  62   This function is boot service only!
  63
  64 Arguments:
  65   ClassGuid     - GUID of function class
  66   ModuleGlobal  - Module global for Function.
  67   ..            - SAL_INTERNAL_EXTENDED_SAL_PROC and FunctionId pairs. NULL
  68                   indicates the end of the list.
  69
  70 Returns:
  71   EFI_SUCCESS - All members of ClassGuid registered
  72
  73 --*/
  74 ;
  75
  76 SAL_RETURN_REGS
  77 EFIAPI
  78 EfiCallEsalService (
  79   IN  EFI_GUID                                      *ClassGuid,
  80   IN  UINT64                                        FunctionId,
  81   IN  UINT64                                        Arg2,
  82   IN  UINT64                                        Arg3,
  83   IN  UINT64                                        Arg4,
  84   IN  UINT64                                        Arg5,
  85   IN  UINT64                                        Arg6,
  86   IN  UINT64                                        Arg7,
  87   IN  UINT64                                        Arg8
  88   )
  89 /*++
  90
  91 Routine Description:
  92
  93   Call module that is not linked direclty to this module. This code is IP
  94   relative and hides the binding issues of virtual or physical calling. The
  95   function that gets dispatched has extra arguments that include the registered
  96   module global and a boolean flag to indicate if the system is in virutal mode.
  97
  98 Arguments:
  99   ClassGuid   - GUID of function
 100   FunctionId  - Function in ClassGuid to call
 101   Arg2        - Argument 2 ClassGuid/FunctionId defined
 102   Arg3        - Argument 3 ClassGuid/FunctionId defined
 103   Arg4        - Argument 4 ClassGuid/FunctionId defined
 104   Arg5        - Argument 5 ClassGuid/FunctionId defined
 105   Arg6        - Argument 6 ClassGuid/FunctionId defined
 106   Arg7        - Argument 7 ClassGuid/FunctionId defined
 107   Arg8        - Argument 8 ClassGuid/FunctionId defined
 108
 109 Returns:
 110   Status of ClassGuid/FuncitonId
 111
 112 --*/
 113 ;
 114
 115 SAL_RETURN_REGS
 116 EFIAPI
 117 SetEsalVirtualEntryPoint (
 118   IN  UINT64  EntryPoint,
 119   IN  UINT64  Gp
 120   )
 121 ;
 122
 123 SAL_RETURN_REGS
 124 EFIAPI
 125 SetEsalPhysicalEntryPoint (
 126   IN  UINT64  EntryPoint,
 127   IN  UINT64  Gp
 128   )
 129 ;
 130
 131 SAL_RETURN_REGS
 132 EFIAPI
 133 GetEsalEntryPoint (
 134   VOID
 135   )
 136 ;
 137
 138
 139 #endif