From patchwork Tue Sep 6 11:30:34 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Robert Marko X-Patchwork-Id: 1674757 X-Patchwork-Delegate: trini@ti.com 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=2a01:238:438b:c500:173d:9f52:ddab:ee01; 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=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20210112 header.b=ZCN8u2vD; dkim-atps=neutral Received: from phobos.denx.de (phobos.denx.de [IPv6:2a01:238:438b:c500:173d:9f52:ddab:ee01]) (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 4MMPP96hz3z1yh5 for ; Tue, 6 Sep 2022 22:11:09 +1000 (AEST) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 34A6684A14; Tue, 6 Sep 2022 14:10:46 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com 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=gmail.com header.i=@gmail.com header.b="ZCN8u2vD"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 81F1B849AA; Tue, 6 Sep 2022 13:30:44 +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,FREEMAIL_FROM,SPF_HELO_NONE, SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-ed1-x533.google.com (mail-ed1-x533.google.com [IPv6:2a00:1450:4864:20::533]) (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 D580D849B9 for ; Tue, 6 Sep 2022 13:30:40 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=robimarko@gmail.com Received: by mail-ed1-x533.google.com with SMTP id 29so9640100edv.2 for ; Tue, 06 Sep 2022 04:30:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date; bh=I6R6iWwZqoZjON1RtstLU4QYFbOhYvszvnGDkuTB4ug=; b=ZCN8u2vDYZsTqBApc4D9QLH4z0xTaKO0F2bdanrkKJCNB6yBffAOn/tMCSMwoh2SGV LUUPHyxpeCasW8MwHs/72BgjNn73B0VbzVXrgg1HCz71M/X5IJZISEpP/7mV1Lownlv4 9YIuAIqU5MuV1AkQ7RGpV7AttjU0AgunfALSi8rfcJWI24WDcFmEragh76frtnPA8A+P Ec5ignFgW7EL0U6jPZQxgLwvD8fzh8LoTDW0LLBFObqWfgAs5SrKHRkX3Lwaj5Bw0rAM g4X03ziQEd7cz+HOipveEimdjU8LKcPoGSwVntwVLh7R5Q018eFFdMa011fdEjxGR+KU VAOQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; 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; bh=I6R6iWwZqoZjON1RtstLU4QYFbOhYvszvnGDkuTB4ug=; b=Vt5JsN4j/E2Az1zLsLUqb0M+8UW+2rSCeVocJXBlSHaGCEtD0Efjs4Z4GBmv/uA/6a ymFYRUc4mbq5CmJ5LuLgz3jFZwrJhmx5t/dZAAK37n+VBpYOFMFRxB2KOc7zVUN6JmfM C0i46anPzLXvts9e9mP4vGvSln3P9oDvhYO11NGQWpN8kcKzudMibkDnbeTWuPHkOp8t CIYBdakAgjcLJYB5ucXa19IT4a4pi4suYZlz91sIXVye5SzRMu5G1MeJ7SHb8fEPMWYX dyk+ibFRd6+Zvm7XmbVgIq31O9YFdXvFOMj04s5DxmBFSrSeSwbc1xqj2Xhy/TI8w2RN 9NMg== X-Gm-Message-State: ACgBeo0V+3fhnm970/CxCqR39NGHtbW8uiJGyOAZj0fX4l6sw+0DcAnW zBu6RwXHzz9zXWtRa68HFvY= X-Google-Smtp-Source: AA6agR6k6GQ2t9K8Kacnuey3tSyfsPmfdsGz1BpkEQNXgiSuHUkXXadVizLecN6AezdokP66XZ/NdA== X-Received: by 2002:aa7:db8b:0:b0:44e:5ce1:f29a with SMTP id u11-20020aa7db8b000000b0044e5ce1f29amr10247213edt.109.1662463840465; Tue, 06 Sep 2022 04:30:40 -0700 (PDT) Received: from fedora.. (dh207-96-48.xnet.hr. [88.207.96.48]) by smtp.googlemail.com with ESMTPSA id x68-20020a50baca000000b0044bfdbd8a33sm8310867ede.88.2022.09.06.04.30.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Sep 2022 04:30:40 -0700 (PDT) From: Robert Marko X-Google-Original-From: Robert Marko To: sjg@chromium.org, pali@kernel.org, u-boot@lists.denx.de, trini@konsulko.com Cc: luka.perkov@sartura.hr, Robert Marko Subject: [PATCH v3 2/4] doc: cmd: temperature: add documentation Date: Tue, 6 Sep 2022 13:30:34 +0200 Message-Id: <20220906113036.1768055-2-robert.marko@sartura.hr> X-Mailer: git-send-email 2.37.3 In-Reply-To: <20220906113036.1768055-1-robert.marko@sartura.hr> References: <20220906113036.1768055-1-robert.marko@sartura.hr> MIME-Version: 1.0 X-Mailman-Approved-At: Tue, 06 Sep 2022 14:10:39 +0200 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.6 at phobos.denx.de X-Virus-Status: Clean Add documentation for the temperature command. Signed-off-by: Robert Marko Reviewed-by: Simon Glass --- doc/usage/cmd/temperature.rst | 50 +++++++++++++++++++++++++++++++++++ doc/usage/index.rst | 1 + 2 files changed, 51 insertions(+) create mode 100644 doc/usage/cmd/temperature.rst diff --git a/doc/usage/cmd/temperature.rst b/doc/usage/cmd/temperature.rst new file mode 100644 index 0000000000..a5144ec50f --- /dev/null +++ b/doc/usage/cmd/temperature.rst @@ -0,0 +1,50 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +temperature command +=================== + +Synopsis +-------- + +:: + + temperature list + temperature get [thermal device name] + +Description +----------- + +The *temperature* command is used to list thermal sensors and get their +readings. + +The 'temperature list' command diplays the available thermal devices. + +The 'temperature get' command is used to get the reading in degrees C from +the desired device which is selected by passing its device name. + + thermal device name + device name of thermal sensor to select + +Example +------- + +:: + + + => temperature list + | Device | Driver | Parent + | tmon@610508110 | sparx5-temp | axi@600000000 + => + => temperature get tmon@610508110 + tmon@610508110: 42 C + +Configuration +------------- + +The *temperature* command is only available if CONFIG_CMD_TEMPERATURE=y. + +Return value +------------ + +The return value $? is set to 0 (true) if the command succeeded and to 1 (false) +otherwise. diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 28f9683a3e..92967efdd2 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -63,6 +63,7 @@ Shell commands cmd/scp03 cmd/setexpr cmd/size + cmd/temperature cmd/true cmd/ums cmd/wdt