PM / OPP: rename functions to dev_pm_opp*

OPP library facilitates this concept in it's implementation. The following

operational functions operate only on available opps:

opp_find_freq_{ceil, floor}, opp_get_voltage, opp_get_freq, opp_get_opp_count

and opp_init_cpufreq_table

opp_find_freq_{ceil, floor}, dev_pm_opp_get_voltage, dev_pm_opp_get_freq, dev_pm_opp_get_opp_count

and dev_pm_opp_init_cpufreq_table

opp_find_freq_exact is meant to be used to find the opp pointer which can then

be used for opp_enable/disable functions to make an opp available as required.

dev_pm_opp_find_freq_exact is meant to be used to find the opp pointer which can then

be used for dev_pm_opp_enable/disable functions to make an opp available as required.

WARNING: Users of OPP library should refresh their availability count using

get_opp_count if opp_enable/disable functions are invoked for a device, the

get_opp_count if dev_pm_opp_enable/disable functions are invoked for a device, the

exact mechanism to trigger these or the notification mechanism to other

dependent subsystems such as cpufreq are left to the discretion of the SoC

specific framework which uses the OPP library. Similar care needs to be taken

opp_get_{voltage, freq, opp_count} fall into this category.

opp_{add,enable,disable} are updaters which use mutex and implement it's own

RCU locking mechanisms. opp_init_cpufreq_table acts as an updater and uses

RCU locking mechanisms. dev_pm_opp_init_cpufreq_table acts as an updater and uses

mutex to implment RCU updater strategy. These functions should *NOT* be called

under RCU locks and other contexts that prevent blocking functions in RCU or

mutex operations from working.

2. Initial OPP List Registration

================================

The SoC implementation calls opp_add function iteratively to add OPPs per

The SoC implementation calls dev_pm_opp_add function iteratively to add OPPs per

device. It is expected that the SoC framework will register the OPP entries

optimally- typical numbers range to be less than 5. The list generated by

registering the OPPs is maintained by OPP library throughout the device

operation. The SoC framework can subsequently control the availability of the

OPPs dynamically using the opp_enable / disable functions.

OPPs dynamically using the dev_pm_opp_enable / disable functions.

opp_add - Add a new OPP for a specific domain represented by the device pointer.

