drivers/opp/opp.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Generic OPP Interface
   4  *
   5  * Copyright (C) 2009-2010 Texas Instruments Incorporated.
   6  *      Nishanth Menon
   7  *      Romit Dasgupta
   8  *      Kevin Hilman
   9  */
  10
  11 #ifndef __DRIVER_OPP_H__
  12 #define __DRIVER_OPP_H__
  13
  14 #include <linux/device.h>
  15 #include <linux/interconnect.h>
  16 #include <linux/kernel.h>
  17 #include <linux/kref.h>
  18 #include <linux/list.h>
  19 #include <linux/limits.h>
  20 #include <linux/pm_opp.h>
  21 #include <linux/notifier.h>
  22
  23 struct clk;
  24 struct regulator;
  25
  26 /* Lock to allow exclusive modification to the device and opp lists */
  27 extern struct mutex opp_table_lock;
  28
  29 extern struct list_head opp_tables;
  30
  31 /* 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  */
  47 struct opp_config_data {
  48         struct opp_table *opp_table;
  49         unsigned int flags;
  50 };
  51
  52 /*
  53  * Internal data structure organization with the OPP layer library is as
  54  * follows:
  55  * opp_tables (root)
  56  *      |- 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)
  64  * device 1, 2.. are represented by opp_table structure while each opp
  65  * is represented by the opp structure.
  66  */
  67
  68 /**
  69  * struct dev_pm_opp - Generic OPP description structure
  70  * @node:       opp table node. The nodes are maintained throughout the lifetime
  71  *              of boot. It is expected only an optimal set of OPPs are
  72  *              added to the library by the SoC framework.
  73  *              IMPORTANT: the opp nodes should be maintained in increasing
  74  *              order.
  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.
  81  * @rates:      Frequencies in hertz
  82  * @level:      Performance level
  83  * @supplies:   Power supplies voltage/current values
  84  * @bandwidth:  Interconnect bandwidth values
  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)
  91  *
  92  * This structure stores the OPP information for a given device.
  93  */
  94 struct dev_pm_opp {
  95         struct list_head node;
  96         struct kref kref;
  97
  98         bool available;
  99         bool dynamic;
 100         bool turbo;
 101         bool suspend;
 102         bool removed;
 103         unsigned long *rates;
 104         unsigned int level;
 105
 106         struct dev_pm_opp_supply *supplies;
 107         struct dev_pm_opp_icc_bw *bandwidth;
 108
 109         unsigned long clock_latency_ns;
 110
 111         struct dev_pm_opp **required_opps;
 112         struct opp_table *opp_table;
 113
 114         struct device_node *np;
 115
 116 #ifdef CONFIG_DEBUG_FS
 117         struct dentry *dentry;
 118         const char *of_name;
 119 #endif
 120 };
 121
 122 /**
 123  * struct opp_device - devices managed by 'struct opp_table'
 124  * @node:       list node
 125  * @dev:        device to which the struct object belongs
 126  * @dentry:     debugfs dentry pointer (per device)
 127  *
 128  * This is an internal data structure maintaining the devices that are managed
 129  * by 'struct opp_table'.
 130  */
 131 struct opp_device {
 132         struct list_head node;
 133         const struct device *dev;
 134
 135 #ifdef CONFIG_DEBUG_FS
 136         struct dentry *dentry;
 137 #endif
 138 };
 139
 140 enum opp_table_access {
 141         OPP_TABLE_ACCESS_UNKNOWN = 0,
 142         OPP_TABLE_ACCESS_EXCLUSIVE = 1,
 143         OPP_TABLE_ACCESS_SHARED = 2,
 144 };
 145
 146 /**
 147  * struct opp_table - Device opp structure
 148  * @node:       table node - contains the devices with OPPs that
 149  *              have been registered. Nodes once added are not modified in this
 150  *              table.
 151  * @head:       notifier head to notify the OPP availability changes.
 152  * @dev_list:   list of devices that share these OPPs
 153  * @opp_list:   table of opps
 154  * @kref:       for reference count of the table.
 155  * @lock:       mutex protecting the opp_list and dev_list.
 156  * @np:         struct device_node pointer for opp's DT node.
 157  * @clock_latency_ns_max: Max clock latency in nanoseconds.
 158  * @parsed_static_opps: Count of devices for which OPPs are initialized from DT.
 159  * @shared_opp: OPP is shared between multiple devices.
 160  * @rate_clk_single: Currently configured frequency for single clk.
 161  * @current_opp: Currently configured OPP for the table.
 162  * @suspend_opp: Pointer to OPP to be used during device suspend.
 163  * @genpd_virt_dev_lock: Mutex protecting the genpd virtual device pointers.
 164  * @genpd_virt_devs: List of virtual devices for multiple genpd support.
 165  * @required_opp_tables: List of device OPP tables that are required by OPPs in
 166  *              this table.
 167  * @required_opp_count: Number of required devices.
 168  * @supported_hw: Array of version number to support.
 169  * @supported_hw_count: Number of elements in supported_hw array.
 170  * @prop_name: A name to postfix to many DT properties, while parsing them.
 171  * @config_clks: Platform specific config_clks() callback.
 172  * @clks: Device's clock handles, for multiple clocks.
 173  * @clk: Device's clock handle, for single clock.
 174  * @clk_count: Number of clocks.
 175  * @config_regulators: Platform specific config_regulators() callback.
 176  * @regulators: Supply regulators
 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
 179  * property).
 180  * @paths: Interconnect path handles
 181  * @path_count: Number of interconnect paths
 182  * @enabled: Set to true if the device's resources are enabled/configured.
 183  * @is_genpd: Marks if the OPP table belongs to a genpd.
 184  * @set_required_opps: Helper responsible to set required OPPs.
 185  * @dentry:     debugfs dentry pointer of the real device directory (not links).
 186  * @dentry_name: Name of the real dentry.
 187  *
 188  * @voltage_tolerance_v1: In percentage, for v1 bindings only.
 189  *
 190  * This is an internal data structure maintaining the link to opps attached to
 191  * a device. This structure is not meant to be shared to users as it is
 192  * meant for book keeping and private to OPP library.
 193  */
 194 struct opp_table {
 195         struct list_head node, lazy;
 196
 197         struct blocking_notifier_head head;
 198         struct list_head dev_list;
 199         struct list_head opp_list;
 200         struct kref kref;
 201         struct mutex lock;
 202
 203         struct device_node *np;
 204         unsigned long clock_latency_ns_max;
 205
 206         /* For backward compatibility with v1 bindings */
 207         unsigned int voltage_tolerance_v1;
 208
 209         unsigned int parsed_static_opps;
 210         enum opp_table_access shared_opp;
 211         unsigned long rate_clk_single;
 212         struct dev_pm_opp *current_opp;
 213         struct dev_pm_opp *suspend_opp;
 214
 215         struct mutex genpd_virt_dev_lock;
 216         struct device **genpd_virt_devs;
 217         struct opp_table **required_opp_tables;
 218         unsigned int required_opp_count;
 219
 220         unsigned int *supported_hw;
 221         unsigned int supported_hw_count;
 222         const char *prop_name;
 223         config_clks_t config_clks;
 224         struct clk **clks;
 225         struct clk *clk;
 226         int clk_count;
 227         config_regulators_t config_regulators;
 228         struct regulator **regulators;
 229         int regulator_count;
 230         struct icc_path **paths;
 231         unsigned int path_count;
 232         bool enabled;
 233         bool is_genpd;
 234         int (*set_required_opps)(struct device *dev,
 235                 struct opp_table *opp_table, struct dev_pm_opp *opp, bool scaling_down);
 236
 237 #ifdef CONFIG_DEBUG_FS
 238         struct dentry *dentry;
 239         char dentry_name[NAME_MAX];
 240 #endif
 241 };
 242
 243 /* Routines internal to opp core */
 244 void dev_pm_opp_get(struct dev_pm_opp *opp);
 245 bool _opp_remove_all_static(struct opp_table *opp_table);
 246 void _get_opp_table_kref(struct opp_table *opp_table);
 247 int _get_opp_count(struct opp_table *opp_table);
 248 struct opp_table *_find_opp_table(struct device *dev);
 249 struct opp_device *_add_opp_dev(const struct device *dev, struct opp_table *opp_table);
 250 struct dev_pm_opp *_opp_allocate(struct opp_table *opp_table);
 251 void _opp_free(struct dev_pm_opp *opp);
 252 int _opp_compare_key(struct opp_table *opp_table, struct dev_pm_opp *opp1, struct dev_pm_opp *opp2);
 253 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp, struct opp_table *opp_table);
 254 int _opp_add_v1(struct opp_table *opp_table, struct device *dev, unsigned long freq, long u_volt, bool dynamic);
 255 void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, int last_cpu);
 256 struct opp_table *_add_opp_table_indexed(struct device *dev, int index, bool getclk);
 257 void _put_opp_list_kref(struct opp_table *opp_table);
 258 void _required_opps_available(struct dev_pm_opp *opp, int count);
 259 void _update_set_required_opps(struct opp_table *opp_table);
 260
 261 static inline bool lazy_linking_pending(struct opp_table *opp_table)
 262 {
 263         return unlikely(!list_empty(&opp_table->lazy));
 264 }
 265
 266 #ifdef CONFIG_OF
 267 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index);
 268 void _of_clear_opp_table(struct opp_table *opp_table);
 269 struct opp_table *_managed_opp(struct device *dev, int index);
 270 void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp);
 271 #else
 272 static inline void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index) {}
 273 static inline void _of_clear_opp_table(struct opp_table *opp_table) {}
 274 static inline struct opp_table *_managed_opp(struct device *dev, int index) { return NULL; }
 275 static inline void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp) {}
 276 #endif
 277
 278 #ifdef CONFIG_DEBUG_FS
 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);
 281 void opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table);
 282 void opp_debug_unregister(struct opp_device *opp_dev, struct opp_table *opp_table);
 283 #else
 284 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {}
 285
 286 static inline void opp_debug_create_one(struct dev_pm_opp *opp,
 287                                         struct opp_table *opp_table) { }
 288
 289 static inline void opp_debug_register(struct opp_device *opp_dev,
 290                                       struct opp_table *opp_table) { }
 291
 292 static inline void opp_debug_unregister(struct opp_device *opp_dev,
 293                                         struct opp_table *opp_table)
 294 { }
 295 #endif          /* DEBUG_FS */
 296
 297 #endif          /* __DRIVER_OPP_H__ */