gas: sparc: fix collision of registers and pseudo-ops.
[deliverable/binutils-gdb.git] / gas / doc / c-m68hc11.texi
index df80f8dfc4f5934a2d5ae35d21454ca70fae214c..abd6ee19adaafb6aa94cd229a53ecc602597b18b 100644 (file)
@@ -1,4 +1,4 @@
-@c Copyright (C) 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
+@c Copyright (C) 1991-2016 Free Software Foundation, Inc.
 @c This is part of the GAS manual.
 @c For copying conditions, see the file as.texinfo.
 @ifset GENERIC
 @c This is part of the GAS manual.
 @c For copying conditions, see the file as.texinfo.
 @ifset GENERIC
@@ -15,6 +15,8 @@
 @menu
 * M68HC11-Opts::                   M68HC11 and M68HC12 Options
 * M68HC11-Syntax::                 Syntax
 @menu
 * M68HC11-Opts::                   M68HC11 and M68HC12 Options
 * M68HC11-Syntax::                 Syntax
+* M68HC11-Modifiers::              Symbolic Operand Modifiers
+* M68HC11-Directives::             Assembler Directives
 * M68HC11-Float::                  Floating Point
 * M68HC11-opcodes::                Opcodes
 @end menu
 * M68HC11-Float::                  Floating Point
 * M68HC11-opcodes::                Opcodes
 @end menu
 
 @cindex options, M68HC11
 @cindex M68HC11 options
 
 @cindex options, M68HC11
 @cindex M68HC11 options
-The Motorola 68HC11 and 68HC12 version of @code{@value{AS}} has a few machine
+The Motorola 68HC11 and 68HC12 version of @code{@value{AS}} have a few machine
 dependent options.
 
 dependent options.
 
+@table @code
+
 @cindex @samp{-m68hc11}
 @cindex @samp{-m68hc11}
-This option switches the assembler in the M68HC11 mode. In this mode,
+@item -m68hc11
+This option switches the assembler into the M68HC11 mode. In this mode,
 the assembler only accepts 68HC11 operands and mnemonics. It produces
 code for the 68HC11.
 
 @cindex @samp{-m68hc12}
 the assembler only accepts 68HC11 operands and mnemonics. It produces
 code for the 68HC11.
 
 @cindex @samp{-m68hc12}
-This option switches the assembler in the M68HC12 mode. In this mode,
+@item -m68hc12
+This option switches the assembler into the M68HC12 mode. In this mode,
 the assembler also accepts 68HC12 operands and mnemonics. It produces
 the assembler also accepts 68HC12 operands and mnemonics. It produces
-code for the 68HC12. A fiew 68HC11 instructions are replaced by
+code for the 68HC12. A few 68HC11 instructions are replaced by
 some 68HC12 instructions as recommended by Motorola specifications.
 
 some 68HC12 instructions as recommended by Motorola specifications.
 
+@cindex @samp{-m68hcs12}
+@item -m68hcs12
+This option switches the assembler into the M68HCS12 mode.  This mode is
+similar to @samp{-m68hc12} but specifies to assemble for the 68HCS12
+series.  The only difference is on the assembling of the @samp{movb}
+and @samp{movw} instruction when a PC-relative operand is used.
+
+@cindex @samp{-mm9s12x}
+@item -mm9s12x
+This option switches the assembler into the M9S12X mode.  This mode is
+similar to @samp{-m68hc12} but specifies to assemble for the S12X
+series which is a superset of the HCS12.
+
+@cindex @samp{-mm9s12xg}
+@item -mm9s12xg
+This option switches the assembler into the XGATE mode for the RISC
+co-processor featured on some S12X-family chips.
+
+@cindex @samp{--xgate-ramoffset}
+@item --xgate-ramoffset
+This option instructs the linker to offset RAM addresses from S12X address
+space into XGATE address space.
+
+@cindex @samp{-mshort}
+@item -mshort
+This option controls the ABI and indicates to use a 16-bit integer ABI.
+It has no effect on the assembled instructions.
+This is the default.
+
+@cindex @samp{-mlong}
+@item -mlong
+This option controls the ABI and indicates to use a 32-bit integer ABI.
+
+@cindex @samp{-mshort-double}
+@item -mshort-double
+This option controls the ABI and indicates to use a 32-bit float ABI.
+This is the default.
+
+@cindex @samp{-mlong-double}
+@item -mlong-double
+This option controls the ABI and indicates to use a 64-bit float ABI.
+
 @cindex @samp{--strict-direct-mode}
 @cindex @samp{--strict-direct-mode}
