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