History

Merge branches 'pm-core' and 'pm-runtime'

Merge runtime PM framework updates and a core power management code fix for 6.18-rc1: - Make pm_runtime_put*() family of functions return 1 when the given device is already suspended which is consistent with the documentation (Brian Norris) - Add basic kunit tests for runtime PM API contracts and update return values in kerneldoc coments for the runtime PM API (Brian Norris, Dan Carpenter) - Add auto-cleanup macros for runtime PM "resume and get" and "get without resume" operations, use one of them in the PCI core and drop the existing "free" macro introduced for similar purpose, but somewhat cumbersome to use (Rafael Wysocki) - Make the core power management code avoid waiting on device links marked as SYNC_STATE_ONLY which is consistent with the handling of those device links elsewhere (Pin-yen Lin) * pm-core: PM: sleep: Do not wait on SYNC_STATE_ONLY device links * pm-runtime: PM: runtime: Fix error checking for kunit_device_register() PM: runtime: Introduce one more usage counter guard PM: runtime: Drop DEFINE_FREE() for pm_runtime_put() PCI/sysfs: Use runtime PM guard macro for auto-cleanup PM: runtime: Add auto-cleanup macros for "resume and get" operations PM: runtime: Update kerneldoc return codes PM: runtime: Make put{,_sync}() return 1 when already suspended PM: runtime: Add basic kunit tests for API contracts

Rafael J. Wysocki committed 1 year ago

Commit 05f084d3 parents 9910531 632d310 92158fa9 files · +343 −41Browse files

Showing the changes to include/linux (1 of 9 files). Show all

Unified · Split

