From patchwork Wed Jun 28 00:48:40 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 1800833 X-Patchwork-Delegate: sjg@chromium.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=85.214.62.61; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.a=rsa-sha256 header.s=google header.b=OUIigxR4; dkim-atps=neutral Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4QrNM85k9xz20bH for ; Wed, 28 Jun 2023 10:51:48 +1000 (AEST) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id B6A9B8660F; Wed, 28 Jun 2023 02:51:20 +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="OUIigxR4"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 9240D86607; Wed, 28 Jun 2023 02:50:23 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-pl1-x62a.google.com (mail-pl1-x62a.google.com [IPv6:2607:f8b0:4864:20::62a]) (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 EC1C58661C for ; Wed, 28 Jun 2023 02:49:50 +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-pl1-x62a.google.com with SMTP id d9443c01a7336-1b8130e0ac6so3019635ad.1 for ; Tue, 27 Jun 2023 17:49:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1687913389; x=1690505389; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=o2/W/WeS6uFl1UoXejk4UI9prfCv7n3Y5G853Rg0tSE=; b=OUIigxR4T9aoLVEMxhfHbN+AITdBJIwt17sSC+eH5LrFOq86pe1TN8/o2eznfcQguJ j12mG/LgZVYEfJv3SbcUxxvt13s4oaH6rgU//9sEec+G/8SsotPub7y6i2qF+YV0Bedr ZmPm9PlDrSRzZC0E+chLLxkw7yDKdAHpvGdKrq5DNaL9ZYzrgn0u/RVLmWBIMBG9n5eG m49UuS4fT3qfozee84Tfp58gHKagDzui7mjLqS1mOVWcyGG10g12auYF1ncewXu9uzLC JwBiv0i9FveljBKCZ2Lq+Q0bQdUzJJ/Q83kKc8ptUbBUr3DX80WTQgBaXUm4wf2fTNMG 08oQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1687913389; x=1690505389; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=o2/W/WeS6uFl1UoXejk4UI9prfCv7n3Y5G853Rg0tSE=; b=g6JGo0rZA4RXjWOz0H8CbDsY3Gi1XXDrFJtFLWrmiC49Z9KX68es9csQEs+J7b05v/ 6n6EVWTqH2HfTZFHTAIMj6UhK5vbFz/z7HXCbaWstWfk4Rb55Jcx16Wq345YNc2zmvWT tsx/oy+J1GiAHLJxO48+A4u4L2pRgIPL++5UgiJKwMdC4dJNhci7YS3CmXqK0fYKue6F pCFSS7uGVQpgkBGk8eXCyjj4EJMz/dz/CRNEqTz4xNVWHV+8EghrBr4ZXmG/HyHSZTEC Wngg9OViyPBvK/+8Qr9/RoyJ7L2HH/yPVoZ5KJ4c8fwmmPVZGvud0LaoiM5uw4E7Uplt 6Bbg== X-Gm-Message-State: AC+VfDx4UDxpcY68dw+m8kI9gZxzZ43POlu5s91sGzKbORs5ha/8PF8w UO97Kzp/zdzcatsdNESz86BquA== X-Google-Smtp-Source: ACHHUZ6cUmeIHH9BHdGc1DbZztRLC6LUNsALGcZuoTxjS9cRcM1/cN9ixQL1hRQaZitRmU6ASrNhDQ== X-Received: by 2002:a17:903:104c:b0:1b3:d4bb:3515 with SMTP id f12-20020a170903104c00b001b3d4bb3515mr3470639plc.0.1687913389260; Tue, 27 Jun 2023 17:49:49 -0700 (PDT) Received: from laputa.. ([2400:4050:c3e1:100:58b2:60ed:38ea:8b1f]) by smtp.gmail.com with ESMTPSA id u13-20020a170903124d00b001b3fb2f0296sm6517278plh.120.2023.06.27.17.49.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Jun 2023 17:49:49 -0700 (PDT) From: AKASHI Takahiro To: trini@konsulko.com, sjg@chromium.org Cc: etienne.carriere@st.com, u-boot@lists.denx.de, AKASHI Takahiro Subject: [PATCH 09/10] doc: cmd: add documentation for scmi Date: Wed, 28 Jun 2023 09:48:40 +0900 Message-ID: <20230628004841.21774-10-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230628004841.21774-1-takahiro.akashi@linaro.org> References: <20230628004841.21774-1-takahiro.akashi@linaro.org> MIME-Version: 1.0 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 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 + + + Device ID + + + Protocol ID, should not be 0x10 (base protocol) + + + Flags to control the action. See SCMI specification for + defined values. + +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.