transport: Document the parameters to pldm_transport_poll()
The behaviour of the timeout value was under-specified. The behaviour is
as for POSIX poll(2), but make it concrete that users of the API can
expect that behaviour.
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ic2fa470000e347c96c92285dbdee507ef04f1675
diff --git a/include/libpldm/transport.h b/include/libpldm/transport.h
index 802fae5..e5464b8 100644
--- a/include/libpldm/transport.h
+++ b/include/libpldm/transport.h
@@ -18,6 +18,11 @@
* PLDM_REQUESTER_INVALID_SETUP is returned. This should be called after
* pldm_transport_send_msg has been called.
*
+ * @param[in] transport - Wait until this transport instance is ready
+ * @param[in] timeout - Wait for readiness for up to timeout milliseconds.
+ * Specifying a timeout value of zero yields an immediate return.
+ * Specifying a negative value means an indefinite timeout.
+ *
* @return pldm_requester_rc_t (errno may be set)
*/
pldm_requester_rc_t pldm_transport_poll(struct pldm_transport *transport,