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 phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 8945EEB64D9 for ; Mon, 3 Jul 2023 01:19:56 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id A029C86362; Mon, 3 Jul 2023 03:19:54 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="FlDo+0WJ"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 5665E86366; Mon, 3 Jul 2023 03:19:52 +0200 (CEST) Received: from mail-pj1-x102e.google.com (mail-pj1-x102e.google.com [IPv6:2607:f8b0:4864:20::102e]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 7233586346 for ; Mon, 3 Jul 2023 03:19:49 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=takahiro.akashi@linaro.org Received: by mail-pj1-x102e.google.com with SMTP id 98e67ed59e1d1-262c8746f08so500163a91.0 for ; Sun, 02 Jul 2023 18:19:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1688347188; x=1690939188; h=in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date:from:to:cc :subject:date:message-id:reply-to; bh=O//b6hlVWjRjK80+k0dx6uObWUl6rfiJlCVD4pVuPKg=; b=FlDo+0WJGxiLuGj6RSDT9B8w+XKFsrBsx2hlxFMBabEClHO9NF/TuSHxCuQqi/1fQk j0/Uv3gpC111/b3VNgxGnz7DcDY/UqQF4J7dDm2MbJE4IBQsqESL97UqT7Jlxxn8OFG4 369vKt0FwjqvcBRmVngft+xHyiYYZ75mbsMc151AGLx+zWITyPj4IStNFL4ILX9bM5ok SVo8lCg7IjC8y602yDXtGuTi619LJ7P9vM5VzCQotaaYlK+PivkWv3X3mH97/CVma94w Ff38V6eZezbK0CK4uKRbSojShhOwNRk7e+snY9S9eMDqFSnObF0qsZ5oXx1MJIb3scoj B9AQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1688347188; x=1690939188; h=in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=O//b6hlVWjRjK80+k0dx6uObWUl6rfiJlCVD4pVuPKg=; b=IrKF3B64MdnJVoggganrmhxLufjlnmt9K5m8sQUTumTwziYtH+Irpknao4f8FPuCKC Zw2Jq9OfUSxPxTRK/SkuOaPjQTVHra5qRdMVCMrTLDBKZQrUaykaSCgv80FcYCTz1zoK G09pgLS2o7d8TNigl7SW4INfJmdsQMV42DLX/T32jTrfOT1xCNkiA7kVBQzvqNwsWZm6 gZ+VixaleBfYXeu/GYpXXiTvB08x1Ml/oQ9P/0B/eUKDRNe8cYU8Ic4QHtPfd3GkYeoz RoxeG+I2SdhVR1wUtlTs9eY4nr8I97zVme6diTp7So5J8J/i8N7VMUS1ie+QSANc86d1 vv/A== X-Gm-Message-State: ABy/qLYynrc9YteDZbwWnfUywFoLE/ps00sYhxQmDTjd8xOK4FJuH5lv kxISIqQVQluU6tVxQ0lQRsgmCw== X-Google-Smtp-Source: APBJJlERlQeZoI1V1pIRao5jsQBt1hnZuKgXa6sDTH5XiMosi+pbBWEQ2xR7BhraQqP0VqNbVSHDgw== X-Received: by 2002:a17:903:94:b0:1ac:40f7:8b5a with SMTP id o20-20020a170903009400b001ac40f78b5amr9540270pld.3.1688347187734; Sun, 02 Jul 2023 18:19:47 -0700 (PDT) Received: from laputa ([2400:4050:c3e1:100:b349:4abf:f4cb:7486]) by smtp.gmail.com with ESMTPSA id c14-20020a170902d48e00b001b02df0ddbbsm5780584plg.275.2023.07.02.18.19.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 02 Jul 2023 18:19:46 -0700 (PDT) Date: Mon, 3 Jul 2023 10:19:43 +0900 From: AKASHI Takahiro To: Simon Glass Cc: trini@konsulko.com, etienne.carriere@st.com, u-boot@lists.denx.de Subject: Re: [PATCH 09/10] doc: cmd: add documentation for scmi Message-ID: Mail-Followup-To: AKASHI Takahiro , Simon Glass , trini@konsulko.com, etienne.carriere@st.com, u-boot@lists.denx.de References: <20230628004841.21774-1-takahiro.akashi@linaro.org> <20230628004841.21774-10-takahiro.akashi@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.8 at phobos.denx.de X-Virus-Status: Clean On Thu, Jun 29, 2023 at 08:10:02PM +0100, Simon Glass wrote: > Hi AKASHI, > > On Wed, 28 Jun 2023 at 01:49, AKASHI Takahiro > wrote: > > > > This is a help text for scmi command. > > > > Signed-off-by: AKASHI Takahiro > > --- > > doc/usage/cmd/scmi.rst | 98 ++++++++++++++++++++++++++++++++++++++++++ > > 1 file changed, 98 insertions(+) > > create mode 100644 doc/usage/cmd/scmi.rst > > > > diff --git a/doc/usage/cmd/scmi.rst b/doc/usage/cmd/scmi.rst > > new file mode 100644 > > index 000000000000..20cdae4b877d > > --- /dev/null > > +++ b/doc/usage/cmd/scmi.rst > > @@ -0,0 +1,98 @@ > > +.. SPDX-License-Identifier: GPL-2.0+: > > + > > +scmi command > > +============ > > + > > +Synopsis > > +-------- > > + > > +:: > > + > > + scmi base info > > + scmi base perm_dev > > + scmi base perm_proto > > + scmi base reset > > + > > +Description > > +----------- > > + > > +The scmi command is used to access and operate on SCMI server. > > + > > +scmi base info > > +~~~~~~~~~~~~~~ > > + Show base information about SCMI server and supported protocols > > + > > +scmi base perm_dev > > +~~~~~~~~~~~~~~~~~~ > > + Allow or deny access permission to the device > > + > > +scmi base perm_proto > > +~~~~~~~~~~~~~~~~~~~~ > > + Allow or deny access to the protocol on the device > > + > > +scmi base reset > > +~~~~~~~~~~~~~~~ > > + Reset the existing configurations > > + > > +Parameters are used as follows: > > + > > + > > + Agent ID > > what is this? I thought that the meaning was trivial in SCMI context. Will change it to "SCMI Agent ID". > > + > > + > > + Device ID > > what is this? Again, will change it to "SCMI Device ID". > > + > > + > > + Protocol ID, should not be 0x10 (base protocol) > > what is this? Please add more detail Again, will change it to "SCMI Protocol ID". I think that users should be familiar with those terms if they want to use these interfaces. > > + > > + > > + Flags to control the action. See SCMI specification for > > + defined values. > > ? > > Please add the flags here, or at the very least provide a URL and page > number, etc. I intentionally avoid providing details here because a set of flags acceptable to a specific SCMI server may depend on the server and its implementation version. The interface on U-Boot is just a wrapper to make a call to SCMI server via a transport layer and doesn't care what the parameters means. That said, I agree to referring to a URL to SCMI specification somewhere in this document. Thanks, -Takahiro Akashi > > + > > +Example > > +------- > > + > > +Obtain basic information about SCMI server: > > + > > +:: > > + > > + => scmi base info > > + SCMI device: scmi > > + protocol version: 0x20000 > > + # of agents: 3 > > + 0: platform > > + > 1: OSPM > > + 2: PSCI > > + # of protocols: 4 > > + Power domain management > > + Performance domain management > > + Clock management > > + Sensor management > > + vendor: Linaro > > + sub vendor: PMWG > > + impl version: 0x20b0000 > > + > > +Ask for access permission to device#0: > > + > > +:: > > + > > + => scmi base perm_dev 1 0 1 > > + > > +Reset configurations with all access permission settings retained: > > + > > +:: > > + > > + => scmi base reset 1 0 > > + > > +Configuration > > +------------- > > + > > +The scmi command is only available if CONFIG_CMD_SCMI=y. > > +Default n because this command is mainly for debug purpose. > > + > > +Return value > > +------------ > > + > > +The return value ($?) is set to 0 if the operation succeeded, > > +1 if the operation failed or -1 if the operation failed due to > > +a syntax error. > > -- > > 2.41.0 > > > > Regards, > Simon