/* SPDX-License-Identifier: GPL-2.0-only */

  /*
   * Generic OPP Interface
   *
   * Copyright (C) 2009-2010 Texas Instruments Incorporated.
   *	Nishanth Menon
   *	Romit Dasgupta
   *	Kevin Hilman

   */
  
  #ifndef __LINUX_OPP_H__
  #define __LINUX_OPP_H__

  #include <linux/energy_model.h>

  #include <linux/err.h>

  #include <linux/notifier.h>

  struct clk;
  struct regulator;

  struct dev_pm_opp;

  struct device;

  struct opp_table;

  enum dev_pm_opp_event {

  	OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,

  	OPP_EVENT_ADJUST_VOLTAGE,

  };

  /**
   * struct dev_pm_opp_supply - Power supply voltage/current values
   * @u_volt:	Target voltage in microvolts corresponding to this OPP
   * @u_volt_min:	Minimum voltage in microvolts corresponding to this OPP
   * @u_volt_max:	Maximum voltage in microvolts corresponding to this OPP
   * @u_amp:	Maximum current drawn by the device in microamperes
   *
   * This structure stores the voltage/current values for a single power supply.
   */
  struct dev_pm_opp_supply {
  	unsigned long u_volt;
  	unsigned long u_volt_min;
  	unsigned long u_volt_max;
  	unsigned long u_amp;
  };

  /**

   * struct dev_pm_opp_icc_bw - Interconnect bandwidth values
   * @avg:	Average bandwidth corresponding to this OPP (in icc units)
   * @peak:	Peak bandwidth corresponding to this OPP (in icc units)
   *
   * This structure stores the bandwidth values for a single interconnect path.
   */
  struct dev_pm_opp_icc_bw {
  	u32 avg;
  	u32 peak;
  };
  
  /**

   * struct dev_pm_opp_info - OPP freq/voltage/current values
   * @rate:	Target clk rate in hz
   * @supplies:	Array of voltage/current values for all power supplies
   *
   * This structure stores the freq/voltage/current values for a single OPP.
   */
  struct dev_pm_opp_info {
  	unsigned long rate;
  	struct dev_pm_opp_supply *supplies;
  };
  
  /**
   * struct dev_pm_set_opp_data - Set OPP data
   * @old_opp:	Old OPP info
   * @new_opp:	New OPP info
   * @regulators:	Array of regulator pointers
   * @regulator_count: Number of regulators
   * @clk:	Pointer to clk
   * @dev:	Pointer to the struct device
   *
   * This structure contains all information required for setting an OPP.
   */
  struct dev_pm_set_opp_data {
  	struct dev_pm_opp_info old_opp;
  	struct dev_pm_opp_info new_opp;
  
  	struct regulator **regulators;
  	unsigned int regulator_count;
  	struct clk *clk;
  	struct device *dev;
  };

  #if defined(CONFIG_PM_OPP)

  struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);

  struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index);

  void dev_pm_opp_put_opp_table(struct opp_table *opp_table);

  unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);

  unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);

  unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);

  bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);

  int dev_pm_opp_get_opp_count(struct device *dev);

  unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);

  unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);

  unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);

  unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);

  struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
  					      unsigned long freq,
  					      bool available);

  struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
  					       unsigned int level);

  struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
  					      unsigned long *freq);

  struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
  						     unsigned long u_volt);

  struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
  					     unsigned long *freq);

  void dev_pm_opp_put(struct dev_pm_opp *opp);

  int dev_pm_opp_add(struct device *dev, unsigned long freq,
  		   unsigned long u_volt);

  void dev_pm_opp_remove(struct device *dev, unsigned long freq);

  void dev_pm_opp_remove_all_dynamic(struct device *dev);

  int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
  			      unsigned long u_volt, unsigned long u_volt_min,
  			      unsigned long u_volt_max);

  int dev_pm_opp_enable(struct device *dev, unsigned long freq);

  int dev_pm_opp_disable(struct device *dev, unsigned long freq);

  int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
  int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);

  struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
  void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
  struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
  void dev_pm_opp_put_prop_name(struct opp_table *opp_table);

  struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
  void dev_pm_opp_put_regulators(struct opp_table *opp_table);

  struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name);
  void dev_pm_opp_put_clkname(struct opp_table *opp_table);

  struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));

  void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);

  struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs);

  void dev_pm_opp_detach_genpd(struct opp_table *opp_table);

  int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);

  int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);

  int dev_pm_opp_set_bw(struct device *dev, struct dev_pm_opp *opp);

  int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
  int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);

  void dev_pm_opp_remove_table(struct device *dev);
  void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);

  #else

  static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
  {
  	return ERR_PTR(-ENOTSUPP);
  }

  static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
  {
  	return ERR_PTR(-ENOTSUPP);
  }

  static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}

  static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)

  {
  	return 0;
  }

  static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)

  {
  	return 0;
  }

  static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
  {
  	return 0;
  }

  static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
  {
  	return false;
  }

  static inline int dev_pm_opp_get_opp_count(struct device *dev)

  {
  	return 0;
  }

  static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
  {
  	return 0;
  }

  static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
  {
  	return 0;
  }

  static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
  {
  	return 0;
  }

  static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)

  {

  	return 0;

  }

  static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,

  					unsigned long freq, bool available)
  {

  	return ERR_PTR(-ENOTSUPP);

  }

  static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
  					unsigned int level)
  {
  	return ERR_PTR(-ENOTSUPP);
  }

  static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,

  					unsigned long *freq)
  {

  	return ERR_PTR(-ENOTSUPP);

  }

  static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
  					unsigned long u_volt)
  {
  	return ERR_PTR(-ENOTSUPP);
  }

  static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,

  					unsigned long *freq)
  {

  	return ERR_PTR(-ENOTSUPP);

  }

  static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}

  static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,

  					unsigned long u_volt)
  {

  	return -ENOTSUPP;

  }

  static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
  {
  }

  static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
  {
  }

  static inline int
  dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
  			  unsigned long u_volt, unsigned long u_volt_min,
  			  unsigned long u_volt_max)
  {
  	return 0;
  }

  static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)

  {
  	return 0;
  }

  static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)

  {
  	return 0;
  }

  static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)

  {

  	return -ENOTSUPP;
  }
  
  static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
  {
  	return -ENOTSUPP;

  }

  static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
  							    const u32 *versions,
  							    unsigned int count)

  {

  	return ERR_PTR(-ENOTSUPP);

  }

  static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}

  static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,

  			int (*set_opp)(struct dev_pm_set_opp_data *data))
  {

  	return ERR_PTR(-ENOTSUPP);

  }

  static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}

  static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)

  {

  	return ERR_PTR(-ENOTSUPP);

  }

  static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}

  static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)

  {

  	return ERR_PTR(-ENOTSUPP);

  }

  static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}

  static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name)
  {
  	return ERR_PTR(-ENOTSUPP);
  }
  
  static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}

  static inline struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs)

  {
  	return ERR_PTR(-ENOTSUPP);
  }

  static inline void dev_pm_opp_detach_genpd(struct opp_table *opp_table) {}

  
  static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
  {
  	return -ENOTSUPP;
  }

  static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
  {

  	return -ENOTSUPP;

  }

  static inline int dev_pm_opp_set_bw(struct device *dev, struct dev_pm_opp *opp)
  {
  	return -EOPNOTSUPP;
  }

  static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)

  {

  	return -ENOTSUPP;

  }

  static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)

  {
  	return -EINVAL;
  }

  static inline void dev_pm_opp_remove_table(struct device *dev)
  {
  }
  
  static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
  {
  }

  #endif		/* CONFIG_PM_OPP */

  #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)

  int dev_pm_opp_of_add_table(struct device *dev);

  int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);

  void dev_pm_opp_of_remove_table(struct device *dev);

  int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
  void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
  int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);

  struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);

  struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);

  int of_get_required_opp_performance_state(struct device_node *np, int index);

  int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);

  int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus);
  static inline void dev_pm_opp_of_unregister_em(struct device *dev)
  {
  	em_dev_unregister_perf_domain(dev);
  }

  #else

  static inline int dev_pm_opp_of_add_table(struct device *dev)

  {

  	return -ENOTSUPP;

  }

  static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
  {
  	return -ENOTSUPP;
  }

  static inline void dev_pm_opp_of_remove_table(struct device *dev)

  {
  }

  static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)

  {

  	return -ENOTSUPP;

  }

  static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)

  {
  }

  static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)

  {

  	return -ENOTSUPP;

  }

  
  static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
  {
  	return NULL;
  }

  static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
  {
  	return NULL;
  }

  static inline int dev_pm_opp_of_register_em(struct device *dev,
  					    struct cpumask *cpus)
  {
  	return -ENOTSUPP;
  }
  
  static inline void dev_pm_opp_of_unregister_em(struct device *dev)

  {
  }

  static inline int of_get_required_opp_performance_state(struct device_node *np, int index)

  {

  	return -ENOTSUPP;

  }

  
  static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
  {
  	return -ENOTSUPP;
  }

  #endif

  #endif		/* __LINUX_OPP_H__ */