Upgrading Field-Programmable Hardware Devices for Cisco 4000 Series ISRs

CPLD Field-Programmable Upgrade Overview

CPLD field-programmable upgrade can be performed on a need basis to address any specific issues with the hardware-programmable devices.The subsequent sections describe how to upgrade the Cisco 4000 Series ISRs.

To determine if one of the components has an incompatible CPLD version, use the show platform command. See the “Displaying the CPLD Version” section.

From Cisco IOS XE Release 3.10.S onwards, a hardware-programmable package is released to customers whose devices require a CPLD upgrade.

Downloading the Hardware-Programmable Firmware Package

To download the hardware programmable firmware package from Cisco.com, perform these steps:

---

Step 1 Log in to the Download Software page https://software.cisco.com/download/navigator.html.

Step 2 From the Select a Software Product Category area, select > Routers > Branch Routers > Cisco 4000 Series Integrated Services Routers, and select the appropriate router from the list.

Step 3 From the Select a Software Type area, select IOS XE Hardware Programmable Devices.

Step 4 Click Download or Add to Cart the IOS XE Software hardware programmable firmware package and follow the prompts.

---

Note A CPLD upgrade is necessary only when a system message indicates that the Cisco 4000 Series ISR needs an upgrade. Cisco 4000 Series ISRs are shipped with Cisco IOS XE 15.3(3r)S1 image pre-installed and that ROMMON upgrade is necessary only starting with Cisco IOS Xe Denali 16.2 release.

 

Upgrading an Active Cisco 4000 Series ISRs

You can upgrade the CPLD firmware on Cisco 4000 Series ISRs using the upgrade hw-programmable command. The CPLD upgrade can take up to ten minutes for each component. You can perform the upgrade on the Cisco 4000 Series ISRs any time as long as you can access the privileged EXEC mode prompt on the router.

To upgrade a Cisco 4000 Series ISRs, perform these steps:

---

Step 1 Cold boot the active Cisco 4000 Series ISR.

Step 2 Copy the hardware-programmable upgrade package to your bootflash:

Step 3 Run the hw-programmable cpld filename command from the EXEC mode:

Step 4 If you are using IOS XE 3.13.1 or later, then skip to Step 5. At the system prompt, press Enter to start the upgrade:

---

a. From the IOS console, use the reload command to gracefully shutdown the system.

b. Turn OFF and turn ON the router. After the router restarts, use the show platform command to check the version of the CPLD:

c. This example show that the router is upgraded successfully.

Step 5 At the system prompt, press Enter to start the upgrade:

a. After the router restarts automatically, use the show platform command to check the version of CPLD:

b. This example shows that the router is upgraded successfully.

 

Field-Programmable Hardware Device Commands

You can use the following field-programmable commands to perform a CPLD upgrade, display the package file version, or display progress during the upgrade:

• upgrade hw-programmable —Performs a CPLD upgrade on a Cisco ISR 4000 Series Router.
• show hw-programmable— Displays the current CPLD or FPGA version in a particular line card.
• show upgrade hw-programmable file— Displays the names and versions of individual files in the hardware-programmable package file in a Cisco 4000 Series ISR.

For command syntax and detailed information, see the Cisco IOS Interface and Hardware Component Command Reference.

Access ROM Monitor Mode

The following sections describe how to enter the ROMMON mode, and contains the following sections:

• Checking the Current ROMMON Version
• Commonly Used ROM Monitor Commands
• Changing the ROM Monitor Prompt

Checking the Current ROMMON Version

If you are unsure whether a ROMMON upgrade is required, use the show rom-monitor command or the show platform command.

Commonly Used ROM Monitor Commands

Table 1-1 summarizes the commands commonly used in ROM Monitor. For specific instructions on using these commands, refer to the relevant procedure in this document.

 

Table 1-2 describes the available help commands for ROM Monitor mode.

 

---

Note Commands are case-sensitive. You can halt any command by pressing Ctrl-C.

Examples

The following example shows what appears when you enter the ? command on a router:

 

Changing the ROM Monitor Prompt

You can change the prompt in ROM Monitor mode by using the PS1= command as shown in the following example:

Changing the prompt is useful if you are working with multiple routers in ROM Monitor at the same time. This example specifies that the prompt should be “ISR4400 rommon ”, followed by the line number, and then followed by “ > “ by the line number.

Frequently Used Environmental Variables

Table 5-3 shows the main ROM Monitor environmental variables. For instructions on how to use these variables, see the relevant instructions in this document.

 

 

Displaying Environment Variable Settings

To display the current environment variable settings, enter the set command at the ROM Monitor mode prompt :

Entering Environment Variable Settings

Environment variable settings are entered in capital letters, followed by a definition. The following example shows the environmental variables used to configure the control Ethernet port on a routerCisco CRS-1 Cisco XR 12000 Series Router:

Saving Environment Variable Settings

To save the current environment variable settings, enter the sync command:

---

Note Environmental values that are not saved with the sync command are discarded whenever the system is reset or booted.

 

DETAILED STEPS

 

Configuration Example

ROMMON Compatibility Matrix

The following table provides information about Cisco 4000 Series Integrated Services Routers supported in each ROMMONrelease.

Table 5 Supported ROMMON Releases for Cisco 4000 Series Integrated Service Routers

---

