docs: Add suggested timeout response argument to GET_MBOX_INFO

It would be nice to suggest to the host how long it should wait for a
response to a command before assuming that the BMC is not going to
respond and timing out.

Add a response argument for this to the GET_MBOX_INFO command. We don't want
to require a BMC to set this so we allow it to be zero to indicate that no
suggestion has been given.

This doesn't require us to bump the protocol number since the current daemon
just sets this to zero (which is allowed) and the host is free to ignore this,
which it currently does.

Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com>
Change-Id: Idd65a5660e0092b9abd98829403b981fd26f8bbe

1 files changed, 9 insertions, 0 deletions

diff --git a/Documentation/mbox_protocol.md b/Documentation/mbox_protocol.md
index 3907742..45320dd 100644
--- a/Documentation/mbox_protocol.md
+++ b/Documentation/mbox_protocol.md
@@ -429,6 +429,15 @@ Command:
 		Args 1-2: reserved
 		Args 3-4: reserved
 		Args 5: Block size as power of two (encoded as a shift)
+		Args 6-7: Suggested Timeout (seconds)
+	Notes:
+		The suggested timeout is a hint to the host as to how long
+		it should wait after issuing a command to the BMC before it
+		times out waiting for a response. This is the maximum time
+		which the BMC thinks it could take to service any command which
+		the host could issue. This may be set to zero to indicate that
+		the BMC	does not wish to provide a hint in which case the host
+		must choose some reasonable value.
 
 Command:
 	GET_FLASH_INFO