Add MIPS32 as a seperate MIPS architecture
[external/binutils.git] / 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 @itemx -mips32
64 Generate code for a particular MIPS Instruction Set Architecture level.
65 @samp{-mips1} corresponds to the @sc{r2000} and @sc{r3000} processors,
66 @samp{-mips2} to the @sc{r6000} processor, @samp{-mips3} to the
67 @sc{r4000} processor, @samp{-mips4} to the @sc{r8000} and
68 @sc{r10000} processors, and @samp{-mips32} to a generic @sc(MIPS32)
69 processor.  You can also switch instruction sets during the
70 assembly; see @ref{MIPS ISA, Directives to override the ISA level}.
71
72 @item -mgp32
73 Assume that 32-bit general purpose registers are available.  This
74 affects synthetic instructions such as @code{move}, which will assemble
75 to a 32-bit or a 64-bit instruction depending on this flag.  On some
76 MIPS variants there is a 32-bit mode flag; when this flag is set,
77 64-bit instructions generate a trap.  Also, some 32-bit OSes only save
78 the 32-bit registers on a context switch, so it is essential never to
79 use the 64-bit registers.
80
81 @item -mgp64
82 Assume that 64-bit general purpose registers are available.  This is
83 provided in the interests of symmetry with -gp32.
84
85 @item -mips16
86 @itemx -no-mips16
87 Generate code for the MIPS 16 processor.  This is equivalent to putting
88 @samp{.set mips16} at the start of the assembly file.  @samp{-no-mips16}
89 turns off this option.
90
91 @item -mfix7000
92 @itemx -no-mfix7000
93 Cause nops to be inserted if the read of the destination register
94 of an mfhi or mflo instruction occurs in the following two instructions.
95
96 @item -m4010
97 @itemx -no-m4010
98 Generate code for the LSI @sc{r4010} chip.  This tells the assembler to
99 accept the @sc{r4010} specific instructions (@samp{addciu}, @samp{ffc},
100 etc.), and to not schedule @samp{nop} instructions around accesses to
101 the @samp{HI} and @samp{LO} registers.  @samp{-no-m4010} turns off this
102 option.
103
104 @item -m4650
105 @itemx -no-m4650
106 Generate code for the MIPS @sc{r4650} chip.  This tells the assembler to accept
107 the @samp{mad} and @samp{madu} instruction, and to not schedule @samp{nop}
108 instructions around accesses to the @samp{HI} and @samp{LO} registers.
109 @samp{-no-m4650} turns off this option.
110
111 @itemx -m3900
112 @itemx -no-m3900
113 @itemx -m4100
114 @itemx -no-m4100
115 For each option @samp{-m@var{nnnn}}, generate code for the MIPS
116 @sc{r@var{nnnn}} chip.  This tells the assembler to accept instructions
117 specific to that chip, and to schedule for that chip's hazards.
118
119 @item -mcpu=@var{cpu}
120 Generate code for a particular MIPS cpu.  It is exactly equivalent to
121 @samp{-m@var{cpu}}, except that there are more value of @var{cpu}
122 understood.  Valid @var{cpu} value are:
123
124 @quotation
125 2000,
126 3000,
127 3900,
128 4000,
129 4010,
130 4100,
131 4111,
132 4300,
133 4400,
134 4600,
135 4650,
136 5000,
137 rm5200,
138 rm5230,
139 rm5231,
140 rm5261,
141 rm5721,
142 6000,
143 rm7000,
144 8000,
145 10000,
146 mips32-4k
147 @end quotation
148
149
150 @cindex @code{-nocpp} ignored (MIPS)
151 @item -nocpp
152 This option is ignored.  It is accepted for command-line compatibility with
153 other assemblers, which use it to turn off C style preprocessing.  With
154 @sc{gnu} @code{@value{AS}}, there is no need for @samp{-nocpp}, because the
155 @sc{gnu} assembler itself never runs the C preprocessor.
156
157 @item --construct-floats
158 @itemx --no-construct-floats
159 @cindex --construct-floats
160 @cindex --no-construct-floats
161 The @code{--no-construct-floats} option disables the construction of
162 double width floating point constants by loading the two halves of the
163 value into the two single width floating point registers that make up
164 the double width register.  This feature is useful if the processor
165 support the FR bit in its status  register, and this bit is known (by
166 the programmer) to be set.  This bit prevents the aliasing of the double
167 width register by the single width registers.
168
169 By default @code{--construct-floats} is selected, allowing construction
170 of these floating point constants.
171
172 @item --trap
173 @itemx --no-break
174 @c FIXME!  (1) reflect these options (next item too) in option summaries;
175 @c         (2) stop teasing, say _which_ instructions expanded _how_.
176 @code{@value{AS}} automatically macro expands certain division and
177 multiplication instructions to check for overflow and division by zero.  This
178 option causes @code{@value{AS}} to generate code to take a trap exception
179 rather than a break exception when an error is detected.  The trap instructions
180 are only supported at Instruction Set Architecture level 2 and higher.
181
182 @item --break
183 @itemx --no-trap
184 Generate code to take a break exception rather than a trap exception when an
185 error is detected.  This is the default.
186 @end table
187
188 @node MIPS Object
189 @section MIPS ECOFF object code
190
191 @cindex ECOFF sections
192 @cindex MIPS ECOFF sections
193 Assembling for a @sc{mips} @sc{ecoff} target supports some additional sections
194 besides the usual @code{.text}, @code{.data} and @code{.bss}.  The
195 additional sections are @code{.rdata}, used for read-only data,
196 @code{.sdata}, used for small data, and @code{.sbss}, used for small
197 common objects.
198
199 @cindex small objects, MIPS ECOFF
200 @cindex @code{gp} register, MIPS
201 When assembling for @sc{ecoff}, the assembler uses the @code{$gp} (@code{$28})
202 register to form the address of a ``small object''.  Any object in the
203 @code{.sdata} or @code{.sbss} sections is considered ``small'' in this sense.
204 For external objects, or for objects in the @code{.bss} section, you can use
205 the @code{@value{GCC}} @samp{-G} option to control the size of objects addressed via
206 @code{$gp}; the default value is 8, meaning that a reference to any object
207 eight bytes or smaller uses @code{$gp}.  Passing @samp{-G 0} to
208 @code{@value{AS}} prevents it from using the @code{$gp} register on the basis
209 of object size (but the assembler uses @code{$gp} for objects in @code{.sdata}
210 or @code{sbss} in any case).  The size of an object in the @code{.bss} section
211 is set by the @code{.comm} or @code{.lcomm} directive that defines it.  The
212 size of an external object may be set with the @code{.extern} directive.  For
213 example, @samp{.extern sym,4} declares that the object at @code{sym} is 4 bytes
214 in length, whie leaving @code{sym} otherwise undefined.
215
216 Using small @sc{ecoff} objects requires linker support, and assumes that the
217 @code{$gp} register is correctly initialized (normally done automatically by
218 the startup code).  @sc{mips} @sc{ecoff} assembly code must not modify the
219 @code{$gp} register.
220
221 @node MIPS Stabs
222 @section Directives for debugging information
223
224 @cindex MIPS debugging directives
225 @sc{mips} @sc{ecoff} @code{@value{AS}} supports several directives used for
226 generating debugging information which are not support by traditional @sc{mips}
227 assemblers.  These are @code{.def}, @code{.endef}, @code{.dim}, @code{.file},
228 @code{.scl}, @code{.size}, @code{.tag}, @code{.type}, @code{.val},
229 @code{.stabd}, @code{.stabn}, and @code{.stabs}.  The debugging information
230 generated by the three @code{.stab} directives can only be read by @sc{gdb},
231 not by traditional @sc{mips} debuggers (this enhancement is required to fully
232 support C++ debugging).  These directives are primarily used by compilers, not
233 assembly language programmers!
234
235 @node MIPS ISA
236 @section Directives to override the ISA level
237
238 @cindex MIPS ISA override
239 @kindex @code{.set mips@var{n}}
240 @sc{gnu} @code{@value{AS}} supports an additional directive to change
241 the @sc{mips} Instruction Set Architecture level on the fly: @code{.set
242 mips@var{n}}.  @var{n} should be a number from 0 to 4, or 32.  The values 1
243 to 4 and 32 make the assembler accept instructions for the corresponding
244 @sc{isa} level, from that point on in the assembly.  @code{.set
245 mips@var{n}} affects not only which instructions are permitted, but also
246 how certain macros are expanded.  @code{.set mips0} restores the
247 @sc{isa} level to its original level: either the level you selected with
248 command line options, or the default for your configuration.  You can
249 use this feature to permit specific @sc{r4000} instructions while
250 assembling in 32 bit mode.  Use this directive with care!
251
252 The directive @samp{.set mips16} puts the assembler into MIPS 16 mode,
253 in which it will assemble instructions for the MIPS 16 processor.  Use
254 @samp{.set nomips16} to return to normal 32 bit mode.
255
256 Traditional @sc{mips} assemblers do not support this directive.  
257
258 @node MIPS autoextend
259 @section Directives for extending MIPS 16 bit instructions
260
261 @kindex @code{.set autoextend}
262 @kindex @code{.set noautoextend}
263 By default, MIPS 16 instructions are automatically extended to 32 bits
264 when necessary.  The directive @samp{.set noautoextend} will turn this
265 off.  When @samp{.set noautoextend} is in effect, any 32 bit instruction
266 must be explicitly extended with the @samp{.e} modifier (e.g.,
267 @samp{li.e $4,1000}).  The directive @samp{.set autoextend} may be used
268 to once again automatically extend instructions when necessary.
269
270 This directive is only meaningful when in MIPS 16 mode.  Traditional
271 @sc{mips} assemblers do not support this directive.
272
273 @node MIPS insn
274 @section Directive to mark data as an instruction
275
276 @kindex @code{.insn}
277 The @code{.insn} directive tells @code{@value{AS}} that the following
278 data is actually instructions.  This makes a difference in MIPS 16 mode:
279 when loading the address of a label which precedes instructions,
280 @code{@value{AS}} automatically adds 1 to the value, so that jumping to
281 the loaded address will do the right thing.
282
283 @node MIPS option stack
284 @section Directives to save and restore options
285
286 @cindex MIPS option stack
287 @kindex @code{.set push}
288 @kindex @code{.set pop}
289 The directives @code{.set push} and @code{.set pop} may be used to save
290 and restore the current settings for all the options which are
291 controlled by @code{.set}.  The @code{.set push} directive saves the
292 current settings on a stack.  The @code{.set pop} directive pops the
293 stack and restores the settings.
294
295 These directives can be useful inside an macro which must change an
296 option such as the ISA level or instruction reordering but does not want
297 to change the state of the code which invoked the macro.
298
299 Traditional @sc{mips} assemblers do not support these directives.