System Setup and Software Installation Guide for Cisco NCS 1010, IOS XR Releases

PDF

Field programmable devices

Want to summarize with AI?

Log in

This section explains Field Programmable Devices for Cisco NCS 1010. Use it to understand FPD behavior, hardware scope, and upgrade context before software maintenance.


A Field Programmable Device (FPD) refers to any programmable hardware device on a chassis, which includes a Field Programmable Gate Array (FPGA). NCS 1010 uses several FPDs that are necessary for chassis, route processor, line cards, and power modules to function properly. Before upgrading the software, check whether the latest FPDs are available on NCS 1010.

Details

Table 1. Feature History

Feature Name

Release Information

Feature Description

FPD Upgrade for Passive Modules

Cisco IOS XR Release 7.10.1

You can now perform FPD upgrade of the breakout modules and multiplexer/demultiplexer modules. It is essential to upgrade the passive modules to ensure the proper functioning of the modules. You can upgrade the FPD on all passive modules simultaneously or selectively upgrade the required modules.

Note

FPD auto-upgrade is enabled by default on NCS 1010.

From Release 7.10.1, you can perform FPD upgrade for the breakout and multiplexer/demultiplexer modules. For the breakout modules, you can perform the FPD upgrade in both direct and indirect connections. You can upgrade all the passive modules at once or selectively upgrade the necessary modules as needed.

Note

If the FPD in a given SSD is not supported by the current IOS XR software release, the status is displayed as NOT READY . The status will change once FPD support for these SSDs is enabled in future releases.

Table 2. NCS 1010 FPDs

Location

FPDs

RP

  • ADMConfig

  • CpuFpga

  • CpuFpgaGolden

  • BIOS

  • BIOS-Golden

  • SsdIntelS4510

  • SsdMicron5300

  • SsdSmartModular

  • TamFw/

    TamFwGolden

PM0 and PM1

  • AP-PrimMCU

  • AP-SecMCU

LC

  • ILA

  • OLT

  • Raman-1

  • Raman-2

Rack

  • IoFpga

  • IoFpgaGolden

  • EITU-ADMConfig

  • SsdIntelS4510

  • SsdMicron5300

  • SsdSmartModular

Breakout module

  • BRK-8

  • BRK-24

Multiplexer and demultiplexer modules

  • MD-32-ACC

  • MD-32-NEO

Golden FPDs serve as backup FPDs for the primary FPDs. For example, BIOS-Golden is the backup Golden FPD for the BIOS primary FPD. If a primary FPD is corrupted, NCS 1010 boots with the corresponding Golden FPD. The Golden FPDs cannot be upgraded.

Check FPD Version

There are multiple types of FPDs for each type of module. The show hw-module fpd command provides information about each FPD.

RP/0/RP0/CPU0:ios#show hw-module fpd
Fri Feb 17 11:43:28.878 UTC

Auto-upgrade:Enabled
Attribute codes: B golden, P protect, S secure, A Anti Theft aware
                                                                         FPD Versions
                                                                        ==============
Location   Card type             HWver FPD device       ATR Status   Running Programd  Reload Loc
-------------------------------------------------------------------------------------------------
0/RP0/CPU0 NCS1010-CTLR-B-K9     1.0   ADMConfig            CURRENT    2.30    2.30       NOT REQ
0/RP0/CPU0 NCS1010-CTLR-B-K9     1.0   BIOS             S   CURRENT    4.40    4.40         0/RP0
0/RP0/CPU0 NCS1010-CTLR-B-K9     1.0   BIOS-Golden      BS  CURRENT            4.40         0/RP0
0/RP0/CPU0 NCS1010-CTLR-B-K9     1.0   CpuFpga          S   CURRENT    1.11    1.11         0/RP0
0/RP0/CPU0 NCS1010-CTLR-B-K9     1.0   CpuFpgaGolden    BS  CURRENT            1.01         0/RP0
0/RP0/CPU0 NCS1010-CTLR-B-K9     1.0   SsdIntelS4510    S   CURRENT   11.32   11.32         0/RP0
0/RP0/CPU0 NCS1010-CTLR-B-K9     1.0   TamFw            S   CURRENT    6.13    6.13         0/RP0
0/RP0/CPU0 NCS1010-CTLR-B-K9     1.0   TamFwGolden      BS  CURRENT            6.11         0/RP0
0/PM0      NCS1010-AC-PSU        0.0   AP-PriMCU            CURRENT    1.03    1.03       NOT REQ
0/PM0      NCS1010-AC-PSU        0.0   AP-SecMCU            CURRENT    2.01    2.01       NOT REQ
0/PM1      NCS1010-AC-PSU        0.0   AP-PriMCU            CURRENT    1.03    1.03       NOT REQ
0/PM1      NCS1010-AC-PSU        0.0   AP-SecMCU            NEED UPGD  1.06    1.06       NOT REQ
0/0/NXR0   NCS1K-E-OLT-R-C       1.0   OLT              S   CURRENT    1.16    1.16       NOT REQ
0/0/NXR0   NCS1K-E-OLT-R-C       1.0   Raman-1          S   CURRENT    1.04    1.04       NOT REQ
0/Rack     NCS1010-SA            0.1   EITU-ADMConfig       CURRENT    1.04    1.04       NOT REQ
0/Rack     NCS1010-SA            0.1   IoFpga           S   CURRENT            1.12       NOT REQ
0/Rack     NCS1010-SA            0.1   IoFpgaGolden     BS  NEED UPGD  1.12    0.08       NOT REQ
0/Rack     NCS1010-SA            0.1   SsdIntelS4510    S   CURRENT   11.32   11.32        0/Rack
0/1        NCS1K-MD-32E-C        0.1   MD-32-NEO        S   CURRENT    2.02    2.02       NOT REQ
0/2        NCS1K-MD-32O-C        10.2  MD-32-ACC        S   CURRENT    2.18    2.18       NOT REQ
0/3/0      NCS1K-BRK-8           1.0   BRK-8            S   CURRENT    2.08    2.08       NOT REQ
0/3/3      NCS1K-BRK-24          1.0   BRK-24           S   CURRENT    2.08    2.08       NOT REQ
                                                                       

