===========

R E A D M E
===========
Broadcom Ethernet Controller WMI provider
Copyright (c) 2012 Broadcom Corporation
All rights reserved.
Table of Contents
----------------1.
2.
3.
4.
5.
6.
7.
8.
9.

Overview
Limitation
Files
Dependency
Installation
Implementation
Known Limitations
Troubleshooting
Third Party Software License

1. Overview
----------Broadcom ethernet controller WMI provider implements various DMTF
profiles to provide information about the device, and methods to
perform diagnostic tests, firmware update, as well as device
configuration. The provider currently conforms to the following
standards defined by DMTF:
Standard
Version
-----------------------------------------------Profile Registration Profile
1.0.0c
Ethernet Port Profile
1.0.0
Diagnostic Profile
1.0.0b
Host LAN Network Port Profile
1.0.0
Software Inventory Profile
1.0.0
Software Update Profile
1.0.0
DASH Standard
1.1
Simple Identity Management Profile
1.0.0
Role Based Authorization Profile
1.0.0
Opaque Management Data Profile
1.0.0

2. Limitation
------------The provider supports i386 architecture based CPU. The following is
the list of supported OS:
Windows
Windows
Windows
Windows
Windows

2003 GA-SP1 (32 bit and 64 bit)

2003 R2 (32 bit and 64 bit)
XP GA-SP2 (32 bit and 64 bit)
Vista (32 bit and 64 bit)
2008 (32 bit and 64 bit)

Please also refer to 'Dependency' section for more information.

3. Files
-------BnxWmiProvider.<version>.dll
bmapi.dll
libxml2.dll
libeasy32.dll
tcl83.dll
tcldde83.dll
tclpip83.dll
tclreg83.dll
BnxAdapter.mof
er related classes
BnxCDM.mof
es for Diagnostic Profile
BnxInterop.mof
es for Profile Registration Profile
BnxWmiProvier.mof
CIM_Core.mof
CIM_Device.mof
CIM_Interop.mof
CIM_Network.mof
CIM_Physical.mof
CIM_System.mof
CIM_System_Device.mof
CIM_User.mof
readme.txt
release.txt

BRCM CIM provider library

BMAPI share library
XML share library
OpenSSL share library
TCL library
TCL library
TCL library
TCL library
MOF file for Broadcom derived adapt
MOF file for Broadcom derived class
MOF file for Broadcom derived class
MOF file for class registration
MOF file for CIM Classes from DMTF
MOF file for CIM Classes from DMTF
MOF file for CIM Classes from DMTF
MOF file for CIM Classes from DMTF
MOF file for CIM Classes from DMTF
MOF file for CIM Classes from DMTF
MOF file for CIM Classes from DMTF
MOF file for CIM Classes from DMTF
this file
release information

4. Dependency
-----------------a. Broadcom network adapters running the following driver versions:
For 4401 devices:
driver version 3.46.
For NetXtreme devices: NDIS driver version >= 6.34.
For NetXtremeII devices: VBD driver version >= 2.5.2.
Please refer to README.TXT of the target driver for installation
instruction.
b. BMAPI
bmapi version >= 7.29.4.
c. OpenSSL
Refer to license information below.
d. TCL libraries
e. CIM Studio
This provider package is tested with CIM Studio.
5. Installation
--------------------

The provider can be manually installed/uninstalled in a command prompt.

For Windows Vista and above, you must open the command prompt with
"run as administrator".
5.1 Uninstall
1. CD to the path containing the provider files.
2. mofcomp BnxWmiProvider_Uninstall.mof
3. regsvr32 /u BnxWmiProvider.<version>.dll
5.2 Install
1. CD to the path containing the provider files.
2. mofcomp BnxWmiProvider.mof
3. regsvr32 BnxWmiProvider.<version>.dll
6. Implementation
-------------------6.1 Profile Registration Profile
For each implemented profile, there is an instance of RegisteredProfile descr
ibing
the profile name and version. The RegisteredProfile instance is associated to
the
corresponding ManagedElement through ElementConformsToProfile. RegisteredProf
ile
instances are instantiated in root/InterOp namespace in order to advertise th
e
availability of a conformant implementation of a profile. The rest of the cla
ss
instances are implemented in root/BrcmBnxNS namespace.
6.2 Ethernet Port Profile / Host LAN Network Port Profile
The provider implements Ethernet Port Profile (derived from Host LAN Network
Port
Profile) to model Broadcom adapter information.
6.3 Diagnostic Profile
The following Diagnostic tests are available:
Control Registers
MII Registers
EEPROM
Internal Memory
Interrupt
Loopback MAC
Loopback PHY
LEDs
CPU
Package Test
Some diagnostic may not be available to certain devices due to hardware limit
ation.
CIM_DiagnosticTest.RunDiagnostic() method is implemented to perform diagnosti
c on
the device represented by a BRCM_NetworkController instance referenced by the
ManagedElement parameter.
6.4 Software Inventory Profile
Broadcom device firmware, drivers, installers, management software, etc. are
represented by instances of CIM_SoftwareIdentity.

