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