6502/cc65
1
0
Fork 0
mirror of https://github.com/cc65/cc65.git synced 2024-06-25 13:29:41 +00:00
Code Issues Projects Releases Wiki Activity

Added documentation of static drivers.

Browse Source 
git-svn-id: svn://svn.cc65.org/cc65/trunk@5927 b7a2c559-68d2-44c3-8de9-860c34a00d81
This commit is contained in:
ol.sc 2012-11-08 23:08:00 +00:00
parent f15b8246f9
commit 8e06d6d4f7
10 changed files with 115 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/apple2enh.sgml
View File

@ -313,18 +313,20 @@ you cannot do it, it just means that there's no help.
<sect>Loadable drivers<p>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
<descrip>
<tag><tt/a2e.lo.tgi/</tag>
<tag><tt/a2e.lo.tgi (apple2_40_48_16)/</tag>
This driver features a resolution of 40&times;48 with 16 colors.
The function <tt/tgi_apple2_mix()/ allows to activate 4 lines of text. The
function clears the corresponding area at the bottom of the screen.
<tag><tt/a2e.hi.tgi/</tag>
<tag><tt/a2e.hi.tgi (apple2_280_192_8)/</tag>
This driver features a resolution of 280&times;192 with 8 colors and two
hires pages. Note that programs using this driver will have to be linked
with <tt/--start-addr $4000/ to reserve the first hires page or with
@ -350,7 +352,7 @@ you cannot do it, it just means that there's no help.
<descrip>
<tag><tt/a2e.auxmem.emd/</tag>
<tag><tt/a2e.auxmem.emd (apple2_auxmem)/</tag>
Gives access to 47.5 KB RAM (190 pages of 256 bytes each) on an Extended
80-Column Text Card.
@ -364,7 +366,7 @@ you cannot do it, it just means that there's no help.
<descrip>
<tag><tt/a2e.stdjoy.joy/</tag>
<tag><tt/a2e.stdjoy.joy (apple2_stdjoy)/</tag>
Supports up to two standard analog joysticks connected to the game port of
the enhanced&nbsp;Apple&nbsp;//e.
@ -375,7 +377,7 @@ you cannot do it, it just means that there's no help.
<descrip>
<tag><tt/a2e.stdmou.mou/</tag>
<tag><tt/a2e.stdmou.mou (apple2_stdmou)/</tag>
Driver for the AppleMouse&nbsp;II Card. Searches all Apple&nbsp;II slots
for an AppleMouse&nbsp;II Card compatible firmware. The default bounding
box is &lsqb;0..279,0..191&rsqb;.
@ -390,7 +392,7 @@ you cannot do it, it just means that there's no help.
<descrip>
<tag><tt/a2e.ssc.ser/</tag>
<tag><tt/a2e.ssc.ser (apple2_ssc)/</tag>
Driver for the Apple&nbsp;II Super Serial Card. Supports up to 19200 baud,
hardware flow control (RTS/CTS) and interrupt driven receives. Note
that because of the peculiarities of the 6551 chip transmits are not

52
doc/atari.sgml
View File

