1 <!doctype linuxdoc system>
5 <title>PC-Engine (TurboGrafx 16) System-specific information for cc65
6 <author><url url="mailto:groepaz@gmx.net" name="Groepaz/Hitmen">,<newline>
7 <url url="mailto:greg.king5@verizon.net" name="Greg King">
11 An overview over the PCE runtime system as it is implemented for the
15 <!-- Table of contents -->
18 <!-- Begin the document -->
22 This file contains an overview of the PCE runtime system as it comes
23 with the cc65 C compiler. It describes the memory layout, PCE-specific header
24 files, available drivers, and any pitfalls specific to that platform.
26 Please note that PCE-specific functions are just mentioned here; they are
27 described, in detail, in the separate <url url="funcref.html" name="function
28 reference">. Even functions marked as "platform dependent" might be available on
29 more than one platform. Please see the function reference for more
34 <sect>Binary format<p>
36 The binary output file generated by the linker, for the PCE target, is an
37 image, with no header, that has 8K bytes in the wrong place. That file must be
38 post-processed; the 8K at the end must be moved to the front of the image.
40 On POSIX systems, the <tt/dd/ command and the shell give a convenient way to do
41 it. Here is an example of their use:
43 dd if=conio.bin bs=8K skip=3 > conio.pce
44 dd if=conio.bin bs=8K count=3 >> conio.pce
46 The first command grabs the last 8K of a 32K file, and writes it as the first
47 part of a new file. The second command reads all but the last part of the old
48 file, and appends it to the new file.
50 +--------+--------+--------+--------+
51 | Bank 1 | Bank 2 | Bank 3 | Bank 0 | <-- "conio.bin"
52 +--------+--------+--------+--------+
54 +--------+--------+--------+--------+
55 | Bank 0 | Bank 1 | Bank 2 | Bank 3 | <-- "conio.pce"
56 +--------+--------+--------+--------+
58 <em/Note/: That <tt/.pce/ file shows the format of the ROM cartridge that is
59 plugged into a PC-Engine. But, that <tt/.bin/ file shows what programs
60 actually see when they execute the code in that cartridge.
64 <sect>Memory layout<p>
66 cc65-generated programs with the default setup run with the memory map that was
67 used by many PC-Engine games:
69 <item>The first 8K bytes is the I/O area.
70 <item>The second 8K bytes is RAM, which holds
72 <item>the redirected zero-page and the redirected hardware stack page,
73 <item>and 7680 bytes of general memory ($2200 - $3FFF).
75 <item>The last 8K bytes in the usual 64K-byte range is the ROM that holds the
82 <tag/Text screen and Font/
83 The text screen is located at Video RAM (VRAM) address $0000;
84 the Font is located at VRAM address $2000.
87 The C run-time stack is located in system RAM at $3FFF;
91 The Data (initialized variables) and BSS (uninitialized variables) sections are
92 placed one after the other into system RAM at $2200.
95 The C heap is located after the end of the BSS section;
96 and, extends up to the C run-time stack.
99 In an 8K ROM cartridge, code and read-only data are located between
100 $E000 and $FFF5 in the System bank.
102 In a 16K cartridge, code and read-only data are located between $C000
105 In a 32K cartridge, code and read-only data are located between $8000
111 <sect>Platform-specific header files<p>
113 Programs containing PCE-specific code may use the <tt/pce.h/ header file.
116 <sect1>PCE-specific functions<p>
119 <item>waitvsync</item>
120 <item>get_tv (since all PCE systems are NTSC, this always returns TV_NTSC)</item>
124 <sect1>Hardware access<p>
126 The following constants, defined in the <tt/pce.inc/ include file, do
127 allow access to hardware that is located in the address space.
132 The <tt/PSG/ defines allow access to the PSG (Programmable Sound Generator).
135 The <tt/VCE/ defines allow access to the VCE chip (Video Color Encoder).
138 The <tt/VDC/ defines allow access to the VDC chip (Video Display Controller).<newline>
139 32K of 16-bit words of Video RAM can be accessed only through this chip.
145 <sect>Loadable drivers<p>
147 All drivers must be statically linked because no file I/O is available.
148 The names in the parentheses denote the symbols to be used for static linking of the drivers.
151 <sect1>Graphics drivers<p>
153 No TGI graphics drivers are currently available for the PCE.
156 <sect1>Extended memory drivers<p>
158 No extended memory drivers are currently available for the PCE.
161 <sect1>Joystick drivers<p>
165 <tag><tt/pce-stdjoy.joy (pce_stdjoy)/</tag>
166 A joystick driver for the standard two-button joypad is available.
168 Note that the Japanese 6-button pad currently is not supported.
173 <sect1>Mouse drivers<p>
175 No mouse drivers are currently available for the PCE.
178 <sect1>RS232 device drivers<p>
180 No serial drivers are currently available for the PCE.
189 The existing library for the PCE doesn't implement C file
190 I/O. There are no hacks for the <tt/read()/ and <tt/write()/ routines.
192 To be more concrete, that limitation means that you cannot use any of the
193 following functions (and a few others):
212 <item><url url="https://mednafen.github.io/" name= "Mednafen"> is a good
213 emulator to use for the PC-Engine.
216 Some useful resources on PCE coding:
219 <item><url url="http://blog.blockos.org/?tag=pc-engine">
220 <item><url url="http://pcedev.blockos.org/viewforum.php?f=5">
221 <item><url url="http://www.romhacking.net/?page=documents&platform=4">
222 <item><url url="http://archaicpixels.com/Main_Page">
224 <item><url url="http://www.magicengine.com/mkit/doc.html">
226 <item><url url="https://github.com/uli/huc">
227 <item><url url="http://www.zeograd.com/parse.php?src=hucf">
234 This software is provided "as-is", without any expressed or implied
235 warranty. In no event will the authors be held liable for any damages
236 arising from the use of this software.
238 Permission is granted to anyone to use this software for any purpose,
239 including commercial applications, and to alter it and redistribute it
240 freely, subject to the following restrictions:
243 <item>The origin of this software must not be misrepresented; you must not
244 claim that you wrote the original software. If you use this software
245 in a product, an acknowledgment in the product documentation would be
246 appreciated, but is not required.
247 <item>Altered source versions must be marked plainly as such; and, must not
248 be misrepresented as being the original software.
249 <item>This notice may not be removed or altered from any source