%YAML 1.2
---
$id: "http://devicetree.org/schemas/net/qrtr-genpool.yaml#"
$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: QRTR Genpool FIFO Transport Configuration

maintainers:
  - Tony Truong <truong@quicinc.com>

description: |
  Configuration properties for the QRTR Genpool FIFO Transport. This
  configuration is to instantiate a transport for IPC Router protocol
  communication between Virtual Machine and Digital Signal Processor subsystem.

properties:
  compatible:
    const: qcom,qrtr-genpool

  gen-pool:
    $ref: /schemas/types.yaml#/definitions/phandle
    maxItems: 1
    description:
      Phandle reference to a client which has a dedicated memory region for
      sharing between Virtual Machine and Digital Signal Processor subsystem.

  genpool-poll:
    $ref: /schemas/types.yaml#/definitions/flag
    description:
      If set, enables polling mode for RX.

  genpool-poll-sleep:
    $ref: /schemas/types.yaml#/definitions/uint32
    maxItems: 1
    description:
      Sleep (ms) between each poll. If not set, the default interval is 100ms.

required:
  -compatible
  -gen-pool

examples:
  - |
    qrtr-genpool {
        compatible = "qcom,qrtr-genpool";
        gen-pool = <&fastrpc_compute_cb1>;
        genpool-poll;
        genpool-poll-sleep = <1000>;
    };
