Ethernet POWERLINKXML Header for Firmware Files
Version 1.0.0

Ethernet POWERLINKXML Header for Firmware Files

Version 1.0.0©

B&R(B&R Industrial Automation GmbH)
2023

XML Header for Firmware Files V1.0.0-2-

B&R Industrial Automation GmbH

POWERLINK-Office
B&R Straße 15142 Eggelsberg
Austria

powerlink.office@br-automation.com
www.br-automation.com/en/technologies/powerlink/

The EPSG Technical Specification “Ethernet Powerlink XML Header for Firmware Files” has been
provided by Ethernet POWERLINK Standardisation Group (hereinafter referred to as “EPSG”). As aconsequence of the EPSG being dissolved from March 31st, 2023, B&R Industrial Automation GmbHwill – as the formal successor of EPSG regarding the rights and content – make the Ethernet
Powerlink XML Header for Firmware Files available as open source on it’s own website subject to theconditions mentioned in the disclaimer under clause Pre. 1 of this document. B&R IndustrialAutomation GmbH especially disclaims liability for any personal injury, property or other damage, of
any nature whatsoever, whether special, indirect, consequential, or compensatory, directly or indirectly
resulting from the publication, use of, or reliance upon this, or any other EPSG Standard document.

XML Header for Firmware Files V1.0.0

Pre. 1-3-Disclaimer

Use of this EPSG Standard is wholly voluntary. The EPSG disclaims liability for any personal injury,
property or other damage, of any nature whatsoever, whether special, indirect, consequential, orcompensatory, directly or indirectly resulting from the publication, use of, or reliance upon this, or any
other EPSG Standard document.
The EPSG does not warrant or represent the accuracy or content of the material contained herein,and expressly disclaims any express or implied warranty, including any implied warranty ofmerchantability or fitness for a specific purpose, or that the use of the material contained herein is freefrom patent infringement. EPSG Standards documents are supplied “AS IS”.
The existence of an EPSG Standard does not imply that there are no other ways to produce, test,measure, purchase, market, or provide other goods and services related to the scope of the EPSG
Standard. Furthermore, the viewpoint expressed at the time a standard is approved and issued issubject to change brought about through developments in the state of the art and comments received
from users of the standard. Users are cautioned to check to determine that they have the latest editionof any EPSG Standard.
In publishing and making this document available, the EPSG is not suggesting or rendering
professional or other services for, or on behalf of, any person or entity. Nor is the EPSG undertaking toperform any duty owed by any other person or entity to another. Any person utilizing this, and anyother EPSG Standards document, should rely upon the advice of a competent professional indetermining the exercise of reasonable care in any given circumstances.
Interpretations: Occasionally questions may arise regarding the meaning of portions of standards as
they relate to specific applications. When the need for interpretations is brought to the attention of theEPSG, the group will initiate action to prepare appropriate responses. Since EPSG Standards
represent a consensus of concerned interests, it is important to ensure that any interpretation has also
received the concurrence of a balance of interests. For this reason, the EPSG and its members are
not able to provide an instant response to interpretation requests except in those cases where thematter has previously received formal consideration.
Comments for revision of EPSG Standards are welcome from any interested party, regardless ofmembership affiliation with the EPSG. Suggestions for changes in documents should be in the form ofa proposed change of text, together with appropriate supporting comments. Comments on standards
and requests for interpretations should be sent to the address given on the page before.

Pre. 1.1

Patent noticeAttention is called to the possibility that implementation of this standard may require use of subject
matter covered by patent rights. By publication of this standard, no position is taken with respect to theexistence or validity of any patent rights in connection therewith. B&R shall not be responsible for
identifying patents for which a license may be required by an EPSG standard or for conducting
inquiries into the legal validity or scope of those patents that are brought to its attention.

XML Header for Firmware Files V1.0.0

Pre. 2-4-Contribution

The following persons contributed to this document:
Kirchmayer, Stephan, Editor
Prenninger, Franz

Bernecker + Rainer Industrie-Elektronik Ges.m.b.H.
Bernecker + Rainer Industrie-Elektronik Ges.m.b.H.

XML Header for Firmware Files V1.0.0

Pre. 3

History

Vers.
0.0.1
0.0.2
0.0.3
0.0.4
1.0.0

Author / Filename
Stephan Kirchmayer
Stephan Kirchmayer
Stephan Kirchmayer
Stephan Kirchmayer
Stephan Kirchmayer

Date2011-06-03
2011-11-07
2012-08-16
2021-04-02
2023-06-02

-5-

B&R
B&R
B&R
B&R
B&R

short description
createdFeedback from TWG meeting 10/11
Editorial changes
XML header example corrected© B&R due to dissolution of EPSG

XML Header for Firmware Files V1.0.0

Pre. 4-6-Content

