From patchwork Tue Nov 6 13:28:23 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Honggang LI X-Patchwork-Id: 10670405 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 57D1715E9 for ; Tue, 6 Nov 2018 13:28:31 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 95F0C1FFBD for ; Tue, 6 Nov 2018 13:28:30 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 88F8729451; Tue, 6 Nov 2018 13:28:30 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI,SUBJ_OBFU_PUNCT_FEW autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 7B1091FFBD for ; Tue, 6 Nov 2018 13:28:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2388110AbeKFWxl (ORCPT ); Tue, 6 Nov 2018 17:53:41 -0500 Received: from mx1.redhat.com ([209.132.183.28]:39650 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2388021AbeKFWxl (ORCPT ); Tue, 6 Nov 2018 17:53:41 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 240194E91D; Tue, 6 Nov 2018 13:28:28 +0000 (UTC) Received: from lhg.nay.redhat.com (unknown [10.66.129.124]) by smtp.corp.redhat.com (Postfix) with ESMTP id AF19F60C61; Tue, 6 Nov 2018 13:28:26 +0000 (UTC) From: Honggang LI To: hal@dev.mellanox.co.il Cc: linux-rdma@vger.kernel.org, Honggang Li Subject: [opensm patch v2] opensm/osm_node.h: Improves comments Date: Tue, 6 Nov 2018 21:28:23 +0800 Message-Id: <20181106132823.29802-1-honli@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.38]); Tue, 06 Nov 2018 13:28:28 +0000 (UTC) Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Honggang Li Signed-off-by: Honggang Li --- include/opensm/osm_node.h | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/include/opensm/osm_node.h b/include/opensm/osm_node.h index 1d349048..b6e5e00a 100644 --- a/include/opensm/osm_node.h +++ b/include/opensm/osm_node.h @@ -234,7 +234,7 @@ static inline osm_physp_t *osm_node_get_physp_ptr(IN osm_node_t * p_node, * RETURN VALUES * Returns a pointer to the physical port object at the * specified local port number. -* A return value of zero means the port number was out of range. +* A return value of NULL means the port number was out of range. * * NOTES * @@ -454,6 +454,9 @@ void osm_node_init_physp(IN osm_node_t * p_node, uint8_t port_num, * p_node * [in] Pointer to an osm_node_t object. * +* port_num +* [in] Local port number. +* * p_madw * [in] Pointer to a osm_madw_t object containing a mad with * the node's NodeInfo attribute as discovered through the @@ -517,7 +520,7 @@ void osm_node_link(IN osm_node_t * p_node, IN uint8_t port_num, * [in] Port number in p_node through which to create the link. * * p_remote_node -* [in] Pointer to the remote port object. +* [in] Pointer to the remote node object. * * remote_port_num * [in] Port number in the remote's node through which to @@ -553,7 +556,7 @@ void osm_node_unlink(IN osm_node_t * p_node, IN uint8_t port_num, * [in] Port number in p_node through which to unlink. * * p_remote_node -* [in] Pointer to the remote port object. +* [in] Pointer to the remote node object. * * remote_port_num * [in] Port number in the remote's node through which to unlink. @@ -590,7 +593,7 @@ boolean_t osm_node_link_exists(IN osm_node_t * p_node, IN uint8_t port_num, * [in] Port number in p_node through which to check the link. * * p_remote_node -* [in] Pointer to the remote port object. +* [in] Pointer to the remote node object. * * remote_port_num * [in] Port number in the remote's node through which to @@ -660,6 +663,13 @@ boolean_t osm_node_link_has_valid_ports(IN osm_node_t * p_node, * port_num * [in] Port number in p_node through which to check the link. * +* p_remote_node +* [in] Pointer to the remote node object. +* +* remote_port_num +* [in] Port number in the remote's node through which to +* check this link. +* * RETURN VALUES * Return TRUE if both ports in the link are valid (initialized). * Returns FALSE otherwise.