If the status of any FPD is NEED UPGD, then the upgrade is required for that FPD. In this example, IoFpgaGolden FPD devices need an upgrade. You must ensure that FPDs are upgraded before upgrading NCS 1010.

The following table lists the NCS 1010 FPDs that are distributed across route processor (RP), power modules (PM), line cards (LC), and Rack.

The following table describes the significant fields in the output of the show hw-module fpd command.

Table 3. Description of Fields in show hw-module fpd Command

Field

Description

Location

Location of the FPD.

Card type

PID of the modules such as chassis, card, CPU, and PSU.

HWver

Hardware version where the FPD resides.

FPD device

Name of the FPD.

ATR

Attribute codes. The possible values are:

  • B - Golden Image

  • S - Secure Image

  • P - Protect Image

The attribute code of the primary FPDs is S and the Golden FPDs is BS.

Status

Status of the FPD. See Table 4.

Running

FPD image version that has been activated and currently running in the FPD device.

Programd

FPD image version that has been programmed into the FPD device, but might not be activated.

Reload Loc

Indicates whether reload of the location is required or not.

The following table describes the possible values of the Status field in the output of the show hw-module fpd command.

Table 4. Description of FPD Status Values in show hw-module fpd Command

FPD Status

Description

NOT READY

The driver that owns the FPD device has not initialized the FPD client to handle this device.

CURRENT

FPD version is up to date and upgrade is not required.

NEED UPGD

Upgrade is required for this FPD. Check the output of the show fpd package command to determine the recommended FPD version.

UPGD PREP

FPD is preparing for upgrade.

IN QUEUE

Upgrade of this FPD is in queue.

UPGD SKIP

FPD upgrade is not required. For example,

  • FPD version is up to date and compatible.

  • FPD image is protected.

UPGRADING

FPD upgrade started and the driver did not report the upgrade progress information yet.

%UPGD

Percentage of FPD upgrade completion.

RLOAD REQ

FPD upgrade is successfully completed and the FPD must be reloaded for the new version to take effect.

UPGD FAIL

FPD upgrade has failed. Check the syslog for failure reason. It could be a timeout or a failure that is reported by the driver.

UPGD DONE

FPD upgrade is successfully completed.

The show fpd package command is used to determine the FPDs that are supported with the current software release and the minimum hardware requirements for each FPD.

The following table describes the fields in the output of the show fpd package command.

Table 5. Description of Fields in show fpd package Command

Field

Description

Card Type

PID of the modules such as chassis, card, CPU, and PSU.

FPD Description

Description of the FPD.

Req Reload

Determines whether reload is required to activate the FPD image.

SW Ver

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

Min Req SW Ver

Minimum required FPD software version to operate the module.

Min Req Board Ver

Minimum required hardware version for the associated FPD. A minimum hardware requirement of version 0.0 indicates that all the hardware can support this FPD version.


Upgrade FPDs automatically

Use this task to upgrade FPDs automatically.

The automatic FPD upgrade upgrades the FPD version of all the modules to the latest version. When automatic FPD upgrade is enabled, all the FPDs (except the Golden FPDs) that are in NEED UPGD status are upgraded to CURRENT status during the software upgrade.

In NCS 1010, automatic FPD upgrade is enabled by default.

Before you begin

Follow these steps to upgrade FPDs automatically.

Procedure

Run the following commands to disable automatic FPD upgrade.

Example:


