ethtool: Correct description of 'max_coalesced_frames' fields
authorBen Hutchings <bhutchings@solarflare.com>
Mon, 15 Aug 2011 14:07:47 +0000 (14:07 +0000)
committerDavid S. Miller <davem@davemloft.net>
Tue, 16 Aug 2011 23:36:14 +0000 (16:36 -0700)
commit2d7c79390eccd743a643db3fa577f4837e7f2b85
tree9c13001aac43a3f3de9e9d60778968faf56a92b5
parent725b361b29ba9fb72705a30743d288ee66055209
ethtool: Correct description of 'max_coalesced_frames' fields

The current descriptions state that these fields specify 'How many
packets to delay ... after a packet ...' which implies that the
hardware should wait for (max_coalesced_frames + 1) completions before
generating an interrupt.  It is also stated that setting both this
field and the corresponding 'coalesce_usecs' field to 0 is invalid.
Together, this implies that the hardware must always be configured
to delay a completion IRQ for at least 1 usec or 1 more completion.

I believe that the addition of 1 is not intended, and David Miller
confirms that the original implementation (in tg3) does not do this.
Clarify the descriptions of these fields to avoid this interpretation.

Signed-off-by: Ben Hutchings <bhutchings@solarflare.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/linux/ethtool.h