summaryrefslogtreecommitdiff
path: root/Documentation/sound
AgeCommit message (Collapse)AuthorFilesLines
2016-11-10ALSA: doc: ReSTize OSS-Emulation documentTakashi Iwai2-69/+101
A simple conversion from a text file. Put to designs subdirectory. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize Channel-Mapping-API documentTakashi Iwai2-33/+45
A simple conversion from a text file. Put to designs subdirectory. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize powersave documentTakashi Iwai2-7/+10
A simple conversion from a text file. Put into designs subdirectory, although it's mostly relevant with HD-audio. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize Procfile documentTakashi Iwai3-51/+63
A simple conversion from a text file. A new subidrectory, Documentation/sound/designs, was created to put this document. The other API design and implementation docuemnts will be put to that directory in later commits. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize ALSA-Configuration documentTakashi Iwai3-2330/+2684
A simple conversion from the text file. Since this is the only document specific to the configurations, it's put to the root sound subdirectory. A section describing the obsoleted configure stuff of old alsa-driver tarball got removed. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize HD-Audio-DP-MST-audio.txtTakashi Iwai2-10/+21
A simple conversion from a plain text file. Put to hd-audio subdirectory. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize HD-Audio-Controls documentTakashi Iwai2-14/+20
A conversion from a simple text file. Put to hd-audio subdirectory with a rename. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize HD-Audio-Models documentTakashi Iwai3-324/+519
A simple reformat with the description list of ReST, and the content was kept as is, but renamed as Documentation/sound/hd-audio/models.rst. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize HD-Audio documentTakashi Iwai3-304/+339
The original HD-Audio.txt was already in asciidoc format, so it's a simple conversion in the end. A new subdirectory, Documentation/sound/hd-audio, is created and the document is moved there with another file name to match better with the recent Documentation tree structure. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize writing-an-alsa-driver documentTakashi Iwai2-0/+4220
Another simple conversion from DocBook to ReST. This required a few manual fixups and reformats, but the most of contents are kept as is. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: ReSTize alsa-driver-api documentTakashi Iwai3-0/+156
A simple conversion of alsa-driver-api document from DocBook to ReST. It's moved to the new Documentation/sound/kernel-api subdirectory that will contain other ALSA kernel API documents. The GPL legal note was removed, as it's superfluous (and doesn't fit with ReST kernel docs pretty well). Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10ALSA: doc: Remove alsa-parameters.txtTakashi Iwai1-135/+0
This is a really obsoleted information, effectively just listing the module names. Let's get rid of it for avoiding confusions. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-10-26ASoC: Codec to codec dai link descriptionanish kumar1-0/+103
Signed-off-by: anish kumar <yesanishhere@gmail.com> Acked-by: Charles Keepax <ckeepax@opensource.wolfsonmicro.com> Signed-off-by: Mark Brown <broonie@kernel.org>
2016-10-24docs: fix locations of several documents that got movedMauro Carvalho Chehab2-2/+2
The previous patch renamed several files that are cross-referenced along the Kernel documentation. Adjust the links to point to the right places. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-26Merge tag 'asoc-v4.8' of ↵Takashi Iwai1-1/+1
git://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound into for-linus ASoC: Updates for v4.8 Not really any framework work this time around (though we have seen one of the Analog Devices drivers move more to the clock API which is good to see) but rather a lot of new drivers: - Lots of updates for the Intel drivers, mostly board support and bug fixing, and to the NAU8825 driver. - Work on generalizing bits of simple-card to allow more code sharing with the Renesas rsrc-card (which can't use simple-card due to DPCM). - Removal of the Odroid X2 driver due to replacement with simple-card. - Support for several new Mediatek platforms and associated boards. - New drivers for Allwinner A10, Analog Devices ADAU7002, Broadcom Cygnus, Cirrus Logic CS35L33 and CS53L30, Maxim MAX8960 and MAX98504, Realtek RT5514 and Wolfson WM8758
2016-07-11ALSA - hda: Fix timestamping documentationVinod Koul1-6/+6
Some typos in the documentation, so fix them up. Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-30ASoC: dt: Fix typoAndrea Gelmini1-1/+1
Signed-off-by: Andrea Gelmini <andrea.gelmini@gelma.net> Signed-off-by: Mark Brown <broonie@kernel.org>
2016-05-08ALSA: compress: fix some typoVinod Koul1-1/+1
Noticed two typos in Documentation, so fix them up Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-04-25ALSA: doc: fix spelling mistakesEric Engestrom3-3/+3
Signed-off-by: Eric Engestrom <eric@engestrom.ch> Acked-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-04-12ALSA: hda - Update documentationTakashi Iwai1-18/+8
Update the URLs for alsa-info.sh and hda-emu. Also drop the alsa-driver snapshot URL since it's been discontinued recently. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-04-08ALSA: Fix a typo in timestamping.txtMasanari Iida1-1/+1
This patch fix a spelling typo found in Documentation/sound/alsa/timestamping.txt Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-02-10Merge branch 'topic/hda-mst' into for-nextTakashi Iwai1-0/+74
2016-01-29ALSA: doc: Update option descriptions for snd-usb-audioTakashi Iwai1-0/+9
The autoclock and quirk_alias options have been added. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-01-29ALSA: Add documentation about HD-audio DP MSTLibin Yang1-0/+74
Add the documentation about HD-audio DP MST: 1. Overview 2. Jack Others will be added later. Signed-off-by: Libin Yang <libin.yang@linux.intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-11-16ASoC: img: Add documentation for SPDIF in controlsDamien.Horsley1-0/+49
Add documentation for the controls present in the SPDIF input controller driver Signed-off-by: Damien.Horsley <Damien.Horsley@imgtec.com> Signed-off-by: Mark Brown <broonie@kernel.org>
2015-10-17ALSA: hda - Remove obsoleted documentationTakashi Iwai1-322/+0
It's totally outdated. We need a revised version later, maybe better integrated into kernel doc. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-06-09Doc: sound:oss: Fix typo in sound/ossMasanari Iida3-3/+3
This patch fix some spelling typo found in Documentations/sound/oss. Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-05-19ALSA: hda - Sync HD-Audio-Models.txt for Realtek codecsTakashi Iwai1-2/+10
Added missing model entries and updated the codec names. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-05-19ALSA: hda - Add headset-mode* model options for ALC269 & coTakashi Iwai1-0/+2
Modern machines tend to have only one headset jack nowadays, and they often need these quirks. Let's allow them applicable via model option for ease of debugging. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-04-27ALSA: Docs: Add documentation for Jack kcontrolsJie Yang1-0/+43
Add documentation describing Jack kcontrols and how to use them with HD-Audio and ASoC. Signed-off-by: Jie Yang <yang.jie@intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-04-13Merge tag 'asoc-v4.1-2' of ↵Takashi Iwai1-5/+5
git://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound into for-linus ASoC: Updates for v4.1 More updates for v4.1, pretty much all drivers: - Lots of cleanups from Lars, mainly moving things from the CODEC level to the card level. - Continuing improvements to rcar from Morimoto-san, pcm512x from Howard and Peter, the Intel platforms from Vinod, Jie, Jin and Han, and to rt5670 from Bard. - Support for some non-DSP Qualcomm platforms, Google's Storm platform, Maxmim MAX98925 CODECs and the Ingenic JZ4780 SoC.
2015-03-21ALSA: ControlName.txt: Add 'Analogue' as a prefix for volume controlsHoward Mitchell1-5/+5
Currently 'Playback Volume' is the correct way to express an analogue volume control. However, this control name has initialisation defaults applied when using 'alsactl restore' and in some cases this is not appropriate. An example would be a control that has a selection of 0db and -6dB of gain that is intended to set the fullscale ouput voltage of a DAC. The TI pcm512x family of DAcs have such a control. In this case the device/driver reset defaults are preferred. Signed-off-by: Howard Mitchell <hm@hmbedded.co.uk> Acked-by: Takashi Iwai <tiwai@suse.de> Signed-off-by: Mark Brown <broonie@kernel.org>
2015-03-20ALSA: hda - Rename power_mgmt flag with power_save_nodeTakashi Iwai1-1/+5
David suggested that the name "power_mgmt" is too ambiguous. Rename the flag with a bit clearer one "power_save_node". Also, add the corresponding description to HD-Audio.txt, too. Reported-by: David Henningsson <david.henningsson@canonical.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-02-20ALSA: core: selection of audio_tstamp type and accuracy reportsPierre-Louis Bossart1-0/+200
Audio timestamps can be extracted from sample counters, wall clocks, PHC clocks (Ethernet AVB), on-demand synchronized snapshots. This patch provides the ability to report timestamping capabilities, select timestamp types and retrieve timestamp accuracy, if supported. Details can be found in Documentations/sound/alsa/timestamping.txt This functionality is introduced by reclaiming the reserved_aligned field introduced by commit9c7066aef4a5eb8e4063de28f06c508bf6f2963a in snd_pcm_status to provide userspace with selection/query capabilities. Additional driver_tstamp and audio_tstamp_accuracy fields are also added. snd_pcm_mmap_status remains a read-only structure with only the audio timestamp value accessible from user space. The selection of audio timestamp type is done through snd_pcm_status only This commit does not impact ABI and does not impact the default behavior. By default audio timestamp is aligned with hw_pointer and reports the DMA position. Backwards compatibility is handled by using the HDAudio wall clock for playback and the hw_ptr for all other cases. For timestamp selection a new STATUS_EXT ioctl is introduced with read/write parameters. Alsa-lib will be modified to make use of STATUS_EXT. Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-12-10ALSA: hda - Add "eapd" model string for AD1986A codecTakashi Iwai1-6/+2
Also update the documentation to the latest state. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-11-04ALSA: pcm: Add xrun_injection proc entryTakashi Iwai1-0/+4
This patch adds a new proc entry for PCM substreams to inject an XRUN. When a PCM substream is running and any value is written to its xrun_injection proc file, the driver triggers XRUN. This is a useful feature for debugging XRUN and error handling code paths. Note that this entry is enabled only when CONFIG_SND_PCM_XRUN_DEBUG is set. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-11-04ALSA: pcm: Replace PCM hwptr tracking with tracepointsTakashi Iwai1-13/+0
ALSA PCM core has a mechanism tracking the PCM hwptr updates for analyzing XRUNs. But its log is limited (up to 10) and its log output is a kernel message, which is hard to handle. In this patch, the hwptr logging is moved to the tracing infrastructure instead of its own. Not only the hwptr updates but also XRUN and hwptr errors are recorded on the trace log, so that user can see such events at the exact timing. The new "snd_pcm" entry will appear in the tracing events: # ls -F /sys/kernel/debug/tracing/events/snd_pcm enable filter hw_ptr_error/ hwptr/ xrun/ The hwptr is for the regular hwptr update events. An event trace looks like: aplay-26187 [004] d..3 4012.834761: hwptr: pcmC0D0p/sub0: POS: pos=488, old=0, base=0, period=1024, buf=16384 "POS" shows the hwptr update by the explicit position update call and "IRQ" means the hwptr update by the interrupt, i.e. snd_pcm_period_elapsed() call. The "pos" is the passed ring-buffer offset by the caller, "old" is the previous hwptr, "base" is the hwptr base position, "period" and "buf" are period- and buffer-size of the target PCM substream. (Note that the hwptr position displayed here isn't the ring-buffer offset. It increments up to the PCM position boundary.) The XRUN event appears similarly, but without "pos" field. The hwptr error events appear with the PCM identifier and its reason string, such as "Lost interrupt?". The XRUN and hwptr error reports on kernel message are still left, can be turned on/off via xrun_debug proc like before. But the bit 3, 4, 5 and 6 bits of xrun_debug proc are dropped by this patch. Also, along with the change, the message strings have been reformatted to be a bit more consistent. Last but not least, the hwptr reporting is enabled only when CONFIG_SND_PCM_XRUN_DEBUG is set. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-10-20ALSA: Update control names documentationDavid Henningsson1-5/+27
This document was not really up-to-date. Add recent additions to this standard - based on what the HDA driver currently does, which is some kind of a de facto standard. Signed-off-by: David Henningsson <david.henningsson@canonical.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-08-04ALSA: virtuoso: add Xonar Essence STX II supportClemens Ladisch1-2/+2
Just add the PCI ID for the STX II. It appears to work the same as the STX, except for the addition of the not-yet-supported daughterboard. Tested-by: Mario <fugazzi99@gmail.com> Tested-by: corubba <corubba@gmx.de> Cc: <stable@vger.kernel.org> Signed-off-by: Clemens Ladisch <clemens@ladisch.de> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-07-15ALSA: hda - Update model list documentation for IDT codecsTakashi Iwai1-0/+5
Just add missing recent entries. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-06-25ALSA: hda - Adjust speaker HPF and add LED support for HP Spectre 13Takashi Iwai1-0/+5
HP Spectre 13 has the IDT 92HD95 codec, and BIOS seems to set the default high-pass filter in some "safer" range, which results in the very soft tone from the built-in speakers in contrast to Windows. Also, the mute LED control is missing, since 92HD95 codec still has no HP-specific fixups for GPIO setups. This patch adds these missing features: the HPF is adjusted by the vendor-specific verb, and the LED is set up from a DMI string (but with the default polarity = 0 assumption due to the incomplete BIOS on the given machine). Bugzilla: https://bugzilla.kernel.org/show_bug.cgi?id=74841 Cc: <stable@vger.kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-05-05doc: spelling error changesCarlos Garcia1-2/+2
Fixed multiple spelling errors. Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Carlos E. Garcia <carlos@cgarcia.org> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
2014-02-27x86, platforms: Remove SGI Visual WorkstationH. Peter Anvin1-293/+0
The SGI Visual Workstation seems to be dead; remove support so we don't have to continue maintaining it. Cc: Andrey Panin <pazke@donpac.ru> Cc: Michael Reed <mdr@sgi.com> Link: http://lkml.kernel.org/r/530CFD6C.7040705@zytor.com Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2014-01-07ASoC: docs: Update the Overview documentLiam Girdwood1-9/+18
Update the ASoC overview to bring it up to date with the current code base and include multi-component. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Mark Brown <broonie@linaro.org>
2013-10-29ALSA: Fix typo in documentation/alsaMasanari Iida6-10/+10
Correct spelling typo in documentation/alsa Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2013-10-24Merge remote-tracking branch 'asoc/topic/doc' into asoc-nextMark Brown5-66/+456
2013-10-11ALSA: hda - Add a headset mic model for ALC269 and friendsDavid Henningsson1-0/+1
Using the headset mic model will cause the headset mic to be labeled "headset mic" instead of just "mic". Signed-off-by: David Henningsson <david.henningsson@canonical.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2013-09-27ALSA: hda - Add documentation for CS4208 fixupsTakashi Iwai1-0/+6
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2013-09-23ASoC: Docs: Add documentation for Dynamic PCMLiam Girdwood1-0/+380
Add documentation describing DPCM with examples of a DSP based smart phone. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Mark Brown <broonie@linaro.org>
2013-09-23ASoC: Docs: Machine updateLiam Girdwood1-2/+4
Update the machine driver documentation and bring it up to date with the current code base. This includes multi component. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Mark Brown <broonie@linaro.org>