Merge pull request cc65#1871 from clbr/da816

da65 support for 65816

Author: mrdudz

doc/da65.sgml

@@ -115,14 +115,14 @@ Here is a description of all the command line options:
   <item>6502dtv
   <item>65sc02
   <item>65c02
+  <item>65816
   <item>huc6280
   <item>4510
   </itemize>
 
   6502x is for the NMOS 6502 with unofficial opcodes. 6502dtv is for the
   emulated CPU of the C64DTV device. huc6280 is the CPU of the PC engine.
-  4510 is the CPU of the Commodore C65. Support for the 65816 currently
-  is not available.
+  4510 is the CPU of the Commodore C65. 65816 is the CPU of the SNES.
 
 
   <label id="option--formfeeds">
@@ -263,8 +263,9 @@ can produce output that can not be re-assembled, when one or more of those
 branches point outside of the disassembled memory. This can happen when text
 or binary data is processed.
 
-While there is some code for the 65816 in the sources, it is currently
-unsupported.
+The 65816 support requires annotating ranges with the M and X flag states.
+This can be recorded with an emulator that supports Code and Data Logging,
+for example. Disassemble one bank at a time.
 
 
 <sect1>Attribute map<p>
@@ -521,6 +522,11 @@ following attributes are recognized:
 
   </descrip>
 
+  <tag><tt>ADDRMODE</tt></tag>
+  When disassembling 65816 code, this specifies the M and X flag states
+  for this range. It's a string argument of the form "mx", capital letters
+  mean the flag is enabled.
+
 </descrip>
 
 
@@ -693,6 +699,20 @@ directives explained above:
 
 
 
+<sect>Helper scripts<p>
+
+<tt>util/parse-bsnes-log.awk</tt> is a supplied script for 65816 disassembly,
+to parse bsnes-plus Code-Data log files and output the RANGE sections
+for your info file. For typical usage, you'd check the S-CPU log and trace
+log mask boxes in the bsnes-plus debugger, play through the game, then grep
+for the bank you're disassembling, and pass that to this script.
+
+<tscreen><verb>
+grep ^83 my-game-log | parse-bsnes-log.awk
+</verb></tscreen>
+
+
+
 <sect>Copyright<p>
 
 da65 (and all cc65 binutils) is (C) Copyright 1998-2011, Ullrich von

src/da65/attrtab.c

@@ -34,6 +34,7 @@
 
 
 /* da65 */
+#include "cpu.h"
 #include "error.h"
 #include "attrtab.h"
 
@@ -48,6 +49,12 @@
 /* Attribute table */
 static unsigned short AttrTab[0x10000];
 
+/* 65816 attribute table */
+#define MAX_LONG_ATTRS 256
+static unsigned short LongAttrVal[MAX_LONG_ATTRS];
+static unsigned LongAttrAddr[MAX_LONG_ATTRS];
+static unsigned LongAttrsUsed;
+
 
 
 /*****************************************************************************/
