3 Copyright (c) 2006 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Head file for BDS Platform specific code
22 #ifndef _PLATFORM_SPECIFIC_BDS_PLATFORM_H_
23 #define _PLATFORM_SPECIFIC_BDS_PLATFORM_H_
28 #include <IndustryStandard/Pci.h>
29 #include <IndustryStandard/Acpi.h>
30 #include <IndustryStandard/SmBios.h>
31 #include <IndustryStandard/LegacyBiosMpTable.h>
33 #include <Library/DebugLib.h>
34 #include <Library/BaseMemoryLib.h>
35 #include <Library/UefiBootServicesTableLib.h>
36 #include <Library/MemoryAllocationLib.h>
37 #include <Library/BaseLib.h>
38 #include <Library/PcdLib.h>
39 #include <Library/GenericBdsLib.h>
40 #include <Library/PlatformBdsLib.h>
41 #include <Library/HobLib.h>
42 #include <Library/UefiLib.h>
43 #include <Library/DxeServicesTableLib.h>
44 #include <Library/DevicePathLib.h>
46 #include <Protocol/PciIo.h>
49 #include <Guid/Acpi.h>
50 #include <Guid/SmBios.h>
52 #include <Guid/HobList.h>
53 #include <Guid/PciExpressBaseAddress.h>
54 #include <Guid/GlobalVariable.h>
56 extern BDS_CONSOLE_CONNECT_ENTRY gPlatformConsole
[];
57 extern EFI_DEVICE_PATH_PROTOCOL
*gPlatformConnectSequence
[];
58 extern EFI_DEVICE_PATH_PROTOCOL
*gPlatformDriverOption
[];
59 extern EFI_DEVICE_PATH_PROTOCOL
*gPlatformRootBridges
[];
60 extern ACPI_HID_DEVICE_PATH gPnpPs2KeyboardDeviceNode
;
61 extern ACPI_HID_DEVICE_PATH gPnp16550ComPortDeviceNode
;
62 extern UART_DEVICE_PATH gUartDeviceNode
;
63 extern VENDOR_DEVICE_PATH gTerminalTypeDeviceNode
;
67 #define VarConsoleInpDev L"ConInDev"
68 #define VarConsoleInp L"ConIn"
69 #define VarConsoleOutDev L"ConOutDev"
70 #define VarConsoleOut L"ConOut"
71 #define VarErrorOutDev L"ErrOutDev"
72 #define VarErrorOut L"ErrOut"
74 #define PCI_DEVICE_PATH_NODE(Func, Dev) \
76 HARDWARE_DEVICE_PATH, \
79 (UINT8) (sizeof (PCI_DEVICE_PATH)), \
80 (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) \
86 #define PNPID_DEVICE_PATH_NODE(PnpId) \
92 (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \
93 (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \
96 EISA_PNP_ID((PnpId)), \
100 #define gPciRootBridge \
101 PNPID_DEVICE_PATH_NODE(0x0A03)
103 #define gPciIsaBridge \
104 PCI_DEVICE_PATH_NODE(0, 0x1f)
107 PCI_DEVICE_PATH_NODE(0, 0x1e)
109 #define gPnpPs2Keyboard \
110 PNPID_DEVICE_PATH_NODE(0x0303)
112 #define gPnp16550ComPort \
113 PNPID_DEVICE_PATH_NODE(0x0501)
118 MESSAGING_DEVICE_PATH, \
121 (UINT8) (sizeof (UART_DEVICE_PATH)), \
122 (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8) \
132 #define gPcAnsiTerminal \
135 MESSAGING_DEVICE_PATH, \
138 (UINT8) (sizeof (VENDOR_DEVICE_PATH)), \
139 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) \
142 DEVICE_PATH_MESSAGING_PC_ANSI \
147 END_DEVICE_PATH_TYPE, \
148 END_ENTIRE_DEVICE_PATH_SUBTYPE, \
150 END_DEVICE_PATH_LENGTH, \
155 #define PCI_CLASS_SCC 0x07
156 #define PCI_SUBCLASS_SERIAL 0x00
157 #define PCI_IF_16550 0x02
158 #define IS_PCI_16550SERIAL(_p) IS_CLASS3 (_p, PCI_CLASS_SCC, PCI_SUBCLASS_SERIAL, PCI_IF_16550)
160 #define EFI_SYSTEM_TABLE_MAX_ADDRESS 0xFFFFFFFF
161 #define SYS_TABLE_PAD(ptr) (((~ptr) +1) & 0x07 )
163 // Platform Root Bridge
166 ACPI_HID_DEVICE_PATH PciRootBridge
;
167 EFI_DEVICE_PATH_PROTOCOL End
;
168 } PLATFORM_ROOT_BRIDGE_DEVICE_PATH
;
171 ACPI_HID_DEVICE_PATH PciRootBridge
;
172 PCI_DEVICE_PATH IsaBridge
;
173 ACPI_HID_DEVICE_PATH Keyboard
;
174 EFI_DEVICE_PATH_PROTOCOL End
;
175 } PLATFORM_DUMMY_ISA_KEYBOARD_DEVICE_PATH
;
178 ACPI_HID_DEVICE_PATH PciRootBridge
;
179 PCI_DEVICE_PATH IsaBridge
;
180 ACPI_HID_DEVICE_PATH IsaSerial
;
181 UART_DEVICE_PATH Uart
;
182 VENDOR_DEVICE_PATH TerminalType
;
183 EFI_DEVICE_PATH_PROTOCOL End
;
184 } PLATFORM_DUMMY_ISA_SERIAL_DEVICE_PATH
;
187 ACPI_HID_DEVICE_PATH PciRootBridge
;
188 PCI_DEVICE_PATH VgaDevice
;
189 EFI_DEVICE_PATH_PROTOCOL End
;
190 } PLATFORM_DUMMY_PCI_VGA_DEVICE_PATH
;
193 ACPI_HID_DEVICE_PATH PciRootBridge
;
194 PCI_DEVICE_PATH PciBridge
;
195 PCI_DEVICE_PATH SerialDevice
;
196 UART_DEVICE_PATH Uart
;
197 VENDOR_DEVICE_PATH TerminalType
;
198 EFI_DEVICE_PATH_PROTOCOL End
;
199 } PLATFORM_DUMMY_PCI_SERIAL_DEVICE_PATH
;
202 // the short form device path for Usb keyboard
205 #define SUBCLASS_BOOT 1
206 #define PROTOCOL_KEYBOARD 1
209 USB_CLASS_DEVICE_PATH UsbClass
;
210 EFI_DEVICE_PATH_PROTOCOL End
;
211 } USB_CLASS_FORMAT_DEVICE_PATH
;
213 extern PLATFORM_ROOT_BRIDGE_DEVICE_PATH gPlatformRootBridge0
;
216 // Platform BDS Functions
220 IN EFI_BDS_ARCH_PROTOCOL_INSTANCE
*PrivateData
224 PlatformBdsPolicyBehavior (
225 IN EFI_BDS_ARCH_PROTOCOL_INSTANCE
*PrivateData
,
226 IN LIST_ENTRY
*DriverOptionList
,
227 IN LIST_ENTRY
*BootOptionList
231 PlatformBdsGetDriverOption (
232 IN LIST_ENTRY
*BdsDriverLists
237 EXTENDMEM_COVERAGE_LEVEL Level
241 PlatformBdsShowProgress (
242 EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground
,
243 EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground
,
245 EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor
,
251 PlatformBdsConnectSequence (
256 PlatformBdsBootFail (
257 IN BDS_COMMON_OPTION
*Option
,
258 IN EFI_STATUS Status
,
260 IN UINTN ExitDataSize
264 PlatformBdsBootSuccess (
265 IN BDS_COMMON_OPTION
*Option
270 EFI_BOOT_MODE BootMode
274 PlatformBdsConnectConsole (
275 IN BDS_CONSOLE_CONNECT_ENTRY
*PlatformConsole
279 PlatformBdsNoConsoleAction (
301 IN EFI_GUID
*TableGuid
,
306 PlatformBdsEnterFrontPage (
307 IN UINT16 TimeoutDefault
,
308 IN BOOLEAN ConnectAllHappened
311 #endif // _PLATFORM_SPECIFIC_BDS_PLATFORM_H_