.. SPDX-License-Identifier: GPL-2.0
.. NOTE: This document was auto-generated.


=======================================
Family ``netdev`` netlink specification
=======================================


.. contents::


-------
Summary
-------


netdev configuration over generic netlink.

----------
Operations
----------



dev-get
=======
Get / dump information about a netdev.

:attribute-set: dev
:do:
    **request**
        :attributes: [``ifindex``]

    **reply**
        :attributes: [``ifindex``, ``xdp-features``, ``xdp-zc-max-segs``, ``xdp-rx-metadata-features``]

:dump:
    **reply**
        :attributes: [``ifindex``, ``xdp-features``, ``xdp-zc-max-segs``, ``xdp-rx-metadata-features``]




dev-add-ntf
===========
Notification about device appearing.

:notify: dev-get
:mcgrp: mgmt



dev-del-ntf
===========
Notification about device disappearing.

:notify: dev-get
:mcgrp: mgmt



dev-change-ntf
==============
Notification about device configuration being changed.

:notify: dev-get
:mcgrp: mgmt



----------------
Multicast groups
----------------


- mgmt

-----------
Definitions
-----------



xdp-act
=======
:type: flags


:entries:
    :basic: XDP features set supported by all drivers (XDP_ABORTED, XDP_DROP, XDP_PASS, XDP_TX)
    :redirect: The netdev supports XDP_REDIRECT
    :ndo-xmit: This feature informs if netdev implements ndo_xdp_xmit callback.
    :xsk-zerocopy: This feature informs if netdev supports AF_XDP in zero copy mode.
    :hw-offload: This feature informs if netdev supports XDP hw offloading.
    :rx-sg: This feature informs if netdev implements non-linear XDP buffer support in the driver napi callback.
    :ndo-xmit-sg: This feature informs if netdev implements non-linear XDP buffer support in ndo_xdp_xmit callback.



xdp-rx-metadata
===============
:type: flags


:entries:
    :timestamp: Device is capable of exposing receive HW timestamp via bpf_xdp_metadata_rx_timestamp().
    :hash: Device is capable of exposing receive packet hash via bpf_xdp_metadata_rx_hash().



--------------
Attribute sets
--------------



dev
===
ifindex (``u32``)
~~~~~~~~~~~~~~~~~
:doc: netdev ifindex


pad (``pad``)
~~~~~~~~~~~~~


xdp-features (``u64``)
~~~~~~~~~~~~~~~~~~~~~~
:doc: Bitmask of enabled xdp-features.
:enum: xdp-act


xdp-zc-max-segs (``u32``)
~~~~~~~~~~~~~~~~~~~~~~~~~
:doc: max fragment count supported by ZC driver


xdp-rx-metadata-features (``u64``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:doc: Bitmask of supported XDP receive metadata features. See Documentation/networking/xdp-rx-metadata.rst for more details.
:enum: xdp-rx-metadata

