Page 1
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Broadcom NetXtreme Ethernet Adapter Diagnostic User’s Guide B57diag DOS Version 15.0 B57diag UEFI Version 15.0 page 1 Broadcom Confidential and Proprietary...
Page 2
No part of this document may be reproduced, in any form or by any means, without permission in writing from Broadcom Corporation. Broadcom Corporation reserves the right to make changes to the products or information contained in this document without notice. No liability is assumed as a result of their use or application. No rights under any patent accompany the sale of any such products or information.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide TABLE OF CONTENTS INTRODUCTION ........................... 11 PREREQUISITES ........................... 12 DIAGNOSTIC TESTS ........................13 ..........................14 RROR ODES - A G ....................... 14 EGISTER ESTS ROUP 3.2.1 A1. Indirect Register Test ..................... 14 3.2.2...
Page 4
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 3.7.5 F5. APE Scratch Pad Test ....................24 3.7.6 F6. APE Shared Memory Test ....................25 3.7.7 F7. APE Shared Memory Indirect Access Test ..............25 3.7.8 F8. APE Mutex Register Test ....................25 3.7.9...
The commands are explained in the later chapters. This document provides the information on configuration file specification, command line options and engineering diagnostic commands on Broadcom NetXtreme Ethernet adapter, in particular to check out the functionality of the BCM5700 Family of Ethernet controllers and its related components.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 2 Prerequisites The engineering diagnostic is executed under DOS protected mode or under Unified Extensible Firmware Interface (UEFI). OS: Dos 6.22 or UEFI v2.0x or later Software: b57diag.exe for DOS and b57diag64.efi, b57diag32.efi for UEFI (version 11.05 or later).
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 3 Diagnostic Tests The tests are divided into seven groups: Register Tests, Memory Tests, Miscellaneous Tests, Data Tests, Cable Tests, APE Register Tests and APE Diagnostics Tests. They numbered as group ‘A’, ‘B’, ‘C’, ‘D’, ‘E’, ‘F’, and ‘G’.
D7. E-Switch Test (5756 and 5761E devices only) D8. SADB Test (available on NetXtreme Controllers with hardware IPSec support) D9. IPsec Loopback Test (available on NetXtreme Controllers with hardware IPSec support) Group E. E1. 1G Wire Open/Short (** ZERO LEN LB RJ45 **) Test Group F.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 3.2.2 A2. Control Register Test Command: regtest Function: Each Register specified in the configuration contents is tested for read only bit and read/write bit defines. The test writes zeroes and ones into the test bits to insure the read only bits are not changed, and read/write bits are changed accordingly.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Function: Tests the PCI-E Power capabilities registers on chips that support the Power capability. This command is supported on 5751Cx, 5755 and 5787 only. Default: Enabled. 3.2.8 A8. Mailbox Register Test Function: This test verifies the access integrity of the Mailbox registers. This test is for 5719 and 5720 only.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Function: This test tests the BD SRAM. This performs exact the same way of testing as described in B1, the Scratch Pad Test. Default: Enabled 3.3.3 B3. DMA SRAM Test Command: memtest -d Function: It tests DMA SRAM by performing the tests described in test B1, the Scratch Pad Test.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Default: Enabled 3.3.6 B6. External SRAM Test Command: memtest -e Function: It tests external SRAM by performing the tests described in test B1, the Scratch Pad Test. Default: Disabled 3.3.7 B7. CPU GPR Test Command: memtest -b Function: This test tests the CPU General Purpose Registers.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 3.4.4 C4. MII Test Command: miitest Function: The function is identical to A2. Control Register Test. Each Register specified in the configuration contents read only bit and read/write bit defines. The test writing zero and one into the test bits to insure the read only bits value are not changed, and read/write bits are changed accordingly.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Function: 1. Reset test. Setting reset bit, poll for self-clearing. Verify reset value of registers. 2. Event Mapping Test Setting SMB_ATTN bit. By changing ASF_ATTN LOC bits, verify the mapping bits in TX_CPU or RX_CPU event bits.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Default: Enabled Note: This test is not available for 5718, 5719 and 5720. 3.5.2 D2. Phy Loopback Test Command: pkttest -p Function: This test is same as D1. Mac Loopback Test, except the data is routed back via physical layer device.
3.5.7 D7. E-Switch Test Command: nictest d7 Function: This function tests the E-Switch Ethernet porting switching hardware. Default: Enabled (available only for NetXtreme controllers with E-Switch support) 3.5.8 D8. SADB Test Command: nictest d8 Function: This function tests the Security Association Data Base hardware in IPsec supported NetXtreme Ethernet controllers.
Ethernet controller. Default: Disabled NOTE: The following tests in test groups F and G are only enabled for NetXtreme Ethernet Controllers which support the Application Processing Engine (APE). APE Registers Tests – F Group 3.7.1 F1.
3.7.5 F5. APE Scratch Pad Test Command: nictest f5 Function: This test tests the APE scratch pad SRAM on the APE enabled NetXtreme controllers. The following tests are performed: Data Pattern Test: Write test data into SRAM, read back to ensure data is correct. The test data used is 0x00000000, 0xffffffff, 0xaa55aa55, and 0x55aa55aa.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 3.7.6 F6. APE Shared Memory Test Command: nictest f6 Function: Performs memory data verification tests on the APE Shared Memory. This test uses the same the method of testing as described in F5. APE Scratch Pad Test.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Alternate Data Pattern Test: Write test data into SRAM. Write complement test data into next address. Read back both data to insure the data is correct. After the test, the program reads back data one more time to insure the data stays correct. The test data used is 0x00000000, 0xffffffff, 0xaa55aa55, and 0x55aa55aa.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 3.8.5 G5. APE CPU Event Register Test Command: nictest g5 Function: In this test the APE CPU writes to the APE event registers to verify that each event state can generate a corresponding interrupt.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 4 Command line option parameters When users invoke this program, a set of option parameter can be used to overwrite the configuration file or the default configuration. This section summarizes the options. The options are case sensitive.
Page 30
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -piscsi <file> Program ISCSI firmware This option needs to follow the –e and –c options. If this option is entered, the program will retrieve the ISCSI firmware filename from the command line then it will start programming.
Page 31
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Example: b57diag –chksecfg file_p.txt (for single port devices) b57diag –chksecfg file_p.txt file_s.txt (for dual port devices) -nosz disable storing NVRAM and TPM size in NVRAM Disable the storing of the TPM and NVRAM size in NVRAM when diagnostics is run from the command prompt.
Page 32
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -lbe g:h:t define the number of packets to use during external loopback Selects the number of packets to send during the external loopback test D3 (g ,h ,t are the gigabit, hundred megabit, and ten megabit packet counts respectively) (default values are g=2000, h=1000, t=600).
Page 33
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide The feature outputs the following information: PCI DID, VID, SDID & SVID; MAC address, Firmware revision, PXE, PXESpd, WOL, ASF, MBA, Bond Rev. This information can be used to verify the setup of a chip after a firmware upgrade.
Page 34
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide When “-updateiscsicfg” command line parameter is entered before “-firmall” command, the ISCSI Firmware Configuration Block of the NVRAM will not be preserved. It will get updated by the input file of “-firmall” command. The “-firmall” command is described above.
Page 35
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide In manufacture testing mode, by default, all devices are tested; however, if this option is used, only that selected device is tested. Example: -c 2 -l <filename> log file All diagnostic output can be saved in a log file. Type log file name is specified by this option.
Page 36
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Default Settings: Enabled Tests: A1. Indirect Register Test A2. Control Register Test A3. Interrupt Test A4. Built In Self Test A5. PCI Cfg Register Test B1. Scratch Pad Test B2. BD SRAM Test B3.
Page 37
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Disabled Tests: D9. IPSec Loopback Test F1. Indirect APE Ctrl Register Test F2. APE Control Register Test F8. APE Mutex Register Test F9. APE Timers Test G3. APE CPU SMBus Loopback Test G4.
Page 38
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide If bus number, device number and function number have been specified, the program will only test the UUT with the specified bus number, device number and function number. Example: -bus 2:4:1 This option should NOT be used along with –c option.
Page 39
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Run program in Manufacturing Loop mode. With this option, the –I, iteration number option, is ignored. The program will run in manufacturing loop mode. Power on/off is supported. After each test, the program will prompt user to exchange the UUT before starts another testing.
Page 40
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Program will check the validity of EEPROM. If it is not valid, it will act as a), -f -m option. If it is good, the program will prompt the user for a new MAC address and program the MAC address only. It checks the validity of EEPROM content once more at the end of programming.
Page 41
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -ppxe <filename> Program PXE firmware This option needs to follow the –e and –c options. If this option is entered, the program will retrieve the PXE firmware filename from the command line then it will start programming.
Page 42
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide value = 2 : Selecting 10FD value = 3 : Selecting 100HD value = 4 : Selecting 100FD Example: b57diag –mbas 0 : To select Auto speed mode. -disableeswitch Disable E-Switch. Act like engineering mode "eswitch -f" command. Disable the E-Switch on the device that support eswitch, such as 5756.
Page 43
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -otpwrtchk <value> : Specify the times to do read-check-compare aftesr an OTP write. -fpara <file> : Read b57diag options from a file. -lmac : Log file per UUT based on input MAC address.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 5 Recover device from corrupt NVAM When vendor id and/or device id have been modified and B57diag can longer find the device, the following steps can be followed to recover the missing device.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 6 EEPROM.TXT format A set of commands is defined to allow user to change EEPROM.BIN content. To update EEPROM.BIN, user must enter –e <code> -geneep options at the command prompt. A password must be entered to run this option.
Page 47
Budgeting Data 4 | Power Budgeting Data 5. “x4” = Power Budgeting Data 6 | Power Budgeting Data 7. *** User defined values will be used. Suggested Product Name is “Broadcom NetXtreme Gigabit Ethernet Controller” **** If “VPDR_SYSTEM_DEFAULT = 1” has been entered, System default value for all VPD-R data will be selected.
Page 48
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide b. MBA Configuration c. NIC Design ………………………….…..: LOM d. L1 PLL Disable …………………………..: Yes e. Clkreq ……………………………………..: No f. PCIE Link Polarity Fix Dis ……………….: No g. L1ASPM Debounce En ……………………: Yes x.
Page 49
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Example 1: ; This is comment line // This also can be used as comment line // Blank line is also allowed // This is Broadcom’s MAC prefix MAC_PREFIX = 00:10:18 POWER_DISSIPATCHED = 10:0:0:100...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 7 User Interface Commands The commands are summarized in the following groups: vpd, nvram, cpu, dma, packet, mii, mem, test, power, irq, mac, misc, bridge and uart. Note: For UEFI version, not all tests are supported. Refer to online help for more information.
Page 51
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide secfg2 Configure NVRAM Group 2 secfg3 Configure NVRAM Group 3 secfg4 Configure NVRAM Group 4 secfg5 Configure NVRAM Group 5 dirw Write a directory entry to NVRAM Write a directory entry for the TPM Block...
Page 52
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide txdstport Configure destination port address for transmission txtype Configure packet type for transmission txprot Configure packet protocol field for transmission txipprot Configure packet IP protocol for transmission rxcfg Configure Rx parameters tprot...
Page 53
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide intrtest Run Interrupt Test pkttest Run Packet Tests cputest Run CPU Test dmatest Run DMA Test teste Enable Test testd Disable Test asftest ASF Test bustest PCI Bus Test sramtest SRAM test...
Page 54
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide radix Change System Radix apeaccmode Select between BAR1 Mode and Indirect Access Mode nolog Close the Current Logfile Open Logfile pciinit Initialize PCI Configuration Registers pciscan Scan for All PCI Devices Execute DOS command...
Page 55
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide ipsecsupport To check if the device support IPSec. Command Group 'man' asfcfg Configure Management Firmware in NVRAM (AKA mancfg) mancfg Configure Management Firmware in NVRAM or configuration file asfprg Program ASF firmware into NVRAM (3 bin files)
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 8 Special Instruction 1. Mac register test: Unload MAC driver before running test. 2. Memory test: Unload MAC driver before running test. 3. DMA test: Unload MAC driver before running test. 4. TX RX packets: TX sides need to be configured (txcfg).
CAT5 (RJ45) cable and data is transmitted and received across the cable. In the above setup one device is the device under test (DUT) and the other is the reference device. Any Broadcom device that is supported by diagnostics can be used as the DUT or the reference device.
Description: This command implements both an interactive and a scripted mode of operation that allow a user to view/modify the NetXtreme I controller configuration. When invoked without any options, the user is presented with a listing of the current NVRAM configuration and is given the opportunity to change the configuration and save the results.
Page 61
: Disable 9. PXE Link Speed { Auto(0),10HD(1),10FD(2) 100HD(3),100FD(4) } : Auto 10. Magic Packet WoL { Enable(1), Disable(2) } : Disable 11. Product Name : Broadcom NetXtreme Gigabit Ethernet Controller 12. Part Number : BCM95705A50 13. Engineering Change : 106679-15 14.
Page 63
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 0:> secfg 24=1 9=0 …. 3. Check/Query NVRAM configurations at the command line. A user can query NVRAM options by using this command. To query MAC address a user can type in the following command where the command puts is a TCL standard command.
Page 64
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Disable(2) When PXE is disable the expansion ROM enable bit in the PCI configuration space is cleared for system boot up. The PXE code does NOT have to been load into the non-volatile memory of the device.
Page 65
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Configure Force PCI Mode Description: PCI bus operational mode configuration. Enable(1) When enabled the device uses PCI mode, instead of PCI-X, independent of the capabilities of the slot the device is plugged into.
Page 66
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: Advanced firmware feature such as Alert Standard Format (ASF) or IPMI is enabled by this option. Enable(1) If the ASF/IPMI/UMP code is loaded in NVRAM it is loaded and executed by the device.
Page 67
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: This value determines the size of the expansion ROM. This option does not apply to PXE in system ROM. Options 8,9, 26 - 29 and 39-40 configure the boot protocol behavior.
Page 68
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: Enable Clock-Run on mini-PCI/cardbus systems. This parameter is valid only for the 5705 A0-A2. Enable(1) Sets the clock mode register bit 22 which will assert (active low) the clock run signal on the bus prior to any PCI configuration space activity.
Page 69
This option is only valid for 5787 and 575xCx devices. The power values need to be setup by the OEM / manufacture based on actual measurements. Default values, contained in the bootcode / firmware, are loosely based on the in house Broadcom NIC card. 15-0 Power Budget data 1 7-0 Base Power in .1 Watt...
Page 70
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: Encoded Hot plug power values 7 & 8 for a NIC device that is used only if enabled in option 50 below. Look at option 46 for details. Configure Hot Plug Power Description: Enable/Disable the hot plug power values defined in options 46-49.
Page 71
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Enable (1) Enable Configure Link Speed Power Description: Enable Link Speed Power for Taishan, Caesar_II and Soledad Devices only Disable (0) Disable Enable (1) Enable Configure Link Idle Mode Description: Enable Link Idle mode (CPMU equipped devices only).
Page 73
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Configure EEE Mode Description: Enable Energy Efficient Ethernet mode Disable (0) Disable Enable (1) Enable Configure PCIE Max Link Speed (5719/5720 only) Description: Configure PCIE max link speed. 2.5Gbps (0) 2.5Gbps 5.0Gbps (1) 5.0Gbps...
Page 74
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Configure Memory Stick INS Polarity Description: Configure Memory Stick INS Polarity. Active High Active High Active Low Active Low Configure Memory Stick INS Chip Pull-up/Pull-down Override Description: Configure Memory Stick INS internal Chip Pull-up/Pull-down override.
Page 75
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Activate Pull-up and Activate Pull-up and deactivate Pull-down deactivate Pull-down (1) Activate Pull-down and Activate Pull-down and deactivate Pull-up deactivate Pull-up (2) Deactivate Pull-up and Deactivate Pull-up and Pull-down Pull-down (3) Configure...
Page 76
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide d. Custom PCIE power...: Yes (3.3v, Sustained, D0, 1.2 Watt...) e. Custom VPD-R Data...: Yes g. Cable Sense/Low Power Energy Detect ..: Disabled h. MBA CFG Data i. User Defined Data…...: No j.
Page 78
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Configure Magic Packet WoL Description: A system can be configured to power-on when a Magic Packet is received. Enable(1) The device will assert the pme signal, to power on the system, when a magic packet is received.
Page 79
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Configure Led Mode Description: A device can be configured to use one LED to indicate speed and activity or three LEDs. Use a devices data sheet to verify the LED modes supported by a devices and for exceptions to the LED modes described below.
Page 80
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Reference Product Name Description: VPD Product description string. Configure VPD Data Description: VPD data Part Number (1) BCM95751 Engineering Change (2) 106679-15 Serial Number (3) 0123456789 Manufacturing ID(4) 14e4 Read only Vendor Data (5)
Page 81
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Configure SD LED Output CTRL Description: Configure SD LED output Active High (0) Active High Active Low (1) Active Low Open Drain (2) Open Drain Open Collector (3) Open Collector Configure SD Bus Power Output Polarity...
Page 83
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide x. Save & exit ----------------------------------------------- WOL Auto (option 7)-----------------------------------------_ -> 7 HW Selfboot Driver WOL selection 0. Disable 1. Magic Packet WOL Enable ----------------------------------------------- LED Mode (option 8)-----------------------------------------_ -> 8 HW Selfboot LED Mode selection 0.
Page 84
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide x. Save & exit Description of above parameters: To enter the ‘secfg’ menu shown above a user type in ‘secfg’ for hardware selfboot firmware at the diagnostics command line. A menu is present to the user showing the ‘secfg’ options shown above.
Page 85
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Magic Packet Option selected for Magic Packet WOL. WOL (1) Configure Led Mode Description: A device can be configured to use one LED to indicate speed and activity or three LEDs. Use a devices data sheet to verify the LED modes supported by a devices and for exceptions to the LED modes described below.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.11 upgfrm Command: upgfrm Description: Upgrade ISCSI, PXE, Boot Code and Selfboot Firmware from a File. This command reads code from a file and program into iscsi, pxe or boot area. Both parameter, the programming target '-p', 'b' or '-i' and filename, must be specified.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.15 asfcfg Command: asfcfg Description: Configure ASF in NVRAM Syntax: asfcfg [filename] If [filename] is provided the file is used to configure the ASF configuration information in NVRAM. If asfcfg is entered by it self a menu is present the user and the options of the items listed in the menu are described below.
The values in these records are normally copied from the system's "ASF! Description Table" (using the ACPI System Description Table architecture) into the ASF Configuration Table in the network adapter's non-volatile memory by the Broadcom ASF Configuration Utility (ASFConfig). See the Alert Standard Format (ASF) Specification v2.0 for detailed descriptions of these records.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Import ASF_SDT record from host PC memory Import SMBIOS record from host PC memory Import APE_CFG from file instead of NVRAM Add config records from cfg or ini file Merge config records from cfg or ini file...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.42 secfg2 Command: secfg2 Description: Configure NVRAM Group 2 Syntax: secfg2 Options: Engineering Change Serial Number Manufacturing ID Asset Tag Part Rev Voltage Force PCI Mode 1:Enable 2:Disable 10.43 secfg3 Command: secfg3...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide SERDES Tx Drvr Pre-Emp - ENABLE Encoded Hot Plug Power Value 1 & 2 For NIC Encoded Hot Plug Power Value 3 & 4 For NIC Encoded Hot Plug Power Value 5 & 6 For NIC Encoded Hot Plug Power Value 7 &...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: Halt CPU Syntax: haltcpu Options: Halt Rx CPU only Halt Tx CPU only 10.52 loadbootcode Command: loadbootcode Description: execute bootcode from file instead of NVRAM Syntax: loadbootcode <filename> Options: -d<HEX> data pattern to be used for memory init. (def=00000000) -f<string>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.65 apeinfo Command: apeinfo Description: Display APE CPU related info. When no option is given, displays memory usage for each Nucleus tasks and memory pool. Only one option can be specified at a time, information related to specified option will be displayed.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.66 apectl Command: apectl Description: The command is used to control the Application Processor Engine (APE) and its firmware (in applicable devices, e.g. BCM5761). Used for debugging. One event option has to be specified.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -s<DEC> query specified PLDM State Sensor ID -A<DEC> send ASF remote control request (rst:0, off:1, on:2, pwrRst:3) Note:”apectl –r” can be used to restart APE manually when firmware or config changes. 10.67 apeping Command: apeping Description: Send APE event to ping host from APE.
Page 112
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Options: word swap Force to use 32-bit Allocate 4k-aligned buffers -a<HEX> NIC address to DMA data to (def=00000000) Byte Swap Continousely dma -d<HEX> delay poll dma done polling (def=00000000) -f<string> File name of file that contains <length,patterns ..>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -m<DEC> 1 for enable , 0 for disable Example: 1. Driver must be loaded before configure. 0:> loaddrv 2. Enable MAC loop back. 0:> mcaclpk -m1 Enabling MAC loopback ... OK 2. Disable MAC loop back.
Page 115
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Generate TPROT packets -n<DEC> Number of packets to be transmitted (def=0) -o<DEC> Number of Rx Rings (def=1) Send protocol packets configured with txcfg command. Use software CRC-32 on Tx Path Enable Rx...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Enable RS232 statistic update TCP segment test -T<DEC> Packet Type, 0:None, 1:Eth2, 2:802.3, 4:SNAP Use external loopback on 5714/5715 -V<HEX> IPSEC test for IPv4/IPv6 (def=00000004) Check DMA_Write error status -X<DEC> Show IPSEC debug message -Z<DEC>...
Page 117
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: Display NIC Statistics Syntax: nicstats <-c> -c : Clear Statististics Example: Load driver if driver is not loaded. 0:> loaddrv Reinitializing PCI Configuration Space Bus Number Device/Funtion : 11/0 Base Address : 0xfb010000 Bringing up MAC driver ...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide PageUP/PageDN to scroll. Ins/Del toggles refresh. ESC to exit 10.79 ringIndex Command: Description: Dump Ring Index. Load Mac driver before running. Syntax: ringindex t | r Options: -n<DEC> Number of Rx Ring to dump (Default=1) (def=1)
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: Configure Phy Speed Syntax: phyctrl Options: -f<string> file contains initialization scripts force half duplex reset PHYs Query PHY state -s<HEX> 0:10 Mbps, 1:100 Mbps, 2:1000 Mbps, 3 - Auto (def=00000002) Force into External loopback mode 10.81 txpkt...
Page 121
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -l<DEC> Start packet length (def=txcfg) Use multiple Tx ring test (def=txcfg) -n<DEC> Number of packet to transmit (def=0) -o<HEX> Buffer Offset (def=00000000) -p<DEC> Number of Tx rings to use in multiple ring test (def=txcfg) -q<DEC>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -t<DEC> Turn on/off txflow capability (def=0) -x<DEC> Configure Tx ring size (def=0) 10.89 irt Command: irt Description: Test an individual register. Test an individual register with a specified number of reads/writes. Syntax: irt Options: -n<DEC>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -n<DEC> Number of read/write accesses (def=1) -r<string> Register offset 10.92 pcimrd Command: pcimrd Description: Test an individual register. Test an individual register with a specified number of reads/writes. Syntax: pcimrd Options: -d<DEC>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Dump Tx BIST RAM 10.101 bertstats Command: bertstats Description: Dump PHY BIST statistics Syntax: bertstats 10.102 Command: rm Description: Read MII Registers Syntax: rm 10.103 mrloop Command: mrloop Description: loop on MII read. This is special test routine for MII read. It loops on MII register read util user abort or if value is zero.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide % = direct access of host memory in Byte/ASCII format (8) g = APE registers (32) p = APE Peripheral registers (32) u = APE UART registers (32) r = APE shared memory (32)
Page 133
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide $ = NVRAM (SEEPROM/FLASH) (32) m = MII registers (16) ~ = VPD Access (32) I = indirect access of host memory (32) ^ = internal scratchpad (32) l = direct access of host memory (32)
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide u = APE UART registers (32) r = APE shared memory (32) h = APE Scratchpad memory (32) M = 5717 APE Mutex registers (32) o = OTP registesr (32) 10.112 clearbit Command: clearbit Description: Read-Modify Memory by anded with ~<bits>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide p = APE Peripheral registers (32) u = APE UART registers (32) r = APE shared memory (32) h = APE Scratchpad memory (32) M = 5717 APE Mutex registers (32) o = OTP registesr (32) 10.113...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide g = APE registers (32) p = APE Peripheral registers (32) u = APE UART registers (32) r = APE shared memory (32) h = APE Scratchpad memory (32) M = 5717 APE Mutex registers (32) o = OTP registesr (32) 10.114...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Example: pciwr 2 1 0 8 9 : Write PCI device 1, function 0 on bus 2 with a 9. 10.118 vpdtest Command: vpdtest Description: Run VPD Memory Test. Write designed pattern toVPD storage. Then read back and compare with designed pattern.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -n<DEC> iteration (The default iteration is 1. 0 means run forever) 10.121 Command: msi Description: Run MSI Test Manually Syntax: msi Options: -c<HEX> message count (2 to powered of c) (def=00000003) option removed, kept for bcmediag compatibility initializing MSI block -o<DEC>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide a124b2 -- runs test a1,a2,a4 and b2 Options: run NVRAM verification also run IPSec loopback also -n<DEC> iteration Skip Bond Id verification 10.126 intrtest Command: intrtest Description: Interrupt Test Syntax: intrtest [iteration] Options: -n<DEC>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide teste ab cd -- Enables all tests -- Display enabled tests teste 10.131 testd Command: testd Description: The command disables tests. It affects nictest, regtest, pkttest, and memtest commands. The test must starts with test group alphabet (a-d). If no number is entered, all tests in that group are disabled.
Page 145
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide -h<DEC> Maxmum length (def=1024) -i<DEC> Number of transactions per pattern (def=10) -l<DEC> Minimum length (def=256) -n<DEC> iteration -o<DEC> Number of consecutive patterns (def=1) -p<DEC> DMA priority (def=0) -s<DEC> Start of test case (def=0) -t<DEC>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 80000000 00000000 ffffffff ffffffff ffffffff ffffffff 00000000 00000000 (repeat) ffffffff ffffffff 00000000 00000001 ffffffff ffffffff 00000000 00000002 ffffffff ffffffff 80000000 00000000 If you run bustest command without any parameters, it will perform DMA testing on all 260 patterns with 10 iterations per pattern and different data length in each iteration.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Options: Do not perform reset before test -r<DEC> repeat count for each register test (def=1) -n<DEC> iteration 10.140 petest Command: petest Description: Perform parity error test on a bridge Syntax: petest <bridge>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Disable the write DMA test Disable the chip reset execution before each DMA test -l<HEX> Number of BD sot DMA on read (0x1-0x79) (def=0xA) 10.146 binchksum Command: binchksum Description: Verify the checksum of each piece of firmware in the input file that contains a complete NVRAM image.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: Dump Content of MBUFs. The display command must be specified by -c option or 'chain', 'info', 'cluster', 'hdr', and 'ckhdr. Syntax: mbuf [chain|info|cluster|hdr|ckhdr] Options: -c<HEX> command 0 - displays a MBUF...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Allocate memory for optimization (i.e. DOS with EFI BIOS) Do not wait for link Force Link to Max Speed Show time stamp loadd driver without PHY access Example: 0:> loaddrv Reinitializing PCI Configuration Space...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.160 txmacsrc Command: txmacsrc Description: Program Source address to UUT Syntax: txmacsrc <xx:xx:xx:xx:xx:xx> 10.161 chklddrv Command: chklddrv Description: Check to see if driver is loaded. Returns 1 if driver is loaded, returns 0 otherwise.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.171 help Command: help Description: Enter command group for the list of available commands. If no parameter is entered, all commands are displayed. Example: help vpd. For each command help, type the command and then '?'.
Page 160
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Description: Configure diagnostics parameter for Memory tests and Manufacturing test (NIC test). Syntax: diagcfg Example: 0:> diagcfg Diagnostics Configuration Menu 1. Memory Test Configuration Menu 2. Test Configuration Menu 3. Driver Configuration Menu 4.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 1. Memory Test Configuration Menu 2. Test Configuration Menu 3. Driver Configuration Menu 4. Abort On Failure is enabled 5. Save Configuration Enter your choice or ESC to exit -> 10.181 reset...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.184 smbusrun Command: smbusrun Description: Using ‘smbusrun –mxxxxxx’ or smbusrun xxxxxx’ for master read/write. –xxxx is the message include the slave address. -for example, if slave address is -0x68, ‘smbusrun 681234’ write 1234 to slave.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Syntax: fillpattern [filename] Options: -e<HEX> (end address + 1) of the first block (def=00020000) -f<string> filename which contains data pattern -o<HEX> sram first block offset to be loaded (def=00000000) -s<HEX> sram second block offset to be loaded (def=00000000) 10.193...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide continue on error echo command -p<DEC> pause between each command. If a value is entered, it delays for # of ms (def=0) 10.196 txfill Command: txfill Description: Fill tx buffer with pattern and packet length (14-9018).
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.210 regrestore Command: regrestore Description: Restore register content from a file. This command may be used together with regdump to restore register got changed. Syntax: regrestore <filename> Options: PCI Config Reg. -f<string>...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 10.223 pechk Command: pechk Description: Check parity error on bridge. Defaults to current bridge. Syntax: pechk <bridge> 10.224 iscsiprg Command: iscsiprg Description: Program ISCSI firmware into NVRAM. This command reads ISCSI code from a file and program into NVRAM.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Running UMP Echo Test with test firmware Debug display of SRAM address 0xC00 Debug display of CPU code loading Debug prompt after CPU code loading Enable New UMP Echo Test in UMP Firmware Disable New UMP Echo Test in UMP Firmware 10.226...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Design Type 0: NIC 1: LOM Enable Phy Auto Power Down 0: No 1: Yes Reversed Nway 0: No 1: Yes Disable Power Saving 0: No 1: Yes Led Mode 0: Mac 1:Phy1 2:Phy2 3:S Traffic 4:Shasta Mac 5:Wireless Combo...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Options: Change the port to Docking mode Change the port to Laptop mode Enable E-switch functionality. Disable E-switch functionality. This option will prevent PHY loopback test, external loopback test (pkttest -e), and carrier test from being performed on both laptop mode and docking mode.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Syntax: sadbtest 10.250 sadbutil Command: sadbutil Description: Utilities for the Security Association Database (SADB) table. Valid only for IPSec supported devices. Syntax: sadbutil Options: -a<DEC> Add one SA entry (def=0) -d<DEC> Delete one SA entry (def=0) Delete all SA entries -u<DEC>...
Page 184
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide Get APE diagnostic firmware version Reset APE diagnostic interface Display APE diagnostic result string -G<DEC> Set APE GPIO output pin <0-6> -g<DEC> Clear APE GPIO output pin <0-6> write the file apediag.bin to scratchpad only.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 11 ERROR MESSAGES ERROR ID ERROR NO. ERROR STRING NO_ERROR ERR_IND_REG_ERR 1 Got XXXX @ XXXX. Expected XXXX ERR_CHIP_RUNNING 2 Cannot perform task while chip is running ERR_BAD_NIC 3 Invalid NIC device ERR_READ_ONLY_CLEAR 4 Read only bit X got changed after writing zero at offset XXXX.
Page 186
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide ERR_EEP_FMT 62 Invalid manufacture revision, expected X but found X ERR_EEP_BOOTVER 63 Invalid Boot Code revision, expected XXXX.XXXX but found XXXX.XXXX ERR_EEP_CANNOT_WRITE 64 Cannot write to NVRAM ERR_EEP_CANNOT_READ 65 Cannot read from NVRAM...
Page 187
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide ERR_DRIVER 127 Unsupported driver version VX.XX (need bcm57diag v9.0.0 or tg3d 3.66l or newer) ERR_TXDMA_OVERFLOW 128 TxDMA Overflow ERR_RXDMA_OVERFLOW 129 RxDMA Overflow ERR_DRIVER_BAD_STATUS 130 Driver returned error status=XXXX on ioctl=X ERR_INVALID_HANDLE 131 Invalid Handle...
Page 188
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide ERR_SADB_ENTRY 195 SADB Entry error at SA Indx XXXX with pattern <string> ERR_SADB_CORRUPT 196 SADB Data corrupted: Got XXXX at SADB index XXXX word index XXXX. Expected = XXXX ERR_SADB_DEL_ALL 197 SADB delete all error...
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide 12. TCL Environment Variables The B57diag utility provides numerous environment settings for users to develop their own testing and configuration scripts. Tcl environment variables are accessed using the syntax $::<array_name>(<array_idx>). 12.1 env This environment variable inherits the setting from DOS.
Page 191
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide $::nx1(FW_TYPE) – the type of the firmware residing in the selected device (e.g. “BC”, • “HWSB” , “SB” or “SBII”) $::nx1(FW_VER) – the version of the firmware residing in the selected device (e.g.
Broadcom NetXtreme Ethernet Adapter • Diagnostic User’s Guide $::nx1(UMP_VER) – the version of the UMP firmware residing in the selected device – • (NOT IMPLEMENTED) $::nx1(IPMI_VER) – the version of the IPMI firmware residing in the selected device • (e.g. 8.05) $::nx1(NCSI_VER) –...
Need help?
Do you have a question about the NetXtreme and is the answer not in the manual?
Questions and answers