include/linux/pwrseq/consumer.h

File Facts

System

Linux kernel

Corpus path

include/linux/pwrseq/consumer.h

Extension

.h

Size

1348 bytes

Lines

64

Domain

Core OS

Bucket

Core Kernel Interface

Inferred role

Core OS: implementation source

Status

source implementation candidate

Why This File Exists

Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.

• Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• linux/err.h

Detected Declarations

• struct device
• struct pwrseq_desc
• function pwrseq_get
• function pwrseq_put
• function pwrseq_power_on
• function pwrseq_power_off

Annotated Snippet

#ifndef __POWER_SEQUENCING_CONSUMER_H__
#define __POWER_SEQUENCING_CONSUMER_H__

#include <linux/err.h>

struct device;
struct pwrseq_desc;

#if IS_ENABLED(CONFIG_POWER_SEQUENCING)

struct pwrseq_desc * __must_check
pwrseq_get(struct device *dev, const char *target);
void pwrseq_put(struct pwrseq_desc *desc);

struct pwrseq_desc * __must_check
devm_pwrseq_get(struct device *dev, const char *target);

int pwrseq_power_on(struct pwrseq_desc *desc);
int pwrseq_power_off(struct pwrseq_desc *desc);

struct device *pwrseq_to_device(struct pwrseq_desc *desc);

#else /* CONFIG_POWER_SEQUENCING */

static inline struct pwrseq_desc * __must_check
pwrseq_get(struct device *dev, const char *target)
{
	return ERR_PTR(-ENOSYS);
}

static inline void pwrseq_put(struct pwrseq_desc *desc)
{
}

static inline struct pwrseq_desc * __must_check
devm_pwrseq_get(struct device *dev, const char *target)
{
	return ERR_PTR(-ENOSYS);
}

static inline int pwrseq_power_on(struct pwrseq_desc *desc)
{
	return -ENOSYS;
}

static inline int pwrseq_power_off(struct pwrseq_desc *desc)
{
	return -ENOSYS;
}

static inline struct device *pwrseq_to_device(struct pwrseq_desc *desc)
{
	return NULL;
}

#endif /* CONFIG_POWER_SEQUENCING */

#endif /* __POWER_SEQUENCING_CONSUMER_H__ */

Annotation

• Immediate include surface: `linux/err.h`.
• Detected declarations: `struct device`, `struct pwrseq_desc`, `function pwrseq_get`, `function pwrseq_put`, `function pwrseq_power_on`, `function pwrseq_power_off`.
• Atlas domain: Core OS / Core Kernel Interface.
• Implementation status: source implementation candidate.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.