blob: 3a6e077df3866b8389457afb06925f9c8ada87ca [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001/* SPDX-License-Identifier: GPL-2.0-only */
Viresh Kumarf59d3ee2015-09-04 13:47:26 +05302/*
3 * Generic OPP Interface
4 *
5 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
6 * Nishanth Menon
7 * Romit Dasgupta
8 * Kevin Hilman
Viresh Kumarf59d3ee2015-09-04 13:47:26 +05309 */
10
11#ifndef __DRIVER_OPP_H__
12#define __DRIVER_OPP_H__
13
14#include <linux/device.h>
Georgi Djakov6d3f9222020-05-12 15:53:21 +030015#include <linux/interconnect.h>
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053016#include <linux/kernel.h>
Viresh Kumar70347642017-01-23 10:11:46 +053017#include <linux/kref.h>
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053018#include <linux/list.h>
Viresh Kumardeaa5142015-11-11 07:59:01 +053019#include <linux/limits.h>
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053020#include <linux/pm_opp.h>
Viresh Kumar052c6f12017-01-23 10:11:49 +053021#include <linux/notifier.h>
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053022
Viresh Kumard54974c2016-02-09 10:30:38 +053023struct clk;
Viresh Kumar9f8ea962016-02-09 10:30:33 +053024struct regulator;
25
Viresh Kumar87b41152015-11-05 14:21:19 +053026/* Lock to allow exclusive modification to the device and opp lists */
Viresh Kumar2c2709d2016-02-16 14:17:53 +053027extern struct mutex opp_table_lock;
Viresh Kumar87b41152015-11-05 14:21:19 +053028
Viresh Kumar7eba0c72019-11-25 13:57:58 +053029extern struct list_head opp_tables, lazy_opp_tables;
Viresh Kumarf47b72a2016-05-05 16:20:33 +053030
Viresh Kumar11b9b662022-05-25 15:23:16 +053031/* OPP Config flags */
32#define OPP_CONFIG_CLK BIT(0)
33#define OPP_CONFIG_REGULATOR BIT(1)
34#define OPP_CONFIG_REGULATOR_HELPER BIT(2)
35#define OPP_CONFIG_PROP_NAME BIT(3)
36#define OPP_CONFIG_SUPPORTED_HW BIT(4)
37#define OPP_CONFIG_GENPD BIT(5)
38
39/**
40 * struct opp_config_data - data for set config operations
41 * @opp_table: OPP table
42 * @flags: OPP config flags
43 *
44 * This structure stores the OPP config information for each OPP table
45 * configuration by the callers.
46 */
47struct opp_config_data {
48 struct opp_table *opp_table;
49 unsigned int flags;
50};
51
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053052/*
53 * Internal data structure organization with the OPP layer library is as
54 * follows:
Viresh Kumar2c2709d2016-02-16 14:17:53 +053055 * opp_tables (root)
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053056 * |- device 1 (represents voltage domain 1)
57 * | |- opp 1 (availability, freq, voltage)
58 * | |- opp 2 ..
59 * ... ...
60 * | `- opp n ..
61 * |- device 2 (represents the next voltage domain)
62 * ...
63 * `- device m (represents mth voltage domain)
Viresh Kumar2c2709d2016-02-16 14:17:53 +053064 * device 1, 2.. are represented by opp_table structure while each opp
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053065 * is represented by the opp structure.
66 */
67
68/**
69 * struct dev_pm_opp - Generic OPP description structure
Viresh Kumar2c2709d2016-02-16 14:17:53 +053070 * @node: opp table node. The nodes are maintained throughout the lifetime
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053071 * of boot. It is expected only an optimal set of OPPs are
72 * added to the library by the SoC framework.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053073 * IMPORTANT: the opp nodes should be maintained in increasing
74 * order.
Viresh Kumar70347642017-01-23 10:11:46 +053075 * @kref: for reference count of the OPP.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053076 * @available: true/false - marks if this OPP as available or not
Viresh Kumardc4e7b12015-11-19 09:13:56 +053077 * @dynamic: not-created from static DT entries.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053078 * @turbo: true if turbo (boost) OPP
Viresh Kumardeaa5142015-11-11 07:59:01 +053079 * @suspend: true if suspend OPP
Beata Michalska606a5d422021-03-04 15:07:34 +000080 * @removed: flag indicating that OPP's reference is dropped by OPP core.
Viresh Kumar009acd12017-10-11 12:54:14 +053081 * @pstate: Device's power domain's performance state.
Viresh Kumar2083da22022-06-10 12:02:04 +053082 * @rates: Frequencies in hertz
Rajendra Nayak5b93ac52019-01-10 09:32:02 +053083 * @level: Performance level
Viresh Kumardfbe4672016-12-01 16:28:19 +053084 * @supplies: Power supplies voltage/current values
Georgi Djakov6d3f9222020-05-12 15:53:21 +030085 * @bandwidth: Interconnect bandwidth values
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053086 * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's
87 * frequency from any other OPP's frequency.
Viresh Kumarda544b62018-06-07 14:50:43 +053088 * @required_opps: List of OPPs that are required by this OPP.
Viresh Kumar2c2709d2016-02-16 14:17:53 +053089 * @opp_table: points back to the opp_table struct this opp belongs to
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053090 * @np: OPP's device node.
Viresh Kumardeaa5142015-11-11 07:59:01 +053091 * @dentry: debugfs dentry pointer (per opp)
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053092 *
93 * This structure stores the OPP information for a given device.
94 */
95struct dev_pm_opp {
96 struct list_head node;
Viresh Kumar70347642017-01-23 10:11:46 +053097 struct kref kref;
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053098
99 bool available;
100 bool dynamic;
101 bool turbo;
Viresh Kumardeaa5142015-11-11 07:59:01 +0530102 bool suspend;
Beata Michalska606a5d422021-03-04 15:07:34 +0000103 bool removed;
Viresh Kumar009acd12017-10-11 12:54:14 +0530104 unsigned int pstate;
Viresh Kumar2083da22022-06-10 12:02:04 +0530105 unsigned long *rates;
Rajendra Nayak5b93ac52019-01-10 09:32:02 +0530106 unsigned int level;
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530107
Viresh Kumardfbe4672016-12-01 16:28:19 +0530108 struct dev_pm_opp_supply *supplies;
Georgi Djakov6d3f9222020-05-12 15:53:21 +0300109 struct dev_pm_opp_icc_bw *bandwidth;
Viresh Kumar0f0fe7e2016-12-01 16:28:17 +0530110
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530111 unsigned long clock_latency_ns;
112
Viresh Kumarda544b62018-06-07 14:50:43 +0530113 struct dev_pm_opp **required_opps;
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530114 struct opp_table *opp_table;
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530115
116 struct device_node *np;
Viresh Kumardeaa5142015-11-11 07:59:01 +0530117
118#ifdef CONFIG_DEBUG_FS
119 struct dentry *dentry;
Viresh Kumar021dbec2022-02-10 14:37:53 +0530120 const char *of_name;
Viresh Kumardeaa5142015-11-11 07:59:01 +0530121#endif
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530122};
123
124/**
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530125 * struct opp_device - devices managed by 'struct opp_table'
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530126 * @node: list node
127 * @dev: device to which the struct object belongs
Viresh Kumardeaa5142015-11-11 07:59:01 +0530128 * @dentry: debugfs dentry pointer (per device)
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530129 *
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530130 * This is an internal data structure maintaining the devices that are managed
131 * by 'struct opp_table'.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530132 */
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530133struct opp_device {
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530134 struct list_head node;
135 const struct device *dev;
Viresh Kumardeaa5142015-11-11 07:59:01 +0530136
137#ifdef CONFIG_DEBUG_FS
138 struct dentry *dentry;
139#endif
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530140};
141
Viresh Kumar79ee2e82016-06-16 19:03:11 +0530142enum opp_table_access {
143 OPP_TABLE_ACCESS_UNKNOWN = 0,
144 OPP_TABLE_ACCESS_EXCLUSIVE = 1,
145 OPP_TABLE_ACCESS_SHARED = 2,
146};
147
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530148/**
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530149 * struct opp_table - Device opp structure
150 * @node: table node - contains the devices with OPPs that
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530151 * have been registered. Nodes once added are not modified in this
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530152 * table.
Viresh Kumar052c6f12017-01-23 10:11:49 +0530153 * @head: notifier head to notify the OPP availability changes.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530154 * @dev_list: list of devices that share these OPPs
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530155 * @opp_list: table of opps
Viresh Kumarf067a982017-01-23 10:11:42 +0530156 * @kref: for reference count of the table.
Viresh Kumar3d255692018-08-03 07:05:21 +0530157 * @lock: mutex protecting the opp_list and dev_list.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530158 * @np: struct device_node pointer for opp's DT node.
Viresh Kumardc4e7b12015-11-19 09:13:56 +0530159 * @clock_latency_ns_max: Max clock latency in nanoseconds.
Viresh Kumar03758d62019-11-11 16:35:03 +0530160 * @parsed_static_opps: Count of devices for which OPPs are initialized from DT.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530161 * @shared_opp: OPP is shared between multiple devices.
Viresh Kumar1efae8d2022-06-03 15:01:30 +0530162 * @rate_clk_single: Currently configured frequency for single clk.
Viresh Kumar81c4d8a2021-01-20 16:16:48 +0530163 * @current_opp: Currently configured OPP for the table.
Viresh Kumardc4e7b12015-11-19 09:13:56 +0530164 * @suspend_opp: Pointer to OPP to be used during device suspend.
Viresh Kumar4f018bc2018-06-26 16:29:34 +0530165 * @genpd_virt_dev_lock: Mutex protecting the genpd virtual device pointers.
166 * @genpd_virt_devs: List of virtual devices for multiple genpd support.
Viresh Kumar5d6d1062018-06-07 14:50:43 +0530167 * @required_opp_tables: List of device OPP tables that are required by OPPs in
168 * this table.
169 * @required_opp_count: Number of required devices.
Viresh Kumar7de36b02015-12-09 08:01:46 +0530170 * @supported_hw: Array of version number to support.
171 * @supported_hw_count: Number of elements in supported_hw array.
Viresh Kumar01fb4d32015-12-09 08:01:47 +0530172 * @prop_name: A name to postfix to many DT properties, while parsing them.
Viresh Kumar2083da22022-06-10 12:02:04 +0530173 * @config_clks: Platform specific config_clks() callback.
174 * @clks: Device's clock handles, for multiple clocks.
175 * @clk: Device's clock handle, for single clock.
176 * @clk_count: Number of clocks.
Viresh Kumaraee33522022-07-04 13:45:08 +0530177 * @config_regulators: Platform specific config_regulators() callback.
Viresh Kumardfbe4672016-12-01 16:28:19 +0530178 * @regulators: Supply regulators
Viresh Kumar46f48ac2018-12-11 16:39:36 +0530179 * @regulator_count: Number of power supply regulators. Its value can be -1
180 * (uninitialized), 0 (no opp-microvolt property) or > 0 (has opp-microvolt
181 * property).
Georgi Djakov6d3f9222020-05-12 15:53:21 +0300182 * @paths: Interconnect path handles
183 * @path_count: Number of interconnect paths
Viresh Kumar72f80ce2020-08-13 08:38:37 +0530184 * @enabled: Set to true if the device's resources are enabled/configured.
Viresh Kumar009acd12017-10-11 12:54:14 +0530185 * @genpd_performance_state: Device's power domain support performance state.
Viresh Kumar61d8e7c2018-06-13 16:00:11 +0530186 * @is_genpd: Marks if the OPP table belongs to a genpd.
Viresh Kumardeaa5142015-11-11 07:59:01 +0530187 * @dentry: debugfs dentry pointer of the real device directory (not links).
188 * @dentry_name: Name of the real dentry.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530189 *
Viresh Kumar50f8cfb2016-02-09 10:30:37 +0530190 * @voltage_tolerance_v1: In percentage, for v1 bindings only.
191 *
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530192 * This is an internal data structure maintaining the link to opps attached to
193 * a device. This structure is not meant to be shared to users as it is
194 * meant for book keeping and private to OPP library.
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530195 */
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530196struct opp_table {
Viresh Kumar7eba0c72019-11-25 13:57:58 +0530197 struct list_head node, lazy;
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530198
Viresh Kumar052c6f12017-01-23 10:11:49 +0530199 struct blocking_notifier_head head;
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530200 struct list_head dev_list;
201 struct list_head opp_list;
Viresh Kumarf067a982017-01-23 10:11:42 +0530202 struct kref kref;
Viresh Kumar37a73ec2017-01-23 10:11:41 +0530203 struct mutex lock;
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530204
205 struct device_node *np;
206 unsigned long clock_latency_ns_max;
Viresh Kumar50f8cfb2016-02-09 10:30:37 +0530207
208 /* For backward compatibility with v1 bindings */
209 unsigned int voltage_tolerance_v1;
210
Viresh Kumar03758d62019-11-11 16:35:03 +0530211 unsigned int parsed_static_opps;
Viresh Kumar79ee2e82016-06-16 19:03:11 +0530212 enum opp_table_access shared_opp;
Viresh Kumar1efae8d2022-06-03 15:01:30 +0530213 unsigned long rate_clk_single;
Viresh Kumar81c4d8a2021-01-20 16:16:48 +0530214 struct dev_pm_opp *current_opp;
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530215 struct dev_pm_opp *suspend_opp;
Viresh Kumardeaa5142015-11-11 07:59:01 +0530216
Viresh Kumar4f018bc2018-06-26 16:29:34 +0530217 struct mutex genpd_virt_dev_lock;
218 struct device **genpd_virt_devs;
Viresh Kumar5d6d1062018-06-07 14:50:43 +0530219 struct opp_table **required_opp_tables;
220 unsigned int required_opp_count;
221
Viresh Kumar7de36b02015-12-09 08:01:46 +0530222 unsigned int *supported_hw;
223 unsigned int supported_hw_count;
Viresh Kumar01fb4d32015-12-09 08:01:47 +0530224 const char *prop_name;
Viresh Kumar2083da22022-06-10 12:02:04 +0530225 config_clks_t config_clks;
226 struct clk **clks;
Viresh Kumard54974c2016-02-09 10:30:38 +0530227 struct clk *clk;
Viresh Kumar2083da22022-06-10 12:02:04 +0530228 int clk_count;
Viresh Kumaraee33522022-07-04 13:45:08 +0530229 config_regulators_t config_regulators;
Viresh Kumardfbe4672016-12-01 16:28:19 +0530230 struct regulator **regulators;
Viresh Kumar46f48ac2018-12-11 16:39:36 +0530231 int regulator_count;
Georgi Djakov6d3f9222020-05-12 15:53:21 +0300232 struct icc_path **paths;
233 unsigned int path_count;
Viresh Kumar72f80ce2020-08-13 08:38:37 +0530234 bool enabled;
Viresh Kumar009acd12017-10-11 12:54:14 +0530235 bool genpd_performance_state;
Viresh Kumar61d8e7c2018-06-13 16:00:11 +0530236 bool is_genpd;
Viresh Kumar7de36b02015-12-09 08:01:46 +0530237
Viresh Kumardeaa5142015-11-11 07:59:01 +0530238#ifdef CONFIG_DEBUG_FS
239 struct dentry *dentry;
240 char dentry_name[NAME_MAX];
241#endif
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530242};
243
244/* Routines internal to opp core */
Viresh Kumara88bd2a2017-11-29 15:18:36 +0530245void dev_pm_opp_get(struct dev_pm_opp *opp);
Viresh Kumar922ff072020-08-31 13:03:06 +0530246bool _opp_remove_all_static(struct opp_table *opp_table);
Viresh Kumarf067a982017-01-23 10:11:42 +0530247void _get_opp_table_kref(struct opp_table *opp_table);
Viresh Kumara1e8c132018-04-06 14:35:45 +0530248int _get_opp_count(struct opp_table *opp_table);
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530249struct opp_table *_find_opp_table(struct device *dev);
250struct opp_device *_add_opp_dev(const struct device *dev, struct opp_table *opp_table);
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +0530251struct dev_pm_opp *_opp_allocate(struct opp_table *opp_table);
252void _opp_free(struct dev_pm_opp *opp);
Viresh Kumar2083da22022-06-10 12:02:04 +0530253int _opp_compare_key(struct opp_table *opp_table, struct dev_pm_opp *opp1, struct dev_pm_opp *opp2);
Viresh Kumar47689142022-06-08 11:57:24 +0530254int _opp_add(struct device *dev, struct dev_pm_opp *new_opp, struct opp_table *opp_table);
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +0530255int _opp_add_v1(struct opp_table *opp_table, struct device *dev, unsigned long freq, long u_volt, bool dynamic);
Viresh Kumar2a4eb732018-09-13 13:14:36 +0530256void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, int last_cpu);
Viresh Kumar32439ac2021-01-28 12:05:22 +0530257struct opp_table *_add_opp_table_indexed(struct device *dev, int index, bool getclk);
Viresh Kumard0e8ae62018-09-11 11:14:11 +0530258void _put_opp_list_kref(struct opp_table *opp_table);
Viresh Kumar7eba0c72019-11-25 13:57:58 +0530259void _required_opps_available(struct dev_pm_opp *opp, int count);
260
261static inline bool lazy_linking_pending(struct opp_table *opp_table)
262{
263 return unlikely(!list_empty(&opp_table->lazy));
264}
Viresh Kumarf47b72a2016-05-05 16:20:33 +0530265
266#ifdef CONFIG_OF
Viresh Kumareb7c87432018-09-05 16:17:14 +0530267void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index);
Viresh Kumar5d6d1062018-06-07 14:50:43 +0530268void _of_clear_opp_table(struct opp_table *opp_table);
Viresh Kumar283d55e2018-09-07 09:01:54 +0530269struct opp_table *_managed_opp(struct device *dev, int index);
Liang He3466ea22022-07-18 21:36:32 +0800270void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp);
Viresh Kumarf47b72a2016-05-05 16:20:33 +0530271#else
Viresh Kumareb7c87432018-09-05 16:17:14 +0530272static inline void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index) {}
Viresh Kumar5d6d1062018-06-07 14:50:43 +0530273static inline void _of_clear_opp_table(struct opp_table *opp_table) {}
Viresh Kumar283d55e2018-09-07 09:01:54 +0530274static inline struct opp_table *_managed_opp(struct device *dev, int index) { return NULL; }
Liang He3466ea22022-07-18 21:36:32 +0800275static inline void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp) {}
Viresh Kumarf47b72a2016-05-05 16:20:33 +0530276#endif
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530277
Viresh Kumardeaa5142015-11-11 07:59:01 +0530278#ifdef CONFIG_DEBUG_FS
279void opp_debug_remove_one(struct dev_pm_opp *opp);
Greg Kroah-Hartmana2dea4c2019-01-22 16:21:17 +0100280void opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table);
281void opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table);
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530282void opp_debug_unregister(struct opp_device *opp_dev, struct opp_table *opp_table);
Viresh Kumardeaa5142015-11-11 07:59:01 +0530283#else
284static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {}
285
Greg Kroah-Hartmana2dea4c2019-01-22 16:21:17 +0100286static inline void opp_debug_create_one(struct dev_pm_opp *opp,
287 struct opp_table *opp_table) { }
288
289static inline void opp_debug_register(struct opp_device *opp_dev,
290 struct opp_table *opp_table) { }
Viresh Kumardeaa5142015-11-11 07:59:01 +0530291
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530292static inline void opp_debug_unregister(struct opp_device *opp_dev,
293 struct opp_table *opp_table)
Viresh Kumardeaa5142015-11-11 07:59:01 +0530294{ }
295#endif /* DEBUG_FS */
296
Viresh Kumarf59d3ee2015-09-04 13:47:26 +0530297#endif /* __DRIVER_OPP_H__ */