]> git.proxmox.com Git - mirror_edk2.git/blame - ArmPlatformPkg/Bds/BootOption.c
ArmPkg: Introduce GetGlobalEnvironmentVariable() function.
[mirror_edk2.git] / ArmPlatformPkg / Bds / BootOption.c
CommitLineData
ea46ebbe 1/** @file\r
2*\r
9127a094 3* Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
ea46ebbe 4*\r
5* This program and the accompanying materials\r
6* are licensed and made available under the terms and conditions of the BSD License\r
7* which accompanies this distribution. The full text of the license may be found at\r
8* http://opensource.org/licenses/bsd-license.php\r
9*\r
10* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12*\r
13**/\r
14\r
c0b2e477 15#include <Guid/ArmGlobalVariableHob.h>\r
ea46ebbe 16#include "BdsInternal.h"\r
17\r
18extern EFI_HANDLE mImageHandle;\r
19\r
20EFI_STATUS\r
21BootOptionStart (\r
22 IN BDS_LOAD_OPTION *BootOption\r
23 )\r
24{\r
c60ea9a8 25 EFI_STATUS Status;\r
c60ea9a8 26 EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL* EfiDevicePathFromTextProtocol;\r
27 UINT32 LoaderType;\r
2ccfb71e 28 ARM_BDS_LOADER_OPTIONAL_DATA* OptionalData;\r
29 ARM_BDS_LINUX_ARGUMENTS* LinuxArguments;\r
30 EFI_DEVICE_PATH_PROTOCOL* FdtDevicePath;\r
31 EFI_DEVICE_PATH_PROTOCOL* DefaultFdtDevicePath;\r
32 UINTN FdtDevicePathSize;\r
33 UINTN CmdLineSize;\r
34 UINTN InitrdSize;\r
35 EFI_DEVICE_PATH* Initrd;\r
91213ad3 36 UINT16 LoadOptionIndexSize;\r
2ccfb71e 37\r
a6e97d28 38 if (IS_ARM_BDS_BOOTENTRY (BootOption)) {\r
2ccfb71e 39 Status = EFI_UNSUPPORTED;\r
40 OptionalData = BootOption->OptionalData;\r
41 LoaderType = ReadUnaligned32 ((CONST UINT32*)&OptionalData->Header.LoaderType);\r
42\r
43 if (LoaderType == BDS_LOADER_EFI_APPLICATION) {\r
44 // Need to connect every drivers to ensure no dependencies are missing for the application\r
45 BdsConnectAllDrivers();\r
46\r
47 Status = BdsStartEfiApplication (mImageHandle, BootOption->FilePathList, 0, NULL);\r
48 } else if (LoaderType == BDS_LOADER_KERNEL_LINUX_ATAG) {\r
49 LinuxArguments = &(OptionalData->Arguments.LinuxArguments);\r
50 CmdLineSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->CmdLineSize);\r
51 InitrdSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->InitrdSize);\r
52\r
53 if (InitrdSize > 0) {\r
54 Initrd = GetAlignedDevicePath ((EFI_DEVICE_PATH*)((UINTN)(LinuxArguments + 1) + CmdLineSize));\r
55 } else {\r
56 Initrd = NULL;\r
57 }\r
ea46ebbe 58\r
76d17c31 59 Status = BdsBootLinuxAtag (BootOption->FilePathList,\r
2ccfb71e 60 Initrd, // Initrd\r
76d17c31 61 (CHAR8*)(LinuxArguments + 1)); // CmdLine\r
2ccfb71e 62 } else if (LoaderType == BDS_LOADER_KERNEL_LINUX_FDT) {\r
63 LinuxArguments = &(OptionalData->Arguments.LinuxArguments);\r
64 CmdLineSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->CmdLineSize);\r
65 InitrdSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->InitrdSize);\r
66\r
67 if (InitrdSize > 0) {\r
68 Initrd = GetAlignedDevicePath ((EFI_DEVICE_PATH*)((UINTN)(LinuxArguments + 1) + CmdLineSize));\r
69 } else {\r
70 Initrd = NULL;\r
71 }\r
72\r
73 // Get the default FDT device path\r
74 Status = gBS->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid, NULL, (VOID **)&EfiDevicePathFromTextProtocol);\r
75 ASSERT_EFI_ERROR(Status);\r
76 DefaultFdtDevicePath = EfiDevicePathFromTextProtocol->ConvertTextToDevicePath ((CHAR16*)PcdGetPtr(PcdFdtDevicePath));\r
77\r
78 // Get the FDT device path\r
79 FdtDevicePathSize = GetDevicePathSize (DefaultFdtDevicePath);\r
c0b2e477 80 Status = GetEnvironmentVariable ((CHAR16 *)L"Fdt", &gArmGlobalVariableGuid,\r
81 DefaultFdtDevicePath, &FdtDevicePathSize, (VOID **)&FdtDevicePath);\r
2ccfb71e 82 ASSERT_EFI_ERROR(Status);\r
83\r
76d17c31 84 Status = BdsBootLinuxFdt (BootOption->FilePathList,\r
2ccfb71e 85 Initrd, // Initrd\r
86 (CHAR8*)(LinuxArguments + 1),\r
87 FdtDevicePath);\r
b148591a 88\r
89 FreePool (FdtDevicePath);\r
a6e97d28 90 }\r
91 } else {\r
91213ad3 92 // Set BootCurrent variable\r
93 LoadOptionIndexSize = sizeof(UINT16);\r
94 gRT->SetVariable (L"BootCurrent", &gEfiGlobalVariableGuid,\r
95 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
96 LoadOptionIndexSize, &(BootOption->LoadOptionIndex));\r
97\r
2755d844 98 Status = BdsStartEfiApplication (mImageHandle, BootOption->FilePathList, BootOption->OptionalDataSize, BootOption->OptionalData);\r
91213ad3 99\r
100 // Clear BootCurrent variable\r
101 LoadOptionIndexSize = sizeof(UINT16);\r
102 gRT->SetVariable (L"BootCurrent", &gEfiGlobalVariableGuid,\r
103 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
104 0, NULL);\r
a6e97d28 105 }\r
ea46ebbe 106\r
107 return Status;\r
108}\r
109\r
ea46ebbe 110EFI_STATUS\r
111BootOptionList (\r
112 IN OUT LIST_ENTRY *BootOptionList\r
113 )\r
114{\r
a6e97d28 115 EFI_STATUS Status;\r
116 UINTN Index;\r
117 UINT16* BootOrder;\r
118 UINTN BootOrderSize;\r
119 BDS_LOAD_OPTION* BdsLoadOption;\r
120 BDS_LOAD_OPTION_ENTRY* BdsLoadOptionEntry;\r
ea46ebbe 121\r
122 InitializeListHead (BootOptionList);\r
123\r
124 // Get the Boot Option Order from the environment variable\r
c0b2e477 125 Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe 126 if (EFI_ERROR(Status)) {\r
127 return Status;\r
128 }\r
129\r
130 for (Index = 0; Index < BootOrderSize / sizeof (UINT16); Index++) {\r
4aa24170 131 Status = BootOptionFromLoadOptionIndex (BootOrder[Index], &BdsLoadOption);\r
ea46ebbe 132 if (!EFI_ERROR(Status)) {\r
a6e97d28 133 BdsLoadOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool(sizeof(BDS_LOAD_OPTION_ENTRY));\r
134 BdsLoadOptionEntry->BdsLoadOption = BdsLoadOption;\r
135 InsertTailList (BootOptionList,&BdsLoadOptionEntry->Link);\r
ea46ebbe 136 }\r
137 }\r
138\r
b148591a 139 FreePool (BootOrder);\r
140\r
ea46ebbe 141 return EFI_SUCCESS;\r
142}\r
143\r
ea46ebbe 144STATIC\r
145EFI_STATUS\r
146BootOptionSetFields (\r
c60ea9a8 147 IN BDS_LOAD_OPTION* BootOption,\r
148 IN UINT32 Attributes,\r
149 IN CHAR16* BootDescription,\r
150 IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e 151 IN ARM_BDS_LOADER_TYPE BootType,\r
152 IN ARM_BDS_LOADER_ARGUMENTS* BootArguments\r
ea46ebbe 153 )\r
154{\r
2ccfb71e 155 EFI_LOAD_OPTION EfiLoadOption;\r
156 UINTN EfiLoadOptionSize;\r
157 UINTN BootDescriptionSize;\r
158 UINTN BootOptionalDataSize;\r
159 UINT16 FilePathListLength;\r
160 UINT8* EfiLoadOptionPtr;\r
161 UINT8* InitrdPathListPtr;\r
162 UINTN OptionalDataSize;\r
163 ARM_BDS_LINUX_ARGUMENTS* DestLinuxArguments;\r
164 ARM_BDS_LINUX_ARGUMENTS* SrcLinuxArguments;\r
ea46ebbe 165\r
166 // If we are overwriting an existent Boot Option then we have to free previously allocated memory\r
167 if (BootOption->LoadOption) {\r
168 FreePool(BootOption->LoadOption);\r
169 }\r
170\r
2ccfb71e 171 BootDescriptionSize = StrSize (BootDescription);\r
172 BootOptionalDataSize = sizeof(ARM_BDS_LOADER_OPTIONAL_DATA_HEADER);\r
173 if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
174 BootOptionalDataSize += sizeof(ARM_BDS_LINUX_ARGUMENTS) + BootArguments->LinuxArguments.CmdLineSize + BootArguments->LinuxArguments.InitrdSize;\r
175 }\r
ea46ebbe 176\r
177 // Compute the size of the FilePath list\r
2ccfb71e 178 FilePathListLength = GetUnalignedDevicePathSize (DevicePath);\r
656416bc 179\r
ea46ebbe 180 // Allocate the memory for the EFI Load Option\r
181 EfiLoadOptionSize = sizeof(UINT32) + sizeof(UINT16) + BootDescriptionSize + FilePathListLength + BootOptionalDataSize;\r
182 EfiLoadOption = (EFI_LOAD_OPTION)AllocatePool(EfiLoadOptionSize);\r
183 EfiLoadOptionPtr = EfiLoadOption;\r
184\r
185 //\r
186 // Populate the EFI Load Option and BDS Boot Option structures\r
187 //\r
188\r
189 // Attributes fields\r
190 BootOption->Attributes = Attributes;\r
191 *(UINT32*)EfiLoadOptionPtr = Attributes;\r
192 EfiLoadOptionPtr += sizeof(UINT32);\r
193\r
194 // FilePath List fields\r
195 BootOption->FilePathListLength = FilePathListLength;\r
196 *(UINT16*)EfiLoadOptionPtr = FilePathListLength;\r
197 EfiLoadOptionPtr += sizeof(UINT16);\r
198\r
199 // Boot description fields\r
200 BootOption->Description = (CHAR16*)EfiLoadOptionPtr;\r
201 CopyMem (EfiLoadOptionPtr, BootDescription, BootDescriptionSize);\r
202 EfiLoadOptionPtr += BootDescriptionSize;\r
203\r
204 // File path fields\r
205 BootOption->FilePathList = (EFI_DEVICE_PATH_PROTOCOL*)EfiLoadOptionPtr;\r
2ccfb71e 206 CopyMem (EfiLoadOptionPtr, DevicePath, FilePathListLength);\r
207 EfiLoadOptionPtr += FilePathListLength;\r
ea46ebbe 208\r
209 // Optional Data fields, Do unaligned writes\r
2ccfb71e 210 BootOption->OptionalData = EfiLoadOptionPtr;\r
211 WriteUnaligned32 ((UINT32 *)EfiLoadOptionPtr, ARM_BDS_OPTIONAL_DATA_SIGNATURE);\r
212 WriteUnaligned32 ((UINT32 *)(EfiLoadOptionPtr + 4), BootType);\r
ea46ebbe 213\r
2ccfb71e 214 OptionalDataSize = sizeof(ARM_BDS_LOADER_OPTIONAL_DATA_HEADER);\r
ea46ebbe 215\r
2ccfb71e 216 if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
217 SrcLinuxArguments = &(BootArguments->LinuxArguments);\r
218 DestLinuxArguments = &((ARM_BDS_LOADER_OPTIONAL_DATA*)EfiLoadOptionPtr)->Arguments.LinuxArguments;\r
656416bc 219\r
2ccfb71e 220 WriteUnaligned16 ((UINT16 *)&(DestLinuxArguments->CmdLineSize), SrcLinuxArguments->CmdLineSize);\r
221 WriteUnaligned16 ((UINT16 *)&(DestLinuxArguments->InitrdSize), SrcLinuxArguments->InitrdSize);\r
222 OptionalDataSize += sizeof (ARM_BDS_LINUX_ARGUMENTS);\r
656416bc 223\r
2ccfb71e 224 if (SrcLinuxArguments->CmdLineSize > 0) {\r
225 CopyMem ((VOID*)(DestLinuxArguments + 1), (VOID*)(SrcLinuxArguments + 1), SrcLinuxArguments->CmdLineSize);\r
226 OptionalDataSize += SrcLinuxArguments->CmdLineSize;\r
227 }\r
656416bc 228\r
2ccfb71e 229 if (SrcLinuxArguments->InitrdSize > 0) {\r
230 InitrdPathListPtr = (UINT8*)((UINTN)(DestLinuxArguments + 1) + SrcLinuxArguments->CmdLineSize);\r
231 CopyMem (InitrdPathListPtr, (VOID*)((UINTN)(SrcLinuxArguments + 1) + SrcLinuxArguments->CmdLineSize), SrcLinuxArguments->InitrdSize);\r
656416bc 232 }\r
233 }\r
2ccfb71e 234 BootOption->OptionalDataSize = OptionalDataSize;\r
235\r
6bab33c7 236 // If this function is called at the creation of the Boot Device entry (not at the update) the\r
237 // BootOption->LoadOptionSize must be zero then we get a new BootIndex for this entry\r
238 if (BootOption->LoadOptionSize == 0) {\r
2ccfb71e 239 BootOption->LoadOptionIndex = BootOptionAllocateBootIndex ();\r
6bab33c7 240 }\r
241\r
ea46ebbe 242 // Fill the EFI Load option fields\r
ea46ebbe 243 BootOption->LoadOption = EfiLoadOption;\r
244 BootOption->LoadOptionSize = EfiLoadOptionSize;\r
245\r
246 return EFI_SUCCESS;\r
247}\r
248\r
249EFI_STATUS\r
250BootOptionCreate (\r
c60ea9a8 251 IN UINT32 Attributes,\r
252 IN CHAR16* BootDescription,\r
ea46ebbe 253 IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e 254 IN ARM_BDS_LOADER_TYPE BootType,\r
255 IN ARM_BDS_LOADER_ARGUMENTS* BootArguments,\r
a6e97d28 256 OUT BDS_LOAD_OPTION** BdsLoadOption\r
ea46ebbe 257 )\r
258{\r
a6e97d28 259 EFI_STATUS Status;\r
260 BDS_LOAD_OPTION_ENTRY* BootOptionEntry;\r
261 BDS_LOAD_OPTION* BootOption;\r
262 CHAR16 BootVariableName[9];\r
263 UINT16* BootOrder;\r
264 UINTN BootOrderSize;\r
ea46ebbe 265\r
266 //\r
267 // Allocate and fill the memory for the BDS Load Option structure\r
268 //\r
a6e97d28 269 BootOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool (sizeof (BDS_LOAD_OPTION_ENTRY));\r
270 InitializeListHead (&BootOptionEntry->Link);\r
271 BootOptionEntry->BdsLoadOption = (BDS_LOAD_OPTION*)AllocateZeroPool (sizeof(BDS_LOAD_OPTION));\r
ea46ebbe 272\r
a6e97d28 273 BootOption = BootOptionEntry->BdsLoadOption;\r
ea46ebbe 274 BootOptionSetFields (BootOption, Attributes, BootDescription, DevicePath, BootType, BootArguments);\r
275\r
276 //\r
277 // Set the related environment variables\r
278 //\r
279\r
280 // Create Boot#### environment variable\r
281 UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BootOption->LoadOptionIndex);\r
282 Status = gRT->SetVariable (\r
283 BootVariableName,\r
284 &gEfiGlobalVariableGuid,\r
285 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
286 BootOption->LoadOptionSize,\r
287 BootOption->LoadOption\r
288 );\r
289\r
290 // Add the new Boot Index to the list\r
c0b2e477 291 Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe 292 if (!EFI_ERROR(Status)) {\r
293 BootOrder = ReallocatePool (BootOrderSize, BootOrderSize + sizeof(UINT16), BootOrder);\r
294 // Add the new index at the end\r
295 BootOrder[BootOrderSize / sizeof(UINT16)] = BootOption->LoadOptionIndex;\r
296 BootOrderSize += sizeof(UINT16);\r
297 } else {\r
298 // BootOrder does not exist. Create it\r
299 BootOrderSize = sizeof(UINT16);\r
300 BootOrder = &(BootOption->LoadOptionIndex);\r
301 }\r
302\r
303 // Update (or Create) the BootOrder environment variable\r
304 Status = gRT->SetVariable (\r
305 L"BootOrder",\r
306 &gEfiGlobalVariableGuid,\r
307 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
308 BootOrderSize,\r
309 BootOrder\r
310 );\r
311\r
b148591a 312 // We only free it if the UEFI Variable 'BootOrder' was already existing\r
313 if (BootOrderSize > sizeof(UINT16)) {\r
314 FreePool (BootOrder);\r
315 }\r
316\r
ea46ebbe 317 *BdsLoadOption = BootOption;\r
318 return Status;\r
319}\r
320\r
321EFI_STATUS\r
322BootOptionUpdate (\r
2ccfb71e 323 IN BDS_LOAD_OPTION* BdsLoadOption,\r
324 IN UINT32 Attributes,\r
325 IN CHAR16* BootDescription,\r
ea46ebbe 326 IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e 327 IN ARM_BDS_LOADER_TYPE BootType,\r
328 IN ARM_BDS_LOADER_ARGUMENTS* BootArguments\r
ea46ebbe 329 )\r
330{\r
331 EFI_STATUS Status;\r
ea46ebbe 332 CHAR16 BootVariableName[9];\r
333\r
334 // Update the BDS Load Option structure\r
335 BootOptionSetFields (BdsLoadOption, Attributes, BootDescription, DevicePath, BootType, BootArguments);\r
336\r
337 // Update the related environment variables\r
6bab33c7 338 UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BdsLoadOption->LoadOptionIndex);\r
339\r
ea46ebbe 340 Status = gRT->SetVariable (\r
341 BootVariableName,\r
342 &gEfiGlobalVariableGuid,\r
343 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
6bab33c7 344 BdsLoadOption->LoadOptionSize,\r
345 BdsLoadOption->LoadOption\r
ea46ebbe 346 );\r
347\r
348 return Status;\r
349}\r
350\r
351EFI_STATUS\r
352BootOptionDelete (\r
353 IN BDS_LOAD_OPTION *BootOption\r
354 )\r
355{\r
a6e97d28 356 UINTN Index;\r
357 UINTN BootOrderSize;\r
358 UINT16* BootOrder;\r
359 UINTN BootOrderCount;\r
360 EFI_STATUS Status;\r
ea46ebbe 361\r
362 // Remove the entry from the BootOrder environment variable\r
c0b2e477 363 Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe 364 if (!EFI_ERROR(Status)) {\r
365 BootOrderCount = BootOrderSize / sizeof(UINT16);\r
366\r
367 // Find the index of the removed entry\r
368 for (Index = 0; Index < BootOrderCount; Index++) {\r
369 if (BootOrder[Index] == BootOption->LoadOptionIndex) {\r
370 // If it the last entry we do not need to rearrange the BootOrder list\r
371 if (Index + 1 != BootOrderCount) {\r
9127a094 372 CopyMem (\r
373 &BootOrder[Index],\r
374 &BootOrder[Index + 1],\r
375 (BootOrderCount - (Index + 1)) * sizeof(UINT16)\r
376 );\r
ea46ebbe 377 }\r
378 break;\r
379 }\r
380 }\r
381\r
382 // Update the BootOrder environment variable\r
383 Status = gRT->SetVariable (\r
384 L"BootOrder",\r
385 &gEfiGlobalVariableGuid,\r
386 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
387 BootOrderSize - sizeof(UINT16),\r
388 BootOrder\r
389 );\r
390 }\r
391\r
b148591a 392 FreePool (BootOrder);\r
393\r
ea46ebbe 394 return EFI_SUCCESS;\r
395}\r