Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
From:   Chancel Liu <chancel.liu@nxp.com>
To:     lgirdwood@gmail.com, broonie@kernel.org, perex@perex.cz,
        tiwai@suse.com, alsa-devel@alsa-project.org,
        linux-kernel@vger.kernel.org
Cc:     Chancel Liu <chancel.liu@nxp.com>
Subject: [PATCH v2 1/1] ASoC: soc-pcm.c: Make sure DAI parameters cleared if the DAI becomes inactive
Date:   Wed, 20 Sep 2023 23:36:21 +0800
Message-Id: <20230920153621.711373-2-chancel.liu@nxp.com>
In-Reply-To: <20230920153621.711373-1-chancel.liu@nxp.com>
References: <20230920153621.711373-1-chancel.liu@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?7KHSRA+zbTm37vf5UzBno6DNY3ox+hyoqFK9JCgdKy1z6f8ESF6Gfv3L3MjU?=
 =?us-ascii?Q?E4d7ovvlSYiGqj88TVZuus0PAdxbcDZzeedhuZ6SsF1y2P9ZdzSmwXwfFH1Z?=
 =?us-ascii?Q?dCdfVGbdsmvs8Ci+yT9q3hKs1uGL8ePgfKZKvrkiB74BpLFHB9Kipeb0kZ95?=
 =?us-ascii?Q?+7i/6EW1ODFIofJMbEcCdvfY80rGC4B8B0msIU0QmBeyYzxGY29NkuuFrN/Y?=
 =?us-ascii?Q?yLLgiFHpbZvzpUGGG4eqETDHmWK5I8Qz4ASkFVPYzzEQkhv11/BpwFucnfHr?=
 =?us-ascii?Q?OqILpHFZGSIpOLw9DATFzgiybhnW084uICpRThNhOHKY70SLzBArsjsKgkyK?=
 =?us-ascii?Q?QWIlIdSyo9cfst7It8D+m1hWXP/inafkxl+v38lMjMzhLEit9N4pHy6cWf/b?=
 =?us-ascii?Q?Vi9v7ferPTJp1muwgj5fEvUbdI0Kuz9RaxLIuvj97vKPkbfbYLXl/ei4bKml?=
 =?us-ascii?Q?VQD5mbyOveXgiiN1F7FEMFZs67JDvdT0mmGjwIC5GIxgUMEn+nLd1KjhyBNd?=
 =?us-ascii?Q?nK/PqrtUADJhFAGvKe/j8qFNVHFYcBJr05Ou0fwtsYVlb3C4ZSyUYrMKmCRy?=
 =?us-ascii?Q?BqRR5vfe+2nV/FMKbJ2TTtBjdkXro1v8M6xcA1HudHB5SIXMgBI1J7z4c0Mx?=
 =?us-ascii?Q?DFiDIPBKkpHtu7G2ry7gMpx/0o//NG6tQZrfPClo0Ytca2/YNkOo6Bj0wZbf?=
 =?us-ascii?Q?kzIJD4COAtfeaKa/1DFJr8EkXsxRMXP7RHpsE2dXCY6iB5ylGe/XrkrzNxZ/?=
 =?us-ascii?Q?1hYfD1DoGBPlh2EgpL+L0xsnYftQJqTBM3fQLFyNTnmozogJ77KjgIJaPcpX?=
 =?us-ascii?Q?MxRqtUWvBdgWacNHt178KK1O+wevZDbZJpU+bOD9QRZYL5N2I50ackTH4/lD?=
 =?us-ascii?Q?DIDEnXrTtAi8hurwhiD25rzBqJj7PxofuNooHMF7GLXEF3uqnVTGWZ9dUAhF?=
 =?us-ascii?Q?9zhZc12yOmTBF0pGVYg954KpGj3Ux0Fut4yUcvcVYJ5VscXiE7L8NB+fZNIy?=
 =?us-ascii?Q?YxEIjkzt0CmnqsKvtL2glX2/TohGe4wVChClvKsnNEPCXtNI7xG2qsYUi20y?=
 =?us-ascii?Q?G5KqNgY6CVkQNgL0Lr8uLBS4S7SVkl4wN+vOdHhh7DJS8nV/YjNtDpnUZyRT?=
 =?us-ascii?Q?W1zf/gwdBb0NDUbqvvz/0VAc8OMw1ViTMkZzDu5+/3oBaJ7FubWKmsGca3sx?=
 =?us-ascii?Q?TUGmtft+4kTptmPMjYPwQ61HohmZdoAiRtsC8/n9mFKCmkGxyXCJpZFmKkKg?=
 =?us-ascii?Q?pPpOong8hmN8XS2YjhYWW/pf8aZ71zudeQhgFtdhTtchJ7T1ulJ93ARQsTNW?=
 =?us-ascii?Q?m5zF5W9kl64m8Y9rPOrALFHYGNzgw2hVX4cigMctRqARPshslF5nTvUao5Lw?=
 =?us-ascii?Q?US/isUPNV7CeKM1nJK/+s0CXni/TCQElCc5SoL9dgnKNXVQ4ZYdH2aYX9s5h?=
 =?us-ascii?Q?iA66Tu8cJr97r1Cexnahfm5esSTmbcC6OnA/ZiWbV8CYpfjT+c+lmBpS2HM4?=
 =?us-ascii?Q?W+2ePuknBVYvh5HDzsP42J129TtKzX+Bu6BE6Q8untJP1Y5JlsKaQKdEFNlA?=
 =?us-ascii?Q?p4L75DwO4yDH/U12kD3d5KHxUooPAOW7O+iAC6Hf?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: bd3ebdf7-b97a-4cc5-c650-08dbb9ef63a2
X-MS-Exchange-CrossTenant-AuthSource: DB9PR04MB9498.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Sep 2023 15:36:42.4686
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: YlSZf+ln78Jt6Q/QV7RpV69oLCK3G7ufM7xwAaIv06kB0OX7TpMDvpBPtGWP4HkV5VoLbE8cuUm25wxqgn1kEw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DUZPR04MB9748
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED,
        RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Wed, 20 Sep 2023 08:36:56 -0700 (PDT)

The commit 1da681e52853 ("ASoC: soc-pcm.c: Clear DAIs parameters after
stream_active is updated") tries to make sure DAI parameters can be
cleared properly through moving the cleanup to the place where stream
active status is updated. However, it will cause the cleanup only
happening in soc_pcm_close().

Suppose a case: aplay -Dhw:0 44100.wav 48000.wav. The case calls
soc_pcm_open()->soc_pcm_hw_params()->soc_pcm_hw_free()->
soc_pcm_hw_params()->soc_pcm_hw_free()->soc_pcm_close() in order. The
parameters would be remained in the system even if the playback of
44100.wav is finished.

The case requires us clearing parameters in phase of soc_pcm_hw_free().
However, moving the DAI parameters cleanup back to soc_pcm_hw_free()
has the risk that DAIs parameters never be cleared if there're more
than one stream, see commit 1da681e52853 ("ASoC: soc-pcm.c: Clear DAIs
parameters after stream_active is updated") for more details.

To meet all these requirements, in addition to do DAI parameters
cleanup in soc_pcm_hw_free(), also check it in soc_pcm_close() to make
sure DAI parameters cleared if the DAI becomes inactive.

Fixes: 1da681e52853 ("ASoC: soc-pcm.c: Clear DAIs parameters after stream_active is updated")
Signed-off-by: Chancel Liu <chancel.liu@nxp.com>
---
 sound/soc/soc-pcm.c | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/sound/soc/soc-pcm.c b/sound/soc/soc-pcm.c
index 3aa6b988cb4b..6cf4cd667d03 100644
--- a/sound/soc/soc-pcm.c
+++ b/sound/soc/soc-pcm.c
@@ -698,14 +698,12 @@ static int soc_pcm_clean(struct snd_soc_pcm_runtime *rtd,
 
 	if (!rollback) {
 		snd_soc_runtime_deactivate(rtd, substream->stream);
-		/* clear the corresponding DAIs parameters when going to be inactive */
-		for_each_rtd_dais(rtd, i, dai) {
-			if (snd_soc_dai_active(dai) == 0)
-				soc_pcm_set_dai_params(dai, NULL);
 
-			if (snd_soc_dai_stream_active(dai, substream->stream) == 0)
-				snd_soc_dai_digital_mute(dai, 1, substream->stream);
-		}
+		/* Make sure DAI parameters cleared if the DAI becomes inactive */
+		for_each_rtd_dais(rtd, i, dai)
+			if (snd_soc_dai_active(dai) == 0 &&
+			    (dai->rate || dai->channels || dai->sample_bits))
+				soc_pcm_set_dai_params(dai, NULL);
 	}
 
 	for_each_rtd_dais(rtd, i, dai)
@@ -936,6 +934,15 @@ static int soc_pcm_hw_clean(struct snd_soc_pcm_runtime *rtd,
 
 	snd_soc_dpcm_mutex_assert_held(rtd);
 
+	/* clear the corresponding DAIs parameters when going to be inactive */
+	for_each_rtd_dais(rtd, i, dai) {
+		if (snd_soc_dai_active(dai) == 1)
+			soc_pcm_set_dai_params(dai, NULL);
+
+		if (snd_soc_dai_stream_active(dai, substream->stream) == 1)
+			snd_soc_dai_digital_mute(dai, 1, substream->stream);
+	}
+
 	/* run the stream event */
 	snd_soc_dapm_stream_stop(rtd, substream->stream);
 
-- 
2.25.1