6.5 Software Update Profile

CIM_SoftwareInstallationService.InstallFromURI() method is implemented to sup
port
firmware upgrade for Broadcom Ethernet Controllers. This function takes the
following parameters:
1. URI - the URI corresponding to the new firmware image to be used.
2. Target - reference to the CIM_SoftwareIdentity corresponding to the
device and firmware to be upgraded.
3. InstallOptions - supports options "defer reset" (2), "force" (3),
"update" (5), "reboot" (7) and Broadcom specific
values 32768 and 32769.
4. InstallOptionsValues - if Broadcom specific values 32768 or 32769 are used
in
InstallOptions array, there should be an entry in
InstallOptionValues array with the same index of the Broa
dcom
specific value in the InstallOptions array.
e.g. if the 2nd entry of InstallOptions contains 32768, t
hen
the 2nd entry of InstallOptionsValue should contain an op
tion
string accordingly.
"-p" to upgrade iSCSI configuration program along with iS
CSI
firmware.
For iscsi firmware upgrade, the following 2 entries in InstallOptions/Install
OptionsValues
are supported:
InstallOptions
InstallOptionsValues
Required
Purpose
---------------------------------------------------------------------------------------------1. 32768
"-p"
No
upgrade iscs
i config program
along with i
scsi firmware
2. 32769
"ipv4", "ipv6", or "ipv4n6"
Yes
specify the
iscsi configuration
for the upgr
ade
If option 32769 and the corresponding value is not specified when upgrading i
scsi firmware,
InstallFromURI() method will return error.
6.6 DASH Standard 1.1
The provider conforms to DASH Standard 1.1 and implements Broadcom OOB Manage
ment
Service Profile is to manage DASH enabled devices, and supports IPv4/IPv6 set
ting info,
configuration of 802.1x, Active Directory, HTTP, HTTPS, HTTPS Client, RMCP, S
ecure RMCP,
and Web Server.
6.7 Role Based Authorization Profile
For DASH enabled devices, Role Based Authorization Profile is implemented to
support
show roles, show access, assign roles and modify role.
6.8 Simple Identity Management Profile
For DASH enabled devices, Simple Identity Management Profile is implemented t

o support
create account, modify account, delete account, and enable/disable account.
6.9 Opaque Management Data Profile
For DASH enabled devices, Opaque Management Data Profile is implemented to su
pport
create data, read/write data, assign access, and reassign ownership.

7. Known Limitations
---------------------No known limitation.
8. Troubleshooting
------------------Problem:

Cannot enumerate any BRCM classes

Possible cause: Provider software is not installed properly.

Solution:
Reinstall provider software and make sure the BnxWmiProvider,
BmapiObjServices, and BrcmUtil libraries are in the library
search path.
Possible cause: Bmapi library is not in the library search path, or the wrong
version of Bmapi library is installed.
Solution:
Make sure a supported version of Bmapi library is in the library
search path. Refer to Dependency section for supported versions
of Bmapi.
Problem:

No Broadcom devices are enumerated.

Possible cause: Device driver of supported version is not installed or not loade
d.
Solution:
Make sure the device driver is installed and loaded properly.
Ethtool should be able to enumerate the device if driver is inst
alled.
Refer to Dependency section for supported versions of device dri
vers.
Problem:

Only loopback tests fail while other tests pass.

Possible cause: Fad.sys and fadxp32.sys are required for MAC and physical loopba
ck
tests. These files are required to be in the search path.
Solution:
Make sure these 2 files provided in the installation are in the
search path.
Problem:

RunDiagnostic failed

Possible cause: Ran out of disk/memory space.

Solution:
Free up disk/memory space and try again.
Possible cause: No admin privileges to run the tests.

Solution:

Login as administrator and try again.

Possible cause: Device is already in diagnostic state.

Solution:
Wait until the current diagnostic to finish and try again.
If the problem can't be solved by any of the above, and it is persistent,
try using a different version of driver or software and repeat the test to
rule out the possibility of faulty software.
If the problem still persists, contact support personnel and ask for support.

