PLDM: Comment explaining dbus-timeout-value option
To give more clarity, this commit adds an elaborate comment in
meson_options explaining why 5 seconds DBUS timeout value was
chosen for PLDM.
Change-Id: Icbfcb2c0521810ad1d31835ff8ccda67abd0e858
Signed-off-by: vkaverap@in.ibm.com <vkaverap@in.ibm.com>
diff --git a/meson_options.txt b/meson_options.txt
index 2ea557d..9a7aaf2 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -33,8 +33,12 @@
description: 'Include systemd support'
)
-# Time taken to wait for the reply for any PLDM dbus call is set to 5 seconds.
-# After 5 seconds the dbus method will exit.
+# As per PLDM spec DSP0240 version 1.1.0, in Timing Specification for PLDM messages (Table 6),
+# the instance ID for a given response will expire and become reusable if a response has not been
+# received within a maximum of 6 seconds after a request is sent. By setting the dbus timeout
+# value to 5 seconds we ensure that PLDM does not wait for a response from a dbus call even after
+# the instance ID has expired. If the option is set to 5 seconds, any dbus call originated from
+# PLDM daemon will timeout after 5 seconds.
option(
'dbus-timeout-value',
type: 'integer',