@@ -59,19 +66,37 @@ static unsigned short AttrTab[0x10000];
 void AddrCheck (unsigned Addr)
 /* Check if the given address has a valid range */
 {
-    if (Addr >= 0x10000) {
+    if (Addr >= 0x10000 && CPU != CPU_65816) {
         Error ("Address out of range: %08X", Addr);
     }
 }
 
 
+unsigned char IsLongAddr (unsigned Addr)
+/* Is it 24-bit? */
+{
+    return Addr >= 0x10000 && CPU == CPU_65816;
+}
+
+
 
 attr_t GetAttr (unsigned Addr)
 /* Return the attribute for the given address */
 {
     /* Check the given address */
     AddrCheck (Addr);
 
+    if (IsLongAddr (Addr)) {
+        unsigned i;
+        for (i = 0; i < LongAttrsUsed; i++) {
+            if (LongAttrAddr[i] == Addr) {
+                return LongAttrVal[i];
+            }
+        }
+
+        return 0;
+    }
+
     /* Return the attribute */
     return AttrTab[Addr];
 }
@@ -148,6 +173,33 @@ void MarkAddr (unsigned Addr, attr_t Attr)
     /* Check the given address */
     AddrCheck (Addr);
 
+    if (IsLongAddr (Addr)) {
+        unsigned i;
+        for (i = 0; i < LongAttrsUsed; i++) {
+            if (LongAttrAddr[i] == Addr) {
+
+                /* We must not have more than one style bit */
+                if (Attr & atStyleMask) {
+                    if (LongAttrVal[i] & atStyleMask) {
+                        Error ("Duplicate style for long address %06X", Addr);
+                    }
+                }
+                LongAttrVal[i] |= Attr;
+
+                return;
+            }
+        }
+
+        if (LongAttrsUsed >= MAX_LONG_ATTRS) {
+            Error ("Too many long addresses");
+        }
+        LongAttrVal[LongAttrsUsed] |= Attr;
+        LongAttrAddr[LongAttrsUsed] = Addr;
+        LongAttrsUsed++;
+
+        return;
+    }
+
     /* We must not have more than one style bit */
     if (Attr & atStyleMask) {
         if (AttrTab[Addr] & atStyleMask) {
@@ -168,7 +220,7 @@ attr_t GetStyleAttr (unsigned Addr)
     AddrCheck (Addr);
 
     /* Return the attribute */
-    return (AttrTab[Addr] & atStyleMask);
+    return (GetAttr (Addr) & atStyleMask);
 }
 
 
@@ -180,5 +232,5 @@ attr_t GetLabelAttr (unsigned Addr)
     AddrCheck (Addr);
 
     /* Return the attribute */
-    return (AttrTab[Addr] & atLabelMask);
+    return (GetAttr (Addr) & atLabelMask);
 }

src/da65/attrtab.h

@@ -66,15 +66,22 @@ typedef enum attr_t {
     atDepLabel     = 0x0040,    /* Dependent label */
     atUnnamedLabel = 0x0080,    /* Unnamed label */
 
-    atLabelDefined = 0x0100,    /* True if we defined the label */
-
-    atStyleMask    = 0x000F,    /* Output style */
-    atLabelMask    = 0x00F0,    /* Label information */
-
     /* Segment */
     atSegment      = 0x0100,    /* Code is in a segment */
     atSegmentEnd   = 0x0200,    /* Segment end */
     atSegmentStart = 0x0400,    /* Segment start */
+
+    /* 65816 addressing mode */
+    atMem8         = 0x1000,    /* M flag enabled, 8-bit */
+    atMem16        = 0x2000,    /* M flag disabled, 16-bit */
+    atIdx8         = 0x4000,    /* X flag enabled, 8-bit */
+    atIdx16        = 0x8000,    /* X flag disabled, 16-bit */
+
+    atStyleMask    = 0x000F,    /* Output style */
+    atLabelMask    = 0x00F0,    /* Label information */
+    atSegmentMask  = 0x0F00,    /* Segment information */
+    at65816Mask    = 0xF000,    /* 65816 information */
+
 } attr_t;
 
 
@@ -88,6 +95,9 @@ typedef enum attr_t {
 void AddrCheck (unsigned Addr);
 /* Check if the given address has a valid range */
 
+unsigned char IsLongAddr (unsigned Addr);
+/* Check if the given address is 24-bit */
+
 attr_t GetAttr (unsigned Addr);
 /* Return the attribute for the given address */
 

src/da65/code.c

@@ -194,6 +194,17 @@ unsigned long GetCodeDWord (unsigned Addr)
 
 
 
+unsigned GetCodeLongAddr (unsigned Addr)
+/* Get a word from the given address */
+{
+    unsigned Lo = GetCodeByte (Addr);
+    unsigned Mid = GetCodeByte (Addr+1);
+    unsigned Hi = GetCodeByte (Addr+2);
+    return Lo | (Mid << 8) | (Hi << 16);
+}
+
+
+
 unsigned GetRemainingBytes (void)
 /* Return the number of remaining code bytes */
 {

src/da65/code.h

@@ -72,6 +72,9 @@ unsigned GetCodeWord (unsigned Addr);
 unsigned long GetCodeDWord (unsigned Addr);
 /* Get a dword from the given address */
 
+unsigned GetCodeLongAddr (unsigned Addr);
+/* Get a 24-bit address from the given address */
+
 unsigned GetRemainingBytes (void);
 /* Return the number of remaining code bytes */
 

src/da65/comments.c

@@ -52,6 +52,11 @@
 /* Comment table */
 static const char* CommentTab[0x10000];
 
+#define MAX_LONG_COMMENTS 256
+static const char* LongCommentVal[MAX_LONG_COMMENTS];
+static unsigned LongCommentAddr[MAX_LONG_COMMENTS];
+static unsigned LongCommentsUsed;
+
 
 
 /*****************************************************************************/
@@ -60,17 +65,43 @@ static const char* CommentTab[0x10000];
 
 
 
+static unsigned FindLongIndex (unsigned Addr)
+{
+    unsigned i;
+    for (i = 0; i < LongCommentsUsed; i++) {
+        if (LongCommentAddr[i] == Addr) {
+            return i;
+        }
+    }
+    return -1;
+}
+
+
+
 void SetComment (unsigned Addr, const char* Comment)
 /* Set a comment for the given address */
 {
     /* Check the given address */
     AddrCheck (Addr);
 
-    /* If we do already have a comment, warn and ignore the new one */
-    if (CommentTab[Addr]) {
-        Warning ("Duplicate comment for address $%04X", Addr);
+    if (IsLongAddr (Addr)) {
+        if (FindLongIndex (Addr)) {
+            Warning ("Duplicate comment for address $%06X", Addr);
+        } else {
+            if (LongCommentsUsed >= MAX_LONG_COMMENTS) {
+                Error("Too many long-address comments");
+            }
+            LongCommentVal[LongCommentsUsed] = xstrdup (Comment);
+            LongCommentAddr[LongCommentsUsed] = Addr;
+            LongCommentsUsed++;
+        }
     } else {
-        CommentTab[Addr] = xstrdup (Comment);
+        /* If we do already have a comment, warn and ignore the new one */
+        if (CommentTab[Addr]) {
+            Warning ("Duplicate comment for address $%04X", Addr);
+        } else {
+            CommentTab[Addr] = xstrdup (Comment);
+        }
     }
 }
 
@@ -82,6 +113,14 @@ const char* GetComment (unsigned Addr)
     /* Check the given address */
     AddrCheck (Addr);
 
+    if (IsLongAddr (Addr)) {
+        const unsigned i = FindLongIndex (Addr);
+        if (i < LongCommentsUsed) {
+            return LongCommentVal[i];
+        }
+        return NULL;
+    }
+
     /* Return the label if any */
     return CommentTab[Addr];
 }