mirror of
https://github.com/torvalds/linux.git
synced 2026-04-18 14:53:58 -04:00
50a59230fa
Add a scope-based helpers for runtime PM that may be used to simplify
cleanup logic and potentially avoid goto-based cleanup.
For example, using
guard(xe_pm_runtime)(xe);
will get runtime PM and cause a corresponding put to occur automatically
when the current scope is exited. 'xe_pm_runtime_noresume' can be used
as a guard replacement for the corresponding 'noresume' variant.
There's also an xe_pm_runtime_ioctl conditional guard that can be used
as a replacement for xe_runtime_ioctl():
ACQUIRE(xe_pm_runtime_ioctl, pm)(xe);
if ((ret = ACQUIRE_ERR(xe_pm_runtime_ioctl, &pm)) < 0)
/* failed */
In a few rare cases (such as gt_reset_worker()) we need to ensure that
runtime PM is dropped when the function is exited by any means
(including error paths), but the function does not need to acquire
runtime PM because that has already been done earlier by a different
function. For these special cases, an 'xe_pm_runtime_release_only'
guard can be used to handle the release without doing an acquisition.
These guards will be used in future patches to eliminate some of our
goto-based cleanup.
v2:
- Specify success condition for xe_pm runtime_ioctl as _RET >= 0 so
that positive values will be properly identified as success and
trigger destructor cleanup properly.
v3:
- Add comments to the kerneldoc for the existing 'get' functions
indicating that scope-based handling should be preferred where
possible. (Gustavo)
Cc: Gustavo Sousa <gustavo.sousa@intel.com>
Reviewed-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
Reviewed-by: Gustavo Sousa <gustavo.sousa@intel.com>
Link: https://patch.msgid.link/20251118164338.3572146-31-matthew.d.roper@intel.com
Signed-off-by: Matt Roper <matthew.d.roper@intel.com>
(cherry picked from commit 59e7528dbf)
Signed-off-by: Thomas Hellström <thomas.hellstrom@linux.intel.com>
58 lines
2.1 KiB
C
58 lines
2.1 KiB
C
/* SPDX-License-Identifier: MIT */
|
|
/*
|
|
* Copyright © 2022 Intel Corporation
|
|
*/
|
|
|
|
#ifndef _XE_PM_H_
|
|
#define _XE_PM_H_
|
|
|
|
#include <linux/cleanup.h>
|
|
#include <linux/pm_runtime.h>
|
|
|
|
#define DEFAULT_VRAM_THRESHOLD 300 /* in MB */
|
|
|
|
struct xe_device;
|
|
|
|
int xe_pm_suspend(struct xe_device *xe);
|
|
int xe_pm_resume(struct xe_device *xe);
|
|
|
|
int xe_pm_init_early(struct xe_device *xe);
|
|
int xe_pm_init(struct xe_device *xe);
|
|
void xe_pm_fini(struct xe_device *xe);
|
|
bool xe_pm_runtime_suspended(struct xe_device *xe);
|
|
int xe_pm_runtime_suspend(struct xe_device *xe);
|
|
int xe_pm_runtime_resume(struct xe_device *xe);
|
|
void xe_pm_runtime_get(struct xe_device *xe);
|
|
int xe_pm_runtime_get_ioctl(struct xe_device *xe);
|
|
void xe_pm_runtime_put(struct xe_device *xe);
|
|
bool xe_pm_runtime_get_if_active(struct xe_device *xe);
|
|
bool xe_pm_runtime_get_if_in_use(struct xe_device *xe);
|
|
void xe_pm_runtime_get_noresume(struct xe_device *xe);
|
|
bool xe_pm_runtime_resume_and_get(struct xe_device *xe);
|
|
void xe_pm_assert_unbounded_bridge(struct xe_device *xe);
|
|
int xe_pm_set_vram_threshold(struct xe_device *xe, u32 threshold);
|
|
void xe_pm_d3cold_allowed_toggle(struct xe_device *xe);
|
|
bool xe_rpm_reclaim_safe(const struct xe_device *xe);
|
|
struct task_struct *xe_pm_read_callback_task(struct xe_device *xe);
|
|
int xe_pm_block_on_suspend(struct xe_device *xe);
|
|
void xe_pm_might_block_on_suspend(void);
|
|
int xe_pm_module_init(void);
|
|
|
|
static inline void __xe_pm_runtime_noop(struct xe_device *xe) {}
|
|
|
|
DEFINE_GUARD(xe_pm_runtime, struct xe_device *,
|
|
xe_pm_runtime_get(_T), xe_pm_runtime_put(_T))
|
|
DEFINE_GUARD(xe_pm_runtime_noresume, struct xe_device *,
|
|
xe_pm_runtime_get_noresume(_T), xe_pm_runtime_put(_T))
|
|
DEFINE_GUARD_COND(xe_pm_runtime, _ioctl, xe_pm_runtime_get_ioctl(_T), _RET >= 0)
|
|
|
|
/*
|
|
* Used when a function needs to release runtime PM in all possible cases
|
|
* and error paths, but the wakeref was already acquired by a different
|
|
* function (i.e., get() has already happened so only a put() is needed).
|
|
*/
|
|
DEFINE_GUARD(xe_pm_runtime_release_only, struct xe_device *,
|
|
__xe_pm_runtime_noop(_T), xe_pm_runtime_put(_T));
|
|
|
|
#endif
|