Bug 213026

Summary: ixgbe(4) driver name is now ix
Product: Documentation Reporter: Sergey Akhmatov <sergey>
Component: Manual PagesAssignee: freebsd-bugs (Nobody) <bugs>
Status: Open ---    
Severity: Affects Only Me CC: doc, felix.the.red, khj, nospam, ygy
Priority: --- Keywords: needs-qa, patch
Version: Latest   
Hardware: Any   
OS: Any   
URL: https://reviews.freebsd.org/D32531

Description Sergey Akhmatov 2016-09-27 19:00:25 UTC
% man 4 ix
NAME
     ixgbe – Intel(R) 10Gb Ethernet driver for the FreeBSD operating system

SYNOPSIS
     To compile this driver into the kernel, place the following line in your
     kernel configuration file:

           device ixgbe

     Alternatively, to load the driver as a module at boot time, place the
     following line in loader.conf(5):

           if_ixgbe_load="YES"
---
r280182 comments:
        - The driver loadables will now match the device names, something that
          has been requested for some time.
        - Rather than a modules/ixgbe there is now modules/ix and modules/ixv
---
sys/amd64/conf/GENERIC:
 device          ix                      # Intel PRO/10GbE PCIE PF Ethernet
 device          ixv                     # Intel PRO/10GbE PCIE VF Ethernet
---
Since r280182 there is no more device named ixgbe, so the manpage name and the statements from manpage are invalid:
device ixgbe  # for kernel configuration file
if_ixgbe_load="YES" # for loader.conf(5)
Comment 1 Ofloo 2018-01-20 12:49:30 UTC
# make -j9 buildkernel
--- buildkernel ---
--- buildkernel ---

--------------------------------------------------------------
>>> Kernel build for OFL started on Sat Jan 20 13:45:58 CET 2018
--------------------------------------------------------------
===> OFL
mkdir -p /usr/obj/usr/src/sys
--------------------------------------------------------------
>>> stage 1: configuring the kernel
--------------------------------------------------------------
cd /usr/src/sys/amd64/conf;  PATH=/usr/obj/usr/src/tmp/legacy/usr/sbin:/usr/obj/usr/src/tmp/legacy/usr/bin:/usr/obj/usr/src/tmp/legacy/bin:/usr/obj/usr/src/tmp/usr/sbin:/usr/obj/usr/src/tmp/usr/bin:/sbin:/bin:/usr/sbin:/usr/bin  config  -d /usr/obj/usr/src/sys/OFL  -I '/usr/src/sys/amd64/conf' '/usr/src/sys/amd64/conf/OFL'
config: Error: device "ixgbe" is unknown
config: 1 errors
*** [buildkernel] Error code 1

make[1]: stopped in /usr/src
1 error

make[1]: stopped in /usr/src
*** [buildkernel] Error code 2

make: stopped in /usr/src
1 error

make: stopped in /usr/src
Comment 2 Kristian 2019-04-16 12:21:58 UTC
Would be great to add relevant module parameters to the man page as well.

For example, I would assume that:

hw.ixgbe.unsupported_sfp="1"

No longer has any effect and should be replaced with:

hw.ix.unsupported_sfp="1"
Comment 3 Felix Johnson freebsd_triage 2021-10-17 03:50:30 UTC
I created a Phabricator review for this patch:
https://reviews.freebsd.org/D32531

I don't have an ix device, so I can't tell if the diagnostic error messages
have moved from ixgbe to ix.