<article>
<title>da65 Users Guide
-<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
-<date>2003-08-08
+<author>
+<url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
+<url url="mailto:greg.king5@verizon.net" name="Greg King">
+<date>2014-11-23
<abstract>
-da65 is a 6502/65C02 disassembler that is able to read user supplied
-information about its input data for better results. The output is ready for
+da65 is a 6502/65C02 disassembler that is able to read user-supplied
+information about its input data, for better results. The output is ready for
feeding into ca65, the macro assembler supplied with the cc65 C compiler.
</abstract>
macro assembler.
Besides generating output for ca65, one of the design goals was that the user
-is able to feed additional information about the code into the disassembler
+is able to feed additional information about the code into the disassembler,
for improved results. This information may include the location and size of
tables, and their format.
-o name Name the output file
-v Increase verbosity
-F Add formfeeds to the output
+ -s Accept line markers in the info file
-S addr Set the start/load address
-V Print the disassembler version
Long options:
+ --argument-column n Specify argument start column
+ --comment-column n Specify comment start column
--comments n Set the comment level for the output
--cpu type Set cpu type
--debug-info Add debug info to object file
--formfeeds Add formfeeds to the output
--help Help (this text)
+ --hexoffs Use hexadecimal label offsets
--info name Specify an info file
+ --label-break n Add newline if label exceeds length n
+ --mnemonic-column n Specify mnemonic start column
--pagelength n Set the page length for the listing
--start-addr addr Set the start/load address
+ --sync-lines Accept line markers in the info file
+ --text-column n Specify text start column
--verbose Increase verbosity
--version Print the disassembler version
---------------------------------------------------------------------------
<descrip>
+ <label id="option--argument-column">
+ <tag><tt>--argument-column n</tt></tag>
+
+ Specifies the column where the argument for a mnemonic or pseudo instruction
+ starts.
+
+
+ <label id="option--comment-column">
+ <tag><tt>--comment-column n</tt></tag>
+
+ Specifies the column where the comment for an instruction starts.
+
+
<label id="option--comments">
<tag><tt>--comments n</tt></tag>
<tag><tt>--cpu type</tt></tag>
Set the CPU type. The option takes a parameter, which may be one of
+ <itemize>
+ <item>6502
+ <item>6502x
+ <item>65sc02
+ <item>65c02
+ <item>huc6280
+ <item>4510
+ </itemize>
- 6502, 65SC02, 65C02
-
- Support for the 65816 is currently not available.
+ 6502x is for the NMOS 6502 with unofficial opcodes. huc6280 is the CPU of
+ the PC engine. 4510 is the CPU of the Commodore C65. Support for the 65816
+ currently is not available.
<label id="option--formfeeds">
<tag><tt>-g, --debug-info</tt></tag>
This option adds the <tt/.DEBUGINFO/ command to the output file, so the
- assembler will generate debug information when reassembling the generated
+ assembler will generate debug information when re-assembling the generated
output.
Print the short option summary shown above.
+ <label id="option--hexoffs">
+ <tag><tt>--hexoffs</tt></tag>
+
+ Output label offsets in hexadecimal instead of decimal notation.
+
+
<label id="option--info">
<tag><tt>-i name, --info name</tt></tag>
the output will go to the terminal.
+ <label id="option--label-break">
+ <tag><tt>--label-break n</tt></tag>
+
+ Adds a newline if the length of a label exceeds the given length.
+ Note: If the label would run into the code in the mid column, a
+ linefeed is always inserted regardless of this setting.
+
+ This option overrides the <ref id="global-options" name="global option">
+ <tt><ref id="LABELBREAK" name="LABELBREAK"></tt>.
+
+
+ <label id="option--mnemonic-column">
+ <tag><tt>--mnemonic-column n</tt></tag>
+
+ Specifies the column where a mnemonic or pseudo instrcuction is output.
+
+
<label id="option--pagelength">
<tag><tt>--pagelength n</tt></tag>
Specify the start/load address of the binary code that is going to be
disassembled. The given address is interpreted as an octal value if
- preceeded with a '0' digit, as a hexadecimal value if preceeded with '0x',
- '0X', or '$', and as a decimal value in all other cases. If no start address
- is specified, $10000 minus the size of the input file is used.
+ preceded with a '0' digit, as a hexadecimal value if preceded
+ with '0x', '0X', or '$', and as a decimal value in all other cases. If no
+ start address is specified, $10000 minus the size of the input file is used.
+
+
+ <label id="option--sync-lines">
+ <tag><tt>-s, --sync-lines</tt></tag>
+
+ Accept line markers in the info file in the following syntax:
+<tscreen><verb>
+#line <lineno> ["<filename>"]
+# <lineno> "<filename>" [<flag>] ...
+</verb></tscreen>
+ This option is intended for preprocessing info files with "cpp" or "m4".
+
+
+ <label id="option--text-column">
+ <tag><tt>--text-column n</tt></tag>
+
+ Specifies the column where additional text is output. This additional text
+ consists of the bytes encoded in this line in text representation.
<tag><tt>-v, --verbose</tt></tag>
latter understands the same opcodes as the former, plus 16 additional bit
manipulation and bit test-and-branch commands.
+When disassembling 4510 code, due to handling of 16-bit wide branches, da65
+can produce output that can not be re-assembled, when one or more of those
+branches point outside of the disassembled memory. This can happen when text
+or binary data is processed.
+
While there is some code for the 65816 in the sources, it is currently
unsupported.
The disassembler works by creating an attribute map for the whole address
space ($0000 - $FFFF). Initially, all attributes are cleared. Then, an
external info file (if given) is read. Disassembly is done in several passes.
-In all passes with the exception of the last one, information about the
+In all passes, with the exception of the last one, information about the
disassembled code is gathered and added to the symbol and attribute maps. The
last pass generates output using the information from the maps.
depends on the type of the attribute. String attributes are places in double
quotes, numeric attributes may be specified as decimal numbers or hexadecimal
with a leading dollar sign. There are also attributes where the attribute
-value is a keyword, in this case the keyword is given as is (without quotes or
+value is a keyword; in this case, the keyword is given as-is (without quotes or
anything). Each attribute is terminated by a semicolon.
<tscreen><verb>
- group-name { attribute1 attribute-value; attribute2 attribute-value; }
+ group-name { attribute1 attribute-value; attribute2 attribute-value; }
</verb></tscreen>
<sect1>Comments<p>
-Comments start with a hash mark (<tt/#/) and extend from the position of
-the mark to the end of the current line. Hash marks inside of strings will
-of course <em/not/ start a comment.
+Comments start with a hash mark (<tt/#/) or a double slash (<tt>//</tt>);
+and, extend from the position of the mark to the end of the current line.
+Hash marks or double slashes inside of strings will <em/not/ start a comment,
+of course.
<sect1>Specifying global options<label id="global-options"><p>
<descrip>
- <tag><tt>COMMENTS</tt></tag>
+ <tag><tt/ARGUMENTCOLUMN/</tag>
+ This attribute specifies the column in the output, where the argument for
+ an opcode or pseudo instruction starts. The corresponding command line
+ option is
+ <tt><ref id="option--argument-column" name="--argument-column"></tt>.
+
+
+ <tag><tt/COMMENTCOLUMN/</tag>
+ This attribute specifies the column in the output, where the comment starts
+ in a line. It is only used for in-line comments. The corresponding command
+ line option is
+ <tt><ref id="option--comment-column" name="--comment-column"></tt>.
+
+
+ <label id="COMMENTS">
+ <tag><tt/COMMENTS/</tag>
This attribute may be used instead of the <tt><ref id="option--comments"
name="--comments"></tt> option on the command line. It takes a numerical
parameter between 0 and 4. Higher values increase the amount of information
written to the output file in form of comments.
- <tag><tt>CPU</tt></tag>
+ <tag><tt/CPU/</tag>
This attribute may be used instead of the <tt><ref id="option--cpu"
- name="--cpu"></tt> option on the command line. It takes a string parameter.
+ name="--cpu"></tt> option on the command line. For possible values see
+ there. The value is a string and must be enclosed in quotes.
+
+
+ <tag><tt/HEXOFFS/</tag>
+ The attribute is followed by a boolean value. If true, offsets to labels are
+ output in hex, otherwise they're output in decimal notation. The default is
+ false. The attribute may be changed on the command line using the <tt><ref
+ id="option--hexoffs" name="--hexoffs"></tt> option.
- <tag><tt>INPUTNAME</tt></tag>
+ <tag><tt/INPUTNAME/</tag>
The attribute is followed by a string value, which gives the name of the
input file to read. If it is present, the disassembler does not accept an
input file name on the command line.
- <tag><tt>INPUTOFFS</tt></tag>
+ <tag><tt/INPUTOFFS/</tag>
The attribute is followed by a numerical value that gives an offset into
the input file which is skipped before reading data. The attribute may be
used to skip headers or unwanted code sections in the input file.
- <tag><tt>INPUTSIZE</tt></tag>
+ <tag><tt/INPUTSIZE/</tag>
<tt/INPUTSIZE/ is followed by a numerical value that gives the amount of
data to read from the input file. Data beyond <tt/INPUTOFFS + INPUTSIZE/
is ignored.
+ <label id="LABELBREAK">
+ <tag><tt/LABELBREAK/</tag>
+ <tt/LABELBREAK/ is followed by a numerical value that specifies the label
+ length that will force a newline. To have all labels on their own lines,
+ you may set this value to zero.
+
+ See also the <tt><ref id="option--label-break" name="--label-break"></tt>
+ command line option. A <tt/LABELBREAK/ statement in the info file will
+ override any value given on the command line.
+
+
+ <tag><tt/MNEMONICCOLUMN/</tag>
+ This attribute specifies the column in the output, where the mnemonic or
+ pseudo instruction is placed. The corresponding command line option is
+ <tt><ref id="option--mnemonic-column" name="--mnemonic-column"></tt>.
+
+
+ <tag><tt/NEWLINEAFTERJMP/</tag>
+ This attribute is followed by a boolean value. When true, a newline is
+ inserted after each <tt/JMP/ instruction. The default is false.
+
+
+ <tag><tt/NEWLINEAFTERRTS/</tag>
+ This attribute is followed by a boolean value. When true, a newline is
+ inserted after each <tt/RTS/ instruction. The default is false.
+
+
<label id="OUTPUTNAME">
- <tag><tt>OUTPUTNAME</tt></tag>
+ <tag><tt/OUTPUTNAME/</tag>
The attribute is followed by string value, which gives the name of the
output file to write. If it is present, specification of an output file on
the command line using the <tt><ref id="option-o" name="-o"></tt> option is
the output will go to the terminal.
- <tag><tt>PAGELENGTH</tt></tag>
+ <tag><tt/PAGELENGTH/</tag>
This attribute may be used instead of the <tt><ref id="option--pagelength"
name="--pagelength"></tt> option on the command line. It takes a numerical
parameter. Using zero as page length (which is the default) means that no
pages are generated.
- <tag><tt>STARTADDR</tt></tag>
+ <tag><tt/STARTADDR/</tag>
This attribute may be used instead of the <tt><ref id="option--start-addr"
name="--start-addr"></tt> option on the command line. It takes a numerical
parameter. The default for the start address is $10000 minus the size of
the input file (this assumes that the input file is a ROM that contains the
reset and irq vectors).
+
+ <tag><tt/TEXTCOLUMN/</tag>
+ This attribute specifies the column, where the data bytes are output
+ translated into ASCII text. It is only used if
+ <tt><ref id="COMMENTS" name="COMMENTS"></tt> is set to at least 4. The
+ corresponding command line option is
+ <tt><ref id="option--text-column" name="--text-column"></tt>.
+
</descrip>
<tag><tt>NAME</tt></tag>
The attribute is followed by a string value which gives the name of the
- label.
+ label. Empty names are allowed, in this case the disassembler will create
+ an unnamed label (see the assembler docs for more information about unnamed
+ labels).
<tag><tt>SIZE</tt></tag>
- This attribute is optional and may be used to specifiy the size of the data
+ This attribute is optional and may be used to specify the size of the data
that follows. If a size greater than 1 is specified, the disassembler will
create labels in the form <tt/label+offs/ for all bytes within the given
range, where <tt/label/ is the label name given with the <tt/NAME/
attribute, and <tt/offs/ is the offset within the data.
+ <tag><tt>PARAMSIZE</tt></tag>
+ This optional attribute is followed by a numerical value. It tells the
+ assembler that subroutine calls to this label are followed by
+ "inline parameters" with the given number of bytes, like this:
+
+<tscreen><verb>
+ JSR LabelWithParamSize2
+ .byte $00, $10
+ (return here)
+ code...
+</verb></tscreen>
+
</descrip>
+<sect1>Specifying Segments<label id="infofile-segment"><p>
+
+The <tt/SEGMENT/ directive is used to specify a segment within the
+disassembled code. The following attributes are recognized:
+
+<descrip>
+
+ <tag><tt>START</tt></tag>
+ Followed by a numerical value. Specifies the start address of the segment.
+
+ <tag><tt>END</tt></tag>
+ Followed by a numerical value. Specifies the end address of the segment. The
+ end address is the last address that is a part of the segment.
+
+ <tag><tt>NAME</tt></tag>
+ The attribute is followed by a string value which gives the name of the
+ segment.
+</descrip>
+
+All attributes are mandatory. Segments must not overlap. The disassembler will
+change back to the (default) <tt/.code/ segment after the end of each defined
+segment. That might not be what you want. As a rule of thumb, if you're using
+segments, you should define segments for all disassembled code.
+
+
<sect1>Specifying Assembler Includes<label id="infofile-asminc"><p>
The <tt/ASMINC/ directive is used to give the names of input files containing
symbol assignments in assembler syntax:
<tscreen><verb>
- Name = value
- Name := value
+ Name = value
+ Name := value
</verb></tscreen>
The usual conventions apply for symbol names. Values may be specified as hex
CPU "6502";
};
+ # One segment for the whole stuff
+ SEGMENT { START $E000; END $FFFF; NAME "kernal"; };
- RANGE { START $E612; END $E631; TYPE Code; };
- RANGE { START $E632; END $E640; TYPE ByteTable; };
- RANGE { START $EA51; END $EA84; TYPE RtsTable; };
- RANGE { START $EC6C; END $ECAB; TYPE RtsTable; };
- RANGE { START $ED08; END $ED11; TYPE AddrTable; };
+ RANGE { START $E612; END $E631; TYPE Code; };
+ RANGE { START $E632; END $E640; TYPE ByteTable; };
+ RANGE { START $EA51; END $EA84; TYPE RtsTable; };
+ RANGE { START $EC6C; END $ECAB; TYPE RtsTable; };
+ RANGE { START $ED08; END $ED11; TYPE AddrTable; };
- # Zero page variables
- LABEL { NAME "fnadr"; ADDR $90; SIZE 3; };
- LABEL { NAME "sal"; ADDR $93; };
- LABEL { NAME "sah"; ADDR $94; };
- LABEL { NAME "sas"; ADDR $95; };
+ # Zero-page variables
+ LABEL { NAME "fnadr"; ADDR $90; SIZE 3; };
+ LABEL { NAME "sal"; ADDR $93; };
+ LABEL { NAME "sah"; ADDR $94; };
+ LABEL { NAME "sas"; ADDR $95; };
# Stack
- LABEL { NAME "stack"; ADDR $100; SIZE 255; };
+ LABEL { NAME "stack"; ADDR $100; SIZE 255; };
# Indirect vectors
- LABEL { NAME "cinv"; ADDR $300; SIZE 2; }; # IRQ
- LABEL { NAME "cbinv"; ADDR $302; SIZE 2; }; # BRK
- LABEL { NAME "nminv"; ADDR $304; SIZE 2; }; # NMI
+ LABEL { NAME "cinv"; ADDR $300; SIZE 2; }; # IRQ
+ LABEL { NAME "cbinv"; ADDR $302; SIZE 2; }; # BRK
+ LABEL { NAME "nminv"; ADDR $304; SIZE 2; }; # NMI
# Jump table at end of kernal ROM
- LABEL { NAME "kscrorg"; ADDR $FFED; };
- LABEL { NAME "kplot"; ADDR $FFF0; };
- LABEL { NAME "kiobase"; ADDR $FFF3; };
- LABEL { NAME "kgbye"; ADDR $FFF6; };
+ LABEL { NAME "kscrorg"; ADDR $FFED; };
+ LABEL { NAME "kplot"; ADDR $FFF0; };
+ LABEL { NAME "kiobase"; ADDR $FFF3; };
+ LABEL { NAME "kgbye"; ADDR $FFF6; };
# Hardware vectors
- LABEL { NAME "hanmi"; ADDR $FFFA; };
- LABEL { NAME "hares"; ADDR $FFFC; };
- LABEL { NAME "hairq"; ADDR $FFFE; };
+ LABEL { NAME "hanmi"; ADDR $FFFA; };
+ LABEL { NAME "hares"; ADDR $FFFC; };
+ LABEL { NAME "hairq"; ADDR $FFFE; };
</verb></tscreen>
-
-
-<sect>Bugs/Feedback<p>
-
-If you have problems using the disassembler, if you find any bugs, or if
-you're doing something interesting with the assembler, I would be glad to hear
-from you. Feel free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
-name="uz@cc65.org">).
-
-
-
<sect>Copyright<p>
-da65 (and all cc65 binutils) are (C) Copyright 1998-2003 Ullrich von
-Bassewitz. For usage of the binaries and/or sources the following
+da65 (and all cc65 binutils) is (C) Copyright 1998-2011, Ullrich von
+Bassewitz. For usage of the binaries and/or sources, the following
conditions do apply:
This software is provided 'as-is', without any expressed or implied
freely, subject to the following restrictions:
<enum>
-<item> The origin of this software must not be misrepresented; you must not
- claim that you wrote the original software. If you use this software
- in a product, an acknowledgment in the product documentation would be
- appreciated but is not required.
-<item> Altered source versions must be plainly marked as such, and must not
- be misrepresented as being the original software.
-<item> This notice may not be removed or altered from any source
- distribution.
+<item> The origin of this software must not be misrepresented; you must not
+ claim that you wrote the original software. If you use this software
+ in a product, an acknowledgment in the product documentation would be
+ appreciated but is not required.
+<item> Altered source versions must be plainly marked as such, and must not
+ be misrepresented as being the original software.
+<item> This notice may not be removed or altered from any source
+ distribution.
</enum>
</article>
-
-
-
-
projects / cc65 / blobdiff