@ -154,12 +154,39 @@ chip registers.
<sect1>Graphics drivers<p>
Currently there are no graphics drivers available for the Atari platform.
However, the runtime library provides a function named _graphics, with
a mode parameter just like the BASIC GRAPHICS command. This function will
switch to the requested graphics mode.
There are currently no functions available to access the graphics
memory. The access must be implemented manually.
<descrip>
<tag><tt/atari10.tgi (atari_10)/</tag>
<tag><tt/atr10p2.tgi (atari_10p2)/</tag>
<tag><tt/atari11.tgi (atari_11)/</tag>
<tag><tt/atari14.tgi (atari_14)/</tag>
<tag><tt/atari15.tgi (atari_15)/</tag>
<tag><tt/atr15p2.tgi (atari_15p2)/</tag>
<tag><tt/atari3.tgi (atari_3)/</tag>
<tag><tt/atari4.tgi (atari_4)/</tag>
<tag><tt/atari5.tgi (atari_5)/</tag>
<tag><tt/atari6.tgi (atari_6)/</tag>
<tag><tt/atari7.tgi (atari_7)/</tag>
<tag><tt/atari8.tgi (atari_8)/</tag>
<tag><tt/atr8p2.tgi (atari_8p2)/</tag>
<tag><tt/atari9.tgi (atari_9)/</tag>
<tag><tt/atr9p2.tgi (atari_9p2)/</tag>
</descrip><p>
Many graphics modes require more memory than the text screen which is
in effect when the program starts up. Therefore the programmer has to
@ -221,24 +248,27 @@ the Atari ROM code.
<sect1>Extended memory drivers<p>
Currently there are no extended memory drivers available for the Atari
platform.
<descrip>
<tag><tt/atr130xe.emd (atari_130xe)/</tag>
</descrip><p>
<sect1>Joystick drivers<p>
<descrip>
<tag><tt/ataristd.joy/</tag>
<tag><tt/ataristd.joy (atari_stdjoy)/</tag>
Supports up to four standard joysticks connected to the joystick ports of
the Atari.
<tag><tt/atarim8.joy/</tag>
<tag><tt/atarim8.joy (atari_multijoy)/</tag>
Supports up to eight standard joysticks connected to a MultiJoy adapter.
</descrip><p>
<sect1>Mouse drivers<p>
Currently no drivers available (in fact, the API for loadable mouse drivers

7
doc/atmos.sgml
View File

@ -104,13 +104,14 @@ this may seem overhead, it has two advantages:
at runtime with almost no effort.
</enum>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
<descrip>
<tag><tt/atmos-240-200-2.tgi/</tag>
<tag><tt/atmos-240-200-2.tgi (atmos_240_200_2)/</tag>
This driver was written by Stefan Haubenthal. It features a resolution of
240&times;200 with 2 colors.
@ -126,7 +127,7 @@ No extended memory drivers are currently available for the Atmos.
<descrip>
<tag><tt/atmos-pase.joy/</tag>
<tag><tt/atmos-pase.joy (atmos_pase)/</tag>
Supports two standard joysticks connected to the P.A.S.E. interface of the Atmos.
</descrip><p>
@ -142,7 +143,7 @@ No mouse drivers are currently available for the Atmos.
<descrip>
<tag><tt/atmos-acia.ser/</tag>
<tag><tt/atmos-acia.ser (atmos_acia)/</tag>
Driver for the Telestrat integrated serial controller and the Atmos with a
serial add-on.
Note that because of the peculiarities of the 6551 chip together with the

31
doc/c128.sgml
View File

@ -159,19 +159,22 @@ structures, accessing the struct fields will access the chip registers.
<sect>Loadable drivers<p>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
Note: The graphics drivers for the VDC are incompatible with the extended
memory drivers using the VDC memory!
<descrip>
<tag><tt/c128-vdc.tgi/</tag>
<tag><tt/c128-vdc.tgi (c128_640_200_2)/</tag>
This driver was written by Maciej Witkowiak. It uses the 80 column display
and features a resolution of 640*200 with two colors and an adjustable
palette (that means that the two colors can be chosen out of the 16 VDC
colors).
<tag><tt/c128-vdc2.tgi/</tag>
<tag><tt/c128-vdc2.tgi (c128_640_480_2)/</tag>
This driver was written by Maciej Witkowiak. This driver uses the 80 column
display and features a resolution of 640*480 with two colors and an
adjustable palette (that means that the two colors can be chosen out of the
@ -186,16 +189,16 @@ missing on VDC and are translated to the two colors missing from VIC palette.
<descrip>
<tag><tt/c128-georam.emd/</tag>
<tag><tt/c128-georam.emd (c128_georam)/</tag>
A driver for the GeoRam cartridge. The driver will always assume 2048 pages
of 256 bytes each. There are no checks, so if your program knows better,
just go ahead.
<tag><tt/c128-ram.emd/</tag>
<tag><tt/c128-ram.emd (c128_ram)/</tag>
An extended memory driver for the RAM in page 1. The common memory area is
excluded, so this driver supports 251 pages of 256 bytes each.
<tag><tt/c128-ram2.emd/</tag>
<tag><tt/c128-ram2.emd (c128_ram2)/</tag>
An extended memory driver for the RAM in pages 1-3. The common memory area
is excluded, so this driver supports up to 731 pages of 256 bytes each. The
@ -204,17 +207,17 @@ missing on VDC and are translated to the two colors missing from VIC palette.
machines with RAM in banks 2+3, so it has been made a separate driver. The
additional code was contributed by Marco van den Heuvel.
<tag><tt/c128-ramcart.emd/</tag>
<tag><tt/c128-ramcart.emd (c128_ramcart)/</tag>
A driver for the RamCart 64/128 written and contributed by Maciej Witkowiak.
Will test the hardware for the available RAM.
<tag><tt/c128-reu.emd/</tag>
<tag><tt/c128-reu.emd (c128_reu)/</tag>
A driver for the CBM REUs. The driver will determine from the connected REU
if it supports 128KB of RAM or more. In the latter case, 256KB are assumed,
but since there are no range checks, the application can use more memory if
it has better knowledge about the hardware than the driver.
<tag><tt/c128-vdc.emd/</tag>
<tag><tt/c128-vdc.emd (c128_vdc)/</tag>
A driver for the VDC memory of the C128 written and contributed by Maciej
Witkowiak. Autodetects the amount of memory available (16 or 64K) and offers
64 or 256 pages of 256 bytes each. Note: This driver is incompatible with
@ -227,14 +230,14 @@ missing on VDC and are translated to the two colors missing from VIC palette.
<descrip>
<tag><tt/c128-ptvjoy.joy/</tag>
<tag><tt/c128-ptvjoy.joy (c128_ptvjoy)/</tag>
Driver for the Protovision 4-player adapter originally written by Groepaz
for the C64 and converted for the C128 by me. See <htmlurl
url="http://www.protovision-online.de/hardw/hardwstart.htm"
name="http://www.protovision-online.de/hardw/hardwstart.htm"> for prices and
building instructions. Up to four joysticks are supported.
<tag><tt/c128-stdjoy.joy/</tag>
<tag><tt/c128-stdjoy.joy (c128_stdjoy)/</tag>
Supports up to two joysticks connected to the standard joysticks port of
the C128.
@ -246,14 +249,14 @@ missing on VDC and are translated to the two colors missing from VIC palette.
<descrip>
<tag><tt/c128-1351.mou/</tag>
<tag><tt/c128-1351.mou (c128_1351)/</tag>
Supports a standard mouse connected to port #0 of the C128.
<tag><tt/c128-joy.mou/</tag>
<tag><tt/c128-joy.mou (c128_joymouse)/</tag>
Supports a mouse emulated by a standard joystick e.g. 1350 mouse in port
#1 of the C128.
<tag><tt/c128-pot.mou/</tag>
<tag><tt/c128-pot.mou (c128_potmouse)/</tag>
Supports a potentiometer device e.g. Koala Pad connected to port #1 of
the C128.
@ -264,7 +267,7 @@ missing on VDC and are translated to the two colors missing from VIC palette.
<descrip>
<tag><tt/c128-swlink.ser/</tag>
<tag><tt/c128-swlink.ser (c128_swlink)/</tag>
Driver for the SwiftLink cartridge. Supports up to 38400 baud, hardware flow
control (RTS/CTS) and interrupt driven receives. Note that because of the
peculiarities of the 6551 chip together with the use of the NMI, transmits

7
doc/c16.sgml
View File

@ -148,6 +148,9 @@ structures, accessing the struct fields will access the chip registers.
<sect>Loadable drivers<p>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
No graphics drivers are currently available for the C16/C116.
@ -157,7 +160,7 @@ No graphics drivers are currently available for the C16/C116.
<descrip>
<tag><tt/c16-ram.emd/</tag>
<tag><tt/c16-ram.emd (c16_ram)/</tag>
A driver for the hidden RAM below the BASIC and KERNAL ROMs. Supports 125
pages with 256 bytes each if the machine is equipped with 64K of memory
(a Plus/4 or a memory extended C16/116).
@ -170,7 +173,7 @@ No graphics drivers are currently available for the C16/C116.
<descrip>
<tag><tt/c16-stdjoy.joy/</tag>
<tag><tt/c16-stdjoy.joy (c16_stdjoy)/</tag>
Supports up to two joysticks connected to the standard joysticks port of
the Commodore 16/116.

39
doc/c64.sgml
View File

@ -199,6 +199,9 @@ structures, accessing the struct fields will access the chip registers.
<sect>Loadable drivers<p>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
<em>Note:</em> All available graphics drivers for the TGI interface will use
@ -207,7 +210,7 @@ the standard setup without any memory loss or need for a changed
configuration.
<descrip>
<tag><tt/c64-hi.tgi/</tag>
<tag><tt/c64-hi.tgi (c64_320_200_2)/</tag>
This driver features a resolution of 320*200 with two colors and an
adjustable palette (that means that the two colors can be chosen out of a
palette of the 16 C64 colors).
@ -218,45 +221,45 @@ configuration.
<descrip>
<tag><tt/c64-c256k.emd/</tag>
<tag><tt/c64-c256k.emd (c64_c256k)/</tag>
A driver for the C64 256K memory expansion. This driver offers 768 pages of
256 bytes each. Written and contributed by Marco van den Heuvel.
<tag><tt/c64-dqbb.emd/</tag>
<tag><tt/c64-dqbb.emd (c64_dqbb)/</tag>
A driver for the Double Quick Brown Box cartridge. This driver offers
64 pages of 256 bytes each. Written and contributed by Marco van den Heuvel.
<tag><tt/c64-georam.emd/</tag>
<tag><tt/c64-georam.emd (c64_georam)/</tag>
A driver for the Berkeley Softworks GeoRam cartridge. The driver will
determine the available RAM from the connected cartridge. It supports 64KB
up to 2048KB of RAM.
<tag><tt/c64-isepic.emd/</tag>
<tag><tt/c64-isepic.emd (c64_isepic)/</tag>
A driver for the ISEPIC cartridge. This driver offers just 8 pages of 256
bytes each. Written and contributed by Marco van den Heuvel.
<tag><tt/c64-ram.emd/</tag>
<tag><tt/c64-ram.emd (c64_ram)/</tag>
A driver for the hidden RAM below the I/O area and kernal ROM. Supports 48
256 byte pages. Please note that this driver is incompatible with any of the
graphics drivers!
<tag><tt/c64-ramcart.emd/</tag>
<tag><tt/c64-ramcart.emd (c64_ramcart)/</tag>
A driver for the RamCart 64/128 written and contributed by Maciej Witkowiak.
Will test the hardware for the available RAM.
<tag><tt/c64-reu.emd/</tag>
<tag><tt/c64-reu.emd (c64_reu)/</tag>
A driver for the CBM REUs. The driver will determine from the connected REU
if it supports 128KB of RAM or more. In the latter case, 256KB are assumed,
but since there are no range checks, the application can use more memory if
it has better knowledge about the hardware than the driver.
<tag><tt/c64-vdc.emd/</tag>
<tag><tt/c64-vdc.emd (c64_vdc)/</tag>
A driver for the VDC memory of the C128. Written and contributed by Maciej
Witkowiak. Can be used if the program is running in C64 mode of the C128.
Autodetects the amount of memory available (16 or 64K) and offers 64 or 256
pages of 256 bytes each.
<tag><tt/dtv-himem.emd/</tag>
<tag><tt/dtv-himem.emd (dtv_himem)/</tag>
A driver for the C64 D2TV (the second or PAL version). This driver offers
indeed 7680 pages of 256 bytes each.
@ -267,23 +270,23 @@ configuration.
<descrip>
<tag><tt/c64-hitjoy.joy/</tag>
<tag><tt/c64-hitjoy.joy (c64_hitjoy)/</tag>
Driver for the Digital Excess & Hitmen adapter contributed by Groepaz. See
<htmlurl url="http://www.digitalexcess.de/downloads/productions.php"
name="http://www.digitalexcess.de/downloads/productions.php"> on
instructions how to build one. Up to four joysticks are supported.
<tag><tt/c64-ptvjoy.joy/</tag>
<tag><tt/c64-ptvjoy.joy (c64_ptvjoy)/</tag>
Driver for the Protovision 4-player adapter contributed by Groepaz. See
<htmlurl url="http://www.protovision-online.de/hardw/hardwstart.htm"
name="http://www.protovision-online.de/hardw/hardwstart.htm"> for prices and
building instructions. Up to four joysticks are supported.
<tag><tt/c64-stdjoy.joy/</tag>
<tag><tt/c64-stdjoy.joy (c64_stdjoy)/</tag>
Supports up to two standard joysticks connected to the joysticks port of
the C64.
<tag><tt/c64-numpad.joy/</tag>
<tag><tt/c64-numpad.joy (c64_numpad)/</tag>
Supports one joystick emulated by the numberpad of the C128 in C64 mode,
the firebutton is labeled &dquot;5&dquot; and ENTER.
@ -294,14 +297,14 @@ configuration.
<descrip>
<tag><tt/c64-1351.mou/</tag>
<tag><tt/c64-1351.mou (c64_1351)/</tag>
Supports a standard mouse connected to port #0 of the C64.
<tag><tt/c64-joy.mou/</tag>
<tag><tt/c64-joy.mou (c64_joymouse)/</tag>
Supports a mouse emulated by a standard joystick e.g. 1350 mouse in port
#1 of the C64.
<tag><tt/c64-pot.mou/</tag>
<tag><tt/c64-pot.mou (c64_potmouse)/</tag>
Supports a potentiometer device e.g. Koala Pad connected to port #1 of
the C64.
@ -312,7 +315,7 @@ configuration.
<descrip>
<tag><tt/c64-swlink.ser/</tag>
<tag><tt/c64-swlink.ser (c64_swlink)/</tag>
Driver for the SwiftLink cartridge. Supports up to 38400 baud, hardware flow
control (RTS/CTS) and interrupt driven receives. Note that because of the
peculiarities of the 6551 chip together with the use of the NMI, transmits

8
doc/cbm510.sgml
View File

@ -173,6 +173,8 @@ will <em>not</em> work!
<sect>Loadable drivers<p>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
@ -182,7 +184,7 @@ No graphics drivers are currently available for the Commodore 510.
<sect1>Extended memory drivers<p>
<descrip>
<tag><tt/cbm510-ram.emd/</tag>
<tag><tt/cbm510-ram.emd (cbm510_ram)/</tag>
A driver for the RAM in bank 1. Supports up to 255 pages with 256 bytes
each.
</descrip><p>
@ -192,7 +194,7 @@ No graphics drivers are currently available for the Commodore 510.
<descrip>
<tag><tt/cbm510-std.joy/</tag>
<tag><tt/cbm510-std.joy (cbm510_stdjoy)/</tag>
Supports up to two standard joysticks connected to the joysticks port of
the Commodore 510.
@ -208,7 +210,7 @@ No mouse drivers are currently available for the Commodore 510.
<descrip>
<tag><tt/cbm510-std.ser/</tag>
<tag><tt/cbm510-std.ser (cbm510_stdser)/</tag>
Driver for the 6551 ACIA chip built into the Commodore 510. Supports up to
19200 baud, hardware flow control (RTS/CTS) and interrupt driven receives.
Note that because of the peculiarities of the 6551 chip transmits are not

6
doc/cbm610.sgml
View File

@ -173,6 +173,8 @@ will <em>not</em> work!
<sect>Loadable drivers<p>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
@ -184,7 +186,7 @@ really good:-).
<sect1>Extended memory drivers<p>
<descrip>
<tag><tt/cbm610-ram.emd/</tag>
<tag><tt/cbm610-ram.emd (cbm610_ram)/</tag>
A driver for the RAM in bank 2. Supports up to 255 pages with 256 bytes
each.
</descrip><p>
@ -207,7 +209,7 @@ does not exist).
<descrip>
<tag><tt/cbm610-std.ser/</tag>
<tag><tt/cbm610-std.ser (cbm610_stdser)/</tag>
Driver for the 6551 ACIA chip built into the Commodore 610. Supports up to
19200 baud, hardware flow control (RTS/CTS) and interrupt driven receives.
Note that because of the peculiarities of the 6551 chip transmits are not

