From: Honggang Li <honli@xxxxxxxxxx> Signed-off-by: Honggang Li <honli@xxxxxxxxxx> --- 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. -- 2.14.4