[PATCH v2] dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file
Douglas Anderson <[email protected]>
| Newsgroups | org.kernel.vger.linux-tegra,dev.linux.lists.linux-sunxi,org.infradead.lists.linux-arm-kernel,org.kernel.vger.linux-arm-msm,org.kernel.vger.linux-devicetree,org.kernel.vger.linux-kernel,org.kernel.vger.linux-pm |
|---|---|
| Message-ID | <20260814124603.v2.1.I8b3ff71c528133e7d6f81fe926fa39e6451d63fd@changeid> |
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]. Also remove dangling references to `mailbox.txt` across all remaining device-tree binding documentation files. Link: https://lore.kernel.org/r/[email protected] [1] Link: https://lore.kernel.org/r/[email protected] [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 <[email protected]> Cc: Jassi Brar <[email protected]> Cc: Lee Jones <[email protected]> Signed-off-by: Douglas Anderson <[email protected]> --- - v1: https://lore.kernel.org/r/20260804133801.1.I8b3ff71c528133e7d6f81fe926fa39e6451d63fd@changeid Changes in v2: - Remove dangling mailbox.txt references as per Sashiko. .../firmware/nvidia,tegra186-bpmp.yaml | 6 +- .../mailbox/allwinner,sun6i-a31-msgbox.yaml | 3 - .../bindings/mailbox/altera-mailbox.txt | 12 ++-- .../mailbox/hisilicon,hi3660-mailbox.txt | 2 +- .../mailbox/hisilicon,hi6220-mailbox.txt | 2 +- .../devicetree/bindings/mailbox/mailbox.txt | 60 ------------------- .../bindings/mailbox/ti,omap-mailbox.yaml | 3 +- .../power/reset/xlnx,zynqmp-power.yaml | 9 +-- .../bindings/soc/qcom/qcom,aoss-qmp.yaml | 2 +- 9 files changed, 15 insertions(+), 84 deletions(-) delete mode 100644 Documentation/devicetree/bindings/mailbox/mailbox.txt diff --git a/Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml b/Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml index 3c44fe607e12..acdc5c1d3d8b 100644 --- a/Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml +++ b/Documentation/devicetree/bindings/firmware/nvidia,tegra186-bpmp.yaml @@ -18,11 +18,9 @@ description: | which can create the interprocessor communication (IPC) between the CPU and BPMP. - This node is a mailbox consumer. See the following files for details - of the mailbox subsystem, and the specifiers implemented by the - relevant provider(s): + This node is a mailbox consumer. See the following file for details + of the mailbox specifiers implemented by the relevant provider(s): - - .../mailbox/mailbox.txt - .../mailbox/nvidia,tegra186-hsp.yaml This node is a clock, power domain, and reset provider. See the diff --git a/Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml b/Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml index 87d31963c1b7..f58b0d412186 100644 --- a/Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml +++ b/Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml @@ -17,9 +17,6 @@ description: | hold four 32-bit messages; when a FIFO is full, clients must wait before attempting more transmissions. - Refer to ./mailbox.txt for generic information about mailbox device-tree - bindings. - properties: compatible: oneOf: diff --git a/Documentation/devicetree/bindings/mailbox/altera-mailbox.txt b/Documentation/devicetree/bindings/mailbox/altera-mailbox.txt index c4dd93f1fed2..87749d251f09 100644 --- a/Documentation/devicetree/bindings/mailbox/altera-mailbox.txt +++ b/Documentation/devicetree/bindings/mailbox/altera-mailbox.txt @@ -31,12 +31,12 @@ Example: Mailbox client =============== -"mboxes" and the optional "mbox-names" (please see -Documentation/devicetree/bindings/mailbox/mailbox.txt for details). Each value -of the mboxes property should contain a phandle to the mailbox controller -device node and second argument is the channel index. It must be 0 (hardware -support only one channel).The equivalent "mbox-names" property value can be -used to give a name to the communication channel to be used by the client user. +The common mailbox binding properties "mboxes" and the optional "mbox-names" +can be used. Each value of the mboxes property should contain a phandle to +the mailbox controller device node and second argument is the channel index. +It must be 0 (hardware support only one channel). The equivalent "mbox-names" +property value can be used to give a name to the communication channel to be +used by the client user. Example: mclient0: mclient0@400 { diff --git a/Documentation/devicetree/bindings/mailbox/hisilicon,hi3660-mailbox.txt b/Documentation/devicetree/bindings/mailbox/hisilicon,hi3660-mailbox.txt index 3e5b4537407d..ec2da5c9e647 100644 --- a/Documentation/devicetree/bindings/mailbox/hisilicon,hi3660-mailbox.txt +++ b/Documentation/devicetree/bindings/mailbox/hisilicon,hi3660-mailbox.txt @@ -35,7 +35,7 @@ Client Required properties: - compatible : See the client docs -- mboxes : Standard property to specify a Mailbox (See ./mailbox.txt) +- mboxes : Standard property to specify a Mailbox Cells must match 'mbox-cells' (See Controller docs above) Optional properties diff --git a/Documentation/devicetree/bindings/mailbox/hisilicon,hi6220-mailbox.txt b/Documentation/devicetree/bindings/mailbox/hisilicon,hi6220-mailbox.txt index 044b17f3a77a..de9fbf722bee 100644 --- a/Documentation/devicetree/bindings/mailbox/hisilicon,hi6220-mailbox.txt +++ b/Documentation/devicetree/bindings/mailbox/hisilicon,hi6220-mailbox.txt @@ -55,7 +55,7 @@ Mailbox client Required properties: -------------------- - compatible: Many (See the client docs). -- mboxes: Standard property to specify a Mailbox (See ./mailbox.txt) +- mboxes: Standard property to specify a Mailbox Cells must match 'mbox-cells' (See Mailbox Device Node above). Optional Properties: 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>; - .. - }; diff --git a/Documentation/devicetree/bindings/mailbox/ti,omap-mailbox.yaml b/Documentation/devicetree/bindings/mailbox/ti,omap-mailbox.yaml index 8504ceb64806..7e3b7b68841c 100644 --- a/Documentation/devicetree/bindings/mailbox/ti,omap-mailbox.yaml +++ b/Documentation/devicetree/bindings/mailbox/ti,omap-mailbox.yaml @@ -53,8 +53,7 @@ description: | ============== A device needing to communicate with a target processor device should specify them using the common mailbox binding properties, "mboxes" and the optional - "mbox-names" (please see Documentation/devicetree/bindings/mailbox/mailbox.txt - for details). Each value of the mboxes property should contain a phandle to + "mbox-names". Each value of the mboxes property should contain a phandle to the mailbox controller device node and an args specifier that will be the phandle to the intended sub-mailbox child node to be used for communication. The equivalent "mbox-names" property value can be used to give a name to the diff --git a/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml b/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml index 079ad977b907..60f0882f5381 100644 --- a/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml +++ b/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml @@ -27,12 +27,9 @@ properties: mailbox controller device node and an args specifier that will be the phandle to the intended sub-mailbox child node to be used for communication. See - Documentation/devicetree/bindings/mailbox/mailbox.txt - for more details about the generic mailbox controller - and client driver bindings. Also see - Documentation/devicetree/bindings/mailbox/ \ - xlnx,zynqmp-ipi-mailbox.txt for typical controller that - is used to communicate with this System controllers. + Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml + for typical controller that is used to communicate with + this System controllers. items: - description: tx channel - description: rx channel diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,aoss-qmp.yaml b/Documentation/devicetree/bindings/soc/qcom/qcom,aoss-qmp.yaml index 8eaa04431d74..e238f100f8ff 100644 --- a/Documentation/devicetree/bindings/soc/qcom/qcom,aoss-qmp.yaml +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,aoss-qmp.yaml @@ -69,7 +69,7 @@ properties: maxItems: 1 description: Reference to the mailbox representing the outgoing doorbell in APCS for - this client, as described in mailbox/mailbox.txt + this client. "#clock-cells": const: 0 -- 2.55.0.691.gc56d675ccc-goog