From patchwork Wed Nov 21 06:58:06 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Honggang LI X-Patchwork-Id: 10692045 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 BBE1415A7 for ; Wed, 21 Nov 2018 06:58:21 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A60892B980 for ; Wed, 21 Nov 2018 06:58:21 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 96E512B985; Wed, 21 Nov 2018 06:58:21 +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.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI,SUBJ_OBFU_PUNCT_MANY 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 3C7082B980 for ; Wed, 21 Nov 2018 06:58:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728220AbeKURbe (ORCPT ); Wed, 21 Nov 2018 12:31:34 -0500 Received: from mx1.redhat.com ([209.132.183.28]:56040 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726039AbeKURbd (ORCPT ); Wed, 21 Nov 2018 12:31:33 -0500 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id D4C8930821EF; Wed, 21 Nov 2018 06:58:17 +0000 (UTC) Received: from lhg.nay.redhat.com (unknown [10.66.129.124]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6E3A617A8F; Wed, 21 Nov 2018 06:58:16 +0000 (UTC) From: Honggang LI To: hal@dev.mellanox.co.il Cc: linux-rdma@vger.kernel.org, Honggang Li Subject: [opensm patch 1/6] opensm/osm_ucast_cache.h: Improve coding style and comments Date: Wed, 21 Nov 2018 14:58:06 +0800 Message-Id: <20181121065811.21806-1-honli@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.47]); Wed, 21 Nov 2018 06:58:17 +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_ucast_cache.h | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/include/opensm/osm_ucast_cache.h b/include/opensm/osm_ucast_cache.h index e186590f..316a7f61 100644 --- a/include/opensm/osm_ucast_cache.h +++ b/include/opensm/osm_ucast_cache.h @@ -89,7 +89,7 @@ struct osm_ucast_mgr; * * SYNOPSIS */ -void osm_ucast_cache_invalidate(struct osm_ucast_mgr *p_mgr); +void osm_ucast_cache_invalidate(IN struct osm_ucast_mgr *p_mgr); /* * PARAMETERS * p_mgr @@ -115,19 +115,27 @@ void osm_ucast_cache_invalidate(struct osm_ucast_mgr *p_mgr); * * SYNOPSIS */ -void osm_ucast_cache_check_new_link(struct osm_ucast_mgr *p_mgr, - osm_node_t * p_node_1, uint8_t port_num_1, - osm_node_t * p_node_2, uint8_t port_num_2); +void osm_ucast_cache_check_new_link(IN struct osm_ucast_mgr *p_mgr, + IN osm_node_t * p_node_1, + IN uint8_t port_num_1, + IN osm_node_t * p_node_2, + IN uint8_t port_num_2); /* * PARAMETERS * p_mgr * [in] Pointer to the unicast manager object. * -* physp1 -* [in] Pointer to the first physical port of the link. +* p_node_1 +* [in] Pointer to the first node of the link. * -* physp2 -* [in] Pointer to the second physical port of the link. +* port_num_1 +* [in] Port number of the first node. +* +* p_node_2 +* [in] Pointer to the second node of the link. +* +* port_num_2 +* [in] Port number of the second node. * * RETURN VALUE * This function does not return any value. @@ -151,8 +159,9 @@ void osm_ucast_cache_check_new_link(struct osm_ucast_mgr *p_mgr, * * SYNOPSIS */ -void osm_ucast_cache_add_link(struct osm_ucast_mgr *p_mgr, - osm_physp_t * physp1, osm_physp_t * physp2); +void osm_ucast_cache_add_link(IN struct osm_ucast_mgr *p_mgr, + IN osm_physp_t * physp1, + IN osm_physp_t * physp2); /* * PARAMETERS * p_mgr @@ -188,7 +197,8 @@ void osm_ucast_cache_add_link(struct osm_ucast_mgr *p_mgr, * * SYNOPSIS */ -void osm_ucast_cache_add_node(struct osm_ucast_mgr *p_mgr, osm_node_t * p_node); +void osm_ucast_cache_add_node(IN struct osm_ucast_mgr *p_mgr, + IN osm_node_t * p_node); /* * PARAMETERS * p_mgr @@ -218,7 +228,7 @@ void osm_ucast_cache_add_node(struct osm_ucast_mgr *p_mgr, osm_node_t * p_node); * * SYNOPSIS */ -int osm_ucast_cache_process(struct osm_ucast_mgr *p_mgr); +int osm_ucast_cache_process(IN struct osm_ucast_mgr *p_mgr); /* * PARAMETERS * p_mgr