Skip to content

Commit 372a0d7

Browse files
miquelraynaltiwai
authored andcommitted
ALSA: doc: Fix PCM interface section typos
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 <[email protected]> Reviewed-by: Takashi Sakamoto <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Takashi Iwai <[email protected]>
1 parent d8dc872 commit 372a0d7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Documentation/sound/kernel-api/writing-an-alsa-driver.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1720,16 +1720,16 @@ Typically, you'll have a hardware descriptor as below:
17201720
- ``rate_min`` and ``rate_max`` define the minimum and maximum sample
17211721
rate. This should correspond somehow to ``rates`` bits.
17221722

1723-
- ``channel_min`` and ``channel_max`` define, as you might already
1723+
- ``channels_min`` and ``channels_max`` define, as you might already
17241724
expected, the minimum and maximum number of channels.
17251725

17261726
- ``buffer_bytes_max`` defines the maximum buffer size in
17271727
bytes. There is no ``buffer_bytes_min`` field, since it can be
17281728
calculated from the minimum period size and the minimum number of
1729-
periods. Meanwhile, ``period_bytes_min`` and define the minimum and
1730-
maximum size of the period in bytes. ``periods_max`` and
1731-
``periods_min`` define the maximum and minimum number of periods in
1732-
the buffer.
1729+
periods. Meanwhile, ``period_bytes_min`` and ``period_bytes_max``
1730+
define the minimum and maximum size of the period in bytes.
1731+
``periods_max`` and ``periods_min`` define the maximum and minimum
1732+
number of periods in the buffer.
17331733

17341734
The “period” is a term that corresponds to a fragment in the OSS
17351735
world. The period defines the size at which a PCM interrupt is

0 commit comments

Comments
 (0)