Documentation/driver-api/men-chameleon-bus.rst

Source file repositories/reference/linux-study-clean/Documentation/driver-api/men-chameleon-bus.rst

File Facts

System: Linux kernel
Corpus path: Documentation/driver-api/men-chameleon-bus.rst
Extension: .rst
Size: 6226 bytes
Lines: 188
Domain: Support Tooling And Documentation
Bucket: Documentation
Inferred role: Support Tooling And Documentation: exported/initcall integration point
Status: integration implementation candidate

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.
Exports symbols or registers init work; inspect boot/module ordering and who consumes the exported contract.
Touches IRQ or DMA behavior; this matters for the representative real-device path.
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

function foo_init
function foo_exit
module init foo_init

Annotated Snippet

module_init(foo_init);

	static void __exit foo_exit(void)
	{
		mcb_unregister_driver(&foo_driver);
	}
	module_exit(foo_exit);

The module_mcb_driver() macro can be used to reduce the above code::

	module_mcb_driver(foo_driver);

Using DMA
---------

To make use of the kernel's DMA-API's function, you will need to use the
carrier device's 'struct device'. Fortunately 'struct mcb_device' embeds a
pointer (->dma_dev) to the carrier's device for DMA purposes::

        ret = dma_set_mask_and_coherent(&mdev->dma_dev, DMA_BIT_MASK(dma_bits));
        if (rc)
                /* Handle errors */

Annotation

Detected declarations: `function foo_init`, `function foo_exit`, `module init foo_init`.
Atlas domain: Support Tooling And Documentation / Documentation.
Implementation status: integration implementation candidate.
IRQ or DMA behavior appears here, which is relevant to the selected PCIe/NVMe device path.

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.