DATA ITEM DESCRIPTION

DATA ITEM DESCRIPTION						Form Approved OMB No. 0704-0188
1. TITLE FIRMWARE SUPPORT MANUAL				1. IDENTIFICATION NUMBER DI-MCCR-80022A
3. DESCRIPTION, PURPOSE 3.1 The Firmware Support Manual (FMS) provides the information necessary to load software or data into firmware components of a system. It is equally applicable to read only memory (ROMs), Programmable ROMs (PROMs), Erasable PROMs (EPROMs), and other firmware devices. (continued on page 2)
4. APPROVAL DATE (YYMMDD) 880229	5. OFFICE OF PRIMARY RESPONSIBILITY (OPR) E C		6a. DTIC APPLICABLE		6b. GIDEP APPLICABLE
7. APPLICATION/INTERRELATIONSHIP 7.1 This Data Item Description (DID) contains the format and content preparation instructions for data generated under the work tasks described by paragraph 4.6.4 of DOD-STD-2167A. 7.2 The Contract Data Requirements List should specify whether this document is to be prepared and delivered on bound 8-1/2 by 11 inch bond paper or electronic media. If electronic media is selected, the precise format must be specified. (continued on page 2)
8. APPROVAL LIMITATION		9a. APPLICABLE FORMS				9b. AMSC NUMBER N4338
10. PREPARATION INSTRUCTIONS 10.1 Content and format instructions. Production of this document using automated techniques is encouraged. Specific content and format instructions for this document are identified below. a. Response to tailoring instructions. In the event that a paragraph or subparagraph has been tailored out, a statement to that effect shall be added directly following the heading of each such (sub)paragraph. If a paragraph and all of its subparagraphs are tailored out, only the highest level paragraph heading need be included. b. Use of alternate presentation styles. Charts, tables, matrices, or other presentation styles are acceptable when the information required by the paragraphs and subparagraphs of this DID can be made more readable. c. Page numbering. Each page prior to Section 1 shall be numbered in lower-case Roman numerals beginning with page ii for the Table of Contents. Each page starting from Section 1 to the beginning of the appendixes shall be consecutively numbered in Arabic numerals. If the document is divided into volumes, each such volume shall restart the page numbering sequence. (continued on page 2)
11. DISTRIBUTION STATEMENT DISTRIBUTION STATEMENT A. Approved for public release; distribution is unlimited

3. DESCRIPTION/PURPOSE (continued)

3.2 The FSM describes the aspects of the firmware devices, support software, support equipment, and the procedures required to load software into firmware devices to verify the load process and to test the firmware device for proper functioning.

7. APPLICATION/INTERRELATIONSHIP (continued)

7.3 This DID supersedes DI-MCCR-80022 dated 4 June 1985.

10. PREPARATION INSTRUCTIONS (continued)

d. Document control numbers. For hard copy formats, this document may be printed on one or both sides of each page (single-sided/double-sided). All printed pages shall contain the document control number and the date of the document centered at the top of the page. Document control numbers shall include revision and volume identification as applicable.

e. Multiple (sub)paragraphs. All paragraphs and subparagraphs starting with the phrase "This (sub)paragraph shall..." may be written as multiple subparagraphs to enhance readability. These subparagraphs shall be numbered sequentially.

f. Document structure. This manual shall consist of the following:

(1) Cover

(2) Title page

(3) Table of contents

(4) Scope

(5) Referenced documents

(6) Firmware device information

(7) Programming equipment and procedures

(8) Vendor information

(9) Notes

(10) Appendixes.

10. PREPARATION INSTRUCTIONS (continued)

10.1.1 Title page. The title page shall contain the information identified below in the indicated format:

