xref: /linux/include/linux/platform_profile.h (revision d4fd25b6f883db41194e1760041560779d412d98)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Platform profile sysfs interface
4  *
5  * See Documentation/userspace-api/sysfs-platform_profile.rst for more
6  * information.
7  */
8 
9 #ifndef _PLATFORM_PROFILE_H_
10 #define _PLATFORM_PROFILE_H_
11 
12 #include <linux/device.h>
13 #include <linux/bitops.h>
14 
15 /*
16  * If more options are added please update profile_names array in
17  * platform_profile.c and sysfs-platform_profile documentation.
18  */
19 
20 enum platform_profile_option {
21 	PLATFORM_PROFILE_LOW_POWER,
22 	PLATFORM_PROFILE_COOL,
23 	PLATFORM_PROFILE_QUIET,
24 	PLATFORM_PROFILE_BALANCED,
25 	PLATFORM_PROFILE_BALANCED_PERFORMANCE,
26 	PLATFORM_PROFILE_PERFORMANCE,
27 	PLATFORM_PROFILE_CUSTOM,
28 	PLATFORM_PROFILE_LAST, /*must always be last */
29 };
30 
31 /**
32  * struct platform_profile_ops - platform profile operations
33  * @probe: Callback to setup choices available to the new class device. These
34  *	   choices will only be enforced when setting a new profile, not when
35  *	   getting the current one.
36  * @hidden_choices: Callback to setup choices that are not visible to the user
37  *		    but can be set by the driver.
38  * @profile_get: Callback that will be called when showing the current platform
39  *		 profile in sysfs.
40  * @profile_set: Callback that will be called when storing a new platform
41  *		 profile in sysfs.
42  */
43 struct platform_profile_ops {
44 	int (*probe)(void *drvdata, unsigned long *choices);
45 	int (*hidden_choices)(void *drvdata, unsigned long *choices);
46 	int (*profile_get)(struct device *dev, enum platform_profile_option *profile);
47 	int (*profile_set)(struct device *dev, enum platform_profile_option profile);
48 };
49 
50 struct device *platform_profile_register(struct device *dev, const char *name,
51 					 void *drvdata,
52 					 const struct platform_profile_ops *ops);
53 int platform_profile_remove(struct device *dev);
54 struct device *devm_platform_profile_register(struct device *dev, const char *name,
55 					      void *drvdata,
56 					      const struct platform_profile_ops *ops);
57 int platform_profile_cycle(void);
58 void platform_profile_notify(struct device *dev);
59 
60 #endif  /*_PLATFORM_PROFILE_H_*/
61