The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
An FPD is a field programmable logic device which contains non-volatile, re-programmable memory to define its internal wiring and functionality. The contents of this non-volatile memory are called the FPD image or FPD firmware. Over the lifespan of an FPD, FPD firmware images may need upgrades for bug fixes or functionality improvements. These upgrades are performed in the field with minimum system impact.
You must install the FPD pie before you install the SMUs or Service Packs. If you install the SMU or Service Packs before the FPD pie, the FPDs on the line card may not upgrade. In such cases, you must remove the SMUs and Service Packs and reload the router.
An FPD image is used to upgrade the software on an FPD.
FPD versions must be compatible with the Cisco IOS XR software that is running on the router; if an incompatibility exists between an FPD version and the Cisco IOS XR software, the device with the FPGA may not operate properly until the incompatibility is resolved.
 Note |
|
The main tasks of the FPD upgrade service are:
Check FPD image version to decide if a specific firmware image needs an upgrade or not.
Automatic FPD Image Upgrade (if enabled).
Manual FPD Image Upgrade using the upgrade hw-module fpd command.
Invoke the appropriate device driver with a name of the new image to load.
An FPD image package is used to upgrade FPD images. The install activate command is used to place the FPD binary files into the expected location on the boot devices.
Supported Upgrade Methods
|
Method |
Remarks |
|---|---|
|
Manual Upgrade |
Upgrade using CLI, force upgrade supported. |
|
Auto Upgrade |
Upgrade using install SMU activation or during image upgrade. User can enable/disable auto upgrade feature. |
Use the show hw-module fpd command to determine if an FPD upgrade is required. Check for NEED UPGD in the Status column.
Example
Router: #show hw - module fpd
Wed Dec 14 07:08:08.424 UTC
Auto-upgrade:Disabled
FPD Versions
==============
Location Card type HWver FPD device ATR Status Running Programd
-----------------------------------------------------------------------------------------
0/0 NC55-18H18F 1.0 MIFPGA NEED UPGD 7.01 7.01
0/0 NC55-18H18F 1.0 Bootloader CURRENT 1.14 1.14
0/0 NC55-18H18F 1.0 IOFPGA CURRENT 0.07 0.07
0/0 NC55-18H18F 1.0 SATA-M600-MCT CURRENT 0.23 0.23
Use the show fpd package command to find out which FPGAs are supported with your current software release and minimum hardware requirements for each module.
Manual FPD upgrade is performed using the upgrade hw-module fpd command. All cards or all FPGA in a card can be upgraded. If reload is required to activate FPD, the upgrade should be complete. Line-cards, fabric cards and RP cards cannot be reloaded during the process of the FPD upgrade.
FPD upgrade is transaction-based:
Each fpd upgrade CLI execution is one transaction.
Only one transaction is allowed at any given time.
One transaction may include one or many FPD upgrades
The force option can be used to forcibly upgrade the FPD (regardless of whether it is required or not). It triggers all FPDs to be upgraded or downgraded. The force option can also be used to downgrade or upgrade the FPGAs even after the version check.
Note |
|
These entries are applicable for Cisco N540-FH-CSR-SYS and Cisco N540-FH-AGG-SYS routers.
Perform a manual upgrade of the DPFPGA after the software downgrade to Cisco IOS XR Releases 7.3.2, 7.4.x, 7.5.1, or 7.6.2 from higher image versions.
DPFPGA ports:
On N540-FH-CSR-SYS: Ports 0-13
On N540-FH-AGG-SYS: Ports 0-23
These entries are the commands used to upgrade FPD firmware for specific hardware modules.
On N540-FH-CSR-SYS: The command upgrade hw-module location 0/rP0/CPU0 fpd DpFpga force is used in Cisco IOS XR software to upgrade the FPD firmware.
On N540-FH-AGG-SYS: The command upgrade hw-module location 0/rP0/CPU0 fpd DpFpgaEth force is used in Cisco IOS XR software to upgrade the FPD firmware Ethernet bundle.
On N540-FH-AGG-SYS: The command upgrade hw-module location 0/rP0/CPU0 fpd DpFpgaCpri force is used in Cisco IOS XR software to upgrade the FPD firmware CPRI bundle.
Execute the software downgrade to Cisco IOS XR Releases 7.5.1, 7.5.2, or 7.6.2 from higher image versions with the SMU integrated into the maintenance release.
You must determine if an FPD image upgrade is needed using the show hw-module fpd command and perform the upgrade, if needed, under the following circumstances:
Migrate the software to a later Cisco IOS XR software release.
In the event of an FPD incompatibility with your card, you might receive the following error message:
LC/0/0/CPU0:Jul 5 03:00:18.929 UTC: optics_driver[220]: %L2-OPTICS-3-BAD_FPGA_IMAGE : Detected bad MI FPGA image programmed in MI FPGA SPI flash in 0/0/CPU0 location: Failed to validate meta data CRC
LC/0/0/CPU0:Jul 5 03:00:19.019 UTC: optics_driver[220]: %L2-OPTICS-3-BACKUP_FPGA_LOADED : Detected Backup FPGA image running on 0/0/CPU0 - primary image corrupted (@0x8c = 0x44)
RP/0/RP0/CPU0:Jul 5 03:00:48.987 UTC: fpd-serv[301]: %PKT_INFRA-FM-3-FAULT_MAJOR : ALARM_MAJOR :FPD-NEED-UPGRADE :DECLARE :0/0:Upgrades to the Cisco IOS XR software might result in an FPD incompatibility. Ensure that you perform the FPD upgrade procedure and resolve all incompatibilities, for the cards to function properly.
Note |
The use of the force option when performing a FPD upgrade is not recommended except under explicit direction from Cisco engineering or TAC for a one-time purpose only. |
The FPD upgrade procedure is performed while the card is online. At the end of the procedure the card must be reloaded before the FPD upgrade is complete. To reload the card, you can use the hw-module location <location> reload command in Admin mode, during the next maintenance window. The upgrade procedure is not complete until the card is reloaded.
During the FPD upgrade, you must not do the following:
Reload, perform an online insertion and removal (OIR) of a line card (LC), or power down the chassis. Doing so may cause the node to enter an unusable state.
Press Ctrl-C if the console appears to hang without any output. Doing so may abort the upgrade.
If you are not sure whether a card requires an FPD upgrade, you can install the card and use the show hw-module fpd command to determine if the FPD image on the card is compatible with the currently running Cisco IOS XR software release.
The following examples indicates the use of commands associated with the FPD image upgrade procedure.
Use the show fpd package command in System Admin EXEC mode to find out which line cards are supported with your current Cisco IOS XR software release, which FPD image package you need for each line card, and what the minimum hardware requirements are for each module. If multiple FPD images are available for your card, they are listed as Subtype fpga2, fpga3, and so on.
Note |
The FPD name used in the FPD Description column of the output of the |
Use the upgrade hw-module fpd command to upgrade the FPD image. The upgrade can be executed for all FPDs or for specific FPDs that need an upgrade. To upgrade all FPDs, use upgrade hw-module fpd all location all command. To upgrade a specific FPD image type, use the FPD subtype value in the upgrade hw-module fpd command.
Use the show platform command to verify that the line card is up and running.
|
Feature Name |
Release Information |
Feature Description |
|---|---|---|
|
Auto FPD Upgrade |
Release 7.3.2 |
This functionality enables automatic upgrade and reload for field-programmable devices (FPDs) whenever the Cisco IOS XR image has a newer FPD version. This functionality upgrades all route processors and line card FPDs simultaneously while displaying upgrade triggers on the console. |
Effective Cisco IOS XR Release 7.3.2, you can enable automatic upgrade of FPD by using the “fpd auto-upgrade enable” command.
To automatically upgrade all FPDs, use:
RP/0/RP0/CPU0:IOS(config)#fpd auto-upgrade enableTo reload the interface modules following the fpd auto-upgrade, use:
RP/0/RP0/CPU0:IOS(config)#fpd auto-reload enableLimitations
FPD auto-upgrade should be enabled only in the XR VM and not in the System Admin VM.
With auto-upgrade enabled, if any card is in RELOAD REQUIRED state, auto-upgrade is re-triggered during any SSO or FPD-serv process restart.
When an interface module (IM) or route processor (RP) is in RELOAD REQUIRED state and auto-upgrade is enabled, FPD upgrades are triggered again.
With auto-upgrade enabled, if line card is inserted, an auto-upgrade is triggered. During this phase optics alarms are generated. If auto-reload is not enabled, you must reload the line cards manually to clear these alarms.
SATA allows you to upgrade or downgrade when an FPD version change is available. Therefore, when auto-upgrade is enabled, the system automatically downgrades if lower versions are available. This behavior is specific only to SATA FPDs.
FPD auto-reload is applicable for line cards only. Line cards are automatically reloaded after the fpd auto-upgrade process is completed.
You must disable auto-upgrade during XR ISSU; otherwise, the router goes into a state where redundancy cannot be achieved. In this case, standby RP must be reloaded to achieve redundancy.
TimingICs do not support auto fpd upgrade on NCS5500 Series Routers as the TimingIC requires a card reload immediately after upgrade. For the same reason, the TimingICs are not upgraded if the user specifies location all in the auto fpd upgrade command. To upgrade a TimingIC FPD, specify the FPD name along with the card location. For example, upgrade hw-module fpd TimngIC-A location 0/RP0/cpu0.
Usage Guidelines—Online Insertion of Line Cards
When a line card with a lower FPD version is inserted, one of the following scenarios apply:
If fpd auto-upgrade and auto-reload are enabled, and a new line card is inserted, the system upgrades the line card FPDs automatically with the latest FPDs and reloads the line cards.
If fpd auto-upgrade and auto-reload are both disabled, no action is required.
If fpd auto-upgrade is enabled and auto-reload is disabled, the following alarms are displayed on the console:
RP/0/RP1/CPU0:Jun 1 10:05:46.095 UTC: optics_driver[231]: %PKT_INFRA-FM-3-FAULT_MAJOR : ALARM_MAJOR :OPTICS SUPPORTED_ERROR :DECLARE : Optics0/5/0/6: Optics0/5/0/6
RP/0/RP1/CPU0:Jun 1 10:05:46.096 UTC: optics_driver[231]: %PKT_INFRA-FM-2-FAULT_CRITICAL : ALARM_CRITICAL :OPTICS NOT SUPPORTED :DECLARE : Optics0/5/0/6: Optics0/5/0/6You must reload the line cards manually to clear these alarms
Usage Guidelines—Online Insertion of RPs
When fpd auto-upgrade is enabled and a new RP is inserted, the system upgrades the RP FPDs automatically with the latest FPDs.
Note |
RPs are not reloaded automatically. You must manually reload the RP or chassis for the latest FPD version to reflect. |
Note |
Reload of active RPs and line cards impacts the network traffic. |
|
FPD |
Action Required |
|---|---|
|
IOFPGA |
Manual reload required |
|
ADM |
Upgraded version available immediately |
|
PRIMARY-BIOS |
Manual reload required |
|
SATA |
Upgraded version available immediately |
|
PSOC |
Upgraded version available immediately |
|
IMFPGA |
Manual reload required, if auto-reload is not configured |
In case of Software upgrade (without ISSU), configure the fpd auto-upgrade enable command. All the FPDs are automatically upgraded in the currently installed image (V1). After the upgrade, the router automatically reloads and comes up with the new image (V2) with the upgraded FPDs already running. No additional reloads are required.
Note |
System reloads are part of the SU process, therefore you can disable the FPD auto reload functionality by using the fpd auto-reload disable command. |
RP/0/RP0/CPU0:IOS#conf
RP/0/RP0/CPU0:IOS(config)#fpd auto-upgrade enable
RP/0/RP0/CPU0:IOS#commit
Check for FPD Versions
Check that Auto Upgrades are Triggered for FPDs with Newer Versions Available
Note |
At this step, all RSP, IMs, and fan FPD upgrades are initiated and completed. All cards are upgraded before the router reloads. |
Check the RP FPD Versions and FPD Status
When the router is operational after the reload, all the RP, IMs, and fan FPDs are upgraded to the latest FPD versions.
During the Power Supply Unit (PSU) insertion and installation process, the routers can now automatically upgrade the Field-Programmable Devices (FPD) associated with the PSUs.
Starting with Cisco IOS-XR Release 7.5.2, the automatic FPD upgrade includes the FPDs associated with the PSUs by default. This means that when automatic FPD upgrade is enabled, the FPDs associated with the PSUs will also be upgraded. The upgrades for the PSUs will occur sequentially, so the FPD upgrades for the PSUs will take longer than for other components.
You can choose to exclude PSUs from the automatic upgrade process to reduce the time taken for FPD automatic upgrade by preventing them from being upgraded upon insertion or during a system upgrade using the fpd auto-upgrade exclude pm command.
Configuration
Router# config
Router(config)# fpd auto-upgrade enable
Router(config)# fpd auto-upgrade exclude pm
Router(config)# commit
Show Running Configuration
Router# show running-config fpd auto-upgrade
fpd auto-upgrade enable
fpd auto-upgrade include pmOn failure of an FPD upgrade, you get a warning with the following syslog message:
LC/0/5/CPU0:Jun 27 05:02:25.742 UTC: optics_driver[216]: %INFRA-FPD_Driver-1-UPGRADE_ALERT : FPD MIFPGA@0/5 image programming completed with UPGD FAIL state Info: [Image verification failed at offset 0x5c8, flash value = 0x0, image value = 0x40, image size = 4194304]
LC/0/5/CPU0:Jun 27 05:02:26.570 UTC: optics_driver[216]: %INFRA-FPD_Driver-1-UPGRADE_ALERT : FPD MIFPGA@0/5 image programming completed with UPGD FAIL state Info: [Image verification failed at offset 0x1e, flash value = 0x56, image value = 0xff, image size = 4194304]
When you use the show hw-module fpd command, the status column displays UPGD FAIL to indicate failure of the FPD upgrade.
Note |
|
Feedback