Documentation/networking/devlink/devlink-shared.rst

Source file repositories/reference/linux-study-clean/Documentation/networking/devlink/devlink-shared.rst

File Facts

System
Linux kernel
Corpus path
Documentation/networking/devlink/devlink-shared.rst
Extension
.rst
Size
3471 bytes
Lines
98
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.

Dependency Surface

Detected Declarations

Annotated Snippet

.. SPDX-License-Identifier: GPL-2.0

========================
Devlink Shared Instances
========================

Overview
========

Shared devlink instances allow multiple physical functions (PFs) on the same
chip to share a devlink instance for chip-wide operations.

Multiple PFs may reside on the same physical chip, running a single firmware.
Some of the resources and configurations may be shared among these PFs. The
shared devlink instance provides an object to pin configuration knobs on.

There are two possible usage models:

1. The shared devlink instance is used alongside individual PF devlink
   instances, providing chip-wide configuration in addition to per-PF
   configuration.
2. The shared devlink instance is the only devlink instance, without
   per-PF instances.

It is up to the driver to decide which usage model to use.

The shared devlink instance is not backed by any struct *device*.

Implementation
==============

Architecture
------------

The implementation uses:

* **Chip identification**: PFs are grouped by chip using a driver-specific identifier
* **Shared instance management**: Global list of shared instances with reference counting

API Functions
-------------

The following functions are provided for managing shared devlink instances:

* ``devlink_shd_get()``: Get or create a shared devlink instance identified by a string ID
* ``devlink_shd_put()``: Release a reference on a shared devlink instance
* ``devlink_shd_get_priv()``: Get private data from shared devlink instance

Initialization Flow
-------------------

1. **PF calls shared devlink init** during driver probe
2. **Chip identification** using driver-specific method to determine device identity
3. **Get or create shared instance** using ``devlink_shd_get()``:

   * The function looks up existing instance by identifier
   * If none exists, creates new instance:
     - Allocates and registers devlink instance
     - Adds to global shared instances list
     - Increments reference count

4. **Set nested devlink instance** for the PF devlink instance using
   ``devl_nested_devlink_set()`` before registering the PF devlink instance

Cleanup Flow
------------

1. **Cleanup** when PF is removed
2. **Call** ``devlink_shd_put()`` to release reference (decrements reference count)
3. **Shared instance is automatically destroyed** when the last PF removes (reference count reaches zero)

Annotation

Implementation Notes