Commit 5661df8f authored by Jaroslav Kysela's avatar Jaroslav Kysela

[ALSA] Fix typos in doc

Documentation
Fixed typos in the document by Kirill Smelkov <kirr@mns.spb.ru>
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent eac5f14a
...@@ -110,9 +110,9 @@ ...@@ -110,9 +110,9 @@
</para> </para>
<para> <para>
One is the the trees provided as a tarball or via cvs from the One is the trees provided as a tarball or via cvs from the
ALSA's ftp site, and another is the 2.6 (or later) Linux kernel ALSA's ftp site, and another is the 2.6 (or later) Linux kernel
tree. To synchronize both, the ALSA driver tree is split to tree. To synchronize both, the ALSA driver tree is split into
two different trees: alsa-kernel and alsa-driver. The former two different trees: alsa-kernel and alsa-driver. The former
contains purely the source codes for the Linux 2.6 (or later) contains purely the source codes for the Linux 2.6 (or later)
tree. This tree is designed only for compilation on 2.6 or tree. This tree is designed only for compilation on 2.6 or
...@@ -766,7 +766,7 @@ ...@@ -766,7 +766,7 @@
</para> </para>
<para> <para>
The ALSA interfaces like PCM or control API are define in other The ALSA interfaces like PCM or control API are defined in other
header files as <filename>&lt;sound/xxx.h&gt;</filename>. header files as <filename>&lt;sound/xxx.h&gt;</filename>.
They have to be included after They have to be included after
<filename>&lt;sound/core.h&gt;</filename>. <filename>&lt;sound/core.h&gt;</filename>.
...@@ -1103,7 +1103,7 @@ ...@@ -1103,7 +1103,7 @@
/* release the irq */ /* release the irq */
if (chip->irq >= 0) if (chip->irq >= 0)
free_irq(chip->irq, (void *)chip); free_irq(chip->irq, (void *)chip);
/* release the i/o ports */ /* release the i/o ports & memory */
pci_release_regions(chip->pci); pci_release_regions(chip->pci);
/* disable the PCI entry */ /* disable the PCI entry */
pci_disable_device(chip->pci); pci_disable_device(chip->pci);
...@@ -1314,6 +1314,7 @@ ...@@ -1314,6 +1314,7 @@
</para> </para>
<para> <para>
<!-- obsolete -->
It will reserve the i/o port region of 8 bytes of the given It will reserve the i/o port region of 8 bytes of the given
PCI device. The returned value, chip-&gt;res_port, is allocated PCI device. The returned value, chip-&gt;res_port, is allocated
via <function>kmalloc()</function> by via <function>kmalloc()</function> by
...@@ -1936,6 +1937,7 @@ ...@@ -1936,6 +1937,7 @@
snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE,
&snd_mychip_capture_ops); &snd_mychip_capture_ops);
/* pre-allocation of buffers */ /* pre-allocation of buffers */
/* NOTE: this may fail */
snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV, snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV,
snd_dma_pci_data(chip->pci), snd_dma_pci_data(chip->pci),
64*1024, 64*1024); 64*1024, 64*1024);
...@@ -1950,7 +1952,7 @@ ...@@ -1950,7 +1952,7 @@
<section id="pcm-interface-constructor"> <section id="pcm-interface-constructor">
<title>Constructor</title> <title>Constructor</title>
<para> <para>
A pcm instance is allocated <function>snd_pcm_new()</function> A pcm instance is allocated by <function>snd_pcm_new()</function>
function. It would be better to create a constructor for pcm, function. It would be better to create a constructor for pcm,
namely, namely,
...@@ -2235,7 +2237,8 @@ struct _snd_pcm_runtime { ...@@ -2235,7 +2237,8 @@ struct _snd_pcm_runtime {
unsigned char *dma_area; /* DMA area */ unsigned char *dma_area; /* DMA area */
dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */ dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
size_t dma_bytes; /* size of DMA area */ size_t dma_bytes; /* size of DMA area */
void *dma_private; /* private DMA data for the memory allocator */
struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE) #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
/* -- OSS things -- */ /* -- OSS things -- */
...@@ -2250,7 +2253,7 @@ struct _snd_pcm_runtime { ...@@ -2250,7 +2253,7 @@ struct _snd_pcm_runtime {
<para> <para>
For the operators (callbacks) of each sound driver, most of For the operators (callbacks) of each sound driver, most of
these records are supposed to be read-only. Only the PCM these records are supposed to be read-only. Only the PCM
middle-layer changes / updates these info. The excpetions are middle-layer changes / updates these info. The exceptions are
the hardware description (hw), interrupt callbacks the hardware description (hw), interrupt callbacks
(transfer_ack_xxx), DMA buffer information, and the private (transfer_ack_xxx), DMA buffer information, and the private
data. Besides, if you use the standard buffer allocation data. Besides, if you use the standard buffer allocation
...@@ -3250,7 +3253,7 @@ struct _snd_pcm_runtime { ...@@ -3250,7 +3253,7 @@ struct _snd_pcm_runtime {
<para> <para>
There are many different constraints. There are many different constraints.
Look in <filename>sound/asound.h</filename> for a complete list. Look in <filename>sound/pcm.h</filename> for a complete list.
You can even define your own constraint rules. You can even define your own constraint rules.
For example, let's suppose my_chip can manage a substream of 1 channel For example, let's suppose my_chip can manage a substream of 1 channel
if and only if the format is S16_LE, otherwise it supports any format if and only if the format is S16_LE, otherwise it supports any format
...@@ -4066,7 +4069,7 @@ struct _snd_pcm_runtime { ...@@ -4066,7 +4069,7 @@ struct _snd_pcm_runtime {
Both <function>snd_ac97_write()</function> and Both <function>snd_ac97_write()</function> and
<function>snd_ac97_update()</function> functions are used to <function>snd_ac97_update()</function> functions are used to
set a value to the given register set a value to the given register
(<constant>AC97_XXX</constant>). The different between them is (<constant>AC97_XXX</constant>). The difference between them is
that <function>snd_ac97_update()</function> doesn't write a that <function>snd_ac97_update()</function> doesn't write a
value if the given value has been already set, while value if the given value has been already set, while
<function>snd_ac97_write()</function> always rewrites the <function>snd_ac97_write()</function> always rewrites the
...@@ -4152,8 +4155,8 @@ struct _snd_pcm_runtime { ...@@ -4152,8 +4155,8 @@ struct _snd_pcm_runtime {
<title>Proc Files</title> <title>Proc Files</title>
<para> <para>
The ALSA AC97 interface will create a proc file such as The ALSA AC97 interface will create a proc file such as
<filename>/proc/asound/card0/ac97#0</filename> and <filename>/proc/asound/card0/codec97#0/ac97#0-0</filename> and
<filename>ac97#0regs</filename>. You can refer to these files to <filename>ac97#0-0+regs</filename>. You can refer to these files to
see the current status and registers of the codec. see the current status and registers of the codec.
</para> </para>
</section> </section>
...@@ -4633,7 +4636,7 @@ struct _snd_pcm_runtime { ...@@ -4633,7 +4636,7 @@ struct _snd_pcm_runtime {
where <parameter>size</parameter> is the byte size to be where <parameter>size</parameter> is the byte size to be
pre-allocated and the <parameter>max</parameter> is the maximal pre-allocated and the <parameter>max</parameter> is the maximal
size to be changed via <filename>prealloc</filename> proc file. size to be changed via <filename>prealloc</filename> proc file.
The allocator will try to get as the large area as possible The allocator will try to get as large area as possible
within the given size. within the given size.
</para> </para>
...@@ -4855,7 +4858,7 @@ struct _snd_pcm_runtime { ...@@ -4855,7 +4858,7 @@ struct _snd_pcm_runtime {
If your hardware supports the page table like emu10k1 or the If your hardware supports the page table like emu10k1 or the
buffer descriptors like via82xx, you can use the scatter-gather buffer descriptors like via82xx, you can use the scatter-gather
(SG) DMA. ALSA provides an interface for handling SG-buffers. (SG) DMA. ALSA provides an interface for handling SG-buffers.
The API is provided in <filename>&lt;sound/pcm_sgbuf.h&gt;</filename>. The API is provided in <filename>&lt;sound/pcm.h&gt;</filename>.
</para> </para>
<para> <para>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment