From cf210c83b2d29882aa0144a8e52af0d460628b6e Mon Sep 17 00:00:00 2001
From: Jiabin Huang <jiabin@google.com>
Date: Thu, 27 Apr 2023 23:06:04 +0000
Subject: [PATCH] AHAL: add more comment for IModule.disconnectExternalDevice

Bug: 277955540
Change-Id: I0d6a73884ab4bcfec62da45124024e8680155144
Test: TH
---
 audio/aidl/android/hardware/audio/core/IModule.aidl | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/audio/aidl/android/hardware/audio/core/IModule.aidl b/audio/aidl/android/hardware/audio/core/IModule.aidl
index 7622d9a16c..e736c32e98 100644
--- a/audio/aidl/android/hardware/audio/core/IModule.aidl
+++ b/audio/aidl/android/hardware/audio/core/IModule.aidl
@@ -234,6 +234,12 @@ interface IModule {
      * instance previously instantiated using the 'connectExternalDevice'
      * method.
      *
+     * The framework will call this method before closing streams and resetting
+     * patches. This call can be used by the HAL module to prepare itself to
+     * device disconnection. If the HAL module indicates an error after the first
+     * call, the framework will call this method once again after closing associated
+     * streams and patches.
+     *
      * @throws EX_ILLEGAL_ARGUMENT In the following cases:
      *                             - If the port can not be found by the ID.
      *                             - If this is not a connected device port.