Re: [PATCH net-next 2/7] net: aquantia: add documentation for the atlantic driver

[Andrew Lunn <andrew@lunn.ch>]

> +  Jumbo Frames
> +  ------------
> +  The driver supports Jumbo Frames for all adapters. Jumbo Frames support is
> +  enabled by changing the MTU to a value larger than the default of 1500.
> +  The maximum value for the MTU is 16000.  Use the ifconfig command to
> +  increase the MTU size.  For example:
> +
> +        ifconfig <ethX> mtu 16000 up

ifconfig has been deprecated for many years. Please document the
iproute2 command.

> + Viewing adapter information
> + ---------------------
> + ethtool -i <ethX>
> +
> + Output example:
> + driver: atlantic
> + version: 1.6.9.0
> + firmware-version: 1.5.49
> + expansion-rom-version:
> + bus-info: 0000:01:00.0
> + supports-statistics: yes
> + supports-test: no
> + supports-eeprom-access: no
> + supports-register-dump: yes
> + supports-priv-flags: no

Shouldn't there be 5.2-rc5 in here somewhere, given the first patch in
this series?

> +
> + Disable GRO when routing/bridging
> + ---------------------------------
> + Due to a known kernel issue, GRO must be turned off when routing/bridging.
> + It can be done with command:

Is this a kernel issue, or a driver issue? 

> + Interrupt coalescing support
> + ---------------------------------
> + ITR mode, TX/RX coalescing timings could be viewed with:
> +
> + ethtool -c <ethX>
> +
> + and changed with:
> +
> + ethtool -C <ethX> tx-usecs <usecs> rx-usecs <usecs>
> +
> + To disable coalescing:
> +
> + ethtool -C <ethX> tx-usecs 0 rx-usecs 0 tx-max-frames 1 tx-max-frames 1

Please put these before the module parameters. We should discourage
the use of module parameters. Using ethtool is the correct way to do
this.

> +License
> +=======
> +
> +aQuantia Corporation Network Driver
> +Copyright(c) 2014 - 2019 aQuantia Corporation.
> +
> +This program is free software; you can redistribute it and/or modify it
> +under the terms and conditions of the GNU General Public License,
> +version 2, as published by the Free Software Foundation.

grep SPDX drivers/net/ethernet/aquantia/atlantic/*.c
drivers/net/ethernet/aquantia/atlantic/aq_drvinfo.c:// SPDX-License-Identifier: GPL-2.0-or-later
drivers/net/ethernet/aquantia/atlantic/aq_ethtool.c:// SPDX-License-Identifier: GPL-2.0-only
drivers/net/ethernet/aquantia/atlantic/aq_filters.c:// SPDX-License-Identifier: GPL-2.0-or-later
drivers/net/ethernet/aquantia/atlantic/aq_hw_utils.c:// SPDX-License-Identifier: GPL-2.0-only
drivers/net/ethernet/aquantia/atlantic/aq_main.c:// SPDX-License-Identifier: GPL-2.0-only
drivers/net/ethernet/aquantia/atlantic/aq_nic.c:// SPDX-License-Identifier: GPL-2.0-only
drivers/net/ethernet/aquantia/atlantic/aq_pci_func.c:// SPDX-License-Identifier: GPL-2.0-only
drivers/net/ethernet/aquantia/atlantic/aq_ring.c:// SPDX-License-Identifier: GPL-2.0-only
drivers/net/ethernet/aquantia/atlantic/aq_vec.c:// SPDX-License-Identifier: GPL-2.0-only

You have a mix of 2 and 2+.

    Andrew