xref: /linux/Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,qe-firmware.yaml (revision c532de5a67a70f8533d495f8f2aaa9a0491c3ad0)
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/soc/fsl/cpm_qe/fsl,qe-firmware.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Freescale QUICC Engine module Firmware Node
8
9maintainers:
10  - Frank Li <Frank.Li@nxp.com>
11
12description: |
13  This node defines a firmware binary that is embedded in the device tree, for
14  the purpose of passing the firmware from bootloader to the kernel, or from
15  the hypervisor to the guest.
16
17  The firmware node itself contains the firmware binary contents, a compatible
18  property, and any firmware-specific properties.  The node should be placed
19  inside a QE node that needs it.  Doing so eliminates the need for a
20  fsl,firmware-phandle property.  Other QE nodes that need the same firmware
21  should define an fsl,firmware-phandle property that points to the firmware node
22  in the first QE node.
23
24  The fsl,firmware property can be specified in the DTS (possibly using incbin)
25  or can be inserted by the boot loader at boot time.
26
27properties:
28  compatible:
29    enum:
30      - fsl,qe-firmware
31
32  fsl,firmware:
33    $ref: /schemas/types.yaml#/definitions/uint8-array
34    description:
35      A standard property.  This property contains the firmware binary "blob".
36
37required:
38  - compatible
39  - fsl,firmware
40
41additionalProperties: false
42
43examples:
44  - |
45    qe-firmware {
46        compatible = "fsl,qe-firmware";
47        fsl,firmware = <0x70 0xcd 0x00 0x00 0x01 0x46 0x45>;
48    };
49