diff options
author | Robert Marko <robimarko@gmail.com> | 2022-09-06 14:30:34 +0300 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2022-10-11 22:40:48 +0300 |
commit | 0995e81e10c10fda32c6dec350d14473d6d1d23e (patch) | |
tree | a3c5146f44de44e22a9a3652ea27947101f8b927 /doc/usage/cmd | |
parent | 7f673bb8f52894eec641b287d9bb19fa603142c6 (diff) | |
download | u-boot-0995e81e10c10fda32c6dec350d14473d6d1d23e.tar.xz |
doc: cmd: temperature: add documentation
Add documentation for the temperature command.
Signed-off-by: Robert Marko <robert.marko@sartura.hr>
Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc/usage/cmd')
-rw-r--r-- | doc/usage/cmd/temperature.rst | 50 |
1 files changed, 50 insertions, 0 deletions
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. |