+@item --strict-direct-mode
 You can use the @samp{--strict-direct-mode} option to disable
 the automatic translation of direct page mode addressing into
 extended mode when the instruction does not support direct mode.
 You can use the @samp{--strict-direct-mode} option to disable
 the automatic translation of direct page mode addressing into
 extended mode when the instruction does not support direct mode.
@@ -48,8 +97,9 @@ mode addressing. When it is used with the direct page mode,
 This option prevents @code{@value{AS}} from doing this, and the wrong
 usage of the direct page mode will raise an error.
 
 This option prevents @code{@value{AS}} from doing this, and the wrong
 usage of the direct page mode will raise an error.
 
-@cindex @samp{--short-branchs}
-The @samp{--short-branchs} option turns off the translation of
+@cindex @samp{--short-branches}
+@item --short-branches
+The @samp{--short-branches} option turns off the translation of
 relative branches into absolute branches when the branch offset is
 out of range. By default @code{@value{AS}} transforms the relative
 branch (@samp{bsr}, @samp{bgt}, @samp{bge}, @samp{beq}, @samp{bne},
 relative branches into absolute branches when the branch offset is
 out of range. By default @code{@value{AS}} transforms the relative
 branch (@samp{bsr}, @samp{bgt}, @samp{bge}, @samp{beq}, @samp{bne},
@@ -58,23 +108,26 @@ branch (@samp{bsr}, @samp{bgt}, @samp{bge}, @samp{beq}, @samp{bne},
 an absolute branch when the offset is out of the -128 .. 127 range.
 In that case, the @samp{bsr} instruction is translated into a
 @samp{jsr}, the @samp{bra} instruction is translated into a
 an absolute branch when the offset is out of the -128 .. 127 range.
 In that case, the @samp{bsr} instruction is translated into a
 @samp{jsr}, the @samp{bra} instruction is translated into a
-@samp{jmp} and the conditional branchs instructions are inverted and
+@samp{jmp} and the conditional branches instructions are inverted and
 followed by a @samp{jmp}. This option disables these translations
 and @code{@value{AS}} will generate an error if a relative branch
 is out of range. This option does not affect the optimization
 associated to the @samp{jbra}, @samp{jbsr} and @samp{jbXX} pseudo opcodes.
 
 followed by a @samp{jmp}. This option disables these translations
 and @code{@value{AS}} will generate an error if a relative branch
 is out of range. This option does not affect the optimization
 associated to the @samp{jbra}, @samp{jbsr} and @samp{jbXX} pseudo opcodes.
 
-@cindex @samp{--force-long-branchs}
-The @samp{--force-long-branchs} option forces the translation of
+@cindex @samp{--force-long-branches}
+@item --force-long-branches
+The @samp{--force-long-branches} option forces the translation of
 relative branches into absolute branches. This option does not affect
 the optimization associated to the @samp{jbra}, @samp{jbsr} and
 relative branches into absolute branches. This option does not affect
 the optimization associated to the @samp{jbra}, @samp{jbsr} and
-@samp{jbXX} pseudo opcodes. 
+@samp{jbXX} pseudo opcodes.
 
 @cindex @samp{--print-insn-syntax}
 
 @cindex @samp{--print-insn-syntax}
+@item --print-insn-syntax
 You can use the @samp{--print-insn-syntax} option to obtain the
 syntax description of the instruction when an error is detected.
 
 @cindex @samp{--print-opcodes}
 You can use the @samp{--print-insn-syntax} option to obtain the
 syntax description of the instruction when an error is detected.
 
 @cindex @samp{--print-opcodes}
+@item --print-opcodes
 The @samp{--print-opcodes} option prints the list of all the
 instructions with their syntax. The first item of each line
 represents the instruction name and the rest of the line indicates
 The @samp{--print-opcodes} option prints the list of all the
 instructions with their syntax. The first item of each line
 represents the instruction name and the rest of the line indicates
@@ -83,8 +136,10 @@ in alphabetical order. Once the list is printed @code{@value{AS}}
 exits.
 
 @cindex @samp{--generate-example}
 exits.
 
 @cindex @samp{--generate-example}
+@item --generate-example
 The @samp{--generate-example} option is similar to @samp{--print-opcodes}
 but it generates an example for each instruction instead.
 The @samp{--generate-example} option is similar to @samp{--print-opcodes}
 but it generates an example for each instruction instead.
+@end table
 
 @node M68HC11-Syntax
 @section Syntax
 
 @node M68HC11-Syntax
 @section Syntax
@@ -106,9 +161,28 @@ bset 2,x #4
 brclr *bot #8 foo
 @end smallexample
 
 brclr *bot #8 foo
 @end smallexample
 
+@cindex line comment character, M68HC11
+@cindex M68HC11 line comment character
+The presence of a @samp{;} character or a @samp{!} character anywhere
+on a line indicates the start of a comment that extends to the end of
+that line.
+
+A @samp{*} or a @samp{#} character at the start of a line also
+introduces a line comment, but these characters do not work elsewhere
+on the line.  If the first character of the line is a @samp{#} then as
+well as starting a comment, the line could also be logical line number
+directive (@pxref{Comments}) or a preprocessor control command
+(@pxref{Preprocessing}).
+
+@cindex line separator, M68HC11
+@cindex statement separator, M68HC11
+@cindex M68HC11 line separator
+The M68HC11 assembler does not currently support a line separator
+character.
+
 @cindex M68HC11 addressing modes
 @cindex addressing modes, M68HC11
 @cindex M68HC11 addressing modes
 @cindex addressing modes, M68HC11
-The following addressing modes are understood:
+The following addressing modes are understood for 68HC11 and 68HC12:
 @table @dfn
 @item Immediate
 @samp{#@var{number}}
 @table @dfn
 @item Immediate
 @samp{#@var{number}}
@@ -125,6 +199,173 @@ The @var{number} may be omitted in which case 0 is assumed.
 @samp{@var{symbol}}, or @samp{@var{digits}}
 @end table
 
 @samp{@var{symbol}}, or @samp{@var{digits}}
 @end table
 
+The M68HC12 has other more complex addressing modes. All of them
+are supported and they are represented below:
+
+@table @dfn
+@item Constant Offset Indexed Addressing Mode
+@samp{@var{number},@var{reg}}
+
+The @var{number} may be omitted in which case 0 is assumed.
+The register can be either @samp{X}, @samp{Y}, @samp{SP} or
+@samp{PC}.  The assembler will use the smaller post-byte definition
+according to the constant value (5-bit constant offset, 9-bit constant
+offset or 16-bit constant offset).  If the constant is not known by
+the assembler it will use the 16-bit constant offset post-byte and the value
+will be resolved at link time.
+
+@item Offset Indexed Indirect
+@samp{[@var{number},@var{reg}]}
+
+The register can be either @samp{X}, @samp{Y}, @samp{SP} or @samp{PC}.
+
+@item Auto Pre-Increment/Pre-Decrement/Post-Increment/Post-Decrement
+@samp{@var{number},-@var{reg}}
+@samp{@var{number},+@var{reg}}
+@samp{@var{number},@var{reg}-}
+@samp{@var{number},@var{reg}+}
+
+The number must be in the range @samp{-8}..@samp{+8} and must not be 0.
+The register can be either @samp{X}, @samp{Y}, @samp{SP} or @samp{PC}.
+
+@item Accumulator Offset
+@samp{@var{acc},@var{reg}}
+
+The accumulator register can be either @samp{A}, @samp{B} or @samp{D}.
+The register can be either @samp{X}, @samp{Y}, @samp{SP} or @samp{PC}.
+
+@item Accumulator D offset indexed-indirect
+@samp{[D,@var{reg}]}
+
+The register can be either @samp{X}, @samp{Y}, @samp{SP} or @samp{PC}.
+
+@end table
+
+For example:
+
+@smallexample
+ldab 1024,sp
+ldd [10,x]
+orab 3,+x
+stab -2,y-
+ldx a,pc
+sty [d,sp]
+@end smallexample
+
+
+@node M68HC11-Modifiers
+@section Symbolic Operand Modifiers
+
+@cindex M68HC11 modifiers
+@cindex syntax, M68HC11
+
+The assembler supports several modifiers when using symbol addresses
+in 68HC11 and 68HC12 instruction operands.  The general syntax is
+the following:
+
+@smallexample
+%modifier(symbol)
+@end smallexample
+
+@table @code
+@cindex symbol modifiers
+@item %addr
+This modifier indicates to the assembler and linker to use
+the 16-bit physical address corresponding to the symbol.  This is intended
+to be used on memory window systems to map a symbol in the memory bank window.
+If the symbol is in a memory expansion part, the physical address
+corresponds to the symbol address within the memory bank window.
+If the symbol is not in a memory expansion part, this is the symbol address
+(using or not using the %addr modifier has no effect in that case).
+
+@item %page
+This modifier indicates to use the memory page number corresponding
+to the symbol.  If the symbol is in a memory expansion part, its page
+number is computed by the linker as a number used to map the page containing
+the symbol in the memory bank window.  If the symbol is not in a memory
+expansion part, the page number is 0.
+
+@item %hi
+This modifier indicates to use the 8-bit high part of the physical
+address of the symbol.
+
+@item %lo
+This modifier indicates to use the 8-bit low part of the physical
+address of the symbol.
+
+@end table
+
+For example a 68HC12 call to a function @samp{foo_example} stored in memory
+expansion part could be written as follows:
+
+@smallexample
+call %addr(foo_example),%page(foo_example)
+@end smallexample
+
+and this is equivalent to
+
+@smallexample
+call foo_example
+@end smallexample
+
+And for 68HC11 it could be written as follows:
+
+@smallexample
+ldab #%page(foo_example)
+stab _page_switch
+jsr  %addr(foo_example)
+@end smallexample
+
+@node M68HC11-Directives
+@section Assembler Directives
+
+@cindex assembler directives, M68HC11
+@cindex assembler directives, M68HC12
+@cindex M68HC11 assembler directives
+@cindex M68HC12 assembler directives
+
+The 68HC11 and 68HC12 version of @code{@value{AS}} have the following
+specific assembler directives:
+
+@table @code
+@item .relax
+@cindex assembler directive .relax, M68HC11
+@cindex M68HC11 assembler directive .relax
+The relax directive is used by the @samp{GNU Compiler} to emit a specific
+relocation to mark a group of instructions for linker relaxation.
+The sequence of instructions within the group must be known to the linker
+so that relaxation can be performed.
+
+@item .mode [mshort|mlong|mshort-double|mlong-double]
+@cindex assembler directive .mode, M68HC11
+@cindex M68HC11 assembler directive .mode
+This directive specifies the ABI.  It overrides the @samp{-mshort},
+@samp{-mlong}, @samp{-mshort-double} and @samp{-mlong-double} options.
+
+@item .far @var{symbol}
+@cindex assembler directive .far, M68HC11
+@cindex M68HC11 assembler directive .far
+This directive marks the symbol as a @samp{far} symbol meaning that it
+uses a @samp{call/rtc} calling convention as opposed to @samp{jsr/rts}.
+During a final link, the linker will identify references to the @samp{far}
+symbol and will verify the proper calling convention.
+
+@item .interrupt @var{symbol}
+@cindex assembler directive .interrupt, M68HC11
+@cindex M68HC11 assembler directive .interrupt
+This directive marks the symbol as an interrupt entry point.
+This information is then used by the debugger to correctly unwind the
+frame across interrupts.
+
+@item .xrefb @var{symbol}
+@cindex assembler directive .xrefb, M68HC11
+@cindex M68HC11 assembler directive .xrefb
+This directive is defined for compatibility with the
+@samp{Specification for Motorola 8 and 16-Bit Assembly Language Input
+Standard} and is ignored.
+
+@end table
+
 @node M68HC11-Float
 @section Floating Point
 
 @node M68HC11-Float
 @section Floating Point
 
@@ -175,26 +416,26 @@ Certain pseudo opcodes are permitted for branch instructions.
 They expand to the shortest branch instruction that reach the
 target. Generally these mnemonics are made by prepending @samp{j} to
 the start of Motorola mnemonic. These pseudo opcodes are not affected
 They expand to the shortest branch instruction that reach the
 target. Generally these mnemonics are made by prepending @samp{j} to
 the start of Motorola mnemonic. These pseudo opcodes are not affected
-by the @samp{--short-branchs} or @samp{--force-long-branchs} options.
+by the @samp{--short-branches} or @samp{--force-long-branches} options.
 
 The following table summarizes the pseudo-operations.
 
 @smallexample
 
 The following table summarizes the pseudo-operations.
 
 @smallexample
-                              Displacement Width
-          +-------------------------------------------------------------+
-          |                     Options                                 |
-          |    --short-branchs            --force-long-branchs          |
-          +--------------------------+----------------------------------+
-Pseudo-Op |BYTE             WORD     | BYTE          WORD               |
-          +--------------------------+----------------------------------+
     bsr | bsr <pc-rel>    <error>  |               jsr <abs>          |
     bra | bra <pc-rel>    <error>  |               jmp <abs>          |
-     jbsr | bsr <pc-rel>   jsr <abs> | bsr <pc-rel>  jsr <abs>          |
-     jbra | bra <pc-rel>   jmp <abs> | bra <pc-rel>  jmp <abs>          |
-      bXX | bXX <pc-rel>    <error>  |               bNX +3; jmp <abs>  | 
-     jbXX | bXX <pc-rel>   bNX +3;   | bXX <pc-rel>  bNX +3; jmp <abs>  |
-          |                jmp <abs> |                                  |
-          +--------------------------+----------------------------------+
+                        Displacement Width
+     +-------------------------------------------------------------+
+     |                     Options                                 |
+     |    --short-branches           --force-long-branches         |
+     +--------------------------+----------------------------------+
+  Op |BYTE             WORD     | BYTE          WORD               |
+     +--------------------------+----------------------------------+
+ bsr | bsr <pc-rel>    <error>  |               jsr <abs>          |
+ bra | bra <pc-rel>    <error>  |               jmp <abs>          |
+jbsr | bsr <pc-rel>   jsr <abs> | bsr <pc-rel>  jsr <abs>          |
+jbra | bra <pc-rel>   jmp <abs> | bra <pc-rel>  jmp <abs>          |
+ bXX | bXX <pc-rel>    <error>  |               bNX +3; jmp <abs>  |
+jbXX | bXX <pc-rel>   bNX +3;   | bXX <pc-rel>  bNX +3; jmp <abs>  |
+     |                jmp <abs> |                                  |
+     +--------------------------+----------------------------------+
 XX: condition
 NX: negative of condition XX
 
 XX: condition
 NX: negative of condition XX
 
This page took 0.028225 seconds and 4 git commands to generate.