drivers/crypto/cavium/nitrox/nitrox_main.c

File Facts

System

Linux kernel

Corpus path

drivers/crypto/cavium/nitrox/nitrox_main.c

Extension

.c

Size

13659 bytes

Lines

583

Domain

Driver Families

Bucket

drivers/crypto

Inferred role

Driver Families: operation-table or driver-model contract

Status

pattern implementation candidate

Why This File Exists

Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.

• Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
• Defines an operation table; this is where Linux turns generic core objects into subsystem-specific behavior.
• Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
• Allocates kernel memory; connect allocation flags and lifetime to context constraints.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• linux/delay.h
• linux/firmware.h
• linux/list.h
• linux/module.h
• linux/mutex.h
• linux/pci.h
• linux/pci_ids.h
• nitrox_dev.h
• nitrox_common.h
• nitrox_csr.h
• nitrox_hal.h
• nitrox_isr.h
• nitrox_debugfs.h

Detected Declarations

• struct ucode
• function write_to_ucd_unit
• function nitrox_load_fw
• function nitrox_add_to_devlist
• function nitrox_remove_from_devlist
• function nitrox_put_device
• function nitrox_device_flr
• function nitrox_pf_sw_init
• function nitrox_pf_sw_cleanup
• function nitrox_bist_check
• function nitrox_pf_hw_init
• function nitrox_probe
• function nitrox_remove
• function nitrox_shutdown

Annotated Snippet

static struct pci_driver nitrox_driver = {
	.name = nitrox_driver_name,
	.id_table = nitrox_pci_tbl,
	.probe = nitrox_probe,
	.remove	= nitrox_remove,
	.shutdown = nitrox_shutdown,
	.sriov_configure = nitrox_sriov_configure,
};

module_pci_driver(nitrox_driver);

MODULE_AUTHOR("Srikanth Jampala <Jampala.Srikanth@cavium.com>");
MODULE_DESCRIPTION("Cavium CNN55XX PF Driver" DRIVER_VERSION " ");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRIVER_VERSION);
MODULE_FIRMWARE(SE_FW);

Annotation

• Immediate include surface: `linux/delay.h`, `linux/firmware.h`, `linux/list.h`, `linux/module.h`, `linux/mutex.h`, `linux/pci.h`, `linux/pci_ids.h`, `nitrox_dev.h`.
• Detected declarations: `struct ucode`, `function write_to_ucd_unit`, `function nitrox_load_fw`, `function nitrox_add_to_devlist`, `function nitrox_remove_from_devlist`, `function nitrox_put_device`, `function nitrox_device_flr`, `function nitrox_pf_sw_init`, `function nitrox_pf_sw_cleanup`, `function nitrox_bist_check`.
• Atlas domain: Driver Families / drivers/crypto.
• Implementation status: pattern implementation candidate.
• Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.

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.