]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Protocol/Bds.h
MdePkg/Http.h: Add #define for 308 redirect
[mirror_edk2.git] / MdePkg / Include / Protocol / Bds.h
CommitLineData
d1f95000 1/** @file\r
4ca9b6c4 2 Boot Device Selection Architectural Protocol as defined in PI spec Volume 2 DXE\r
d1f95000 3\r
4 When the DXE core is done it calls the BDS via this protocol.\r
5\r
9df063a0
HT
6 Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
7 This program and the accompanying materials \r
d1f95000 8 are licensed and made available under the terms and conditions of the BSD License \r
9 which accompanies this distribution. The full text of the license may be found at \r
10 http://opensource.org/licenses/bsd-license.php \r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
14\r
d1f95000 15**/\r
16\r
17#ifndef __ARCH_PROTOCOL_BDS_H__\r
18#define __ARCH_PROTOCOL_BDS_H__\r
19\r
99e8ed21 20///\r
21/// Global ID for the BDS Architectural Protocol\r
22///\r
d1f95000 23#define EFI_BDS_ARCH_PROTOCOL_GUID \\r
24 { 0x665E3FF6, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
25\r
99e8ed21 26///\r
27/// Declare forward reference for the BDS Architectural Protocol\r
28///\r
d1f95000 29typedef struct _EFI_BDS_ARCH_PROTOCOL EFI_BDS_ARCH_PROTOCOL;\r
30\r
31/**\r
32 This function uses policy data from the platform to determine what operating \r
33 system or system utility should be loaded and invoked. This function call \r
34 also optionally make the use of user input to determine the operating system \r
35 or system utility to be loaded and invoked. When the DXE Core has dispatched \r
36 all the drivers on the dispatch queue, this function is called. This \r
37 function will attempt to connect the boot devices required to load and invoke \r
38 the selected operating system or system utility. During this process, \r
39 additional firmware volumes may be discovered that may contain addition DXE \r
40 drivers that can be dispatched by the DXE Core. If a boot device cannot be \r
41 fully connected, this function calls the DXE Service Dispatch() to allow the \r
42 DXE drivers from any newly discovered firmware volumes to be dispatched. \r
43 Then the boot device connection can be attempted again. If the same boot \r
44 device connection operation fails twice in a row, then that boot device has \r
45 failed, and should be skipped. This function should never return.\r
46\r
47 @param This The EFI_BDS_ARCH_PROTOCOL instance.\r
48\r
49 @return None.\r
50\r
51**/\r
52typedef\r
53VOID\r
8b13229b 54(EFIAPI *EFI_BDS_ENTRY)(\r
d1f95000 55 IN EFI_BDS_ARCH_PROTOCOL *This\r
56 );\r
57\r
44717a39 58///\r
59/// The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating \r
60/// system or a system utility. If there are not enough drivers initialized \r
61/// when this protocol is used to access the required boot device(s), then \r
62/// this protocol should add drivers to the dispatch queue and return control \r
63/// back to the dispatcher. Once the required boot devices are available, then \r
64/// the boot device can be used to load and invoke an OS or a system utility.\r
65///\r
d1f95000 66struct _EFI_BDS_ARCH_PROTOCOL {\r
67 EFI_BDS_ENTRY Entry;\r
68};\r
69\r
70extern EFI_GUID gEfiBdsArchProtocolGuid;\r
71\r
72#endif\r