r9649: Clarify that service_id and remote_ca_guid are specified in network-byte order.

This is based on feedback to using the libibcm interface.

Signed-off-by: Sean Hefty <sean.hefty@intel.com>

diff --git a/include/infiniband/cm.h b/include/infiniband/cm.h
index 149fa91b57ff854bfd29c90691e9c0bd5571b92a..72c5db1f3b842970395a188024db7eca3c03fad8 100644 (file)
--- a/include/infiniband/cm.h
+++ b/include/infiniband/cm.h
@@ -99,7 +99,7 @@ struct ib_cm_req_event_param {
        struct ibv_sa_path_rec  *primary_path;
        struct ibv_sa_path_rec  *alternate_path;
 
-       uint64_t                remote_ca_guid;
+       uint64_t                remote_ca_guid; /* netork-byte order */
        uint32_t                remote_qkey;
        uint32_t                remote_qpn;
        enum ibv_qp_type        qp_type;
@@ -116,7 +116,7 @@ struct ib_cm_req_event_param {
 };
 
 struct ib_cm_rep_event_param {
-       uint64_t                remote_ca_guid;
+       uint64_t                remote_ca_guid; /* network-byte order */
        uint32_t                remote_qkey;
        uint32_t                remote_qpn;
        uint32_t                starting_psn;
@@ -223,7 +223,6 @@ struct ib_cm_sidr_rep_event_param {
        uint32_t                qpn;
        void                    *info;
        uint8_t                 info_len;
-
 };
 
 struct ib_cm_event {
@@ -309,8 +308,8 @@ int ib_cm_create_id(struct ib_cm_device *device,
 int ib_cm_destroy_id(struct ib_cm_id *cm_id);
 
 struct ib_cm_attr_param {
-       uint64_t                service_id;
-       uint64_t                service_mask;
+       uint64_t                service_id;   /* network-byte order */
+       uint64_t                service_mask; /* network-byte order */
        uint32_t                local_id;
        uint32_t                remote_id;
 };
@@ -343,7 +342,7 @@ int ib_cm_listen(struct ib_cm_id *cm_id,
 struct ib_cm_req_param {
        struct ibv_sa_path_rec  *primary_path;
        struct ibv_sa_path_rec  *alternate_path;
-       uint64_t                service_id;
+       uint64_t                service_id; /* network-byte order */
        uint32_t                qp_num;
        enum ibv_qp_type        qp_type;
        uint32_t                starting_psn;
@@ -532,7 +531,7 @@ int ib_cm_send_apr(struct ib_cm_id *cm_id,
 
 struct ib_cm_sidr_req_param {
        struct ibv_sa_path_rec  *path;
-       uint64_t                service_id;
+       uint64_t                service_id; /* network-byte order */
        int                     timeout_ms;
        void                    *private_data;
        uint8_t                 private_data_len;