admin/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2025-12-07 20:06:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

drm/xe/forcewake: Improve kerneldoc

Browse Source 
Improve the kerneldoc for forcewake a bit to give more detail about what
the structures represent.

Reviewed-by: Gustavo Sousa <gustavo.sousa@intel.com>
Reviewed-by: Stuart Summers <stuart.summers@intel.com>
Link: https://patch.msgid.link/20251110232017.1475869-33-matthew.d.roper@intel.com
Signed-off-by: Matt Roper <matthew.d.roper@intel.com>
This commit is contained in:
Matt Roper
2025-11-10 15:20:19 -08:00
parent e448372e8a
commit defdf27284
1 changed files with 24 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
drivers/gpu/drm/xe/xe_force_wake_types.h
View File

@@ -52,7 +52,22 @@ enum xe_force_wake_domains {
};
/**
* struct xe_force_wake_domain - Xe force wake domains
* struct xe_force_wake_domain - Xe force wake power domain
*
* Represents an individual device-internal power domain. The driver must
* ensure the power domain is awake before accessing registers or other
* hardware functionality that is part of the power domain. Since different
* driver threads may access hardware units simultaneously, a reference count
* is used to ensure that the domain remains awake as long as any software
* is using the part of the hardware covered by the power domain.
*
* Hardware provides a register interface to allow the driver to request
* wake/sleep of power domains, although in most cases the actual action of
* powering the hardware up/down is handled by firmware (and may be subject to
* requirements and constraints outside of the driver's visibility) so the
* driver needs to wait for an acknowledgment that a wake request has been
* acted upon before accessing the parts of the hardware that reside within the
* power domain.
*/
struct xe_force_wake_domain {
/** @id: domain force wake id */
@@ -70,7 +85,14 @@ struct xe_force_wake_domain {
};
/**
* struct xe_force_wake - Xe force wake
* struct xe_force_wake - Xe force wake collection
*
* Represents a collection of related power domains (struct
* xe_force_wake_domain) associated with a subunit of the device.
*
* Currently only used for GT power domains (where the term "forcewake" is used
* in the hardware documentation), although the interface could be extended to
* power wells in other parts of the hardware in the future.
*/
struct xe_force_wake {
/** @gt: back pointers to GT */