Upgrading Field-Programmable Devices

Table Of Contents

Upgrading Field-Programmable Devices

Overview of SPA FPD Image Upgrade Support

Upgrading SPA FPD Images

Verifying SPA FPD Image Compatibility

SPA FPD Image Upgrade

SPA FPD Image Upgrade Task List

SPA FPD Image Upgrade Example

Troubleshooting Problems with SPA FPD Image Upgrades

Power Failure or Removal of a SPA During an FPD Image Upgrade

FPD Command Summary

Upgrading Field-Programmable Devices

In general terms, field-programmable devices (FPDs) are hardware devices implemented on router cards that support separate software upgrades. A field-programmable gate array (FPGA) is a type of programmable memory device that exists on most hardware components of a Cisco XR 12000 Series Router. The term "FPD" has been introduced to collectively and generically describe any type of programmable hardware device on SPAs, including FPGAs. Cisco IOS XR software Release 3.2 introduces the Cisco FPD upgrade feature to manage the upgrade of FPD images on SPAs.

This chapter describes the information that you need to know to verify image versions and to perform an upgrade for SPA FPD images when incompatibilities arise.

This chapter includes the following sections:

• Overview of SPA FPD Image Upgrade Support

• Upgrading SPA FPD Images

• Troubleshooting Problems with SPA FPD Image Upgrades

• FPD Command Summary

Overview of SPA FPD Image Upgrade Support

FPGA versions must be compatible with the Cisco IOS XR software that is running on the router; if an incompatibility exists between an FPGA version and the Cisco IOS XR software, the device with the FPGA will not operate properly until the incompatibility is resolved.

The Cisco XR 12000 Series Router supports upgrades for FPGA devices on its SPAs. FPGA software upgrades are part of an FPD image package that corresponds to a Cisco IOS XR software image. The SPA supports manual upgrades for its FPGA device using the Cisco FPD upgrade feature that is further described in this chapter.

Upgrading SPA FPD Images

This section describes information about SPA FPD image packages and the tasks to perform an FPD image upgrade on a SPA, for upgrading the software for an FPGA device or other FPDs. This section includes the following topics:

• Verifying SPA FPD Image Compatibility

• SPA FPD Image Upgrade

• SPA FPD Image Upgrade Task List

• SPA FPD Image Upgrade Example

Verifying SPA FPD Image Compatibility

An up-to-date SPA FPD image is required to properly run any SPA. The FPD image on each SPA must be compatible with the Cisco IOS XR software release that is running on the router of the installed SPA. If an incompatibility exists between the FPD image on the SPA and the Cisco IOS XR software release on the router, the SPA will be disabled until the incompatibility is addressed.

An FPD image package is used to upgrade FPD images. Whenever a Cisco IOS XR software image is released that supports SPAs, a companion SPA FPD image package is bundled with the Cisco IOS XR software release. However, the FPD image is not automatically upgraded unless you manually issue the upgrade command.

You can use the following show commands to monitor information related to SPA FPD images and determine if an FPD upgrade is required:

•show hw-module fpd— Displaying Current and Minimum Required FPD Image Versions

•show fpd packages— Displaying Information About the FPD Image Package

Displaying Current and Minimum Required FPD Image Versions

To display the current version of FPD images on the SPAs installed on your router, use the show hw-module fpd location [all | node-id] command, where node-id is the location of the SPA in the rack/slot/module notation.

Note This command can be used to identify information about FPDs on any SPA. If you enter the location of a line card that is not a SPA, the output displays information about any programmable devices on that line card.

The following examples show the output when using this command.

The output display in this example shows that FPD versions on the SPA in the system do not meet the minimum requirements. The output contains a "NOTES" section that states how to upgrade the SPA's FPD image.

RP/0/0/CPU0:ios# show hw-module fpd location all

