Re: [External] Re: [PATCH v6 1/3] Documentation: Add documentation for new platform_profile sysfs attribute

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Rafael,

On 16/12/2020 13:34, Rafael J. Wysocki wrote:
> On Fri, Dec 11, 2020 at 3:15 AM Mark Pearson <markpearson@xxxxxxxxxx> wrote:
>>
<snip>
>>
>> diff --git a/Documentation/ABI/testing/sysfs-platform_profile b/Documentation/ABI/testing/sysfs-platform_profile
>> new file mode 100644
>> index 000000000000..5ac14268585f
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-platform_profile
>> @@ -0,0 +1,24 @@
>> +What:          /sys/firmware/acpi/platform_profile_choices
>> +Date:          October 2020
>> +Contact:       Hans de Goede <hdegoede@xxxxxxxxxx>
>> +Description:   This file contains a space-separated list of profiles supported for this device.
>> +
>> +               Drivers must use the following standard profile-names:
>> +
>> +               ============    ============================================
>> +               low-power       Low power consumption
>> +               cool            Cooler operation
>> +               quiet           Quieter operation
>> +               balanced        Balance between low power consumption and performance
>> +               performance     High performance operation
>> +               ============    ============================================
>> +
>> +               Userspace may expect drivers to offer more than one of these
>> +               standard profile names.
>> +
>> +What:          /sys/firmware/acpi/platform_profile
>> +Date:          October 2020
>> +Contact:       Hans de Goede <hdegoede@xxxxxxxxxx>
>> +Description:   Reading this file gives the current selected profile for this
>> +               device. Writing this file with one of the strings from
>> +               available_profiles changes the profile to the new value.
> 
> IIUC s/available_profiles/platform_profile_choices/
Yep - I missed this one. Thank you, I'll update
> 
>> diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
>> index acd2cc2a538d..d29b020e5622 100644
>> --- a/Documentation/userspace-api/index.rst
>> +++ b/Documentation/userspace-api/index.rst
>> @@ -24,6 +24,7 @@ place where this information is gathered.
>>     ioctl/index
>>     iommu
>>     media/index
>> +   sysfs-platform_profile
>>
>>  .. only::  subproject and html
>>
>> diff --git a/Documentation/userspace-api/sysfs-platform_profile.rst b/Documentation/userspace-api/sysfs-platform_profile.rst
>> new file mode 100644
>> index 000000000000..56639d218003
>> --- /dev/null
>> +++ b/Documentation/userspace-api/sysfs-platform_profile.rst
>> @@ -0,0 +1,43 @@
>> +=====================================================================
>> +Platform Profile Selection (e.g. /sys/firmware/acpi/platform_profile)
>> +=====================================================================
>> +
>> +On modern systems the platform performance, temperature, fan and other
>> +hardware related characteristics are often dynamically configurable. The
>> +profile is often automatically adjusted to the load by some
> 
> After reading this one more time it looks to me like referring to the
> profile here is premature, it needs to be defined first.
> 
> Maybe say "The platform configuration is often ..."
> 
> Iit is also unclear what "the load" means here, so I would say
> something like "adjusted to the current conditions" to avoid using
> that term.
I'm good with both those suggestions. Thank you. I'll update

Mark



[Index of Archives]     [Linux Kernel Development]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux