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 */
32  * Internal data structure organization with the OPP layer library is as
35  *	|- device 1 (represents voltage domain 1)
36  *	|	|- opp 1 (availability, freq, voltage)
37  *	|	|- opp 2 ..
39  *	|	`- opp n ..
40  *	|- device 2 (represents the next voltage domain)
42  *	`- device m (represents mth voltage domain)
43  * device 1, 2.. are represented by opp_table structure while each opp
44  * is represented by the opp structure.
48  * struct dev_pm_opp - Generic OPP description structure
49  * @node:	opp table node. The nodes are maintained throughout the lifetime
52  *		IMPORTANT: the opp nodes should be maintained in increasing
54  * @kref:	for reference count of the OPP.
55  * @available:	true/false - marks if this OPP as available or not
56  * @dynamic:	not-created from static DT entries.
57  * @turbo:	true if turbo (boost) OPP
58  * @suspend:	true if suspend OPP
64  * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's
65  *		frequency from any other OPP's frequency.
66  * @required_opps: List of OPPs that are required by this OPP.
67  * @opp_table:	points back to the opp_table struct this opp belongs to
68  * @np:		OPP's device node.
69  * @dentry:	debugfs dentry pointer (per opp)
71  * This structure stores the OPP information for a given device.
101  * struct opp_device - devices managed by 'struct opp_table'
125  * struct opp_table - Device opp structure
126  * @node:	table node - contains the devices with OPPs that
128  *		table.
129  * @head:	notifier head to notify the OPP availability changes.
131  * @opp_list:	table of opps
132  * @kref:	for reference count of the table.
134  * @np:		struct device_node pointer for opp's DT node.
137  * @shared_opp: OPP is shared between multiple devices.
138  * @suspend_opp: Pointer to OPP to be used during device suspend.
141  * @required_opp_tables: List of device OPP tables that are required by OPPs in
142  *		this table.
149  * @regulator_count: Number of power supply regulators. Its value can be -1
150  * (uninitialized), 0 (no opp-microvolt property) or > 0 (has opp-microvolt
156  * @is_genpd: Marks if the OPP table belongs to a genpd.
166  * meant for book keeping and private to OPP library.
213 /* Routines internal to opp core */
214 void dev_pm_opp_get(struct dev_pm_opp *opp);
221 void _opp_free(struct dev_pm_opp *opp);
234 				struct dev_pm_opp *opp);
240 					      struct dev_pm_opp *opp) {}  in _of_opp_free_required_opps()  argument
244 void opp_debug_remove_one(struct dev_pm_opp *opp);
245 void opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table);
249 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {}  in opp_debug_remove_one()  argument
251 static inline void opp_debug_create_one(struct dev_pm_opp *opp,  in opp_debug_create_one()  argument