XGMI Functions

XGMI Functions#

AMD SMI: XGMI Functions

Functions
amdsmi_status_t	amdsmi_gpu_xgmi_error_status (amdsmi_processor_handle processor_handle, amdsmi_xgmi_status_t *status)
	Retrieve the XGMI error status for a device. It is not supported on virtual machine guest. More...

amdsmi_status_t	amdsmi_reset_gpu_xgmi_error (amdsmi_processor_handle processor_handle)
	Reset the XGMI error status for a device. It is not supported on virtual machine guest. More...

amdsmi_status_t	amdsmi_get_xgmi_info (amdsmi_processor_handle processor_handle, amdsmi_xgmi_info_t *info)
	Returns XGMI information for the GPU. More...

amdsmi_status_t	amdsmi_get_gpu_xgmi_link_status (amdsmi_processor_handle processor_handle, amdsmi_xgmi_link_status_t *link_status)
	Get the XGMI link status. More...

Detailed Description

These functions are used to configure, query and control XGMI.

Function Documentation

◆ amdsmi_gpu_xgmi_error_status()

amdsmi_status_t amdsmi_gpu_xgmi_error_status	(	amdsmi_processor_handle	processor_handle,
		amdsmi_xgmi_status_t *	status
	)

Retrieve the XGMI error status for a device. It is not supported on virtual machine guest.

Platform:: gpu_bm_linux

Given a processor handle processor_handle, and a pointer to an amdsmi_xgmi_status_t status, this function will write the current XGMI error state amdsmi_xgmi_status_t for the device processor_handle to the memory pointed to by status.

Parameters

[in]	processor_handle	a processor handle
[in,out]	status	A pointer to an amdsmi_xgmi_status_t to which the XGMI error state should be written If this parameter is nullptr, this function will return AMDSMI_STATUS_INVAL if the function is supported with the provided, arguments and AMDSMI_STATUS_NOT_SUPPORTED if it is not supported with the provided arguments.

Returns: amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_reset_gpu_xgmi_error()

amdsmi_status_t amdsmi_reset_gpu_xgmi_error ( amdsmi_processor_handle processor_handle )

Reset the XGMI error status for a device. It is not supported on virtual machine guest.

Platform:: gpu_bm_linux

Given a processor handle processor_handle, this function will reset the current XGMI error state amdsmi_xgmi_status_t for the device processor_handle to amdsmi_xgmi_status_t::AMDSMI_XGMI_STATUS_NO_ERRORS

Parameters

[in] processor_handle a processor handle

Returns: amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_xgmi_info()

amdsmi_status_t amdsmi_get_xgmi_info	(	amdsmi_processor_handle	processor_handle,
		amdsmi_xgmi_info_t *	info
	)

Returns XGMI information for the GPU.

Platform:: gpu_bm_linux

Parameters

[in]	processor_handle	Device which to query
[out]	info	Reference to xgmi information structure. Must be allocated by user.

Returns: amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_gpu_xgmi_link_status()

amdsmi_status_t amdsmi_get_gpu_xgmi_link_status	(	amdsmi_processor_handle	processor_handle,
		amdsmi_xgmi_link_status_t *	link_status
	)

Get the XGMI link status.

Platform:

gpu_bm_linux

host

Given a processor handle processor_handle, this function will return the link status for each XGMI link connect to this processor. If the processor link type is not XGMI, it should return AMDSMI_STATUS_NOT_SUPPORTED.

Parameters

[in]	processor_handle	a processor handle
[out]	link_status	The link status of the XGMI connect to this processor.

Returns: amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail