Generated from osm_path.h with ROBODoc vunknown on Wed Aug 07 15:31:46 2002
TABLE OF CONTENTS
- OpenSM/DR Path
- OpenSM: DR Path/osm_dr_path_t
- OpenSM: DR Path/osm_dr_path_construct
- OpenSM: DR Path/osm_dr_path_init
- OpenSM: DR Path/osm_dr_path_extend
- OpenSM: DR Path/osm_dr_path_get_bind_handle
NAME
DR Path
DESCRIPTION
The DR Path structure encapsulates a directed route through the subnet.
This structure allows direct access to member variables.
AUTHOR
Steve King, Intel
NAME
osm_dr_path_t
DESCRIPTION
Directed Route structure.
This structure allows direct access to member variables.
SYNOPSIS
typedef struct _osm_dr_path
{
osm_bind_handle_t h_bind;
uint8_t hop_count;
uint8_t path[IB_SUBNET_PATH_HOPS_MAX];
} osm_dr_path_t;
FIELDS
h_bind
Bind handle for port to which this path applies.
hop_count
The number of hops in this path.
path
The array of port numbers that comprise this path.
SEE ALSO
DR Path structure
NAME
osm_dr_path_construct
DESCRIPTION
This function constructs a directed route path object.
SYNOPSIS
void
osm_dr_path_construct(
IN osm_dr_path_t* const p_path );
PARAMETERS
p_path
[in] Pointer to a directed route path oject to initialize.
h_bind
[in] Bind handle for the port on which this path applies.
hop_count
[in] Hop count needed to reach this node.
path
[in] Directed route path to reach this node.
RETURN VALUE
None.
NOTES
SEE ALSO
NAME
osm_dr_path_init
DESCRIPTION
This function initializes a directed route path object.
SYNOPSIS
void
osm_dr_path_init(
IN osm_dr_path_t* const p_path,
IN const osm_bind_handle_t h_bind,
IN const uint8_t hop_count,
IN const uint8_t path[IB_SUBNET_PATH_HOPS_MAX] );
PARAMETERS
p_path
[in] Pointer to a directed route path oject to initialize.
h_bind
[in] Bind handle for the port on which this path applies.
hop_count
[in] Hop count needed to reach this node.
path
[in] Directed route path to reach this node.
RETURN VALUE
None.
NOTES
SEE ALSO
NAME
osm_dr_path_extend
DESCRIPTION
Adds a new hop to a path.
SYNOPSIS
void
osm_dr_path_extend(
IN osm_dr_path_t* const p_path,
IN const uint8_t port_num );
PARAMETERS
p_path
[in] Pointer to a directed route path oject to initialize.
port_num
[in] Additional port to add to the DR path.
RETURN VALUE
None.
NOTES
SEE ALSO
NAME
osm_dr_path_get_bind_handle
DESCRIPTION
Gets the bind handle from a path.
SYNOPSIS
osm_bind_handle_t
osm_dr_path_get_bind_handle(
IN const osm_dr_path_t* const p_path );
PARAMETERS
p_path
[in] Pointer to a directed route path oject to initialize.
port_num
[in] Additional port to add to the DR path.
RETURN VALUE
None.
NOTES
SEE ALSO