| Message ID | 20250109150731.110799-19-kuurtb@gmail.com (mailing list archive) |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | Hide platform_profile_handler from consumers | expand |
On 1/9/2025 09:06, Kurt Borja wrote: > Add kerneldoc and sysfs class documentation. > > Signed-off-by: Kurt Borja <kuurtb@gmail.com> > --- > .../ABI/testing/sysfs-class-platform-profile | 44 +++++++++++++++++++ > drivers/acpi/platform_profile.c | 33 ++++++++++++++ > 2 files changed, 77 insertions(+) > create mode 100644 Documentation/ABI/testing/sysfs-class-platform-profile > > diff --git a/Documentation/ABI/testing/sysfs-class-platform-profile b/Documentation/ABI/testing/sysfs-class-platform-profile > new file mode 100644 > index 000000000000..59486dc4313f > --- /dev/null > +++ b/Documentation/ABI/testing/sysfs-class-platform-profile > @@ -0,0 +1,44 @@ > +What: /sys/class/platform-profile/platform-profile-X/name > +Date: January 2025 > +Description: Name of the class device given by the driver. > + > + RO > + > +What: /sys/class/platform-profile/platform-profile-X/choices > +Date: January 2025 > +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 > + balanced-performance Balance between performance and low > + power consumption with a slight bias > + towards performance > + performance High performance operation > + custom Driver defined custom profile > + ==================== ======================================== > + > + RO > + > +What: /sys/class/platform-profile/platform-profile-X/profile > +Date: January 2025 > +Description: Reading this file gives the current selected profile for this > + device. Writing this file with one of the strings from > + platform_profile_choices changes the profile to the new value. > + > + This file can be monitored for changes by polling for POLLPRI, > + POLLPRI will be signalled on any changes, independent of those signaled > + changes coming from a userspace write; or coming from another > + source such as e.g. a hotkey triggered profile change handled > + either directly by the embedded-controller or fully handled > + inside the kernel. > + > + This file may also emit the string 'custom' to indicate > + that the driver is using a driver defined custom profile. > + > + RW > diff --git a/drivers/acpi/platform_profile.c b/drivers/acpi/platform_profile.c > index 8c79ecab8a6d..5d74675c5419 100644 > --- a/drivers/acpi/platform_profile.c > +++ b/drivers/acpi/platform_profile.c > @@ -426,6 +426,10 @@ static const struct attribute_group platform_profile_group = { > .is_visible = profile_class_is_visible, > }; > > +/** > + * platform_profile_notify - Notify class device and legacy sysfs interface > + * @dev: The class device > + */ > void platform_profile_notify(struct device *dev) > { > scoped_cond_guard(mutex_intr, return, &profile_lock) { > @@ -435,6 +439,11 @@ void platform_profile_notify(struct device *dev) > } > EXPORT_SYMBOL_GPL(platform_profile_notify); > > +/** > + * platform_profile_cycle - Cycles profiles available on all registered class devices > + * > + * Return: 0 on success, -errno on failure > + */ > int platform_profile_cycle(void) > { > enum platform_profile_option next = PLATFORM_PROFILE_LAST; > @@ -478,6 +487,15 @@ int platform_profile_cycle(void) > } > EXPORT_SYMBOL_GPL(platform_profile_cycle); > > +/** > + * platform_profile_register - Creates and registers a platform profile class device > + * @dev: Parent device > + * @name: Name of the class device > + * @drvdata: Driver data that will be attached to the class device > + * @ops: Platform profile's mandatory operations > + * > + * Return: pointer to the new class device on success, ERR_PTR on failure > + */ > struct device *platform_profile_register(struct device *dev, const char *name, > void *drvdata, > const struct platform_profile_ops *ops) > @@ -548,6 +566,12 @@ struct device *platform_profile_register(struct device *dev, const char *name, > } > EXPORT_SYMBOL_GPL(platform_profile_register); > > +/** > + * platform_profile_remove - Unregisters a platform profile class device > + * @dev: Class device > + * > + * Return: 0 > + */ > int platform_profile_remove(struct device *dev) > { > struct platform_profile_handler *pprof = to_pprof_handler(dev); > @@ -573,6 +597,15 @@ static void devm_platform_profile_release(struct device *dev, void *res) > platform_profile_remove(*ppdev); > } > > +/** > + * devm_platform_profile_register - Device managed version of platform_profile_register > + * @dev: Parent device > + * @name: Name of the class device > + * @drvdata: Driver data that will be attached to the class device > + * @ops: Platform profile's mandatory operations > + * > + * Return: pointer to the new class device on success, ERR_PTR on failure > + */ > struct device *devm_platform_profile_register(struct device *dev, const char *name, > void *drvdata, > const struct platform_profile_ops *ops)
diff --git a/Documentation/ABI/testing/sysfs-class-platform-profile b/Documentation/ABI/testing/sysfs-class-platform-profile new file mode 100644 index 000000000000..59486dc4313f --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-platform-profile @@ -0,0 +1,44 @@ +What: /sys/class/platform-profile/platform-profile-X/name +Date: January 2025 +Description: Name of the class device given by the driver. + + RO + +What: /sys/class/platform-profile/platform-profile-X/choices +Date: January 2025 +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 + balanced-performance Balance between performance and low + power consumption with a slight bias + towards performance + performance High performance operation + custom Driver defined custom profile + ==================== ======================================== + + RO + +What: /sys/class/platform-profile/platform-profile-X/profile +Date: January 2025 +Description: Reading this file gives the current selected profile for this + device. Writing this file with one of the strings from + platform_profile_choices changes the profile to the new value. + + This file can be monitored for changes by polling for POLLPRI, + POLLPRI will be signalled on any changes, independent of those + changes coming from a userspace write; or coming from another + source such as e.g. a hotkey triggered profile change handled + either directly by the embedded-controller or fully handled + inside the kernel. + + This file may also emit the string 'custom' to indicate + that the driver is using a driver defined custom profile. + + RW diff --git a/drivers/acpi/platform_profile.c b/drivers/acpi/platform_profile.c index 8c79ecab8a6d..5d74675c5419 100644 --- a/drivers/acpi/platform_profile.c +++ b/drivers/acpi/platform_profile.c @@ -426,6 +426,10 @@ static const struct attribute_group platform_profile_group = { .is_visible = profile_class_is_visible, }; +/** + * platform_profile_notify - Notify class device and legacy sysfs interface + * @dev: The class device + */ void platform_profile_notify(struct device *dev) { scoped_cond_guard(mutex_intr, return, &profile_lock) { @@ -435,6 +439,11 @@ void platform_profile_notify(struct device *dev) } EXPORT_SYMBOL_GPL(platform_profile_notify); +/** + * platform_profile_cycle - Cycles profiles available on all registered class devices + * + * Return: 0 on success, -errno on failure + */ int platform_profile_cycle(void) { enum platform_profile_option next = PLATFORM_PROFILE_LAST; @@ -478,6 +487,15 @@ int platform_profile_cycle(void) } EXPORT_SYMBOL_GPL(platform_profile_cycle); +/** + * platform_profile_register - Creates and registers a platform profile class device + * @dev: Parent device + * @name: Name of the class device + * @drvdata: Driver data that will be attached to the class device + * @ops: Platform profile's mandatory operations + * + * Return: pointer to the new class device on success, ERR_PTR on failure + */ struct device *platform_profile_register(struct device *dev, const char *name, void *drvdata, const struct platform_profile_ops *ops) @@ -548,6 +566,12 @@ struct device *platform_profile_register(struct device *dev, const char *name, } EXPORT_SYMBOL_GPL(platform_profile_register); +/** + * platform_profile_remove - Unregisters a platform profile class device + * @dev: Class device + * + * Return: 0 + */ int platform_profile_remove(struct device *dev) { struct platform_profile_handler *pprof = to_pprof_handler(dev); @@ -573,6 +597,15 @@ static void devm_platform_profile_release(struct device *dev, void *res) platform_profile_remove(*ppdev); } +/** + * devm_platform_profile_register - Device managed version of platform_profile_register + * @dev: Parent device + * @name: Name of the class device + * @drvdata: Driver data that will be attached to the class device + * @ops: Platform profile's mandatory operations + * + * Return: pointer to the new class device on success, ERR_PTR on failure + */ struct device *devm_platform_profile_register(struct device *dev, const char *name, void *drvdata, const struct platform_profile_ops *ops)
Add kerneldoc and sysfs class documentation. Signed-off-by: Kurt Borja <kuurtb@gmail.com> --- .../ABI/testing/sysfs-class-platform-profile | 44 +++++++++++++++++++ drivers/acpi/platform_profile.c | 33 ++++++++++++++ 2 files changed, 77 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-class-platform-profile