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 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 smtp.lore.kernel.org (Postfix) with ESMTPS id 9498DC3DA41 for ; Thu, 11 Jul 2024 13:16:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:In-Reply-To:Content-Type: MIME-Version:References:Message-ID:Subject:Cc:To:From:Date:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=gUF5Vw84ikzkqx0O1GRSnC5oDN5p/hulPNWPGhV9ZSM=; b=fiSc8U2jYPB7X+E8Xev5XXE+p4 PAlFBF1Q7wPJKHdGE5BwIHU3UkpGRDtJjAoD5aPnRl4tPOdmKknoxExM782VzEVKc1/yVJiGHD+ZQ b3n0ovIGdF4qcboFYMAZYxjligq0DGPlY2I9N/UFqSzS58L6giVt97sHM1cG+vKd1DkPHWLiL7gUA iU73/DYV6epIzoBmkQH1z5LQ4x2lW/x+3uE0EsLhRr+dV8POpfkc3bIKQcKkUDM19qLquFEZp029b Z2DCtInD0OYsGbL88/6B+zAW6OwxCs8NFNE/ZzDgnkIyMgHzG0PmXmWk7SDZp6fq8av+Tuad/jB8x uy9xcTXw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sRtex-0000000E7KN-04bW; Thu, 11 Jul 2024 13:16:31 +0000 Received: from foss.arm.com ([217.140.110.172]) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sRtef-0000000E7FQ-0L6a for linux-arm-kernel@lists.infradead.org; Thu, 11 Jul 2024 13:16:14 +0000 Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id A703BFEC; Thu, 11 Jul 2024 06:16:36 -0700 (PDT) Received: from pluto (usa-sjc-mx-foss1.foss.arm.com [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 78F383F766; Thu, 11 Jul 2024 06:16:08 -0700 (PDT) Date: Thu, 11 Jul 2024 14:16:06 +0100 From: Cristian Marussi To: "Peng Fan (OSS)" Cc: Jonathan Corbet , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , Sudeep Holla , Cristian Marussi , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Peng Fan , Alexandre Belloni , Dmitry Torokhov , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, imx@lists.linux.dev, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, arm-scmi@vger.kernel.org, linux-rtc@vger.kernel.org, linux-input@vger.kernel.org Subject: Re: [PATCH v5 1/7] Documentation: firmware-guide: add NXP i.MX95 SCMI documentation Message-ID: References: <20240621-imx95-bbm-misc-v2-v5-0-b85a6bf778cb@nxp.com> <20240621-imx95-bbm-misc-v2-v5-1-b85a6bf778cb@nxp.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20240621-imx95-bbm-misc-v2-v5-1-b85a6bf778cb@nxp.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240711_061613_370878_F6897373 X-CRM114-Status: GOOD ( 17.88 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Fri, Jun 21, 2024 at 03:04:36PM +0800, Peng Fan (OSS) wrote: > From: Peng Fan > > Add NXP i.MX95 System Control Management Interface(SCMI) vendor > extensions protocol documentation. > Hi, beside the final location of this file in the tree, and a few nitpicks down below. LGTM. Reviewed-by: Cristian Marussi > Signed-off-by: Peng Fan > --- [snip] > +MISC_CONTROL_GET > +~~~~~~~~~~~~~~~~ > + > +message_id: 0x4 > +protocol_id: 0x84 > + > ++------------------+-----------------------------------------------------------+ > +|Parameters | > ++------------------+-----------------------------------------------------------+ > +|Name |Description | > ++------------------+-----------------------------------------------------------+ > +|uint32 index |Index of the control | > ++------------------+-----------------------------------------------------------+ > +|Return values | > ++------------------+-----------------------------------------------------------+ > +|Name |Description | > ++------------------+-----------------------------------------------------------+ > +|int32 status |SUCCESS: if the control was get successfully. | > +| |NOT_FOUND: if the index is not valid. | > +| |DENIED: if the agent does not have permission to get the | > +| |control | > ++------------------+-----------------------------------------------------------+ > +|uint32 num |Size of the return data in words, max 8 | > ++------------------+-----------------------------------------------------------+ > +|uint32 | | > +|val[0, num - 8] |value data array | val[0, num - 1] --- typo ? which I suppose means that this field is variable in size depending on num value... In the gneral SCMI spec I think usually we write something like uint32 val[N] with N as specified in num. ... but I am fine even with this val[0, num - 1] if it is intended to meanb this same thing, i.e. variable size field depending on another field. > ++------------------+-----------------------------------------------------------+ > + > +MISC_CONTROL_ACTION > +~~~~~~~~~~~~~~~~~~~ > + > +message_id: 0x5 > +protocol_id: 0x84 > + > ++------------------+-----------------------------------------------------------+ > +|Parameters | > ++------------------+-----------------------------------------------------------+ > +|Name |Description | > ++------------------+-----------------------------------------------------------+ > +|uint32 index |Index of the control | > ++------------------+-----------------------------------------------------------+ > +|uint32 action |Action for the control | > ++------------------+-----------------------------------------------------------+ > +|uint32 numarg |Size of the argument data, max 8 | > ++------------------+-----------------------------------------------------------+ > +|uint32 | | > +|arg[0, numarg -1] |Argument data array | > ++------------------+-----------------------------------------------------------+ > +|Return values | > ++------------------+-----------------------------------------------------------+ > +|Name |Description | > ++------------------+-----------------------------------------------------------+ > +|int32 status |SUCCESS: if the action was set successfully. | > +| |NOT_FOUND: if the index is not valid. | > +| |DENIED: if the agent does not have permission to get the | > +| |control | > ++------------------+-----------------------------------------------------------+ > +|uint32 num |Size of the return data in words, max 8 | > ++------------------+-----------------------------------------------------------+ > +|uint32 | | > +|val[0:num-1] |value data array | val[0, num - 1] ... for consistency > ++------------------+-----------------------------------------------------------+ > + > +MISC_DISCOVER_BUILD_INFO > +~~~~~~~~~~~~~~~~~~~~~~~~ > + > +This function is used to obtain the build commit, data, time, number. > + > +message_id: 0x6 > +protocol_id: 0x84 > + > ++------------------+-----------------------------------------------------------+ > +|Return values | > ++------------------+-----------------------------------------------------------+ > +|Name |Description | > ++------------------+-----------------------------------------------------------+ > +|int32 status |SUCCESS: if the build info was got successfully. | > +| |NOT_SUPPORTED: if the data is not available. | > ++------------------+-----------------------------------------------------------+ > +|uint32 buildnum |Build number | > ++------------------+-----------------------------------------------------------+ > +|uint32 buildcommit|Most significant 32 bits of the git commit hash | > ++------------------+-----------------------------------------------------------+ > +|uint8 date[16] |Date of build. Null terminated ASCII string of up to 16 | > +| |bytes in length | > ++------------------+-----------------------------------------------------------+ > +|uint8 time[16] |Time of build. Null terminated ASCII string of up to 16 | > +| |bytes in length | > ++------------------+-----------------------------------------------------------+ > + > +MISC_ROM_PASSOVER_GET > +~~~~~~~~~~~~~~~~~~~~~ > + > +ROM passover data is information exported by ROM and could be used by others. > +It includes boot device, instance, type, mode and etc. This function is used > +to obtain the ROM passover data. The returned block of words is structured as > +defined in the ROM passover section in the SoC RM. > + > +message_id: 0x7 > +protocol_id: 0x84 > + > ++------------------+-----------------------------------------------------------+ > +|Return values | > ++------------------+-----------------------------------------------------------+ > +|Name |Description | > ++------------------+-----------------------------------------------------------+ > +|int32 status |SUCCESS: if the data was got successfully. | > +| |NOT_SUPPORTED: if the data is not available. | > ++------------------+-----------------------------------------------------------+ > +|uint32 num |Size of the passover data in words, max 13 | > ++------------------+-----------------------------------------------------------+ > +|uint32_t | | > +|data[0:num-1] |Passover data array | > ++------------------+-----------------------------------------------------------+ > + data[0, num - 1] ... consistency Thanks, Cristian