v6502 Documentation

Components

The v6502 infrastructure currently consists of a few major tools, and their API subsections. (L) indicates that a module is a member of its library target.

• Virtual Machine (v6502)
  • cpu.h (L)
    • Instruction Set Reference
    • CPU Lifecycle Functions
    • Instruction Execution
    • Karnaugh Map Analysis
  • mem.h (L)
    • Memory Map Definitions
    • Memory Lifecycle Functions
    • Memory Access
    • Memory Map Cache
  • log.h
    • VM State Logging
  • breakpoint.h
    • Breakpoint Management
  • debugger.h
    • Interactive Debugger
  • textmode.h
    • Reference Platform Video/Keyboard
• Assembler (as6502)
  • parser.h (L)
    • Instruction Transliteration
    • Line Based Assembly Parsing
    • Parsing Assistance
  • linectl.h (L)
    • String Manipulation Functions
  • codegen.h (L)
    • Code Generation Functions
  • error.h (L)
    • Assembler Error Handling
  • symbols.h (L)
    • Symbol Table Lifecycle Functions
    • Symbol Table Accessors
    • Easy Symbol Table Interaction
    • Symbol Replacement
• Linker (ld6502)
  • object.h (L)
    • Object Lifecycle Functions
    • Object Accessors
  • ines.h (L)
  • flat.h (L)
  • aout.h (L)
• Disassembler (dis6502)
  • reverse.h (L)
    • Instruction Disassembly

Building

The entire project is separated into libraries for each of the Components. You can build each target in its directory, or build its library with make lib. Everything uses portable Makefiles, if you want to just build and test the entire project, simply run make in the top level directory.

Testing

Currently, running make in the top level directory will automatically make all subdirectory targets with the final one being the tests directory. Inside the tests directory are actual test runs of the assembler, disassembler, interactive reference VM, and a compiled set of C-based unit tests.

v6502 has been successfully built and tested without modification on the following platforms:

• x86_64-apple-darwin13.4.0 (clang 6.0, little-endian, 64-bit, GNU make)
• avr (gcc 4.8.1, mixed-endian, 8-bit, GNU make) *libraries only
• i386–netbsdelf (clang 3.4 & gcc 4.5.3, little-endian, 32-bit, BSD make)
• powerpc-apple-darwin9 (gcc 4.0.1, big-endian, 32-bit, GNU make)
• x86_64-unknown-freebsd10.1 (clang 3.4.1, little-endian, 64-bit, BSD make)
• armv6–netbsdelf-eabihf (gcc 4.8.4, little-endian, 32-bit, BSD make)
• x86_64-linux-gnu (gcc 4.7.2, little-endian, 64-bit, GNU make)

There is also an analyze target which will run the clang static analyzer against any library or binary target. This is also makeable from the top level.

License

The entire v6502 infrastructure is distributed under the MIT license. The exact license is as follows:

Copyright (c) 2013 Daniel Loffgren

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.

Notice

There are few foreign sources included in the tests directory. I do not attempt to claim them as my own.

• wozmon.s
  This is the original "Woz Monitor" for the Apple 1, transcribed by me, by hand, from the original Apple 1 manual, which included the full source.
  http://archive.computerhistory.org/resources/text/Apple/Apple.AppleI.1976.102646518.pdf
• wozfp1.s
  These are the original floating point routines written by Roy Rankin and Steve Wozniak for the 6502.
  http://www.6502.org/source/floats/wozfp1.txt
• snake.s
  This is the snake game implementation included as part of the easy6502 project, by skilldrick.
  https://github.com/skilldrick/easy6502/blob/gh-pages/_includes/snake.html