dev_pm_opp_add - Add a new OPP for a specific domain represented by the device pointer.

	The OPP is defined using the frequency and voltage. Once added, the OPP

	is assumed to be available and control of it's availability can be done

	with the opp_enable/disable functions. OPP library internally stores

	with the dev_pm_opp_enable/disable functions. OPP library internally stores

	and manages this information in the opp struct. This function may be

	used by SoC framework to define a optimal list as per the demands of

	SoC usage environment.

	 soc_pm_init()

	 {

		/* Do things */

		r = opp_add(mpu_dev, 1000000, 900000);

		r = dev_pm_opp_add(mpu_dev, 1000000, 900000);

		if (!r) {

			pr_err("%s: unable to register mpu opp(%d)\n", r);

			goto no_cpufreq;

found, else returns error. These errors are expected to be handled by standard

error checks such as IS_ERR() and appropriate actions taken by the caller.

opp_find_freq_exact - Search for an OPP based on an *exact* frequency and

dev_pm_opp_find_freq_exact - Search for an OPP based on an *exact* frequency and

	availability. This function is especially useful to enable an OPP which

	is not available by default.

	Example: In a case when SoC framework detects a situation where a

	higher frequency could be made available, it can use this function to

	find the OPP prior to call the opp_enable to actually make it available.

	find the OPP prior to call the dev_pm_opp_enable to actually make it available.

	 rcu_read_lock();

	 opp = opp_find_freq_exact(dev, 1000000000, false);

	 opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);

	 rcu_read_unlock();

	 /* dont operate on the pointer.. just do a sanity check.. */

	 if (IS_ERR(opp)) {

		pr_err("frequency not disabled!\n");

		/* trigger appropriate actions.. */

	 } else {

		opp_enable(dev,1000000000);

		dev_pm_opp_enable(dev,1000000000);

	 }

	NOTE: This is the only search function that operates on OPPs which are

	not available.

opp_find_freq_floor - Search for an available OPP which is *at most* the

dev_pm_opp_find_freq_floor - Search for an available OPP which is *at most* the

	provided frequency. This function is useful while searching for a lesser

	match OR operating on OPP information in the order of decreasing

	frequency.

	Example: To find the highest opp for a device:

	 freq = ULONG_MAX;

	 rcu_read_lock();

	 opp_find_freq_floor(dev, &freq);

	 dev_pm_opp_find_freq_floor(dev, &freq);

	 rcu_read_unlock();

opp_find_freq_ceil - Search for an available OPP which is *at least* the

dev_pm_opp_find_freq_ceil - Search for an available OPP which is *at least* the

	provided frequency. This function is useful while searching for a

	higher match OR operating on OPP information in the order of increasing

	frequency.

	Example 1: To find the lowest opp for a device:

	 freq = 0;

	 rcu_read_lock();

	 opp_find_freq_ceil(dev, &freq);

	 dev_pm_opp_find_freq_ceil(dev, &freq);

	 rcu_read_unlock();

	Example 2: A simplified implementation of a SoC cpufreq_driver->target:

	 soc_cpufreq_target(..)

		/* Do stuff like policy checks etc. */

		/* Find the best frequency match for the req */

		rcu_read_lock();

		opp = opp_find_freq_ceil(dev, &freq);

		opp = dev_pm_opp_find_freq_ceil(dev, &freq);

		rcu_read_unlock();

		if (!IS_ERR(opp))

			soc_switch_to_freq_voltage(freq);

WARNING: Do not use these functions in interrupt context.

opp_enable - Make a OPP available for operation.

dev_pm_opp_enable - Make a OPP available for operation.

	Example: Lets say that 1GHz OPP is to be made available only if the

	SoC temperature is lower than a certain threshold. The SoC framework

	implementation might choose to do something as follows:

	 if (cur_temp < temp_low_thresh) {

		/* Enable 1GHz if it was disabled */

		rcu_read_lock();

		opp = opp_find_freq_exact(dev, 1000000000, false);

		opp = dev_pm_opp_find_freq_exact(dev, 1000000000, false);

		rcu_read_unlock();

		/* just error check */

		if (!IS_ERR(opp))

			ret = opp_enable(dev, 1000000000);

			ret = dev_pm_opp_enable(dev, 1000000000);

		else

			goto try_something_else;

	 }

opp_disable - Make an OPP to be not available for operation

dev_pm_opp_disable - Make an OPP to be not available for operation

	Example: Lets say that 1GHz OPP is to be disabled if the temperature

	exceeds a threshold value. The SoC framework implementation might

	choose to do something as follows:

	 if (cur_temp > temp_high_thresh) {

		/* Disable 1GHz if it was enabled */

		rcu_read_lock();

		opp = opp_find_freq_exact(dev, 1000000000, true);

		opp = dev_pm_opp_find_freq_exact(dev, 1000000000, true);

		rcu_read_unlock();

		/* just error check */

		if (!IS_ERR(opp))

			ret = opp_disable(dev, 1000000000);

			ret = dev_pm_opp_disable(dev, 1000000000);

		else

			goto try_something_else;

	 }

retrieved using the search functions, the following functions can be used by SoC

framework to retrieve the information represented inside the OPP layer.

opp_get_voltage - Retrieve the voltage represented by the opp pointer.

dev_pm_opp_get_voltage - Retrieve the voltage represented by the opp pointer.

	Example: At a cpufreq transition to a different frequency, SoC

	framework requires to set the voltage represented by the OPP using

	the regulator framework to the Power Management chip providing the

	 {

		/* do things */

		rcu_read_lock();

		opp = opp_find_freq_ceil(dev, &freq);

		v = opp_get_voltage(opp);

		opp = dev_pm_opp_find_freq_ceil(dev, &freq);

		v = dev_pm_opp_get_voltage(opp);

		rcu_read_unlock();

		if (v)

			regulator_set_voltage(.., v);

		/* do other things */

	 }

opp_get_freq - Retrieve the freq represented by the opp pointer.

dev_pm_opp_get_freq - Retrieve the freq represented by the opp pointer.

	Example: Lets say the SoC framework uses a couple of helper functions

	we could pass opp pointers instead of doing additional parameters to

	handle quiet a bit of data parameters.

		/* do things.. */

		 max_freq = ULONG_MAX;

		 rcu_read_lock();

		 max_opp = opp_find_freq_floor(dev,&max_freq);

		 requested_opp = opp_find_freq_ceil(dev,&freq);

		 max_opp = dev_pm_opp_find_freq_floor(dev,&max_freq);

		 requested_opp = dev_pm_opp_find_freq_ceil(dev,&freq);

		 if (!IS_ERR(max_opp) && !IS_ERR(requested_opp))

			r = soc_test_validity(max_opp, requested_opp);

		 rcu_read_unlock();

	 }

	 soc_test_validity(..)

	 {

		 if(opp_get_voltage(max_opp) < opp_get_voltage(requested_opp))

		 if(dev_pm_opp_get_voltage(max_opp) < dev_pm_opp_get_voltage(requested_opp))

			 return -EINVAL;

		 if(opp_get_freq(max_opp) < opp_get_freq(requested_opp))

		 if(dev_pm_opp_get_freq(max_opp) < dev_pm_opp_get_freq(requested_opp))

			 return -EINVAL;

		/* do things.. */

	 }

