Commit Graph

660 Commits

Author SHA1 Message Date
Jonathan Corbet
726d661fea Merge remote-tracking branch 'sound/topic/restize-docs' into sound
Bring in the sphinxification of the sound documentation.
2016-11-18 16:19:28 -07:00
Takashi Iwai
c6ab9e57e8 ASoC: doc: ReSTize codec_to_codec.txt
Yet another simple conversion from a plain text file.
Renamed to codec-to-codec.rst to align with others.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:35:10 +01:00
Takashi Iwai
76228a2b54 Merge branch 'topic/doc' of git://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound into topic/restize-docs 2016-11-11 17:34:57 +01:00
Takashi Iwai
40433cd34e ASoC: doc: ReSTize DPCM.txt
A simple conversion from a plain text file.
The file name was renamed to lower letters to align with others.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:34:22 +01:00
Takashi Iwai
8155258a7d ASoC: doc: ReSTize jack.txt
A simple conversion from a plain text file.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:34:14 +01:00
Takashi Iwai
fb3df95083 ASoC: doc: ReSTize clocking.txt
A simple conversion from a plain text file.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:34:03 +01:00
Takashi Iwai
c9746eeafc ASoC: doc: ReSTize pops_clicks.txt
A simple conversion from a plain text file.
The file name was changed from "pops_clicks" to "pops-clicks" to align
with others.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:33:54 +01:00
Takashi Iwai
d9641c9d63 ASoC: doc: ReSTize machine.txt
A simple conversion from a plain text file.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:33:46 +01:00
Takashi Iwai
d8a5d624cc ASoC: doc: ReSTize platform.txt
A simple conversion from a plain text file.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:33:37 +01:00
Takashi Iwai
77190f0333 ASoC: doc: ReSTize dapm.txt
A simple conversion from a plain text file.
The section numbers and the item numbers are dropped to align with the
ReST format.  Some lists are converted to description lists to be
clearer.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:33:29 +01:00
Takashi Iwai
e732d1bcd4 ASoC: doc: ReSTize DAI.txt
A simple conversion from a plain text file with slight reformatting /
corrections.

The file name was changed to lower letters to align with others.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:33:16 +01:00
Takashi Iwai
693ba474a3 ASoC: doc: ReSTize codec.txt
A simple conversion from a plain text file.
The section numbers are dropped to align with other documents.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:33:07 +01:00
Takashi Iwai
8e5336a144 ASoC: doc: ReSTize overview.txt
A simple conversion from a plain text file.
Created a new subdirectory, Documentation/sound/soc, for this and
other ASoC documents.