=============================== ================================================
Existing Field Programmable Devices
================================================
Current SW HW Upg/
Location Card Type Type Subtype Inst Version Version Dng?
============ ======================== ==== ======= ==== =========== ======= ====
0/2/CPU0 Jacket Card lc fpga 0 0.1 0.34 Yes
--------------------------------------------------------------------------------
0/2/0 SPA-8X1GE spa fpga 0 0.16 1.0 Yes
--------------------------------------------------------------------------------
0/2/4 SPA-4XOC3POS spa fpga 4 3.4 1.0 Yes
--------------------------------------------------------------------------------
0/2/1 SPA-4XOC3POS spa fpga 1 3.4 1.0 Yes
--------------------------------------------------------------------------------
0/2/3 SPA-OC192POS-XFP spa fpga 3 1.2 2.1 Yes
--------------------------------------------------------------------------------
0/3/CPU0 Jacket Card lc fpga 0 0.1 0.34 Yes
--------------------------------------------------------------------------------
0/3/1 SPA-8X1GE spa fpga 1 0.16 1.0 Yes
--------------------------------------------------------------------------------
NOTES:
1. One or more FPD needs an upgrade or a downgrade. This can be accomplished
using the "admin upgrade hw-module fpd" CLI.

Table 7-1 describes the significant fields shown in the display.

Table 7-1 show hw-module fpd Field Descriptions

Field

Description

Location

Location of the module in the rack/slot/module notation.

Card Type

Module part number.

Type

Hardware type can be: spa—shared port adapter; lc—line card.

Subtype

FPD type can be: fabldr—fabric downloader; fpga—field-programmable gate array; rommon—read-only memory monitor

Inst

Instance—A unique identifier that is used by the FPD process to register an FPD.

Current SW Version

Currently running FPD image version.

Min Req HW Vers

Minimum required hardware version for the associated FPD image.

Upg/Dng

Specifies whether an FPD upgrade or downgrade is required. A downgrade will be required in rare cases when the version of the FPD image has a higher major revision than the version of the FPD image in the current Cisco IOS XR software package.

Displaying Information About the FPD Image Package

You can use the show fpd package command to find out which SPAs are supported with your current Cisco IOS XR software release, which FPD image package you need for each SPA and what the minimum hardware requirements are for the SPA modules.

RP/0/0/CPU0:ios(admin)# show fpd package

=============================== ================================================
Field Programmable Device Package
================================================
SW Min Req
Card Type FPD Description Type Subtype Version HW Vers
==================== ========================== ==== ======= =========== =======
Jacket Card SPA FPGA swv13 lc fpga 0.13 0.0
--------------------------------------------------------------------------------
SPA-4XOC3POS SPA FPGA swv13 spa fpga 0.13 0.0
SPA FPGA swv13 hwv2 spa fpga 0.13 2.0
--------------------------------------------------------------------------------
SPA-OC192POS-XFP SPA FPGA swv13 spa fpga 0.13 0.0
SPA FPGA swv13 hwv2 spa fpga 0.13 2.0
--------------------------------------------------------------------------------
SPA-8X1GE SPA FPGA swv1.8 spa fpga 1.8 0.0
--------------------------------------------------------------------------------

Table 7-2 describes the significant fields shown in the display.

Table 7-2 show fpd package Field Descriptions

Field

Description

Card Type

Module part number.

FPD Description

Description of all FPD images available for the SPA.

Type

Hardware type can be: spa—shared port adapter; lc—line card.

Subtype

FPD type can be: fabldr—fabric downloader; fpga—field-programmable gate array; rommon—read-only memory monitor

SW Version

FPD software version required for the associated module running the current Cisco IOS XR software.

Min Req HW Vers

Minimum required hardware version for the associated FPD image.

SPA FPD Image Upgrade

To determine which FPD images on a SPA require an upgrade, the system compares the current FPD image version for each individual SPA in the router with the minimum required FPD version required by the current Cisco IOS software release. An FPD upgrade is required if at least one FPD image on one of the SPAs in the router does not meet the minimum version requirements for that particular Cisco IOS XR software image.

Typical reasons to upgrade FPD images include:

•Migrating to a newer Cisco IOS XR software release

After you migrate to a new Cisco IOS XR software release, the system notifies you to if it is necessary to perform an upgrade.

•Swapping SPAs

If you are swapping SPAs from another platform or from the same platform that is running a different Cisco IOS XR software release, the system notifies you to if it is necessary to perform an upgrade.

•Inserting a new SPA

SPA FPD Image Upgrade Task List

This section describes the guidelines and tasks to perform an FPD image upgrade on a SPA for FPGA version upgrades, or other supported FPD version upgrades. This section includes the following topics:

• SPA FPD Image Upgrade Guidelines

• Upgrading FPD Images for SPAs in a Production System

• Upgrading SPA FPD Images

