Documentation/devicetree/bindings/remoteproc/stm32-rproc.txt

   1 STMicroelectronics STM32 Remoteproc
   2 -----------------------------------
   3 This document defines the binding for the remoteproc component that loads and
   4 boots firmwares on the ST32MP family chipset.
   5
   6 Required properties:
   7 - compatible:   Must be "st,stm32mp1-m4"
   8 - reg:          Address ranges of the RETRAM and MCU SRAM memories used by the
   9                 remote processor.
  10 - resets:       Reference to a reset controller asserting the remote processor.
  11 - st,syscfg-holdboot: Reference to the system configuration which holds the
  12                 remote processor reset hold boot
  13         1st cell: phandle of syscon block
  14         2nd cell: register offset containing the hold boot setting
  15         3rd cell: register bitmask for the hold boot field
  16 - st,syscfg-tz: Reference to the system configuration which holds the RCC trust
  17                 zone mode
  18         1st cell: phandle to syscon block
  19         2nd cell: register offset containing the RCC trust zone mode setting
  20         3rd cell: register bitmask for the RCC trust zone mode bit
  21
  22 Optional properties:
  23 - interrupts:   Should contain the watchdog interrupt
  24 - mboxes:       This property is required only if the rpmsg/virtio functionality
  25                 is used. List of phandle and mailbox channel specifiers:
  26                 - a channel (a) used to communicate through virtqueues with the
  27                   remote proc.
  28                   Bi-directional channel:
  29                       - from local to remote = send message
  30                       - from remote to local = send message ack
  31                 - a channel (b) working the opposite direction of channel (a)
  32                 - a channel (c) used by the local proc to notify the remote proc
  33                   that it is about to be shut down.
  34                   Unidirectional channel:
  35                       - from local to remote, where ACK from the remote means
  36                         that it is ready for shutdown
  37 - mbox-names:   This property is required if the mboxes property is used.
  38                 - must be "vq0" for channel (a)
  39                 - must be "vq1" for channel (b)
  40                 - must be "shutdown" for channel (c)
  41 - memory-region: List of phandles to the reserved memory regions associated with
  42                 the remoteproc device. This is variable and describes the
  43                 memories shared with the remote processor (eg: remoteproc
  44                 firmware and carveouts, rpmsg vrings, ...).
  45                 (see ../reserved-memory/reserved-memory.txt)
  46 - st,syscfg-pdds: Reference to the system configuration which holds the remote
  47                 processor deep sleep setting
  48         1st cell: phandle to syscon block
  49         2nd cell: register offset containing the deep sleep setting
  50         3rd cell: register bitmask for the deep sleep bit
  51 - st,auto-boot: If defined, when remoteproc is probed, it loads the default
  52                 firmware and starts the remote processor.
  53
  54 Example:
  55         m4_rproc: m4@10000000 {
  56                 compatible = "st,stm32mp1-m4";
  57                 reg = <0x10000000 0x40000>,
  58                       <0x30000000 0x40000>,
  59                       <0x38000000 0x10000>;
  60                 resets = <&rcc MCU_R>;
  61                 st,syscfg-holdboot = <&rcc 0x10C 0x1>;
  62                 st,syscfg-tz = <&rcc 0x000 0x1>;
  63         };