From d4709265970baf2afa60bb031324a80852e4976b Mon Sep 17 00:00:00 2001
From: jiabin <jiabin@google.com>
Date: Thu, 21 Dec 2023 23:03:55 +0000
Subject: [PATCH] AHAL: update doc for prepareToDisconnectExternalDevice.

Bug: 317405349
Test: make
Change-Id: If6c61a851c2e565ab16eb738b9dc0d42ebc04b05
---
 audio/aidl/android/hardware/audio/core/IModule.aidl | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/audio/aidl/android/hardware/audio/core/IModule.aidl b/audio/aidl/android/hardware/audio/core/IModule.aidl
index 2d4d283be2..3c5f7f69a9 100644
--- a/audio/aidl/android/hardware/audio/core/IModule.aidl
+++ b/audio/aidl/android/hardware/audio/core/IModule.aidl
@@ -928,7 +928,10 @@ interface IModule {
      * using 'connectExternalDevice' method. 'disconnectExternalDevice' method will be called
      * soon after this method with the same 'portId'.
      *
-     * @param portId The ID of the audio port that is about to disconnect
+     * Note: This method is called after the external device is disconnected. The system does
+     * not try to predict the disconnection event.
+     *
+     * @param portId The ID of the audio port corresponding to the disconnected device
      * @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.