Technical Whitepaper HP Mac Address Manager · Technical Whitepaper HP Mac Address Manager...

Technical Whitepaper

HP Mac Address Manager

Whitepaper

January 09, 2020

For HP Business PC’s using HP Mac Address Manager

4AA7-6557ENW

HP MAC Address Manager

©Copyright 2019 HP Development Company, L.P. The information contained herein is

subject to change without notice.

2

Technical Whitepaper

Table of contents

1 Introduction ............................................................................................................ 3

2 Acronyms ............................................................................................................... 4

3 Support ................................................................................................................... 5

3.1 Supported HP Platforms ................................................................................................................. 5

3.2 OS Support ..................................................................................................................................... 6

3.3 Language Support ........................................................................................................................... 6

4 BIOS ....................................................................................................................... 7

4.1 BIOS location and storage .............................................................................................................. 7

4.2 MAC Address format ....................................................................................................................... 8

4.3 BIOS Parameter Configuration ................................................................................................. 8-10

4.4 BIOS configuration and status interface for MS Windows ............................................................ 11

4.5 BIOS BCU HBMA sample ............................................................................................................ 11

5 MAC Address ....................................................................................................... 12

5.1 Host based MAC Addressing (HBMA) .......................................................................................... 12

5.2 Usage cases ................................................................................................................................ 12




1 Introduction 3

1 Introduction

This Document provides detailed information about HP Mac Address Manager.

HP Mac Address Manager version 1.1.19.1 released April 22, 2019 will provide users

with additional value and create product differentiation. Customers who manage their

assets (laptops) via MAC address will have issues if MAC addresses are not unique to

the platform. Starting on 2020 HP Commercial Notebooks, HP Mac Address Manager

will now be a web only application. The web only feature will not be backwards

compatible.




2 Acronyms 4

2 Acronyms

Throughout this documentation certain acronyms are used which may require more clarification.

OS Operating System

BCU BIOS Configuration Utility

MPM Manufacturing Program Mode

HBMA Host Based Mac Address

WMI Windows Management

Infrastructure

BIOS Basic Input\Output System

LAN Local Area Network

WLAN Wireless Local Area Network

API Application Programming

Mode

MAC Media Access Control

OEM Original Equipment

Manufacturer

UEFI Unified Extensible Firmware

Interface




3 Support 5

3 Support

3.1 Supported HP platforms

HP Elite x2 1012 G2

HP ELITEBOOK 1040 G4


HP ELITEBOOK X360 1030 G2

HP Pro x2 612 G2, HP PRO X2 612 G2 WITH

COLLABORATION KEYBOARD

HP ELITEBOOK 725 G4

HP ZBOOK 17 G6 MOBILE


HP ProBook x360 11 G3 Education Edition

HP ProBook x360 11 G4 Education Edition





HP Engage Go Mobile System

HP ELITEBOOK 830 G6

HP ELITEBOOK 836 G6

HP PROBOOK 640 G4

HP PROBOOK 650 G4

HP PROBOOK 640 G5

HP PROBOOK 650 G5

HP ELITEBOOK 840 G5

HP ELITEBOOK 846 G5

HP ELITEBOOK 850 G5

HP ZBOOK U G5 MOBILE

HP ZBOOK 15U G5 MOBILE

HP ELITEBOOK 840 G6

HP ELITEBOOK 846 G6

HP ELITEBOOK 850 G6

HP ZBOOK U G6 MOBILE

HP ZBOOK 15U G6 MOBILE

HP ELITEBOOK 840 G6 HEALTHCARE EDITION


HP ELITEBOOK 840R G4

HP ELITEBOOK 846R G4

HP ZBOOK X2 G4 DETACHABLE

HP Elite Dragonfly



HP ELITEBOOK 735 G6

HP ELITEBOOK 735 G5

HP ELITE X2 1013 G3

HP Elite x2 G4



HP PROBOOK 445R G6

HP PROBOOK 455R G6

HP PROBOOK 455 G5

HP PROBOOK 455 G5

HP PROBOOK 445 G6

HP PROBOOK 455 G6

HP PROBOOK 440 G6

HP ZHAN 66 PRO G1

HP ZHAN 66 PRO G1

HP PROBOOK 440 G5

HP PROBOOK 470 G5

HP PROBOOK 440 G7

HP PROBOOK 450 G7

HP PROBOOK 430 G6

HP ZHAN 66 PRO 13 G2



HP PROBOOK 450 G6

HP PROBOOK 430 G7

HP PROBOOK 430 G5

HP PROBOOK 450 G5

HP PROBOOK X360 440 G1

HP ZHAN X 13 G2

HP ELITEBOOK 830 G5

HP ELITEBOOK 836 G5



HP ELITEBOOK 745 G6

HP PROBOOK 645 G4

HP ELITEBOOK 745 G5

HP ELITEBOOK 755 G5




HP ZBOOK STUDIO G4 MOBILE

HP ZBOOK STUDIO G5 CONVERTIBLE


HP ZBOOK STUDIO G5 CONVERTIBLE





3 Support 6

3.2 OS Support

Supported OS.

WT32_1507 WT64_1507 WTIOT32

WT32_1511 WT64_1511 WTIOT64

WT32_1607 WT64_1607 WTIOT64_1607

WT32_1703 WT64_1703 WTIOT64_1809

WT32_1709 WT64_1709

WT32_1803 WT64_1803

WT32_1809 WT64_1809

WT32_1903 WT64_1903

WT64_1909

3.3 Language Support

CODE LANGUAGE

US English - United States

BR Portuguese - Brazil

DE Deutsch - Germany

ES Spanish - Spain

FR French - France

IT Italian - Italy

JA Japanese - Japan

KO Korean - Korea

RU Russian – Russia

zh-Hans Chinese (Simplified)

zh-Hant Chinese (Traditional)

zh-HK

Chinese (Traditional) for Hong

Kong




4.2 MAC Address format 7

4 BIOS

4.1 BIOS location and storage

Factory will store a unique MAC address on each host platform. Leveraging the same existing factory process used to reserve and acquire MAC address for embedded notebook NICs. The HBMA MAC address will be different then the embedded MAC address on the platform. The HBMA address may be from a completely different range or might be the embedded address +1, the exact implementation may be specific to each OEM, the important distinction is that HBMA and embedded NIC do not share the same stored addresses. As described in section 4.2, because MS Windows® asserts certain MAC address format limits on their APIs, two similar but not identical MAC address will be stored in BIOS (Factory and SYSTEM). The Factory and System Address MAC address should be stored in the BIOS variable service region. The factory and system MAC variables need to be protected and locked when MPM is locked. The factory and system MAC addresses are identical. We will use the BCU to set both addresses in the factory, allowing us to preserve a unique identifier on the system for future use. The HBMA Factory and System MAC parameter should also be added to the white screen (lockout) feature. Once written the Factory and System HBMA MAC addresses should not be able to be deleted or overridden by typical users without specific BIOS tools. In addition, any update in BIOS versions should not alter or delete the MAC address, it must remain intact and preserved.

The Custom address is not protected and is reset to 00-00-00-00-00 after restoring the defaults. The ability to flash the address should be included as part of the BCU tool and available via F10 setup as well.

BIOS Location for HBMA addresses location Size

0xTBD Factory 6 Bytes (i.e. 12-22-33-44-55-66)

0xTBD System 6 Bytes (i.e. 12-22-33-44-55-66)

0xTBD Custom 6 Bytes (i.e. 14-88-77-66-55-44)




4.2 MAC Address format 8

4.2 MAC Address format The IEC standards body (IEC 10039) have defined the format of the MAC address. The Factory, System and Custom

MAC addresses are required to have the second byte either 0, 2, 4, 6, 8, A, C, or E. To accommodate for this format,

BIOS should error check during each write, to ensure that the second byte is either 0, 2, 4, 6, 8, A, C, or E. Exposed

to F10 configuration page.

• Factory MAC address – Accessible via WMI. Read access via public WMI. Write access only with MBM mode enabled.

• System MAC address – Accessible via WMI. Read access via public WMI. Write access only with MBM mode enabled.

• Custom MAC address – Accessible via WMI. Read and Write access via public WMI. Exposed to F10 configuration page.

BIOS Location for HBMA addresses location

Stored/Written Example Limits

0xTBD Factory xy-xx-xx-xx-xx-xx C4-22-33-44-55-66 x=0-9, a-f; y=0,2,4,6,8,a,c,e

0xTBD System xy-xx-xx-xx-xx-xx C4-22-33-44-55-66 x=0-9, a-f; y=0,2,4,6,8,a,c,e

0xTBD Custom xy-xx-xx-xx-xx-xx C8-22-33-44-55-66 x=0-9, a-f; y=0,2,4,6,8,a,c,e

MAC Address Format Check: BIOS shall check the format of the MAC addresses being written into the memory storage as in table above and described below.

• For System location, Bytes 1, and 3-12 shall be hexadecimal (0-9,a-f, A-F), byte 2 shall be 0, 2, 4, 6, 8, A, C, or E.

• For Factory location, Bytes 1, and 3-12 shall be hexadecimal (0-9,a-f, A-F), byte 2 shall be 0, 2, 4, 6, 8, A, C, or E.

• For Custom location, Bytes 1, and 3-12 shall be hexadecimal (0-9,a-f, A-F), byte 2 shall be 0, 2, 4, 6, 8, A, C, or E.

BCU shall trigger an error code when parameter being written is not matching the format. F10 configuration page shall provide error dialog, when incorrect format is attempted.

4.3 BIOS parameter configuration

BIOS should setup several interfaces for configuration purposes. The address modification and HBMA settings

should be available for management via existing BIOS tools (BCU). In addition, these settings should be available for

other OS’s such as MS Windows® via WMI (or similar) so the HBMA MS Windows® software component can have

access to these same settings.

HBMA Enable /Disable – A setting should Enable/Disable using HBMA on the system. Disabled is the default setting,

when disabled the HBMA custom and SYSTEM addresses should be grayed out and unavailable for configuration.

Address modification – The Custom MAC address should be available to the user to customize as needed. On a

restore default BIOS event the “Custom” address should be reset to all 0’s.

Prioritization Device List – HBMA is capable of being used with several NIC devices. A single list should be provided,

per supported device, that sets the prioritization of HBMA association/configuration to a specific NIC device. The list

should also allow for enable HBMA or Disable HBMA on that device as well. As mentioned above in the usage

models, multiple NICs may be active on a system at any given time, and they cannot share the HBMA address

simultaneously, therefore the prioritization list enables the user to choose which NIC should be configured with the

HBMA address when multiple NICs are simultaneously active. This list is similar in operation as the existing F10 boot

device menu, where devices can be slid up/down the list in order to give precedence to a device with HBMA. In

addition to the list ordering, the same list should allow a user to enable/disable HBMA association with each

supported device. This would allow a user to specify which of the supported NIC devices should be enabled for




9

HBMA configuration. For example, a user could assert and want HBMA to function only on dongles and docks

devices but may not want the embedded NIC to be configured with HBMA. See below image.

Disable all other HBMA adapters setting – This setting would allow the user to disable all other HBMA adapters

whenever one of the adapters is configured. This would force the other adapters to be disabled by Software, which

means that only a single adapter will be allowed to be active on the network at any one time. Similar to WLAN/LAN

switching, forcing other network adapters to be disabled anytime a single adapter is enabled and configured with the

HBMA address. The setting is in BIOS, but the actual functionality is accomplished via Software.

BIOS will be provided a table similar to below that provides the supported NIC devices for each specified platform.

BIOS should display all the external devices listed within the platform specific table. BIOS should display only the

embedded NIC that is currently installed in the unit. External devices that are listed in BIOS, may not necessarily be

currently installed on the system, but should still be displayed nonetheless in the HBMA setup page.

Device Type Friendly Device Name Vendor ID Device ID

Subsyste

m Vendor

ID

Subsystem

Device ID

Embedded NIC

Intel® N219V NIC

Adaptor 0x8086 0x423B 0x8086 0x1011

Type C USB dock

Broadcom 5762 NIC

Adapter 0xE4 0x432B

Type C USB dongle Realtek RTK8153 NIC

Adapter 0x10EC 0x2334

Type C USB dongle Broadcom 57762 NIC

Adapter 0x14E4 0x4353

Type C USB dongle

DisplayLink 3900 NIC

Adapter 0x168C 0x002B

PXE and MS Windows Selections – The HBMA feature should be configurable for both PXE and MS Windows®. If

PXE is chosen, then BIOS configures the HBMA address during PXE execution onto the PXE NIC driver. If HBMA

MS Windows® support is chosen, then the HBMA address is provided via a WMI call (or similar query).

PXE should follow the boot order. Every HBMA supported NIC should show up in the boot order listing. BIOS to

ensure that every PXE boot attempt will be asserted with an HBMA address, and also that every failed PXE boot will

be revoke/reset during a PXE failure.

MS Windows® follows the HBMA priority list.




10

Default is SYSTEM. Once custom is set, then custom MAC address becomes the default HBMA address used by

PXE.

By default, the custom address is empty. When custom is selected, then user will be provided a text box to fill in the

MAC address. If user writes blank entry to this, it will clear the custom address, and factory will be the default again.

BIOS should check for the correct format of MAC address (Bytes 1, 3-12 should be Hexadecimal, 0-9 a-f, A-F, no

other characters; Byte 2 should be 2, 6, A or E).




