Free SNES assembler

0. Contents

This is the documentation of snescom-1.4.2.
   1. Purpose
   2. Linker
   3. Supported syntax
      3.1. Mnemonics
      3.2. Addressing modes
      3.3. Operand size control
      3.4. Expression evaluation
      3.5. Segments
      3.6. Comments
      3.7. Command separation
      3.8. Code pointer relocation
      3.9. Branch labels
      3.10. Preprocessor
      3.11. Object file format
      3.12. Automatic jump size detection
      3.13. IPS output support
   4. Examples and more documentation
   5. Changelog
   6. Known bugs
   7. Copying
   8. Downloading

1. Purpose

This program reads symbolic 65816 or 65c816 machine code and compiles (assembles) it into a relocatable object file.

The produced object file is binary-compatible with those made with XA65.

2. Linker

This package also contains a linker.
See http://bisqwit.iki.fi/src/snescom-demo/ - there's a demo explaining how this all works.

3. Supported syntax

3.1. Mnemonics

The following mnemonics are supported:

adc, and, asl, bcc, bcs, beq, bit, bmi, bne, bpl, bra, brk, brl, bvc, bvs, clc, cld, cli, clv, cmp, cop, cpx, cpy, db , dec, dex, dey, eor, inc, inx, iny, jml, jmp, jsl, jsr, lda, ldx, ldy, lsr, mvn, mvp, nop, ora, pea, pei, per, pha, phb, phd, phk, php, phx, phy, pla, plb, pld, plp, plx, ply, rep, rol, ror, rti, rtl, rts, sbc, sec, sed, sei, sep, sta, stp, stx, sty, stz, tax, tay, tcd, tcs, tdc, trb, tsb, tsc, tsx, txa, txs, txy, tya, tyx, wai, xba, xce

3.2. Addressing modes

All the standard addressing modes of the 65816 cpu are supported.

3.3. Operand size control

The pseudo ops .as, .al, .xs & .xl are used to decide what size accumulator and index mode for the assembler to use. .as and .xs are for 8bit operands, and .al and .xl are for 16 bit operands.

I've found it handy to define these macroes:

#define SET_8_BIT_A()   sep #$20 : .as
#define SET_16_BIT_A()  rep #$20 : .al
#define SET_8_BIT_X()   sep #$10 : .xs
#define SET_16_BIT_X()  rep #$10 : .xl

#define SET_8_BIT_AX()  sep #$30 : .xs : .as
#define SET_16_BIT_AX() rep #$30 : .xl : .al
In addition to these modes, there are several operand prefixes that can be used to force a certain operand size/type.

3.4. Expression evaluation

Expressions are supported. These are valid code:

3.5. Segments

Code, labels and data can be generated to four segments: text, data, zero and bss.
Use .text, .data, .zero and .bss respectively to select the segment.
However, only the contents of text and data segments are saved into the o65 file. Labels are saved in all segments.

3.6. Comments

Comments begin with a semicolon (;) and end with a newline.
A colon is allowed to appear in comment.

3.7. Command separation

Commands are separated by newlines and colons (:).

3.8. Code pointer relocation

You can use a command like *= $34F200 to change where the code goes by default.
With IPS this is especially useful.

3.9. Branch labels

The label - can be defined for branches backward and + for branches forward.
Example:
        ; Space-fill the buffer to end
        phx
         cpx #$0010
         bcs +     ;jumps to the next "+"
         SET_8_BIT_A()
         lda #$FF
-        sta $94A0,x
         sta $94B0,x
         inx
         cpx #$0010
         bcc -     ;jumps to the previous "-"
         SET_16_BIT_A()
+        lda W_VRAMADDR
         sta @$002116
        pla

3.10. Preprocessor

snescom uses GCC as a preprocessor.
You can use #ifdef, #ifndef, #define, #if, #endif and #include like in any C program.

3.11. Object file format

Currently snescom only produces relocatable object files.
The file format has been documented by André Fachat for the XA65 project.

3.12. Automatic jump size detection

If --jumps option is enabled, all short jumps are automatically turned into near jumps when needed.

3.13. IPS output support

This version of snescom allows you to create IPS files.
This IPS format has been extended to allow you to specify global symbols and externs to be patched later.
In the generated format:

4. Examples and more documentation

In the source distribution there are some C++ modules that can be used to handle the o65 files.
There are also some example assembler files (copied from Chronotools).

5. Changelog

Sep 23 2003; 0.0.0 started working with the project.
Sep 28 2003; 1.0.0 initial release. All features working.
Sep 29 2003; 1.1.0 added feature: branch labels.
Sep 29 2003; 1.2.0 bugfix: didn't resolve correctly when different scopes had a label with the same name; added warning options
Oct 3 2003; 1.3.0 added feature: jump optimization.
Oct 8 2003; 1.3.1 bugfix: jump optimization only supports two passes. Requiring more now produces an error.
Oct 13 2003; 1.3.2 bugfix: accidentally had broke MVN/MVP some time ago
Nov 3 2003; 1.3.2.1 bugfix: undef; broken HTML in README.html
Nov 3 2003; 1.3.3 added some alternative methods (pea #$8000, mvn $7E7F)
Dec 30 2003; 1.3.4 bugfix; error-exit now deletes the broken output file
Jan 2 2004; 1.3.4.1 bugfix; added missing files
Jan 23 2004; 1.3.4.2 handles memory addressing a bit differently internally
Jan 24 2004; 1.4.0 adds IPS output support
Jan 24 2004; 1.4.1 added new program: IPS and O65 linker (BETA!)
Jan 24 2004; 1.4.1.1 added feature: string constants in .byt
Jan 28 2004; 1.4.1.2 IPS bugfixes; linker improved
Jan 31 2004; 1.4.1.3 some internal changes
Jan 31 2004; 1.4.1.4 more internal changes - aiming towards multisegment linking
Feb 3 2004; 1.4.2 improved expression parsing

6. Known bugs

7. Copying

snescom has been written by Joel Yliluoma, a.k.a. Bisqwit,
and is distributed under the terms of the General Public License (GPL).

If you happen to see this program useful for you, I'd appreciate if you tell me :) Perhaps it would motivate me to enhance the program.

8. Downloading

The official home page of snescom is at http://iki.fi/bisqwit/source/snescom.html.
Check there for new versions.

Generated from progdesc.php (last updated: Tue, 3 Feb 2004 05:39:10 +0200)
with docmaker.php (last updated: Fri, 2 Jan 2004 17:31:18 +0200)
at Tue, 3 Feb 2004 06:17:28 +0200