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 b200
26 * Network controller: Cavium, Inc. Device b400
27
28Interface Control
29=================
30Network Interface control like changing mtu, link speed, link down/up are
31done by writing command to mailbox command queue, a mailbox interface
32implemented through a reserved region in BAR4.
33This driver writes the commands into the mailbox and the firmware on the
34Octeon device processes them. The firmware also sends unsolicited notifications
35to driver for events suchs as link change, through notification queue
36implemented as part of mailbox interface.
37