kernel/linux.git/Documentation/sound/kernel-api, branch v6.19.11

ALSA: docs: Drop snd_print*() stuff

2024-08-08T05:49:47+00:00

The legacy snd_print*() helpers will be dropped now. Clean up the corresponding documentation, too. Reviewed-by: Jaroslav Kysela Signed-off-by: Takashi Iwai Link: https://patch.msgid.link/20240807133452.9424-54-tiwai@suse.de

ALSA: docs: Correct the kernel object suffix of target

2024-05-08T16:15:32+00:00

The correct suffix is 'y' for the kernel code and 'objs' for the user space. Update documentation. Signed-off-by: Andy Shevchenko Link: https://lore.kernel.org/r/20240506085219.3403731-1-andriy.shevchenko@linux.intel.com Signed-off-by: Takashi Iwai

ALSA: doc: Use DEFINE_SIMPLE_DEV_PM_OPS()

2024-02-12T10:50:26+00:00

Use the new DEFINE_SIMPLE_DEV_PM_OPS() instead of SIMPLE_DEV_PM_OPS() for the example code. This allows us to drop CONFIG_PM_SLEEP ifdefs. While we're at it, expand the driver definition instead of passing directly via .driver.pm field. This seems to be a more common pattern. Signed-off-by: Takashi Iwai Link: https://lore.kernel.org/r/20240207155140.18238-30-tiwai@suse.de Signed-off-by: Takashi Iwai

ALSA: doc: Update description for the new PCM copy ops

2023-08-18T10:19:19+00:00

Update the documentation about the PCM copy callbacks. The update was kept minimalistic, just correcting the use of copy_user ops with the single copy ops, and drop/update the text mentioning the copy_kernel. Link: https://lore.kernel.org/r/20230815190136.8987-24-tiwai@suse.de Signed-off-by: Takashi Iwai

ALSA: docs: Fix code block indentation in ALSA driver example

2023-05-03T06:08:25+00:00

Sphinx reports htmldocs warnings: Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3997: WARNING: Literal block expected; none found. Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4004: WARNING: Literal block expected; none found. Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4009: WARNING: Unexpected indentation. Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4035: WARNING: Literal block expected; none found. These are due to indentation of example driver snippets which is outside the code block scope. Fix these by indenting code blocks in question to the scope. Fixes: 4d421eebe1465d ("ALSA: docs: writing-an-alsa-driver.rst: polishing") Reported-by: kernel test robot Closes: https://lore.kernel.org/linux-doc/202305021822.4U6XOvGf-lkp@intel.com/ Signed-off-by: Bagas Sanjaya Link: https://lore.kernel.org/r/20230503035416.62722-1-bagasdotme@gmail.com Signed-off-by: Takashi Iwai

ALSA: docs: writing-an-alsa-driver.rst: polishing

2023-04-21T14:47:18+00:00

- Update some outdated info - Language fixes - Whitespace/formatting fixes - Prefer attached over stand-alone '::' [ dropped a trailing white space in the patch -- tiwai ] Signed-off-by: Oswald Buddenhagen Link: https://lore.kernel.org/r/20230421112751.990244-1-oswald.buddenhagen@gmx.de Signed-off-by: Takashi Iwai

ALSA: pcm: rewrite snd_pcm_playback_silence()

2023-04-21T10:21:04+00:00

The auto-silencer supports two modes: "thresholded" to fill up "just enough", and "top-up" to fill up "as much as possible". The two modes used rather distinct code paths, which this patch unifies. The only remaining distinction is how much we actually want to fill. This fixes a bug in thresholded mode, where we failed to use new_hw_ptr, resulting in under-fill. Top-up mode is now more well-behaved and much easier to understand in corner cases. This also updates comments in the proximity of silencing-related data structures. Signed-off-by: Oswald Buddenhagen Reviewed-by: Jaroslav Kysela Link: https://lore.kernel.org/r/20230420113324.877164-1-oswald.buddenhagen@gmx.de Signed-off-by: Takashi Iwai

ALSA: docs: A few more words for PCM XRUN handling and stream locks

2023-03-24T13:52:59+00:00

Enhance the documents about the PCM, missing descriptions for a couple of helpers like snd_pcm_period_elapsed_under_stream_lock() and snd_pcm_stop_xrun(). Link: https://lore.kernel.org/r/20230323065237.5062-4-tiwai@suse.de Signed-off-by: Takashi Iwai

ALSA: docs: Add description about ack callback -EPIPE error handling

2023-03-24T13:52:58+00:00

Add a brief description about the newly added behavior of the PCM ack callback with -EPIPE error. Link: https://lore.kernel.org/r/20230323065237.5062-3-tiwai@suse.de Signed-off-by: Takashi Iwai

ALSA: doc: Fix PCM interface section typos

2023-01-31T08:35:40+00:00

Fix two mistakes in the PCM interface section: 1/ Members of the snd_pcm_hardware structure are channels_{min,max} and not channel_{min,max} (mind the 's'). 2/ Another sentence is incomplete as the reference to one structure member (period_bytes_max) is missing. There is no relevant 'Fixes:' tag to apply as both typos predate the Git era. Signed-off-by: Miquel Raynal Reviewed-by: Takashi Sakamoto Link: https://lore.kernel.org/r/20230130162924.119389-1-miquel.raynal@bootlin.com Signed-off-by: Takashi Iwai