[PATCH] dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file

[PATCH] dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file

[Douglas Anderson]

As per mailing-list discussions [1] [2] [3], we want to delete the
following old file from the device-tree bindings that live in the
Linux kernel git tree:
* Documentation/devicetree/bindings/mailbox/mailbox.txt

The old .txt file did have some descriptive text about what some of
the properties meant. Those have been added to the dt-schema
repository in a pull request [4].

Link: https://lore.kernel.org/r/20260722140214.GA548057-robh@kernel.org [1]
Link: https://lore.kernel.org/r/dc7a2041-50a4-482e-9930-566bb3fd1e72@kernel.org [2]
Link: https://lore.kernel.org/r/CAL_JsqKVjQ2m-dzMUENQry-f_YE9QrYSOKoH9CPj1gjj8XkPRA@mail.gmail.com [3]
Link: https://github.com/devicetree-org/dt-schema/pull/202 [4]
Cc: Sudeep Holla <sudeep.holla@kernel.org>
Cc: Jassi Brar <jassisinghbrar@gmail.com>
Cc: Lee Jones <lee@kernel.org>
Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 .../devicetree/bindings/mailbox/mailbox.txt   | 60 -------------------
 1 file changed, 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/mailbox/mailbox.txt

diff --git a/Documentation/devicetree/bindings/mailbox/mailbox.txt b/Documentation/devicetree/bindings/mailbox/mailbox.txt
deleted file mode 100644
index af8ecee2ac68..000000000000
--- a/Documentation/devicetree/bindings/mailbox/mailbox.txt
+++ /dev/null
@@ -1,60 +0,0 @@
-* Generic Mailbox Controller and client driver bindings
-
-Generic binding to provide a way for Mailbox controller drivers to
-assign appropriate mailbox channel to client drivers.
-
-* Mailbox Controller
-
-Required property:
-- #mbox-cells: Must be at least 1. Number of cells in a mailbox
-		specifier.
-
-Example:
-	mailbox: mailbox {
-		...
-		#mbox-cells = <1>;
-	};
-
-
-* Mailbox Client
-
-Required property:
-- mboxes: List of phandle and mailbox channel specifiers.
-
-Optional property:
-- mbox-names: List of identifier strings for each mailbox channel.
-- shmem : List of phandle pointing to the shared memory(SHM) area between the
-	  users of these mailboxes for IPC, one for each mailbox. This shared
-	  memory can be part of any memory reserved for the purpose of this
-	  communication between the mailbox client and the remote.
-
-
-Example:
-	pwr_cntrl: power {
-		...
-		mbox-names = "pwr-ctrl", "rpc";
-		mboxes = <&mailbox 0 &mailbox 1>;
-	};
-
-Example with shared memory(shmem):
-
-	sram: sram@50000000 {
-		compatible = "mmio-sram";
-		reg = <0x50000000 0x10000>;
-
-		#address-cells = <1>;
-		#size-cells = <1>;
-		ranges = <0 0x50000000 0x10000>;
-
-		cl_shmem: shmem@0 {
-			compatible = "client-shmem";
-			reg = <0x0 0x200>;
-		};
-	};
-
-	client@2e000000 {
-		...
-		mboxes = <&mailbox 0>;
-		shmem = <&cl_shmem>;
-		..
-	};
-- 
2.55.0.571.g244d577d93-goog

Re: [PATCH] dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file

[sashiko-bot]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] Deleting `mailbox.txt` without updating references to it in other binding files leaves dangling, broken documentation references.
--

--- Patch [1]: [PATCH] dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file ---
commit 1b70b3f250d6bcf306aca223e0e91c9fb8a20cc2
Author: Douglas Anderson <dianders@chromium.org>

dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file

This commit deletes the old mailbox.txt device-tree bindings file. The
documentation contained in the file has been moved to the dt-schema
repository.

