Documentation/networking/device_drivers/ethernet/marvell/octeon_ep.rst

   1 .. SPDX-License-Identifier: GPL-2.0+
   2
   3 ====================================================================
   4 Linux kernel networking driver for Marvell's Octeon PCI Endpoint NIC
   5 ====================================================================
   6
   7 Network driver for Marvell's Octeon PCI EndPoint NIC.
   8 Copyright (c) 2020 Marvell International Ltd.
   9
  10 Contents
  11 ========
  12
  13 - `Overview`_
  14 - `Supported Devices`_
  15 - `Interface Control`_
  16
  17 Overview
  18 ========
  19 This driver implements networking functionality of Marvell's Octeon PCI
  20 EndPoint NIC.
  21
  22 Supported Devices
  23 =================
  24 Currently, this driver support following devices:
  25  * Network controller: Cavium, Inc. Device b200
  26  * Network controller: Cavium, Inc. Device b400
  27
  28 Interface Control
  29 =================
  30 Network Interface control like changing mtu, link speed, link down/up are
  31 done by writing command to mailbox command queue, a mailbox interface
  32 implemented through a reserved region in BAR4.
  33 This driver writes the commands into the mailbox and the firmware on the
  34 Octeon device processes them. The firmware also sends unsolicited notifications
  35 to driver for events suchs as link change, through notification queue
  36 implemented as part of mailbox interface.