redonkable/alistair23-linux
redonkable/alistair23-linux
1
0
Fork 0
Code Releases Activity

ALSA: docs: Remove snd_dma_pci_data() usage in documentation

Browse source 
The macro will be removed soon later, so update the documentation to
reflect that as well.

Link: https://lore.kernel.org/r/20191105151856.10785-25-tiwai@suse.de
Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Takashi Iwai 2019-11-05 16:18:56 +01:00
parent 6974f8ad44
commit b65f131b8f
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1383,7 +1383,7 @@ shows only the skeleton, how to build up the PCM interfaces.
/* pre-allocation of buffers */ /* pre-allocation of buffers */
/* NOTE: this may fail */ /* 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), &chip->pci->dev,
64*1024, 64*1024); 64*1024, 64*1024);
return 0; return 0;
} }
@ -1470,7 +1470,7 @@ buffer. For the pre-allocation, simply call the following:
:: ::
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), &chip->pci->dev,
64*1024, 64*1024); 64*1024, 64*1024);
It will allocate a buffer up to 64kB as default. Buffer management It will allocate a buffer up to 64kB as default. Buffer management
@ -3514,7 +3514,7 @@ bus).
:: ::
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(pci), size, max); &pci->dev, size, max);
where ``size`` is the byte size to be pre-allocated and the ``max`` is where ``size`` is the byte size to be pre-allocated and the ``max`` is
the maximum size to be changed via the ``prealloc`` proc file. The the maximum size to be changed via the ``prealloc`` proc file. The
@ -3700,14 +3700,14 @@ For creating the SG-buffer handler, call
:c:func:`snd_pcm_lib_preallocate_pages()` or :c:func:`snd_pcm_lib_preallocate_pages()` or
:c:func:`snd_pcm_lib_preallocate_pages_for_all()` with :c:func:`snd_pcm_lib_preallocate_pages_for_all()` with
``SNDRV_DMA_TYPE_DEV_SG`` in the PCM constructor like other PCI ``SNDRV_DMA_TYPE_DEV_SG`` in the PCM constructor like other PCI
pre-allocator. You need to pass ``snd_dma_pci_data(pci)``, where pci is pre-allocator. You need to pass ``&pci->dev``, where pci is
the :c:type:`struct pci_dev <pci_dev>` pointer of the chip as the :c:type:`struct pci_dev <pci_dev>` pointer of the chip as
well. well.
:: ::
snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV_SG, snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
snd_dma_pci_data(pci), size, max); &pci->dev, size, max);
The ``struct snd_sg_buf`` instance is created as The ``struct snd_sg_buf`` instance is created as
``substream->dma_private`` in turn. You can cast the pointer like: ``substream->dma_private`` in turn. You can cast the pointer like: