Hyderabad Technical WriterA blog for Technical Writing Tips and Tricks, Quick Reference Guides, Technology, Hyderabad, and India
What is a Firmware Support Manual?
The Firmware Support Manual (FSM) provides the information needed to program and reprogram the firmware devices of a system. It applies to read only memories (ROMs), Programmable ROMs (PROMs), Erasable PROMs (EPROMs), and other firmware devices.
The FSM describes the firmware devices and the equipment, software, and procedures needed to erase firmware devices, load software into the firmware devices, verify the load process, and mark the loaded firmware devices.
1. Scope
This section is divided into the following sub-sections.
1.1 Identification
This sub-section contains a full identification of the system, software, and firmware devices to which this document applies, including, as applicable, identification number(s), title(s), abbreviation(s), version number(s), and release number(s) of the system and software and manufacturer’s name and model number for each firmware device.
1.2 System overview
This sub-section briefly states the purpose of the system and the software to which this document applies. It describes the general nature of the system and software; summarizes the history of system development, operation, and maintenance; identifies the project sponsor, acquirer, user, developer, and support agencies; identify current and planned operating sites; and list other relevant documents.
1.3 Document overview
This sub-section summarizes the purpose and contents of this manual and describes any security or privacy considerations associated with its use.
2. Referenced documents
This section lists the number, title, revision, and date of all documents referenced in this manual. This section shall also identify the source for all documents not available through normal Government stocking activities.
3. Firmware programming instructions
This section shall be divided into the following sub-sections.
3.1 (Identifier of programmed firmware device)
This sub-section states the project-unique identifier of a programmed firmware device to be used in the system and is divided into the following sub-sections.
3.1.1 Description of pre-programmed device
This sub-section:
a. Identifies manufacturer’s name and model number the firmware device to be programmed
b. Provides a complete physical description of the firmware device, including the following, as applicable:
1) Memory size, type, speed, and configuration (such as 64Kx1, 8Kx8)
2) Operating characteristics (such as access time, power requirements,logic levels)
3) Pin functional descriptions
4) Logical interfaces (such as addressing scheme, chip selection)
5) Internal and external identification scheme used
6) Timing diagrams
c. Describes the operational and environmental limits to which the firmware device may be subjected and still maintain satisfactory operation
3.1.2 Software to be programmed into the device
This sub-section identifies by project-unique identifier(s) the software to be programmed into the firmware device.
3.1.3 Programming equipment
This sub-section describes the equipment to be used for programming and reprogramming the firmware device. It includes computer equipment, general purpose equipment, and special equipment to be used for device erasure, loading, verification, and marking, as applicable. Each piece of equipment identified by manufacturer’s name, model number, and any other information that is necessary to uniquely identifies that piece of equipment. A description of each piece of equipment provides, including its purpose, usage, and major capabilities.
3.1.4 Programming software
This sub-section describes the software to be used for programming and reprogramming the firmware device. It includes software to be used for device erasure, loading, verification, and marking, as applicable. Each software item is identified by vendor’s name, software name, number, version/release, and any other information necessary to uniquely identify the software item. A description of each software item is provided, including its purpose, usage, and major capabilities.
3.1.5 Programming procedures
This sub-section describes the procedures to be used for programming and reprogramming the firmware device. It includes procedures to be used for device erasure, loading, verification, and marking, as applicable. All equipment and software necessary for each procedure is identified, together with any security and privacy measures to be applied.
3.1.6 Installation and repair procedures
This sub-section contains the installation, replacement, and repair procedures for the firmware device. This sub-section also includes remove and replace procedures, device addressing scheme and implementation, description of the host board layout, and any procedures for ensuring continuity of operations in the event of emergencies. Safety precautions, marked by WARNING or CAUTION, is included where applicable.
3.1.7 Vendor information
This section includes or references any relevant information supplied by the vendor(s) of the firmware device, programming equipment, or programming software.
4. Notes
This section contains any general information that aids in understanding this document (for example, background information, glossary, rationale). This section includes an alphabetical listing of all acronyms, abbreviations, and their meanings and a list of terms and definitions needed to understand.
5. Appendixes
Appendixes may be used to provide information published separately for convenience in document maintenance (for example, charts, classified data). As applicable, each appendix is referenced in the main body of the document where the data would normally have been provided. Appendixes may be bound as separate documents for ease in handling. Appendixes are lettered alphabetically (A, B, and so on).
