Main Page | Modules | Directories | File List | Globals | Related Pages

gm_max_node_id_in_use.c File Reference

#include "gm_call_trace.h"
#include "gm_internal.h"

Functions

GM_ENTRY_POINT gm_status_t gm_max_node_id_in_use (gm_port_t *port, unsigned int *n)

Detailed Description

This file contains the GM API function gm_max_node_id_in_use().

This function exists to allow gm_board_info to have a guess for an upper limit to the actual number of nodes in the route table Without it, gm_board_info calls thousands of _gm_get_route() calls. When debugging, this is really a mess.


Function Documentation

GM_ENTRY_POINT gm_status_t gm_max_node_id_in_use gm_port_t *  port,
unsigned int *  n
 

gm_max_node_id_in_use() returns the maximum GM node ID that is in use by the network attached to the port.

See also:
_gm_get_route
Return values:
GM_SUCCESS Operation completed successfully.
GM_UNATTACHED 
Parameters:
port (IN) The GM port.
n (OUT) Buffer containing the maximum GM node ID.
Author:
Glenn Brown
Version:
GM_API_VERSION (as defined in gm.h)


Generated on Sat May 20 19:20:41 2006 for GM by  doxygen 1.4.4