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