ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
1 / 8
Technical Description of DriveLoaderModule.INI
ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
1 / 8
Technical Description of DriveLoaderModule.INI
ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
2 / 8
1. Preface
This paper describes DriveLoaderModule.INI, which can be used to configure the system
software restoring process of the DriveLoader module version 2.21 or newer.
2. General
DriveLoader module version 2.21 is included in DriveWindow 2 version 2.21.
The configurable new version of the module is compatible with older versions. Thus older
DriveWindow 2 installations can be upgraded to use the new configurable version.
DriveLoaderModule.INI structure follows the industry standard. Thus it is an ASCII-file consisting
of sections that contain key-value pairs. The file should reside in the Windows folder.
If no DriveLoaderModule.INI exists (or it is empty), the configurable DriveLoader module behaves
exactly as older versions, i.e., the new drive operating system is not loaded into RAM of the drive
before restoring unless absolutely necessary.
By using the DriveLoaderModule.INI-file during the system software restoring process
DriveLoader module determines, whether to load the new drive operating system to drive RAM or
not, even if it is not absolutely necessary. It is also possible to deny restoring of some
combinations of system software versions in a drive and in a backup package.
The new DriveLoader module uses contents of SW_PACK*.TXT files both in the drive and in the
backup package to determine the action to be done. The contents are checked against the
match strings given in the DriveLoaderModule.INI-file. If there is no such a file, DriveLoader
module behaves as if one with empty content exists.
Beginning with DriveLoader module version 2.22, which is included in DriveWindow 2 version
2.22, it is possible to specify in DriveLoaderModule.INI the DDCS communication speed to be
used during system software backup and restore.
ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
3 / 8
3. Matching
The characters in match strings given in the DriveLoaderModule.INI-file are used in matching as
follows.
Character Matches
?
Any single character
*
Zero or more (any) characters
\?
?
\*
*
\\
\
\r
Carriage return (13)
\n
Line feed (10)
\f
Form feed (12)
\t
Horizontal tab (9)
0x01, 0x02, 0x7F, 0xFF
Skipped (cannot be used in matching)
0x00
Must not be used
Any other
Matches the character itself and, if matching is case
insensitive, the corresponding lower or upper case character
as well.
Note that matching is always done against the total content of a SW_PACK*.TXT file. So, a
match string typically begins and ends with an asterisk.
4. INI-file Content
There are three reserved section names in the INI-file:
•
[CommSpeed]
•
[RestoreDefaults]
•
[CurrentSW]
The first section (
[CommSpeed]
) is new in DriveLoaderModule version 2.22.
4.1. CommSpeed Section
The section defines minimum and maximum communication speeds in megabauds to be used
during system software backup and restore. Definitions are separate for NDPA-02 (or NISA-03)
and RUSB-02.
Note that although using high communication speed shortens the system software backup and
restore time, there is a risk of failure, which requires restarting the drive to recover the original
communication speed. So, do not use this feature unless you consider yourself a specialist.
Note also that RUSB-02 communication may actually slow down considerably with higher baud
rates. The reason is that on many platforms the Microsoft HID driver used in RUSB-02
communication begins to lose USB interrupts and falls back to polling.
If the current communication speed is between the specified minimum and maximum values,
communication speed is not changed during system software backup and restore.
ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
4 / 8
The following keys can be included in the
[CommSpeed]
section.
Key Type
Default
Description
MinBauds
integer
1
The minimum baudrate for system software
backup and restore for NDPA-02 (and NISA-
03).
MaxBauds
integer
8
The maximum baudrate for system software
backup and restore for NDPA-02 (and NISA-
03).
RUSBMinBauds
integer
1
The minimum baudrate for system software
backup and restore for RUSB-02.
RUSBMaxBauds
integer
8
The maximum baudrate for system software
backup and restore for RUSB-02.
The following are examples of backup and restore times of ASXR7320. Note that 8 MBaud
speed could not be used because it did not work reliably enough. Note also the serious slow
down in RUSB-02 with 4 MBaud speed. Time is in minutes-colon-seconds.
Device
Function
1 MBaud
2 MBauds
4 MBauds
8 MBauds
NDPA-02
Backup 3:12 2:16 2:16 n/a
NDPA-02
Restore 8:21 7:13 7:08 n/a
RUSB-02
Backup 8:28 7:24
29:55 n/a
RUSB-02
Restore 14:29 13:25 42:58 n/a
4.2. RestoreDefaults Section
The section defines some default values that take effect if not overridden by a match.
The following keys can be included in the
[RestoreDefaults]
section.
Key Type
Default
Description
LoadFluxToRAM
integer
0
0: The new drive operating system is loaded
to RAM only if absolutely necessary.
1: The new drive operating system is always
loaded to RAM.
Else: Restoring is denied.
MatchIsCaseSensitive
integer
0
If nonzero, case of the letters is meaningful
during matching.
4.3. CurrentSW Section
The section is used to determine the software currently in the Flash memory of the drive.
Determination is done by trying to match content of the SW_PACK*.TXT file in the Flash memory
against the
MatchCurrentSW
i
values listed in the section.
If no match is found, the default
LoadFluxToRAM
action is valid.
ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
5 / 8
The following keys can be included in the
[CurrentSW]
section.
Key Type
Description
MatchCurrentSW0
string
A match (wildcard) string.
NewSW0
string
Name of the section for determining the software in
the backup package.
LoadFluxToRAM0
integer
Empty or not given: the
LoadFluxToRAM
value given
in the
[RestoreDefaults]
section is used.
0: The new drive operating system is loaded to RAM
only if absolutely necessary.
1: The new drive operating system is always loaded
to RAM.
Else: Restoring is denied.
This can be overridden in the
NewSW0
section.
MatchIsCaseSensitive0
integer
Empty or not given: the
MatchIsCaseSensitive
value given in the
[RestoreDefaults]
section is
used.
0: case of the letters is not meaningful during this
match.
Nonzero: case of the letters is meaningful during this
match.
.
.
MatchCurrentSW
n
string
A match (wildcard) string.
NewSW
n
string
Name of the section for determining the software in
the backup package.
LoadFluxToRAM
n
integer
Empty or not given: the
LoadFluxToRAM
value given
in the
[RestoreDefaults]
section is used.
0: The new drive operating system is loaded to RAM
only if absolutely necessary.
1: The new drive operating system is always loaded
to RAM.
Else: Restoring is denied.
This can be overridden in the
NewSW0
section.
MatchIsCaseSensitive
n
integer
Empty or not given: the
MatchIsCaseSensitive
value given in the
[RestoreDefaults]
section is
used.
0: case of the letters is not meaningful during this
match.
Nonzero: case of the letters is meaningful during this
match.
Matching is done in order 0…n and terminates when the first match is found or the list is
exhausted. Note that the numbering must be consecutive without any missing numbers.
ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
6 / 8
If a match is found at i and there is a non-empty
NewSW
i
, the content of the SW_PACK*.TXT file
in the backup package is matched against
MatchNewSW
j
values listed in the section defined by
NewSW
i
.
Note that
LoadFluxToRAM
i
can be overridden in the
NewSW
i
section in case a match is found
there.
4.4. NewSW
i
Sections
The names of these sections are defined by
NewSW
i
values in the
[CurrentSW]
section.
This kind of section is used to determine the software in the backup package. Determination is
done by trying to match content of the SW_PACK*.TXT file in the package against the
MatchNewSW
j
values listed in the section.
If no match is found, the
LoadFluxToRAM
i
action defined by the match in the
[CurrentSW]
section is valid.
The following keys can be included in a
[<NewSW
i
>]
section.
Key Type
Description
MatchNewSW0
string
A match (wildcard) string.
LoadFluxToRAM0
integer
Empty or not given: the
LoadFluxToRAM
value defined by the match in the
[CurrentSW]
section is used.
0: The new drive operating system is
loaded to RAM only if absolutely
necessary.
1: The new drive operating system is
always loaded to RAM.
Else: Restoring is denied.
MatchIsCaseSensitive0
integer
Empty or not given: the
MatchIsCaseSensitive
value given in
the
[RestoreDefaults]
section is
used.
0: case of the letters is not meaningful
during this match.
Nonzero: case of the letters is meaningful
during this match.
.
.
ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
7 / 8
Key Type
Description
MatchNewSW
m
string
A match (wildcard) string.
LoadFluxToRAM
m
integer
Empty or not given: the
LoadFluxToRAM
i
value defined by the match in the
[CurrentSW]
section is used.
0: The new drive operating system is
loaded to RAM only if absolutely
necessary.
1: The new drive operating system is
always loaded to RAM.
Else: Restoring is denied.
MatchIsCaseSensitive
m
integer
Empty or not given: the
MatchIsCaseSensitive
value given in
the
[RestoreDefaults]
section is
used.
0: case of the letters is not meaningful
during this match.
Nonzero: case of the letters is meaningful
during this match.
Matching is done in order 0…m and terminates when the first match is found or the list is
exhausted. Note that the numbering must be consecutive without any missing numbers.
5. INI-file Example
Note that this example is made for demonstration purposes only.
Communication speed for NDPA-02 is at least 4 MBauds during system software backup and
restore. Other speeds have their default values, which are shown as comments (lines start with
semicolon). So, RUSB-02 speeds are never changed.
The following DriveLoaderModule.INI loads the new drive operating system to RAM before
restoring system software in case the current system software is meant for an RMIO board, its
version is not ASXR7270, ASXR7280, or ASXR729?, and the system software version in the
backup package is ASXR7270, ASXR7280, or ASXR729?.
If the current system software is meant for an RMIO board, but the system software in the
backup package is not, restoring is denied.
[CommSpeed]
MinBauds=4
;MinBauds=1
;MaxBauds=8
;RUSBMinBauds=1
;RUSBMaxBauds=8
[RestoreDefaults]
; The following is unnecessary because zero is the default
LoadFluxToRAM=0
; The following is unnecessary because zero is the default
MatchIsCaseSensitive=0
[CurrentSW]
MatchCurrentSW0=* RMIO * ASXR729? *
ABB Drives
DRIVELOADER MODULE
Technical Description
3AFE
00556549.DOC
Dept.
Project
AC DRIVES
Status Date
10.Sep 2008
Author
ERJANTI JYRKI
Status
APPROVED/ERJANTI JYRKI
Revision
B
Page
8 / 8
NewSW0=ASXR7270-729x
MatchCurrentSW1=* RMIO * ASXR7280 *
NewSW1=ASXR7270-729x
MatchCurrentSW2=* RMIO * ASXR7270 *
NewSW2=ASXR7270-729x
MatchCurrentSW3=* RMIO *
NewSW3=RMIO
LoadFluxToRAM3=2
[ASXR7270-729x]
MatchNewSW0=* RMIO *
LoadFluxToRAM0=0
MatchNewSW1=*
LoadFluxToRAM1=2
[RMIO]
MatchNewSW0=* RMIO * ASXR729? *
LoadFluxToRAM0=1
MatchNewSW1=* RMIO * ASXR7280 *
LoadFluxToRAM1=1
MatchNewSW2=* RMIO * ASXR7270 *
LoadFluxToRAM2=1
MatchNewSW3=* RMIO *
LoadFluxToRAM3=0