SPA FPD Image Upgrade Guidelines

•The SPA will probably be in the FAILED state if you do not have the required FPD image downloaded on it.

•Upgrading the FPD image on a SPA places the SPA offline and interrupts traffic. An image upgrade requires approximately 30 seconds to complete depending on the SPA.

Upgrading FPD Images for SPAs in a Production System

When the FPD image is upgraded on the SPA, the SPA is shutdown and traffic through the SPA interfaces is rerouted. Therefore some packets may get dropped if the upgrade is performed on a production system. The performance impact will vary depending on the type of processing engine used and the type of service configured.

Because of the potential problems, we highly recommend that one of the following alternatives be used to perform the upgrade if possible.

•Upgrade the FPD image on SPAs on a non-production system that is running the same Cisco IOS XR software image that you are running on the production system that the SPAs will be inserted into.

•Upgrade the FPD image on SPAs during a maintenance window when there is no traffic passing through the system.

If you are not sure whether the SPA requires an FPD upgrade, you can install the SPA and use the show hw-module fpd command to determine if the FPD image on the SPA is compatible with the currently running Cisco IOS XR software release.

Upgrading SPA FPD Images

To upgrade the current FPD version on a SPA card, use the following command in admin EXEC mode:

upgrade hw-module fpd {all | fpga} [force] location [all | node-id]

The node-id refers to the location of the module in the rack/slot/module notation. Currently only the FPGA image can be upgraded on your SPA. If the SPA you want to upgrade is already in the shutdown state, then you must use the force option to upgrade it. You can also use the force option to perform the upgrade even if there is no image version incompatibility.

Caution Upgrading the FPD image on a SPA places the SPA offline and interrupts traffic. An image upgrade can require 30 seconds or longer to complete depending on the SPA.

SPA FPD Image Upgrade Example

The following example displays the output from the upgrade hw-module fpd command:

RP/0/0/CPU0:ios(admin)# upgrade hw-module fpd fpga force location 0/3/1
SP/0/3/SP:Feb 25 17:13:21.349 : upgrade_daemon[124]: Start Upgrade...
SP/0/3/SP:Feb 25 17:13:21.356 : upgrade_daemon[124]: programming...with file /net/node0_RP1_CPU0/hfr-lc-3.2.80/fpd/ucode/espam_damselfly_isp1.xsvf
SP/0/3/SP:Feb 25 17:13:22.925 : upgrade_daemon[124]: ...continue programming...
SP/0/3/SP:Feb 25 17:13:22.931 : upgrade_daemon[124]: ...it will take a while...
SP/0/3/SP:Feb 25 17:13:23.029 : upgrade_daemon[124]: ...it does take a while...
SP/0/3/SP:Feb 25 17:13:48.286 : upgrade_daemon[124]: ...continue programming...
SP/0/3/SP:Feb 25 17:13:48.292 : upgrade_daemon[124]: ...it will take a while...
SP/0/3/SP:Feb 25 17:13:48.314 : upgrade_daemon[124]: almost...done
Successfully upgraded spa fpga instance 1 on location 0/3/1.

Troubleshooting Problems with SPA FPD Image Upgrades

This section contains information to help troubleshoot problems that can occur during the upgrade process.

Power Failure or Removal of a SPA During an FPD Image Upgrade

If the FPD upgrade operation is interrupted by a power failure or the removal of the SPA, it could corrupt the FPD image. This corruption of the FPD image file makes the SPA unusable by the router and the system will display the following messages when it tries to power up the SPA. When it cannot successfully power up the SPA, it places it in the FAILED state.

LC/0/3/CPU0:Feb 4 08:23:16.672 : spa_192_jacket[188]: %L2-SPA-5-OIR_INSERTED : SPA discovered in bay 0
LC/0/3/CPU0:Feb 4 08:23:23.349 : spa_192_jacket[188]: %L2-SPA-5-OIR_ERROR : SPA (0): An error occurred (0x1002), error recovery action: reset SPA
LC/0/3/CPU0:Feb 4 08:23:26.431 : spa_192_jacket[188]: %L2-SPA-5-OIR_INSERTED : SPA discovered in bay 0
LC/0/3/CPU0:Feb 4 08:23:32.593 : spa_192_jacket[188]: %L2-SPA-5-OIR_ERROR : SPA (0): Too many retries, error recovery stopped
LC/0/3/CPU0:Feb 4 08:23:32.593 : spa_192_jacket[188]: %L2-SPA-5-OIR_ERROR : SPA (0): An error occurred (0x1002), error recovery action: hold SPA in reset

