2 This function deal with the legacy boot option, it create, delete
3 and manage the legacy boot option, all legacy boot option is getting from
6 Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "BBSsupport.h"
23 } LEGACY_BOOT_OPTION_BBS_DATA
;
27 Re-order the Boot Option according to the DevOrder.
29 The routine re-orders the Boot Option in BootOption array according to
30 the order specified by DevOrder.
32 @param DevOrder Pointer to buffer containing the BBS Index,
33 high 8-bit value 0xFF indicating a disabled boot option
34 @param DevOrderCount Count of the BBS Index
35 @param EnBootOption Callee allocated buffer containing the enabled Boot Option Numbers
36 @param EnBootOptionCount Count of the enabled Boot Option Numbers
37 @param DisBootOption Callee allocated buffer containing the disabled Boot Option Numbers
38 @param DisBootOptionCount Count of the disabled Boot Option Numbers
41 OrderLegacyBootOption4SameType (
44 UINT16
**EnBootOption
,
45 UINTN
*EnBootOptionCount
,
46 UINT16
**DisBootOption
,
47 UINTN
*DisBootOptionCount
51 UINT16
*NewBootOption
;
57 BDS_COMMON_OPTION
*BootOption
;
59 CHAR16 OptionName
[sizeof ("Boot####")];
60 UINT16
*BbsIndexArray
;
61 UINT16
*DeviceTypeArray
;
64 BootOrder
= BdsLibGetVariableAndSize (
66 &gEfiGlobalVariableGuid
,
69 ASSERT (BootOrder
!= NULL
);
71 BbsIndexArray
= AllocatePool (BootOrderSize
);
72 DeviceTypeArray
= AllocatePool (BootOrderSize
);
73 *EnBootOption
= AllocatePool (BootOrderSize
);
74 *DisBootOption
= AllocatePool (BootOrderSize
);
75 *DisBootOptionCount
= 0;
76 *EnBootOptionCount
= 0;
79 ASSERT (BbsIndexArray
!= NULL
);
80 ASSERT (DeviceTypeArray
!= NULL
);
81 ASSERT (*EnBootOption
!= NULL
);
82 ASSERT (*DisBootOption
!= NULL
);
84 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
86 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", BootOrder
[Index
]);
87 InitializeListHead (&List
);
88 BootOption
= BdsLibVariableToOption (&List
, OptionName
);
89 ASSERT (BootOption
!= NULL
);
91 if ((DevicePathType (BootOption
->DevicePath
) == BBS_DEVICE_PATH
) &&
92 (DevicePathSubType (BootOption
->DevicePath
) == BBS_BBS_DP
)) {
96 ASSERT (BootOption
->LoadOptionsSize
== sizeof (LEGACY_BOOT_OPTION_BBS_DATA
));
98 DeviceTypeArray
[Index
] = ((BBS_BBS_DEVICE_PATH
*) BootOption
->DevicePath
)->DeviceType
;
99 BbsIndexArray
[Index
] = ((LEGACY_BOOT_OPTION_BBS_DATA
*) BootOption
->LoadOptions
)->BbsIndex
;
101 DeviceTypeArray
[Index
] = BBS_TYPE_UNKNOWN
;
102 BbsIndexArray
[Index
] = 0xFFFF;
104 FreePool (BootOption
->DevicePath
);
105 FreePool (BootOption
->Description
);
106 FreePool (BootOption
->LoadOptions
);
107 FreePool (BootOption
);
111 // Record the corresponding Boot Option Numbers according to the DevOrder
112 // Record the EnBootOption and DisBootOption according to the DevOrder
114 StartPosition
= BootOrderSize
/ sizeof (UINT16
);
115 NewBootOption
= AllocatePool (DevOrderCount
* sizeof (UINT16
));
116 ASSERT (NewBootOption
!= NULL
);
117 while (DevOrderCount
-- != 0) {
118 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
119 if (BbsIndexArray
[Index
] == (DevOrder
[DevOrderCount
] & 0xFF)) {
120 StartPosition
= MIN (StartPosition
, Index
);
121 NewBootOption
[DevOrderCount
] = BootOrder
[Index
];
123 if ((DevOrder
[DevOrderCount
] & 0xFF00) == 0xFF00) {
124 (*DisBootOption
)[*DisBootOptionCount
] = BootOrder
[Index
];
125 (*DisBootOptionCount
)++;
127 (*EnBootOption
)[*EnBootOptionCount
] = BootOrder
[Index
];
128 (*EnBootOptionCount
)++;
136 // Overwrite the old BootOption
138 CopyMem (&BootOrder
[StartPosition
], NewBootOption
, (*DisBootOptionCount
+ *EnBootOptionCount
) * sizeof (UINT16
));
139 Status
= gRT
->SetVariable (
141 &gEfiGlobalVariableGuid
,
142 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
146 ASSERT_EFI_ERROR (Status
);
148 FreePool (NewBootOption
);
149 FreePool (DeviceTypeArray
);
150 FreePool (BbsIndexArray
);
154 Group the legacy boot options in the BootOption.
156 The routine assumes the boot options in the beginning that covers all the device
157 types are ordered properly and re-position the following boot options just after
158 the corresponding boot options with the same device type.
160 1. Input = [Harddisk1 CdRom2 Efi1 Harddisk0 CdRom0 CdRom1 Harddisk2 Efi0]
161 Assuming [Harddisk1 CdRom2 Efi1] is ordered properly
162 Output = [Harddisk1 Harddisk0 Harddisk2 CdRom2 CdRom0 CdRom1 Efi1 Efi0]
164 2. Input = [Efi1 Efi0 CdRom1 Harddisk0 Harddisk1 Harddisk2 CdRom0 CdRom2]
165 Assuming [Efi1 Efi0 CdRom1 Harddisk0] is ordered properly
166 Output = [Efi1 Efi0 CdRom1 CdRom0 CdRom2 Harddisk0 Harddisk1 Harddisk2]
170 GroupMultipleLegacyBootOption4SameType (
176 UINTN DeviceTypeIndex
[7];
181 CHAR16 OptionName
[sizeof ("Boot####")];
182 BDS_COMMON_OPTION
*BootOption
;
185 SetMem (DeviceTypeIndex
, sizeof (DeviceTypeIndex
), 0xff);
187 BootOrder
= BdsLibGetVariableAndSize (
189 &gEfiGlobalVariableGuid
,
193 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
194 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", BootOrder
[Index
]);
195 InitializeListHead (&List
);
196 BootOption
= BdsLibVariableToOption (&List
, OptionName
);
197 ASSERT (BootOption
!= NULL
);
199 if ((DevicePathType (BootOption
->DevicePath
) == BBS_DEVICE_PATH
) &&
200 (DevicePathSubType (BootOption
->DevicePath
) == BBS_BBS_DP
)) {
202 // Legacy Boot Option
204 ASSERT ((((BBS_BBS_DEVICE_PATH
*) BootOption
->DevicePath
)->DeviceType
& 0xF) < sizeof (DeviceTypeIndex
) / sizeof (DeviceTypeIndex
[0]));
205 NextIndex
= &DeviceTypeIndex
[((BBS_BBS_DEVICE_PATH
*) BootOption
->DevicePath
)->DeviceType
& 0xF];
207 if (*NextIndex
== (UINTN
) -1) {
209 // *NextIndex is the Index in BootOrder to put the next Option Number for the same type
211 *NextIndex
= Index
+ 1;
214 // insert the current boot option before *NextIndex, causing [*Next .. Index] shift right one position
216 OptionNumber
= BootOrder
[Index
];
217 CopyMem (&BootOrder
[*NextIndex
+ 1], &BootOrder
[*NextIndex
], (Index
- *NextIndex
) * sizeof (UINT16
));
218 BootOrder
[*NextIndex
] = OptionNumber
;
221 // Update the DeviceTypeIndex array to reflect the right shift operation
223 for (DeviceIndex
= 0; DeviceIndex
< sizeof (DeviceTypeIndex
) / sizeof (DeviceTypeIndex
[0]); DeviceIndex
++) {
224 if (DeviceTypeIndex
[DeviceIndex
] != (UINTN
) -1 && DeviceTypeIndex
[DeviceIndex
] >= *NextIndex
) {
225 DeviceTypeIndex
[DeviceIndex
]++;
230 FreePool (BootOption
->DevicePath
);
231 FreePool (BootOption
->Description
);
232 FreePool (BootOption
->LoadOptions
);
233 FreePool (BootOption
);
238 &gEfiGlobalVariableGuid
,
239 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
243 FreePool (BootOrder
);