Unix version of EFI emulator

[mirror_edk2.git] / EdkUnixPkg / Include / Ppi / UnixAutoScan.h

/*++\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
Module Name:\r
\r
  UnixAutoscan.h\r
\r
Abstract:\r
\r
Unix Autoscan PPI\r
\r
--*/\r
\r
#ifndef __UNIX_PEI_AUTOSCAN_H__\r
#define __UNIX_PEI_AUTOSCAN_H__\r
\r
#include <UnixDxe.h>\r
\r
#define PEI_UNIX_AUTOSCAN_PPI_GUID \\r
  { \\r
    0xf2ed3d14, 0x8985, 0x11db, {0xb0, 0x57, 0x00, 0x40, 0xd0, 0x2b, 0x18, 0x35 } \
  }\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PEI_UNIX_AUTOSCAN) (\r
  IN  UINTN                 Index,\r
  OUT EFI_PHYSICAL_ADDRESS  *MemoryBase,\r
  OUT UINT64                *MemorySize\r
  );\r
\r
/*++\r
\r
Routine Description:\r
  This service is called from Index == 0 until it returns EFI_UNSUPPORTED.\r
  It allows discontiguous memory regions to be supported by the emulator.\r
  It uses gSystemMemory[] and gSystemMemoryCount that were created by\r
  parsing the Windows environment variable EFI_MEMORY_SIZE.\r
  The size comes from the varaible and the address comes from the call to\r
  WinNtOpenFile. \r
\r
Arguments:\r
  Index      - Which memory region to use\r
  MemoryBase - Return Base address of memory region\r
  MemorySize - Return size in bytes of the memory region\r
\r
Returns:\r
  EFI_SUCCESS - If memory region was mapped\r
  EFI_UNSUPPORTED - If Index is not supported\r
\r
--*/\r
typedef struct {\r
  PEI_UNIX_AUTOSCAN UnixAutoScan;\r
} PEI_UNIX_AUTOSCAN_PPI;\r
\r
extern EFI_GUID gPeiUnixAutoScanPpiGuid;\r
\r
#endif\r