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
;
62 STATIC CONST PROPERTY CompatibleProperties
[] = {
63 { PropertyTypeGic
, "arm,cortex-a15-gic" },
64 { PropertyTypeRtc
, "arm,pl031" },
65 { PropertyTypeVirtio
, "virtio,mmio" },
66 { PropertyTypeUart
, "arm,pl011" },
67 { PropertyTypeTimer
, "arm,armv7-timer" },
68 { PropertyTypeTimer
, "arm,armv8-timer" },
69 { PropertyTypePsci
, "arm,psci-0.2" },
70 { PropertyTypeFwCfg
, "qemu,fw-cfg-mmio" },
71 { PropertyTypePciHost
, "pci-host-ecam-generic" },
72 { PropertyTypeGicV3
, "arm,gic-v3" },
73 { PropertyTypeXen
, "xen,xen" },
74 { PropertyTypeUnknown
, "" }
86 IN CONST CHAR8
*NodeType
,
90 CONST CHAR8
*Compatible
;
91 CONST PROPERTY
*CompatibleProperty
;
94 // A 'compatible' node may contain a sequence of NULL terminated
95 // compatible strings so check each one
97 for (Compatible
= NodeType
; Compatible
< NodeType
+ Size
&& *Compatible
;
98 Compatible
+= 1 + AsciiStrLen (Compatible
)) {
99 for (CompatibleProperty
= CompatibleProperties
; CompatibleProperty
->Compatible
[0]; CompatibleProperty
++) {
100 if (AsciiStrCmp (CompatibleProperty
->Compatible
, Compatible
) == 0) {
101 return CompatibleProperty
->Type
;
105 return PropertyTypeUnknown
;
109 // We expect the "ranges" property of "pci-host-ecam-generic" to consist of
110 // records like this.
118 } DTB_PCI_HOST_RANGE_RECORD
;
121 #define DTB_PCI_HOST_RANGE_RELOCATABLE BIT31
122 #define DTB_PCI_HOST_RANGE_PREFETCHABLE BIT30
123 #define DTB_PCI_HOST_RANGE_ALIASED BIT29
124 #define DTB_PCI_HOST_RANGE_MMIO32 BIT25
125 #define DTB_PCI_HOST_RANGE_MMIO64 (BIT25 | BIT24)
126 #define DTB_PCI_HOST_RANGE_IO BIT24
127 #define DTB_PCI_HOST_RANGE_TYPEMASK (BIT31 | BIT30 | BIT29 | BIT25 | BIT24)
130 Process the device tree node describing the generic PCI host controller.
132 param[in] DeviceTreeBase Pointer to the device tree.
134 param[in] Node Offset of the device tree node whose "compatible"
135 property is "pci-host-ecam-generic".
137 param[in] RegProp Pointer to the "reg" property of Node. The caller
138 is responsible for ensuring that the size of the
139 property is 4 UINT32 cells.
141 @retval EFI_SUCCESS Parsing successful, properties parsed from Node
142 have been stored in dynamic PCDs.
144 @retval EFI_PROTOCOL_ERROR Parsing failed. PCDs are left unchanged.
150 IN CONST VOID
*DeviceTreeBase
,
152 IN CONST VOID
*RegProp
155 UINT64 ConfigBase
, ConfigSize
;
158 UINT32 BusMin
, BusMax
;
160 UINT64 IoBase
, IoSize
, IoTranslation
;
161 UINT64 MmioBase
, MmioSize
, MmioTranslation
;
164 // Fetch the ECAM window.
166 ConfigBase
= fdt64_to_cpu (((CONST UINT64
*)RegProp
)[0]);
167 ConfigSize
= fdt64_to_cpu (((CONST UINT64
*)RegProp
)[1]);
170 // Fetch the bus range (note: inclusive).
172 Prop
= fdt_getprop (DeviceTreeBase
, Node
, "bus-range", &Len
);
173 if (Prop
== NULL
|| Len
!= 2 * sizeof(UINT32
)) {
174 DEBUG ((EFI_D_ERROR
, "%a: 'bus-range' not found or invalid\n",
176 return EFI_PROTOCOL_ERROR
;
178 BusMin
= fdt32_to_cpu (((CONST UINT32
*)Prop
)[0]);
179 BusMax
= fdt32_to_cpu (((CONST UINT32
*)Prop
)[1]);
182 // Sanity check: the config space must accommodate all 4K register bytes of
183 // all 8 functions of all 32 devices of all buses.
185 if (BusMax
< BusMin
|| BusMax
- BusMin
== MAX_UINT32
||
186 DivU64x32 (ConfigSize
, SIZE_4KB
* 8 * 32) < BusMax
- BusMin
+ 1) {
187 DEBUG ((EFI_D_ERROR
, "%a: invalid 'bus-range' and/or 'reg'\n",
189 return EFI_PROTOCOL_ERROR
;
193 // Iterate over "ranges".
195 Prop
= fdt_getprop (DeviceTreeBase
, Node
, "ranges", &Len
);
196 if (Prop
== NULL
|| Len
== 0 ||
197 Len
% sizeof (DTB_PCI_HOST_RANGE_RECORD
) != 0) {
198 DEBUG ((EFI_D_ERROR
, "%a: 'ranges' not found or invalid\n", __FUNCTION__
));
199 return EFI_PROTOCOL_ERROR
;
203 // IoBase, IoTranslation, MmioBase and MmioTranslation are initialized only
204 // in order to suppress '-Werror=maybe-uninitialized' warnings *incorrectly*
205 // emitted by some gcc versions.
213 // IoSize and MmioSize are initialized to zero because the logic below
218 for (RecordIdx
= 0; RecordIdx
< Len
/ sizeof (DTB_PCI_HOST_RANGE_RECORD
);
220 CONST DTB_PCI_HOST_RANGE_RECORD
*Record
;
222 Record
= (CONST DTB_PCI_HOST_RANGE_RECORD
*)Prop
+ RecordIdx
;
223 switch (fdt32_to_cpu (Record
->Type
) & DTB_PCI_HOST_RANGE_TYPEMASK
) {
224 case DTB_PCI_HOST_RANGE_IO
:
225 IoBase
= fdt64_to_cpu (Record
->ChildBase
);
226 IoSize
= fdt64_to_cpu (Record
->Size
);
227 IoTranslation
= fdt64_to_cpu (Record
->CpuBase
) - IoBase
;
230 case DTB_PCI_HOST_RANGE_MMIO32
:
231 MmioBase
= fdt64_to_cpu (Record
->ChildBase
);
232 MmioSize
= fdt64_to_cpu (Record
->Size
);
233 MmioTranslation
= fdt64_to_cpu (Record
->CpuBase
) - MmioBase
;
235 if (MmioBase
> MAX_UINT32
|| MmioSize
> MAX_UINT32
||
236 MmioBase
+ MmioSize
> SIZE_4GB
) {
237 DEBUG ((EFI_D_ERROR
, "%a: MMIO32 space invalid\n", __FUNCTION__
));
238 return EFI_PROTOCOL_ERROR
;
241 if (MmioTranslation
!= 0) {
242 DEBUG ((EFI_D_ERROR
, "%a: unsupported nonzero MMIO32 translation "
243 "0x%Lx\n", __FUNCTION__
, MmioTranslation
));
244 return EFI_UNSUPPORTED
;
250 if (IoSize
== 0 || MmioSize
== 0) {
251 DEBUG ((EFI_D_ERROR
, "%a: %a space empty\n", __FUNCTION__
,
252 (IoSize
== 0) ? "IO" : "MMIO32"));
253 return EFI_PROTOCOL_ERROR
;
256 PcdSet64 (PcdPciExpressBaseAddress
, ConfigBase
);
258 PcdSet32 (PcdPciBusMin
, BusMin
);
259 PcdSet32 (PcdPciBusMax
, BusMax
);
261 PcdSet64 (PcdPciIoBase
, IoBase
);
262 PcdSet64 (PcdPciIoSize
, IoSize
);
263 PcdSet64 (PcdPciIoTranslation
, IoTranslation
);
265 PcdSet32 (PcdPciMmio32Base
, (UINT32
)MmioBase
);
266 PcdSet32 (PcdPciMmio32Size
, (UINT32
)MmioSize
);
268 PcdSetBool (PcdPciDisableBusEnumeration
, FALSE
);
270 DEBUG ((EFI_D_INFO
, "%a: Config[0x%Lx+0x%Lx) Bus[0x%x..0x%x] "
271 "Io[0x%Lx+0x%Lx)@0x%Lx Mem[0x%Lx+0x%Lx)@0x%Lx\n", __FUNCTION__
, ConfigBase
,
272 ConfigSize
, BusMin
, BusMax
, IoBase
, IoSize
, IoTranslation
, MmioBase
,
273 MmioSize
, MmioTranslation
));
280 InitializeVirtFdtDxe (
281 IN EFI_HANDLE ImageHandle
,
282 IN EFI_SYSTEM_TABLE
*SystemTable
286 VOID
*DeviceTreeBase
;
292 PROPERTY_TYPE PropType
;
294 VIRTIO_TRANSPORT_DEVICE_PATH
*DevicePath
;
297 UINT64 DistBase
, CpuBase
, RedistBase
;
298 CONST INTERRUPT_PROPERTY
*InterruptProp
;
299 INT32 SecIntrNum
, IntrNum
, VirtIntrNum
, HypIntrNum
;
300 CONST CHAR8
*PsciMethod
;
301 UINT64 FwCfgSelectorAddress
;
302 UINT64 FwCfgSelectorSize
;
303 UINT64 FwCfgDataAddress
;
304 UINT64 FwCfgDataSize
;
305 UINT64 FwCfgDmaAddress
;
309 Hob
= GetFirstGuidHob(&gFdtHobGuid
);
310 if (Hob
== NULL
|| GET_GUID_HOB_DATA_SIZE (Hob
) != sizeof (UINT64
)) {
311 return EFI_NOT_FOUND
;
313 DeviceTreeBase
= (VOID
*)(UINTN
)*(UINT64
*)GET_GUID_HOB_DATA (Hob
);
315 if (fdt_check_header (DeviceTreeBase
) != 0) {
316 DEBUG ((EFI_D_ERROR
, "%a: No DTB found @ 0x%p\n", __FUNCTION__
, DeviceTreeBase
));
317 return EFI_NOT_FOUND
;
320 Status
= gBS
->InstallConfigurationTable (&gFdtTableGuid
, DeviceTreeBase
);
321 ASSERT_EFI_ERROR (Status
);
323 DEBUG ((EFI_D_INFO
, "%a: DTB @ 0x%p\n", __FUNCTION__
, DeviceTreeBase
));
328 // Now enumerate the nodes and install peripherals that we are interested in,
329 // i.e., GIC, RTC and virtio MMIO nodes
331 for (Prev
= 0;; Prev
= Node
) {
332 Node
= fdt_next_node (DeviceTreeBase
, Prev
, NULL
);
337 Type
= fdt_getprop (DeviceTreeBase
, Node
, "compatible", &Len
);
342 PropType
= GetTypeFromNode (Type
, Len
);
343 if (PropType
== PropertyTypeUnknown
) {
348 // Get the 'reg' property of this node. For now, we will assume
349 // 8 byte quantities for base and size, respectively.
350 // TODO use #cells root properties instead
352 RegProp
= fdt_getprop (DeviceTreeBase
, Node
, "reg", &Len
);
353 ASSERT ((RegProp
!= NULL
) || (PropType
== PropertyTypeTimer
) ||
354 (PropType
== PropertyTypePsci
));
357 case PropertyTypePciHost
:
358 ASSERT (Len
== 2 * sizeof (UINT64
));
359 Status
= ProcessPciHost (DeviceTreeBase
, Node
, RegProp
);
360 ASSERT_EFI_ERROR (Status
);
364 case PropertyTypeFwCfg
:
365 ASSERT (Len
== 2 * sizeof (UINT64
));
367 FwCfgDataAddress
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
369 FwCfgSelectorAddress
= FwCfgDataAddress
+ FwCfgDataSize
;
370 FwCfgSelectorSize
= 2;
373 // The following ASSERT()s express
375 // Address + Size - 1 <= MAX_UINTN
377 // for both registers, that is, that the last byte in each MMIO range is
378 // expressible as a MAX_UINTN. The form below is mathematically
379 // equivalent, and it also prevents any unsigned overflow before the
382 ASSERT (FwCfgSelectorAddress
<= MAX_UINTN
- FwCfgSelectorSize
+ 1);
383 ASSERT (FwCfgDataAddress
<= MAX_UINTN
- FwCfgDataSize
+ 1);
385 PcdSet64 (PcdFwCfgSelectorAddress
, FwCfgSelectorAddress
);
386 PcdSet64 (PcdFwCfgDataAddress
, FwCfgDataAddress
);
388 DEBUG ((EFI_D_INFO
, "Found FwCfg @ 0x%Lx/0x%Lx\n", FwCfgSelectorAddress
,
391 if (fdt64_to_cpu (((UINT64
*)RegProp
)[1]) >= 0x18) {
392 FwCfgDmaAddress
= FwCfgDataAddress
+ 0x10;
396 // See explanation above.
398 ASSERT (FwCfgDmaAddress
<= MAX_UINTN
- FwCfgDmaSize
+ 1);
400 PcdSet64 (PcdFwCfgDmaAddress
, FwCfgDmaAddress
);
401 DEBUG ((EFI_D_INFO
, "Found FwCfg DMA @ 0x%Lx\n", FwCfgDmaAddress
));
405 case PropertyTypeVirtio
:
408 // Create a unique device path for this transport on the fly
410 RegBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
411 DevicePath
= (VIRTIO_TRANSPORT_DEVICE_PATH
*)CreateDeviceNode (
412 HARDWARE_DEVICE_PATH
,
414 sizeof (VIRTIO_TRANSPORT_DEVICE_PATH
));
415 if (DevicePath
== NULL
) {
416 DEBUG ((EFI_D_ERROR
, "%a: Out of memory\n", __FUNCTION__
));
420 CopyMem (&DevicePath
->Vendor
.Guid
, &gVirtioMmioTransportGuid
,
422 DevicePath
->PhysBase
= RegBase
;
423 SetDevicePathNodeLength (&DevicePath
->Vendor
,
424 sizeof (*DevicePath
) - sizeof (DevicePath
->End
));
425 SetDevicePathEndNode (&DevicePath
->End
);
428 Status
= gBS
->InstallProtocolInterface (&Handle
,
429 &gEfiDevicePathProtocolGuid
, EFI_NATIVE_INTERFACE
,
431 if (EFI_ERROR (Status
)) {
432 DEBUG ((EFI_D_ERROR
, "%a: Failed to install the EFI_DEVICE_PATH "
433 "protocol on a new handle (Status == %r)\n",
434 __FUNCTION__
, Status
));
435 FreePool (DevicePath
);
439 Status
= VirtioMmioInstallDevice (RegBase
, Handle
);
440 if (EFI_ERROR (Status
)) {
441 DEBUG ((EFI_D_ERROR
, "%a: Failed to install VirtIO transport @ 0x%Lx "
442 "on handle %p (Status == %r)\n", __FUNCTION__
, RegBase
,
445 Status
= gBS
->UninstallProtocolInterface (Handle
,
446 &gEfiDevicePathProtocolGuid
, DevicePath
);
447 ASSERT_EFI_ERROR (Status
);
448 FreePool (DevicePath
);
452 case PropertyTypeGic
:
455 DistBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
456 CpuBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[2]);
457 ASSERT (DistBase
< MAX_UINT32
);
458 ASSERT (CpuBase
< MAX_UINT32
);
460 PcdSet32 (PcdGicDistributorBase
, (UINT32
)DistBase
);
461 PcdSet32 (PcdGicInterruptInterfaceBase
, (UINT32
)CpuBase
);
462 PcdSet32 (PcdArmGicRevision
, 2);
464 DEBUG ((EFI_D_INFO
, "Found GIC @ 0x%Lx/0x%Lx\n", DistBase
, CpuBase
));
467 case PropertyTypeGicV3
:
469 // The GIC v3 DT binding describes a series of at least 3 physical (base
470 // addresses, size) pairs: the distributor interface (GICD), at least one
471 // redistributor region (GICR) containing dedicated redistributor
472 // interfaces for all individual CPUs, and the CPU interface (GICC).
473 // Under virtualization, we assume that the first redistributor region
474 // listed covers the boot CPU. Also, our GICv3 driver only supports the
475 // system register CPU interface, so we can safely ignore the MMIO version
476 // which is listed after the sequence of redistributor interfaces.
477 // This means we are only interested in the first two memory regions
478 // supplied, and ignore everything else.
482 // RegProp[0..1] == { GICD base, GICD size }
483 DistBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
484 ASSERT (DistBase
< MAX_UINT32
);
486 // RegProp[2..3] == { GICR base, GICR size }
487 RedistBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[2]);
488 ASSERT (RedistBase
< MAX_UINT32
);
490 PcdSet32 (PcdGicDistributorBase
, (UINT32
)DistBase
);
491 PcdSet32 (PcdGicRedistributorsBase
, (UINT32
)RedistBase
);
492 PcdSet32 (PcdArmGicRevision
, 3);
494 DEBUG ((EFI_D_INFO
, "Found GIC v3 (re)distributor @ 0x%Lx (0x%Lx)\n",
495 DistBase
, RedistBase
));
498 case PropertyTypeRtc
:
501 RegBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
502 ASSERT (RegBase
< MAX_UINT32
);
504 PcdSet32 (PcdPL031RtcBase
, (UINT32
)RegBase
);
506 DEBUG ((EFI_D_INFO
, "Found PL031 RTC @ 0x%Lx\n", RegBase
));
510 case PropertyTypeTimer
:
512 // - interrupts : Interrupt list for secure, non-secure, virtual and
513 // hypervisor timers, in that order.
515 InterruptProp
= fdt_getprop (DeviceTreeBase
, Node
, "interrupts", &Len
);
516 ASSERT (Len
== 36 || Len
== 48);
518 SecIntrNum
= fdt32_to_cpu (InterruptProp
[0].Number
)
519 + (InterruptProp
[0].Type
? 16 : 0);
520 IntrNum
= fdt32_to_cpu (InterruptProp
[1].Number
)
521 + (InterruptProp
[1].Type
? 16 : 0);
522 VirtIntrNum
= fdt32_to_cpu (InterruptProp
[2].Number
)
523 + (InterruptProp
[2].Type
? 16 : 0);
524 HypIntrNum
= Len
< 48 ? 0 : fdt32_to_cpu (InterruptProp
[3].Number
)
525 + (InterruptProp
[3].Type
? 16 : 0);
527 DEBUG ((EFI_D_INFO
, "Found Timer interrupts %d, %d, %d, %d\n",
528 SecIntrNum
, IntrNum
, VirtIntrNum
, HypIntrNum
));
530 PcdSet32 (PcdArmArchTimerSecIntrNum
, SecIntrNum
);
531 PcdSet32 (PcdArmArchTimerIntrNum
, IntrNum
);
532 PcdSet32 (PcdArmArchTimerVirtIntrNum
, VirtIntrNum
);
533 PcdSet32 (PcdArmArchTimerHypIntrNum
, HypIntrNum
);
536 case PropertyTypePsci
:
537 PsciMethod
= fdt_getprop (DeviceTreeBase
, Node
, "method", &Len
);
539 if (PsciMethod
&& AsciiStrnCmp (PsciMethod
, "hvc", 3) == 0) {
540 PcdSet32 (PcdArmPsciMethod
, 1);
541 } else if (PsciMethod
&& AsciiStrnCmp (PsciMethod
, "smc", 3) == 0) {
542 PcdSet32 (PcdArmPsciMethod
, 2);
544 DEBUG ((EFI_D_ERROR
, "%a: Unknown PSCI method \"%a\"\n", __FUNCTION__
,
549 case PropertyTypeXen
:
553 // Retrieve the reg base from this node and wire it up to the
554 // MMIO flavor of the XenBus root device I/O protocol
556 RegBase
= fdt64_to_cpu (((UINT64
*)RegProp
)[0]);
558 Status
= XenIoMmioInstall (&Handle
, RegBase
);
559 if (EFI_ERROR (Status
)) {
560 DEBUG ((EFI_D_ERROR
, "%a: XenIoMmioInstall () failed on a new handle "
561 "(Status == %r)\n", __FUNCTION__
, Status
));
565 DEBUG ((EFI_D_INFO
, "Found Xen node with Grant table @ 0x%Lx\n", RegBase
));
575 // UEFI takes ownership of the RTC hardware, and exposes its functionality
576 // through the UEFI Runtime Services GetTime, SetTime, etc. This means we
577 // need to disable it in the device tree to prevent the OS from attaching its
578 // device driver as well.
580 if ((RtcNode
!= -1) &&
581 fdt_setprop_string (DeviceTreeBase
, RtcNode
, "status",
583 DEBUG ((EFI_D_WARN
, "Failed to set PL031 status to 'disabled'\n"));
588 // Set the /chosen/linux,pci-probe-only property to 1, so that the PCI
589 // setup we will perform in the firmware is honored by the Linux OS,
590 // rather than torn down and done from scratch. This is generally a more
591 // sensible approach, and aligns with what ACPI based OSes do in general.
593 // In case we are exposing an emulated VGA PCI device to the guest, which
594 // may subsequently get exposed via the Graphics Output protocol and
595 // driven as an efifb by Linux, we need this setting to prevent the
596 // framebuffer from becoming unresponsive.
598 Node
= fdt_path_offset (DeviceTreeBase
, "/chosen");
600 Node
= fdt_add_subnode (DeviceTreeBase
, 0, "/chosen");
603 fdt_setprop_u32 (DeviceTreeBase
, Node
, "linux,pci-probe-only", 1) < 0) {
604 DEBUG ((EFI_D_WARN
, "Failed to set /chosen/linux,pci-probe-only property\n"));