Auxillary functions

Auxillary functions#

AMD SMI: Auxillary functions
Functions
Auxillary functions

Functions

amdsmi_status_t amdsmi_first_online_core_on_cpu_socket (amdsmi_processor_handle processor_handle, uint32_t *pcore_ind)
 Get first online core on socket.
 
amdsmi_status_t amdsmi_get_cpu_family (uint32_t *cpu_family)
 Get CPU family.
 
amdsmi_status_t amdsmi_get_cpu_model (uint32_t *cpu_model)
 Get CPU model.
 
amdsmi_status_t amdsmi_get_cpu_model_name (amdsmi_processor_handle processor_handle, amdsmi_cpu_info_t *cpu_info)
 Retrieve the CPU processor model name based on the processor index.
 
amdsmi_status_t amdsmi_get_esmi_err_msg (amdsmi_status_t status, const char **status_string)
 Get a description of provided AMDSMI error status for esmi errors.
 
amdsmi_status_t amdsmi_get_cpu_cores_per_socket (uint32_t sock_count, amdsmi_sock_info_t *soc_info)
 Get cpu cores per socket from sys filesystem.
 
amdsmi_status_t amdsmi_get_cpu_socket_count (uint32_t *sock_count)
 Get CPU socket count from sys filesystem.
 

Detailed Description

Function Documentation

◆ amdsmi_first_online_core_on_cpu_socket()

amdsmi_status_t amdsmi_first_online_core_on_cpu_socket ( amdsmi_processor_handle  processor_handle,
uint32_t *  pcore_ind 
)

Get first online core on socket.

Platform:
cpu_bm
Parameters
[in]processor_handleCpu socket which to query
[in,out]pcore_ind- Input buffer to fill first online core on socket data
Returns
amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_cpu_family()

amdsmi_status_t amdsmi_get_cpu_family ( uint32_t *  cpu_family)

Get CPU family.

Platform:
cpu_bm
Parameters
[in,out]cpu_family- Input buffer to return the cpu family
Returns
amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_cpu_model()

amdsmi_status_t amdsmi_get_cpu_model ( uint32_t *  cpu_model)

Get CPU model.

Platform:
cpu_bm
Parameters
[in,out]cpu_model- Input buffer to return the cpu model
Returns
amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_cpu_model_name()

amdsmi_status_t amdsmi_get_cpu_model_name ( amdsmi_processor_handle  processor_handle,
amdsmi_cpu_info_t *  cpu_info 
)

Retrieve the CPU processor model name based on the processor index.

Platform:
cpu_bm

This function obtains the CPU model name associated with the specified processor index from the list of available processor handles. Before invoking this function, ensure that the list of processor handles is properly initialized and that the processor type is specified. This function is to be utilized for RDC and is not part of ESMI library.

Parameters
[in]processor_handleCpu socket which to query
[out]cpu_infoA pointer to an amdsmi_cpu_info_t structure that will be populated with the CPU processor model information upon successful execution of the function.
Returns
amdsmi_status_t indicating the result of the operation.
  • AMDSMI_STATUS_SUCCESS on successful retrieval of the model name.
  • A non-zero error code if the operation fails.

◆ amdsmi_get_esmi_err_msg()

amdsmi_status_t amdsmi_get_esmi_err_msg ( amdsmi_status_t  status,
const char **  status_string 
)

Get a description of provided AMDSMI error status for esmi errors.

Platform:
cpu_bm

Set the provided pointer to a const char *, status_string, to a string containing a description of the provided error code status.

Parameters
[in]status- The error status for which a description is desired.
[in,out]status_string- A pointer to a const char * which will be made to point to a description of the provided error code
Returns
amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_cpu_cores_per_socket()

amdsmi_status_t amdsmi_get_cpu_cores_per_socket ( uint32_t  sock_count,
amdsmi_sock_info_t *  soc_info 
)

Get cpu cores per socket from sys filesystem.

Platform:
cpu_bm
Parameters
[in]sock_count- cpu socket count
[in,out]soc_info- Input buffer to return the cpu cores per socket
Returns
amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_cpu_socket_count()

amdsmi_status_t amdsmi_get_cpu_socket_count ( uint32_t *  sock_count)

Get CPU socket count from sys filesystem.

Platform:
cpu_bm
Parameters
[in,out]sock_count- Input buffer to return the cpu socket count
Returns
amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail