Add device tree binding documentation for Texas Instruments RPMsg Ethernet
channels. This binding describes the shared memory communication interface
between host processor and a remote processor for Ethernet packet exchange.
The binding defines the required 'memory-region' property that references
the dedicated shared memory area used for exchanging Ethernet packets
between processors.
Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
---
.../devicetree/bindings/net/ti,rpmsg-eth.yaml | 38 +++++++++++++++++++
1 file changed, 38 insertions(+)
create mode 100644 Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml
diff --git a/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml b/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml
new file mode 100644
index 000000000000..1c86d5c020b0
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml
@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/ti,rpmsg-eth.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments RPMsg channel nodes for Ethernet communication
+
+description: |
+ RPMsg Ethernet subnode represents the communication interface between host
+ processor and a remote processor.
+
+maintainers:
+ - MD Danish Anwar <danishanwar@ti.com>
+
+properties:
+ memory-region:
+ $ref: /schemas/types.yaml#/definitions/phandle
+ description: |
+ Phandle to the shared memory region used for communication between the
+ host processor and the remote processor.
+ This shared memory region is used to exchange Ethernet packets.
+
+required:
+ - memory-region
+
+additionalProperties: false
+
+examples:
+ - |
+ main_r5fss0_core0 {
+ mboxes = <&mailbox0_cluster2 &mbox_main_r5fss0_core0>;
+ memory-region = <&main_r5fss0_core0_dma_memory_region>,
+ <&main_r5fss0_core0_memory_region>;
+ rpmsg-eth {
+ memory-region = <&main_r5fss0_core0_memory_region_shm>;
+ };
+ };
--
2.34.1On Tue, Sep 02, 2025 at 02:37:39PM +0530, MD Danish Anwar wrote: > Add device tree binding documentation for Texas Instruments RPMsg Ethernet > channels. This binding describes the shared memory communication interface > between host processor and a remote processor for Ethernet packet exchange. > > The binding defines the required 'memory-region' property that references Describe the hardware, not "this binding". A nit, subject: drop second/last, redundant "DT binding". The "dt-bindings" prefix is already stating that these are bindings. See also: https://elixir.bootlin.com/linux/v6.17-rc3/source/Documentation/devicetree/bindings/submitting-patches.rst#L18 Best regards, Krzysztof
On Tue, Sep 02, 2025 at 02:37:39PM +0530, MD Danish Anwar wrote:
> Add device tree binding documentation for Texas Instruments RPMsg Ethernet
> channels. This binding describes the shared memory communication interface
> between host processor and a remote processor for Ethernet packet exchange.
>
> The binding defines the required 'memory-region' property that references
> the dedicated shared memory area used for exchanging Ethernet packets
> between processors.
>
> Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
> ---
> .../devicetree/bindings/net/ti,rpmsg-eth.yaml | 38 +++++++++++++++++++
> 1 file changed, 38 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml
>
> diff --git a/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml b/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml
> new file mode 100644
> index 000000000000..1c86d5c020b0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/ti,rpmsg-eth.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments RPMsg channel nodes for Ethernet communication
> +
> +description: |
> + RPMsg Ethernet subnode represents the communication interface between host
> + processor and a remote processor.
> +
> +maintainers:
> + - MD Danish Anwar <danishanwar@ti.com>
> +
> +properties:
> + memory-region:
> + $ref: /schemas/types.yaml#/definitions/phandle
> + description: |
> + Phandle to the shared memory region used for communication between the
> + host processor and the remote processor.
> + This shared memory region is used to exchange Ethernet packets.
> +
> +required:
> + - memory-region
> +
> +additionalProperties: false
This cannot be really tested and is pointless binding... Really, one
property does not make it a device node.
> +
> +examples:
> + - |
> + main_r5fss0_core0 {
> + mboxes = <&mailbox0_cluster2 &mbox_main_r5fss0_core0>;
> + memory-region = <&main_r5fss0_core0_dma_memory_region>,
> + <&main_r5fss0_core0_memory_region>;
All this is irrelevant, drop.
> + rpmsg-eth {
> + memory-region = <&main_r5fss0_core0_memory_region_shm>;
> + };
> + };
> --
> 2.34.1
>
Hi Krzysztof, On 03/09/25 12:48 pm, Krzysztof Kozlowski wrote: > On Tue, Sep 02, 2025 at 02:37:39PM +0530, MD Danish Anwar wrote: >> Add device tree binding documentation for Texas Instruments RPMsg Ethernet >> channels. This binding describes the shared memory communication interface >> between host processor and a remote processor for Ethernet packet exchange. >> >> The binding defines the required 'memory-region' property that references >> the dedicated shared memory area used for exchanging Ethernet packets >> between processors. >> >> Signed-off-by: MD Danish Anwar <danishanwar@ti.com> >> --- >> .../devicetree/bindings/net/ti,rpmsg-eth.yaml | 38 +++++++++++++++++++ >> 1 file changed, 38 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml >> >> diff --git a/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml b/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml >> new file mode 100644 >> index 000000000000..1c86d5c020b0 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/net/ti,rpmsg-eth.yaml >> @@ -0,0 +1,38 @@ >> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause >> +%YAML 1.2 >> +--- >> +$id: http://devicetree.org/schemas/net/ti,rpmsg-eth.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: Texas Instruments RPMsg channel nodes for Ethernet communication >> + >> +description: | >> + RPMsg Ethernet subnode represents the communication interface between host >> + processor and a remote processor. >> + >> +maintainers: >> + - MD Danish Anwar <danishanwar@ti.com> >> + >> +properties: >> + memory-region: >> + $ref: /schemas/types.yaml#/definitions/phandle >> + description: | >> + Phandle to the shared memory region used for communication between the >> + host processor and the remote processor. >> + This shared memory region is used to exchange Ethernet packets. >> + >> +required: >> + - memory-region >> + >> +additionalProperties: false > > This cannot be really tested and is pointless binding... Really, one > property does not make it a device node. > > I tried to do something similar to google,cros-ec.yaml and qcom,glink-edge.yaml They are also rpmsg related and used by other vendors. I created similar to that as my use case seems similar to them. The only difference being I only need one property. -- Thanks and Regards, Danish
© 2016 - 2025 Red Hat, Inc.