Link: https://lore.kernel.org/r/20260722140214.GA548057-robh@kernel.org [1]
Link: https://lore.kernel.org/r/dc7a2041-50a4-482e-9930-566bb3fd1e72@kernel.org [2]
Link: https://lore.kernel.org/r/CAL_JsqKVjQ2m-dzMUENQry-f_YE9QrYSOKoH9CPj1gjj8XkPRA@mail.gmail.com [3]
Link: https://github.com/devicetree-org/dt-schema/pull/202 [4]

> diff --git a/Documentation/devicetree/bindings/mailbox/mailbox.txt b/Documentation/devicetree/bindings/mailbox/mailbox.txt
> deleted file mode 100644
> index af8ecee2ac687..0000000000000
> --- a/Documentation/devicetree/bindings/mailbox/mailbox.txt
> +++ /dev/null
> @@ -1,60 +0,0 @@
> -* Generic Mailbox Controller and client driver bindings

[Severity: Low]
Does deleting this file leave dangling documentation links in other bindings
that still reference it?

For example, there are explicit references to mailbox.txt in:
- Documentation/devicetree/bindings/mailbox/ti,omap-mailbox.yaml
- Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml
- Documentation/devicetree/bindings/soc/qcom/qcom,aoss-qmp.yaml
- Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml
- Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml

[ ... ]

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260804133801.1.I8b3ff71c528133e7d6f81fe926fa39e6451d63fd@changeid?part=1

Re: [PATCH] dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file

[Doug Anderson]

Hi,

On Tue, Aug 4, 2026 at 1:44 PM <sashiko-bot@kernel.org> wrote:
>
> Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
> - [Low] Deleting `mailbox.txt` without updating references to it in other binding files leaves dangling, broken documentation references.
> --
>
> --- Patch [1]: [PATCH] dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file ---
> commit 1b70b3f250d6bcf306aca223e0e91c9fb8a20cc2
> Author: Douglas Anderson <dianders@chromium.org>
>
> dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file
>
> This commit deletes the old mailbox.txt device-tree bindings file. The
> documentation contained in the file has been moved to the dt-schema
> repository.
>
> Link: https://lore.kernel.org/r/20260722140214.GA548057-robh@kernel.org [1]
> Link: https://lore.kernel.org/r/dc7a2041-50a4-482e-9930-566bb3fd1e72@kernel.org [2]
> Link: https://lore.kernel.org/r/CAL_JsqKVjQ2m-dzMUENQry-f_YE9QrYSOKoH9CPj1gjj8XkPRA@mail.gmail.com [3]
> Link: https://github.com/devicetree-org/dt-schema/pull/202 [4]
>
> > diff --git a/Documentation/devicetree/bindings/mailbox/mailbox.txt b/Documentation/devicetree/bindings/mailbox/mailbox.txt
> > deleted file mode 100644
> > index af8ecee2ac687..0000000000000
> > --- a/Documentation/devicetree/bindings/mailbox/mailbox.txt
> > +++ /dev/null
> > @@ -1,60 +0,0 @@
> > -* Generic Mailbox Controller and client driver bindings
>
> [Severity: Low]
> Does deleting this file leave dangling documentation links in other bindings
> that still reference it?
>
> For example, there are explicit references to mailbox.txt in:
> - Documentation/devicetree/bindings/mailbox/ti,omap-mailbox.yaml
> - Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml
> - Documentation/devicetree/bindings/soc/qcom/qcom,aoss-qmp.yaml
> - Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml
> - Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml
>
> [ ... ]
>
> --
> Sashiko AI review · https://sashiko.dev/#/patchset/20260804133801.1.I8b3ff71c528133e7d6f81fe926fa39e6451d63fd@changeid?part=1

Sashiko makes a good point. I'm happy to send a v2 of this patch
fixing this, but I'll wait to see if there are any other comments
first. If I don't hear anything in a week or so, I'll send a v2
anyway.

-Doug