From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.5 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE, SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id F0462C606D1 for ; Mon, 8 Jul 2019 22:20:09 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id BCA682173C for ; Mon, 8 Jul 2019 22:20:09 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="gpYdvRs5" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org BCA682173C Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=mj+8mvJILr+dCDC1QtZFZtWeu2X3FP3bFdDIO7QiXV8=; b=gpYdvRs5PfHa94 gbIcWv3Fe9eIWh2auWNYN1hINyReh4q50jD4y5MI0XB4vFsGuA6FB/fR8XtTh2g7tjzN/crGu9kKQ 3JnrEBtPXVKTta1p+n8CffT5wC0oiOEGF5hSOqDsRgfIiFGwyXdvV9MzXdiEbwleSTxsRFgYHk7bI jt4QcBoLrCw0YoCa4cxNq6HQEkRO4KG3jzaTzX7OmEr63Uf97u5mZFYpPVo+KTgp643HHcl5Q8jg2 IZvCwHIm6bvMJnbMU9Fo1pOQpXaYPxBEpKE7LNQfHzwOTzJhEX8/Aw+bnElBcyh/WnjCm8AOn02B1 rNOZx4XaPx44RF+wQlwA==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92 #3 (Red Hat Linux)) id 1hkbzJ-0007LU-Fx; Mon, 08 Jul 2019 22:19:57 +0000 Received: from mail-io1-f65.google.com ([209.85.166.65]) by bombadil.infradead.org with esmtps (Exim 4.92 #3 (Red Hat Linux)) id 1hkbzF-0007Kd-At for linux-arm-kernel@lists.infradead.org; Mon, 08 Jul 2019 22:19:55 +0000 Received: by mail-io1-f65.google.com with SMTP id g20so17761977ioc.12 for ; Mon, 08 Jul 2019 15:19:50 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=mN46vG+/AOz/nYTuDQPNV5277nOfHBKNL+k2+anwNSQ=; b=nEAv6tTQOaIfM6Wf7zXwEVn8sLh0Srw2RBanKPfXEWWRQqgLAJDr87Z/+v2crc+8UG D5C+xbEjrxmRHIk37xBmA1weElONHYVYpNtOrvaVIUvGNH15ytg3tDamyfc0zB/48V4d k+WmJhXutH4Ejbosray5sJ47jjB+In1T9AxNDe2AhVeRkBdWqUmXeFop9ABxeRE4olHu cSDk5k3rVLFwYFSHo2MdELh1yL2g0dBrk2K+Ugu1T+jqI192Mp9jB62342zWj6cTm81s k4fCCtmVfXMi1dpVGuw8hbCOaJYvML4WCdKcxwsmPLoFINA3K7t2Hzh0IZ5LKrbAIvch Y91w== X-Gm-Message-State: APjAAAW8fBsaBqL87/bZNdNUGTJrh2Z9a+Q6w8L9OT+lktfasPfZoXq5 U0pHBfiL1McViJdBYlTSmg== X-Google-Smtp-Source: APXvYqyFCtd9RZAWexm1ovEMHGgSm3Adn/B2Dt7+BZSqwk7NopQ7+ycbM6hzReeqC1agYla95EW74Q== X-Received: by 2002:a02:1607:: with SMTP id a7mr23310703jaa.123.1562624389648; Mon, 08 Jul 2019 15:19:49 -0700 (PDT) Received: from localhost ([64.188.179.252]) by smtp.gmail.com with ESMTPSA id q22sm14923152ioj.56.2019.07.08.15.19.48 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Mon, 08 Jul 2019 15:19:48 -0700 (PDT) Date: Mon, 8 Jul 2019 16:19:47 -0600 From: Rob Herring To: peng.fan@nxp.com Subject: Re: [PATCH V2 1/2] DT: mailbox: add binding doc for the ARM SMC mailbox Message-ID: <20190708221947.GA13552@bogus> References: <20190603083005.4304-1-peng.fan@nxp.com> <20190603083005.4304-2-peng.fan@nxp.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20190603083005.4304-2-peng.fan@nxp.com> User-Agent: Mutt/1.10.1 (2018-07-13) X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190708_151953_379945_AC1ECD8D X-CRM114-Status: GOOD ( 27.29 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: mark.rutland@arm.com, devicetree@vger.kernel.org, f.fainelli@gmail.com, festevam@gmail.com, jassisinghbrar@gmail.com, linux-kernel@vger.kernel.org, andre.przywara@arm.com, linux-imx@nxp.com, kernel@pengutronix.de, sudeep.holla@arm.com, van.freenix@gmail.com, shawnguo@kernel.org, linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Mon, Jun 03, 2019 at 04:30:04PM +0800, peng.fan@nxp.com wrote: > From: Peng Fan > > The ARM SMC 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 > --- > > V2: > Introduce interrupts as a property. > > V1: > arm,func-ids is still kept as an optional property, because there is no > defined SMC funciton id passed from SCMI. So in my test, I still use > arm,func-ids for ARM SIP service. > > .../devicetree/bindings/mailbox/arm-smc.txt | 101 +++++++++++++++++++++ > 1 file changed, 101 insertions(+) > create mode 100644 Documentation/devicetree/bindings/mailbox/arm-smc.txt > > diff --git a/Documentation/devicetree/bindings/mailbox/arm-smc.txt b/Documentation/devicetree/bindings/mailbox/arm-smc.txt > new file mode 100644 > index 000000000000..401887118c09 > --- /dev/null > +++ b/Documentation/devicetree/bindings/mailbox/arm-smc.txt > @@ -0,0 +1,101 @@ > +ARM SMC Mailbox Interface > +========================= > + > +This mailbox uses the ARM smc (secure monitor 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[1]. > +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. > + > +Mailbox Device Node: > +==================== > + > +This node is expected to be a child of the /firmware node. > + > +Required properties: > +-------------------- > +- compatible: Shall be "arm,smc-mbox" > +- #mbox-cells Shall be 1 - the index of the channel needed. > +- arm,num-chans The number of channels supported. > +- method: A string, either: > + "hvc": if the driver shall use an HVC call, or > + "smc": if the driver shall use an SMC call. > + > +Optional properties: > +- arm,func-ids 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. > +- interrupts SPI interrupts may be listed for notification, > + each channel should use a dedicated interrupt > + line. > + > +Example: > +-------- > + > + 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>; > + }; > + }; > + > + smc_mbox: mailbox { This should be a child of 'firmware' node at least and really a child of the firmware component that implements the feature. > + #mbox-cells = <1>; > + compatible = "arm,smc-mbox"; > + method = "smc"; > + arm,num-chans = <0x2>; > + /* Optional */ > + arm,func-ids = <0xc20000fe>, <0xc20000ff>; > + }; > + > + firmware { > + scmi { > + compatible = "arm,scmi"; > + mboxes = <&mailbox 0 &mailbox 1>; > + mbox-names = "tx", "rx"; > + shmem = <&cpu_scp_lpri &cpu_scp_hpri>; > + }; > + }; > + > + > +[1] > +http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.den0028a/index.html > -- > 2.16.4 > _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel