]> git.proxmox.com Git - mirror_edk2.git/blame - ArmPlatformPkg/Bds/BootOption.c
ArmPlatformPkg/Bds: Add support to handle Unicode parameters
[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
79480c8d 89 FreePool (DefaultFdtDevicePath);\r
b148591a 90 FreePool (FdtDevicePath);\r
a6e97d28 91 }\r
92 } else {\r
91213ad3 93 // Set BootCurrent variable\r
94 LoadOptionIndexSize = sizeof(UINT16);\r
95 gRT->SetVariable (L"BootCurrent", &gEfiGlobalVariableGuid,\r
96 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
97 LoadOptionIndexSize, &(BootOption->LoadOptionIndex));\r
98\r
2755d844 99 Status = BdsStartEfiApplication (mImageHandle, BootOption->FilePathList, BootOption->OptionalDataSize, BootOption->OptionalData);\r
91213ad3 100\r
101 // Clear BootCurrent variable\r
102 LoadOptionIndexSize = sizeof(UINT16);\r
103 gRT->SetVariable (L"BootCurrent", &gEfiGlobalVariableGuid,\r
104 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
105 0, NULL);\r
a6e97d28 106 }\r
ea46ebbe 107\r
108 return Status;\r
109}\r
110\r
ea46ebbe 111EFI_STATUS\r
112BootOptionList (\r
113 IN OUT LIST_ENTRY *BootOptionList\r
114 )\r
115{\r
a6e97d28 116 EFI_STATUS Status;\r
117 UINTN Index;\r
118 UINT16* BootOrder;\r
119 UINTN BootOrderSize;\r
120 BDS_LOAD_OPTION* BdsLoadOption;\r
121 BDS_LOAD_OPTION_ENTRY* BdsLoadOptionEntry;\r
ea46ebbe 122\r
123 InitializeListHead (BootOptionList);\r
124\r
125 // Get the Boot Option Order from the environment variable\r
c0b2e477 126 Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe 127 if (EFI_ERROR(Status)) {\r
128 return Status;\r
129 }\r
130\r
131 for (Index = 0; Index < BootOrderSize / sizeof (UINT16); Index++) {\r
4aa24170 132 Status = BootOptionFromLoadOptionIndex (BootOrder[Index], &BdsLoadOption);\r
ea46ebbe 133 if (!EFI_ERROR(Status)) {\r
a6e97d28 134 BdsLoadOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool(sizeof(BDS_LOAD_OPTION_ENTRY));\r
135 BdsLoadOptionEntry->BdsLoadOption = BdsLoadOption;\r
136 InsertTailList (BootOptionList,&BdsLoadOptionEntry->Link);\r
ea46ebbe 137 }\r
138 }\r
139\r
b148591a 140 FreePool (BootOrder);\r
141\r
ea46ebbe 142 return EFI_SUCCESS;\r
143}\r
144\r
ea46ebbe 145STATIC\r
146EFI_STATUS\r
147BootOptionSetFields (\r
c60ea9a8 148 IN BDS_LOAD_OPTION* BootOption,\r
149 IN UINT32 Attributes,\r
150 IN CHAR16* BootDescription,\r
151 IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e 152 IN ARM_BDS_LOADER_TYPE BootType,\r
153 IN ARM_BDS_LOADER_ARGUMENTS* BootArguments\r
ea46ebbe 154 )\r
155{\r
2ccfb71e 156 EFI_LOAD_OPTION EfiLoadOption;\r
157 UINTN EfiLoadOptionSize;\r
158 UINTN BootDescriptionSize;\r
159 UINTN BootOptionalDataSize;\r
160 UINT16 FilePathListLength;\r
161 UINT8* EfiLoadOptionPtr;\r
162 UINT8* InitrdPathListPtr;\r
163 UINTN OptionalDataSize;\r
164 ARM_BDS_LINUX_ARGUMENTS* DestLinuxArguments;\r
165 ARM_BDS_LINUX_ARGUMENTS* SrcLinuxArguments;\r
ea46ebbe 166\r
167 // If we are overwriting an existent Boot Option then we have to free previously allocated memory\r
168 if (BootOption->LoadOption) {\r
169 FreePool(BootOption->LoadOption);\r
170 }\r
171\r
2ccfb71e 172 BootDescriptionSize = StrSize (BootDescription);\r
173 BootOptionalDataSize = sizeof(ARM_BDS_LOADER_OPTIONAL_DATA_HEADER);\r
174 if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
175 BootOptionalDataSize += sizeof(ARM_BDS_LINUX_ARGUMENTS) + BootArguments->LinuxArguments.CmdLineSize + BootArguments->LinuxArguments.InitrdSize;\r
176 }\r
ea46ebbe 177\r
178 // Compute the size of the FilePath list\r
2ccfb71e 179 FilePathListLength = GetUnalignedDevicePathSize (DevicePath);\r
656416bc 180\r
ea46ebbe 181 // Allocate the memory for the EFI Load Option\r
182 EfiLoadOptionSize = sizeof(UINT32) + sizeof(UINT16) + BootDescriptionSize + FilePathListLength + BootOptionalDataSize;\r
183 EfiLoadOption = (EFI_LOAD_OPTION)AllocatePool(EfiLoadOptionSize);\r
184 EfiLoadOptionPtr = EfiLoadOption;\r
185\r
186 //\r
187 // Populate the EFI Load Option and BDS Boot Option structures\r
188 //\r
189\r
190 // Attributes fields\r
191 BootOption->Attributes = Attributes;\r
192 *(UINT32*)EfiLoadOptionPtr = Attributes;\r
193 EfiLoadOptionPtr += sizeof(UINT32);\r
194\r
195 // FilePath List fields\r
196 BootOption->FilePathListLength = FilePathListLength;\r
197 *(UINT16*)EfiLoadOptionPtr = FilePathListLength;\r
198 EfiLoadOptionPtr += sizeof(UINT16);\r
199\r
200 // Boot description fields\r
201 BootOption->Description = (CHAR16*)EfiLoadOptionPtr;\r
202 CopyMem (EfiLoadOptionPtr, BootDescription, BootDescriptionSize);\r
203 EfiLoadOptionPtr += BootDescriptionSize;\r
204\r
205 // File path fields\r
206 BootOption->FilePathList = (EFI_DEVICE_PATH_PROTOCOL*)EfiLoadOptionPtr;\r
2ccfb71e 207 CopyMem (EfiLoadOptionPtr, DevicePath, FilePathListLength);\r
208 EfiLoadOptionPtr += FilePathListLength;\r
ea46ebbe 209\r
210 // Optional Data fields, Do unaligned writes\r
2ccfb71e 211 BootOption->OptionalData = EfiLoadOptionPtr;\r
212 WriteUnaligned32 ((UINT32 *)EfiLoadOptionPtr, ARM_BDS_OPTIONAL_DATA_SIGNATURE);\r
213 WriteUnaligned32 ((UINT32 *)(EfiLoadOptionPtr + 4), BootType);\r
ea46ebbe 214\r
2ccfb71e 215 OptionalDataSize = sizeof(ARM_BDS_LOADER_OPTIONAL_DATA_HEADER);\r
ea46ebbe 216\r
2ccfb71e 217 if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
218 SrcLinuxArguments = &(BootArguments->LinuxArguments);\r
219 DestLinuxArguments = &((ARM_BDS_LOADER_OPTIONAL_DATA*)EfiLoadOptionPtr)->Arguments.LinuxArguments;\r
656416bc 220\r
2ccfb71e 221 WriteUnaligned16 ((UINT16 *)&(DestLinuxArguments->CmdLineSize), SrcLinuxArguments->CmdLineSize);\r
222 WriteUnaligned16 ((UINT16 *)&(DestLinuxArguments->InitrdSize), SrcLinuxArguments->InitrdSize);\r
223 OptionalDataSize += sizeof (ARM_BDS_LINUX_ARGUMENTS);\r
656416bc 224\r
2ccfb71e 225 if (SrcLinuxArguments->CmdLineSize > 0) {\r
226 CopyMem ((VOID*)(DestLinuxArguments + 1), (VOID*)(SrcLinuxArguments + 1), SrcLinuxArguments->CmdLineSize);\r
227 OptionalDataSize += SrcLinuxArguments->CmdLineSize;\r
228 }\r
656416bc 229\r
2ccfb71e 230 if (SrcLinuxArguments->InitrdSize > 0) {\r
231 InitrdPathListPtr = (UINT8*)((UINTN)(DestLinuxArguments + 1) + SrcLinuxArguments->CmdLineSize);\r
232 CopyMem (InitrdPathListPtr, (VOID*)((UINTN)(SrcLinuxArguments + 1) + SrcLinuxArguments->CmdLineSize), SrcLinuxArguments->InitrdSize);\r
656416bc 233 }\r
234 }\r
2ccfb71e 235 BootOption->OptionalDataSize = OptionalDataSize;\r
236\r
6bab33c7 237 // If this function is called at the creation of the Boot Device entry (not at the update) the\r
238 // BootOption->LoadOptionSize must be zero then we get a new BootIndex for this entry\r
239 if (BootOption->LoadOptionSize == 0) {\r
2ccfb71e 240 BootOption->LoadOptionIndex = BootOptionAllocateBootIndex ();\r
6bab33c7 241 }\r
242\r
ea46ebbe 243 // Fill the EFI Load option fields\r
ea46ebbe 244 BootOption->LoadOption = EfiLoadOption;\r
245 BootOption->LoadOptionSize = EfiLoadOptionSize;\r
246\r
247 return EFI_SUCCESS;\r
248}\r
249\r
250EFI_STATUS\r
251BootOptionCreate (\r
c60ea9a8 252 IN UINT32 Attributes,\r
253 IN CHAR16* BootDescription,\r
ea46ebbe 254 IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e 255 IN ARM_BDS_LOADER_TYPE BootType,\r
256 IN ARM_BDS_LOADER_ARGUMENTS* BootArguments,\r
a6e97d28 257 OUT BDS_LOAD_OPTION** BdsLoadOption\r
ea46ebbe 258 )\r
259{\r
a6e97d28 260 EFI_STATUS Status;\r
261 BDS_LOAD_OPTION_ENTRY* BootOptionEntry;\r
262 BDS_LOAD_OPTION* BootOption;\r
263 CHAR16 BootVariableName[9];\r
264 UINT16* BootOrder;\r
265 UINTN BootOrderSize;\r
ea46ebbe 266\r
267 //\r
268 // Allocate and fill the memory for the BDS Load Option structure\r
269 //\r
a6e97d28 270 BootOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool (sizeof (BDS_LOAD_OPTION_ENTRY));\r
271 InitializeListHead (&BootOptionEntry->Link);\r
272 BootOptionEntry->BdsLoadOption = (BDS_LOAD_OPTION*)AllocateZeroPool (sizeof(BDS_LOAD_OPTION));\r
ea46ebbe 273\r
a6e97d28 274 BootOption = BootOptionEntry->BdsLoadOption;\r
ea46ebbe 275 BootOptionSetFields (BootOption, Attributes, BootDescription, DevicePath, BootType, BootArguments);\r
276\r
277 //\r
278 // Set the related environment variables\r
279 //\r
280\r
281 // Create Boot#### environment variable\r
282 UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BootOption->LoadOptionIndex);\r
283 Status = gRT->SetVariable (\r
284 BootVariableName,\r
285 &gEfiGlobalVariableGuid,\r
286 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
287 BootOption->LoadOptionSize,\r
288 BootOption->LoadOption\r
289 );\r
290\r
291 // Add the new Boot Index to the list\r
c0b2e477 292 Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe 293 if (!EFI_ERROR(Status)) {\r
294 BootOrder = ReallocatePool (BootOrderSize, BootOrderSize + sizeof(UINT16), BootOrder);\r
295 // Add the new index at the end\r
296 BootOrder[BootOrderSize / sizeof(UINT16)] = BootOption->LoadOptionIndex;\r
297 BootOrderSize += sizeof(UINT16);\r
298 } else {\r
299 // BootOrder does not exist. Create it\r
300 BootOrderSize = sizeof(UINT16);\r
301 BootOrder = &(BootOption->LoadOptionIndex);\r
302 }\r
303\r
304 // Update (or Create) the BootOrder environment variable\r
305 Status = gRT->SetVariable (\r
306 L"BootOrder",\r
307 &gEfiGlobalVariableGuid,\r
308 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
309 BootOrderSize,\r
310 BootOrder\r
311 );\r
312\r
b148591a 313 // We only free it if the UEFI Variable 'BootOrder' was already existing\r
314 if (BootOrderSize > sizeof(UINT16)) {\r
315 FreePool (BootOrder);\r
316 }\r
317\r
ea46ebbe 318 *BdsLoadOption = BootOption;\r
319 return Status;\r
320}\r
321\r
322EFI_STATUS\r
323BootOptionUpdate (\r
2ccfb71e 324 IN BDS_LOAD_OPTION* BdsLoadOption,\r
325 IN UINT32 Attributes,\r
326 IN CHAR16* BootDescription,\r
ea46ebbe 327 IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e 328 IN ARM_BDS_LOADER_TYPE BootType,\r
329 IN ARM_BDS_LOADER_ARGUMENTS* BootArguments\r
ea46ebbe 330 )\r
331{\r
332 EFI_STATUS Status;\r
ea46ebbe 333 CHAR16 BootVariableName[9];\r
334\r
335 // Update the BDS Load Option structure\r
336 BootOptionSetFields (BdsLoadOption, Attributes, BootDescription, DevicePath, BootType, BootArguments);\r
337\r
338 // Update the related environment variables\r
6bab33c7 339 UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BdsLoadOption->LoadOptionIndex);\r
340\r
ea46ebbe 341 Status = gRT->SetVariable (\r
342 BootVariableName,\r
343 &gEfiGlobalVariableGuid,\r
344 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
6bab33c7 345 BdsLoadOption->LoadOptionSize,\r
346 BdsLoadOption->LoadOption\r
ea46ebbe 347 );\r
348\r
349 return Status;\r
350}\r
351\r
352EFI_STATUS\r
353BootOptionDelete (\r
354 IN BDS_LOAD_OPTION *BootOption\r
355 )\r
356{\r
a6e97d28 357 UINTN Index;\r
358 UINTN BootOrderSize;\r
359 UINT16* BootOrder;\r
360 UINTN BootOrderCount;\r
361 EFI_STATUS Status;\r
ea46ebbe 362\r
363 // Remove the entry from the BootOrder environment variable\r
c0b2e477 364 Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe 365 if (!EFI_ERROR(Status)) {\r
366 BootOrderCount = BootOrderSize / sizeof(UINT16);\r
367\r
368 // Find the index of the removed entry\r
369 for (Index = 0; Index < BootOrderCount; Index++) {\r
370 if (BootOrder[Index] == BootOption->LoadOptionIndex) {\r
371 // If it the last entry we do not need to rearrange the BootOrder list\r
372 if (Index + 1 != BootOrderCount) {\r
9127a094 373 CopyMem (\r
374 &BootOrder[Index],\r
375 &BootOrder[Index + 1],\r
376 (BootOrderCount - (Index + 1)) * sizeof(UINT16)\r
377 );\r
ea46ebbe 378 }\r
379 break;\r
380 }\r
381 }\r
382\r
383 // Update the BootOrder environment variable\r
384 Status = gRT->SetVariable (\r
385 L"BootOrder",\r
386 &gEfiGlobalVariableGuid,\r
387 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
388 BootOrderSize - sizeof(UINT16),\r
389 BootOrder\r
390 );\r
391 }\r
392\r
b148591a 393 FreePool (BootOrder);\r
394\r
ea46ebbe 395 return EFI_SUCCESS;\r
396}\r