FILE NAME: 	bcm5700-2.2.23-1.src.rpm

TITLE:     	Compaq Tested and Approved bcm5700 Linux NIC Driver

VERSION:   	2.2.23

LANGUAGE:  	English

CATEGORY:  	Software Solutions

DIVISIONS: 	Systems

PRODUCTS AFFECTED:
		Compaq NC6770 Gigabit Server Adapter
		Compaq NC7760 Gigabit Server Adapter
		Compaq NC7770 Gigabit Server Adapter
		Compaq NC7771 Gigabit Server Adapter
		Compaq NC7780 Gigabit Server Adapter
		Compaq NC7781 Gigabit Server Adapter 
		                   
OPERATING SYSTEM:
		Red Hat 7.3 Professional (32-bit)
		Red Hat 2.1 Advanced Server (32-bit)
		Red Hat 7.2 Professional (64-bit)
		SuSE Linux Enterprise Server 7 (32-bit and 64-bit)
		

PREREQUISITES:  Pentium based computer (32-bit)
		Itanium based computer (64-bit)
		128MB RAM minimum
		Root or Super user mode
		Latest Compaq system ROM 

		Note: Please visit the following URL to upgrade the ROM
         		http://www.compaq.com/support/files/

EFFECTIVE DATE:	07/23/2002

SUPERSEDES:  	bcm5700-2.0.25-1.src.rpm

DESCRIPTION:  	This RPM Package contains the Compaq Tested and Approved bcm5700
		Linux NIC Driver for use with Compaq NC67XX/NC77XX Gigabit
		Server Adapters.

ENHANCEMENTS/FIXES:
		Documentation enhancements 


Table of Contents
=================

  Introduction
  Packaging
  Installing Source RPM Package
  Kernel Source Code Setup
  Module Parameters
  Driver Messages
  Statistics
  Limitations
  
			       
Introduction
============

This file describes the Linux driver for the Compaq NC67xx/NC77xx Gigabit
Server Adapters.  After installation additional information can be found in the
MAN page for bcm5700, and in the RELEASE.TXT file located at:

For Red Hat: /usr/share/doc/bcm5700-2.2.23/RELEASE.TXT
For SuSE: /usr/share/doc/packages/bcm5700/RELEASE.TXT

User guides and additional Compaq Network Adapter information can be found at:
	http://www.compaq.com/support/networking/nics/index.html
 

Packaging
=========

The driver is released in a source RPM format. The file name for the package
is bcm5700-<version>.src.rpm and is dependent on the kernel source code.  If you
have not installed the kernel source code and/or setup the source tree on your
Linux system please see the "Kernel Source Code Setup" section below.


Installing Source RPM Package
=============================

1. This package requires the kernel source code as well as setting up the source
   tree.  Verify the source code /usr/src/linux-<kernel-version> directory exist.

	# cd /usr/src/linux-<kernel-version>

  	If the kernel source code is not present then please refer to the
	"Kernel	Source Code Setup" section below.


2. Install the source RPM package.
   
	# rpm -ivh bcm5700-<version>.src.rpm


3. Build the binary RPM for the bcm5700 driver.

	# cd /usr/src/{redhat,packages} 
	# rpm -bb SPECS/bcm5700.spec

	If you get an error during the build process, please refer to the
	"Kernel Source Code Setup" section to correctly setup the source tree.

   
4. Install the new RPM package.  This installs the bcm5700 driver and man page.


	for 32-bit environments:
	# rpm -ivh RPMS/i386/bcm5700-<version>.i386.rpm

	for 64-bit environments:
	# rpm -ivh RPMS/ia64/bcm5700-<version>.ia64.rpm

	If an older version of bcm5700 already exists or a conflict occurs, 
	please use the "force" command as shown below.

	for 32-bit environments:
	# rpm -ivh RPMS/i386/bcm5700-<version>.i386.rpm --force

	for 64-bit environments:
	# rpm -ivh RPMS/ia64/bcm5700-<version>.ia64.rpm --force

	The bcm5700.o driver will be installed in the following path:

	Red Hat
	/lib/modules/<kernel_version>/kernel/drivers/addon/bcm5700/bcm5700.o

	SuSE
	/lib/modules/<kernel_version>/kernel/drivers/net/bcm5700.o


