3 * Copyright (c) 2011, ARM Limited. All rights reserved.
5 * This program and the accompanying materials
6 * are licensed and made available under the terms and conditions of the BSD License
7 * which accompanies this distribution. The full text of the license may be found at
8 * http://opensource.org/licenses/bsd-license.php
10 * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _BDSINTERNAL_H_
16 #define _BDSINTERNAL_H_
19 #include <Library/BaseMemoryLib.h>
20 #include <Library/BdsLib.h>
21 #include <Library/BdsUnixLib.h>
22 #include <Library/DebugLib.h>
23 #include <Library/DevicePathLib.h>
24 #include <Library/UefiLib.h>
25 #include <Library/PrintLib.h>
26 #include <Library/PcdLib.h>
27 #include <Library/MemoryAllocationLib.h>
28 #include <Library/UefiBootServicesTableLib.h>
29 #include <Library/UefiRuntimeServicesTableLib.h>
31 #include <Protocol/DevicePathFromText.h>
32 #include <Protocol/DevicePathToText.h>
34 #include <Guid/GlobalVariable.h>
36 #define BOOT_DEVICE_DESCRIPTION_MAX 100
37 #define BOOT_DEVICE_FILEPATH_MAX 100
38 #define BOOT_DEVICE_OPTION_MAX 300
39 #define BOOT_DEVICE_ADDRESS_MAX 20
41 #define ARM_BDS_OPTIONAL_DATA_SIGNATURE SIGNATURE_32('a', 'b', 'o', 'd')
43 #define IS_ARM_BDS_BOOTENTRY(ptr) (ReadUnaligned32 ((CONST UINT32*)&((ARM_BDS_LOADER_OPTIONAL_DATA*)((ptr)->OptionalData))->Header.Signature) == ARM_BDS_OPTIONAL_DATA_SIGNATURE)
46 BDS_LOADER_EFI_APPLICATION
= 0,
47 BDS_LOADER_KERNEL_LINUX_ATAG
,
48 BDS_LOADER_KERNEL_LINUX_FDT
,
49 } ARM_BDS_LOADER_TYPE
;
55 // These following fields have variable length and are packed:
57 //EFI_DEVICE_PATH_PROTOCOL *InitrdPathList;
58 } ARM_BDS_LINUX_ARGUMENTS
;
61 ARM_BDS_LINUX_ARGUMENTS LinuxArguments
;
62 } ARM_BDS_LOADER_ARGUMENTS
;
66 ARM_BDS_LOADER_TYPE LoaderType
;
67 } ARM_BDS_LOADER_OPTIONAL_DATA_HEADER
;
70 ARM_BDS_LOADER_OPTIONAL_DATA_HEADER Header
;
71 ARM_BDS_LOADER_ARGUMENTS Arguments
;
72 } ARM_BDS_LOADER_OPTIONAL_DATA
;
76 BDS_LOAD_OPTION
* BdsLoadOption
;
77 } BDS_LOAD_OPTION_ENTRY
;
80 BDS_DEVICE_FILESYSTEM
= 0,
85 } BDS_SUPPORTED_DEVICE_TYPE
;
89 CHAR16 Description
[BOOT_DEVICE_DESCRIPTION_MAX
];
90 EFI_DEVICE_PATH_PROTOCOL
* DevicePathProtocol
;
91 struct _BDS_LOAD_OPTION_SUPPORT
* Support
;
92 } BDS_SUPPORTED_DEVICE
;
94 #define SUPPORTED_BOOT_DEVICE_FROM_LINK(a) BASE_CR(a, BDS_SUPPORTED_DEVICE, Link)
96 typedef struct _BDS_LOAD_OPTION_SUPPORT
{
97 BDS_SUPPORTED_DEVICE_TYPE Type
;
98 EFI_STATUS (*ListDevices
)(IN OUT LIST_ENTRY
* BdsLoadOptionList
);
99 BOOLEAN (*IsSupported
)(IN BDS_LOAD_OPTION
* BdsLoadOption
);
100 EFI_STATUS (*CreateDevicePathNode
)(IN BDS_SUPPORTED_DEVICE
* BdsLoadOption
, OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePathNode
, OUT ARM_BDS_LOADER_TYPE
*BootType
, OUT UINT32
*Attributes
);
101 EFI_STATUS (*UpdateDevicePathNode
)(IN EFI_DEVICE_PATH
*OldDevicePath
, OUT EFI_DEVICE_PATH_PROTOCOL
** NewDevicePath
, OUT ARM_BDS_LOADER_TYPE
*BootType
, OUT UINT32
*Attributes
);
102 } BDS_LOAD_OPTION_SUPPORT
;
104 #define LOAD_OPTION_ENTRY_FROM_LINK(a) BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link)
105 #define LOAD_OPTION_FROM_LINK(a) ((BDS_LOAD_OPTION_ENTRY*)BASE_CR(a, BDS_LOAD_OPTION_ENTRY, Link))->BdsLoadOption
108 GetEnvironmentVariable (
109 IN CONST CHAR16
* VariableName
,
110 IN VOID
* DefaultValue
,
116 BootDeviceListSupportedInit (
117 IN OUT LIST_ENTRY
*SupportedDeviceList
121 BootDeviceListSupportedFree (
122 IN LIST_ENTRY
*SupportedDeviceList
,
123 IN BDS_SUPPORTED_DEVICE
*Except
127 BootDeviceGetDeviceSupport (
128 IN BDS_LOAD_OPTION
*BootOption
,
129 OUT BDS_LOAD_OPTION_SUPPORT
** DeviceSupport
134 IN OUT CHAR16
*CmdLine
,
140 IN OUT CHAR16
*CmdLine
,
146 IN OUT CHAR8
*CmdLine
,
152 IN OUT CHAR8
*CmdLine
,
158 IN OUT UINTN
*Integer
163 OUT EFI_IP_ADDRESS
*Ip
172 HasFilePathEfiExtension (
177 GetLastDevicePathNode (
178 IN EFI_DEVICE_PATH
* DevicePath
183 IN CHAR16
* BootOption
187 GetUnalignedDevicePathSize (
188 IN EFI_DEVICE_PATH
* DevicePath
192 GetAlignedDevicePath (
193 IN EFI_DEVICE_PATH
* DevicePath
197 GenerateDeviceDescriptionName (
198 IN EFI_HANDLE Handle
,
199 IN OUT CHAR16
* Description
204 IN OUT LIST_ENTRY
*BootOptionList
208 BootOptionParseLoadOption (
209 IN EFI_LOAD_OPTION EfiLoadOption
,
210 IN UINTN EfiLoadOptionSize
,
211 OUT BDS_LOAD_OPTION
**BdsLoadOption
216 IN BDS_LOAD_OPTION
*BootOption
221 IN UINT32 Attributes
,
222 IN CHAR16
* BootDescription
,
223 IN EFI_DEVICE_PATH_PROTOCOL
* DevicePath
,
224 IN ARM_BDS_LOADER_TYPE BootType
,
225 IN ARM_BDS_LOADER_ARGUMENTS
* BootArguments
,
226 OUT BDS_LOAD_OPTION
** BdsLoadOption
231 IN BDS_LOAD_OPTION
* BdsLoadOption
,
232 IN UINT32 Attributes
,
233 IN CHAR16
* BootDescription
,
234 IN EFI_DEVICE_PATH_PROTOCOL
* DevicePath
,
235 IN ARM_BDS_LOADER_TYPE BootType
,
236 IN ARM_BDS_LOADER_ARGUMENTS
* BootArguments
241 IN BDS_LOAD_OPTION
*BootOption
249 #endif /* _BDSINTERNAL_H_ */