Documentation/devicetree/bindings/remoteproc/st,stm32-rproc.yaml

   1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: "http://devicetree.org/schemas/remoteproc/st,stm32-rproc.yaml#"
   5 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
   6
   7 title: STMicroelectronics STM32 remote processor controller bindings
   8
   9 description:
  10   This document defines the binding for the remoteproc component that loads and
  11   boots firmwares on the ST32MP family chipset.
  12
  13 maintainers:
  14   - Fabien Dessenne <fabien.dessenne@st.com>
  15   - Arnaud Pouliquen <arnaud.pouliquen@st.com>
  16
  17 properties:
  18   compatible:
  19     const: st,stm32mp1-m4
  20
  21   reg:
  22     description:
  23       Address ranges of the RETRAM and MCU SRAM memories used by the remote
  24       processor.
  25     maxItems: 3
  26
  27   resets:
  28     maxItems: 1
  29
  30   st,syscfg-holdboot:
  31     description: remote processor reset hold boot
  32       - Phandle of syscon block.
  33       - The offset of the hold boot setting register.
  34       - The field mask of the hold boot.
  35     $ref: "/schemas/types.yaml#/definitions/phandle-array"
  36     maxItems: 1
  37
  38   st,syscfg-tz:
  39     description:
  40       Reference to the system configuration which holds the RCC trust zone mode
  41       - Phandle of syscon block.
  42       - The offset of the RCC trust zone mode register.
  43       - The field mask of the RCC trust zone mode.
  44     $ref: "/schemas/types.yaml#/definitions/phandle-array"
  45     maxItems: 1
  46
  47   interrupts:
  48     description: Should contain the WWDG1 watchdog reset interrupt
  49     maxItems: 1
  50
  51   wakeup-source: true
  52
  53   mboxes:
  54     description:
  55       This property is required only if the rpmsg/virtio functionality is used.
  56     items:
  57       - description: |
  58           A channel (a) used to communicate through virtqueues with the
  59           remote proc.
  60           Bi-directional channel:
  61             - from local to remote = send message
  62             - from remote to local = send message ack
  63       - description: |
  64           A channel (b) working the opposite direction of channel (a)
  65       - description: |
  66           A channel (c) used by the local proc to notify the remote proc that it
  67           is about to be shut down.
  68           Unidirectional channel:
  69             - from local to remote, where ACK from the remote means that it is
  70               ready for shutdown
  71     minItems: 1
  72     maxItems: 3
  73
  74   mbox-names:
  75     items:
  76       - const: vq0
  77       - const: vq1
  78       - const: shutdown
  79     minItems: 1
  80     maxItems: 3
  81
  82   memory-region:
  83     description:
  84       List of phandles to the reserved memory regions associated with the
  85       remoteproc device. This is variable and describes the memories shared with
  86       the remote processor (e.g. remoteproc firmware and carveouts, rpmsg
  87       vrings, ...).
  88       (see ../reserved-memory/reserved-memory.txt)
  89
  90   st,syscfg-pdds:
  91     $ref: "/schemas/types.yaml#/definitions/phandle-array"
  92     description: |
  93       Reference to the system configuration which holds the remote
  94         1st cell: phandle to syscon block
  95         2nd cell: register offset containing the deep sleep setting
  96         3rd cell: register bitmask for the deep sleep bit
  97     maxItems: 1
  98
  99   st,auto-boot:
 100     $ref: /schemas/types.yaml#/definitions/flag
 101     description:
 102       If defined, when remoteproc is probed, it loads the default firmware and
 103       starts the remote processor.
 104
 105 required:
 106   - compatible
 107   - reg
 108   - resets
 109   - st,syscfg-holdboot
 110   - st,syscfg-tz
 111
 112 additionalProperties: false
 113
 114 examples:
 115   - |
 116     #include <dt-bindings/reset/stm32mp1-resets.h>
 117     m4_rproc: m4@10000000 {
 118       compatible = "st,stm32mp1-m4";
 119       reg = <0x10000000 0x40000>,
 120             <0x30000000 0x40000>,
 121             <0x38000000 0x10000>;
 122       resets = <&rcc MCU_R>;
 123       st,syscfg-holdboot = <&rcc 0x10C 0x1>;
 124       st,syscfg-tz = <&rcc 0x000 0x1>;
 125     };
 126
 127 ...