EmulatorPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmulatorPkg / Include / Protocol / EmuThunk.h

/** @file\r
  Emulator Thunk to abstract OS services from pure EFI code\r
\r
  Copyright (c) 2008 - 2011, Apple Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EMU_THUNK_PROTOCOL_H__\r
#define __EMU_THUNK_PROTOCOL_H__\r
\r
#define EMU_THUNK_PROTOCOL_GUID  \\r
 { 0x5CF32E0B, 0x8EDF, 0x2E44, { 0x9C, 0xDA, 0x93, 0x20, 0x5E, 0x99, 0xEC, 0x1C } }\r
\r
// neded for things like EFI_TIME_CAPABILITIES\r
#include <Uefi.h>\r
\r
#include <Library/PeCoffExtraActionLib.h>\r
\r
#include <Protocol/EmuIoThunk.h>\r
#include <Protocol/DevicePath.h>\r
\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH  VendorDevicePath;\r
  UINT32              Instance;\r
} EMU_VENDOR_DEVICE_PATH_NODE;\r
\r
typedef struct {\r
  EMU_VENDOR_DEVICE_PATH_NODE Vendor;\r
  EFI_DEVICE_PATH_PROTOCOL    EndDevicePath;\r
} EMU_THUNK_DEVICE_PATH;\r
\r
\r
\r
typedef struct _EMU_THUNK_PROTOCOL  EMU_THUNK_PROTOCOL;\r
\r
\r
\r
typedef\r
UINTN\r
(EFIAPI *EMU_WRITE_STD_ERROR) (\r
  IN UINT8     *Buffer,\r
  IN UINTN     NumberOfBytes\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EMU_CONFIG_STD_IN) (\r
  VOID\r
  );\r
\r
typedef\r
UINTN\r
(EFIAPI *EMU_WRITE_STD_OUT) (\r
  IN UINT8     *Buffer,\r
  IN UINTN     NumberOfBytes\r
  );\r
\r
typedef\r
UINTN\r
(EFIAPI *EMU_READ_STD_IN) (\r
  OUT UINT8     *Buffer,\r
  IN  UINTN     NumberOfBytes\r
  );\r
\r
typedef\r
BOOLEAN\r
(EFIAPI *EMU_POLL_STD_IN) (\r
  VOID\r
  );\r
\r
\r
typedef\r
VOID *\r
(EFIAPI *EMU_OS_MALLOC) (\r
  IN  UINTN Size\r
  );\r
\r
typedef\r
VOID *\r
(EFIAPI *EMU_OS_VMALLOC) (\r
  IN  UINTN Size\r
  );\r
\r
typedef\r
BOOLEAN\r
(EFIAPI *EMU_OS_FREE) (\r
  IN  VOID *Ptr\r
  );\r
\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EMU_PE_COFF_GET_ENTRY_POINT) (\r
  IN     VOID  *Pe32Data,\r
  IN OUT VOID  **EntryPoint\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_PE_COFF_RELOCATE_EXTRA_ACTION) (\r
  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_PE_COFF_UNLOAD_EXTRA_ACTION) (\r
  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_ENABLE_INERRUPTS) (\r
  VOID\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_DISABLE_INERRUPTS) (\r
  VOID\r
  );\r
\r
typedef\r
UINT64\r
(EFIAPI *EMU_QUERY_PERFORMANCE_FREQENCY) (\r
  VOID\r
  );\r
\r
typedef\r
UINT64\r
(EFIAPI *EMU_QUERY_PERFORMANCE_COUNTER) (\r
  VOID\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_SLEEP) (\r
  IN  UINT64    Milliseconds\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_CPU_SLEEP) (\r
  VOID\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_EXIT) (\r
  IN  UINTN    Status\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_GET_TIME) (\r
  OUT  EFI_TIME               *Time,\r
  OUT EFI_TIME_CAPABILITIES   *Capabilities OPTIONAL\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_SET_TIME) (\r
  IN   EFI_TIME               *Time\r
  );\r
\r
\r
typedef\r
VOID\r
(EFIAPI EMU_SET_TIMER_CALLBACK) (\r
  IN  UINT64  DeltaMs\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *EMU_SET_TIMER) (\r
  IN  UINT64                  PeriodMs,\r
  IN  EMU_SET_TIMER_CALLBACK  CallBack\r
  );\r
\r
\r
\r
/**\r
  Enumerates the current set of protocol instances that abstract OS services from EFI.\r
\r
  A given protocol can have multiple instances. Usually a protocol is configured via a\r
  single PCD string. The data associated for each instance is seperated via a ! in the string.\r
  EMU_IO_THUNK_PROTOCOL_CLOSE.ConfigString will contain the information in the PCD string up to the next !.\r
  Thus each instance has a unique ConfigString.\r
\r
  @param  EmuBusDriver          TRUE means only return protocol instances that need to be produced\r
                                by the EmuBusDriver. FALSE means return all possible protocols\r
  @param  Instance              On input the protocol to search for, or NULL to start a search\r
                                of all the supported protocol instances.\r
  @param  NextProtocol          On output it represents the next value to be passed into Protocol.\r
  @param  Interface             A pointer to the EMU_IO_THUNK_PROTOCOL_CLOSE interface.\r
\r
  @retval EFI_SUCCESS           The function completed successfully.\r
  @retval EFI_NOT_FOUND         The next protocol instance was not found.\r
  @retval EFI_INVALID_PARAMETER Instance is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EMU_GET_NEXT_PROTOCOL) (\r
  IN  BOOLEAN                 EmuBusDriver,\r
  OUT EMU_IO_THUNK_PROTOCOL   **Instance  OPTIONAL\r
  );\r
\r
\r
struct _EMU_THUNK_PROTOCOL {\r
  // Used for early debug printing\r
  EMU_WRITE_STD_ERROR               WriteStdErr;\r
  EMU_CONFIG_STD_IN                 ConfigStdIn;\r
  EMU_WRITE_STD_OUT                 WriteStdOut;\r
  EMU_READ_STD_IN                   ReadStdIn;\r
  EMU_POLL_STD_IN                   PollStdIn;\r
\r
  //\r
  // Map OS malloc/free so we can use OS based guard malloc\r
  //\r
  EMU_OS_MALLOC                     Malloc;\r
  EMU_OS_VMALLOC                    Valloc;\r
  EMU_OS_FREE                       Free;\r
\r
\r
  ///\r
  /// PE/COFF loader hooks to get symbols loaded\r
  ///\r
  EMU_PE_COFF_GET_ENTRY_POINT       PeCoffGetEntryPoint;\r
  EMU_PE_COFF_RELOCATE_EXTRA_ACTION PeCoffRelocateImageExtraAction;\r
  EMU_PE_COFF_UNLOAD_EXTRA_ACTION   PeCoffUnloadImageExtraAction;\r
\r
  ///\r
  /// DXE Architecture Protocol Services\r
  ///\r
  EMU_ENABLE_INERRUPTS              EnableInterrupt;\r
  EMU_DISABLE_INERRUPTS             DisableInterrupt;\r
  EMU_QUERY_PERFORMANCE_FREQENCY    QueryPerformanceFrequency;\r
  EMU_QUERY_PERFORMANCE_COUNTER     QueryPerformanceCounter;\r
\r
  EMU_SLEEP                         Sleep;\r
  EMU_CPU_SLEEP                     CpuSleep;\r
  EMU_EXIT                          Exit;\r
  EMU_GET_TIME                      GetTime;\r
  EMU_SET_TIME                      SetTime;\r
  EMU_SET_TIMER                     SetTimer;\r
\r
  ///\r
  /// Generic System Services\r
  ///\r
  EMU_GET_NEXT_PROTOCOL             GetNextProtocol;\r
};\r
\r
extern EFI_GUID gEmuThunkProtocolGuid;\r
\r
#endif\r