4.4 BIOS configuration and status interface for MS Windows® 11

4.4 BIOS configuration and status interface for MS Windows® BIOS should make available via a public WMI interface for all the status of the HBMA settings.

The interface is mainly needed for the MS Windows® HBMA software component, so that the configuration status

from within F10 can be forwarded and utilized by the HBMA software component.

4.5 BIOS BCU HBMA sample BIOS should make available BCU settings so that certain field/addresses and HBMA parameters can be configured. Refer to sample below

Host Based MAC Address *Disable System Custom

HBMA Factory MAC Address 00-00-00-00-00-00

HBMA System MAC Address 00-00-00-00-00-00

HBMA Custom MAC Address 00-00-00-00-00-00

Pre-boot HBMA Support Disable *Enable

MS Windows® HBMA Support Disable *Enable

Single NIC Operation (Disable All Other NICs when HBMA is active on one NIC) *Disable Enable

HBMA Priority List USB NIC Dongle: Realtek RTL8153H:0BDA_8153 Embedded NIC: Realtek RTL8111HSH:10EC_8168:103C_8234 (Disabled)

Note: 1. HBMA Factory MAC Address and HBMA Custom MAC Address is 34-byte Unicode with “-” 2. Priority List Format: PCI device: {Device Type}: {Friendly Name}: {VID_DID}: {SVID_SDID} USB device: {Device Type}: {Friendly Name}: {VID_PID}




5.1 Host Based MAC Addressing (HBMA) 12

5 MAC Address

5.1 Host Based MAC Addressing (HBMA)

A MAC address will be stored (programmed/flashed) within the system BIOS at the factory and will be accessible to external NIC devices. Optionally, there can also be a user defined “custom” MAC address that would then be used as the HBMA address. When an external NIC device (dongle or dock) is installed on the system, it will query for the “host based” MAC address (HBMA) and will then override the external MAC address embedded on the device itself. There are also usage cases, in which the integrated NIC might be configured to utilize the HBMA address as well.

The basic overview is seen in flow chart below. A factory process stores a platform unique Host Based MAC address (HBMA) into BIOS. BIOS configures (PXE) or exposes (MS Windows®) the HBMA address to the operating system (PXE or MS Windows®). The UEFI (PXE) or MS Windows® Software then take the HBMA address and configure the appropriate NIC adapter with a platform specific (HBMA) MAC address.

5.2 Usage cases There are many usage cases in which customers want to have a single MAC address exposed to the network for system identification purposes for both management and security purposes.

The use of HBMA also spans across multiple NIC Hardware architectures.

External NIC Devices: The main intent of HBMA, is to provide external NICs that are not embedded on the platform, a platform unique MAC address that can be uniquely identified as originating from a specific platform. Examples of such devices are external dongle accessories and/or external dock accessories.

Embedded NIC Devices: There are also certain use cases in which the embedded NIC device may need to utilize the HBMA address, even though the embedded NIC device already has a platform unique MAC address (since it is soldered down on motherboard), however the HBMA may still be desired as a way to provide a unique single MAC address for all NIC devices on the system no matter the NIC interface that is chosen (Embedded, Dongle or Dock).

The use of HBMA also spans across multiple OS configurations.

PXE Operating Systems: HBMA is being developed to support PXE environments, to enable customers to uniquely image systems using PXE, especially for those systems that do not have a dedicated embedded NIC (i.e. tablets). These tablet systems typically have external NIC dongles or docks to connect to the PXE network. In this usage case the HBMA feature allows for a NIC dongle or external dock to utilize the platforms host-based MAC address, and thereby allow the PXE network to uniquely identify and manage the PXE image based on the attached system.

MS Windows® Operating System: Customers who manage their assets (laptops) via MAC address will have issues if MAC addresses are not unique to the platform. Many current and future dock architectures have integrated NICs within the dock itself, therefore these MAC addresses are not uniquely associated with a specific platform. In the floating workplace environments in which docks are used, and those docks are not specifically assigned to a single user, it is impossible to uniquely track and/or manage the user based on MAC address. HBMA solves this issue, by providing a unique platform MAC address to network for device drivers that are updated to support this HBMA protocol.

Note: Currently only PXE and MS Windows® are targeted, no plans for FreeDOS, WinPE or Linux® are planned.

Technical Whitepaper HP Mac Address Manager · Technical Whitepaper HP Mac Address Manager...

Documents

Transcript of Technical Whitepaper HP Mac Address Manager · Technical Whitepaper HP Mac Address Manager...