drivers/opp/opp.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * Generic OPP Interface
5  * Copyright (C) 2009-2010 Texas Instruments Incorporated.
26 /* Lock to allow exclusive modification to the device and opp lists */
31 /* OPP Config flags */
33 #define OPP_CONFIG_REGULATOR		BIT(1)
40  * struct opp_config_data - data for set config operations
41  * @opp_table: OPP table
42  * @flags: OPP config flags
44  * This structure stores the OPP config information for each OPP table
53  * Internal data structure organization with the OPP layer library is as
56  *	|- device 1 (represents voltage domain 1)
57  *	|	|- opp 1 (availability, freq, voltage)
58  *	|	|- opp 2 ..
60  *	|	`- opp n ..
61  *	|- device 2 (represents the next voltage domain)
63  *	`- device m (represents mth voltage domain)
64  * device 1, 2.. are represented by opp_table structure while each opp
65  * is represented by the opp structure.
69  * struct dev_pm_opp - Generic OPP description structure
70  * @node:	opp table node. The nodes are maintained throughout the lifetime
73  *		IMPORTANT: the opp nodes should be maintained in increasing
75  * @kref:	for reference count of the OPP.
76  * @available:	true/false - marks if this OPP as available or not
77  * @dynamic:	not-created from static DT entries.
78  * @turbo:	true if turbo (boost) OPP
79  * @suspend:	true if suspend OPP
80  * @removed:	flag indicating that OPP's reference is dropped by OPP core.
85  * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's
86  *		frequency from any other OPP's frequency.
87  * @required_opps: List of OPPs that are required by this OPP.
88  * @opp_table:	points back to the opp_table struct this opp belongs to
89  * @np:		OPP's device node.
90  * @dentry:	debugfs dentry pointer (per opp)
92  * This structure stores the OPP information for a given device.
123  * struct opp_device - devices managed by 'struct opp_table'
142 	OPP_TABLE_ACCESS_EXCLUSIVE = 1,
147  * struct opp_table - Device opp structure
148  * @node:	table node - contains the devices with OPPs that
151  * @head:	notifier head to notify the OPP availability changes.
156  * @np:		struct device_node pointer for opp's DT node.
159  * @shared_opp: OPP is shared between multiple devices.
161  * @current_opp: Currently configured OPP for the table.
162  * @suspend_opp: Pointer to OPP to be used during device suspend.
165  * @required_opp_tables: List of device OPP tables that are required by OPPs in
177  * @regulator_count: Number of power supply regulators. Its value can be -1
178  * (uninitialized), 0 (no opp-microvolt property) or > 0 (has opp-microvolt
183  * @is_genpd: Marks if the OPP table belongs to a genpd.
192  * meant for book keeping and private to OPP library.
235 		struct opp_table *opp_table, struct dev_pm_opp *opp, bool scaling_down);
243 /* Routines internal to opp core */
244 void dev_pm_opp_get(struct dev_pm_opp *opp);
251 void _opp_free(struct dev_pm_opp *opp);
258 void _required_opps_available(struct dev_pm_opp *opp, int count);
263 	return unlikely(!list_empty(&opp_table->lazy));  in lazy_linking_pending()
270 void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp);
275 static inline void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp) {}  in _of_clear_opp()  argument
279 void opp_debug_remove_one(struct dev_pm_opp *opp);
280 void opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table);
284 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {}  in opp_debug_remove_one()  argument
286 static inline void opp_debug_create_one(struct dev_pm_opp *opp,  in opp_debug_create_one()  argument