Page MenuHomeFreeBSD
Files F147424464

D27800.id81264.diff
No OneTemporary
Actions

D27800.id81264.diff
View Options

Index: share/man/man4/axp.4
===================================================================
--- /dev/null
+++ share/man/man4/axp.4
@@ -0,0 +1,219 @@
+.\" Copyright (c) 2020, Advanced Micro Devices Inc.,
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright notice,
+.\" this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" 3. Neither the name of Advanced Micro Devices Inc., nor the names of its
+.\" contributors may be used to endorse or promote products derived from
+.\" this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.\" * Other names and brands may be claimed as the property of others.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd October 27, 2020
+.Dt AXP 4
+.Os
+.Sh NAME
+.Nm axp
+.Nd "Advanced Micro Devices 10Gigabit Ethernet driver"
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device iflib"
+.Cd "device axp"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+if_axp_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver enables the PCI-E based 10Gigabit Ethernet controller inbuilt in the
+AMD EPYC Processors.
+.Pp
+The following features are supported,
+.Pp
+.Bl -bullet -compact
+.It
+1G/10G SFP+ Link
+.It
+Jumbo frames (9000 Bytes)
+.It
+Transmit and Receive checksum offload
+.It
+TCP segmentation offload (TSO)
+.It
+VLAN tag insertion/extraction
+.It
+VLAN checksum offload
+.It
+VLAN TSO
+.It
+Receive side steering (RSS)
+.It
+IPV4 and IPV6 capable
+.It
+MSI-X interrupts
+.It
+Split header
+.El
+.Pp
+All the above mentioned features are enabled by default.
+.Pp
+For hardware related questions, please refer the documentation supplied
+along with the AMD EPYC Processors.
+.Sh SYSCTL VARIABLES
+The following variables are available as
+.Xr sysctl 8
+variables
+.Bl -tag -width indent
+.It Va dev.ax.X.mac_stats
+Dumps the transmit and receive statistics counter values for the controller.
+This includes statistics specific to each transmit and receive queues.
+.It Va dev.ax.X.channels_info
+Dumps the permissible and default configured transmit and receive channel
+information
+.It Va dev.ax.X.ringparam_info
+Dumps the permissible and default configured descriptor information for the
+transmit and receive queues.
+.It Va dev.ax.X.link_ksettings_info
+Dumps the current link setting like link mode, speed, duplex settings.
+.It Va dev.ax.X.pauseparam_info
+Dumps the current flow-control settings.
+.It Va dev.ax.X.coalesce_info
+Dumps the current interrupt coalescing settings.
+.It Va dev.ax.X.link_info
+Dumps the current state of the Link.
+.It Va dev.ax.X.drv_info
+Dumps the driver and controller firmware version information.
+.It Va dev.ax.X.YYYY_register
+.It Va dev.ax.X.YYYY_register_values
+Sysctl to dump a specific register from a specific block of the controller.
+YYYY specifies the block. The following blocks are supported
+.Bl -bullet -compact
+.It
+xpcs
+.It
+xgmac
+.It
+xprop
+.It
+xi2c
+.El
+.Pp
+Set the offset of the register to the first variable, and then read the value
+of the register by reading the second variable.
+.It Va dev.ax.X.axgbe_debug_level
+Configure the log-level for the driver. Default is 0. Supports 0-3.
+.It Va dev.ax.X.netmap_test
+This variable must be set before loading the driver, either via
+.Xr loader.conf 5
+or through the use of
+.Xr kenv 1 .
+This can't be modified when driver is loaded.
+
+Setting this variable in
+.Xr loader.conf 5
+needs the system to be restarted to take effect. When using
+.Xr kenv 1 ,
+use the wrapper variable
+.Va dev.ax.netmap_test\&,
+which will configure all
+.Xr axp 4
+interfaces for netmap testing.
+
+This variable is to configure the interface for netmap testing. Basically,
+this will control the software behavior of how the receive descriptors are used.
+
+Setting this variable to 1, will use 1 Freelist per receive queue.
+
+Setting this variable to 0, will use 2 Freelist per receive queue.
+
+Based on the setting, the receive buffers are programmed accordingly on the
+received descriptors.
+
+By default, this variable will be set to 0, meaning the interfaces will be
+configured for regular data traffic (not netmap traffic).
+.It Va dev.ax.X.sph_enabled
+This variable must be set before loading the driver, either via
+.Xr loader.conf 5
+or through the use of
+.Xr kenv 1 .
+This can't be modified when driver is loaded.
+
+Setting this variable in
+.Xr loader.conf 5
+needs the system to be restarted to take effect. When using
+.Xr kenv 1 ,
+use the wrapper variable
+.Va dev.ax.sph_enable\&,
+which will configure(enable/disable) split header support in all
+.Xr axp 4
+interfaces.
+
+This variable is to control enable/disable of the split header feature in
+the interface.
+
+Setting this variable to 1, will enable split header feature.
+
+Setting this variable to 0, will disable split header feature.
+
+By default, this variable will be set to 1, meaning the Split header support be
+enabled.
+
+NOTE: It is recommended to use this variable only when
+.Va netmap_test\&
+is configured. Otherwise let it be default value.
+.Pp
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr iflib 4 ,
+.Xr netmap 4,
+.Xr vlan 4 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 13.0.
+.Pp
+Another version of the driver is already present in FreeBSD. This driver was
+named as "axgbe" earlier, which is renamed as "axa" now. This driver is for the
+ACPI based Ethernet controllers in the previous/older version of the hardware.
+This driver is authored by
+.Aq Mt andrew@FreeBSD.org
+.Sh AUTHORS
+The
+.Nm
+device driver was written by
+.An Advanced Micro Devices Inc.,.
+.Pp
+For any issues and support requirements, email the details to
+.Aq Mt rajesh1.kumar@amd.com .

File Metadata

Mime Type
text/plain
Expires
Wed, Mar 11, 9:18 PM (10 h, 1 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
29551605
Default Alt Text
D27800.id81264.diff (6 KB)

Event Timeline