EdkCompatibilityPkg/Foundation/Core/Dxe/ArchProtocol/Bds/Bds.h

   1 /*++
   2
   3 Copyright (c) 2004, 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   Bds.h
  15
  16 Abstract:
  17
  18   Boot Device Selection Architectural Protocol as defined in Tiano
  19
  20   When the DXE core is done it calls the BDS via this protocol.
  21
  22 --*/
  23
  24 #ifndef _ARCH_PROTOCOL_BDS_H_
  25 #define _ARCH_PROTOCOL_BDS_H_
  26
  27 //
  28 // Global ID for the BDS Architectural Protocol
  29 //
  30 #define EFI_BDS_ARCH_PROTOCOL_GUID \
  31   { 0x665E3FF6, 0x46CC, 0x11d4, 0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }
  32
  33 //
  34 // Declare forward reference for the BDS Architectural Protocol
  35 //
  36 EFI_FORWARD_DECLARATION (EFI_BDS_ARCH_PROTOCOL);
  37
  38 typedef
  39 VOID
  40 (EFIAPI *EFI_BDS_ENTRY) (
  41   IN EFI_BDS_ARCH_PROTOCOL  * This
  42   );
  43 /*++
  44
  45 Routine Description:
  46
  47   This function uses policy data from the platform to determine what operating
  48   system or system utility should be loaded and invoked.  This function call
  49   also optionally make the use of user input to determine the operating system
  50   or system utility to be loaded and invoked.  When the DXE Core has dispatched
  51   all the drivers on the dispatch queue, this function is called.  This
  52   function will attempt to connect the boot devices required to load and invoke
  53   the selected operating system or system utility.  During this process,
  54   additional firmware volumes may be discovered that may contain addition DXE
  55   drivers that can be dispatched by the DXE Core.   If a boot device cannot be
  56   fully connected, this function calls the DXE Service Dispatch() to allow the
  57   DXE drivers from any newly discovered firmware volumes to be dispatched.
  58   Then the boot device connection can be attempted again.  If the same boot
  59   device connection operation fails twice in a row, then that boot device has
  60   failed, and should be skipped.  This function should never return.
  61
  62 Arguments:
  63
  64   This - The EFI_BDS_ARCH_PROTOCOL instance.
  65
  66 Returns:
  67
  68   None.
  69
  70 --*/
  71
  72 //
  73 // Interface stucture for the BDS Architectural Protocol
  74 //
  75 typedef struct _EFI_BDS_ARCH_PROTOCOL {
  76   EFI_BDS_ENTRY Entry;
  77 } EFI_BDS_ARCH_PROTOCOL;
  78
  79 /*++
  80
  81   Protocol Description:
  82     The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating
  83     system or a system utility.  If there are not enough drivers initialized
  84     when this protocol is used to access the required boot device(s), then
  85     this protocol should add drivers to the dispatch queue and return control
  86     back to the dispatcher.  Once the required boot devices are available, then
  87     the boot device can be used to load and invoke an OS or a system utility.
  88
  89   Parameters:
  90
  91     Entry - The entry point to BDS.  This call does not take any parameters,
  92             and the return value can be ignored.  If it returns, then the
  93             dispatcher must be invoked again, if it never returns, then an
  94             operating system or a system utility have been invoked.
  95
  96 --*/
  97
  98 extern EFI_GUID gEfiBdsArchProtocolGuid;
  99
 100 #endif