XGMI info

Functions

XGMI info

Functions
amdsmi_status_t	amdsmi_get_link_metrics (amdsmi_processor_handle processor_handle, amdsmi_link_metrics_t *link_metrics)
	Return link metric information. More...
amdsmi_status_t	amdsmi_get_link_topology (amdsmi_processor_handle processor_handle_src, amdsmi_processor_handle processor_handle_dst, amdsmi_link_topology_t *topology_info)
	Return link topology information between two connected processors. More...
amdsmi_status_t	amdsmi_get_xgmi_fb_sharing_caps (amdsmi_processor_handle processor_handle, amdsmi_xgmi_fb_sharing_caps_t *caps)
	Return XGMI capabilities. More...
amdsmi_status_t	amdsmi_get_xgmi_fb_sharing_mode_info (amdsmi_processor_handle processor_handle_src, amdsmi_processor_handle processor_handle_dst, amdsmi_xgmi_fb_sharing_mode_t mode, uint8_t *fb_sharing)
	Return XGMI framebuffer sharing information between two GPUs. More...
amdsmi_status_t	amdsmi_set_xgmi_fb_sharing_mode (amdsmi_processor_handle processor_handle, amdsmi_xgmi_fb_sharing_mode_t mode)
	Set XGMI framebuffer sharing mode. More...
amdsmi_status_t	amdsmi_set_xgmi_fb_sharing_mode_v2 (amdsmi_processor_handle *processor_list, uint32_t num_processors, amdsmi_xgmi_fb_sharing_mode_t mode)
	Set XGMI framebuffer custom sharing mode. More...

Detailed Description

Function Documentation

◆ amdsmi_get_link_metrics()

amdsmi_status_t amdsmi_get_link_metrics	(	amdsmi_processor_handle	processor_handle,
		amdsmi_link_metrics_t *	link_metrics
	)

Return link metric information.

Parameters

[in]	processor_handle	PF of a processor for which to query
[out]	link_metrics	reference to the link metrics struct. Must be allocated by user.

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_link_topology()

amdsmi_status_t amdsmi_get_link_topology	(	amdsmi_processor_handle	processor_handle_src,
		amdsmi_processor_handle	processor_handle_dst,
		amdsmi_link_topology_t *	topology_info
	)

Return link topology information between two connected processors.

Parameters

[in]	processor_handle_src	Source PF of a processor for which to query
[in]	processor_handle_dst	Destination PF of a processor for which to query
[out]	topology_info	reference to the link topology struct. Must be allocated by user.

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_xgmi_fb_sharing_caps()

amdsmi_status_t amdsmi_get_xgmi_fb_sharing_caps	(	amdsmi_processor_handle	processor_handle,
		amdsmi_xgmi_fb_sharing_caps_t *	caps
	)

Return XGMI capabilities.

Parameters

[in]	processor_handle	PF of a processor for which to query
[out]	caps	reference to the xgmi caps union. Must be allocated by user.

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_xgmi_fb_sharing_mode_info()

amdsmi_status_t amdsmi_get_xgmi_fb_sharing_mode_info	(	amdsmi_processor_handle	processor_handle_src,
		amdsmi_processor_handle	processor_handle_dst,
		amdsmi_xgmi_fb_sharing_mode_t	mode,
		uint8_t *	fb_sharing
	)

Return XGMI framebuffer sharing information between two GPUs.

Parameters

[in]	processor_handle_src	Source PF of a processor for which to query
[in]	processor_handle_dst	Destination PF of a processor for which to query
[in]	mode	Enum representing the framebuffer sharing mode to query
[out]	fb_sharing	Indicates framebuffer sharing between two processors. Must be allocated by user.

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_set_xgmi_fb_sharing_mode()

amdsmi_status_t amdsmi_set_xgmi_fb_sharing_mode	(	amdsmi_processor_handle	processor_handle,
		amdsmi_xgmi_fb_sharing_mode_t	mode
	)

Set XGMI framebuffer sharing mode.

Note

This API will only work if there's no guest VM running.

Parameters

[in]	processor_handle	PF of a processor for which to query
[in]	mode	Enum representing the framebuffer sharing mode to set

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_set_xgmi_fb_sharing_mode_v2()

amdsmi_status_t amdsmi_set_xgmi_fb_sharing_mode_v2	(	amdsmi_processor_handle *	processor_list,
		uint32_t	num_processors,
		amdsmi_xgmi_fb_sharing_mode_t	mode
	)

Set XGMI framebuffer custom sharing mode.

Note

This API will only work if there's no guest VM running. This api can be used for custom and auto setting of xgmi frame buffer sharing. In case of custom mode:

• All processors in the list must be on the same NUMA node. Otherwise, api will return error.
• If any processor from the list already belongs to an existing group, the existing group will be released automatically. In case of auto mode(MODE_X):
• The input parameters num_processors should be 1 and processor_list[0] should be valid. Only the first element of processor_list is taken into account and it can be any gpu0,gpu1,...

Parameters

[in]	processor_list	The list of processors
[in]	num_processors	The number of processors in the list
[in]	mode	Enum representing the framebuffer sharing mode to set

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail