The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/contrib/device-tree/Bindings/pci/pci.txt

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 PCI bus bridges have standardized Device Tree bindings:
    2 
    3 PCI Bus Binding to: IEEE Std 1275-1994
    4 https://www.devicetree.org/open-firmware/bindings/pci/pci2_1.pdf
    5 
    6 And for the interrupt mapping part:
    7 
    8 Open Firmware Recommended Practice: Interrupt Mapping
    9 https://www.devicetree.org/open-firmware/practice/imap/imap0_9d.pdf
   10 
   11 Additionally to the properties specified in the above standards a host bridge
   12 driver implementation may support the following properties:
   13 
   14 - linux,pci-domain:
   15    If present this property assigns a fixed PCI domain number to a host bridge,
   16    otherwise an unstable (across boots) unique number will be assigned.
   17    It is required to either not set this property at all or set it for all
   18    host bridges in the system, otherwise potentially conflicting domain numbers
   19    may be assigned to root buses behind different host bridges.  The domain
   20    number for each host bridge in the system must be unique.
   21 - max-link-speed:
   22    If present this property specifies PCI gen for link capability.  Host
   23    drivers could add this as a strategy to avoid unnecessary operation for
   24    unsupported link speed, for instance, trying to do training for
   25    unsupported link speed, etc.  Must be '4' for gen4, '3' for gen3, '2'
   26    for gen2, and '1' for gen1. Any other values are invalid.
   27 - reset-gpios:
   28    If present this property specifies PERST# GPIO. Host drivers can parse the
   29    GPIO and apply fundamental reset to endpoints.
   30 - supports-clkreq:
   31    If present this property specifies that CLKREQ signal routing exists from
   32    root port to downstream device and host bridge drivers can do programming
   33    which depends on CLKREQ signal existence. For example, programming root port
   34    not to advertise ASPM L1 Sub-States support if there is no CLKREQ signal.
   35 
   36 PCI-PCI Bridge properties
   37 -------------------------
   38 
   39 PCIe root ports and switch ports may be described explicitly in the device
   40 tree, as children of the host bridge node. Even though those devices are
   41 discoverable by probing, it might be necessary to describe properties that
   42 aren't provided by standard PCIe capabilities.
   43 
   44 Required properties:
   45 
   46 - reg:
   47    Identifies the PCI-PCI bridge. As defined in the IEEE Std 1275-1994
   48    document, it is a five-cell address encoded as (phys.hi phys.mid
   49    phys.lo size.hi size.lo). phys.hi should contain the device's BDF as
   50    0b00000000 bbbbbbbb dddddfff 00000000. The other cells should be zero.
   51 
   52    The bus number is defined by firmware, through the standard bridge
   53    configuration mechanism. If this port is a switch port, then firmware
   54    allocates the bus number and writes it into the Secondary Bus Number
   55    register of the bridge directly above this port. Otherwise, the bus
   56    number of a root port is the first number in the bus-range property,
   57    defaulting to zero.
   58 
   59    If firmware leaves the ARI Forwarding Enable bit set in the bridge
   60    above this port, then phys.hi contains the 8-bit function number as
   61    0b00000000 bbbbbbbb ffffffff 00000000. Note that the PCIe specification
   62    recommends that firmware only leaves ARI enabled when it knows that the
   63    OS is ARI-aware.
   64 
   65 Optional properties:
   66 
   67 - external-facing:
   68    When present, the port is external-facing. All bridges and endpoints
   69    downstream of this port are external to the machine. The OS can, for
   70    example, use this information to identify devices that cannot be
   71    trusted with relaxed DMA protection, as users could easily attach
   72    malicious devices to this port.
   73 
   74 Example:
   75 
   76 pcie@10000000 {
   77         compatible = "pci-host-ecam-generic";
   78         ...
   79         pcie@0008 {
   80                 /* Root port 00:01.0 is external-facing */
   81                 reg = <0x00000800 0 0 0 0>;
   82                 external-facing;
   83         };
   84 };

Cache object: e47c3ef10d23eb79a5153dcb4ac241fe


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.