u-boot/doc/usage/cmd/sound.rst
Tom Rini 11da3403e9 doc: usage: Add general rule for $?
For nearly all commands in U-Boot the '?' variable is handled the same
way with 0 meaning success, 1 meaning any failure.  Explain this in the
general rules section of the cmdline documentation (with a link to a
counter example) and then remove the redundant wording from most
commands. We retain a section about the return value in a number of
places where we are doing something such as always returning a specific
value or we have useful additional information to go along with the
normal return codes.

Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-10-26 09:03:35 -06:00

59 lines
964 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+
.. Copyright 2022, Heinrich Schuchardt <xypron.glpk@gmx.de>
.. index::
single: sound (command)
sound command
=============
Synopsis
--------
::
sound init
sound play [[len freq] ...] [len [freq]]
Description
-----------
The *sound* command is used to play one or multiple beep sounds.
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
Examples
--------
Beep at 400 Hz for 1000 ms::
sound play
Beep at 400 Hz for 600 ms::
sound play 600
Beep at 500 Hz for 600 ms::
sound play 600 500
Play melody::
sound play 500 1047 500 880 500 0 500 1047 500 880 500 0 500 784 500 698 500 784 1000 698
Configuration
-------------
The sound command is enabled by CONFIG_CMD_SOUND=y.