E-SMI In-band Library

NEW! E-SMI library beta 5.0 is now available

The EPYC™ System Management Interface In-band Library, is a C-library for Linux, which provides APIs for In-band user space software to monitor and control the CPU’s power, energy, performance, and other system management functionality.

Highlights of major release v5.0.0

• AMD Family 0x1A and model 0x50-0x5F processors are supported in this release.
• Support for new system management features in tool and library, such as
  • Get APB status and Data Fabric pstate(if APBDisabled)
  • Get xgmi link width
  • Get df pstate range and xgmi pstate range for a given socket
  • Get Temperature delta (Tdelta) for a given socket
  • Get DIMM Sideband register data
  • Get SVI3 VR Controller temperature
  • Get and Set for PC6 and CC6 Control
  • Get CCD power for a given core.
• Furthermore, the following logging support has been enabled to enhance user experience, improve power management debugging capabilities, and boost automation capabilities for the Power Debug Team. 
  • LoopWatch
  • Logger (CSV format)
  • JSON/CSV Format summary

Highlights of major release v4.0.0

• AMD Family 0x1A and model 0x00-0x1 processors are supported in this release.
• Any of the hsmp/amd_energy/msr_safe/msr driver can be used to monitor energy.

Highlights of major release v3.0.0

• AMD MI300 processors are supported in this release.
• Library is modified to support platform-specific check in each message in an organized way.
• tool options are modified to show valid input values

Highlights of minor release v2.1

• Library is updated to align with changes in the processor spec

Highlights of major release v2.0

• Supports new HSMP protocol version 5 messages, defined for Family 19h Model 10h - SP5
  • New APIs are added for platform features
  • esmi_tool is updated with platform specific features

Highlights of minor release v1.5

• Supports ioctl-based implementation of hsmp driver with support for following new APIs
  • Set XGMI link width for 2P-connected systems
  • Set LCLK dpm level for NBIO id
  • APB Disable and Enable messages

Highlights of minor release v1.2

• Support to compile E-SMI In-band library as static
• Support for new system management features in tool and library, such as
  • Get SMU Firmware version
  • Get PROCHOT status
  • Get clocks
    • CPU clock frequency limit
    • Data Fabric Clock(fclk),
    • DRAM Memory Clock(mclk) and
  •  Provide maximum DDR bandwidth (theoretical) & DDR bandwidth utilization
• Add more options and improve the tool’s console output for readability

Highlights of minor release v1.1

• Support for creating RPM and DEB packages
• Auxiliary APIs to provide system topology
• An API to read all the Energy counters on the CPU at once.
• Single command to create a doxygen-based PDF document
• Updated e_smi_tool supporting all the above information
• Cosmetic changes to the tool

Highlights of major release v1.0

• Power
  • Current Power Consumed
  • Power Limit
  • Max Power Limit
• Performance
  • Boostlimit
• Energy
  • Energy Consumed
• e_smi_tool, user application supporting all the above information.

Specifications

Supported Processors:

• AMD CPU Family 19h Models 0h-Fh (Milan), 10h-1Fh (Genoa), A0h-AFh (Genoa-Dense).
• AMD CPU Family 19h Models 30h-3Fh (Badami).
• AMD CPU Family 1Ah Models 0h-Fh (Turin), 10h-1Fh (Turin-Dense).
• AMD APU Family 19h Models 90h-9fh (MI300A).
• AMD CPU Family 1Ah Models 50h-5Fh (Venice).

Operating Systems

AMD E-SMI In-band library is tested on the following distributions

• Ubuntu 18.04 and later
• SUSE SLES 15 and later 
• RHEL 8.1 and later 

Dependency

This new e-smi release works well with amd_hsmp driver version 2.4. Not all features will work with version < 2.4. Setting cpu rail iso frequency policy, df c-state enabling, xGMI pstate range setting, etc. will only work with the 2.4 version of the amd_hsmp driver.

Resources and Technical Support

Resources

• Documentation: E-SMI Manual
• Source Code

Support

Thank you for using AMD E-SMI In-band Library. Please use E-SMI In-band Support for bug reports, support and feature requests.

Known Issues

In creating a package if “make install” is used previously with “sudo”, you will need to create a package with sudo permission, “sudo make package”, otherwise permission denied error is popped.