OSDN Git Service

pcm: fix wrong document references to PCM APIs which perform direct memory access...
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Sun, 11 Dec 2016 11:31:38 +0000 (20:31 +0900)
committerTakashi Iwai <tiwai@suse.de>
Mon, 12 Dec 2016 21:36:29 +0000 (22:36 +0100)
commitd008e1ac203dde67838effe43bd512d38bd92f24
tree030ead7a8115974609f4f3368d90c3f783a33b70
parent60b68cb47ed5da9b3c0adde04c69df2649feafe8
pcm: fix wrong document references to PCM APIs which perform direct memory access with frame copying

In a design of ALSA PCM interface, for PCM frame transmission to/from
kernel space, applications can select from two options; direct memory access
or ioctl(2). Available options are decided depending on device capacity and
machine architecture. Applications can get available options by the first
entry of 'struct snd_pcm_hw_params.masks'.

When the mask includes 'SNDRV_PCM_ACCESS_MMAP_xxx', applications can use
direct memory access. For this use case, userspace library has two types
of PCM API. One is to expose a pointer over the memory to start
reading/writing PCM frames. Another is to copy PCM frames between the
memory and a given buffer.

Current documentation includes wrong references to these APIs to describe
their advantages/disadvantages. This confuses application developers
because the references indicate PCM APIs to execute ioctl(2) operation to
read/write PCM frames.

This commit fixes the bug.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
src/pcm/pcm.c