RP/0/RP0/CPU0:ios#configure
RP/0/RP0/CPU0:ios(config)#fpd auto-upgrade disable
RP/0/RP0/CPU0:ios(config)#commit
RP/0/RP0/CPU0:ios(config)#end

Upgrade FPDs manually

Use this task to upgrade FPDs manually.

Use the following procedure to upgrade the FPDs manually.

Note

The Golden FPDs cannot be upgraded using the CLI.

Before you begin

Follow these steps to upgrade FPDs manually.

Procedure

1.

Run the show hw-module fpd command to display information about the current FPD version.

You can use this command to determine if you must upgrade the FPD.

2.

Run the show alarms brief system active command to display the active alarms.

You must upgrade the FPD when the

One Or More FPDs Need Upgrade Or Not In Current State

alarm is present.

3.

Run the upgrade hw-module location [location-id] fpd [fpd name] command to upgrade a specific FPD.

After upgrading the FPD, the user must wait for upgrade completion. The progress of the FPD upgrade can be monitored using the show hw-module fpd command.

Example:

RP/0/RP0/CPU0:ios#upgrade hw-module location 0/Rack fpd IoFpga
          
Note

The FPDs of power modules belong to 0/PM0 and 0/PM1 locations. The FPDs belonging to both the PM locations cannot be simultaneously upgraded.

4.

Run the reload location location-id command to reload the FPDs belonging to a specific location with the new version.

The Reload Loc field in the output of show hw-module fpd command indicates whether the reload is required or not.

Example:

RP/0/RP0/CPU0:ios#reload location 0/RP0/CPU0
          
5.

(Optional) Run the upgrade hw-module location all fpd all command to upgrade all the FPDs at once.

6.

(Optional) Run the upgrade hw-module [location [location-id | all]] fpd [fpd name] | all] command to upgrade a specific FPD, all the FPDs, or the FPDs belonging to a specific location.

Example:

RP/0/RP0/CPU0:ios#upgrade hw-module location all fpd all
          
Note

The FPDs of power modules and SSDs cannot be forcefully upgraded.


FPD upgrades using YANG data models

Use this reference to review upgrading FPDs using Yang data models.

The following information supports upgrading FPDs using Yang data models:

  • YANG is a data modeling language that helps to create configurations, retrieve operational data and execute actions. NCS 1010 acts on the data definition when these operations are requested using NETCONF RPCs. The data model handles the following types of requirements on NCS 1010 for FPD:

Operational Data

Native Data Model

Auto Upgrade: Enabling or disabling of automatic upgrade of FPD

Cisco-IOS-XR-fpd-infra-cfg.yang

Auto Reload: Enabling or disabling of automatic reload of FPD

Cisco-IOS-XR-fpd-infra-cfg.yang


FPD downgrade scenarios

Use this reference to review fPD downgrade scenarios.

When you downgrade from a higher release to lower release, the downgrade process of FPDs differs based on the higher and lower release firmware version.

  • Manual downgrade

  • When an FPD in the higher release runs a firmware that has an EVEN minor version, then the FPD does not downgrade automatically. The FPD requires manual downgrading using the force upgrade command1 .

  • For example, when you downgrade from R24.1.1 that has an FPD with an even firmware version 1.10 to R7.11.1 that has the same FPD with firmware version 1.07, then the FPD does not downgrade automatically. The FPD must be manually downgraded using the force upgrade command 1 .

  • Automatic downgrade

  • When the change in the FPD firmware is in the major version, then the FPD automatically downgrades.

  • For example. when you downgrade from R24.1.1 that has an FPD with firmware version 2.10 to R7.11.1 that has the same FPD with a major difference in firmware version such as version 1.07, then the FPD automatically downgrades.

  • Break release

  • When an FPD in the higher release runs a firmware that has an ODD minor version, then the FPD does not downgrade automatically. The FPD cannot be manually downgraded even with the force upgrade command 1 .

  • For example, when you downgrade from R24.1.1 that has an FPD with odd firmware version 1.19 to R7.11.1 that has the same FPD with firmware version 1.07, then the FPD does not downgrade automatically. Also, the FPD cannot be forced to downgrade manually using the force upgrade command 1 .

  • Minimum required firmware version

  • When an FPD in the lower release runs a firmware version that is less than the minimum version programmed in IDPROM of the FPD's respective cards, then the FPD does not downgrade automatically. The FPD cannot be manually downgraded even with the force upgrade command 1 .

  • For example, when you downgrade from R24.1.1 that has an FPD with firmware version 1.19 to R7.11.1 that has the same FPD with firmware version 1.07. If the minimum required firmware version that is programmed in IDPROM for that FPD is 1.09, then the FPD does not downgrade automatically. Also, the FPD cannot be forced to downgrade manually using the force upgrade command 1 .

1 The force upgrade command is upgrade hw-module location [location-id] fpd [fpd name] force.