From patchwork Wed Nov 7 14:22:41 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Honggang LI X-Patchwork-Id: 10672435 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 8928D14E2 for ; Wed, 7 Nov 2018 14:23:13 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6E64A2C0DA for ; Wed, 7 Nov 2018 14:23:13 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 62E0D2C13B; Wed, 7 Nov 2018 14:23:13 +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 C5DD92C127 for ; Wed, 7 Nov 2018 14:23:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726886AbeKGXxq (ORCPT ); Wed, 7 Nov 2018 18:53:46 -0500 Received: from mx1.redhat.com ([209.132.183.28]:43804 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726830AbeKGXxq (ORCPT ); Wed, 7 Nov 2018 18:53:46 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id B035C7F6A7; Wed, 7 Nov 2018 14:23:11 +0000 (UTC) Received: from lhg.nay.redhat.com (unknown [10.66.129.124]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4AFAE60464; Wed, 7 Nov 2018 14:23:10 +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_vl15intf.h: Minor update of comments Date: Wed, 7 Nov 2018 22:22:41 +0800 Message-Id: <20181107142246.28336-1-honli@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.25]); Wed, 07 Nov 2018 14:23:11 +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_vl15intf.h | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/include/opensm/osm_vl15intf.h b/include/opensm/osm_vl15intf.h index b024b23a..589e03a3 100644 --- a/include/opensm/osm_vl15intf.h +++ b/include/opensm/osm_vl15intf.h @@ -92,7 +92,7 @@ BEGIN_C_DECLS * osm_vl15_state_t * * DESCRIPTION -* Enumerates the possible states of SM object. +* Enumerates the possible states of OpenSM VL15 object. * * SYNOPSIS */ @@ -150,6 +150,9 @@ typedef struct osm_vl15 { * signal * Event on which the poller sleeps. * +* poller +* Worker thread pool that services the fifo to transmit VL15 MADs +* * rfifo * First-in First-out queue for outbound VL15 MADs for which * a response is expected, aka the "response fifo" @@ -158,9 +161,6 @@ typedef struct osm_vl15 { * First-in First-out queue for outbound VL15 MADs for which * no response is expected, aka the "unicast fifo". * -* poller -* Worker thread pool that services the fifo to transmit VL15 MADs -* * lock * Spinlock guarding the FIFO. * @@ -224,8 +224,8 @@ void osm_vl15_destroy(IN osm_vl15_t * p_vl15, IN struct osm_mad_pool *p_pool); * p_vl15 * [in] Pointer to a VL15 object to destroy. * -* p_pool -* [in] The pointer to the mad pool to return outstanding mads to +* p_pool +* [in] The pointer to the mad pool to return outstanding mads to * * RETURN VALUE * This function does not return a value. @@ -240,11 +240,6 @@ void osm_vl15_destroy(IN osm_vl15_t * p_vl15, IN struct osm_mad_pool *p_pool); * VL15 object, osm_vl15_construct, osm_vl15_init *********/ -/* - Initialization. - Rate specifies the minimum number of microseconds between transmissions - on VL15. -*/ /****f* OpenSM: VL15/osm_vl15_init * NAME * osm_vl15_init @@ -372,8 +367,8 @@ void osm_vl15_shutdown(IN osm_vl15_t * p_vl, IN osm_mad_pool_t * p_mad_pool); * p_vl15 * [in] Pointer to an osm_vl15_t object. * -* p_mad_pool -* [in] The MAD pool owning the mads. +* p_mad_pool +* [in] The MAD pool owning the mads. * * RETURN VALUES * None.