Skip to content

Commit fe52de3

Browse files
committed
PM: QoS: Update file information comments
Update the file information comments in include/linux/pm_qos.h and kernel/power/qos.c by adding titles along with copyright and authors information to them and changing the qos.c description to better reflect its contents (outdated information is dropped from it in particular). Signed-off-by: Rafael J. Wysocki <[email protected]> Reviewed-by: Ulf Hansson <[email protected]> Reviewed-by: Amit Kucheria <[email protected]> Tested-by: Amit Kucheria <[email protected]>
1 parent 67b06ba commit fe52de3

File tree

2 files changed

+23
-26
lines changed

2 files changed

+23
-26
lines changed

include/linux/pm_qos.h

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
/* SPDX-License-Identifier: GPL-2.0 */
2-
#ifndef _LINUX_PM_QOS_H
3-
#define _LINUX_PM_QOS_H
4-
/* interface for the pm_qos_power infrastructure of the linux kernel.
2+
/*
3+
* Definitions related to Power Management Quality of Service (PM QoS).
4+
*
5+
* Copyright (C) 2020 Intel Corporation
56
*
6-
* Mark Gross <[email protected]>
7+
* Authors:
8+
* Mark Gross <[email protected]>
9+
* Rafael J. Wysocki <[email protected]>
710
*/
11+
12+
#ifndef _LINUX_PM_QOS_H
13+
#define _LINUX_PM_QOS_H
14+
815
#include <linux/plist.h>
916
#include <linux/notifier.h>
1017
#include <linux/device.h>

kernel/power/qos.c

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,21 @@
11
// SPDX-License-Identifier: GPL-2.0-only
22
/*
3-
* This module exposes the interface to kernel space for specifying
4-
* QoS dependencies. It provides infrastructure for registration of:
3+
* Power Management Quality of Service (PM QoS) support base.
54
*
6-
* Dependents on a QoS value : register requests
7-
* Watchers of QoS value : get notified when target QoS value changes
5+
* Copyright (C) 2020 Intel Corporation
86
*
9-
* This QoS design is best effort based. Dependents register their QoS needs.
10-
* Watchers register to keep track of the current QoS needs of the system.
7+
* Authors:
8+
* Mark Gross <[email protected]>
9+
* Rafael J. Wysocki <[email protected]>
1110
*
12-
* There are 3 basic classes of QoS parameter: latency, timeout, throughput
13-
* each have defined units:
14-
* latency: usec
15-
* timeout: usec <-- currently not used.
16-
* throughput: kbs (kilo byte / sec)
11+
* Provided here is an interface for specifying PM QoS dependencies. It allows
12+
* entities depending on QoS constraints to register their requests which are
13+
* aggregated as appropriate to produce effective constraints (target values)
14+
* that can be monitored by entities needing to respect them, either by polling
15+
* or through a built-in notification mechanism.
1716
*
18-
* There are lists of pm_qos_objects each one wrapping requests, notifiers
19-
*
20-
* User mode requests on a QOS parameter register themselves to the
21-
* subsystem by opening the device node /dev/... and writing there request to
22-
* the node. As long as the process holds a file handle open to the node the
23-
* client continues to be accounted for. Upon file release the usermode
24-
* request is removed and a new qos target is computed. This way when the
25-
* request that the application has is cleaned up when closes the file
26-
* pointer or exits the pm_qos_object will get an opportunity to clean up.
27-
*
28-
* Mark Gross <[email protected]>
17+
* In addition to the basic functionality, more specific interfaces for managing
18+
* global CPU latency QoS requests and frequency QoS requests are provided.
2919
*/
3020

3121
/*#define DEBUG*/

0 commit comments

Comments
 (0)