5. Configure your network setting and address.  You may need to refer to your
   Linux vendor documentation.  Other helpful network configuration tools such a
   "yast" in SLES 7 or "linuxconf" in Red Hat 7.2 exist for easy configuration.

6. Ensure that the /etc/modules.conf file is configured similar to the example
   listed below.  The example below is presented as if more than one adapter is
   present.  If so, one eth# instance should exist for each ethernet port.
   View the modules.conf man page for more information. 

   alias eth0 bcm5700
   alias eth1 bcm5700
   alias eth# bcm5700

7. You can now reboot your server. Upon reboot the network should start with
   the bcm5700 driver loaded and the correct network configuration.  To verify
   that the bcm5700 driver is loaded use the following command.

	# lsmod

   If bcm5700 is listed then the bcm5700 driver loaded.

   Note: By default Red Hat 7.3 installs the tg3 driver.  If the tg3 driver is
   installed please unload the tg3 driver first. Use ifconfig to bring down all
   eth# interfaces used by tg3.

	# ifconfig eth# down

   Now remove or unload the tg3 driver.

	# rmmod tg3

   You may also need to manually edit the /etc/modules.conf file to change
   the driver from tg3 to bcm5700.

	alias eth0 tg3

   and replace tg3 with bcm5700:

	alias eth0 bcm5700

   Load the bcm5700 driver:

	# insmod bcm5700

   Use ifconfig to bring up the network with the new driver:

	# ifconfig eth# up

   See the man pages for lsmod, ifconfig, rmmod, insmod and moduels.conf for
   more detailed information.



Kernel Source Code Setup
========================

The bcm5700 driver requires the presence of the kernel source code and setting
up the kernel source tree before building the bcm5700 driver. Please install the
kernel source code (if not already installed) and proceed with the steps listed
below.

Note 1: Red Hat installations
	If the /usr/src/linux-<kernel-version> directory does not exist please
	install the kernel source code per Redhat instructions.  Once installed,
	please follow the commands listed below to setup the kernel source tree.

	# cd /usr/src/linux-<kernel_version>
	# make oldconfig
	# make dep


Note 2: SuSE SLES 7 installation
	If the /usr/src/linux-<kernel-version> directory does not exist please
	install the kernel source code per SuSE instructions.  Once installed,
	please follow the commands listed below to setup the kernel source tree.

	# cd /usr/src/linux-<kernel_version>.SuSE
	# cp /boot/vmlinuz.config .config
	# cp /boot/vmlinuz.version.h include/linux/version.h
	# cp /boot/vmlinuz.autoconf.h include/linux/autoconf.h
	# make oldconfig
	# make dep


Module Parameters
=================

Optional parameters for the driver can be supplied as command line arguments 
to the insmod command. Typically, these parameters are set in the file
/etc/modules.conf (see the man page for modules.conf). These parameters take
the form listed below.  Note that multiple values for the same parameter 
correspond to it's respective adapter.  That is, the first value is for eth0,
the second value for eth1, etc.  If a parameter is not specified then the 
default value is used.  Caution! Parameters are case sensitive and require 
correct spelling.  Please ensure correct usage as the bcm5700 driver will not
load if incorrectly used.

    alias eth0 bcm5700
    alias eth1 bcm5700
    alias eth# bcm5700
    options bcm5700 <parameter>=[value,value,...] <parameter>=[value,value,...]

line_speed

    Selects the line speed of the link. This parameter is used together with
    full_duplex and auto_speed to select the speed and duplexity of the link
    and the setting of autonegotiation. The valid values are:
    
    0      Autonegotiate for highest speed supported by link partner (default)
    10     10 Mbps
    100    100 Mbps
    1000   1000 Mbps

    If line_speed is set to 10, 100, or 1000, the NIC will autonegotiate for
    the selected speed (and selected duplexity) if auto_speed is set to 1.
    If auto_speed is set to 0, the selected speed and duplexity will be
    set without autonegotiation. Note that 1000 Mbps must be negotiated for
    copper twisted pair links.

auto_speed

    Enables or disables autonegotiation. The valid values are:

    0      Autonegotiation disabled
    1      Autonegotiation enabled (default)

    Note that this parameter is ignored and assumed 1 if line_speed is set
    to 0.
    
full_duplex

    Selects the duplexity of the link. This parameter is used together with
    line_speed to select the speed and duplexity of the link. Note that this
    parameter is ignored if line_speed is 0. The valid values are:
    
    0      half duplex
    1      full duplex (default)
    
    