Since the index page contains the TOC, so "Documentation" section got
removed from overview.

Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-11 17:32:48 +01:00
Takashi Iwai
f336c3f072 ALSA: doc: ReSTize img,spdif-in.txt
Yet another simple conversion from a plain text file.
Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:31 +01:00
Takashi Iwai
bb02859cd3 ALSA: doc: ReSTize serial-u16550.txt
Yet another simple conversion from a plain text file.
Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:29 +01:00
Takashi Iwai
c79b5bb0a3 ALSA: doc: ReSTize hdspm.txt
A simple conversion from a plain text file.  Quite a few reformatting
in the end due to the style of the original document.

Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:28 +01:00
Takashi Iwai
a02f5895ee ALSA: doc: ReSTize README.maya44
Another	simple conversion from a plain text file.
Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:27 +01:00
Takashi Iwai
7bb97dfdca ALSA: doc: ReSTize Bt87x.txt
Another	simple conversion from a plain text file.
Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:26 +01:00
Takashi Iwai
3d8e81862c ALSA: doc: ReSTize MIXART.txt
Another simple conversion from a plain text file.
Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:25 +01:00
Takashi Iwai
4e47556e34 ALSA: doc: ReSTize Audiophile-USB.txt
Another simple conversion from a plain text file.
Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:24 +01:00
Takashi Iwai
312c01b173 ALSA: doc: ReSTize VIA82xx-mixer.txt
Another simple conversion from a plain text file.
Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:23 +01:00
Takashi Iwai
e7030c96fc ALSA: doc: ReSTize emu10k1-jack.txt
Another simple conversion from a plain text file.
Put to cards directory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:22 +01:00
Takashi Iwai
72e6916671 ALSA: doc: ReSTize Audigy-mixer.txt
Another simple conversion from a plain text file.
Put to cards subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:20 +01:00
Takashi Iwai
ecef1481d5 ALSA: doc: ReSTize SB-Live-mixer document
Another simple conversion from a plain text file.
Put to cards subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 22:33:12 +01:00
Takashi Iwai
95ee717a89 ALSA: doc: ReSTize CMIPCI document
A simple conversion from a plain text file.
Put to cards subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:10:07 +01:00
Takashi Iwai
f59c3c6d87 ALSA: doc: ReSTize Joystick document
A conversion from a simple text file.
A new subdirectory, cards, was created to contain the card-specific
information like this one.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:10:03 +01:00
Takashi Iwai
df3a57105c ALSA: doc: ReSTize Jack-Controls.txt
A simple conversion from a plain text file.
Put to designs subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:09:31 +01:00
Takashi Iwai
20a1d0f44d ALSA: doc: ReSTize timestamping document
A simple conversion from a plain text file.
Put to designs subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:09:30 +01:00
Takashi Iwai
e9df12c3ba ALSA: doc: ReSTize compress-offload document
A simple conversion from a plain text file.
Put to designs subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:09:29 +01:00
Takashi Iwai
5a481fe309 ALSA: doc: ReSTize ControlNames.txt
A simple conversion from a plain text file.
Put to designs subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:09:28 +01:00
Takashi Iwai
07aecc06eb ALSA: doc: ReSTize seq_oss document
Converted from an ancient plain HTML document. It's much readable now!
Put to designs subdirectory with a slight rename.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:09:27 +01:00
Takashi Iwai
0c266c4b70 ALSA: doc: ReSTize OSS-Emulation document
A simple conversion from a text file.
Put to designs subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:09:26 +01:00
Takashi Iwai
efe541c230 ALSA: doc: ReSTize Channel-Mapping-API document
A simple conversion from a text file.
Put to designs subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 18:09:25 +01:00
Takashi Iwai
48e92b488d ALSA: doc: ReSTize powersave document
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-10 18:09:23 +01:00
Takashi Iwai
afb8fd3c72 ALSA: doc: ReSTize Procfile document
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-10 18:09:21 +01:00
Takashi Iwai
f6d23df5ca ALSA: doc: ReSTize ALSA-Configuration document
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-10 18:08:44 +01:00
Takashi Iwai
76ab4e1515 ALSA: doc: ReSTize HD-Audio-DP-MST-audio.txt
A simple conversion from a plain text file.
Put to hd-audio subdirectory.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-11-10 17:59:23 +01:00
Takashi Iwai
fe0abd18e1 ALSA: doc: ReSTize HD-Audio-Controls document
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-10 17:59:22 +01:00
Takashi Iwai
a4caad753f ALSA: doc: ReSTize HD-Audio-Models document
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-10 17:59:21 +01:00
Takashi Iwai
9000d69925 ALSA: doc: ReSTize HD-Audio document
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-10 17:59:19 +01:00
Takashi Iwai
7ddedebb03 ALSA: doc: ReSTize writing-an-alsa-driver document
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-10 17:59:18 +01:00
Takashi Iwai
8551914a5e ALSA: doc: ReSTize alsa-driver-api document
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-10 17:59:17 +01:00
Takashi Iwai
3a5182c04a ALSA: doc: Remove alsa-parameters.txt
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-11-10 17:59:16 +01:00
anish kumar
452a256898 ASoC: Codec to codec dai link description
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-26 11:31:14 +01:00
Mauro Carvalho Chehab
8c27ceff36 docs: fix locations of several documents that got moved
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-10-24 08:12:35 -02:00
Takashi Iwai
4a6baf1b35 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
 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1
 
 iQEcBAABAgAGBQJXli6yAAoJECTWi3JdVIfQgmkH/RIfbuCuGJCspFNZ3Gv/ORoX
 oRcUILFd/74FRhQ+ax65Vg/Sn1P/p9dSLspRmZt/pjR37vr/b6BlZSLXgCEqVgIr
 OjYi6ixcEeGyfIvWUH77nYgnUGT62XVJPfQC/2r8DsYI2bWw6tQGA/rCE2h9cl0N
 JoeoGghcNoxS7zZzhgoyTX6B1FoQjJiHML6ApOvpGJWr87dPv1nbJHVBrYOPMr4X
 4l/oVzOIVDmhRQtYPAWTXQzDNhVrLPxs8sgd/oV41Jl4gHRW4EPivjUBCWxQKPFy
 Tf98Q7058eqcFn/egO5lsvzC0kQdiKEXpSRfol4VAU6LAvGxAYDbaIh8cBy29P4=
 =nQWb
 -----END PGP SIGNATURE-----

Merge tag 'asoc-v4.8' of 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-26 10:35:31 +02:00
Vinod Koul
a5d48be457 ALSA - hda: Fix timestamping documentation
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-07-11 12:45:39 +02:00
Andrea Gelmini
add3873ebd ASoC: dt: Fix typo
Signed-off-by: Andrea Gelmini <andrea.gelmini@gelma.net>
Signed-off-by: Mark Brown <broonie@kernel.org>
2016-05-30 16:15:16 +01:00
Vinod Koul
242658ff99 ALSA: compress: fix some typo
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-05-08 11:27:44 +02:00
Eric Engestrom
8d84c1973b ALSA: doc: fix spelling mistakes
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-25 11:22:42 +02:00