diff options
author | Tom Rini <trini@konsulko.com> | 2022-12-06 10:07:01 -0500 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2022-12-06 10:07:01 -0500 |
commit | 14f2d087a3d6347ba0ff7a7e9aaff6955e53e7a8 (patch) | |
tree | bc4677f00c57b7ff42a0852a50d213266896e68a /doc | |
parent | 1c470f32f74248ff4aa145bf033fb6524dc7fc2e (diff) | |
parent | 304bc9f437df51b4d982fe25fd0988350c8f5fc9 (diff) | |
download | u-boot-14f2d087a3d6347ba0ff7a7e9aaff6955e53e7a8.tar.gz u-boot-14f2d087a3d6347ba0ff7a7e9aaff6955e53e7a8.tar.bz2 u-boot-14f2d087a3d6347ba0ff7a7e9aaff6955e53e7a8.zip |
Merge tag 'sound-2023-01-rc4' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request for sound-2023-01-rc4
* Avoid endless loop and amend unit test
* Add man-page for the sound command
* Fix sandbox sound driver
Diffstat (limited to 'doc')
-rw-r--r-- | doc/usage/cmd/sound.rst | 41 | ||||
-rw-r--r-- | doc/usage/index.rst | 1 |
2 files changed, 42 insertions, 0 deletions
diff --git a/doc/usage/cmd/sound.rst b/doc/usage/cmd/sound.rst new file mode 100644 index 0000000000..d3fac243b1 --- /dev/null +++ b/doc/usage/cmd/sound.rst @@ -0,0 +1,41 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright 2022, Heinrich Schuchardt <xypron.glpk@gmx.de> + +sound command +============= + +Synopsis +-------- + +:: + + sound init + sound play [len [freq]] + +Description +----------- + +The *sound* command is used to play a beep sound. + +sound init + initializes the sound driver. + +sound play + plays a square wave sound. It does not depend on previously calling + *sound init*. + +len + duration of the sound in ms, defaults to 1000 ms + +freq + frequency of the sound in Hz, defaults to 400 Hz + +Configuration +------------- + +The sound command is enabled by CONFIG_CMD_SOUND=y. + +Return value +------------ + +The return value $? is 0 (true) if the command succeeds, 1 (false) otherwise. diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 0bc82887e9..bbd40a6e18 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -73,6 +73,7 @@ Shell commands cmd/scp03 cmd/setexpr cmd/size + cmd/sound cmd/temperature cmd/tftpput cmd/true |