Documentation/driver-api/w1.rst

File Facts

System

Linux kernel

Corpus path

Documentation/driver-api/w1.rst

Extension

.rst

Size

1118 bytes

Lines

68

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.

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

======================
W1: Dallas' 1-wire bus
======================

:Author: David Fries

W1 API internal to the kernel
=============================

include/linux/w1.h
~~~~~~~~~~~~~~~~~~

W1 kernel API functions.

.. kernel-doc:: include/linux/w1.h
   :internal:

drivers/w1/w1.c
~~~~~~~~~~~~~~~

W1 core functions.

.. kernel-doc:: drivers/w1/w1.c
   :internal:

drivers/w1/w1_family.c
~~~~~~~~~~~~~~~~~~~~~~~

Allows registering device family operations.

.. kernel-doc:: drivers/w1/w1_family.c
   :export:

drivers/w1/w1_internal.h
~~~~~~~~~~~~~~~~~~~~~~~~

W1 internal initialization for master devices.

.. kernel-doc:: drivers/w1/w1_internal.h
   :internal:

drivers/w1/w1_int.c
~~~~~~~~~~~~~~~~~~~~

W1 internal initialization for master devices.

.. kernel-doc:: drivers/w1/w1_int.c
   :export:

drivers/w1/w1_netlink.h
~~~~~~~~~~~~~~~~~~~~~~~~

W1 external netlink API structures and commands.

.. kernel-doc:: drivers/w1/w1_netlink.h
   :internal:

drivers/w1/w1_io.c
~~~~~~~~~~~~~~~~~~~

W1 input/output.

.. kernel-doc:: drivers/w1/w1_io.c
   :export:

.. kernel-doc:: drivers/w1/w1_io.c
   :internal:

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.