sysfs-platform_profile.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. =====================================================================
  2. Platform Profile Selection (e.g. /sys/firmware/acpi/platform_profile)
  3. =====================================================================
  4. On modern systems the platform performance, temperature, fan and other
  5. hardware related characteristics are often dynamically configurable. The
  6. platform configuration is often automatically adjusted to the current
  7. conditions by some automatic mechanism (which may very well live outside
  8. the kernel).
  9. These auto platform adjustment mechanisms often can be configured with
  10. one of several platform profiles, with either a bias towards low power
  11. operation or towards performance.
  12. The purpose of the platform_profile attribute is to offer a generic sysfs
  13. API for selecting the platform profile of these automatic mechanisms.
  14. Note that this API is only for selecting the platform profile, it is
  15. NOT a goal of this API to allow monitoring the resulting performance
  16. characteristics. Monitoring performance is best done with device/vendor
  17. specific tools such as e.g. turbostat.
  18. Specifically when selecting a high performance profile the actual achieved
  19. performance may be limited by various factors such as: the heat generated
  20. by other components, room temperature, free air flow at the bottom of a
  21. laptop, etc. It is explicitly NOT a goal of this API to let userspace know
  22. about any sub-optimal conditions which are impeding reaching the requested
  23. performance level.
  24. Since numbers on their own cannot represent the multiple variables that a
  25. profile will adjust (power consumption, heat generation, etc) this API
  26. uses strings to describe the various profiles. To make sure that userspace
  27. gets a consistent experience the sysfs-platform_profile ABI document defines
  28. a fixed set of profile names. Drivers *must* map their internal profile
  29. representation onto this fixed set.
  30. If there is no good match when mapping then a new profile name may be
  31. added. Drivers which wish to introduce new profile names must:
  32. 1. Explain why the existing profile names canot be used.
  33. 2. Add the new profile name, along with a clear description of the
  34. expected behaviour, to the sysfs-platform_profile ABI documentation.