View RA17K_377219.PDF datasheet online --- IC-ON-LINE

Datasheet File OCR Text:

USER'S MANUAL
DOC17K
DOCUMENT PROCESSOR (PRELIMINARY)
(c)
1995
Document No. EEU-1536 (O. D. No. EEU-5006) Date Published May 1995 P Printed in Japan
SIMPLEHOST and emlC-17K are trademarks of NEC Corporation.
MS-DOS is a trademark of Microsoft Corporation. PC/AT and PC DOS are trademarks of IBM Corporation.
The information contained in this document is being issued in advance of the production cycle for the device. The parameters for the device may change before final production or NEC Corporation, at its own discretion, may withdraw the device prior to its production. No part of this document may be copied or reproduced in any form or by any means without the prior written consent of NEC Corporation. NEC Corporation assumes no responsibility for any errors which may appear in this document. NEC Corporation does not assume any liability for infringement of patents, copyrights or other intellectual property rights of third parties by or arising from use of a device described herein or any other liability arising from use of such device. No license, either express, implied or otherwise, is granted under any patents, copyrights or other intellectual property rights of NEC Corporation or of others.
Preface
Product Outline: The Document Processor (DOC17K) extracts program information from 17K Series relocatable assembler (RA17K) or C compiler (emlC-17KTM) source programs and documents the information in a specified format. Audience: This manual is aimed at those engineers who use RA17K or emlC-17K to develop application systems based on the 17K Series 4-bit single-chip microcontroller. Organization: This manual consists of the following chapters: General Running the Document Processor Types of Output Listings and Options Output Listings Error Messages Reading This Manual: The reader is assumed to be familiar with the concepts of RA17K or emlC-17K. Conventions: In this manual, the following symbols are used: ... [] {|} : Indicates repetition. : Elements in brackets are optional. : One of the characters or character strings, delimited by "|" in braces, must be selected. <> : The actual characters enclosed in the angular brackets are to be specified; often used to indicate a title. CR LF TAB : Carriage return. : Line feed. : Horizontal tab.
xxx Single-byte
: Any character string. : Single-byte character.
Double-byte(Note) : Double-byte character.
(Note) Only the PC-9800 version supports double-byte characters.
File Naming Conventions: [drive-name:][\directory-name\...]filename[.extension] A filename includes a drive name and a directory name. A drive name and directory name together constitute a pathname. Related Documents: Note that these related documents may be preliminary editions. These documents are not marked "Preliminary" in this manual. * Documents related to software tools Project Manager Version 1.00 User's Manual : To be released soon RA17K User's Manual RA17K Utility User's Manual LK17K User's Manual : To be released soon : To be released soon : To be released soon : EEU-1427 : This manual
emlC-17K Version 1.00 User's Manual
DOC17K User's Manual * Documents related to SIMPLEHOSTTM
SIMPLEHOST Version 2.0 corresponding to emlC-17K/RA17K
User's Manual, Tutorial: To be released soon
SIMPLEHOST Version 2.0 corresponding to emlC-17K/RA17K
User's Manual, Reference: To be released soon
The software package may contain a README.DOC file. The README.DOC file provides information that was not available when the manual was printed. Always read the contents of the README.DOC file before attempting to use the product.
Contents
Chapter 1
General ..............................................................................1-1
1.1 1.2 1.3 1.4 1.5 1.6 Configuration ........................................................................1-1 Outline of Functions ............................................................1-2 System Configuration ..........................................................1-3
1.3.1 Files That Are Referenced or Created ......................................1-4
Operating Environment .......................................................1-5 Environmental Variable .......................................................1-5 Limitations .............................................................................1-6
Chapter 2
Running the Document Processor ..............................2-1
2.1 Execution ...............................................................................2-1
2.1.1 2.1.2 2.1.3 Execution Procedure ...................................................................2-1 Sample Runs ................................................................................2-3 Sample Runs without Parameters .............................................2-5
2.2 2.3
Start and End Messages ...................................................2-16 Cancellation (CTRL + C) ...................................................2-17
Chapter 3
Supported Output Listings and Options ..................3-11
3.1 Options ...................................................................................3-1
3.1.1 3.1.2 3.1.3 Options That Specify a Listing Utility ........................................3-2 Options Common to All Listing Utilities .....................................3-4 Listing-Specific Options ..............................................................3-6
Chapter 4
Output Listing ..................................................................4-1
4.1 4.2 4.3 Option Information Listing .................................................4-1 Absolute Address Format Listing .....................................4-3 Cross-Reference Listing .....................................................4-7
4.3.1 4.3.2 Embedded Cross-References.....................................................4-7 Table Cross-References .............................................................4-9 Map Listings ...............................................................................4-13 Symbol Listing ............................................................................4-18
4.4
Module Map and Program Map Listings ........................4-13
4.4.1 4.4.2
DOC17K User's Manual
TOC - 1
Contents
4.5 4.6
Report Listing .....................................................................4-20 Document Listing ...............................................................4-24
4.6.1 4.6.2 4.6.3 Document Listing .......................................................................4-24 Summary Rules..........................................................................4-28 Format Definition .......................................................................4-33
4.7 4.8 4.9
Call Tree Listing .................................................................4-39 Module Listing ....................................................................4-40 Address Map .......................................................................4-42
Chapter 5
Error Messages ...............................................................5-1
5.1 Error Handling ..........................................................................5-1 5.2 Error Messages ........................................................................5-1 5.3 System Error Messages .........................................................5-6
TOC - 2
DOC17K User's Manual
List of Figures
(1/1)
Figure 1-1. Figure 1-2. Figure Figure Figure Figure 3-1. 3-2. 3-3. 3-4.
DOC17K Functions ..................................................................................................1-1 DOC17K System Configuration ..............................................................................1-3 Report Listing Output Format (Default) ...............................................................3-13 Document Listing Output Format (Default) ..........................................................3-14 Module Listing Output Format (Default) ..............................................................3-16 Address Map Output Format .................................................................................3-16 Sample Memory Map Listing ................................................................................4-14 Representation of a Data Memory Map Greater than One ...............................4-15 Summary Layout ....................................................................................................4-29
Figure 4-1. Figure 4-2. Figure 4-3.
DOC17K User's Manual
TOC - 3
Contents
[MEMO]
TOC - 4
DOC17K User's Manual
List of Tables
(1/1)
Table 2-1. Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table 3-1. 3-2. 3-3. 3-4. 3-5. 3-6. 3-7. 3-8. 3-9. 3-10. 3-11. 3-12. 3-13. 3-14. 3-15. 3-16. 3-17. 3-18. 3-19. 3-20. 3-21. 3-22. 3-23. 3-24. 3-25.
Listing Utilities ..........................................................................................................2-1 Types of Output Listings and Options ...................................................................3-1 Options That Specify a Listing Utility .....................................................................3-2 Input Files Required to Enable Listing Output ......................................................3-3 Input File Extensions ...............................................................................................3-4 Options That Are Common to All Listing Utilities .................................................3-4 -TAB Option Settings ...............................................................................................3-5 -FORM Option Settings ...........................................................................................3-5 -HEAD Option Settings ............................................................................................3-6 Absolute Address Format Listing Options .............................................................3-6 -GEN Option Settings ..............................................................................................3-7 -COND Option Settings ...........................................................................................3-7 -SEQ Option Settings ..............................................................................................3-7 -BRANCH Option Settings ......................................................................................3-8 Module Map Listing and Program Map Listing Options .......................................3-8 -AXIS Option Settings ..............................................................................................3-9 -LINEKIND Option Settings .....................................................................................3-9 -LINEKIND Option Settings (Detailed Settings) ..................................................3-10 -SEPARATE Option Settings ................................................................................3-10 -SORT Option Settings ..........................................................................................3-11 Cross-Reference Listing Option............................................................................3-12 -XFORM Option Settings .......................................................................................3-12 Report Listing Option .............................................................................................3-12 Document Listing Options .....................................................................................3-13 Call Tree Listing Option .........................................................................................3-15 Module Listing Options ..........................................................................................3-15 Relationship Between Components of Contents and Program Units ...............4-25 Reserved Item Names in the Format Definition File ..........................................4-34 Error Messages ........................................................................................................5-2
Table 4-1. Table 4-2. Table 5-1.
DOC17K User's Manual
TOC - 5
Contents
[MEMO]
TOC - 6
DOC17K User's Manual
Chapter 1
General
The Document Processor (DOC17K) extracts program information from relocatable assembler (RA17K) or C compiler (emlC-17K) source programs and documents the information in a specified format.
1.1 Configuration
The multi-functional Document Processor consists of several sets of utilities and programs that manage these utilities.
Figure 1-1. DOC17K Functions
DOC17K Document Processor
Document generation functions : Document listing utility SPEC17K : Module listing utility MOD17K TREE17K(Note) : Call tree listing utility
Cross-reference generation functions XREF17K : Cross-reference listing utility PUB17K : Public cross-reference listing utility
Report writing function REP17K: Report listing utility
Memory map generation functions MAP17K : Module map listing utility AMAP17K: Program map listing utility MOD17K : Address map output (produced with the module listing utility)
(Note) Available only when emlC-17K is used.
DOC17K User's Manual
1-1
Chapter 1
General
1.2 Outline of Functions
The Document Processor provides the following functions:
(1) Document generation
The Document Processor produces the following document components: (a) Contents The titles assigned to all blocks are output as a table of contents. (b) Program specifications Module (including routine) information in a summary format. (c) Module listing A listing of each module file and its routines. (d) Module configuration A call tree listing (supported only when emlC-17K is being used).
(2) Cross-reference (symbol cross-reference) generation
The Document Processor can produce two kinds of listing: module-specific cross-reference listings and program public symbol cross-reference listings.
(3) Memory map generation
(a) Memory map/flag map The Document Processor can produce two kinds of maps: module-specific memory maps and program memory maps. (b) Symbol list
(4) Report writing function
(a) Listing file reformatting (b) Report (log file) reformatting
1-2
DOC17K User's Manual
Chapter 1
General
1.3 System Configuration
Figure 1-2 shows the configuration of the DOC17K system.
Figure 1-2. DOC17K System Configuration
Source file Device file
RA17K (Relocatable assembler) REL file (.REL) Intermediate PRN file (.IPN) XREF data file (.IXF) Summary file (.SUM) Log file (.LOG)
emlC-17K (C compiler)
Preprocessing file (.PPL) XREF data file (.IXF) Summary file (.SUM) Log file (.LOG)
LK17 (Linker)
LNK file (.LNK)
DOC17K (Document processor)
Absolute address format listing Cross-reference listing (.XRF) (.PRN) -> Output with LIST17K -> Output with XREF17K
Public cross-reference listing (.PUB) -> Output with PUB17K
Report listing (.REP) -> Output with REP17K
Module map listing (.MAP) -> Output with MAP17K
Program map list (.AMP) -> Output with AMAP17K
Document listing (.SPC) -> Output with SPEC17K
Module listing (.MOD) -> Output with MOD17K
Call tree listing (.TRE) -> Output with TREE17K available only when emlC-17K is used.
DOC17K User's Manual
1-3
Chapter 1
General
1.3.1 Files That Are Referenced or Created
(1) Files that are referenced
(a) REL file (.REL) A file of relocatable object codes and assembly (or compilation) information, produced by RA17K or emlC-17K. A LNK file (.LNK) must be specified at the same time, by specifying the -LNK option. (b) Log file (.LOG) A file recording the messages output by RA17K or emlC-17K upon assembly or compilation. (c) Intermediate PRN file (.IPN) An assembly result list file produced by RA17K. (d) Preprocessing file (.PPL) A precompilation result list file produced by emlC-17K. (e) Cross-reference data file (.IXF) An information file used to produce a symbol cross-reference listing. (f) Summary file (.SUM) A file of information defined by a SUMMARY pseudo instruction.
(2) Files that are created
(a) Absolute address format listing (.PRN) An edited listing, represented in absolute address format, of the contents of an intermediate PRN file, along with the address and object codes stored in it. (b) Cross-reference listing (.XRF) An edited listing of cross-reference information. (c) Public cross-reference listing (.PUB) An edited listing of cross-references between the public symbols of a program. (d) Module map listing (.MAP) A module-specific data memory map, presented as a table. (e) Program map listing (.AMP) A program data memory map, presented as a table.
1-4
DOC17K User's Manual
Chapter 1
General
(f) Report listing (.REP) Run-time information, produced by RA17K or emlC-17K, presented as a listing. (g) Document listing (.SPC) Summary information, and information derived from an intermediate PRN file, presented as a document. (h) Call tree listing (.TRE) A tree listing of all the functions defined and referenced by emlC-17K. (i) Module listing (.MOD) A module file-specific routine listing, which may contain a program address map if needed.
1.4 Operating Environment
DOC17K requires the operating environment described below: * Host machine : NEC PC-9800 Series IBM PC/ATTM * OS : MS-DOSTM Ver.3.30 or higher PC DOSTM Ver.5.02 or higher * Main memory : 640K bytes or more. At least 400K bytes of free memory is required. * Extended memory (EMS) : At least 1M byte of extended memory is recommended. * External storage : At least 1M byte. (The use of a hard disk is recommended.)
1.5 Environmental Variable
The following environmental variable is used with DOC17K: TMP: Specifies a temporary file search path. If more than one path is specified, only that specified first becomes valid. Paths are used in the following order: <1> If a work path option (-WORK) is specified, temporary files are created on that path. <2> If environmental variable TMP is specified, temporary files are created on that path. <3> If neither <1> nor <2> is specified, temporary files are created on the current path.
DOC17K User's Manual
1-5
Chapter 1
General
1.6 Limitations
The limitations imposed on DOC17K are summarized below: (1) Utilities other than MAP17K support up to 8,000 symbols. MAP17K supports up to 6,000 symbols for each data memory bank of the device (17K Series). If EMS memory is available, a symbol area is allocated in EMS memory; otherwise, it is allocated in main memory. When EMS memory is not available, the number of symbols supported is limited by the amount of free main memory. (2) During list processing, a work area is allocated as needed. The size of the allocated work area depends on the number of symbols to be processed. The size of the work area that can be allocated is limited by the amount of free main memory in the host.
1-6
DOC17K User's Manual
Chapter 2
Running the Document Processor
2.1 Execution
The Document Processor runs the individual listing utilities for which options have been specified. Run the Document Processor (DOC17K) to produce all the listings at one time. The listing utilities may also be run independently.
2.1.1 Execution Procedure
(1) Command
* Running DOC17K >DOC17K[.EXE]-LNK=[-

▲Up To Search▲

Price & Availability of RA17K

	To Download RA17K Datasheet File
If you can't view the Datasheet, Please click here to try to view without PDF Reader .