Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/axp.4
Show All 23 Lines | |||||||||||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||||||||||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||||||||||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | .\" 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 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||||||||||||
.\" POSSIBILITY OF SUCH DAMAGE. | .\" POSSIBILITY OF SUCH DAMAGE. | ||||||||||||
.\" | .\" | ||||||||||||
.\" * Other names and brands may be claimed as the property of others. | .\" * Other names and brands may be claimed as the property of others. | ||||||||||||
.\" | .\" | ||||||||||||
.Dd January 24, 2021 | .Dd February 19, 2021 | ||||||||||||
.Dt AXP 4 | .Dt AXP 4 | ||||||||||||
.Os | .Os | ||||||||||||
.Sh NAME | .Sh NAME | ||||||||||||
.Nm axp | .Nm axp | ||||||||||||
.Nd "Advanced Micro Devices 10G Ethernet driver" | .Nd "Advanced Micro Devices 10G Ethernet driver" | ||||||||||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||||||||||
To compile this driver into the kernel, | To compile this driver into the kernel, | ||||||||||||
place the following lines in your | place the following lines in your | ||||||||||||
▲ Show 20 Lines • Show All 87 Lines • ▼ Show 20 Lines | |||||||||||||
.El | .El | ||||||||||||
.Pp | .Pp | ||||||||||||
Set the offset of the register to the first variable, and then read the value | Set the offset of the register to the first variable, and then read the value | ||||||||||||
of the register by reading the second variable. | of the register by reading the second variable. | ||||||||||||
.It Va dev.ax.X.axgbe_debug_level | .It Va dev.ax.X.axgbe_debug_level | ||||||||||||
Configure the log-level for the driver. | Configure the log-level for the driver. | ||||||||||||
Default is 0. | Default is 0. | ||||||||||||
Supports 0-3. | Supports 0-3. | ||||||||||||
.It Va dev.ax.X.single_fl | .It Va dev.ax.X.link_workaround | ||||||||||||
This variable must be set before loading the driver, either via | This variable enables the workaround for an intermittent link issue. | ||||||||||||
When link does not come up for long time, this variable can be set to 1 to | |||||||||||||
reset the phy and bring up the link. | |||||||||||||
.El | |||||||||||||
.Sh LOADER TUNABLES | |||||||||||||
The following variable is available as | |||||||||||||
.Xr loader.conf 5 | .Xr loader.conf 5 | ||||||||||||
or through the use of | tunable. | ||||||||||||
.Xr kenv 1 . | .Bl -tag -width indent | ||||||||||||
This cannot be modified when driver is loaded. | .It Va dev.ax.X.sph_enable | ||||||||||||
This variable controls split header feature for the interface. | |||||||||||||
Default is 1, meaning the split header support is enabled. | |||||||||||||
.Pp | .Pp | ||||||||||||
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.single_fl\&, | |||||||||||||
which will configure all AMD interfaces with single freelist per receive queue. | |||||||||||||
Default is 2 freelist per receive queue. | |||||||||||||
.Pp | |||||||||||||
This variable is to configure the interface when single freelist is needed. | |||||||||||||
(For Eg. netmap). | |||||||||||||
Basically, this will control the software behavior of how the receive | |||||||||||||
descriptors are used. | |||||||||||||
.Pp | |||||||||||||
Setting this variable to 1, will use 1 Freelist per receive queue. | |||||||||||||
.Pp | |||||||||||||
Setting this variable to 0, will use 2 Freelist per receive queue. | |||||||||||||
.Pp | |||||||||||||
Based on the setting, the receive buffers are programmed accordingly on the | |||||||||||||
received descriptors. | |||||||||||||
.Pp | |||||||||||||
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 | This variable must be set before loading the driver, either via | ||||||||||||
yuripv: This should be documented in LOADER TUNABLES section then. | |||||||||||||
Done Inline ActionsAdded LOADER TUNABLES section and moved this variable there. rajeshasp: Added LOADER TUNABLES section and moved this variable there. | |||||||||||||
.Xr loader.conf 5 | .Xr loader.conf 5 | ||||||||||||
or through the use of | or through | ||||||||||||
.Xr kenv 1 . | .Xr kenv 1 . | ||||||||||||
This cannot be modified when driver is loaded. | This cannot be modified when driver is loaded. | ||||||||||||
.Pp | .Pp | ||||||||||||
Setting this variable in | Setting this variable in | ||||||||||||
Done Inline Actions
yuripv: | |||||||||||||
.Xr loader.conf 5 | .Xr loader.conf 5 | ||||||||||||
needs the system to be restarted to take effect. | needs the system to be restarted to take effect. | ||||||||||||
When using | When using | ||||||||||||
.Xr kenv 1 , | .Xr kenv 1 , | ||||||||||||
use the wrapper variable | use the wrapper variable | ||||||||||||
.Va dev.ax.sph_enable\&, | .Va dev.ax.sph_enable , | ||||||||||||
Done Inline Actions
yuripv: | |||||||||||||
Done Inline Actions
This sentence should be first in description. yuripv: This sentence should be first in description. | |||||||||||||
Done Inline ActionsThis seems to be redundant and stating obvious. yuripv: This seems to be redundant and stating obvious. | |||||||||||||
Done Inline ActionsRemoved these two lines. rajeshasp: Removed these two lines. | |||||||||||||
Done Inline Actions
yuripv: | |||||||||||||
which will configure(enable/disable) split header support in all | which will configure(enable/disable) split header support for all | ||||||||||||
AMD interfaces. | .Nm | ||||||||||||
interfaces. | |||||||||||||
.Pp | .Pp | ||||||||||||
This variable is to control enable/disable of the split header feature in | To use netmap with this device, split header support must be disabled | ||||||||||||
the interface. | (set this variable to 0). | ||||||||||||
Done Inline ActionsI would rephrase to remove the word "test". Perhaps something like "To use netmap with this device, split header support must be disabled (set this variable to 0)" gallatin: I would rephrase to remove the word "test". Perhaps something like "To use netmap with this… | |||||||||||||
.Pp | |||||||||||||
Setting this variable to 1, will enable split header feature. | |||||||||||||
.Pp | |||||||||||||
Setting this variable to 0, will disable split header feature. | |||||||||||||
.Pp | |||||||||||||
By default, this variable will be set to 1, meaning the Split header support be | |||||||||||||
enabled. | |||||||||||||
.Pp | |||||||||||||
NOTE: It is recommended to use this variable only when | |||||||||||||
.Va single_fl\& | |||||||||||||
is configured. | |||||||||||||
Otherwise let it be default value. | |||||||||||||
.El | .El | ||||||||||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||||||||||
Done Inline Actions
Let's name it consistently. yuripv: Let's name it consistently. | |||||||||||||
.Xr arp 4 , | .Xr arp 4 , | ||||||||||||
.Xr iflib 4 , | .Xr iflib 4 , | ||||||||||||
.Xr netmap 4 , | .Xr netmap 4 , | ||||||||||||
Done Inline ActionsIt was already said that it is workaround. yuripv: It was already said that it is workaround. | |||||||||||||
.Xr vlan 4 , | .Xr vlan 4 , | ||||||||||||
.Xr ifconfig 8 | .Xr ifconfig 8 | ||||||||||||
.Sh HISTORY | .Sh HISTORY | ||||||||||||
The | The | ||||||||||||
.Nm | .Nm | ||||||||||||
device driver first appeared in | device driver first appeared in | ||||||||||||
.Fx 13.0 . | .Fx 13.0 . | ||||||||||||
.Pp | .Pp | ||||||||||||
Show All 15 Lines |
This should be documented in LOADER TUNABLES section then.