Power Control#
Power Control
  Functions | |
| amdsmi_status_t | amdsmi_get_cpu_socket_power (amdsmi_processor_handle processor_handle, uint32_t *ppower) | 
| Get the socket power.  More... | |
| amdsmi_status_t | amdsmi_get_cpu_socket_power_cap (amdsmi_processor_handle processor_handle, uint32_t *pcap) | 
| Get the socket power cap.  More... | |
| amdsmi_status_t | amdsmi_get_cpu_socket_power_cap_max (amdsmi_processor_handle processor_handle, uint32_t *pmax) | 
| Get the maximum power cap value for a given socket.  More... | |
| amdsmi_status_t | amdsmi_get_cpu_pwr_svi_telemetry_all_rails (amdsmi_processor_handle processor_handle, uint32_t *power) | 
| Get the SVI based power telemetry for all rails.  More... | |
| amdsmi_status_t | amdsmi_set_cpu_socket_power_cap (amdsmi_processor_handle processor_handle, uint32_t pcap) | 
| Set the power cap value for a given socket.  More... | |
| amdsmi_status_t | amdsmi_set_cpu_pwr_efficiency_mode (amdsmi_processor_handle processor_handle, uint8_t mode) | 
| Set the power efficiency profile policy.  More... | |
Detailed Description
Function Documentation
◆ amdsmi_get_cpu_socket_power()
| amdsmi_status_t amdsmi_get_cpu_socket_power | ( | amdsmi_processor_handle | processor_handle, | 
| uint32_t * | ppower | ||
| ) | 
Get the socket power.
- Platform:
 - cpu_bm
 
- Parameters
 - 
  
[in] processor_handle Cpu socket which to query [in,out] ppower - Input buffer to return socket power  
- Returns
 - amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail
 
◆ amdsmi_get_cpu_socket_power_cap()
| amdsmi_status_t amdsmi_get_cpu_socket_power_cap | ( | amdsmi_processor_handle | processor_handle, | 
| uint32_t * | pcap | ||
| ) | 
Get the socket power cap.
- Platform:
 - cpu_bm
 
- Parameters
 - 
  
[in] processor_handle Cpu socket which to query [in,out] pcap - Input buffer to return power cap.  
- Returns
 - amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail
 
◆ amdsmi_get_cpu_socket_power_cap_max()
| amdsmi_status_t amdsmi_get_cpu_socket_power_cap_max | ( | amdsmi_processor_handle | processor_handle, | 
| uint32_t * | pmax | ||
| ) | 
Get the maximum power cap value for a given socket.
- Platform:
 - cpu_bm
 
- Parameters
 - 
  
[in] processor_handle Cpu socket which to query [in,out] pmax - Input buffer to return maximum power limit value  
- Returns
 - amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail
 
◆ amdsmi_get_cpu_pwr_svi_telemetry_all_rails()
| amdsmi_status_t amdsmi_get_cpu_pwr_svi_telemetry_all_rails | ( | amdsmi_processor_handle | processor_handle, | 
| uint32_t * | power | ||
| ) | 
Get the SVI based power telemetry for all rails.
- Platform:
 - cpu_bm
 
- Parameters
 - 
  
[in] processor_handle Cpu socket which to query [in,out] power - Input buffer to return svi based power value  
- Returns
 - amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail
 
◆ amdsmi_set_cpu_socket_power_cap()
| amdsmi_status_t amdsmi_set_cpu_socket_power_cap | ( | amdsmi_processor_handle | processor_handle, | 
| uint32_t | pcap | ||
| ) | 
Set the power cap value for a given socket.
- Platform:
 - cpu_bm
 
- Parameters
 - 
  
[in] processor_handle Cpu socket which to query [in] power - Input power limit value  
- Returns
 - amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail
 
◆ amdsmi_set_cpu_pwr_efficiency_mode()
| amdsmi_status_t amdsmi_set_cpu_pwr_efficiency_mode | ( | amdsmi_processor_handle | processor_handle, | 
| uint8_t | mode | ||
| ) | 
Set the power efficiency profile policy.
- Platform:
 - cpu_bm
 
- Parameters
 - 
  
[in] processor_handle Cpu socket which to query [in] mode - mode to be set  
- Returns
 - amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail