Skip to content

Commit

Permalink
API: document the linkspeed as runtime-changing
Browse files Browse the repository at this point in the history
Copy-paste what we had in lstopo.1 and make it appear
in the doxygen-generated doc.

Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr>
(cherry picked from commit bc13d5c)
(cherry picked from commit 5e61b6d)
  • Loading branch information
bgoglin committed Nov 10, 2023
1 parent 6b4a02c commit c1dee2d
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion include/hwloc.h
Expand Up @@ -675,7 +675,12 @@ union hwloc_obj_attr_u {
unsigned short class_id;
unsigned short vendor_id, device_id, subvendor_id, subdevice_id;
unsigned char revision;
float linkspeed; /* in GB/s */
float linkspeed; /**< \brief Link speed in GB/s.
* This datarate is the currently configured speed of the entire PCI link
* (sum of the bandwidth of all PCI lanes in that link).
* It may change during execution since some devices are able to
* slow their PCI links down when idle.
*/
} pcidev;
/** \brief Bridge specific Object Attributes */
struct hwloc_bridge_attr_s {
Expand Down

0 comments on commit c1dee2d

Please sign in to comment.