9. Third Party Software License

-------------------------------Portions of this software contain third party code subject to the following cond
itions:
OpenSSL
/*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*

====================================================================
Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
3. All advertising materials mentioning features or use of this
software must display the following acknowledgment:
"This product includes software developed by the OpenSSL Project
for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
endorse or promote products derived from this software without
prior written permission. For written permission, please contact
openssl-core@openssl.org.
5. Products derived from this software may not be called "OpenSSL"
nor may "OpenSSL" appear in their names without prior written
permission of the OpenSSL Project.
6. Redistributions of any form whatsoever must retain the following
acknowledgment:
"This product includes software developed by the OpenSSL Project
for use in the OpenSSL Toolkit (http://www.openssl.org/)"
THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
* ====================================================================
*
* This product includes cryptographic software written by Eric Young
* (eay@cryptsoft.com). This product includes software written by Tim
* Hudson (tjh@cryptsoft.com).
*
*/
Original SSLeay License
----------------------/*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*

Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)

All rights reserved.
This package is an SSL implementation written
by Eric Young (eay@cryptsoft.com).
The implementation was written so as to conform with Netscapes SSL.
This library is free for commercial and non-commercial use as long as
the following conditions are aheared to. The following conditions
apply to all code found in this distribution, be it the RC4, RSA,
lhash, DES, etc., code; not just the SSL code. The SSL documentation
included with this distribution is covered by the same copyright terms
except that the holder is Tim Hudson (tjh@cryptsoft.com).
Copyright remains Eric Young's, and as such any Copyright notices in
the code are not to be removed.
If this package is used in a product, Eric Young should be given attribution
as the author of the parts of the library used.
This can be in the form of a textual message at program startup or
in documentation (online or textual) provided with the package.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
"This product includes cryptographic software written by
Eric Young (eay@cryptsoft.com)"
The word 'cryptographic' can be left out if the rouines from the library
being used are not cryptographic related :-).
4. If you include any Windows specific code (or a derivative thereof) from
the apps directory (application code) you must include an acknowledgement:
"This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE

* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* The licence and distribution terms for any publically available version or
* derivative of this code cannot be changed. i.e. this code cannot simply be
* copied and put under another distribution licence
* [including the GNU Public Licence.]
*/
Tcl/Tk License Terms
/* This software is copyrighted by the Regents of the University of California,
* Sun Microsystems, Inc., Scriptics Corporation, and other parties. The followi
ng
* terms apply to all files associated with the software unless explicitly discl
aimed
* in individual files.
*
* The authors hereby grant permission to use, copy, modify, distribute, and lic
ense
* this software and its documentation for any purpose, provided that existing c
opyright
* notices are retained in all copies and that this notice is included verbatim
in any
* distributions. No written agreement, license, or royalty fee is required for
any of
* the authorized uses. Modifications to this software may be copyrighted by the
ir authors
* and need not follow the licensing terms described here, provided that the new
terms
* are clearly indicated on the first page of each file where they apply.
*
* IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR DIRE
CT,
* INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE US
E OF
* THIS SOFTWARE, ITS DOCUMENTATION, OR ANY DERIVATIVES THEREOF, EVEN IF THE AUT
HORS
* HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS
IS"
* BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE MAINTEN
ANCE,
* SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
*
* GOVERNMENT USE: If you are acquiring this software on behalf of the U.S. gove
rnment,
* the Government shall have only "Restricted Rights" in the software and relate
d

* documentation as defined in the Federal Acquisition Regulations (FARs) in Cla

use
* 52.227.19 (c) (2). If you are acquiring the software on behalf of the Departm
ent of Defense,
* the software shall be classified as "Commercial Computer Software" and the Go
vernment
* shall have only "Restricted Rights" as defined in Clause 252.227-7013 (c) (1)
of DFARs.
* Notwithstanding the foregoing, the authors grant the U.S. Government and othe
rs acting
* in its behalf permission to use and distribute the software in accordance wit
h the terms
* specified in this license.
*/
License of libxml2
/* Except where otherwise noted in the source code (e.g. the files hash.c,
* list.c and the trio files, which are covered by a similar licence but
* with different Copyright notices) all the files are:
*
* Copyright (C) 1998-2003 Daniel Veillard. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is fur* nished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FIT* NESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* DANIEL VEILLARD BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CON* NECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* Except as contained in this notice, the name of Daniel Veillard shall not
* be used in advertising or otherwise to promote the sale, use or other deal* ings in this Software without prior written authorization from him.
*/