1@c Copyright (C) 1991-2016 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 M68K-Dependent 7@chapter M680x0 Dependent Features 8@end ifset 9@ifclear GENERIC 10@node Machine Dependencies 11@chapter M680x0 Dependent Features 12@end ifclear 13 14@cindex M680x0 support 15@menu 16* M68K-Opts:: M680x0 Options 17* M68K-Syntax:: Syntax 18* M68K-Moto-Syntax:: Motorola Syntax 19* M68K-Float:: Floating Point 20* M68K-Directives:: 680x0 Machine Directives 21* M68K-opcodes:: Opcodes 22@end menu 23 24@node M68K-Opts 25@section M680x0 Options 26 27@cindex options, M680x0 28@cindex M680x0 options 29The Motorola 680x0 version of @code{@value{AS}} has a few machine 30dependent options: 31 32@table @samp 33 34@cindex @samp{-march=} command line option, M680x0 35@item -march=@var{architecture} 36This option specifies a target architecture. The following 37architectures are recognized: 38@code{68000}, 39@code{68010}, 40@code{68020}, 41@code{68030}, 42@code{68040}, 43@code{68060}, 44@code{cpu32}, 45@code{isaa}, 46@code{isaaplus}, 47@code{isab}, 48@code{isac} and 49@code{cfv4e}. 50 51 52@cindex @samp{-mcpu=} command line option, M680x0 53@item -mcpu=@var{cpu} 54This option specifies a target cpu. When used in conjunction with the 55@option{-march} option, the cpu must be within the specified 56architecture. Also, the generic features of the architecture are used 57for instruction generation, rather than those of the specific chip. 58 59@cindex @samp{-m[no-]68851} command line option, M680x0 60@cindex @samp{-m[no-]68881} command line option, M680x0 61@cindex @samp{-m[no-]div} command line option, M680x0 62@cindex @samp{-m[no-]usp} command line option, M680x0 63@cindex @samp{-m[no-]float} command line option, M680x0 64@cindex @samp{-m[no-]mac} command line option, M680x0 65@cindex @samp{-m[no-]emac} command line option, M680x0 66@item -m[no-]68851 67@itemx -m[no-]68881 68@itemx -m[no-]div 69@itemx -m[no-]usp 70@itemx -m[no-]float 71@itemx -m[no-]mac 72@itemx -m[no-]emac 73 74Enable or disable various architecture specific features. If a chip 75or architecture by default supports an option (for instance 76@option{-march=isaaplus} includes the @option{-mdiv} option), 77explicitly disabling the option will override the default. 78 79@cindex @samp{-l} option, M680x0 80@item -l 81You can use the @samp{-l} option to shorten the size of references to undefined 82symbols. If you do not use the @samp{-l} option, references to undefined 83symbols are wide enough for a full @code{long} (32 bits). (Since 84@code{@value{AS}} cannot know where these symbols end up, @code{@value{AS}} can 85only allocate space for the linker to fill in later. Since @code{@value{AS}} 86does not know how far away these symbols are, it allocates as much space as it 87can.) If you use this option, the references are only one word wide (16 bits). 88This may be useful if you want the object file to be as small as possible, and 89you know that the relevant symbols are always less than 17 bits away. 90 91@cindex @samp{--register-prefix-optional} option, M680x0 92@item --register-prefix-optional 93For some configurations, especially those where the compiler normally 94does not prepend an underscore to the names of user variables, the 95assembler requires a @samp{%} before any use of a register name. This 96is intended to let the assembler distinguish between C variables and 97functions named @samp{a0} through @samp{a7}, and so on. The @samp{%} is 98always accepted, but is not required for certain configurations, notably 99@samp{sun3}. The @samp{--register-prefix-optional} option may be used 100to permit omitting the @samp{%} even for configurations for which it is 101normally required. If this is done, it will generally be impossible to 102refer to C variables and functions with the same names as register 103names. 104 105@cindex @samp{--bitwise-or} option, M680x0 106@item --bitwise-or 107Normally the character @samp{|} is treated as a comment character, which 108means that it can not be used in expressions. The @samp{--bitwise-or} 109option turns @samp{|} into a normal character. In this mode, you must 110either use C style comments, or start comments with a @samp{#} character 111at the beginning of a line. 112 113@cindex @samp{--base-size-default-16} 114@cindex @samp{--base-size-default-32} 115@item --base-size-default-16 --base-size-default-32 116If you use an addressing mode with a base register without specifying 117the size, @code{@value{AS}} will normally use the full 32 bit value. 118For example, the addressing mode @samp{%a0@@(%d0)} is equivalent to 119@samp{%a0@@(%d0:l)}. You may use the @samp{--base-size-default-16} 120option to tell @code{@value{AS}} to default to using the 16 bit value. 121In this case, @samp{%a0@@(%d0)} is equivalent to @samp{%a0@@(%d0:w)}. 122You may use the @samp{--base-size-default-32} option to restore the 123default behaviour. 124 125@cindex @samp{--disp-size-default-16} 126@cindex @samp{--disp-size-default-32} 127@item --disp-size-default-16 --disp-size-default-32 128If you use an addressing mode with a displacement, and the value of the 129displacement is not known, @code{@value{AS}} will normally assume that 130the value is 32 bits. For example, if the symbol @samp{disp} has not 131been defined, @code{@value{AS}} will assemble the addressing mode 132@samp{%a0@@(disp,%d0)} as though @samp{disp} is a 32 bit value. You may 133use the @samp{--disp-size-default-16} option to tell @code{@value{AS}} 134to instead assume that the displacement is 16 bits. In this case, 135@code{@value{AS}} will assemble @samp{%a0@@(disp,%d0)} as though 136@samp{disp} is a 16 bit value. You may use the 137@samp{--disp-size-default-32} option to restore the default behaviour. 138 139@cindex @samp{--pcrel} 140@item --pcrel 141Always keep branches PC-relative. In the M680x0 architecture all branches 142are defined as PC-relative. However, on some processors they are limited 143to word displacements maximum. When @code{@value{AS}} needs a long branch 144that is not available, it normally emits an absolute jump instead. This 145option disables this substitution. When this option is given and no long 146branches are available, only word branches will be emitted. An error 147message will be generated if a word branch cannot reach its target. This 148option has no effect on 68020 and other processors that have long branches. 149@pxref{M68K-Branch,,Branch Improvement}. 150 151@cindex @samp{-m68000} and related options 152@cindex architecture options, M680x0 153@cindex M680x0 architecture options 154@item -m68000 155@code{@value{AS}} can assemble code for several different members of the 156Motorola 680x0 family. The default depends upon how @code{@value{AS}} 157was configured when it was built; normally, the default is to assemble 158code for the 68020 microprocessor. The following options may be used to 159change the default. These options control which instructions and 160addressing modes are permitted. The members of the 680x0 family are 161very similar. For detailed information about the differences, see the 162Motorola manuals. 163 164@table @samp 165@item -m68000 166@itemx -m68ec000 167@itemx -m68hc000 168@itemx -m68hc001 169@itemx -m68008 170@itemx -m68302 171@itemx -m68306 172@itemx -m68307 173@itemx -m68322 174@itemx -m68356 175Assemble for the 68000. @samp{-m68008}, @samp{-m68302}, and so on are synonyms 176for @samp{-m68000}, since the chips are the same from the point of view 177of the assembler. 178 179@item -m68010 180Assemble for the 68010. 181 182@item -m68020 183@itemx -m68ec020 184Assemble for the 68020. This is normally the default. 185 186@item -m68030 187@itemx -m68ec030 188Assemble for the 68030. 189 190@item -m68040 191@itemx -m68ec040 192Assemble for the 68040. 193 194@item -m68060 195@itemx -m68ec060 196Assemble for the 68060. 197 198@item -mcpu32 199@itemx -m68330 200@itemx -m68331 201@itemx -m68332 202@itemx -m68333 203@itemx -m68334 204@itemx -m68336 205@itemx -m68340 206@itemx -m68341 207@itemx -m68349 208@itemx -m68360 209Assemble for the CPU32 family of chips. 210 211@item -m5200 212@itemx -m5202 213@itemx -m5204 214@itemx -m5206 215@itemx -m5206e 216@itemx -m521x 217@itemx -m5249 218@itemx -m528x 219@itemx -m5307 220@itemx -m5407 221@itemx -m547x 222@itemx -m548x 223@itemx -mcfv4 224@itemx -mcfv4e 225Assemble for the ColdFire family of chips. 226 227@item -m68881 228@itemx -m68882 229Assemble 68881 floating point instructions. This is the default for the 23068020, 68030, and the CPU32. The 68040 and 68060 always support 231floating point instructions. 232 233@item -mno-68881 234Do not assemble 68881 floating point instructions. This is the default 235for 68000 and the 68010. The 68040 and 68060 always support floating 236point instructions, even if this option is used. 237 238@item -m68851 239Assemble 68851 MMU instructions. This is the default for the 68020, 24068030, and 68060. The 68040 accepts a somewhat different set of MMU 241instructions; @samp{-m68851} and @samp{-m68040} should not be used 242together. 243 244@item -mno-68851 245Do not assemble 68851 MMU instructions. This is the default for the 24668000, 68010, and the CPU32. The 68040 accepts a somewhat different set 247of MMU instructions. 248@end table 249@end table 250 251@node M68K-Syntax 252@section Syntax 253 254@cindex @sc{mit} 255This syntax for the Motorola 680x0 was developed at @sc{mit}. 256 257@cindex M680x0 syntax 258@cindex syntax, M680x0 259@cindex M680x0 size modifiers 260@cindex size modifiers, M680x0 261The 680x0 version of @code{@value{AS}} uses instructions names and 262syntax compatible with the Sun assembler. Intervening periods are 263ignored; for example, @samp{movl} is equivalent to @samp{mov.l}. 264 265In the following table @var{apc} stands for any of the address registers 266(@samp{%a0} through @samp{%a7}), the program counter (@samp{%pc}), the 267zero-address relative to the program counter (@samp{%zpc}), a suppressed 268address register (@samp{%za0} through @samp{%za7}), or it may be omitted 269entirely. The use of @var{size} means one of @samp{w} or @samp{l}, and 270it may be omitted, along with the leading colon, unless a scale is also 271specified. The use of @var{scale} means one of @samp{1}, @samp{2}, 272@samp{4}, or @samp{8}, and it may always be omitted along with the 273leading colon. 274 275@cindex M680x0 addressing modes 276@cindex addressing modes, M680x0 277The following addressing modes are understood: 278@table @dfn 279@item Immediate 280@samp{#@var{number}} 281 282@item Data Register 283@samp{%d0} through @samp{%d7} 284 285@item Address Register 286@samp{%a0} through @samp{%a7}@* 287@samp{%a7} is also known as @samp{%sp}, i.e., the Stack Pointer. @code{%a6} 288is also known as @samp{%fp}, the Frame Pointer. 289 290@item Address Register Indirect 291@samp{%a0@@} through @samp{%a7@@} 292 293@item Address Register Postincrement 294@samp{%a0@@+} through @samp{%a7@@+} 295 296@item Address Register Predecrement 297@samp{%a0@@-} through @samp{%a7@@-} 298 299@item Indirect Plus Offset 300@samp{@var{apc}@@(@var{number})} 301 302@item Index 303@samp{@var{apc}@@(@var{number},@var{register}:@var{size}:@var{scale})} 304 305The @var{number} may be omitted. 306 307@item Postindex 308@samp{@var{apc}@@(@var{number})@@(@var{onumber},@var{register}:@var{size}:@var{scale})} 309 310The @var{onumber} or the @var{register}, but not both, may be omitted. 311 312@item Preindex 313@samp{@var{apc}@@(@var{number},@var{register}:@var{size}:@var{scale})@@(@var{onumber})} 314 315The @var{number} may be omitted. Omitting the @var{register} produces 316the Postindex addressing mode. 317 318@item Absolute 319@samp{@var{symbol}}, or @samp{@var{digits}}, optionally followed by 320@samp{:b}, @samp{:w}, or @samp{:l}. 321@end table 322 323@node M68K-Moto-Syntax 324@section Motorola Syntax 325 326@cindex Motorola syntax for the 680x0 327@cindex alternate syntax for the 680x0 328 329The standard Motorola syntax for this chip differs from the syntax 330already discussed (@pxref{M68K-Syntax,,Syntax}). @code{@value{AS}} can 331accept Motorola syntax for operands, even if @sc{mit} syntax is used for 332other operands in the same instruction. The two kinds of syntax are 333fully compatible. 334 335In the following table @var{apc} stands for any of the address registers 336(@samp{%a0} through @samp{%a7}), the program counter (@samp{%pc}), the 337zero-address relative to the program counter (@samp{%zpc}), or a 338suppressed address register (@samp{%za0} through @samp{%za7}). The use 339of @var{size} means one of @samp{w} or @samp{l}, and it may always be 340omitted along with the leading dot. The use of @var{scale} means one of 341@samp{1}, @samp{2}, @samp{4}, or @samp{8}, and it may always be omitted 342along with the leading asterisk. 343 344The following additional addressing modes are understood: 345 346@table @dfn 347@item Address Register Indirect 348@samp{(%a0)} through @samp{(%a7)}@* 349@samp{%a7} is also known as @samp{%sp}, i.e., the Stack Pointer. @code{%a6} 350is also known as @samp{%fp}, the Frame Pointer. 351 352@item Address Register Postincrement 353@samp{(%a0)+} through @samp{(%a7)+} 354 355@item Address Register Predecrement 356@samp{-(%a0)} through @samp{-(%a7)} 357 358@item Indirect Plus Offset 359@samp{@var{number}(@var{%a0})} through @samp{@var{number}(@var{%a7})}, 360or @samp{@var{number}(@var{%pc})}. 361 362The @var{number} may also appear within the parentheses, as in 363@samp{(@var{number},@var{%a0})}. When used with the @var{pc}, the 364@var{number} may be omitted (with an address register, omitting the 365@var{number} produces Address Register Indirect mode). 366 367@item Index 368@samp{@var{number}(@var{apc},@var{register}.@var{size}*@var{scale})} 369 370The @var{number} may be omitted, or it may appear within the 371parentheses. The @var{apc} may be omitted. The @var{register} and the 372@var{apc} may appear in either order. If both @var{apc} and 373@var{register} are address registers, and the @var{size} and @var{scale} 374are omitted, then the first register is taken as the base register, and 375the second as the index register. 376 377@item Postindex 378@samp{([@var{number},@var{apc}],@var{register}.@var{size}*@var{scale},@var{onumber})} 379 380The @var{onumber}, or the @var{register}, or both, may be omitted. 381Either the @var{number} or the @var{apc} may be omitted, but not both. 382 383@item Preindex 384@samp{([@var{number},@var{apc},@var{register}.@var{size}*@var{scale}],@var{onumber})} 385 386The @var{number}, or the @var{apc}, or the @var{register}, or any two of 387them, may be omitted. The @var{onumber} may be omitted. The 388@var{register} and the @var{apc} may appear in either order. If both 389@var{apc} and @var{register} are address registers, and the @var{size} 390and @var{scale} are omitted, then the first register is taken as the 391base register, and the second as the index register. 392@end table 393 394@node M68K-Float 395@section Floating Point 396 397@cindex floating point, M680x0 398@cindex M680x0 floating point 399Packed decimal (P) format floating literals are not supported. 400Feel free to add the code! 401 402The floating point formats generated by directives are these. 403 404@table @code 405@cindex @code{float} directive, M680x0 406@item .float 407@code{Single} precision floating point constants. 408 409@cindex @code{double} directive, M680x0 410@item .double 411@code{Double} precision floating point constants. 412 413@cindex @code{extend} directive M680x0 414@cindex @code{ldouble} directive M680x0 415@item .extend 416@itemx .ldouble 417@code{Extended} precision (@code{long double}) floating point constants. 418@end table 419 420@node M68K-Directives 421@section 680x0 Machine Directives 422 423@cindex M680x0 directives 424@cindex directives, M680x0 425In order to be compatible with the Sun assembler the 680x0 assembler 426understands the following directives. 427 428@table @code 429@cindex @code{data1} directive, M680x0 430@item .data1 431This directive is identical to a @code{.data 1} directive. 432 433@cindex @code{data2} directive, M680x0 434@item .data2 435This directive is identical to a @code{.data 2} directive. 436 437@cindex @code{even} directive, M680x0 438@item .even 439This directive is a special case of the @code{.align} directive; it 440aligns the output to an even byte boundary. 441 442@cindex @code{skip} directive, M680x0 443@item .skip 444This directive is identical to a @code{.space} directive. 445 446@cindex @code{arch} directive, M680x0 447@item .arch @var{name} 448Select the target architecture and extension features. Valid values 449for @var{name} are the same as for the @option{-march} command line 450option. This directive cannot be specified after 451any instructions have been assembled. If it is given multiple times, 452or in conjunction with the @option{-march} option, all uses must be for 453the same architecture and extension set. 454 455@cindex @code{cpu} directive, M680x0 456@item .cpu @var{name} 457Select the target cpu. Valid valuse 458for @var{name} are the same as for the @option{-mcpu} command line 459option. This directive cannot be specified after 460any instructions have been assembled. If it is given multiple times, 461or in conjunction with the @option{-mopt} option, all uses must be for 462the same cpu. 463 464@end table 465 466@need 2000 467@node M68K-opcodes 468@section Opcodes 469 470@cindex M680x0 opcodes 471@cindex opcodes, M680x0 472@cindex instruction set, M680x0 473@c doc@cygnus.com: I don't see any point in the following 474@c paragraph. Bugs are bugs; how does saying this 475@c help anyone? 476@ignore 477Danger: Several bugs have been found in the opcode table (and 478fixed). More bugs may exist. Be careful when using obscure 479instructions. 480@end ignore 481 482@menu 483* M68K-Branch:: Branch Improvement 484* M68K-Chars:: Special Characters 485@end menu 486 487@node M68K-Branch 488@subsection Branch Improvement 489 490@cindex pseudo-opcodes, M680x0 491@cindex M680x0 pseudo-opcodes 492@cindex branch improvement, M680x0 493@cindex M680x0 branch improvement 494Certain pseudo opcodes are permitted for branch instructions. 495They expand to the shortest branch instruction that reach the 496target. Generally these mnemonics are made by substituting @samp{j} for 497@samp{b} at the start of a Motorola mnemonic. 498 499The following table summarizes the pseudo-operations. A @code{*} flags 500cases that are more fully described after the table: 501 502@smallexample 503 Displacement 504 +------------------------------------------------------------ 505 | 68020 68000/10, not PC-relative OK 506Pseudo-Op |BYTE WORD LONG ABSOLUTE LONG JUMP ** 507 +------------------------------------------------------------ 508 jbsr |bsrs bsrw bsrl jsr 509 jra |bras braw bral jmp 510* jXX |bXXs bXXw bXXl bNXs;jmp 511* dbXX | N/A dbXXw dbXX;bras;bral dbXX;bras;jmp 512 fjXX | N/A fbXXw fbXXl N/A 513 514XX: condition 515NX: negative of condition XX 516 517@end smallexample 518@center @code{*}---see full description below 519@center @code{**}---this expansion mode is disallowed by @samp{--pcrel} 520 521@table @code 522@item jbsr 523@itemx jra 524These are the simplest jump pseudo-operations; they always map to one 525particular machine instruction, depending on the displacement to the 526branch target. This instruction will be a byte or word branch is that 527is sufficient. Otherwise, a long branch will be emitted if available. 528If no long branches are available and the @samp{--pcrel} option is not 529given, an absolute long jump will be emitted instead. If no long 530branches are available, the @samp{--pcrel} option is given, and a word 531branch cannot reach the target, an error message is generated. 532 533In addition to standard branch operands, @code{@value{AS}} allows these 534pseudo-operations to have all operands that are allowed for jsr and jmp, 535substituting these instructions if the operand given is not valid for a 536branch instruction. 537 538@item j@var{XX} 539Here, @samp{j@var{XX}} stands for an entire family of pseudo-operations, 540where @var{XX} is a conditional branch or condition-code test. The full 541list of pseudo-ops in this family is: 542@smallexample 543 jhi jls jcc jcs jne jeq jvc 544 jvs jpl jmi jge jlt jgt jle 545@end smallexample 546 547Usually, each of these pseudo-operations expands to a single branch 548instruction. However, if a word branch is not sufficient, no long branches 549are available, and the @samp{--pcrel} option is not given, @code{@value{AS}} 550issues a longer code fragment in terms of @var{NX}, the opposite condition 551to @var{XX}. For example, under these conditions: 552@smallexample 553 j@var{XX} foo 554@end smallexample 555gives 556@smallexample 557 b@var{NX}s oof 558 jmp foo 559 oof: 560@end smallexample 561 562@item db@var{XX} 563The full family of pseudo-operations covered here is 564@smallexample 565 dbhi dbls dbcc dbcs dbne dbeq dbvc 566 dbvs dbpl dbmi dbge dblt dbgt dble 567 dbf dbra dbt 568@end smallexample 569 570Motorola @samp{db@var{XX}} instructions allow word displacements only. When 571a word displacement is sufficient, each of these pseudo-operations expands 572to the corresponding Motorola instruction. When a word displacement is not 573sufficient and long branches are available, when the source reads 574@samp{db@var{XX} foo}, @code{@value{AS}} emits 575@smallexample 576 db@var{XX} oo1 577 bras oo2 578 oo1:bral foo 579 oo2: 580@end smallexample 581 582If, however, long branches are not available and the @samp{--pcrel} option is 583not given, @code{@value{AS}} emits 584@smallexample 585 db@var{XX} oo1 586 bras oo2 587 oo1:jmp foo 588 oo2: 589@end smallexample 590 591@item fj@var{XX} 592This family includes 593@smallexample 594 fjne fjeq fjge fjlt fjgt fjle fjf 595 fjt fjgl fjgle fjnge fjngl fjngle fjngt 596 fjnle fjnlt fjoge fjogl fjogt fjole fjolt 597 fjor fjseq fjsf fjsne fjst fjueq fjuge 598 fjugt fjule fjult fjun 599@end smallexample 600 601Each of these pseudo-operations always expands to a single Motorola 602coprocessor branch instruction, word or long. All Motorola coprocessor 603branch instructions allow both word and long displacements. 604 605@end table 606 607@node M68K-Chars 608@subsection Special Characters 609 610@cindex special characters, M680x0 611 612@cindex M680x0 line comment character 613@cindex line comment character, M680x0 614@cindex comments, M680x0 615Line comments are introduced by the @samp{|} character appearing 616anywhere on a line, unless the @option{--bitwise-or} command line option 617has been specified. 618 619An asterisk (@samp{*}) as the first character on a line marks the 620start of a line comment as well. 621 622@cindex M680x0 immediate character 623@cindex immediate character, M680x0 624 625A hash character (@samp{#}) as the first character on a line also 626marks the start of a line comment, but in this case it could also be a 627logical line number directive (@pxref{Comments}) or a preprocessor 628control command (@pxref{Preprocessing}). If the hash character 629appears elsewhere on a line it is used to introduce an immediate 630value. (This is for compatibility with Sun's assembler). 631 632@cindex M680x0 line separator 633@cindex line separator, M680x0 634 635Multiple statements on the same line can appear if they are separated 636by the @samp{;} character. 637