svn commit: r236412 - head/share/man/man4

[Sean Bruno]

Author: sbruno
Date: Fri Jun  1 18:01:51 2012
New Revision: 236412
URL: http://svn.freebsd.org/changeset/base/236412

Log:
  Add notes and information for exposed tuneables in bce(4).
  Add source of documentation for this driver.
  
  Thanks to Warren Block for the suggestions for readability.
  
  Note that strict_rx_mtu in inverted in stable/7/8/9 and is
  named loose_rx_mtu.  Ensure that this is converted over when MFC'd
  
  hw.bce.rx_ticks
  hw.bce.rx_ticks_int
  hw.bce.rx_quick_cons_trip
  hw.bce.rx_quick_cons_trip_int
  hw.bce.tx_ticks
  hw.bce.tx_ticks_int
  hw.bce.tx_quick_cons_trip
  hw.bce.tx_quick_cons_trip_int
  hw.bce.strict_rx_mtu
  hw.bce.hdr_split
  hw.bce.tx_pages
  hw.bce.rx_pages
  hw.bce.tso_enable
  hw.bce.verbose
  
  Reviewed by:  Warren Block <wblock at wonkity.com>
  MFC after:	3 days

Modified:
  head/share/man/man4/bce.4

Modified: head/share/man/man4/bce.4
==============================================================================
--- head/share/man/man4/bce.4	Fri Jun  1 17:22:20 2012	(r236411)
+++ head/share/man/man4/bce.4	Fri Jun  1 18:01:51 2012	(r236412)
@@ -200,9 +200,60 @@ variables and
 .Xr loader 8
 tunables:
 .Bl -tag -width indent
+.It Va hw.bce.verbose
+Enable/Disable verbose logging and output to the console.
+Useful for debugging (default 0).
 .It Va hw.bce.msi_enable
-Whether or not MSI support is enabled in the driver.
-The default value is 1.
+Enable/Disable MSI support (default 1).
+.It Va hw.bce.tso_enable
+Enable/Disable TSO support (default 1).
+.It Va hw.bce.strict_rx_mtu
+Enable/Disable strict RX frame size checking (default 0).
+.It Va hw.bce.hdr_split
+Enable/Disable frame header/payload splitting (default 1).
+.It Va hw.bce.rx_pages
+Set the number of memory pages assigned to recieve packets by the driver.
+Due to alignment issues, this value can only be of the set 1, 2, 4 or 8 (default 2).
+.It Va hw.bce.tx_pages
+Set the number of memory pages assigned to transmit packets by the driver.
+Due to alignment issues, this value can only be of the set 1, 2, 4 or 8 (default 2).
+.It Va hw.bce.rx_ticks
+Time in microsecond ticks to wait before generating a status block updates due to RX processing activity.
+Values from 0-100 are valid.
+A value of 0 disables this status block update.
+Cannot be set to 0 if hw.bce.rx_quick_cons_trip is also 0 (default 18).
+.It Va hw.bce.rx_ticks_int
+Time in microsecond ticks to wait during RX interrupt processing before generating a status block update.
+Values from 0-100 are valid.
+Valid values are in the range from 0-100.
+A value of 0 disables this status block update (default 18).
+.It Va hw.bce.rx_quick_cons_trip
+Number of RX Quick BD Chain entries that must be completed before a status block is generated.
+Values from 0-256 are valid.
+A value of 0 disables this status block update.
+Cannot be set to 0 if hw.bce.rx_ticks is also 0 (default 6).
+.It Va hw.bce.rx_quick_cons_trip_int
+Number of RX quick BD entries that must be completed before a status block is generated duing interrupt processing.
+Values from 0-256 are valid.
+A value of 0 disables this status block update (default 6).
+.It Va hw.bce.tx_ticks
+Time in microsecond ticks to wait before a status block update is generated due to TX activitiy.
+Values from 0-100 are valid.
+A value of 0 disables this status block update.
+Cannot be set to 0 if hw.bce.tx_quick_cons_trip is also 0 (default 80).
+.It Va hw.bce.tx_ticks_int
+Time in microsecond ticks to wait in interrupt processing before a status block update is generated due to TX activity
+Values from 0-100 are valid.
+A value of 0 disables this status block update (default 80).
+.It Va hw.bce.tx_cons_trip
+How many TX Quick BD Chain entries that must be completed before a status block is generated.
+Values from 0-100 are valid.
+A value of 0 disables this status block update.
+Cannot be set to 0 if hw.bce.tx_ticks is also 0 (default 20).
+.It Va hw.bce.tx_cons_trip_int
+How many TX Quick BD Chain entries that must be completed before a status block is generated during an interrupt.
+Values from 0-100 are valid.
+A value of 0 disables this status block update (default 20).
 .El
 .Sh DIAGNOSTICS
 .Bl -diag
@@ -266,7 +317,7 @@ address space.
 .It "bce%d: Could not allocate TX descriptor chain DMA tag!"
 The driver could not allocate a DMA tag for the controller's
 TX chain.
-.It "bce%d: Could not allocate TX descriptor chain DMA memory!"
+.It "bce%d: Could not allocate TX descriptor chain DMA memory!
 The driver could not allocate DMA addressable memory for the controller's
 TX chain.
 .It "bce%d: Could not map TX descriptor chain DMA memory!"
@@ -346,6 +397,11 @@ with the cable connection, or a driver l
 A controller hardware failure has occurred.
 If the problem continues replace the controller.
 .El
+.Sh SUPPORT
+For general information and support,
+go to the Broadcom NIC Open Source Developer Resource Site:
+.Pa http://www.broadcom.com/support/ethernet_nic/open_source.php .
+.Pp
 .Sh SEE ALSO
 .Xr altq 4 ,
 .Xr arp 4 ,