diff mbox series

[05/12] ASoC: doc: dapm: clarify it's an internal API

Message ID 20240416-dapm-docs-v1-5-a818d2819bf6@bootlin.com (mailing list archive)
State Superseded
Headers show
Series ASoC: doc: dapm: various improvements | expand

Commit Message

Luca Ceresoli April 16, 2024, 5:56 a.m. UTC
Clarify DAPM does not expose any API to user space, and adapt the paragraph
accordingly.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 Documentation/sound/soc/dapm.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Bagas Sanjaya April 17, 2024, 3:57 a.m. UTC | #1
On Tue, Apr 16, 2024 at 07:56:11AM +0200, Luca Ceresoli wrote:
> diff --git a/Documentation/sound/soc/dapm.rst b/Documentation/sound/soc/dapm.rst
> index e3b399201622..4200bcf18fcd 100644
> --- a/Documentation/sound/soc/dapm.rst
> +++ b/Documentation/sound/soc/dapm.rst
> @@ -11,9 +11,10 @@ all times. It is independent of other kernel power management frameworks
>  and, as such, can easily co-exist with them.
>  
>  DAPM is also completely transparent to all user space applications as
> -all power switching is done within the ASoC core. No code changes or
> -recompiling are required for user space applications. DAPM makes power
> -switching decisions based upon any audio stream (capture/playback)
> +all power switching is done internally to the ASoC core. For this reason
> +DAPM does not expose a kernel API to user space and no code changes or
> +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
> 

LGTM, thanks!

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

Patch

diff --git a/Documentation/sound/soc/dapm.rst b/Documentation/sound/soc/dapm.rst
index e3b399201622..4200bcf18fcd 100644
--- a/Documentation/sound/soc/dapm.rst
+++ b/Documentation/sound/soc/dapm.rst
@@ -11,9 +11,10 @@  all times. It is independent of other kernel power management frameworks
 and, as such, can easily co-exist with them.
 
 DAPM is also completely transparent to all user space applications as
-all power switching is done within the ASoC core. No code changes or
-recompiling are required for user space applications. DAPM makes power
-switching decisions based upon any audio stream (capture/playback)
+all power switching is done internally to the ASoC core. For this reason
+DAPM does not expose a kernel API to user space and no code changes or
+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