When a SPA is in the FAILED state, it may not register itself with the FPD upgrade mechanism. In this case, you will not see the SPA listed when you use the show hw-module fpd command. In order to verify the state of a SPA, use the show hw-module subslot error command and the show hw-module subslot status command.

Performing a SPA FPD Recovery Upgrade

To recover a SPA from the FAILED state due to a corrupted FPD image, you must manually shutdown the SPA. Use the hw-module subslot subslot-id shutdown powered command in global configuration mode to administratively shutdown the SPA. Once the SPA is shutdown, then you can use the upgrade hw-module fpd command in admin EXEC mode, with the force option in order to restart the FPD upgrade process.

Verifying a Successful Upgrade

After the upgrade process is complete, you can use the show hw-module fpd command to verify that the FPD image on the SPA has been successfully upgraded.

Use the show hw-module subslot status command to verify that the SPA is up and running:

RP/0/0/CPU0:Router# show hw-module subslot status

BAY 0/3/0 status info:
------------------------
SPA inserted: YES
SPA type: 5xGE SPA
SPA operational state: READY
SPA powered: YES
SPA in reset: NO
SPA insertion time: Mon Feb 28 13:44:23 2005
SPA last time ready: Mon Feb 28 13:45:10 2005
SPA uptime [HH:MM:SS]: 19:04:47

BAY 0/3/1 status info:
------------------------
SPA inserted: YES
SPA type: 1xOC192 POS/RPR HHSPA with XFP
SPA operational state: READY
SPA powered: YES
SPA in reset: NO
SPA insertion time: Mon Feb 28 13:44:25 2005
SPA last time ready: Mon Feb 28 13:45:05 2005
SPA uptime [HH:MM:SS]: 19:04:52

FPD Command Summary

Table 7-3 provides an alphabetical list of the related commands to configure, monitor, and upgrade FPD images for SPAs on the Cisco XR 12000 Series Router. For more information about the commands, see Chapter 10, "Command Reference" in this book.

Table 7-3 FPD Command Summary

Command

Purpose

Router# show hw-module fpd [slot-number/subslot-number]

Displays all current versions of FPD image files for all of the active SPAs on a router.

Router(admin)# show fpd package

Displays the FPD image package requirements for the router to properly support the SPAs running on the Cisco IOS XR software release.

Router(admin)# upgrade hw-module fpd {all | fabldr | fpga | rommon} [force] location [all | node-id]

Upgrades the current FPD image package on a SPA.

Field	Description
Location	Location of the module in the rack/slot/module notation.
Card Type	Module part number.
Type	Hardware type can be: spa—shared port adapter; lc—line card.
Subtype	FPD type can be: fabldr—fabric downloader; fpga—field-programmable gate array; rommon—read-only memory monitor
Inst	Instance—A unique identifier that is used by the FPD process to register an FPD.
Current SW Version	Currently running FPD image version.
Min Req HW Vers	Minimum required hardware version for the associated FPD image.
Upg/Dng	Specifies whether an FPD upgrade or downgrade is required. A downgrade will be required in rare cases when the version of the FPD image has a higher major revision than the version of the FPD image in the current Cisco IOS XR software package.

Field	Description
Card Type	Module part number.
FPD Description	Description of all FPD images available for the SPA.
Type	Hardware type can be: spa—shared port adapter; lc—line card.
Subtype	FPD type can be: fabldr—fabric downloader; fpga—field-programmable gate array; rommon—read-only memory monitor
SW Version	FPD software version required for the associated module running the current Cisco IOS XR software.
Min Req HW Vers	Minimum required hardware version for the associated FPD image.

Command	Purpose
Router# show hw-module fpd [slot-number/subslot-number]	Displays all current versions of FPD image files for all of the active SPAs on a router.
Router(admin)# show fpd package	Displays the FPD image package requirements for the router to properly support the SPAs running on the Cisco IOS XR software release.
Router(admin)# upgrade hw-module fpd {all \| fabldr \| fpga \| rommon} [force] location [all \| node-id]	Upgrades the current FPD image package on a SPA.