gas/doc/c-mips.texi

   1 @c Copyright (C) 1991, 92, 93, 94, 95, 1997 Free Software Foundation, Inc.
   2 @c This is part of the GAS manual.
   3 @c For copying conditions, see the file as.texinfo.
   4 @ifset GENERIC
   5 @page
   6 @node MIPS-Dependent
   7 @chapter MIPS Dependent Features
   8 @end ifset
   9 @ifclear GENERIC
  10 @node Machine Dependencies
  11 @chapter MIPS Dependent Features
  12 @end ifclear
  13
  14 @cindex MIPS processor
  15 @sc{gnu} @code{@value{AS}} for @sc{mips} architectures supports several
  16 different @sc{mips} processors, and MIPS ISA levels I through IV.  For
  17 information about the @sc{mips} instruction set, see @cite{MIPS RISC
  18 Architecture}, by Kane and Heindrich (Prentice-Hall).  For an overview
  19 of @sc{mips} assembly conventions, see ``Appendix D: Assembly Language
  20 Programming'' in the same work.
  21
  22 @menu
  23 * MIPS Opts::           Assembler options
  24 * MIPS Object::         ECOFF object code
  25 * MIPS Stabs::          Directives for debugging information
  26 * MIPS ISA::            Directives to override the ISA level
  27 * MIPS autoextend::     Directives for extending MIPS 16 bit instructions
  28 * MIPS insn::           Directive to mark data as an instruction
  29 * MIPS option stack::   Directives to save and restore options
  30 @end menu
  31
  32 @node MIPS Opts
  33 @section Assembler options
  34
  35 The @sc{mips} configurations of @sc{gnu} @code{@value{AS}} support these
  36 special options:
  37
  38 @table @code
  39 @cindex @code{-G} option (MIPS)
  40 @item -G @var{num}
  41 This option sets the largest size of an object that can be referenced
  42 implicitly with the @code{gp} register.  It is only accepted for targets
  43 that use @sc{ecoff} format.  The default value is 8.
  44
  45 @cindex @code{-EB} option (MIPS)
  46 @cindex @code{-EL} option (MIPS)
  47 @cindex MIPS big-endian output
  48 @cindex MIPS little-endian output
  49 @cindex big-endian output, MIPS
  50 @cindex little-endian output, MIPS
  51 @item -EB
  52 @itemx -EL
  53 Any @sc{mips} configuration of @code{@value{AS}} can select big-endian or
  54 little-endian output at run time (unlike the other @sc{gnu} development
  55 tools, which must be configured for one or the other).  Use @samp{-EB}
  56 to select big-endian output, and @samp{-EL} for little-endian.
  57
  58 @cindex MIPS architecture options
  59 @item -mips1
  60 @itemx -mips2
  61 @itemx -mips3
  62 @itemx -mips4
  63 Generate code for a particular MIPS Instruction Set Architecture level.
  64 @samp{-mips1} corresponds to the @sc{r2000} and @sc{r3000} processors,
  65 @samp{-mips2} to the @sc{r6000} processor, @samp{-mips3} to the
  66 @sc{r4000} processor, and @samp{-mips4} to the @sc{r8000} and
  67 @sc{r10000} processors.  You can also switch instruction sets during the
  68 assembly; see @ref{MIPS ISA,, Directives to override the ISA level}.
  69
  70 @item -mips16
  71 @itemx -no-mips16
  72 Generate code for the MIPS 16 processor.  This is equivalent to putting
  73 @samp{.set mips16} at the start of the assembly file.  @samp{-no-mips16}
  74 turns off this option.
  75
  76 @item -m4010
  77 @itemx -no-m4010
  78 Generate code for the LSI @sc{r4010} chip.  This tells the assembler to
  79 accept the @sc{r4010} specific instructions (@samp{addciu}, @samp{ffc},
  80 etc.), and to not schedule @samp{nop} instructions around accesses to
  81 the @samp{HI} and @samp{LO} registers.  @samp{-no-m4010} turns off this
  82 option.
  83
  84 @item -m4650
  85 @itemx -no-m4650
  86 Generate code for the MIPS @sc{r4650} chip.  This tells the assembler to accept
  87 the @samp{mad} and @samp{madu} instruction, and to not schedule @samp{nop}
  88 instructions around accesses to the @samp{HI} and @samp{LO} registers.
  89 @samp{-no-m4650} turns off this option.
  90
  91 @itemx -m3900
  92 @itemx -no-m3900
  93 @itemx -m4100
  94 @itemx -no-m4100
  95 For each option @samp{-m@var{nnnn}}, generate code for the MIPS
  96 @sc{r@var{nnnn}} chip.  This tells the assembler to accept instructions
  97 specific to that chip, and to schedule for that chip's hazards.
  98
  99 @item -mcpu=@var{cpu}
 100 Generate code for a particular MIPS cpu.  It is exactly equivalent to
 101 @samp{-m@var{cpu}}, except that there are more value of @var{cpu}
 102 understood.  Valid @var{cpu} value are:
 103
 104 @quotation
 105 2000,
 106 3000,
 107 3900,
 108 4000,
 109 4010,
 110 4100,
 111 4111,
 112 4300,
 113 4400,
 114 4600,
 115 4650,
 116 5000,
 117 6000,
 118 8000,
 119 10000
 120 @end quotation
 121
 122
 123 @cindex @code{-nocpp} ignored (MIPS)
 124 @item -nocpp
 125 This option is ignored.  It is accepted for command-line compatibility with
 126 other assemblers, which use it to turn off C style preprocessing.  With
 127 @sc{gnu} @code{@value{AS}}, there is no need for @samp{-nocpp}, because the
 128 @sc{gnu} assembler itself never runs the C preprocessor.
 129
 130 @item --trap
 131 @itemx --no-break
 132 @c FIXME!  (1) reflect these options (next item too) in option summaries;
 133 @c         (2) stop teasing, say _which_ instructions expanded _how_.
 134 @code{@value{AS}} automatically macro expands certain division and
 135 multiplication instructions to check for overflow and division by zero.  This
 136 option causes @code{@value{AS}} to generate code to take a trap exception
 137 rather than a break exception when an error is detected.  The trap instructions
 138 are only supported at Instruction Set Architecture level 2 and higher.
 139
 140 @item --break
 141 @itemx --no-trap
 142 Generate code to take a break exception rather than a trap exception when an
 143 error is detected.  This is the default.
 144 @end table
 145
 146 @node MIPS Object
 147 @section MIPS ECOFF object code
 148
 149 @cindex ECOFF sections
 150 @cindex MIPS ECOFF sections
 151 Assembling for a @sc{mips} @sc{ecoff} target supports some additional sections
 152 besides the usual @code{.text}, @code{.data} and @code{.bss}.  The
 153 additional sections are @code{.rdata}, used for read-only data,
 154 @code{.sdata}, used for small data, and @code{.sbss}, used for small
 155 common objects.
 156
 157 @cindex small objects, MIPS ECOFF
 158 @cindex @code{gp} register, MIPS
 159 When assembling for @sc{ecoff}, the assembler uses the @code{$gp} (@code{$28})
 160 register to form the address of a ``small object''.  Any object in the
 161 @code{.sdata} or @code{.sbss} sections is considered ``small'' in this sense.
 162 For external objects, or for objects in the @code{.bss} section, you can use
 163 the @code{@value{GCC}} @samp{-G} option to control the size of objects addressed via
 164 @code{$gp}; the default value is 8, meaning that a reference to any object
 165 eight bytes or smaller uses @code{$gp}.  Passing @samp{-G 0} to
 166 @code{@value{AS}} prevents it from using the @code{$gp} register on the basis
 167 of object size (but the assembler uses @code{$gp} for objects in @code{.sdata}
 168 or @code{sbss} in any case).  The size of an object in the @code{.bss} section
 169 is set by the @code{.comm} or @code{.lcomm} directive that defines it.  The
 170 size of an external object may be set with the @code{.extern} directive.  For
 171 example, @samp{.extern sym,4} declares that the object at @code{sym} is 4 bytes
 172 in length, whie leaving @code{sym} otherwise undefined.
 173
 174 Using small @sc{ecoff} objects requires linker support, and assumes that the
 175 @code{$gp} register is correctly initialized (normally done automatically by
 176 the startup code).  @sc{mips} @sc{ecoff} assembly code must not modify the
 177 @code{$gp} register.
 178
 179 @node MIPS Stabs
 180 @section Directives for debugging information
 181
 182 @cindex MIPS debugging directives
 183 @sc{mips} @sc{ecoff} @code{@value{AS}} supports several directives used for
 184 generating debugging information which are not support by traditional @sc{mips}
 185 assemblers.  These are @code{.def}, @code{.endef}, @code{.dim}, @code{.file},
 186 @code{.scl}, @code{.size}, @code{.tag}, @code{.type}, @code{.val},
 187 @code{.stabd}, @code{.stabn}, and @code{.stabs}.  The debugging information
 188 generated by the three @code{.stab} directives can only be read by @sc{gdb},
 189 not by traditional @sc{mips} debuggers (this enhancement is required to fully
 190 support C++ debugging).  These directives are primarily used by compilers, not
 191 assembly language programmers!
 192
 193 @node MIPS ISA
 194 @section Directives to override the ISA level
 195
 196 @cindex MIPS ISA override
 197 @kindex @code{.set mips@var{n}}
 198 @sc{gnu} @code{@value{AS}} supports an additional directive to change
 199 the @sc{mips} Instruction Set Architecture level on the fly: @code{.set
 200 mips@var{n}}.  @var{n} should be a number from 0 to 4.  A value from 1
 201 to 4 makes the assembler accept instructions for the corresponding
 202 @sc{isa} level, from that point on in the assembly.  @code{.set
 203 mips@var{n}} affects not only which instructions are permitted, but also
 204 how certain macros are expanded.  @code{.set mips0} restores the
 205 @sc{isa} level to its original level: either the level you selected with
 206 command line options, or the default for your configuration.  You can
 207 use this feature to permit specific @sc{r4000} instructions while
 208 assembling in 32 bit mode.  Use this directive with care!
 209
 210 The directive @samp{.set mips16} puts the assembler into MIPS 16 mode,
 211 in which it will assemble instructions for the MIPS 16 processor.  Use
 212 @samp{.set nomips16} to return to normal 32 bit mode.
 213
 214 Traditional @sc{mips} assemblers do not support this directive.
 215
 216 @node MIPS autoextend
 217 @section Directives for extending MIPS 16 bit instructions
 218
 219 @kindex @code{.set autoextend}
 220 @kindex @code{.set noautoextend}
 221 By default, MIPS 16 instructions are automatically extended to 32 bits
 222 when necessary.  The directive @samp{.set noautoextend} will turn this
 223 off.  When @samp{.set noautoextend} is in effect, any 32 bit instruction
 224 must be explicitly extended with the @samp{.e} modifier (e.g.,
 225 @samp{li.e $4,1000}).  The directive @samp{.set autoextend} may be used
 226 to once again automatically extend instructions when necessary.
 227
 228 This directive is only meaningful when in MIPS 16 mode.  Traditional
 229 @sc{mips} assemblers do not support this directive.
 230
 231 @node MIPS insn
 232 @section Directive to mark data as an instruction
 233
 234 @kindex @code{.insn}
 235 The @code{.insn} directive tells @code{@value{AS}} that the following
 236 data is actually instructions.  This makes a difference in MIPS 16 mode:
 237 when loading the address of a label which precedes instructions,
 238 @code{@value{AS}} automatically adds 1 to the value, so that jumping to
 239 the loaded address will do the right thing.
 240
 241 @node MIPS option stack
 242 @section Directives to save and restore options
 243
 244 @cindex MIPS option stack
 245 @kindex @code{.set push}
 246 @kindex @code{.set pop}
 247 The directives @code{.set push} and @code{.set pop} may be used to save
 248 and restore the current settings for all the options which are
 249 controlled by @code{.set}.  The @code{.set push} directive saves the
 250 current settings on a stack.  The @code{.set pop} directive pops the
 251 stack and restores the settings.
 252
 253 These directives can be useful inside an macro which must change an
 254 option such as the ISA level or instruction reordering but does not want
 255 to change the state of the code which invoked the macro.
 256
 257 Traditional @sc{mips} assemblers do not support these directives.