include/linux/pm_runtime.h+69−36
@@ -21,6 +21,7 @@ · 20 unmodified lines
2121 #define RPM_GET_PUT 0x04 /* Increment/decrement the
2222 usage_count */
2323 #define RPM_AUTO 0x08 /* Use autosuspend_delay */
24+#define RPM_TRANSPARENT 0x10 /* Succeed if runtime PM is disabled */
2425
2526 /*
2627 * Use this for defining a set of PM operations to be used in all situations
@@ -350,13 +351,12 @@ static inline int pm_runtime_force_resume(struct device *dev) { return -ENXIO; } · 323 unmodified lines
350351 * * 0: Success.
351352 * * -EINVAL: Runtime PM error.
352353 * * -EACCES: Runtime PM disabled.
353− * * -EAGAIN: Runtime PM usage_count non-zero, Runtime PM status change ongoing
354− * or device not in %RPM_ACTIVE state.
354+ * * -EAGAIN: Runtime PM usage counter non-zero, Runtime PM status change
355+ * ongoing or device not in %RPM_ACTIVE state.
355356 * * -EBUSY: Runtime PM child_count non-zero.
356357 * * -EPERM: Device PM QoS resume latency 0.
357358 * * -EINPROGRESS: Suspend already in progress.
358359 * * -ENOSYS: CONFIG_PM not enabled.
359− * * 1: Device already suspended.
360360 * Other values and conditions for the above values are possible as returned by
361361 * Runtime PM idle and suspend callbacks.
362362 */
@@ -370,14 +370,15 @@ static inline int pm_runtime_idle(struct device *dev) · 7 unmodified lines
370370 * @dev: Target device.
371371 *
372372 * Return:
373+ * * 1: Success; device was already suspended.
373374 * * 0: Success.
374375 * * -EINVAL: Runtime PM error.
375376 * * -EACCES: Runtime PM disabled.
376− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
377+ * * -EAGAIN: Runtime PM usage counter non-zero or Runtime PM status change
378+ * ongoing.
377379 * * -EBUSY: Runtime PM child_count non-zero.
378380 * * -EPERM: Device PM QoS resume latency 0.
379381 * * -ENOSYS: CONFIG_PM not enabled.
380− * * 1: Device already suspended.
381382 * Other values and conditions for the above values are possible as returned by
382383 * Runtime PM suspend callbacks.
383384 */
@@ -396,14 +397,15 @@ static inline int pm_runtime_suspend(struct device *dev) · 12 unmodified lines
396397 * engaging its "idle check" callback.
397398 *
398399 * Return:
400+ * * 1: Success; device was already suspended.
399401 * * 0: Success.
400402 * * -EINVAL: Runtime PM error.
401403 * * -EACCES: Runtime PM disabled.
402− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
404+ * * -EAGAIN: Runtime PM usage counter non-zero or Runtime PM status change
405+ * ongoing.
403406 * * -EBUSY: Runtime PM child_count non-zero.
404407 * * -EPERM: Device PM QoS resume latency 0.
405408 * * -ENOSYS: CONFIG_PM not enabled.
406− * * 1: Device already suspended.
407409 * Other values and conditions for the above values are possible as returned by
408410 * Runtime PM suspend callbacks.
409411 */
@@ -433,13 +435,12 @@ static inline int pm_runtime_resume(struct device *dev) · 23 unmodified lines
433435 * * 0: Success.
434436 * * -EINVAL: Runtime PM error.
435437 * * -EACCES: Runtime PM disabled.
436− * * -EAGAIN: Runtime PM usage_count non-zero, Runtime PM status change ongoing
437− * or device not in %RPM_ACTIVE state.
438+ * * -EAGAIN: Runtime PM usage counter non-zero, Runtime PM status change
439+ * ongoing or device not in %RPM_ACTIVE state.
438440 * * -EBUSY: Runtime PM child_count non-zero.
439441 * * -EPERM: Device PM QoS resume latency 0.
440442 * * -EINPROGRESS: Suspend already in progress.
441443 * * -ENOSYS: CONFIG_PM not enabled.
442− * * 1: Device already suspended.
443444 */
444445 static inline int pm_request_idle(struct device *dev)
445446 {
@@ -464,15 +465,16 @@ static inline int pm_request_resume(struct device *dev) · 18 unmodified lines
464465 * equivalent pm_runtime_autosuspend() for @dev asynchronously.
465466 *
466467 * Return:
468+ * * 1: Success; device was already suspended.
467469 * * 0: Success.
468470 * * -EINVAL: Runtime PM error.
469471 * * -EACCES: Runtime PM disabled.
470− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
472+ * * -EAGAIN: Runtime PM usage counter non-zero or Runtime PM status change
473+ * ongoing.
471474 * * -EBUSY: Runtime PM child_count non-zero.
472475 * * -EPERM: Device PM QoS resume latency 0.
473476 * * -EINPROGRESS: Suspend already in progress.
474477 * * -ENOSYS: CONFIG_PM not enabled.
475− * * 1: Device already suspended.
476478 */
477479 static inline int pm_request_autosuspend(struct device *dev)
478480 {
@@ -511,6 +513,19 @@ static inline int pm_runtime_get_sync(struct device *dev) · 32 unmodified lines
511513 return __pm_runtime_resume(dev, RPM_GET_PUT);
512514 }
513515
516+static inline int pm_runtime_get_active(struct device *dev, int rpmflags)
517+{
518+ int ret;
519+
520+ ret = __pm_runtime_resume(dev, RPM_GET_PUT | rpmflags);
521+ if (ret < 0) {
522+ pm_runtime_put_noidle(dev);
523+ return ret;
524+ }
525+
526+ return 0;
527+}
528+
514529 /**
515530 * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
516531 * @dev: Target device.
@@ -521,15 +536,7 @@ static inline int pm_runtime_get_sync(struct device *dev) · 4 unmodified lines
521536 */
522537 static inline int pm_runtime_resume_and_get(struct device *dev)
523538 {
524− int ret;
525−
526− ret = __pm_runtime_resume(dev, RPM_GET_PUT);
527− if (ret < 0) {
528− pm_runtime_put_noidle(dev);
529− return ret;
530− }
531−
532− return 0;
539+ return pm_runtime_get_active(dev, 0);
533540 }
534541
535542 /**
@@ -540,23 +547,22 @@ static inline int pm_runtime_resume_and_get(struct device *dev) · 4 unmodified lines
540547 * equal to 0, queue up a work item for @dev like in pm_request_idle().
541548 *
542549 * Return:
550+ * * 1: Success. Usage counter dropped to zero, but device was already suspended.
543551 * * 0: Success.
544552 * * -EINVAL: Runtime PM error.
545553 * * -EACCES: Runtime PM disabled.
546− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
554+ * * -EAGAIN: Runtime PM usage counter became non-zero or Runtime PM status
555+ * change ongoing.
547556 * * -EBUSY: Runtime PM child_count non-zero.
548557 * * -EPERM: Device PM QoS resume latency 0.
549558 * * -EINPROGRESS: Suspend already in progress.
550559 * * -ENOSYS: CONFIG_PM not enabled.
551− * * 1: Device already suspended.
552560 */
553561 static inline int pm_runtime_put(struct device *dev)
554562 {
555563 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
556564 }
557565
558−DEFINE_FREE(pm_runtime_put, struct device *, if (_T) pm_runtime_put(_T))
559−
560566 /**
561567 * __pm_runtime_put_autosuspend - Drop device usage counter and queue autosuspend if 0.
562568 * @dev: Target device.
@@ -565,15 +571,16 @@ DEFINE_FREE(pm_runtime_put, struct device *, if (_T) pm_runtime_put(_T)) · 2 unmodified lines
565571 * equal to 0, queue up a work item for @dev like in pm_request_autosuspend().
566572 *
567573 * Return:
574+ * * 1: Success. Usage counter dropped to zero, but device was already suspended.
568575 * * 0: Success.
569576 * * -EINVAL: Runtime PM error.
570577 * * -EACCES: Runtime PM disabled.
571− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
578+ * * -EAGAIN: Runtime PM usage counter became non-zero or Runtime PM status
579+ * change ongoing.
572580 * * -EBUSY: Runtime PM child_count non-zero.
573581 * * -EPERM: Device PM QoS resume latency 0.
574582 * * -EINPROGRESS: Suspend already in progress.
575583 * * -ENOSYS: CONFIG_PM not enabled.
576− * * 1: Device already suspended.
577584 */
578585 static inline int __pm_runtime_put_autosuspend(struct device *dev)
579586 {
@@ -590,15 +597,16 @@ static inline int __pm_runtime_put_autosuspend(struct device *dev) · 10 unmodified lines
590597 * in pm_request_autosuspend().
591598 *
592599 * Return:
600+ * * 1: Success. Usage counter dropped to zero, but device was already suspended.
593601 * * 0: Success.
594602 * * -EINVAL: Runtime PM error.
595603 * * -EACCES: Runtime PM disabled.
596− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
604+ * * -EAGAIN: Runtime PM usage counter became non-zero or Runtime PM status
605+ * change ongoing.
597606 * * -EBUSY: Runtime PM child_count non-zero.
598607 * * -EPERM: Device PM QoS resume latency 0.
599608 * * -EINPROGRESS: Suspend already in progress.
600609 * * -ENOSYS: CONFIG_PM not enabled.
601− * * 1: Device already suspended.
602610 */
603611 static inline int pm_runtime_put_autosuspend(struct device *dev)
604612 {
@@ -606,6 +614,29 @@ static inline int pm_runtime_put_autosuspend(struct device *dev) · 1 unmodified line
606614 return __pm_runtime_put_autosuspend(dev);
607615 }
608616
617+DEFINE_GUARD(pm_runtime_noresume, struct device *,
618+ pm_runtime_get_noresume(_T), pm_runtime_put_noidle(_T));
619+
620+DEFINE_GUARD(pm_runtime_active, struct device *,
621+ pm_runtime_get_sync(_T), pm_runtime_put(_T));
622+DEFINE_GUARD(pm_runtime_active_auto, struct device *,
623+ pm_runtime_get_sync(_T), pm_runtime_put_autosuspend(_T));
624+/*
625+ * Use the following guards with ACQUIRE()/ACQUIRE_ERR().
626+ *
627+ * The difference between the "_try" and "_try_enabled" variants is that the
628+ * former do not produce an error when runtime PM is disabled for the given
629+ * device.
630+ */
631+DEFINE_GUARD_COND(pm_runtime_active, _try,
632+ pm_runtime_get_active(_T, RPM_TRANSPARENT))
633+DEFINE_GUARD_COND(pm_runtime_active, _try_enabled,
634+ pm_runtime_resume_and_get(_T))
635+DEFINE_GUARD_COND(pm_runtime_active_auto, _try,
636+ pm_runtime_get_active(_T, RPM_TRANSPARENT))
637+DEFINE_GUARD_COND(pm_runtime_active_auto, _try_enabled,
638+ pm_runtime_resume_and_get(_T))
639+
609640 /**
610641 * pm_runtime_put_sync - Drop device usage counter and run "idle check" if 0.
611642 * @dev: Target device.
@@ -619,14 +650,15 @@ static inline int pm_runtime_put_autosuspend(struct device *dev) · 7 unmodified lines
619650 * if it returns an error code.
620651 *
621652 * Return:
653+ * * 1: Success. Usage counter dropped to zero, but device was already suspended.
622654 * * 0: Success.
623655 * * -EINVAL: Runtime PM error.
624656 * * -EACCES: Runtime PM disabled.
625− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
657+ * * -EAGAIN: Runtime PM usage counter became non-zero or Runtime PM status
658+ * change ongoing.
626659 * * -EBUSY: Runtime PM child_count non-zero.
627660 * * -EPERM: Device PM QoS resume latency 0.
628661 * * -ENOSYS: CONFIG_PM not enabled.
629− * * 1: Device already suspended.
630662 * Other values and conditions for the above values are possible as returned by
631663 * Runtime PM suspend callbacks.
632664 */
@@ -646,15 +678,15 @@ static inline int pm_runtime_put_sync(struct device *dev) · 13 unmodified lines
646678 * if it returns an error code.
647679 *
648680 * Return:
681+ * * 1: Success. Usage counter dropped to zero, but device was already suspended.
649682 * * 0: Success.
650683 * * -EINVAL: Runtime PM error.
651684 * * -EACCES: Runtime PM disabled.
652− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
653− * * -EAGAIN: usage_count non-zero or Runtime PM status change ongoing.
685+ * * -EAGAIN: Runtime PM usage counter became non-zero or Runtime PM status
686+ * change ongoing.
654687 * * -EBUSY: Runtime PM child_count non-zero.
655688 * * -EPERM: Device PM QoS resume latency 0.
656689 * * -ENOSYS: CONFIG_PM not enabled.
657− * * 1: Device already suspended.
658690 * Other values and conditions for the above values are possible as returned by
659691 * Runtime PM suspend callbacks.
660692 */
@@ -677,15 +709,16 @@ static inline int pm_runtime_put_sync_suspend(struct device *dev) · 16 unmodified lines
677709 * if it returns an error code.
678710 *
679711 * Return:
712+ * * 1: Success. Usage counter dropped to zero, but device was already suspended.
680713 * * 0: Success.
681714 * * -EINVAL: Runtime PM error.
682715 * * -EACCES: Runtime PM disabled.
683− * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
716+ * * -EAGAIN: Runtime PM usage counter became non-zero or Runtime PM status
717+ * change ongoing.
684718 * * -EBUSY: Runtime PM child_count non-zero.
685719 * * -EPERM: Device PM QoS resume latency 0.
686720 * * -EINPROGRESS: Suspend already in progress.
687721 * * -ENOSYS: CONFIG_PM not enabled.
688− * * 1: Device already suspended.
689722 * Other values and conditions for the above values are possible as returned by
690723 * Runtime PM suspend callbacks.
691724 */

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t