From: Peng Fan <peng.fan@nxp.com> To: "robh+dt@kernel.org" <robh+dt@kernel.org>, "mark.rutland@arm.com" <mark.rutland@arm.com>, "jassisinghbrar@gmail.com" <jassisinghbrar@gmail.com>, "sudeep.holla@arm.com" <sudeep.holla@arm.com>, "andre.przywara@arm.com" <andre.przywara@arm.com>, "f.fainelli@gmail.com" <f.fainelli@gmail.com> Cc: "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>, "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>, "linux-arm-kernel@lists.infradead.org" <linux-arm-kernel@lists.infradead.org>, dl-linux-imx <linux-imx@nxp.com>, Peng Fan <peng.fan@nxp.com> Subject: [PATCH v5 1/2] dt-bindings: mailbox: add binding doc for the ARM SMC/HVC mailbox Date: Wed, 28 Aug 2019 03:02:58 +0000 [thread overview] Message-ID: <1567004515-3567-2-git-send-email-peng.fan@nxp.com> (raw) In-Reply-To: <1567004515-3567-1-git-send-email-peng.fan@nxp.com> From: Peng Fan <peng.fan@nxp.com> The ARM SMC/HVC mailbox binding describes a firmware interface to trigger actions in software layers running in the EL2 or EL3 exception levels. The term "ARM" here relates to the SMC instruction as part of the ARM instruction set, not as a standard endorsed by ARM Ltd. Signed-off-by: Peng Fan <peng.fan@nxp.com> --- .../devicetree/bindings/mailbox/arm-smc.yaml | 125 +++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 Documentation/devicetree/bindings/mailbox/arm-smc.yaml diff --git a/Documentation/devicetree/bindings/mailbox/arm-smc.yaml b/Documentation/devicetree/bindings/mailbox/arm-smc.yaml new file mode 100644 index 000000000000..f8eb28d5e307 --- /dev/null +++ b/Documentation/devicetree/bindings/mailbox/arm-smc.yaml @@ -0,0 +1,125 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mailbox/arm-smc.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: ARM SMC Mailbox Interface + +maintainers: + - Peng Fan <peng.fan@nxp.com> + +description: | + This mailbox uses the ARM smc (secure monitor call) and hvc (hypervisor + call) instruction to trigger a mailbox-connected activity in firmware, + executing on the very same core as the caller. By nature this operation + is synchronous and this mailbox provides no way for asynchronous messages + to be delivered the other way round, from firmware to the OS, but + asynchronous notification could also be supported. However the value of + r0/w0/x0 the firmware returns after the smc call is delivered as a received + message to the mailbox framework, so a synchronous communication can be + established, for a asynchronous notification, no value will be returned. + The exact meaning of both the action the mailbox triggers as well as the + return value is defined by their users and is not subject to this binding. + + One use case of this mailbox is the SCMI interface, which uses shared memory + to transfer commands and parameters, and a mailbox to trigger a function + call. This allows SoCs without a separate management processor (or when + such a processor is not available or used) to use this standardized + interface anyway. + + This binding describes no hardware, but establishes a firmware interface. + Upon receiving an SMC using one of the described SMC function identifiers, + the firmware is expected to trigger some mailbox connected functionality. + The communication follows the ARM SMC calling convention. + Firmware expects an SMC function identifier in r0 or w0. The supported + identifiers are passed from consumers, or listed in the the arm,func-ids + properties as described below. The firmware can return one value in + the first SMC result register, it is expected to be an error value, + which shall be propagated to the mailbox client. + + Any core which supports the SMC or HVC instruction can be used, as long as + a firmware component running in EL3 or EL2 is handling these calls. + +properties: + compatible: + const: arm,smc-mbox + + "#mbox-cells": + const: 1 + + arm,num-chans: + description: The number of channels supported. + items: + minimum: 1 + maximum: 4096 # Should be enough? + + method: + - enum: + - smc + - hvc + + transports: + - enum: + - mem + - reg + + arm,func-ids: + description: | + An array of 32-bit values specifying the function IDs used by each + mailbox channel. Those function IDs follow the ARM SMC calling + convention standard [1]. + + There is one identifier per channel and the number of supported + channels is determined by the length of this array. + $ref: /schemas/types.yaml#/definitions/uint32-array + minItems: 0 + maxItems: 4096 # Should be enough? + +required: + - compatible + - "#mbox-cells" + - arm,num-chans + - transports + - method + +examples: + - | + sram@910000 { + compatible = "mmio-sram"; + reg = <0x0 0x93f000 0x0 0x1000>; + #address-cells = <1>; + #size-cells = <1>; + ranges = <0 0x0 0x93f000 0x1000>; + + cpu_scp_lpri: scp-shmem@0 { + compatible = "arm,scmi-shmem"; + reg = <0x0 0x200>; + }; + + cpu_scp_hpri: scp-shmem@200 { + compatible = "arm,scmi-shmem"; + reg = <0x200 0x200>; + }; + }; + + firmware { + smc_mbox: mailbox { + #mbox-cells = <1>; + compatible = "arm,smc-mbox"; + method = "smc"; + arm,num-chans = <0x2>; + transports = "mem"; + /* Optional */ + arm,func-ids = <0xc20000fe>, <0xc20000ff>; + }; + + scmi { + compatible = "arm,scmi"; + mboxes = <&smc_mbox 0>, <&smc_mbox 1>; + mbox-names = "tx", "rx"; + shmem = <&cpu_scp_lpri>, <&cpu_scp_hpri>; + }; + }; + +... -- 2.16.4
WARNING: multiple messages have this Message-ID (diff)
From: Peng Fan <peng.fan@nxp.com> To: "robh+dt@kernel.org" <robh+dt@kernel.org>, "mark.rutland@arm.com" <mark.rutland@arm.com>, "jassisinghbrar@gmail.com" <jassisinghbrar@gmail.com>, "sudeep.holla@arm.com" <sudeep.holla@arm.com>, "andre.przywara@arm.com" <andre.przywara@arm.com>, "f.fainelli@gmail.com" <f.fainelli@gmail.com> Cc: "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>, Peng Fan <peng.fan@nxp.com>, "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>, "linux-arm-kernel@lists.infradead.org" <linux-arm-kernel@lists.infradead.org>, dl-linux-imx <linux-imx@nxp.com> Subject: [PATCH v5 1/2] dt-bindings: mailbox: add binding doc for the ARM SMC/HVC mailbox Date: Wed, 28 Aug 2019 03:02:58 +0000 [thread overview] Message-ID: <1567004515-3567-2-git-send-email-peng.fan@nxp.com> (raw) In-Reply-To: <1567004515-3567-1-git-send-email-peng.fan@nxp.com> From: Peng Fan <peng.fan@nxp.com> The ARM SMC/HVC mailbox binding describes a firmware interface to trigger actions in software layers running in the EL2 or EL3 exception levels. The term "ARM" here relates to the SMC instruction as part of the ARM instruction set, not as a standard endorsed by ARM Ltd. Signed-off-by: Peng Fan <peng.fan@nxp.com> --- .../devicetree/bindings/mailbox/arm-smc.yaml | 125 +++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 Documentation/devicetree/bindings/mailbox/arm-smc.yaml diff --git a/Documentation/devicetree/bindings/mailbox/arm-smc.yaml b/Documentation/devicetree/bindings/mailbox/arm-smc.yaml new file mode 100644 index 000000000000..f8eb28d5e307 --- /dev/null +++ b/Documentation/devicetree/bindings/mailbox/arm-smc.yaml @@ -0,0 +1,125 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mailbox/arm-smc.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: ARM SMC Mailbox Interface + +maintainers: + - Peng Fan <peng.fan@nxp.com> + +description: | + This mailbox uses the ARM smc (secure monitor call) and hvc (hypervisor + call) instruction to trigger a mailbox-connected activity in firmware, + executing on the very same core as the caller. By nature this operation + is synchronous and this mailbox provides no way for asynchronous messages + to be delivered the other way round, from firmware to the OS, but + asynchronous notification could also be supported. However the value of + r0/w0/x0 the firmware returns after the smc call is delivered as a received + message to the mailbox framework, so a synchronous communication can be + established, for a asynchronous notification, no value will be returned. + The exact meaning of both the action the mailbox triggers as well as the + return value is defined by their users and is not subject to this binding. + + One use case of this mailbox is the SCMI interface, which uses shared memory + to transfer commands and parameters, and a mailbox to trigger a function + call. This allows SoCs without a separate management processor (or when + such a processor is not available or used) to use this standardized + interface anyway. + + This binding describes no hardware, but establishes a firmware interface. + Upon receiving an SMC using one of the described SMC function identifiers, + the firmware is expected to trigger some mailbox connected functionality. + The communication follows the ARM SMC calling convention. + Firmware expects an SMC function identifier in r0 or w0. The supported + identifiers are passed from consumers, or listed in the the arm,func-ids + properties as described below. The firmware can return one value in + the first SMC result register, it is expected to be an error value, + which shall be propagated to the mailbox client. + + Any core which supports the SMC or HVC instruction can be used, as long as + a firmware component running in EL3 or EL2 is handling these calls. + +properties: + compatible: + const: arm,smc-mbox + + "#mbox-cells": + const: 1 + + arm,num-chans: + description: The number of channels supported. + items: + minimum: 1 + maximum: 4096 # Should be enough? + + method: + - enum: + - smc + - hvc + + transports: + - enum: + - mem + - reg + + arm,func-ids: + description: | + An array of 32-bit values specifying the function IDs used by each + mailbox channel. Those function IDs follow the ARM SMC calling + convention standard [1]. + + There is one identifier per channel and the number of supported + channels is determined by the length of this array. + $ref: /schemas/types.yaml#/definitions/uint32-array + minItems: 0 + maxItems: 4096 # Should be enough? + +required: + - compatible + - "#mbox-cells" + - arm,num-chans + - transports + - method + +examples: + - | + sram@910000 { + compatible = "mmio-sram"; + reg = <0x0 0x93f000 0x0 0x1000>; + #address-cells = <1>; + #size-cells = <1>; + ranges = <0 0x0 0x93f000 0x1000>; + + cpu_scp_lpri: scp-shmem@0 { + compatible = "arm,scmi-shmem"; + reg = <0x0 0x200>; + }; + + cpu_scp_hpri: scp-shmem@200 { + compatible = "arm,scmi-shmem"; + reg = <0x200 0x200>; + }; + }; + + firmware { + smc_mbox: mailbox { + #mbox-cells = <1>; + compatible = "arm,smc-mbox"; + method = "smc"; + arm,num-chans = <0x2>; + transports = "mem"; + /* Optional */ + arm,func-ids = <0xc20000fe>, <0xc20000ff>; + }; + + scmi { + compatible = "arm,scmi"; + mboxes = <&smc_mbox 0>, <&smc_mbox 1>; + mbox-names = "tx", "rx"; + shmem = <&cpu_scp_lpri>, <&cpu_scp_hpri>; + }; + }; + +... -- 2.16.4 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2019-08-28 3:03 UTC|newest] Thread overview: 96+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-08-28 3:02 [PATCH v5 0/2] mailbox: arm: introduce smc triggered mailbox Peng Fan 2019-08-28 3:02 ` Peng Fan 2019-08-28 3:02 ` Peng Fan 2019-08-28 3:02 ` Peng Fan [this message] 2019-08-28 3:02 ` [PATCH v5 1/2] dt-bindings: mailbox: add binding doc for the ARM SMC/HVC mailbox Peng Fan 2019-08-28 3:02 ` Peng Fan 2019-08-28 13:58 ` Sudeep Holla 2019-08-28 13:58 ` Sudeep Holla 2019-08-28 13:58 ` Sudeep Holla 2019-08-30 2:47 ` Peng Fan 2019-08-30 2:47 ` Peng Fan 2019-08-30 2:47 ` Peng Fan 2019-08-30 5:58 ` Jassi Brar 2019-08-30 5:58 ` Jassi Brar 2019-08-30 5:58 ` Jassi Brar 2019-08-30 6:28 ` Peng Fan 2019-08-30 6:28 ` Peng Fan 2019-08-30 6:28 ` Peng Fan 2019-08-30 7:21 ` Jassi Brar 2019-08-30 7:21 ` Jassi Brar 2019-08-30 7:21 ` Jassi Brar 2019-08-30 7:37 ` Peng Fan 2019-08-30 7:37 ` Peng Fan 2019-08-30 7:37 ` Peng Fan 2019-08-30 7:52 ` Jassi Brar 2019-08-30 7:52 ` Jassi Brar 2019-08-30 7:52 ` Jassi Brar 2019-08-30 8:07 ` Peng Fan 2019-08-30 8:07 ` Peng Fan 2019-08-30 8:07 ` Peng Fan 2019-08-30 8:12 ` Jassi Brar 2019-08-30 8:12 ` Jassi Brar 2019-08-30 8:12 ` Jassi Brar 2019-08-30 8:28 ` Peng Fan 2019-08-30 8:28 ` Peng Fan 2019-08-30 8:28 ` Peng Fan 2019-09-09 13:32 ` Andre Przywara 2019-09-09 13:32 ` Andre Przywara 2019-09-09 13:32 ` Andre Przywara 2019-09-11 2:27 ` Peng Fan 2019-09-11 2:27 ` Peng Fan 2019-09-11 2:27 ` Peng Fan 2019-09-11 2:36 ` Jassi Brar 2019-09-11 2:36 ` Jassi Brar 2019-09-11 2:36 ` Jassi Brar 2019-09-11 11:42 ` Andre Przywara 2019-09-11 11:42 ` Andre Przywara 2019-09-11 11:42 ` Andre Przywara 2019-08-30 9:32 ` Sudeep Holla 2019-08-30 9:32 ` Sudeep Holla 2019-08-30 9:32 ` Sudeep Holla 2019-08-30 16:51 ` Jassi Brar 2019-08-30 16:51 ` Jassi Brar 2019-08-30 16:51 ` Jassi Brar 2019-08-30 9:30 ` Sudeep Holla 2019-08-30 9:30 ` Sudeep Holla 2019-08-30 9:30 ` Sudeep Holla 2019-08-30 9:40 ` Peng Fan 2019-08-30 9:40 ` Peng Fan 2019-08-30 9:40 ` Peng Fan 2019-09-02 13:39 ` Rob Herring 2019-09-02 13:39 ` Rob Herring 2019-09-02 13:39 ` Rob Herring 2019-09-02 14:20 ` Rob Herring 2019-09-02 14:20 ` Rob Herring 2019-09-02 14:20 ` Rob Herring 2019-09-09 15:42 ` Andre Przywara 2019-09-09 15:42 ` Andre Przywara 2019-09-09 15:42 ` Andre Przywara 2019-09-11 2:44 ` Jassi Brar 2019-09-11 2:44 ` Jassi Brar 2019-09-11 2:44 ` Jassi Brar 2019-09-11 15:03 ` Andre Przywara 2019-09-11 15:03 ` Andre Przywara 2019-09-11 15:03 ` Andre Przywara 2019-09-11 16:55 ` Jassi Brar 2019-09-11 16:55 ` Jassi Brar 2019-09-11 16:55 ` Jassi Brar 2019-09-12 3:05 ` Peng Fan 2019-09-12 3:05 ` Peng Fan 2019-09-12 3:05 ` Peng Fan 2019-08-28 3:03 ` [PATCH v5 2/2] mailbox: introduce ARM SMC based mailbox Peng Fan 2019-08-28 3:03 ` Peng Fan 2019-08-28 3:03 ` Peng Fan 2019-08-28 14:02 ` Sudeep Holla 2019-08-28 14:02 ` Sudeep Holla 2019-08-28 14:02 ` Sudeep Holla 2019-08-30 2:50 ` Peng Fan 2019-08-30 2:50 ` Peng Fan 2019-08-30 2:50 ` Peng Fan 2019-09-09 15:42 ` Andre Przywara 2019-09-09 15:42 ` Andre Przywara 2019-09-09 15:42 ` Andre Przywara 2019-09-11 5:58 ` Peng Fan 2019-09-11 5:58 ` Peng Fan 2019-09-11 5:58 ` Peng Fan
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=1567004515-3567-2-git-send-email-peng.fan@nxp.com \ --to=peng.fan@nxp.com \ --cc=andre.przywara@arm.com \ --cc=devicetree@vger.kernel.org \ --cc=f.fainelli@gmail.com \ --cc=jassisinghbrar@gmail.com \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-imx@nxp.com \ --cc=linux-kernel@vger.kernel.org \ --cc=mark.rutland@arm.com \ --cc=robh+dt@kernel.org \ --cc=sudeep.holla@arm.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.