Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
Extension
.yaml
Size
5641 bytes
Lines
198
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Xilinx firmware driver

maintainers:
  - Nava kishore Manne <nava.kishore.manne@amd.com>

description: The zynqmp-firmware node describes the interface to platform
  firmware. ZynqMP has an interface to communicate with secure firmware.
  Firmware driver provides an interface to firmware APIs. Interface APIs
  can be used by any driver to communicate to PMUFW(Platform Management Unit).
  These requests include clock management, pin control, device control,
  power management service, FPGA service and other platform management
  services.

properties:
  compatible:
    oneOf:
      - description: For implementations complying for Zynq Ultrascale+ MPSoC.
        const: xlnx,zynqmp-firmware

      - description: For implementations complying for Versal.
        const: xlnx,versal-firmware

      - description: For implementations complying for Versal NET.
        items:
          - enum:
              - xlnx,versal-net-firmware
          - const: xlnx,versal-firmware

  method:
    description: |
                 The method of calling the PM-API firmware layer.
                 Permitted values are.
                 - "smc" : SMC #0, following the SMCCC
                 - "hvc" : HVC #0, following the SMCCC

    $ref: /schemas/types.yaml#/definitions/string-array
    enum:
      - smc
      - hvc

  "#power-domain-cells":
    const: 1

  clock-controller:
    $ref: /schemas/clock/xlnx,versal-clk.yaml#
    description: The clock controller is a hardware block of Xilinx versal
      clock tree. It reads required input clock frequencies from the devicetree
      and acts as clock provider for all clock consumers of PS clocks.list of
      clock specifiers which are external input clocks to the given clock
      controller.
    type: object

  gpio:
    $ref: /schemas/gpio/xlnx,zynqmp-gpio-modepin.yaml#
    description: The gpio node describes connect to PS_MODE pins via firmware
      interface.
    type: object

  soc-nvmem:
    $ref: /schemas/nvmem/xlnx,zynqmp-nvmem.yaml#
    description: The ZynqMP MPSoC provides access to the hardware related data
      like SOC revision, IDCODE and specific purpose efuses.
    type: object

Annotation

Implementation Notes