opp_get_opp_count - Retrieve the number of available opps for a device

dev_pm_opp_get_opp_count - Retrieve the number of available opps for a device

	Example: Lets say a co-processor in the SoC needs to know the available

	frequencies in a table, the main processor can notify as following:

	 soc_notify_coproc_available_frequencies()

	 {

		/* Do things */

		rcu_read_lock();

		num_available = opp_get_opp_count(dev);

		num_available = dev_pm_opp_get_opp_count(dev);

		speeds = kzalloc(sizeof(u32) * num_available, GFP_KERNEL);

		/* populate the table in increasing order */

		freq = 0;

		while (!IS_ERR(opp = opp_find_freq_ceil(dev, &freq))) {

		while (!IS_ERR(opp = dev_pm_opp_find_freq_ceil(dev, &freq))) {

			speeds[i] = freq;

			freq++;

			i++;

6. Cpufreq Table Generation

===========================

opp_init_cpufreq_table - cpufreq framework typically is initialized with

dev_pm_opp_init_cpufreq_table - cpufreq framework typically is initialized with

	cpufreq_frequency_table_cpuinfo which is provided with the list of

	frequencies that are available for operation. This function provides

	a ready to use conversion routine to translate the OPP layer's internal

	 soc_pm_init()

	 {

		/* Do things */

		r = opp_init_cpufreq_table(dev, &freq_table);

		r = dev_pm_opp_init_cpufreq_table(dev, &freq_table);

		if (!r)

			cpufreq_frequency_table_cpuinfo(policy, freq_table);

		/* Do other things */

	addition to CONFIG_PM as power management feature is required to

	dynamically scale voltage and frequency in a system.

opp_free_cpufreq_table - Free up the table allocated by opp_init_cpufreq_table

dev_pm_opp_free_cpufreq_table - Free up the table allocated by dev_pm_opp_init_cpufreq_table

7. Data Structures

==================

	identifier for OPP in the interactions with OPP layer.

	WARNING: The struct opp pointer should not be parsed or modified by the

	users. The defaults of for an instance is populated by opp_add, but the

	availability of the OPP can be modified by opp_enable/disable functions.

	users. The defaults of for an instance is populated by dev_pm_opp_add, but the

	availability of the OPP can be modified by dev_pm_opp_enable/disable functions.

struct device - This is used to identify a domain to the OPP layer. The

	nature of the device and it's implementation is left to the user of

following:

Initialization / modification:

            +-----+        /- opp_enable

opp_add --> | opp | <-------

  |         +-----+        \- opp_disable

            +-----+        /- dev_pm_opp_enable

dev_pm_opp_add --> | opp | <-------

  |         +-----+        \- dev_pm_opp_disable

  \-------> domain_info(device)

Search functions:

             /-- opp_find_freq_ceil  ---\   +-----+

domain_info<---- opp_find_freq_exact -----> | opp |

             \-- opp_find_freq_floor ---/   +-----+

             /-- dev_pm_opp_find_freq_ceil  ---\   +-----+

domain_info<---- dev_pm_opp_find_freq_exact -----> | opp |

             \-- dev_pm_opp_find_freq_floor ---/   +-----+

Retrieval functions:

+-----+     /- opp_get_voltage

+-----+     /- dev_pm_opp_get_voltage

| opp | <---

+-----+     \- opp_get_freq

+-----+     \- dev_pm_opp_get_freq

domain_info <- opp_get_opp_count

domain_info <- dev_pm_opp_get_opp_count

	val = readl_relaxed(base + OCOTP_CFG3);

	val >>= OCOTP_CFG3_SPEED_SHIFT;

	if ((val & 0x3) != OCOTP_CFG3_SPEED_1P2GHZ)

		if (opp_disable(cpu_dev, 1200000000))

		if (dev_pm_opp_disable(cpu_dev, 1200000000))

			pr_warn("failed to disable 1.2 GHz OPP\n");

put_node:

			return -ENODEV;

		}

		/* Enable MPU 1GHz and lower opps */

		r = opp_enable(mpu_dev, 800000000);

		r = dev_pm_opp_enable(mpu_dev, 800000000);

		/* TODO: MPU 1GHz needs SR and ABB */

		/* Enable IVA 800MHz and lower opps */

		r |= opp_enable(iva_dev, 660000000);

		r |= dev_pm_opp_enable(iva_dev, 660000000);

		/* TODO: DSP 800MHz needs SR and ABB */

		if (r) {

			pr_err("%s: failed to enable higher opp %d\n",

			 * Cleanup - disable the higher freqs - we dont care

			 * about the results

			 */

			opp_disable(mpu_dev, 800000000);

			opp_disable(iva_dev, 660000000);

			dev_pm_opp_disable(mpu_dev, 800000000);

			dev_pm_opp_disable(iva_dev, 660000000);

		}

	}

	return 0;

			dev = &oh->od->pdev->dev;

		}

		r = opp_add(dev, opp_def->freq, opp_def->u_volt);

		r = dev_pm_opp_add(dev, opp_def->freq, opp_def->u_volt);

		if (r) {

			dev_err(dev, "%s: add OPP %ld failed for %s [%d] result=%d\n",

				__func__, opp_def->freq,

				opp_def->hwmod_name, i, r);

		} else {

			if (!opp_def->default_available)

				r = opp_disable(dev, opp_def->freq);

				r = dev_pm_opp_disable(dev, opp_def->freq);

			if (r)

				dev_err(dev, "%s: disable %ld failed for %s [%d] result=%d\n",

					__func__, opp_def->freq,

	clk_put(clk);

	rcu_read_lock();

	opp = opp_find_freq_ceil(dev, &freq);

	opp = dev_pm_opp_find_freq_ceil(dev, &freq);

	if (IS_ERR(opp)) {

		rcu_read_unlock();

		pr_err("%s: unable to find boot up OPP for vdd_%s\n",

		goto exit;

	}

	bootup_volt = opp_get_voltage(opp);

	bootup_volt = dev_pm_opp_get_voltage(opp);

	rcu_read_unlock();

	if (!bootup_volt) {

		pr_err("%s: unable to find voltage corresponding to the bootup OPP for vdd_%s\n",