drivers/net/ethernet/mellanox/mlx5/core/lib/mlx5.h

File Facts

System

Linux kernel

Corpus path

drivers/net/ethernet/mellanox/mlx5/core/lib/mlx5.h

Extension

.h

Size

2848 bytes

Lines

78

Domain

Driver Families

Bucket

drivers/net

Inferred role

Driver Families: implementation source

Status

source 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.
• Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• mlx5_core.h

Detected Declarations

• struct mlx5_sd
• function mlx5_uplink_netdev_put
• function mlx5_set_sd

Annotated Snippet

#ifndef __LIB_MLX5_H__
#define __LIB_MLX5_H__

#include "mlx5_core.h"

void mlx5_init_reserved_gids(struct mlx5_core_dev *dev);
void mlx5_cleanup_reserved_gids(struct mlx5_core_dev *dev);
int  mlx5_core_reserve_gids(struct mlx5_core_dev *dev, unsigned int count);
void mlx5_core_unreserve_gids(struct mlx5_core_dev *dev, unsigned int count);
int  mlx5_core_reserved_gid_alloc(struct mlx5_core_dev *dev, int *gid_index);
void mlx5_core_reserved_gid_free(struct mlx5_core_dev *dev, int gid_index);
int mlx5_crdump_enable(struct mlx5_core_dev *dev);
void mlx5_crdump_disable(struct mlx5_core_dev *dev);
int mlx5_crdump_collect(struct mlx5_core_dev *dev, u32 *cr_data);

static inline struct net_device *mlx5_uplink_netdev_get(struct mlx5_core_dev *mdev)
{
	struct mlx5e_resources *mlx5e_res = &mdev->mlx5e_res;
	struct net_device *netdev;

	mutex_lock(&mlx5e_res->uplink_netdev_lock);
	netdev = mlx5e_res->uplink_netdev;
	netdev_hold(netdev, &mlx5e_res->tracker, GFP_KERNEL);
	mutex_unlock(&mlx5e_res->uplink_netdev_lock);
	return netdev;
}

static inline void mlx5_uplink_netdev_put(struct mlx5_core_dev *mdev,
					  struct net_device *netdev)
{
	netdev_put(netdev, &mdev->mlx5e_res.tracker);
}

struct mlx5_sd;

static inline struct mlx5_sd *mlx5_get_sd(struct mlx5_core_dev *dev)
{
	return dev->sd;
}

static inline void mlx5_set_sd(struct mlx5_core_dev *dev, struct mlx5_sd *sd)
{
	dev->sd = sd;
}
#endif

Annotation

• Immediate include surface: `mlx5_core.h`.
• Detected declarations: `struct mlx5_sd`, `function mlx5_uplink_netdev_put`, `function mlx5_set_sd`.
• Atlas domain: Driver Families / drivers/net.
• Implementation status: source 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.