9
doc/plus4.sgml
View File

@ -146,6 +146,9 @@ structures, accessing the struct fields will access the chip registers.
<sect>Loadable drivers<p>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
No graphics drivers are currently available for the Plus/4.
@ -156,19 +159,17 @@ No graphics drivers are currently available for the Plus/4.
No extended memory drivers are currently available for the Plus/4.
<sect1>Joystick drivers<p>
<descrip>
<tag><tt/plus4-stdjoy.joy/</tag>
<tag><tt/plus4-stdjoy.joy (plus4_stdjoy)/</tag>
Supports up to two joysticks connected to the standard joysticks port of
the Plus/4.
</descrip><p>
<sect1>Mouse drivers<p>
Currently no drivers available (in fact, the API for loadable mouse drivers
@ -179,7 +180,7 @@ does not exist).
<descrip>
<tag><tt/plus4-stdser.ser/</tag>
<tag><tt/plus4-stdser.ser (plus4_stdser)/</tag>
Driver for the 6551 ACIA chip built into the Plus/4. Supports up to 19200
baud, hardware flow control (RTS/CTS) and interrupt driven receives. Note
that because of the peculiarities of the 6551 chip transmits are not

8
doc/vic20.sgml
View File

@ -136,6 +136,9 @@ structures, accessing the struct fields will access the chip registers.
<sect>Loadable drivers<p>
The names in the parentheses denote the symbols to be used for static linking of the drivers.
<sect1>Graphics drivers<p>
No graphics drivers are currently available for the VIC20.
@ -150,10 +153,10 @@ No extended memory drivers are currently available for the VIC20.
<descrip>
<tag><tt/vic20-stdjoy.joy/</tag>
<tag><tt/vic20-stdjoy.joy (vic20_stdjoy)/</tag>
Supports one standard joystick connected to the joysticks port of the VIC20.
<tag><tt/vic20-ptvjoy.joy/</tag>
<tag><tt/vic20-ptvjoy.joy (vic20_ptvjoy)/</tag>
Driver for the Protovision 4-player adapter contributed by Groepaz. See
<htmlurl url="http://www.protovision-online.de/hardw/hardwstart.htm"
name="http://www.protovision-online.de/hardw/hardwstart.htm"> for prices and
@ -162,7 +165,6 @@ No extended memory drivers are currently available for the VIC20.
</descrip><p>
<sect1>Mouse drivers<p>
No mouse drivers are currently available for the VIC20.