Pre. 1
Disclaimer
Pre. 1.1
Patent noticePre. 2Contribution
Pre. 3
HistoryPre. 4
Content
Pre. 5
TablesPre. 6Figures
Pre. 7
Definitions and Abbreviations
Pre. 7.1
Definitions
Pre. 7.2
Abbreviations
Pre. 8References
1 Introduction
2 File naming convention
3 XML Header
3.1 File format
3.2 Header 1333456789991011121313

XML Header for Firmware Files V1.0.0

Pre. 5
Tab. 1-7-Tables
XML attributes

14

XML Header for Firmware Files V1.0.0

Pre. 6-8-Figures

Es wurden keine Einträge für das Inhaltsverzeichnis gefunden.
noneXML Header for Firmware Files V1.0.0-9-Pre. 7

Definitions and Abbreviations

Pre. 7.1

Definitions

none

Pre. 7.2

Abbreviations

SDO

Service Data Object

XDD

XML Device Description

XML Header for Firmware Files V1.0.0

Pre. 8[1]-10-

References

EPSG Draft Standard 301 (EPSG DS 301), Ethernet POWERLINK, Communication ProfileSpecification

XML Header for Firmware Files V1.0.01-11-Introduction

So far the communiction profile specification of POWERLINK only defines the mechanism fortransferring firmware / software files to a device. This is done by SDO transfer to object 1F50h.
However the communication profile does not specifiy the naming and identification of a firmware file.
All this is covered by this specification.
A firmware file complying with this specification may be assigned to a device easily just from its namecomprising the Vendor ID, device name and revision number. Inside the file a XML header contains
more detailed information.

XML Header for Firmware Files V1.0.02-12-File naming convention

The firmware file name shall be the same as the XDD file name. Additionally the revision number may
be added.
i.e. The file name shall have the format“vendorID”_”device name”<_”revision number”>.fw.
The vendor ID shall be in hex format without a leading “0x”. The device name shall not containspaces.
e.g. 0100006C_X20BC0083.fw or 010006C_X20BC0083_1.fw

XML Header for Firmware Files V1.0.0

3XML Header

3.1

File format-13-

A POWERLINK firmware file consists of a binary file prefixed by a header. This header is in XMLformat and terminated by a 0-byte (0-terminated).
<Firmware/>0-byte … (binary file)

Additional information is specified by XML attributes.

Header

3.2

A firmware file header always starts with the keyword<Firmware …

and shall contain the following attributes mentioned in Tab. 1
Attribute

Description

ExampleMandatory /optional

Datatype

Ven

Vendor ID

Ven=“0x0100006C“

mandatoryhexadecimal
8 digits plus 2
digits for “0x”

Dev

Device-ID = productcode
The same value as in
the IdentResponse
frame
Version number

Dev=”7966”

mandatory

decimalVer=”50”

mandatory

decimalUse

Usage
fixed value

Use=“fw“

mandatory-FctFunction
fixed value

Fct=”_”

mandatory-

Var

Variant = Revision
number
The same value as in
the IdentResponse
frame

Var=”1”mandatory

decimalLen

Length of the payload
data

Len=”23418”

mandatory

decimalChk

Checksum of thepayload data.

Chk=”0xaf3d”

optional

hexadecimal
4 digits plus 2
digits for “0x”

Mat

Order reference(ASCII text)

Mat=”X20BC0083”

mandatory

string, max. 18
characters

Date

File creation date

Date=”24.12.2011”

optional

string in format
dd.mm.yyyy

RemRemarks
Application software
date as defined in
EPSG DS301

Rem=”Testversion”

optional

ApplSwDate=”1000”

mandatory

stringUINT32(decimal)Ver

ApplSwDate

ApplSwTime

Application software
time as defined in
EPSG DS301

ApplSwTime=”10”

mandatory

UINT32(decimal)

KeepXmlHeader

If true, the firmware
download includes

KeepXmlHeader=”1”

optional

BOOL(1 character)

XML Header for Firmware Files V1.0.0-14-

this XML header
Tab. 1XML attributes

The checksum shall be calculated in the following way: All bytes of the binary data (i.e. XML header
not included) are added without overflow in a 16 bit value. From this sum the complement on two iscalculated (i.e. invert all bits and add 1).
The XML header shall be terminated by />0-byte followed by the payload data (binary file).
Example:<Firmware
Ven=”0x0100006C”
Dev=”7966”
Ver=”50”
Use=”fw”
Fct=”_”
Var=”1”
Len=”23418”
Chk=”0xaf3d”
Mat=”X20BC0083”
Date=”24.12.2011”
Rem=”Testversion”
ApplSwDate=”1000”
ApplSwTime=”10” KeepXmlHeader=”1”/>0-byte … (binary data of firmware file)