rx_flow_control

    Enables or disables receiving flow control (pause) frames. This parameter
    is used together with auto_flow_control. The valid values are:
    
    0      pause receive disabled (default)
    1      pause receive enabled if auto_flow_control is set to 0, or
           pause receive advertised if auto_flow_control is set to 1

tx_flow_control

    Enables or disables transmitting flow control (pause) frames. This parameter
    is used together with auto_flow_control. The valid values are:
    
    0      pause transmit disabled (default)
    1      pause transmit enabled if auto_flow_control is set to 0, or
           pause transmit advertised if auto_flow_control is set to 1

auto_flow_control

    Enables or disables autonegotiation of flow control. This parameter is used
    together with rx_flow_control and tx_flow_control to determine the
    advertised flow control capability. The valid values are:
    
    0      flow control autonegotiation disabled (default)
    1      flow control autonegotiation enabled with capability specified in
           rx_flow_control and tx_flow_control (only valid if line_speed is
           set to 0 or auto_speed is set to 1)

mtu

    Enables jumbo frames if MTU is set equal to or greater than 1501.  The valid
    range for MTU is from 1500 to 9000.  Default is standard MTU size, 1500 (not
    a jumbo frame).  Note: MTU size excludes the Ethernet header size of 14
    bytes. Actual frame size is MTU size + 14 bytes.

tx_checksum

    Enables or disables hardware transmit TCP/UDP checksum. The valid values
    are:

    0      checksum disabled
    1      checksum enabled (default)

rx_checksum

    Enables or disables hardware receive TCP/UDP checksum validation. The
    valid values are:

    0      checksum disabled
    1      checksum enabled (default)

scatter_gather

    Enables or disables scatter-gather and 64-bit DMA on x86. This option is
    only useful when running on TUX-enabled kernels or newer kernels with
    zero-copy TCP. The valid values are:

    0      scatter-gather and 64-bit DMA on x86 disabled
    1      scatter-gather and 64-bit DMA on x86 enabled (default)

tx_pkt_desc_cnt

    Configures the number of transmit descriptors. Default is 100. The
    valid range is from 1 to 600. Note that the driver may not be able to
    allocate the required amount of memory if this parameter is set too high.

rx_std_desc_cnt

    Configures the number of receive descriptors for frames up to 1528 bytes.
    Default is 200. The valid range is from 1 to 511. This parameter should
    not be set less than 80 on systems with high network traffic. Setting this
    parameter higher allows the NIC to buffer larger bursts of network
    traffic without dropping frames, especially on slower systems. Note that
    the driver may not be able to allocate the required amount of memory if
    this parameter is set too high.

rx_jumbo_desc_cnt

    Configures the number of receive descriptors for jumbo frames larger
    than 1528 bytes. Default is 128 and valid range is from 1 to 255.
    When jumbo frames larger than 1528 bytes are used, this parameter should
    not be set lower than 60 on systems with high network traffic. Setting
    this parameter higher allows the NIC to buffer larger bursts of jumbo
    traffic without dropping frames, especially on slower systems. Note that
    each descriptor requires a buffer the size of a maximum jumbo frame.
    On systems with insufficient memory, it may be necessary to reduce this
    parameter. When the maximum frame size is 1528 or smaller (MTU size 1514
    or smaller), this parameter is not used and is always 0. On machines which
    do not have memory constraints, it is advised to use a value of 15 or above
    for this parameter.

adaptive_coalesce

    Enables or disables adaptive adjustments to the various interrupt
    coalescing parameters. Enabling it allows the driver to dynamically
    adjust the interrupt coalescing parameters to achieve high throughput
    during heavy traffic and low latency during light traffic.
    rx_std_desc_cnt, tx_pkt_desc_cnt, (and rx_jumbo_desc_cnt if using
    jumbo frames) should not be set much lower than their default values
    when this parameter is enabled. The valid values are:

    0      disabled
    1      enabled (default)

rx_coalesce_ticks

    Configures the number of 1 usec ticks before the NIC generates receive
    interrupt after receiving a frame. This parameter works in conjunction
    with the rx_max_coalesce_frames parameter. Interrupt will be generated
    when either of these thresholds is exceeded. 0 means this parameter is
    ignored and interrupt will be generated when the rx_max_coalesce_frames
    threshold is reached. The valid range is from 0 to 500, and default is
    100. This parameter is not used and will be adjusted automatically if
    adaptive_coalesce is set to 1.

