Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 893ce44d authored by Catherine Sullivan's avatar Catherine Sullivan Committed by David S. Miller
Browse files

gve: Add basic driver framework for Compute Engine Virtual NIC 



Add a driver framework for the Compute Engine Virtual NIC that will be
available in the future.

At this point the only functionality is loading the driver.

Signed-off-by: default avatarCatherine Sullivan <csully@google.com>
Signed-off-by: default avatarSagi Shahar <sagis@google.com>
Signed-off-by: default avatarJon Olson <jonolson@google.com>
Acked-by: default avatarWillem de Bruijn <willemb@google.com>
Reviewed-by: default avatarLuigi Rizzo <lrizzo@google.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 2a8d8e0f

Documentation/networking/device_drivers/google/gve.rst

0 → 100644
+82 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0+



==============================================================

Linux kernel driver for Compute Engine Virtual Ethernet (gve):

==============================================================



Supported Hardware

===================

The GVE driver binds to a single PCI device id used by the virtual

Ethernet device found in some Compute Engine VMs.



+--------------+----------+---------+

|Field         | Value    | Comments|

+==============+==========+=========+

|Vendor ID     | `0x1AE0` | Google  |

+--------------+----------+---------+

|Device ID     | `0x0042` |         |

+--------------+----------+---------+

|Sub-vendor ID | `0x1AE0` | Google  |

+--------------+----------+---------+

|Sub-device ID | `0x0058` |         |

+--------------+----------+---------+

|Revision ID   | `0x0`    |         |

+--------------+----------+---------+

|Device Class  | `0x200`  | Ethernet|

+--------------+----------+---------+



PCI Bars

========

The gVNIC PCI device exposes three 32-bit memory BARS:

- Bar0 - Device configuration and status registers.

- Bar1 - MSI-X vector table

- Bar2 - IRQ, RX and TX doorbells



Device Interactions

===================

The driver interacts with the device in the following ways:

 - Registers

    - A block of MMIO registers

    - See gve_register.h for more detail

 - Admin Queue

    - See description below

 - Interrupts

    - See supported interrupts below



Registers

---------

All registers are MMIO and big endian.



The registers are used for initializing and configuring the device as well as

querying device status in response to management interrupts.



Admin Queue (AQ)

----------------

The Admin Queue is a PAGE_SIZE memory block, treated as an array of AQ

commands, used by the driver to issue commands to the device and set up

resources.The driver and the device maintain a count of how many commands

have been submitted and executed. To issue AQ commands, the driver must do

the following (with proper locking):



1)  Copy new commands into next available slots in the AQ array

2)  Increment its counter by he number of new commands

3)  Write the counter into the GVE_ADMIN_QUEUE_DOORBELL register

4)  Poll the ADMIN_QUEUE_EVENT_COUNTER register until it equals

    the value written to the doorbell, or until a timeout.



The device will update the status field in each AQ command reported as

executed through the ADMIN_QUEUE_EVENT_COUNTER register.



Interrupts

----------

The following interrupts are supported by the driver:



Management Interrupt

~~~~~~~~~~~~~~~~~~~~

The management interrupt is used by the device to tell the driver to

look at the GVE_DEVICE_STATUS register.



Notification Block Interrupts

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The notification block interrupts are used to tell the driver to poll

the queues associated with that interrupt.

Documentation/networking/device_drivers/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -21,6 +21,7 @@ Contents: 
   intel/i40e

   intel/iavf

   intel/ice

   google/gve

   mellanox/mlx5



.. only::  subproject

MAINTAINERS

+9 −0
Original line number Diff line number Diff line
@@ -6720,6 +6720,15 @@ L: linux-input@vger.kernel.org 
S:	Maintained

F:	drivers/input/touchscreen/goodix.c



GOOGLE ETHERNET DRIVERS

M:	Catherine Sullivan <csully@google.com>

R:	Sagi Shahar <sagis@google.com>

R:	Jon Olson <jonolson@google.com>

L:	netdev@vger.kernel.org

S:	Supported

F:	Documentation/networking/device_drivers/google/gve.txt

F:	drivers/net/ethernet/google



GPD POCKET FAN DRIVER

M:	Hans de Goede <hdegoede@redhat.com>

L:	platform-driver-x86@vger.kernel.org

drivers/net/ethernet/Kconfig

+1 −0
Original line number Diff line number Diff line
@@ -76,6 +76,7 @@ source "drivers/net/ethernet/ezchip/Kconfig" 
source "drivers/net/ethernet/faraday/Kconfig"

source "drivers/net/ethernet/freescale/Kconfig"

source "drivers/net/ethernet/fujitsu/Kconfig"

source "drivers/net/ethernet/google/Kconfig"

source "drivers/net/ethernet/hisilicon/Kconfig"

source "drivers/net/ethernet/hp/Kconfig"

source "drivers/net/ethernet/huawei/Kconfig"

drivers/net/ethernet/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -39,6 +39,7 @@ obj-$(CONFIG_NET_VENDOR_EZCHIP) += ezchip/ 
obj-$(CONFIG_NET_VENDOR_FARADAY) += faraday/

obj-$(CONFIG_NET_VENDOR_FREESCALE) += freescale/

obj-$(CONFIG_NET_VENDOR_FUJITSU) += fujitsu/

obj-$(CONFIG_NET_VENDOR_GOOGLE) += google/

obj-$(CONFIG_NET_VENDOR_HISILICON) += hisilicon/

obj-$(CONFIG_NET_VENDOR_HP) += hp/

obj-$(CONFIG_NET_VENDOR_HUAWEI) += huawei/