Factory Staging Application Version
2.0 User Instructions
Overview
Introduction
These instructions are for staging Cisco client devices and CableCARD™ modules
in a Common Download (CDL) environment or a legacy Code Version Table
(CVT) environment using the Cisco Factory Staging Application version (FSA) 2.0
or higher. This staging process configures these devices for use in the Cisco
Digital Broadband Delivery System (DBDS). FSA 2.0 uses the OpenCable™
diagnostic features to align with industry standards. Client devices supported by
FSA 2.0 include the Cisco® Explorer® 9800 Multiscreen Gateway Series and higher.
Note: This guide includes reference to CableCARD features. These features are
only supported on set-top boxes that support CableCARD.
Scope
In addition to instructions for using FSA for staging, these instructions provide an
overview of the FSA, its various components, and include common
troubleshooting steps.
FSA 2.0 for the Cisco Explorer 9800 series multiscreen gateway supports any of
the following operating environments.
¾ Forward and Reverse Data Channel: DOCSIS/DSG, SCTE55-1 with
CableCARD, SCTE55-2 (DAVIC)
¾ Conditional Access: CableCARD and embedded PowerKey
¾ Software Download: OpenCable Common Download and legacy Ciscoproprietary CVT download
¾ Headend System: Cisco DNCS for embedded PowerKey hosts and any
vendor headend system that supports CableCARD host devices
Configuration and use of the CCCM override package is outside the scope of this
document.
Notes:
¾ For instructions to install client release software, refer to Downloading New
Client Application Platform Installation Instructions (part number 78-4003052-01)
for information regarding installing client release software.
About FSA and Software Downloads
¾ For instructions to stage legacy set-tops and non-CableCARD DHCTs, refer to
the Explorer Digital Home Communications Terminal Staging Guide (part number
78-734375-01).
¾ For instructions to stage 8600 and 8700 series set-tops, refer to the Factory
Staging Application User Guide (part number 78-4031492-01).
¾ For instructions to stage Separable Security Host with CableCARDTM module
(SSC) DHCTs, refer to one of the following guides (based on the Digital
Network Control System (DNCS) system release you are using) for
information regarding staging SSC DHCTs:
-
Separable Security Host Staging Guide for System Release 4.2.1 and Earlier (part
number 78-736107-01)
-
Separable Security Host Staging Guide for System Release 4.3 and Later (part
number 78-4024836-01)
Audience
These instructions are written for staging area personnel, gateway installation
personnel, and system operators of the DNCS.
[
Document Version
This is the first formal release of this document.
2
OL-29686-01
About FSA and Software Downloads
About FSA and Software Downloads
The Factory Staging Application (FSA) is an application that is installed on a client
device or CableCARD module at the factory and is activated the first time the device
is powered on. FSA provides an easy-to-use method for service providers to stage a
factory-fresh device using CDL and legacy Cisco-proprietary CVT download
methods to prepare it for services on the Cisco DBDS.
FSA listens for CDL triggers and responds to CDL requests. Advantages of CDL
include:
¾ Uses industry standard methodology
¾ Provides more efficient and faster code downloads
¾ Supports the ever-increasing size of software image files
For compatibility with legacy systems that do not support CDL, FSA additionally
listens for and responds to legacy Cisco-proprietary CVT triggers.
The FSA provides a standard way of ensuring that CDL and legacy Ciscoproprietary CVT download triggers are recognized and acted upon for software
image download into devices. Additionally, the FSA provides real-time status
information to the staging operator via a combination of LED blinking patterns and
simple text messages on set-tops equipped with a Front Panel Display (FPD). If an
error condition occurs during staging, the FSA provides LED and FPD error code
indicators. If the device is connected to a display monitor, detailed diagnostic pages
appear.
In summary, the FSA from Cisco includes the following benefits:
¾ A useful tool that gives service provider staging personnel a way to leverage
CDL or legacy Cisco proprietary CVT download methods for downloading
software images into set-tops
¾ Ships pre-loaded from the factory for ease of use
¾ Provides the real-time status information that staging personnel need to assess
the condition of a download in progress as well as detailed diagnostic
information using LEDs, FPDs, and diagnostic screens
OL-29686-01
3
What Knowledge and Skills Do You Need?
What Knowledge and Skills Do You Need?
Before you stage client devices and CableCARD modules, you must be familiar with
the basic operation of the devices and the features that are available to subscribers.
Background Knowledge
Before you stage devices, you should be familiar with these processes:
¾ Operation of the DNCS (particularly set-top, gateway, and CableCARD module
loading and activation)
¾ Configuration of your cable headend system
¾ Knowledge of basic UNIX commands
¾ Basic FSA operation (these instructions)
¾ Knowledge of CDL, CDL triggers, and CDL download methods, if CDL
download methods will be used for installing host code images
¾ Knowledge of File Transfer Protocol (FTP), Trivial File Transfer Protocol (TFTP),
Simple Network Management Protocol (SNMP), and the ability to use these
methods, if CDL TFTP download methods will be used for installing host code
images
¾ Knowledge of legacy Cisco-proprietary CVT triggers and download methods
supported in Cisco DBDS environment for installing CableCARD firmware and
host code images.
Staging Knowledge
To stage a device using FSA, you should become familiar with the following features
of the device:
¾ Front and back panels of the Explorer set-tops or gateways
¾ Explorer set-top or gateway FSA and CDL diagnostic screens
¾ Configuration settings that define the operating characteristics for set-tops or
gateways
¾ Remote control operation
¾ LED indicators that indicate device status
Staging involves two main tasks:
¾ Installing updated firmware on the CableCARD device. This step is only
applicable when staging CableCARD host devices whose CableCARD modules
do not already have the target firmware.
¾ Installing host software on the client device.
4
OL-29686-01
Common Download Triggers and Methods
Common Download Triggers and Methods
This section lists the supported triggers and download methods for installing host
code images.
Important: These triggers and methods are not mutually exclusive and can operate
and function together in a variety of combinations depending on system
configuration.
CDL Triggers
¾ TFTP
¾ SNMP
¾ DOCSIS® Configuration File
¾ CVT (via CableCARD or DSG)
CDL Download Methods
¾ TFTP
¾ DSG Carousel (DSM-CC)
¾ FAT Carousel (DSM-CC)
Legacy Cisco-proprietary CVT Trigger Methods
These methods are supported in Cisco DBDS environments only.
¾ Proprietary DSM-CC UN Pass Thru message generated by the DNCS and
delivered via DAVIC FDC and DSG
¾ Proprietary private section data on well-known PID delivered via in-band MPEG
Transport Stream. (Supported only for CableCARD firmware download trigger.
FSA does not support this trigger method for host code downloads.)
Legacy Cisco-proprietary CVT Download Method
This method is supported in Cisco DBDS environments only.
¾ FAT Carousel (DSM-CC)
OL-29686-01
5
Using the Factory Staging Application
Using the Factory Staging Application
Introduction
This section provides the following information:
¾ Descriptions of front panel display behaviors
¾ LED blinking patterns that occur during the FSA
¾ Examples of the FSA screens that display on the monitor during the code
download
¾ List of the CDL errors that may occur and a description of each error
Image Banks
Cisco client devices supported by FSA 2.0 and higher have two image banks. One
bank is a disaster recovery application (DRA) bank; the other is the main bank.
When a device is staged, FSA will check the main bank to see if a valid image
already exists.
¾ If a valid image does not already exist in the main bank, a DRA trigger will load
an image from the headend.
¾ If a valid image does exist in the main bank, a prompt appears instructing the
operator to press the Down arrow key for 5 seconds to restart using the existing
image. If the operator chooses to skip this option, a DRA trigger will load an
image from the headend.
6
OL-29686-01
Using the Factory Staging Application
FSA Splash Screen
If you connect the device to a display monitor during staging, FSA will display a
status screen that shows the following information:
1 — FSA data version information.
2 — Progress of the Host download.
3 — Progress of the CableCARD download.
4 — Status details, error messages, and additional instructions.
Note: CableCARD download status is only applicable when staging CableCARD
host devices.
Starting FSA
The FSA loads and operates automatically after you complete the following steps.
1 Place the set-top in the staging area.
2 Connect the set-top to an active RF signal.
3 Connect the set-top to AC power. The FSA loads and looks for a code download
trigger and associated download method. See Common Download Triggers and
Methods for more information.
OL-29686-01
7
Using the Factory Staging Application
Host and CableCARD Download
The following table lists the behavior of the front panel LEDs that appear during the
FSA process.
8
State
Front Panel Display
(FPD)
Video Monitor
Display
Comments
Powered on
---- (four dashes)
Blank
The device is
powered on
Boot
boot
Blank
¡
The bootloader
has control of
the device
¡
Bootloader
errors display
in the format of
Erxx
Transition to FSA
(Connecting)
Conn
Hunting for host
software
download trigger
PEnd
Host software
downloading
Cd%%
FSA Splash screen
Diagnostics can be
displayed with the
proper button press
sequence (see
Diagnostics)
The OS (FSA) has
control of the settop
FSA Splash screen
Diagnostics can be
displayed with proper
button press sequence
(see Diagnostics)
FSA Splash screen
¡
FPD displays
Cd followed by
digits
representing
the percentage
complete of the
image
download
starting at 00
and ending at
99
¡
Jumps in the
counter
sequencing are
acceptable
Diagnostics can be
displayed with the
proper button press
sequence (see
Diagnostics)
OL-29686-01
Using the Factory Staging Application
State
Front Panel Display
(FPD)
Video Monitor
Display
Comments
CableCARD
image
downloading
(only applicable
when staging
CableCARD host
devices)
Alternate "dnLd"
CableCARD MMI
Screen
and "CArd"
Diagnostics can be
displayed with the
proper button press
sequence (see
Diagnostics)
If an error code is
being displayed on
the FPD, this
sequence shall not
be displayed and
the error code shall
be displayed
constantly
Download failed
Edxx
FSA splash screen
Diagnostics can be
displayed with proper
button press sequence
(see Diagnostics)
Download success Customer Application Customer Application
Specific
Specific
The complete list of
error conditions
and corresponding
error codes that
shall be supported
are listed in a
separate table later
in this section
The platform
software will not be
responsible for the
final state of the
FPD upon success
Display Dialog Message
On a CableCARD host, the CableCARD can request that the host display a dialog
message on the screen for the user. To return to the FSA status screen when a
CableCARD dialog message is displayed, press EXIT on the remote control.
To display the CableCARD dialog message again, press INFO on the remote control.
Force-Boot Into FSA
If you want to force-boot into the FSA, press and hold the power button on the front
panel while restarting the host. This performs a one-time override of the boot order
to selectively boot the FSA image instead of the main image.
Starting Newly Installed Host Software
After FSA has completed installation of the host software, the set-top box will be
restarted and the newly installed host software will begin its initialization process,
which may include additional staging tasks such as partitioning and formatting the
internal hard drive. Refer to the user guide of the installed host software for
additional instructions pertaining to startup and operation of the host software. For
OCAP™-based host software, refer to the OpenCable Host 2.1 Core Functional
Requirements for standard front panel diagnostics.
OL-29686-01
9
Troubleshooting
Troubleshooting
Introduction
This section provides a listing of the diagnostic screens that are available and the
code download error code descriptions for assistance in troubleshooting errors that
may occur during code download when using the FSA.
Diagnostics
To access standard diagnostic screens, press the power button on the front panel
until the power indicator flashes, then release and press the power button again.
You can also use the remote control to access diagnostic screens. Press and hold the
Exit key on the remote control for more than two seconds, then press Down, press
Down again, and press 2.
The following diagnostic screens are available in the FSA:
¾ Host Status Summary
¾ Host Boot Status Results
¾ Host Bootloader Information
¾ Host Component Information
¾ OpenCable - Common Download
¾ Linux - Memory Information
¾ CableCARD Conditional Access Application
¾ CableCARD Binding Information Application
¾ CableCARD IP Service Application
¾ CableCARD Network Interface [SCTE55-2] Application
¾ CableCARD Network Interface [SCTE55-1] Application
¾ CableCARD Copy Protection Application
¾ CableCARD Diagnostic Application
¾ CableCARD Network Interface (DSG) Application
¾ CableCARD CA Network Handler (CANH) Application
Notes:
¾ CableCARD pages only apply to CableCARD host devices and will vary when a
host contains a third-party CableCARD.
¾ FSA supports the following SNMP MIBs:
10
OpenCable Host Device 2.X MIB SPecification (OC-SP-MIB-HOST2.X-I12)
OL-29686-01
Troubleshooting
-
DOCS-CABLE-DEVICE-MIB (RFC 2669)
Code Download Errors and Descriptions
The following table provides a listing of code download errors, the error that
displays on the front panel of the set-top, and a description of each error.
Displayed Error Description
OL-29686-01
Ed01
No Failure
Ed02
Improper code file controls - CVC subject organizationName for
manufacturer does not match the Host device manufacturer name
Ed03
Improper code file controls - CVC subject organizationName for
code cosigning agent does not match the Host device current code
cosigning agent
Ed04
Improper code file controls – The manufacturer's PKCS #7
signingTime value is equal-to or less-than the codeAccessStart value
currently held in the Host device
Ed05
Improper code file controls – The manufacturer's PKCS #7 validity
start time value is less-than the cvcAccessStart value currently held
in the Host device
Ed06
Improper code file controls - The manufacturer's CVC validity start
time is less-than the cvcAccessStart value currently held in the Host
device
Ed07
Improper code file controls - The manufacturer's PKCS #7
signingTime value is less-than the CVC validity start time
Ed08
Improper code file controls - Missing or improper
extendedKeyUsage extension in the manufacturer CVC
Ed09
Improper code file controls - The cosigner's PKCS #7 signingTime
value is equal-to or less-than the codeAccessStart value currently
held in the Host device
Ed10
Improper code file controls - The cosigner's PKCS #7 validity start
time value is less-than the cvcAccessStart value currently held in the
Host device
Ed11
Improper code file controls - The cosigner's CVC validity start time
is less-than the cvcAccessStart value currently held in the Host
device
Ed12
Improper code file controls - The cosigner's PKCS #7 signingTime
value is less-than the CVC validity start time
Ed13
Improper code file controls - Missing or improper extended keyusage extension in the cosigner's CVC
Ed14
Code file manufacturer CVC validation failure
Ed15
Code file manufacturer CVS validation failure
Ed16
Code file cosigner CVC validation failure
11
Troubleshooting
Displayed Error Description
Ed17
Code file cosigner CVS validation failure
Ed18
Improper eCM configuration file CVC format (e.g. missing or
improper key usage attribute)
Ed19
eCM configuration file CVC validation failure
Ed20
Improper SNMP CVC format
Ed21
CVC subject organizationName for manufacturer does not match
the Host devices manufacturer name
Ed22
CVC subject organizationName for code cosigning agent does not
match the Host devices current code cosigning agent
Ed23
The CVC validity start time is less-than or equal-to the
corresponding subject's cvcAccessStart value currently held in the
Host device
Ed24
Missing or improper key usage attribute
Ed25
SNMP CVC validation failure
Ed26
Invalid Source ID or path name
Ed27
TFTP server is unresponsive or no IP address
Ed90
Corruption
Ed91
Exhausted maximum number of reboot retries
Ed98
General code download failure
Ed99
General code download error
ECUt
Invalid CVT
System Errors and Descriptions
Displayed Error Description
E899
Startup failed because device unique identity information is missing
E900 – E911
General startup failures enumerated by bootstage 0 – 11
E920
Failed to install the downloaded host code image
Bootloader Front Panel Display Codes
12
Message
Description
----
Bootloader start
-:-
Jump to image start address
OL-29686-01
Troubleshooting
OL-29686-01
Message
Description
Proc
Processing loaded image
USbE
USB/Ethernet loader init
Lnnn
Load messages
CLr
Erasing flash
PrG
Programming flash
donE
Finished with operation
tftp
TFTP download
ddc
DDC have been installed
Er:00
One of the clock inits failed
Er:01
Loading bootHi failure
Er:02
bootHi load memory fail
Er:03
Security check fail
Er:04
Compatibility error
Er:20
Failed reception after max retries
Er:21
xfer parameters wrong
Er:22
CRC on received image failed
Er:23
Wrong address (over/underflow)
Er:24
Start offset error
Er:27
Overflow - image too long
Er:30
Image length wrong
Er:31
CRC in signature failed
Er:32
Signature values wrong
Er:33
Image does not pass verification
Er:34
Header does not pass verification
Er:35
Image CRC does not match
Er:36
Image Sha does not match
Er:3E
Bootloader repl. - duplicate found
Er:3F
Bootloader replacement verification failed
Er:41
Failed communication with tuner
Er:45
QPSK receiver expected - not detected
Er:50
Disk not detected
Er:51
Disk not responding (during init)
Er:52
Timed out waiting for finish
13
Troubleshooting
14
Message
Description
Er:53
Error reported from disk
Er:54
DMA error during disk write
Er:55
DMA error during disk read
Er:56
Uncorrectable data
Er:57
Read fail, data corrected (overwrite)
Er:58
Operation aborted
Er:59
PHY error
Er:5A
DIsk addressing error
Er:60
Basic storage format established
Er:61
Reformat failed
Er:62
Invalid image list
Er:63
Failed check of one of module headers
Er:64
Boot image load fail
Er:65
Storage unavailable for boot/save
Er:66
Image invalidated due to 7-strike ovf
Er:67
File name too long
Er:6F
Invalid module number
Er:73
Tuner calibration failed
Er:74
Invalid LO1 status in ForceLock()
Er:75
LO1 is not locked
Er:76
LO2 is not locked
Er:77
Tuning/decode script error
Er:78
Wrong param passed to script proc.
Er:79
Timeout waiting for Agc settled
Er:80
USB hardware init failure
Er:81
Address resolution failed
Er:82
Address allocation failed
Er:83
Address allocation failed
Er:84
USB protocol failure
Er:85
Non specific security authentication
failure
Er:86
Killpill for device was not found
Er:87
Unsupport USB MSD Format
OL-29686-01
Troubleshooting
OL-29686-01
Message
Description
Er:90
Invalid flash configuration
Er:91
Error accessing NAND flash
Er:92
Timeout accessing NAND flash
Er:A0
Banker/Driver library init error
Er:A1
Banker table not found, used default
Er:A2
Banker failed to launch from table
Er:A3
Banker error
15
For Information
If You Have Questions
If you have technical questions, call Cisco Services for assistance. Follow the menu
options to speak with a service engineer.
Cisco Systems, Inc.
5030 Sugarloaf Parkway, Box 465447
Lawrenceville, GA 30042
678 277-1120
800-553-6387
www.cisco.com
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)
Product and service availability are subject to change without notice.
© 2013 Cisco and/or its affiliates. All rights reserved.
August 2013 Printed in USA
Part Number
OL-29686-01