mirror of
https://github.com/torvalds/linux.git
synced 2026-11-07 06:17:02 +01:00
dt-bindings: mailbox: Delete old 'mailbox.txt' bindings file
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/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> Link: https://patch.msgid.link/20260814124603.v2.1.I8b3ff71c528133e7d6f81fe926fa39e6451d63fd@changeid Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
This commit is contained in:
parent
117d30d310
commit
cfbc5d96e8
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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>;
|
||||
..
|
||||
};
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -71,7 +71,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
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user