Note When you upgrade from Cisco IOS XE 3.x to 16.x image, you should first upgrade the ROMMON release to the 16.7(5r) ROMMON release. After upgrading to the 16.7(5r) ROMMON release, based on the IOS XE 16.x image, the ROMMON release can be auto-upgraded to a later ROMMON release.

---

Note The ROMMON release 16.9(1r) is the first release that supports the Cisco BIOS Protection. After a device is upgraded to the 16.9(1r) ROMMON release, the ROMMON release cannot be downgraded to a release earlier than 16.9(1r). All future ROMMON releases can be downgraded to the 16.9(1r) release. Also, if a platform has a 16.9(1r) or later release installed, an IOS XE 16.9.1 or later release, or a SD-WAN 16.11.1 or later release must be used for the upgrade.

---

Note ROMMON images for Cisco IOS XE release 17.1.x through 17.5.x are aligned with release 16.12(2r).

---

Note From Cisco IOS XE release 17.6.1 onwards, the ROMMON image will not be released as a standalone package, and will be packaged with the IOS XE image. 17.6.1 ROMMON will only be used in devices with manufacturing date equal or later than 2535. You can view your device manufacturing date with the CLI command show license udi. For example:

 

Minimum Supported ROMMON Release

The following table provides the minimum supported ROMMON release for Cisco IOS XE 16.x.x and 17.x.x releases.

Table 6 Minimum Supported ROMMON Release for Cisco IOS XE 16.x.x and 17.x.x Releases

---

Note For devices with manufacturing date equal or later than 2535, the minimum supported ROMMON version is 17.6.1. These devices cannot downgrade to older ROMMON versions. ROMMON 17.6.1 supports IOS-XE releases from 16.6.x onwards.

Recommended ROMMON Release

The following table lists the recommended ROMMON release for the routing platforms in each Cisco IOS XE 16.x.x and 17.x.x releases.

Table 7 Recommended ROMMON Release for Cisco IOS XE 16.x.x and 17.x.x Releases

---

Note For devices with manufacturing date equal or later than 2535, the minimum supported ROMMON version is 17.6.1. These devices cannot downgrade to older ROMMON versions. For devices with IOS XE 16.12 and pre-installed ROMMON 17.6.1r, the minimum supported ROMMON version is 17.6.1r. Do not downgrade the ROMMON to 16.12(2r); these devices cannot downgrade to older ROMMON versions. ROMMON 17.6.1 supports IOS-XE releases from 16.6.x onwards.

Upgrading ROMMON

To upgrade ROMMON, perform these steps:

---

Step 1 (Optional) To display the current ROMMON version at the IOS prompt, use the following command:

Step 2 From the personal computer, copy the ROMMON isr4400_rommon_169_1r_SPA.pkg R0 file to a USB flash drive.

Step 3 Insert the USB flash drive into the usb0: slot, or download the ROMMON package file to the bootflash: using the IOS copy tftp: command.

Step 4 (Optional) Use the verify /md5 <filesystem>:<pkg filename> command to verify the MD5 checksum of the ROMMON package file.

The <filesystem> is usb0 or bootflash:. The <PKG filename> is the downloaded ROMMON package file. For example, isr4400_rommon_168_1r_SPA.pkg is a downloaded ROMMON package file.

Step 5 At the IOS prompt, run the upgrade rom-monitor command to begin the ROMMON upgrade process:

---

Step 6 After the device is upgraded, use the reload command to complete the upgrade process. When the device boots up, it validates the upgrade file before the backup copy of the ROMMON is upgraded. When the upgrade is complete, the device reboots to start running the new ROMMON.

Step 7 If an autoboot option is not configured, boot an IOS_XE image at the prompt. The IOS-XE image must successfully boot to an IOS prompt to complete the ROMMON upgrade process.

Step 8 At the IOS prompt, use the show rom-monitor R0 command to verify that the ROMMON version matches the ROMMON PKG file version.

---

Note After a device is upgraded to 16.9(1r) ROMMON release, the ROMMON cannot be downgraded to a release earlier than 16.9(1r). All future ROMMON releases can be downgraded to the 16.9(1r) release.

 

Resolved Caveats

The following section list the issues resolved in each ROMMON release:

Resolved Caveats in ROMMON Release 16.12(2r)

All resolved bugs for this release are available in the Cisco Bug Search Tool.

Resolved Caveats in ROMMON Release 16.12(1r)

All resolved bugs for this release are available in the Cisco Bug Search Tool.

Resolved Caveats in ROMMON Release 16.7(5r)

All resolved bugs for this release are available in the Cisco Bug Search Tool.

Resolved Caveats in ROMMON Release 16.7(2r)

All resolved bugs for this release are available in the Cisco Bug Search Tool.

Related Documents

Technical Assistance

Table 8 Feature Information for Upgrading Field-Programmable Hardware Devices for Cisco 4000 Series ISRs

Feature Name	Releases	Feature Information
Upgrading Field-Programmable Hardware Devices for Cisco 4000 Series ISRs	Cisco IOS XE Release 3.10S	In Cisco IOS XE Release 3.10S, support for upgrading field-programmable hardware devices was introduced for the Cisco 4000 Series ISRs. The following commands were introduced: upgrade hw-programmable, show hw-programmable, show upgrade hw-programmable progress, show upgrade hw-programmable file.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

© 2015 Cisco Systems, Inc. All rights reserved.