igb.txt: Add igb documentation
in [Kernel]
|
Prev: [PATCH 2/2] igbvf.txt: Add igbvf Documentation
Next: platform: Faciliatate the creation of pseduo-platform busses
From: Jeff Kirsher on 3 Aug 2010 20:50 On Tue, Aug 3, 2010 at 17:39, Joe Perches <joe(a)perches.com> wrote: > On Tue, 2010-08-03 at 17:15 -0700, Jeff Kirsher wrote: >> Add documentation for the igb networking driver. > > It'd be nice if you could scare up > register level ipw-2xxx docs. > > > -- That would be wireless, and I am with Wired LAN. Although Joe, I will see what I can come up with, but I cannot promise anything... :) -- Cheers, Jeff -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo(a)vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
From: Joe Perches on 3 Aug 2010 20:50 On Tue, 2010-08-03 at 17:15 -0700, Jeff Kirsher wrote: > Add documentation for the igb networking driver. It'd be nice if you could scare up register level ipw-2xxx docs. -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo(a)vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
From: Ben Hutchings on 3 Aug 2010 22:40 On Tue, 2010-08-03 at 17:15 -0700, Jeff Kirsher wrote: [...] > + Jumbo Frames > + ------------ > + Jumbo Frames support is enabled by changing the MTU to a value larger than > + the default of 1500. Use the ifconfig command to increase the MTU size. > + For example: > + > + ifconfig eth<x> mtu 9000 up > + > + This setting is not saved across reboots. Not igb-specific. [...] > + Ethtool > + ------- > + The driver utilizes the ethtool interface for driver configuration and > + diagnostics, as well as displaying statistical information. Ethtool > + version 3.0 or later is required for this functionality, although we > + strongly recommend downloading the latest version at: > + > + http://sourceforge.net/projects/gkernel. Not igb-specific, and seriously - 3.0? > + Enabling Wake on LAN* (WoL) > + --------------------------- > + WoL is configured through the Ethtool* utility. Not igb-specific. [...] > + LRO > + --- > + Large Receive Offload (LRO) is a technique for increasing inbound throughput > + of high-bandwidth network connections by reducing CPU overhead. It works by > + aggregating multiple incoming packets from a single stream into a larger > + buffer before they are passed higher up the networking stack, thus reducing > + the number of packets that have to be processed. LRO combines multiple > + Ethernet frames into a single receive in the stack, thereby potentially > + decreasing CPU utilization for receives. Not igb-specific. > + NOTE: LRO requires 2.6.24 or later kernel version. [...] Which is irrelevant to an in-tree driver. Ben. -- Ben Hutchings, Senior Software Engineer, Solarflare Communications Not speaking for my employer; that's the marketing department's job. They asked us to note that Solarflare product names are trademarked. -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo(a)vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
From: Jeff Kirsher on 5 Aug 2010 00:30 0On Tue, Aug 3, 2010 at 19:34, Ben Hutchings <bhutchings(a)solarflare.com> wrote: > On Tue, 2010-08-03 at 17:15 -0700, Jeff Kirsher wrote: > [...] >> + Jumbo Frames >> + ------------ >> + Jumbo Frames support is enabled by changing the MTU to a value larger than >> + the default of 1500. Use the ifconfig command to increase the MTU size. >> + For example: >> + >> + ifconfig eth<x> mtu 9000 up >> + >> + This setting is not saved across reboots. > > Not igb-specific. > > [...] >> + Ethtool >> + ------- >> + The driver utilizes the ethtool interface for driver configuration and >> + diagnostics, as well as displaying statistical information. Ethtool >> + version 3.0 or later is required for this functionality, although we >> + strongly recommend downloading the latest version at: >> + >> + http://sourceforge.net/projects/gkernel. > > Not igb-specific, and seriously - 3.0? > >> + Enabling Wake on LAN* (WoL) >> + --------------------------- >> + WoL is configured through the Ethtool* utility. > > Not igb-specific. > > [...] >> + LRO >> + --- >> + Large Receive Offload (LRO) is a technique for increasing inbound throughput >> + of high-bandwidth network connections by reducing CPU overhead. It works by >> + aggregating multiple incoming packets from a single stream into a larger >> + buffer before they are passed higher up the networking stack, thus reducing >> + the number of packets that have to be processed. LRO combines multiple >> + Ethernet frames into a single receive in the stack, thereby potentially >> + decreasing CPU utilization for receives. > > Not igb-specific. > >> + NOTE: LRO requires 2.6.24 or later kernel version. > [...] > > Which is irrelevant to an in-tree driver. > > Ben. > > -- > Ben Hutchings, Senior Software Engineer, Solarflare Communications > Not speaking for my employer; that's the marketing department's job. > They asked us to note that Solarflare product names are trademarked. > Thanks for the review Ben. I am fine and agree with removing the reference to Ethtool version 3.0 and reference to LRO requiring 2.6.24 kernel. Sorry we did not catch the earlier... As far as the 4 sections you noted as not being igb-specific, while these sections are not specific to the driver, I see them as useful to users trying to find more information on the driver and how to configure it. IMHO more documentation is more useful that too little, as long as you are not adding bloat to the documentation which makes it difficult to find what you are looking for. If I am in minority here, I fine with removing the non-igb specific sections as well. -- Cheers, Jeff -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo(a)vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
From: David Miller on 8 Aug 2010 23:10
From: Jeff Kirsher <jeffrey.t.kirsher(a)intel.com> Date: Sun, 08 Aug 2010 18:54:11 -0700 > Add documentation for the igb networking driver. > > v2: > - Removed trailing white space > - Removed Ethtool version info > - Removed LRO kernel version info > > Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher(a)intel.com> > Tested-by: Jeff Pieper <jeffrey.e.pieper(a)intel.com> Applied. -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo(a)vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/ |