alsa-devel.alsa-project.org archive mirror
 help / color / mirror / Atom feed
From: Takashi Iwai <tiwai@suse.de>
To: alsa-devel@alsa-project.org
Cc: Liam Girdwood <liam.r.girdwood@linux.intel.com>,
	Mark Brown <broonie@kernel.org>
Subject: [PATCH 05/10] ASoC: doc: ReSTize platform.txt
Date: Thu, 10 Nov 2016 22:47:17 +0100	[thread overview]
Message-ID: <20161110214722.14698-6-tiwai@suse.de> (raw)
In-Reply-To: <20161110214722.14698-1-tiwai@suse.de>

A simple conversion from a plain text file.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
---
 Documentation/sound/soc/index.rst                  |  1 +
 .../{alsa/soc/platform.txt => soc/platform.rst}    | 31 ++++++++++++----------
 2 files changed, 18 insertions(+), 14 deletions(-)
 rename Documentation/sound/{alsa/soc/platform.txt => soc/platform.rst} (81%)

diff --git a/Documentation/sound/soc/index.rst b/Documentation/sound/soc/index.rst
index 0c0c38e582b4..c5a55195bf4d 100644
--- a/Documentation/sound/soc/index.rst
+++ b/Documentation/sound/soc/index.rst
@@ -11,3 +11,4 @@ The documentation is spilt into the following sections:-
    codec
    dai
    dapm
+   platform
diff --git a/Documentation/sound/alsa/soc/platform.txt b/Documentation/sound/soc/platform.rst
similarity index 81%
rename from Documentation/sound/alsa/soc/platform.txt
rename to Documentation/sound/soc/platform.rst
index 3a08a2c9150c..d5574904d981 100644
--- a/Documentation/sound/alsa/soc/platform.txt
+++ b/Documentation/sound/soc/platform.rst
@@ -1,3 +1,4 @@
+====================
 ASoC Platform Driver
 ====================
 
@@ -9,21 +10,23 @@ Audio DMA
 =========
 
 The platform DMA driver optionally supports the following ALSA operations:-
+::
 
-/* SoC audio ops */
-struct snd_soc_ops {
+  /* SoC audio ops */
+  struct snd_soc_ops {
 	int (*startup)(struct snd_pcm_substream *);
 	void (*shutdown)(struct snd_pcm_substream *);
 	int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
 	int (*hw_free)(struct snd_pcm_substream *);
 	int (*prepare)(struct snd_pcm_substream *);
 	int (*trigger)(struct snd_pcm_substream *, int);
-};
+  };
 
 The platform driver exports its DMA functionality via struct
 snd_soc_platform_driver:-
+::
 
-struct snd_soc_platform_driver {
+  struct snd_soc_platform_driver {
 	char *name;
 
 	int (*probe)(struct platform_device *pdev);
@@ -44,7 +47,7 @@ struct snd_soc_platform_driver {
 
 	/* platform stream ops */
 	struct snd_pcm_ops *pcm_ops;
-};
+  };
 
 Please refer to the ALSA driver documentation for details of audio DMA.
 http://www.alsa-project.org/~iwai/writing-an-alsa-driver/
@@ -57,11 +60,11 @@ SoC DAI Drivers
 
 Each SoC DAI driver must provide the following features:-
 
- 1) Digital audio interface (DAI) description
- 2) Digital audio interface configuration
- 3) PCM's description
- 4) SYSCLK configuration
- 5) Suspend and resume (optional)
+1. Digital audio interface (DAI) description
+2. Digital audio interface configuration
+3. PCM's description
+4. SYSCLK configuration
+5. Suspend and resume (optional)
 
 Please see codec.txt for a description of items 1 - 4.
 
@@ -71,9 +74,9 @@ SoC DSP Drivers
 
 Each SoC DSP driver usually supplies the following features :-
 
- 1) DAPM graph
- 2) Mixer controls
- 3) DMA IO to/from DSP buffers (if applicable)
- 4) Definition of DSP front end (FE) PCM devices.
+1. DAPM graph
+2. Mixer controls
+3. DMA IO to/from DSP buffers (if applicable)
+4. Definition of DSP front end (FE) PCM devices.
 
 Please see DPCM.txt for a description of item 4.
-- 
2.10.2

  parent reply	other threads:[~2016-11-10 21:47 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-10 21:47 [PATCH 00/10] ASoC: Modernize documents Takashi Iwai
2016-11-10 21:47 ` [PATCH 01/10] ASoC: doc: ReSTize overview.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 02/10] ASoC: doc: ReSTize codec.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 03/10] ASoC: doc: ReSTize DAI.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 04/10] ASoC: doc: ReSTize dapm.txt Takashi Iwai
2016-11-10 21:47 ` Takashi Iwai [this message]
2016-11-10 21:47 ` [PATCH 06/10] ASoC: doc: ReSTize machine.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 07/10] ASoC: doc: ReSTize pops_clicks.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 08/10] ASoC: doc: ReSTize clocking.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 09/10] ASoC: doc: ReSTize jack.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 10/10] ASoC: doc: ReSTize DPCM.txt Takashi Iwai
2016-11-11 15:16 ` [PATCH 00/10] ASoC: Modernize documents Mark Brown
2016-11-11 15:57   ` Takashi Iwai

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20161110214722.14698-6-tiwai@suse.de \
    --to=tiwai@suse.de \
    --cc=alsa-devel@alsa-project.org \
    --cc=broonie@kernel.org \
    --cc=liam.r.girdwood@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).