rx_max_coalesce_frames

    Configures the number of received frames before the NIC generates a receive
    interrupt. The valid range is from 0 to 100, and default is 10. This
    parameter and rx_coalesce_ticks cannot be both 0, otherwise no receive
    interrupts will be generated. It should also be set significantly lower
    than rx_std_desc_cnt (and rx_jumbo_desc_cnt if using jumbo frames). This
    parameter is not used and will be adjusted automatically if
    adaptive_coalesce is set to 1.

tx_coalesce_ticks

    Configures the number of 1 usec ticks before the NIC generates transmit
    interrupt after transmitting a frame. This parameter works in conjunction
    with the tx_max_coalesce_frames parameter. Interrupt will be generated
    when either of these thresholds is exceeded. 0 means this
    parameter is ignored and interrupt will be generated when the
    tx_max_coalesce_frames threshold is reached. The valid range is from 0 to
    500, and default is 400. This parameter is not used and will be adjusted
    automatically if adaptive_coalesce is set to 1.

tx_max_coalesce_frames

    Configures the number of transmitted frames before the NIC generates a
    transmit interrupt. The valid range is from 0 to 100, and default is 40.
    This parameter and tx_coalesce_ticks cannot be both 0, otherwise no
    transmit completion interrupt will be generated. This parameter should
    always be set lower than tx_pkt_desc_cnt. This parameter is not used and
    will be adjusted automatically if adaptive_coalesce is set to 1.

stats_coalesce_ticks

    Configures the number of 1 usec ticks between periodic statistics block
    DMAs. The valid range is from 0 to 3600000000, and default is 1000000
    (1 sec.).  Set to 0 to disable statistics updates. This parameter is not
    used and will be set to the default value if adaptive_coalesce is set to 1.

enable_wol

    Enables or disables magic packet Wake-On-LAN when the system is shutdown.
    Note that not all systems support Wake-On-LAN. The valid values are:

    0    magic packet Wake-On-LAN disabled (default)
    1    magic packet Wake-On-LAN enabled


Driver Messages
===============

The following are the most common sample messages that may be logged in the file
/var/log/messages.  Some Linux distributions may not display messages to the
console.  To set messages to display on the console, at the command line use
to control the level at which messages will appear on the console.

	# dmesg -n 6

Most systems are set to level 6 by default. For Example, if a Compaq NC7771 Gigabit
Server Adapter is installed, the set of messages would look as follows:

eth#: Compaq NC7771 Gigabit Server Adapter found at mem c6ff0000, IRQ 5, node addr 00101804088e
eth#: Broadcom BCM5703 Integrated Copper transceiver found
eth#: Scatter-gather ON, 64-bit DMA ON, Tx Checksum ON, Rx Checksum ON

If a Compaq NC6770 Gigabit Server Adapter is installed, the set of messages would look as follows:

eth#: Compaq NC6770 Gigabit Server Adapter found at mem c6fe0000, IRQ 10, node addr 000802280026
eth#: Agilent HDMP-1636 SerDes transceiver found
eth#: Scatter-gather ON, 64-bit DMA ON, Tx Checksum ON, Rx Checksum ON

    Link up and speed indication

	bcm5700: eth# NIC Link is Up, 1000 Mbps full duplex

 
    Link down indication

	bcm5700: eth# NIC Link is Down



Statistics
==========

Detailed statistics and configuration information can be viewed by:

	# more /proc/net/nicinfo/eth#.info.


Limitations
===========

The /proc/net/nicinfo/eth#.info file may report incorrect information regarding
statistics, and PCI slot.  Please note that in some cases more tx_packets and/or
rx_packets are reported than tx_bytes and/or rx_bytes,respectively.  The reason
for the error is due to counters rolling over.  Also note that "PCI_SLOT" is not
the actual physical slot.  "PCI_SLOT" represents the PCI device ID.

Under lower speed and half duplex combinations, a higher error count may 
be generated.  This error will have minimal effect on the overall system and 
session performance.  Some error count generation is a normal and expected 
occurrence in these conditions.



Compaq Computer Corporation, Copyright 2000-2002.  All rights reserved.
Product names mentioned herein may be trademarks and/or registered trademarks
of their respective companies