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 </itemize>
  73
  74
  75
  76 <sect1>Hardware access<p>
  77
  78 The following pseudo variables declared in the <tt/nes.inc/ include file do
  79 allow access to hardware located in the address space.
  80
  81 <descrip>
  82
  83   <tag><tt/PPU/</tag>
  84   The <tt/PPU/ defines allow access to the PPU chip.
  85
  86   <tag><tt/APU/</tag>
  87   The <tt/APU/ defines allow access to the APU chip.
  88
  89 </descrip><p>
  90
  91
  92
  93 <sect>Loadable drivers<p>
  94
  95 <sect1>Graphics drivers<p>
  96
  97 No graphics drivers are currently available for the NES.
  98
  99 <sect1>Extended memory drivers<p>
 100
 101 No extended memory drivers are currently available for the NES.
 102
 103
 104 <sect1>Joystick drivers<p>
 105
 106 A joystick driver for the standard buttons is available, but must be
 107 statically linked, because no file I/O is available. See the documentation for
 108 the <htmlurl url="co65.html" name="co65 utility"> for information on how to do
 109 that.
 110
 111 <sect1>Mouse drivers<p>
 112
 113 No mouse drivers are currently available for the NES.
 114
 115
 116 <sect1>RS232 device drivers<p>
 117
 118 No serial drivers are currently available for the NES.
 119
 120
 121
 122 <sect>Limitations<p>
 123
 124 <sect1>Disk I/O<p>
 125
 126 The existing library for the NES doesn't implement C file
 127 I/O. There are no hacks for the <tt/read()/ and <tt/write()/ routines.
 128
 129 To be more concrete, this limitation means that you cannot use any of the
 130 following functions (and a few others):
 131
 132 <itemize>
 133 <item>fclose
 134 <item>fopen
 135 <item>fread
 136 <item>fprintf
 137 <item>fputc
 138 <item>fscanf
 139 <item>fwrite
 140 <item>...
 141 </itemize>
 142
 143
 144
 145 <sect>Other hints<p>
 146
 147
 148
 149 <sect>Bugs/Feedback<p>
 150
 151 If you have problems using the library, if you find any bugs, or if you're
 152 doing something interesting with it, I would be glad to hear from you. Feel
 153 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
 154 name="uz@cc65.org">).
 155
 156
 157
 158 <sect>License<p>
 159
 160 This software is provided 'as-is', without any expressed or implied
 161 warranty.  In no event will the authors be held liable for any damages
 162 arising from the use of this software.
 163
 164 Permission is granted to anyone to use this software for any purpose,
 165 including commercial applications, and to alter it and redistribute it
 166 freely, subject to the following restrictions:
 167
 168 <enum>
 169 <item>  The origin of this software must not be misrepresented; you must not
 170         claim that you wrote the original software. If you use this software
 171         in a product, an acknowledgment in the product documentation would be
 172         appreciated but is not required.
 173 <item>  Altered source versions must be plainly marked as such, and must not
 174         be misrepresented as being the original software.
 175 <item>  This notice may not be removed or altered from any source
 176         distribution.
 177 </enum>
 178
 179 </article>
 180
 181
 182