docs/audio_tone: Add documentation about the audio tone driver

This commit adds some documentation about the audio tone driver, how to
use it and links to it from the main audio component page. I also added
some back links to other audio docs there for convenience.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
This commit is contained in:
Matteo Golin 2026-07-12 17:31:31 -04:00 committed by Xiang Xiao
parent 29c5ae62ad
commit c15a3bfc97
2 changed files with 44 additions and 0 deletions

View file

@ -119,3 +119,9 @@ Related Subdirectories
* ``drivers/audio`` - Contains the lower-level device specific drivers.
* ``apps/system/nxplayer`` - User-mode audio subsystem interface library.
Related Pages
=============
* :doc:`/components/drivers/special/audio`
* :doc:`/applications/audioutils/index`

View file

@ -4,3 +4,41 @@ Audio Device Drivers
See ``include/nuttx/audio/audio.h`` for interface definitions.
See also the audio subsystem at ``nuttx/audio/``.
Audio Tone
----------
This driver has an interfaces which accepts a PWM lower-half and a oneshot timer
lower-half. Its features are enabled by ``CONFIG_AUDIO_TONE=y`` You can register
a tone driver as follows:
.. code:: c
#include <nuttx/audio/tone.h>
#include <nuttx/timers/pwm.h>
/* Somewhere later in the code */
int err;
struct pwm_lowerhalf_s *pwm; /* Assume initialized */
struct oneshot_lowerhalf_s *oneshot; /* Assume initialized */
/* Here, the argument '1' is the PWM channel to use */
err = tone_register("/dev/tone0", pwm, 1, oneshot);
if (err < 0)
{
syslog(LOG_ERR, "Couldn't register /dev/tone0: %d\n", err);
}
The PWM interface generates the tone output, and the one-shot driver is used to
get the timing of musical notes correct.
If you want to try playing sound after the device is registered, you can write
`Music Macro Language (MML)
<https://en.wikipedia.org/wiki/Music_Macro_Language>`_ to the character driver.
For example, here is how you would play Ode to Joy:
.. code:: console
nsh> echo "L8eefggfedccdeL6eL16dL4d" > /dev/tone0