Documentation/power/regulator/regulator.rst

File Facts

System

Linux kernel

Corpus path

Documentation/power/regulator/regulator.rst

Extension

.rst

Size

868 bytes

Lines

33

Domain

Support Tooling And Documentation

Bucket

Documentation

Inferred role

Support Tooling And Documentation: documentation

Status

atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

• Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• No C-style include directives detected by the generator.

Detected Declarations

• No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

==========================
Regulator Driver Interface
==========================

The regulator driver interface is relatively simple and designed to allow
regulator drivers to register their services with the core framework.


Registration
============

Drivers can register a regulator by calling::

  struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
					   const struct regulator_config *config);

This will register the regulator's capabilities and operations to the regulator
core.

Regulators can be unregistered by calling::

  void regulator_unregister(struct regulator_dev *rdev);


Regulator Events
================

Regulators can send events (e.g. overtemperature, undervoltage, etc) to
consumer drivers by calling::

  int regulator_notifier_call_chain(struct regulator_dev *rdev,
				    unsigned long event, void *data);

Annotation

• Atlas domain: Support Tooling And Documentation / Documentation.
• Implementation status: atlas-only.

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.