git.sur5r.net Git - cc65/blob - doc/nes.sgml

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4
   5 <title>Nintendo Entertainment System specific information for cc65
   6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
   7 Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org">
   8 <date>2005-07-17
   9
  10 <abstract>
  11 An overview over the NES runtime system as it is implemented for the
  12 cc65 C compiler.
  13 </abstract>
  14
  15 <!-- Table of contents -->
  16 <toc>
  17
  18 <!-- Begin the document -->
  19
  20 <sect>Overview<p>
  21
  22 This file contains an overview of the NES runtime system as it comes
  23 with the cc65 C compiler. It describes the memory layout, NES specific header
  24 files, available drivers, and any pitfalls specific to that platform.
  25
  26 Please note that NES specific functions are just mentioned here, they are
  27 described in detail in the separate <htmlurl url="funcref.html" name="function
  28 reference">. Even functions marked as "platform dependent" may be available on
  29 more than one platform. Please see the function reference for more
  30 information.
  31
  32
  33 <sect>Binary format<p>
  34
  35 The standard binary output format generated by the linker for the NES target
  36 is a machine language program with an INES cartridge header. It is of course
  37 possible to change this behaviour by using a modified startup file and linker
  38 config.
  39
  40 <sect>Memory layout<p>
  41
  42 cc65 generated programs with the default setup run with the I/O area and a
  43 CHR bank enabled, which gives a usable memory range of &dollar;8000 - &dollar;FFF3.
  44 All boot ROM entry points may be called directly without additional code.
  45
  46 Special locations:
  47
  48 <descrip>
  49   <tag/Text screen/
  50   The text screen is located at VRAM &dollar;2000.
  51
  52   <tag/Stack/
  53   The C runtime stack is located at &dollar;7FFF and growing downwards.
  54
  55   <tag/Heap/
  56   The C heap is located at the end of the program and grows towards the C
  57   runtime stack.
  58
  59 </descrip><p>
  60
  61
  62
  63 <sect>Platform specific header files<p>
  64
  65 Programs containing NES specific code may use the <tt/nes.h/ header file.
  66
  67
  68 <sect1>NES specific functions<p>
  69
  70 <itemize>
  71 <item>waitvblank
  72 <item>get_tv
  73 </itemize>
  74
  75
  76
  77 <sect1>Hardware access<p>
  78
  79 The following pseudo variables declared in the <tt/nes.inc/ include file do
  80 allow access to hardware located in the address space.
  81
  82 <descrip>
  83
  84   <tag><tt/PPU/</tag>
  85   The <tt/PPU/ defines allow access to the PPU chip.
  86
  87   <tag><tt/APU/</tag>
  88   The <tt/APU/ defines allow access to the APU chip.
  89
  90 </descrip><p>
  91
  92
  93
  94 <sect>Loadable drivers<p>
  95
  96 All drivers must be statically linked because no file I/O is available.
  97 The names in the parentheses denote the symbols to be used for static linking of the drivers.
  98
  99
 100 <sect1>Graphics drivers<p>
 101
 102 <descrip>
 103
 104   <tag><tt/nes-64-56-2.tgi (nes_64_56_2)/</tag>
 105   This driver features a resolution of 64&times;56 with 2 colors using the
 106   CHR bank.
 107
 108 </descrip><p>
 109
 110
 111 <sect1>Extended memory drivers<p>
 112
 113 No extended memory drivers are currently available for the NES.
 114
 115
 116 <sect1>Joystick drivers<p>
 117
 118 <descrip>
 119
 120   <tag><tt/nes-stdjoy.joy (nes_stdjoy)/</tag>
 121   A joystick driver for the standard four buttons joypad is available.
 122
 123 </descrip><p>
 124
 125
 126 <sect1>Mouse drivers<p>
 127
 128 No mouse drivers are currently available for the NES.
 129
 130
 131 <sect1>RS232 device drivers<p>
 132
 133 No serial drivers are currently available for the NES.
 134
 135
 136
 137 <sect>Limitations<p>
 138
 139 <sect1>Disk I/O<p>
 140
 141 The existing library for the NES doesn't implement C file
 142 I/O. There are no hacks for the <tt/read()/ and <tt/write()/ routines.
 143
 144 To be more concrete, this limitation means that you cannot use any of the
 145 following functions (and a few others):
 146
 147 <itemize>
 148 <item>fclose
 149 <item>fopen
 150 <item>fread
 151 <item>fprintf
 152 <item>fputc
 153 <item>fscanf
 154 <item>fwrite
 155 <item>...
 156 </itemize>
 157
 158
 159
 160 <sect>Other hints<p>
 161
 162
 163
 164 <sect>License<p>
 165
 166 This software is provided 'as-is', without any expressed or implied
 167 warranty.  In no event will the authors be held liable for any damages
 168 arising from the use of this software.
 169
 170 Permission is granted to anyone to use this software for any purpose,
 171 including commercial applications, and to alter it and redistribute it
 172 freely, subject to the following restrictions:
 173
 174 <enum>
 175 <item>  The origin of this software must not be misrepresented; you must not
 176         claim that you wrote the original software. If you use this software
 177         in a product, an acknowledgment in the product documentation would be
 178         appreciated but is not required.
 179 <item>  Altered source versions must be plainly marked as such, and must not
 180         be misrepresented as being the original software.
 181 <item>  This notice may not be removed or altered from any source
 182         distribution.
 183 </enum>
 184
 185 </article>
 186
 187
 188