public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Luca Ceresoli <luca.ceresoli@bootlin.com>,
	Liam Girdwood <lgirdwood@gmail.com>,
	Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>,
	Takashi Iwai <tiwai@suse.com>, Jonathan Corbet <corbet@lwn.net>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>,
	Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	Mao Zhu <zhumao001@208suo.com>, Ran Sun <sunran001@208suo.com>,
	Xiang wangx <wangxiang@cdjrlc.com>,
	Shaomin Deng <dengshaomin@cdjrlc.com>,
	Charles Han <hanchunchao@inspur.com>,
	Attreyee M <tintinm2017@gmail.com>,
	Linux Sound System <linux-sound@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 07/12] ASoC: doc: dapm: extend initial descrption
Date: Wed, 17 Apr 2024 11:05:00 +0700	[thread overview]
Message-ID: <Zh9KbP0BUDUT3cKi@archie.me> (raw)
In-Reply-To: <20240416-dapm-docs-v1-7-a818d2819bf6@bootlin.com>

[-- Attachment #1: Type: text/plain, Size: 2363 bytes --]

On Tue, Apr 16, 2024 at 07:56:13AM +0200, Luca Ceresoli wrote:
> diff --git a/Documentation/sound/soc/dapm.rst b/Documentation/sound/soc/dapm.rst
> index cab40a6b4c96..3a2fde1d31bf 100644
> --- a/Documentation/sound/soc/dapm.rst
> +++ b/Documentation/sound/soc/dapm.rst
> @@ -17,9 +17,27 @@ recompiling are required for user space applications to use it. DAPM makes
>  power switching decisions based upon any audio stream (capture/playback)
>  activity and audio mixer settings within the device.
>  
> -DAPM spans the whole machine. It covers power control within the entire
> -audio subsystem, this includes internal codec power blocks and machine
> -level power systems.
> +DAPM is based on two basic elements, called widgets and routes:
> +
> + * a **widget** is every part of the audio hardware that can be enabled by
> +   software when in use and disabled to save power when not in use
> + * a **route** is an interconnection between widgets that exists when sound
> +   can flow from one widget to the other
> +
> +All DAPM power switching decisions are made automatically by consulting an
> +audio routing graph. This graph is specific to each sound card and spans
> +the whole sound card, so some DAPM routes connect two widgets belonging to
> +different components (e.g. the LINE OUT pin of a CODEC and the input pin of
> +an amplifier).
> +
> +The graph for the STM32MP1-DK1 sound card is shown in picture:
> +
> +.. kernel-figure:: dapm-graph.svg
> +    :alt:   Example DAPM graph
> +    :align: center
> +
> +DAPM power domains
> +==================
>  
>  There are 4 power domains within DAPM:
>  
> @@ -48,12 +66,6 @@ Stream domain
>        Enabled and disabled when stream playback/capture is started and
>        stopped respectively. e.g. aplay, arecord.
>  
> -All DAPM power switching decisions are made automatically by consulting an audio
> -routing graph of the whole machine. This graph is specific to each machine and
> -consists of the interconnections between every audio component (including
> -internal codec components). All audio components that affect power are called
> -widgets hereafter.
> -
>  
>  DAPM Widgets
>  ============
> 

The wording LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

  reply	other threads:[~2024-04-17  4:05 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-16  5:56 [PATCH 00/12] ASoC: doc: dapm: various improvements Luca Ceresoli
2024-04-16  5:56 ` [PATCH 01/12] ASoC: doc: dapm: fix typos Luca Ceresoli
2024-04-17  3:49   ` Bagas Sanjaya
2024-04-16  5:56 ` [PATCH 02/12] ASoC: doc: dapm: fix struct name Luca Ceresoli
2024-04-16  5:56 ` [PATCH 03/12] ASoC: doc: dapm: minor rewording Luca Ceresoli
2024-04-17  3:54   ` Bagas Sanjaya
2024-04-16  5:56 ` [PATCH 04/12] ASoC: doc: dapm: remove dash after colon Luca Ceresoli
2024-04-16  5:56 ` [PATCH 05/12] ASoC: doc: dapm: clarify it's an internal API Luca Ceresoli
2024-04-17  3:57   ` Bagas Sanjaya
2024-04-16  5:56 ` [PATCH 06/12] ASoC: doc: dapm: replace "map" with "graph" Luca Ceresoli
2024-04-16  5:56 ` [PATCH 07/12] ASoC: doc: dapm: extend initial descrption Luca Ceresoli
2024-04-17  4:05   ` Bagas Sanjaya [this message]
2024-04-16  5:56 ` [PATCH 08/12] ASoC: doc: dapm: describe how widgets and routes are registered Luca Ceresoli
2024-04-17  4:12   ` Bagas Sanjaya
2024-04-16  5:56 ` [PATCH 09/12] ASoC: doc: dapm: fix and improve section "Registering DAPM controls" Luca Ceresoli
2024-04-17  4:16   ` Bagas Sanjaya
2024-04-16  5:56 ` [PATCH 10/12] ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections" Luca Ceresoli
2024-04-17  4:33   ` Bagas Sanjaya
2024-04-17  5:08     ` Luca Ceresoli
2024-04-16  5:56 ` [PATCH 11/12] ASoC: doc: dapm: update section "DAPM Widget Events" Luca Ceresoli
2024-04-16  5:56 ` [PATCH 12/12] ASoC: doc: dapm: update event types Luca Ceresoli
2024-04-16 21:23 ` [PATCH 00/12] ASoC: doc: dapm: various improvements Alexandre Belloni
2024-04-17  5:07   ` Luca Ceresoli
2024-04-17 23:30   ` Luca Ceresoli

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=Zh9KbP0BUDUT3cKi@archie.me \
    --to=bagasdotme@gmail.com \
    --cc=alexandre.belloni@bootlin.com \
    --cc=broonie@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dengshaomin@cdjrlc.com \
    --cc=hanchunchao@inspur.com \
    --cc=lgirdwood@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-sound@vger.kernel.org \
    --cc=luca.ceresoli@bootlin.com \
    --cc=perex@perex.cz \
    --cc=sunran001@208suo.com \
    --cc=thomas.petazzoni@bootlin.com \
    --cc=tintinm2017@gmail.com \
    --cc=tiwai@suse.com \
    --cc=wangxiang@cdjrlc.com \
    --cc=zhumao001@208suo.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