[Document control number and date: Volume x of y (if multi-volume]

[Rev. indicator: date of Rev.]

FIRMWARE SUPPORT MANUAL

FOR THE

[SYSTEM NAME]

CONTRACT NO. [contract number]

CDRL SEQUENCE NO. [CDRL number]

Prepared for:

[Contracting Agency Name, department code]

Prepared by:

[contractor name and address]

10.1.2 Table of contents. This document shall contain a table of contents listing the title and page number of each titled paragraph and subparagraph. The table of contents shall then list the title and page number of each figure, table, and appendix, in that order.

10.1.3 Scope. This section shall be numbered 1 and shall be divided into the following paragraphs.

10.1.3.1 Identification. This paragraph shall be numbered 1.1 and shall contain the approved identification number, version numbers, CSCI revision number, title, and abbreviation, if applicable, of the computer system to which this FSM applies. This paragraph shall also identify by name and number all firmware components to which this FSM applies.

10.1.3.2 System overview. This paragraph shall be numbered 1.2 and shall briefly state the purpose of the system and the software to which this FSM applies.

10.1.3.3 Document overview. This paragraph shall be numbered 1.3 and shall summarize the purpose and contents of this manual.

10.1.4 Referenced documents. This section shall be numbered 2 and shall list by document number and title all documents referenced in this document. This section shall also identify the source for all documents not available through normal Government stocking activities.

10.1.5 Firmware device information This section shall be numbered 3 and shall be divided into the following paragraphs to describe the firmware devices. This section may reference commercially available documents for the information required by the following paragraphs and subparagraphs.

10.1.5.1 Device description. This subparagraph shall be numbered .3.1 and shall contain a complete physical description of the firmware components of the system. This paragraph shall provide the following for each device:

a. Device name and manufacturer's identification and number

b. Memory size

c. Operating characteristics (e.g., access time, power requirements, logic levels)

d. Pin functional descriptions

e. Logical interfaces (e.g., addressing scheme, chip selection, etc.)

f. Internal and external identification scheme used with each device

g. Timing diagrams.

10.1.5.2 Installation and repair procedures. This subparagraph shall be numbered 3.2 and shall contain all installation, replacement, and repair procedures for the firmware devices. This paragraph shall also include remove-and-replace procedures, device addressing scheme and implementation, socket number for each device, and description of the host board layout.

10.1.5.3 Security. This subparagraph shall be numbered 3.3 and shall describe any security measures to be applied to the devices and the supporting hardware and software.

10.1.5.4 Limitations. This subparagraph shall be numbered 3.4 and shall describe the operational and environmental limits to which the devices may be subjected and still maintain satisfactory operation. This data shall be provided for all firmware components of the system.

10.1.5.5 Programming equipment and procedures. This paragraph shall be numbered 3.5 and shall be divided into the following subparagraphs to contain the procedures necessary to operate the computer system once the initiation procedures are complete. If more than one mode of operation is available, instructions for each mode shall be provided.

10.1.6 Input and output procedures. This subparagraph shall be numbered 4 and shall be divided into the following paragraphs to provide a description of the equipment, software, and procedures to be used for programming and reprogramming all firmware components of the system. This section may reference commercially available documents for the information required by the following paragraphs and subparagraphs.

10.1.6.1 Programming hardware. This paragraph shall be numbered 4.1 and shall describe the equipment to be used for programming and reprogramming each firmware device. It shall include computer peripherals, general purpose equipment, and special equipment used for device loading, burn-in, and test (including verification that the proper content is stored). Each piece of equipment shall be identified by manufacturer, manufacturer's designation, and any other information that is necessary to uniquely identify that piece of equipment. A description of each piece of equipment shall be provided, including its purpose. usage, and major capabilities.

10.1.6.2 Programming software. This subparagraph shall be numbered 4.2 and shall describe the software to be used for programming and reprogramming each firmware device, including software for device loading, burn-in, and test. Utility programs to be used shall also be described. Each software item shall be identified by vendor, vendor's designation, version, and any special features. A description of each software item shall be provided, including its purpose, usage, and major capabilities.

10.1.6.3 Loading procedures. This paragraph shall be numbered 4.3 and shall describe the procedures to be used for programming and reprogramming each firmware device, including device loading, verification, and test. All equipment and software necessary for each procedure shall be identified.

10.1.7 Vendor information. This subparagraph shall be numbered 5 and shall include information supplied by the device vendor or reference the appropriate commercially available document(s). This section shall also include all commercially available information for support equipment and software or shall reference the commercially available document(s).

10.1.8 Notes. This section shall be numbered 6 and shall contain any general information that aids in understanding this document, (i.e., background information, glossary). This section shall include an alphabetical listing of all acronyms, abbreviations, and their meanings as used in this document.

10.1.9 Appendixes. Appendixes may be used to provide information published separately for convenience in document maintenance (e.g. charts, classified data). As applicable, each appendix shall be 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 shall be lettered alphabetically (A, B, etc.), and the paragraphs within each appendix be numbered as multiples of 10 (e.g., Appendix A, paragraph 10, 10.1, 10.2, 20, 20.1, 20.1, etc.). Pages within each appendix shall be numbered alpha-numerically as follows: Appendix A pages shall be numbered A-1, A-2, A-3, etc. Appendix B pages shall be numbered B-1, B-2, B-3, etc.