librdmacm/doc: Document private data length limitations

Document the limitations on the user provided private data length
over Infiniband networks. These limitations are calculated by
subtracting the rdma-cm header size (see IBA Annex A11 "RDMA CM IP
Service") from IB's private data len for the REQ (rdma_connect) and
REP (rdma_accept) messages

Signed-off-by: Or Gerlitz <ogerlitz@mellanox.com>
Signed-off-by: Sean Hefty <sean.hefty@intel.com>

diff --git a/man/rdma_accept.3 b/man/rdma_accept.3
index 89f2a62fb726fda73e105b84aa284a105f865cc8..c131d29ea761bb6cd17c1af56baa4d8d878a55b9 100755 (executable)
--- a/man/rdma_accept.3
+++ b/man/rdma_accept.3
@@ -84,5 +84,8 @@ by the active side of the connection.  The HCA ACK delay is a property of
 the locally used HCA.
 .P
 The RNR retry count is a 3-bit value.
+.P
+The length of the private data provided by the user is limited to 160 bytes
+for RDMA_PS_TCP, or 136 bytes for RDMA_PS_UDP.
 .SH "SEE ALSO"
 rdma_listen(3), rdma_reject(3), rdma_get_cm_event(3)

diff --git a/man/rdma_connect.3 b/man/rdma_connect.3
old mode 100644 (file)
new mode 100755 (executable)
index b0cc51e..51056a0
--- a/man/rdma_connect.3
+++ b/man/rdma_connect.3
@@ -79,6 +79,9 @@ Administrator and is part of the resolved route (path record) information.
 The HCA ACK delay is a property of the locally used HCA.
 .P
 Retry count and RNR retry count values are 3-bit values.
+.P
+The length of the private data provided by the user is limited to 56 bytes
+for RDMA_PS_TCP, or 180 bytes for RDMA_PS_UDP.
 .SH "IWARP SPECIFIC"
 Connections established over iWarp RDMA devices currently require that the
 active side of the connection send the first message.