drivers/opp/opp.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Generic OPP Interface
0004  *
0005  * Copyright (C) 2009-2010 Texas Instruments Incorporated.
0006  *  Nishanth Menon
0007  *  Romit Dasgupta
0008  *  Kevin Hilman
0009  */
0010
0011 #ifndef __DRIVER_OPP_H__
0012 #define __DRIVER_OPP_H__
0013
0014 #include <linux/device.h>
0015 #include <linux/interconnect.h>
0016 #include <linux/kernel.h>
0017 #include <linux/kref.h>
0018 #include <linux/list.h>
0019 #include <linux/limits.h>
0020 #include <linux/pm_opp.h>
0021 #include <linux/notifier.h>
0022
0023 struct clk;
0024 struct regulator;
0025
0026 /* Lock to allow exclusive modification to the device and opp lists */
0027 extern struct mutex opp_table_lock;
0028
0029 extern struct list_head opp_tables, lazy_opp_tables;
0030
0031 /* OPP Config flags */
0032 #define OPP_CONFIG_CLK          BIT(0)
0033 #define OPP_CONFIG_REGULATOR        BIT(1)
0034 #define OPP_CONFIG_REGULATOR_HELPER BIT(2)
0035 #define OPP_CONFIG_PROP_NAME        BIT(3)
0036 #define OPP_CONFIG_SUPPORTED_HW     BIT(4)
0037 #define OPP_CONFIG_GENPD        BIT(5)
0038
0039 /**
0040  * struct opp_config_data - data for set config operations
0041  * @opp_table: OPP table
0042  * @flags: OPP config flags
0043  *
0044  * This structure stores the OPP config information for each OPP table
0045  * configuration by the callers.
0046  */
0047 struct opp_config_data {
0048     struct opp_table *opp_table;
0049     unsigned int flags;
0050 };
0051
0052 /*
0053  * Internal data structure organization with the OPP layer library is as
0054  * follows:
0055  * opp_tables (root)
0056  *  |- device 1 (represents voltage domain 1)
0057  *  |   |- opp 1 (availability, freq, voltage)
0058  *  |   |- opp 2 ..
0059  *  ... ...
0060  *  |   `- opp n ..
0061  *  |- device 2 (represents the next voltage domain)
0062  *  ...
0063  *  `- device m (represents mth voltage domain)
0064  * device 1, 2.. are represented by opp_table structure while each opp
0065  * is represented by the opp structure.
0066  */
0067
0068 /**
0069  * struct dev_pm_opp - Generic OPP description structure
0070  * @node:   opp table node. The nodes are maintained throughout the lifetime
0071  *      of boot. It is expected only an optimal set of OPPs are
0072  *      added to the library by the SoC framework.
0073  *      IMPORTANT: the opp nodes should be maintained in increasing
0074  *      order.
0075  * @kref:   for reference count of the OPP.
0076  * @available:  true/false - marks if this OPP as available or not
0077  * @dynamic:    not-created from static DT entries.
0078  * @turbo:  true if turbo (boost) OPP
0079  * @suspend:    true if suspend OPP
0080  * @removed:    flag indicating that OPP's reference is dropped by OPP core.
0081  * @pstate: Device's power domain's performance state.
0082  * @rates:  Frequencies in hertz
0083  * @level:  Performance level
0084  * @supplies:   Power supplies voltage/current values
0085  * @bandwidth:  Interconnect bandwidth values
0086  * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's
0087  *      frequency from any other OPP's frequency.
0088  * @required_opps: List of OPPs that are required by this OPP.
0089  * @opp_table:  points back to the opp_table struct this opp belongs to
0090  * @np:     OPP's device node.
0091  * @dentry: debugfs dentry pointer (per opp)
0092  *
0093  * This structure stores the OPP information for a given device.
0094  */
0095 struct dev_pm_opp {
0096     struct list_head node;
0097     struct kref kref;
0098
0099     bool available;
0100     bool dynamic;
0101     bool turbo;
0102     bool suspend;
0103     bool removed;
0104     unsigned int pstate;
0105     unsigned long *rates;
0106     unsigned int level;
0107
0108     struct dev_pm_opp_supply *supplies;
0109     struct dev_pm_opp_icc_bw *bandwidth;
0110
0111     unsigned long clock_latency_ns;
0112
0113     struct dev_pm_opp **required_opps;
0114     struct opp_table *opp_table;
0115
0116     struct device_node *np;
0117
0118 #ifdef CONFIG_DEBUG_FS
0119     struct dentry *dentry;
0120     const char *of_name;
0121 #endif
0122 };
0123
0124 /**
0125  * struct opp_device - devices managed by 'struct opp_table'
0126  * @node:   list node
0127  * @dev:    device to which the struct object belongs
0128  * @dentry: debugfs dentry pointer (per device)
0129  *
0130  * This is an internal data structure maintaining the devices that are managed
0131  * by 'struct opp_table'.
0132  */
0133 struct opp_device {
0134     struct list_head node;
0135     const struct device *dev;
0136
0137 #ifdef CONFIG_DEBUG_FS
0138     struct dentry *dentry;
0139 #endif
0140 };
0141
0142 enum opp_table_access {
0143     OPP_TABLE_ACCESS_UNKNOWN = 0,
0144     OPP_TABLE_ACCESS_EXCLUSIVE = 1,
0145     OPP_TABLE_ACCESS_SHARED = 2,
0146 };
0147
0148 /**
0149  * struct opp_table - Device opp structure
0150  * @node:   table node - contains the devices with OPPs that
0151  *      have been registered. Nodes once added are not modified in this
0152  *      table.
0153  * @head:   notifier head to notify the OPP availability changes.
0154  * @dev_list:   list of devices that share these OPPs
0155  * @opp_list:   table of opps
0156  * @kref:   for reference count of the table.
0157  * @lock:   mutex protecting the opp_list and dev_list.
0158  * @np:     struct device_node pointer for opp's DT node.
0159  * @clock_latency_ns_max: Max clock latency in nanoseconds.
0160  * @parsed_static_opps: Count of devices for which OPPs are initialized from DT.
0161  * @shared_opp: OPP is shared between multiple devices.
0162  * @rate_clk_single: Currently configured frequency for single clk.
0163  * @current_opp: Currently configured OPP for the table.
0164  * @suspend_opp: Pointer to OPP to be used during device suspend.
0165  * @genpd_virt_dev_lock: Mutex protecting the genpd virtual device pointers.
0166  * @genpd_virt_devs: List of virtual devices for multiple genpd support.
0167  * @required_opp_tables: List of device OPP tables that are required by OPPs in
0168  *      this table.
0169  * @required_opp_count: Number of required devices.
0170  * @supported_hw: Array of version number to support.
0171  * @supported_hw_count: Number of elements in supported_hw array.
0172  * @prop_name: A name to postfix to many DT properties, while parsing them.
0173  * @config_clks: Platform specific config_clks() callback.
0174  * @clks: Device's clock handles, for multiple clocks.
0175  * @clk: Device's clock handle, for single clock.
0176  * @clk_count: Number of clocks.
0177  * @config_regulators: Platform specific config_regulators() callback.
0178  * @regulators: Supply regulators
0179  * @regulator_count: Number of power supply regulators. Its value can be -1
0180  * (uninitialized), 0 (no opp-microvolt property) or > 0 (has opp-microvolt
0181  * property).
0182  * @paths: Interconnect path handles
0183  * @path_count: Number of interconnect paths
0184  * @enabled: Set to true if the device's resources are enabled/configured.
0185  * @genpd_performance_state: Device's power domain support performance state.
0186  * @is_genpd: Marks if the OPP table belongs to a genpd.
0187  * @dentry: debugfs dentry pointer of the real device directory (not links).
0188  * @dentry_name: Name of the real dentry.
0189  *
0190  * @voltage_tolerance_v1: In percentage, for v1 bindings only.
0191  *
0192  * This is an internal data structure maintaining the link to opps attached to
0193  * a device. This structure is not meant to be shared to users as it is
0194  * meant for book keeping and private to OPP library.
0195  */
0196 struct opp_table {
0197     struct list_head node, lazy;
0198
0199     struct blocking_notifier_head head;
0200     struct list_head dev_list;
0201     struct list_head opp_list;
0202     struct kref kref;
0203     struct mutex lock;
0204
0205     struct device_node *np;
0206     unsigned long clock_latency_ns_max;
0207
0208     /* For backward compatibility with v1 bindings */
0209     unsigned int voltage_tolerance_v1;
0210
0211     unsigned int parsed_static_opps;
0212     enum opp_table_access shared_opp;
0213     unsigned long rate_clk_single;
0214     struct dev_pm_opp *current_opp;
0215     struct dev_pm_opp *suspend_opp;
0216
0217     struct mutex genpd_virt_dev_lock;
0218     struct device **genpd_virt_devs;
0219     struct opp_table **required_opp_tables;
0220     unsigned int required_opp_count;
0221
0222     unsigned int *supported_hw;
0223     unsigned int supported_hw_count;
0224     const char *prop_name;
0225     config_clks_t config_clks;
0226     struct clk **clks;
0227     struct clk *clk;
0228     int clk_count;
0229     config_regulators_t config_regulators;
0230     struct regulator **regulators;
0231     int regulator_count;
0232     struct icc_path **paths;
0233     unsigned int path_count;
0234     bool enabled;
0235     bool genpd_performance_state;
0236     bool is_genpd;
0237
0238 #ifdef CONFIG_DEBUG_FS
0239     struct dentry *dentry;
0240     char dentry_name[NAME_MAX];
0241 #endif
0242 };
0243
0244 /* Routines internal to opp core */
0245 void dev_pm_opp_get(struct dev_pm_opp *opp);
0246 bool _opp_remove_all_static(struct opp_table *opp_table);
0247 void _get_opp_table_kref(struct opp_table *opp_table);
0248 int _get_opp_count(struct opp_table *opp_table);
0249 struct opp_table *_find_opp_table(struct device *dev);
0250 struct opp_device *_add_opp_dev(const struct device *dev, struct opp_table *opp_table);
0251 struct dev_pm_opp *_opp_allocate(struct opp_table *opp_table);
0252 void _opp_free(struct dev_pm_opp *opp);
0253 int _opp_compare_key(struct opp_table *opp_table, struct dev_pm_opp *opp1, struct dev_pm_opp *opp2);
0254 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp, struct opp_table *opp_table);
0255 int _opp_add_v1(struct opp_table *opp_table, struct device *dev, unsigned long freq, long u_volt, bool dynamic);
0256 void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, int last_cpu);
0257 struct opp_table *_add_opp_table_indexed(struct device *dev, int index, bool getclk);
0258 void _put_opp_list_kref(struct opp_table *opp_table);
0259 void _required_opps_available(struct dev_pm_opp *opp, int count);
0260
0261 static inline bool lazy_linking_pending(struct opp_table *opp_table)
0262 {
0263     return unlikely(!list_empty(&opp_table->lazy));
0264 }
0265
0266 #ifdef CONFIG_OF
0267 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index);
0268 void _of_clear_opp_table(struct opp_table *opp_table);
0269 struct opp_table *_managed_opp(struct device *dev, int index);
0270 void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp);
0271 #else
0272 static inline void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index) {}
0273 static inline void _of_clear_opp_table(struct opp_table *opp_table) {}
0274 static inline struct opp_table *_managed_opp(struct device *dev, int index) { return NULL; }
0275 static inline void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp) {}
0276 #endif
0277
0278 #ifdef CONFIG_DEBUG_FS
0279 void opp_debug_remove_one(struct dev_pm_opp *opp);
0280 void opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table);
0281 void opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table);
0282 void opp_debug_unregister(struct opp_device *opp_dev, struct opp_table *opp_table);
0283 #else
0284 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {}
0285
0286 static inline void opp_debug_create_one(struct dev_pm_opp *opp,
0287                     struct opp_table *opp_table) { }
0288
0289 static inline void opp_debug_register(struct opp_device *opp_dev,
0290                       struct opp_table *opp_table) { }
0291
0292 static inline void opp_debug_unregister(struct opp_device *opp_dev,
0293                     struct opp_table *opp_table)
0294 { }
0295 #endif      /* DEBUG_FS */
0296
0297 #endif      /* __DRIVER_OPP_H__ */