| Message ID | 20220912090641.111658-4-Shyam-sundar.S-k@amd.com (mailing list archive) |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | platform/x86/amd/pmf: Introduce CnQF feature for AMD PMF | expand |
On 9/12/2022 04:06, Shyam Sundar S K wrote: > AMD PMF driver provides the flexibility to turn "on" or "off" > CnQF feature (introduced in the earlier patch). > > Add corresponding ABI documentation for the new sysfs node. > > Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> > --- > Documentation/ABI/testing/sysfs-amd-pmf | 11 +++++++++++ > 1 file changed, 11 insertions(+) > create mode 100644 Documentation/ABI/testing/sysfs-amd-pmf > > diff --git a/Documentation/ABI/testing/sysfs-amd-pmf b/Documentation/ABI/testing/sysfs-amd-pmf > new file mode 100644 > index 000000000000..c75d7426c2c7 > --- /dev/null > +++ b/Documentation/ABI/testing/sysfs-amd-pmf > @@ -0,0 +1,11 @@ > +What: /sys/devices/platform/AMDI0102\:00/cnqf/feat Presumably future devices beyond AMDI0102 can possibly support this too. So maybe this should be "/sys/devices/platform/*/cnqf/feat". > +Date: September 2022 > +Contact: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> > +Description: Reading this file tells if the AMD Platform Management(PMF) > + Cool n Quiet Framework(CnQF) feature is enabled or not. > + > + This feature is not enabled by default and gets only turned on > + if OEM BIOS passes a "flag" to PMF ACPI function (index 11 or 12) > + or in case the user writes "on". > + > + To turn off CnQF user can write "off" to the sysfs node. I think you want to have a comment here to the effect that "systems that support auto mode will not have this sysfs file available".
Hi Mario, On 9/12/2022 7:31 PM, Limonciello, Mario wrote: > On 9/12/2022 04:06, Shyam Sundar S K wrote: >> AMD PMF driver provides the flexibility to turn "on" or "off" >> CnQF feature (introduced in the earlier patch). >> >> Add corresponding ABI documentation for the new sysfs node. >> >> Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> >> --- >> Documentation/ABI/testing/sysfs-amd-pmf | 11 +++++++++++ >> 1 file changed, 11 insertions(+) >> create mode 100644 Documentation/ABI/testing/sysfs-amd-pmf >> >> diff --git a/Documentation/ABI/testing/sysfs-amd-pmf >> b/Documentation/ABI/testing/sysfs-amd-pmf >> new file mode 100644 >> index 000000000000..c75d7426c2c7 >> --- /dev/null >> +++ b/Documentation/ABI/testing/sysfs-amd-pmf >> @@ -0,0 +1,11 @@ >> +What: /sys/devices/platform/AMDI0102\:00/cnqf/feat > > Presumably future devices beyond AMDI0102 can possibly support this too. > > So maybe this should be "/sys/devices/platform/*/cnqf/feat". Yes, but still we have not reserved a new _HID for future programs. So, I think its OK to leave it as-is and update this file in future when such change happens? > >> +Date: September 2022 >> +Contact: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> >> +Description: Reading this file tells if the AMD Platform >> Management(PMF) >> + Cool n Quiet Framework(CnQF) feature is enabled or not. >> + >> + This feature is not enabled by default and gets only turned on >> + if OEM BIOS passes a "flag" to PMF ACPI function (index 11 or >> 12) >> + or in case the user writes "on". >> + >> + To turn off CnQF user can write "off" to the sysfs node. > > I think you want to have a comment here to the effect that "systems that > support auto mode will not have this sysfs file available". OK. Will take it in the next revision. Thanks, Shyam
On 9/12/2022 11:21, Shyam Sundar S K wrote: > Hi Mario, > > On 9/12/2022 7:31 PM, Limonciello, Mario wrote: >> On 9/12/2022 04:06, Shyam Sundar S K wrote: >>> AMD PMF driver provides the flexibility to turn "on" or "off" >>> CnQF feature (introduced in the earlier patch). >>> >>> Add corresponding ABI documentation for the new sysfs node. >>> >>> Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> >>> --- >>> Documentation/ABI/testing/sysfs-amd-pmf | 11 +++++++++++ >>> 1 file changed, 11 insertions(+) >>> create mode 100644 Documentation/ABI/testing/sysfs-amd-pmf >>> >>> diff --git a/Documentation/ABI/testing/sysfs-amd-pmf >>> b/Documentation/ABI/testing/sysfs-amd-pmf >>> new file mode 100644 >>> index 000000000000..c75d7426c2c7 >>> --- /dev/null >>> +++ b/Documentation/ABI/testing/sysfs-amd-pmf >>> @@ -0,0 +1,11 @@ >>> +What: /sys/devices/platform/AMDI0102\:00/cnqf/feat >> >> Presumably future devices beyond AMDI0102 can possibly support this too. >> >> So maybe this should be "/sys/devices/platform/*/cnqf/feat". > > Yes, but still we have not reserved a new _HID for future programs. So, > I think its OK to leave it as-is and update this file in future when > such change happens? Documentation is one of the things that is most easily forgotten to update when it's just adding a new _HID, so that's why I was suggesting to get it right "now" if CNQF will likely be available on the new programs too. > >> >>> +Date: September 2022 >>> +Contact: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> >>> +Description: Reading this file tells if the AMD Platform >>> Management(PMF) >>> + Cool n Quiet Framework(CnQF) feature is enabled or not. >>> + >>> + This feature is not enabled by default and gets only turned on >>> + if OEM BIOS passes a "flag" to PMF ACPI function (index 11 or >>> 12) >>> + or in case the user writes "on". >>> + >>> + To turn off CnQF user can write "off" to the sysfs node. >> >> I think you want to have a comment here to the effect that "systems that >> support auto mode will not have this sysfs file available". > > OK. Will take it in the next revision. Thanks. > > Thanks, > Shyam
On 9/12/2022 9:53 PM, Limonciello, Mario wrote: > On 9/12/2022 11:21, Shyam Sundar S K wrote: >> Hi Mario, >> >> On 9/12/2022 7:31 PM, Limonciello, Mario wrote: >>> On 9/12/2022 04:06, Shyam Sundar S K wrote: >>>> AMD PMF driver provides the flexibility to turn "on" or "off" >>>> CnQF feature (introduced in the earlier patch). >>>> >>>> Add corresponding ABI documentation for the new sysfs node. >>>> >>>> Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> >>>> --- >>>> Documentation/ABI/testing/sysfs-amd-pmf | 11 +++++++++++ >>>> 1 file changed, 11 insertions(+) >>>> create mode 100644 Documentation/ABI/testing/sysfs-amd-pmf >>>> >>>> diff --git a/Documentation/ABI/testing/sysfs-amd-pmf >>>> b/Documentation/ABI/testing/sysfs-amd-pmf >>>> new file mode 100644 >>>> index 000000000000..c75d7426c2c7 >>>> --- /dev/null >>>> +++ b/Documentation/ABI/testing/sysfs-amd-pmf >>>> @@ -0,0 +1,11 @@ >>>> +What: /sys/devices/platform/AMDI0102\:00/cnqf/feat >>> >>> Presumably future devices beyond AMDI0102 can possibly support this too. >>> >>> So maybe this should be "/sys/devices/platform/*/cnqf/feat". >> >> Yes, but still we have not reserved a new _HID for future programs. So, >> I think its OK to leave it as-is and update this file in future when >> such change happens? > > Documentation is one of the things that is most easily forgotten to > update when it's just adding a new _HID, so that's why I was suggesting > to get it right "now" if CNQF will likely be available on the new > programs too. Agreed. Will take care of it in v3. Thanks, Shyam > >> >>> >>>> +Date: September 2022 >>>> +Contact: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> >>>> +Description: Reading this file tells if the AMD Platform >>>> Management(PMF) >>>> + Cool n Quiet Framework(CnQF) feature is enabled or not. >>>> + >>>> + This feature is not enabled by default and gets only turned on >>>> + if OEM BIOS passes a "flag" to PMF ACPI function (index 11 or >>>> 12) >>>> + or in case the user writes "on". >>>> + >>>> + To turn off CnQF user can write "off" to the sysfs node. >>> >>> I think you want to have a comment here to the effect that "systems that >>> support auto mode will not have this sysfs file available". >> >> OK. Will take it in the next revision. > > Thanks. > >> >> Thanks, >> Shyam >
diff --git a/Documentation/ABI/testing/sysfs-amd-pmf b/Documentation/ABI/testing/sysfs-amd-pmf new file mode 100644 index 000000000000..c75d7426c2c7 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-amd-pmf @@ -0,0 +1,11 @@ +What: /sys/devices/platform/AMDI0102\:00/cnqf/feat +Date: September 2022 +Contact: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> +Description: Reading this file tells if the AMD Platform Management(PMF) + Cool n Quiet Framework(CnQF) feature is enabled or not. + + This feature is not enabled by default and gets only turned on + if OEM BIOS passes a "flag" to PMF ACPI function (index 11 or 12) + or in case the user writes "on". + + To turn off CnQF user can write "off" to the sysfs node.
AMD PMF driver provides the flexibility to turn "on" or "off" CnQF feature (introduced in the earlier patch). Add corresponding ABI documentation for the new sysfs node. Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> --- Documentation/ABI/testing/sysfs-amd-pmf | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-amd-pmf