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 */
41  * struct opp_config_data - data for set config operations
42  * @opp_table: OPP table
43  * @flags: OPP config flags
45  * This structure stores the OPP config information for each OPP table
54  * struct dev_pm_opp_icc_bw - Interconnect bandwidth values
55  * @avg:	Average bandwidth corresponding to this OPP (in icc units)
56  * @peak:	Peak bandwidth corresponding to this OPP (in icc units)
66  * Internal data structure organization with the OPP layer library is as
69  *	|- device 1 (represents voltage domain 1)
70  *	|	|- opp 1 (availability, freq, voltage)
71  *	|	|- opp 2 ..
73  *	|	`- opp n ..
74  *	|- device 2 (represents the next voltage domain)
76  *	`- device m (represents mth voltage domain)
77  * device 1, 2.. are represented by opp_table structure while each opp
78  * is represented by the opp structure.
82  * struct dev_pm_opp - Generic OPP description structure
83  * @node:	opp table node. The nodes are maintained throughout the lifetime
86  *		IMPORTANT: the opp nodes should be maintained in increasing
88  * @kref:	for reference count of the OPP.
89  * @available:	true/false - marks if this OPP as available or not
90  * @dynamic:	not-created from static DT entries.
91  * @turbo:	true if turbo (boost) OPP
92  * @suspend:	true if suspend OPP
93  * @removed:	flag indicating that OPP's reference is dropped by OPP core.
98  * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's
99  *		frequency from any other OPP's frequency.
100  * @required_opps: List of OPPs that are required by this OPP.
101  * @opp_table:	points back to the opp_table struct this opp belongs to
102  * @np:		OPP's device node.
103  * @dentry:	debugfs dentry pointer (per opp)
105  * This structure stores the OPP information for a given device.
114 	bool suspend;  member
136  * struct opp_device - devices managed by 'struct opp_table'
160  * struct opp_table - Device opp structure
161  * @node:	table node - contains the devices with OPPs that
164  * @head:	notifier head to notify the OPP availability changes.
169  * @np:		struct device_node pointer for opp's DT node.
172  * @shared_opp: OPP is shared between multiple devices.
174  * @current_opp: Currently configured OPP for the table.
175  * @suspend_opp: Pointer to OPP to be used during device suspend.
176  * @required_opp_tables: List of device OPP tables that are required by OPPs in
178  * @required_devs: List of devices for required OPP tables.
189  * @regulator_count: Number of power supply regulators. Its value can be -1
190  * (uninitialized), 0 (no opp-microvolt property) or > 0 (has opp-microvolt
195  * @is_genpd: Marks if the OPP table belongs to a genpd.
203  * meant for book keeping and private to OPP library.
251 /* Routines internal to opp core */
252 void dev_pm_opp_get(struct dev_pm_opp *opp);
259 void _opp_free(struct dev_pm_opp *opp);
266 void _required_opps_available(struct dev_pm_opp *opp, int count);
271 	return unlikely(!list_empty(&opp_table->lazy));  in lazy_linking_pending()
278 void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp);
283 static inline void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp) {}  in _of_clear_opp()  argument
287 void opp_debug_remove_one(struct dev_pm_opp *opp);
288 void opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table);
292 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {}  in opp_debug_remove_one()  argument
294 static inline void opp_debug_create_one(struct dev_pm_opp *opp,  in opp_debug_create_one()  argument