include/linux/stmmac.h
Source file repositories/reference/linux-study-clean/include/linux/stmmac.h
File Facts
- System
- Linux kernel
- Corpus path
include/linux/stmmac.h- Extension
.h- Size
- 11365 bytes
- Lines
- 363
- 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.
- 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
linux/platform_device.hlinux/phylink.h
Detected Declarations
struct clkstruct stmmac_privstruct stmmac_mdio_bus_datastruct stmmac_dma_cfgstruct stmmac_axistruct stmmac_rxq_cfgstruct stmmac_txq_cfgstruct stmmac_safety_feature_cfgstruct dwmac4_addrsstruct mac_device_infostruct plat_stmmacenet_dataenum dwmac_core_type
Annotated Snippet
struct stmmac_mdio_bus_data {
u32 phy_mask;
u32 pcs_mask;
int *irqs;
int probed_phy_irq;
bool needs_reset;
};
struct stmmac_dma_cfg {
/* pbl: programmable burst limit
* txpbl: transmit programmable burst limit
* rxpbl: receive programmable burst limit
* If txpbl or rxpbl are zero, the value of pbl will be substituted.
* Range 0 - 63.
*/
int pbl;
int txpbl;
int rxpbl;
/* pblx8: multiplies pbl, txpbl, rxpbl by a factor of 8 for dwmac >=
* 3.50a, or a factor of 4 for previous versions.
*/
bool pblx8;
/* fixed_burst:
* when set, AXI bursts defined by axi_blen_regval are permitted.
* AHB uses SINGLE, INCR4, INCR8 or INCR16 during burst transfers.
* when clear, AXI and AHB use SINGLE or INCR bursts.
*/
bool fixed_burst;
/* mixed_burst:
* when set and fixed_burst is clear, AHB uses INCR for bursts > 16
* and SINGLE or INCRx for bursts <= 16.
*/
bool mixed_burst;
/* aal: address aligned bursts for AHB and AXI master interface */
bool aal;
bool dche;
bool eame;
/* multi_msi_en: stmmac core internal */
bool multi_msi_en;
/* atds: stmmac core internal */
bool atds;
};
#define AXI_BLEN 7
struct stmmac_axi {
u32 axi_wr_osr_lmt;
u32 axi_rd_osr_lmt;
u32 axi_blen_regval;
bool axi_lpi_en;
bool axi_xit_frm;
bool axi_fb;
};
struct stmmac_rxq_cfg {
u32 chan;
u32 prio;
u8 mode_to_use;
u8 pkt_route;
bool use_prio;
};
struct stmmac_txq_cfg {
u32 weight;
/* Credit Base Shaper parameters */
u32 send_slope;
u32 idle_slope;
u32 high_credit;
u32 low_credit;
u32 prio;
int tbs_en;
bool use_prio;
bool coe_unsupported;
u8 mode_to_use;
};
struct stmmac_safety_feature_cfg {
u32 tsoee;
u32 mrxpee;
u32 mestee;
u32 mrxee;
u32 mtxee;
u32 epsi;
u32 edpp;
u32 prtyen;
u32 tmouten;
};
/* Addresses that may be customized by a platform */
struct dwmac4_addrs {
u32 dma_chan;
Annotation
- Immediate include surface: `linux/platform_device.h`, `linux/phylink.h`.
- Detected declarations: `struct clk`, `struct stmmac_priv`, `struct stmmac_mdio_bus_data`, `struct stmmac_dma_cfg`, `struct stmmac_axi`, `struct stmmac_rxq_cfg`, `struct stmmac_txq_cfg`, `struct stmmac_safety_feature_cfg`, `struct dwmac4_addrs`, `struct mac_device_info`.
- Atlas domain: Core OS / Core Kernel Interface.
- Implementation status: source 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.