2 * Device tree enumeration DXE driver for ARM Virtual Machines
4 * Copyright (c) 2014, Linaro Ltd. All rights reserved.<BR>
6 * This program and the accompanying materials are
7 * licensed and made available under the terms and conditions of the BSD License
8 * which accompanies this distribution. The full text of the license may be found at
9 * http://opensource.org/licenses/bsd-license.php
11 * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include <Library/BaseLib.h>
17 #include <Library/DebugLib.h>
18 #include <Library/UefiLib.h>
19 #include <Library/BaseMemoryLib.h>
20 #include <Library/UefiDriverEntryPoint.h>
21 #include <Library/MemoryAllocationLib.h>
22 #include <Library/UefiBootServicesTableLib.h>
23 #include <Library/VirtioMmioDeviceLib.h>
24 #include <Library/DevicePathLib.h>
25 #include <Library/PcdLib.h>
26 #include <Library/DxeServicesLib.h>
27 #include <Library/HobLib.h>
29 #include <Library/XenIoMmioLib.h>
32 #include <Guid/VirtioMmioTransport.h>
33 #include <Guid/FdtHob.h>
37 VENDOR_DEVICE_PATH Vendor
;
39 EFI_DEVICE_PATH_PROTOCOL End
;
40 } VIRTIO_TRANSPORT_DEVICE_PATH
;
58 STATIC CONST PROPERTY CompatibleProperties
[] = {
59 { PropertyTypeRtc
, "arm,pl031" },
60 { PropertyTypeVirtio
, "virtio,mmio" },
61 { PropertyTypeUart
, "arm,pl011" },
62 { PropertyTypeFwCfg
, "qemu,fw-cfg-mmio" },
63 { PropertyTypePciHost
, "pci-host-ecam-generic" },
64 { PropertyTypeXen
, "xen,xen" },
65 { PropertyTypeUnknown
, "" }
71 IN CONST CHAR8
*NodeType
,
75 CONST CHAR8
*Compatible
;
76 CONST PROPERTY
*CompatibleProperty
;
79 // A 'compatible' node may contain a sequence of NULL terminated
80 // compatible strings so check each one
82 for (Compatible
= NodeType
; Compatible
< NodeType
+ Size
&& *Compatible
;
83 Compatible
+= 1 + AsciiStrLen (Compatible
)) {
84 for (CompatibleProperty
= CompatibleProperties
; CompatibleProperty
->Compatible
[0]; CompatibleProperty
++) {
85 if (AsciiStrCmp (CompatibleProperty
->Compatible
, Compatible
) == 0) {
86 return CompatibleProperty
->Type
;
90 return PropertyTypeUnknown
;
94 // We expect the "ranges" property of "pci-host-ecam-generic" to consist of
103 } DTB_PCI_HOST_RANGE_RECORD
;
106 #define DTB_PCI_HOST_RANGE_RELOCATABLE BIT31
107 #define DTB_PCI_HOST_RANGE_PREFETCHABLE BIT30
108 #define DTB_PCI_HOST_RANGE_ALIASED BIT29
109 #define DTB_PCI_HOST_RANGE_MMIO32 BIT25
110 #define DTB_PCI_HOST_RANGE_MMIO64 (BIT25 | BIT24)
111 #define DTB_PCI_HOST_RANGE_IO BIT24
112 #define DTB_PCI_HOST_RANGE_TYPEMASK (BIT31 | BIT30 | BIT29 | BIT25 | BIT24)
115 Process the device tree node describing the generic PCI host controller.
117 param[in] DeviceTreeBase Pointer to the device tree.
119 param[in] Node Offset of the device tree node whose "compatible"
120 property is "pci-host-ecam-generic".
122 param[in] RegProp Pointer to the "reg" property of Node. The caller
123 is responsible for ensuring that the size of the
124 property is 4 UINT32 cells.
126 @retval EFI_SUCCESS Parsing successful, properties parsed from Node
127 have been stored in dynamic PCDs.
129 @retval EFI_PROTOCOL_ERROR Parsing failed. PCDs are left unchanged.
135 IN CONST VOID
*DeviceTreeBase
,
137 IN CONST VOID
*RegProp
140 UINT64 ConfigBase
, ConfigSize
;
143 UINT32 BusMin
, BusMax
;
145 UINT64 IoBase
, IoSize
, IoTranslation
;
146 UINT64 MmioBase
, MmioSize
, MmioTranslation
;
149 // Fetch the ECAM window.
151 ConfigBase
= fdt64_to_cpu (((CONST UINT64
*)RegProp
)[0]);
152 ConfigSize
= fdt64_to_cpu (((CONST UINT64
*)RegProp
)[1]);
155 // Fetch the bus range (note: inclusive).
157 Prop
= fdt_getprop (DeviceTreeBase
, Node
, "bus-range", &Len
);
158 if (Prop
== NULL
|| Len
!= 2 * sizeof(UINT32
)) {
159 DEBUG ((EFI_D_ERROR
, "%a: 'bus-range' not found or invalid\n",
161 return EFI_PROTOCOL_ERROR
;
163 BusMin
= fdt32_to_cpu (((CONST UINT32
*)Prop
)[0]);
164 BusMax
= fdt32_to_cpu (((CONST UINT32
*)Prop
)[1]);
167 // Sanity check: the config space must accommodate all 4K register bytes of
168 // all 8 functions of all 32 devices of all buses.
170 if (BusMax
< BusMin
|| BusMax
- BusMin
== MAX_UINT32
||
171 DivU64x32 (ConfigSize
, SIZE_4KB
* 8 * 32) < BusMax
- BusMin
+ 1) {
172 DEBUG ((EFI_D_ERROR
, "%a: invalid 'bus-range' and/or 'reg'\n",
174 return EFI_PROTOCOL_ERROR
;
178 // Iterate over "ranges".
180 Prop
= fdt_getprop (DeviceTreeBase
, Node
, "ranges", &Len
);
181 if (Prop
== NULL
|| Len
== 0 ||
182 Len
% sizeof (DTB_PCI_HOST_RANGE_RECORD
) != 0) {
183 DEBUG ((EFI_D_ERROR
, "%a: 'ranges' not found or invalid\n", __FUNCTION__
));
184 return EFI_PROTOCOL_ERROR
;
188 // IoBase, IoTranslation, MmioBase and MmioTranslation are initialized only
189 // in order to suppress '-Werror=maybe-uninitialized' warnings *incorrectly*
190 // emitted by some gcc versions.
198 // IoSize and MmioSize are initialized to zero because the logic below
203 for (RecordIdx
= 0; RecordIdx
< Len
/ sizeof (DTB_PCI_HOST_RANGE_RECORD
);
205 CONST DTB_PCI_HOST_RANGE_RECORD
*Record
;
207 Record
= (CONST DTB_PCI_HOST_RANGE_RECORD
*)Prop
+ RecordIdx
;
208 switch (fdt32_to_cpu (Record
->Type
) & DTB_PCI_HOST_RANGE_TYPEMASK
) {
209 case DTB_PCI_HOST_RANGE_IO
:
210 IoBase
= fdt64_to_cpu (Record
->ChildBase
);
211 IoSize
= fdt64_to_cpu (Record
->Size
);
212 IoTranslation
= fdt64_to_cpu (Record
->CpuBase
) - IoBase
;
215 case DTB_PCI_HOST_RANGE_MMIO32
:
216 MmioBase
= fdt64_to_cpu (Record
->ChildBase
);
217 MmioSize
= fdt64_to_cpu (Record
->Size
);
218 MmioTranslation
= fdt64_to_cpu (Record
->CpuBase
) - MmioBase
;
220 if (MmioBase
> MAX_UINT32
|| MmioSize
> MAX_UINT32
||
221 MmioBase
+ MmioSize
> SIZE_4GB
) {
222 DEBUG ((EFI_D_ERROR
, "%a: MMIO32 space invalid\n", __FUNCTION__
));
223 return EFI_PROTOCOL_ERROR
;
226 if (MmioTranslation
!= 0) {
227 DEBUG ((EFI_D_ERROR
, "%a: unsupported nonzero MMIO32 translation "
228 "0x%Lx\n", __FUNCTION__
, MmioTranslation
));
229 return EFI_UNSUPPORTED
;
235 if (IoSize
== 0 || MmioSize
== 0) {
236 DEBUG ((EFI_D_ERROR
, "%a: %a space empty\n", __FUNCTION__
,
237 (IoSize
== 0) ? "IO" : "MMIO32"));
238 return EFI_PROTOCOL_ERROR
;
241 PcdSet64 (PcdPciExpressBaseAddress
, ConfigBase
);
243 PcdSet32 (PcdPciBusMin
, BusMin
);
244 PcdSet32 (PcdPciBusMax
, BusMax
);
246 PcdSet64 (PcdPciIoBase
, IoBase
);
247 PcdSet64 (PcdPciIoSize
, IoSize
);
248 PcdSet64 (PcdPciIoTranslation
, IoTranslation
);
250 PcdSet32 (PcdPciMmio32Base
, (UINT32
)MmioBase
);
251 PcdSet32 (PcdPciMmio32Size
, (UINT32
)MmioSize
);
253 PcdSetBool (PcdPciDisableBusEnumeration
, FALSE
);
255 DEBUG ((EFI_D_INFO
, "%a: Config[0x%Lx+0x%Lx) Bus[0x%x..0x%x] "
256 "Io[0x%Lx+0x%Lx)@0x%Lx Mem[0x%Lx+0x%Lx)@0x%Lx\n", __FUNCTION__
, ConfigBase
,
257 ConfigSize
, BusMin
, BusMax
, IoBase
, IoSize
, IoTranslation
, MmioBase
,
258 MmioSize
, MmioTranslation
));
265 InitializeVirtFdtDxe (
266 IN EFI_HANDLE ImageHandle
,
267 IN EFI_SYSTEM_TABLE
*SystemTable
271 VOID
*DeviceTreeBase
;
277 PROPERTY_TYPE PropType
;
279 VIRTIO_TRANSPORT_DEVICE_PATH
*DevicePath
;
282 UINT64 FwCfgSelectorAddress
;
283 UINT64 FwCfgSelectorSize
;
284 UINT64 FwCfgDataAddress
;
285 UINT64 FwCfgDataSize
;
286 UINT64 FwCfgDmaAddress
;
290 Hob
= GetFirstGuidHob(&gFdtHobGuid
);
291 if (Hob
== NULL
|| GET_GUID_HOB_DATA_SIZE (Hob
) != sizeof (UINT64
)) {
292 return EFI_NOT_FOUND
;
294 DeviceTreeBase
= (VOID
*)(UINTN
)*(UINT64
*)GET_GUID_HOB_DATA (Hob
);
296 if (fdt_check_header (DeviceTreeBase
) != 0) {
297 DEBUG ((EFI_D_ERROR
, "%a: No DTB found @ 0x%p\n", __FUNCTION__
, DeviceTreeBase
));
298 return EFI_NOT_FOUND
;
301 DEBUG ((EFI_D_INFO
, "%a: DTB @ 0x%p\n", __FUNCTION__
, DeviceTreeBase
));
306 // Now enumerate the nodes and install peripherals that we are interested in,
307 // i.e., GIC, RTC and virtio MMIO nodes
309 for (Prev
= 0;; Prev
= Node
) {
310 Node
= fdt_next_node (DeviceTreeBase
, Prev
, NULL
);
315 Type
= fdt_getprop (DeviceTreeBase
, Node
, "compatible", &Len
);
320 PropType
= GetTypeFromNode (Type
, Len
);
321 if (PropType
== PropertyTypeUnknown
) {
326 // Get the 'reg' property of this node. For now, we will assume
327 // 8 byte quantities for base and size, respectively.
328 // TODO use #cells root properties instead
330 RegProp
= fdt_getprop (DeviceTreeBase
, Node
, "reg", &Len
);
331 ASSERT (RegProp
!= NULL
);
334 case PropertyTypePciHost
:
335 ASSERT (Len
== 2 * sizeof (UINT64
));
336 Status
= ProcessPciHost (DeviceTreeBase
, Node
, RegProp
);
337 ASSERT_EFI_ERROR (Status
);
341 case PropertyTypeFwCfg
:
342 ASSERT (Len
== 2 * sizeof (UINT64
));
344 FwCfgDataAddress
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
346 FwCfgSelectorAddress
= FwCfgDataAddress
+ FwCfgDataSize
;
347 FwCfgSelectorSize
= 2;
350 // The following ASSERT()s express
352 // Address + Size - 1 <= MAX_UINTN
354 // for both registers, that is, that the last byte in each MMIO range is
355 // expressible as a MAX_UINTN. The form below is mathematically
356 // equivalent, and it also prevents any unsigned overflow before the
359 ASSERT (FwCfgSelectorAddress
<= MAX_UINTN
- FwCfgSelectorSize
+ 1);
360 ASSERT (FwCfgDataAddress
<= MAX_UINTN
- FwCfgDataSize
+ 1);
362 PcdSet64 (PcdFwCfgSelectorAddress
, FwCfgSelectorAddress
);
363 PcdSet64 (PcdFwCfgDataAddress
, FwCfgDataAddress
);
365 DEBUG ((EFI_D_INFO
, "Found FwCfg @ 0x%Lx/0x%Lx\n", FwCfgSelectorAddress
,
368 if (fdt64_to_cpu (((UINT64
*)RegProp
)[1]) >= 0x18) {
369 FwCfgDmaAddress
= FwCfgDataAddress
+ 0x10;
373 // See explanation above.
375 ASSERT (FwCfgDmaAddress
<= MAX_UINTN
- FwCfgDmaSize
+ 1);
377 PcdSet64 (PcdFwCfgDmaAddress
, FwCfgDmaAddress
);
378 DEBUG ((EFI_D_INFO
, "Found FwCfg DMA @ 0x%Lx\n", FwCfgDmaAddress
));
382 case PropertyTypeVirtio
:
385 // Create a unique device path for this transport on the fly
387 RegBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
388 DevicePath
= (VIRTIO_TRANSPORT_DEVICE_PATH
*)CreateDeviceNode (
389 HARDWARE_DEVICE_PATH
,
391 sizeof (VIRTIO_TRANSPORT_DEVICE_PATH
));
392 if (DevicePath
== NULL
) {
393 DEBUG ((EFI_D_ERROR
, "%a: Out of memory\n", __FUNCTION__
));
397 CopyMem (&DevicePath
->Vendor
.Guid
, &gVirtioMmioTransportGuid
,
399 DevicePath
->PhysBase
= RegBase
;
400 SetDevicePathNodeLength (&DevicePath
->Vendor
,
401 sizeof (*DevicePath
) - sizeof (DevicePath
->End
));
402 SetDevicePathEndNode (&DevicePath
->End
);
405 Status
= gBS
->InstallProtocolInterface (&Handle
,
406 &gEfiDevicePathProtocolGuid
, EFI_NATIVE_INTERFACE
,
408 if (EFI_ERROR (Status
)) {
409 DEBUG ((EFI_D_ERROR
, "%a: Failed to install the EFI_DEVICE_PATH "
410 "protocol on a new handle (Status == %r)\n",
411 __FUNCTION__
, Status
));
412 FreePool (DevicePath
);
416 Status
= VirtioMmioInstallDevice (RegBase
, Handle
);
417 if (EFI_ERROR (Status
)) {
418 DEBUG ((EFI_D_ERROR
, "%a: Failed to install VirtIO transport @ 0x%Lx "
419 "on handle %p (Status == %r)\n", __FUNCTION__
, RegBase
,
422 Status
= gBS
->UninstallProtocolInterface (Handle
,
423 &gEfiDevicePathProtocolGuid
, DevicePath
);
424 ASSERT_EFI_ERROR (Status
);
425 FreePool (DevicePath
);
429 case PropertyTypeRtc
:
432 RegBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
433 ASSERT (RegBase
< MAX_UINT32
);
435 PcdSet32 (PcdPL031RtcBase
, (UINT32
)RegBase
);
437 DEBUG ((EFI_D_INFO
, "Found PL031 RTC @ 0x%Lx\n", RegBase
));
441 case PropertyTypeXen
:
445 // Retrieve the reg base from this node and wire it up to the
446 // MMIO flavor of the XenBus root device I/O protocol
448 RegBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
450 Status
= XenIoMmioInstall (&Handle
, RegBase
);
451 if (EFI_ERROR (Status
)) {
452 DEBUG ((EFI_D_ERROR
, "%a: XenIoMmioInstall () failed on a new handle "
453 "(Status == %r)\n", __FUNCTION__
, Status
));
457 DEBUG ((EFI_D_INFO
, "Found Xen node with Grant table @ 0x%Lx\n", RegBase
));
466 if (!FeaturePcdGet (PcdPureAcpiBoot
)) {
468 // Only install the FDT as a configuration table if we want to leave it up
469 // to the OS to decide whether it prefers ACPI over DT.
471 Status
= gBS
->InstallConfigurationTable (&gFdtTableGuid
, DeviceTreeBase
);
472 ASSERT_EFI_ERROR (Status
);
475 // UEFI takes ownership of the RTC hardware, and exposes its functionality
476 // through the UEFI Runtime Services GetTime, SetTime, etc. This means we
477 // need to disable it in the device tree to prevent the OS from attaching its
478 // device driver as well.
480 if ((RtcNode
!= -1) &&
481 fdt_setprop_string (DeviceTreeBase
, RtcNode
, "status",
483 DEBUG ((EFI_D_WARN
, "Failed to set PL031 status to 'disabled'\n"));
488 // Set the /chosen/linux,pci-probe-only property to 1, so that the PCI
489 // setup we will perform in the firmware is honored by the Linux OS,
490 // rather than torn down and done from scratch. This is generally a more
491 // sensible approach, and aligns with what ACPI based OSes do in general.
493 // In case we are exposing an emulated VGA PCI device to the guest, which
494 // may subsequently get exposed via the Graphics Output protocol and
495 // driven as an efifb by Linux, we need this setting to prevent the
496 // framebuffer from becoming unresponsive.
498 Node
= fdt_path_offset (DeviceTreeBase
, "/chosen");
500 Node
= fdt_add_subnode (DeviceTreeBase
, 0, "/chosen");
503 fdt_setprop_u32 (DeviceTreeBase
, Node
, "linux,pci-probe-only", 1) < 0) {
504 DEBUG ((EFI_D_WARN
, "Failed to set /chosen/linux,pci-probe-only property\n"));