Commit bf1db69f authored by Richard Hughes's avatar Richard Hughes Committed by Linus Torvalds

pm_qos: spelling fixes

A documentation cleanup patch.  With a minor tweak to clarify units for
kbs.

[akpm@linux-foundation.org: coding-style fixes]
Signed-off-by: default avatarmark gross <mgross@linux.intel.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 7c44319d
PM quality of Service interface. PM Quality Of Service Interface.
This interface provides a kernel and user mode interface for registering This interface provides a kernel and user mode interface for registering
performance expectations by drivers, subsystems and user space applications on performance expectations by drivers, subsystems and user space applications on
...@@ -7,6 +7,11 @@ one of the parameters. ...@@ -7,6 +7,11 @@ one of the parameters.
Currently we have {cpu_dma_latency, network_latency, network_throughput} as the Currently we have {cpu_dma_latency, network_latency, network_throughput} as the
initial set of pm_qos parameters. initial set of pm_qos parameters.
Each parameters have defined units:
* latency: usec
* timeout: usec
* throughput: kbs (kilo bit / sec)
The infrastructure exposes multiple misc device nodes one per implemented The infrastructure exposes multiple misc device nodes one per implemented
parameter. The set of parameters implement is defined by pm_qos_power_init() parameter. The set of parameters implement is defined by pm_qos_power_init()
and pm_qos_params.h. This is done because having the available parameters and pm_qos_params.h. This is done because having the available parameters
......
/* interface for the pm_qos_power infrastructure of the linux kernel. /* interface for the pm_qos_power infrastructure of the linux kernel.
* *
* Mark Gross * Mark Gross <mgross@linux.intel.com>
*/ */
#include <linux/list.h> #include <linux/list.h>
#include <linux/notifier.h> #include <linux/notifier.h>
......
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
* requirement that the application has is cleaned up when closes the file * requirement that the application has is cleaned up when closes the file
* pointer or exits the pm_qos_object will get an opportunity to clean up. * pointer or exits the pm_qos_object will get an opportunity to clean up.
* *
* mark gross mgross@linux.intel.com * Mark Gross <mgross@linux.intel.com>
*/ */
#include <linux/pm_qos_params.h> #include <linux/pm_qos_params.h>
...@@ -211,8 +211,8 @@ EXPORT_SYMBOL_GPL(pm_qos_requirement); ...@@ -211,8 +211,8 @@ EXPORT_SYMBOL_GPL(pm_qos_requirement);
* @value: defines the qos request * @value: defines the qos request
* *
* This function inserts a new entry in the pm_qos_class list of requested qos * This function inserts a new entry in the pm_qos_class list of requested qos
* performance charactoistics. It recomputes the agregate QoS expectations for * performance characteristics. It recomputes the aggregate QoS expectations
* the pm_qos_class of parrameters. * for the pm_qos_class of parameters.
*/ */
int pm_qos_add_requirement(int pm_qos_class, char *name, s32 value) int pm_qos_add_requirement(int pm_qos_class, char *name, s32 value)
{ {
...@@ -250,10 +250,10 @@ EXPORT_SYMBOL_GPL(pm_qos_add_requirement); ...@@ -250,10 +250,10 @@ EXPORT_SYMBOL_GPL(pm_qos_add_requirement);
* @name: identifies the request * @name: identifies the request
* @value: defines the qos request * @value: defines the qos request
* *
* Updates an existing qos requierement for the pm_qos_class of parameters along * Updates an existing qos requirement for the pm_qos_class of parameters along
* with updating the target pm_qos_class value. * with updating the target pm_qos_class value.
* *
* If the named request isn't in the lest then no change is made. * If the named request isn't in the list then no change is made.
*/ */
int pm_qos_update_requirement(int pm_qos_class, char *name, s32 new_value) int pm_qos_update_requirement(int pm_qos_class, char *name, s32 new_value)
{ {
...@@ -287,7 +287,7 @@ EXPORT_SYMBOL_GPL(pm_qos_update_requirement); ...@@ -287,7 +287,7 @@ EXPORT_SYMBOL_GPL(pm_qos_update_requirement);
* @pm_qos_class: identifies which list of qos request to us * @pm_qos_class: identifies which list of qos request to us
* @name: identifies the request * @name: identifies the request
* *
* Will remove named qos request from pm_qos_class list of parrameters and * Will remove named qos request from pm_qos_class list of parameters and
* recompute the current target value for the pm_qos_class. * recompute the current target value for the pm_qos_class.
*/ */
void pm_qos_remove_requirement(int pm_qos_class, char *name) void pm_qos_remove_requirement(int pm_qos_class, char *name)
...@@ -319,7 +319,7 @@ EXPORT_SYMBOL_GPL(pm_qos_remove_requirement); ...@@ -319,7 +319,7 @@ EXPORT_SYMBOL_GPL(pm_qos_remove_requirement);
* @notifier: notifier block managed by caller. * @notifier: notifier block managed by caller.
* *
* will register the notifier into a notification chain that gets called * will register the notifier into a notification chain that gets called
* uppon changes to the pm_qos_class target value. * upon changes to the pm_qos_class target value.
*/ */
int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier) int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier)
{ {
...@@ -338,7 +338,7 @@ EXPORT_SYMBOL_GPL(pm_qos_add_notifier); ...@@ -338,7 +338,7 @@ EXPORT_SYMBOL_GPL(pm_qos_add_notifier);
* @notifier: notifier block to be removed. * @notifier: notifier block to be removed.
* *
* will remove the notifier from the notification chain that gets called * will remove the notifier from the notification chain that gets called
* uppon changes to the pm_qos_class target value. * upon changes to the pm_qos_class target value.
*/ */
int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier) int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier)
{ {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment