Auxillary 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.  More... | |
| amdsmi_status_t | amdsmi_get_cpu_family (uint32_t *cpu_family) | 
| Get CPU family.  More... | |
| amdsmi_status_t | amdsmi_get_cpu_model (uint32_t *cpu_model) | 
| Get CPU model.  More... | |
| 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.  More... | |
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_handle Cpu 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.
- 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.
- 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_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