docs: README.buddha: convert to ReST and add to m68k book

Adjust the file for it to be properly parsed by Sphinx, adding
it to the index of the book it belongs.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2019-07-26 09:51:22 -03:00 committed by Jonathan Corbet
parent 76b5a6e842
commit 6d6486a0c5
2 changed files with 48 additions and 48 deletions

View File

@ -1,3 +1,6 @@
=====================================
Amiga Buddha and Catweasel IDE Driver
=====================================
The Amiga Buddha and Catweasel IDE Driver (part of ide.c) was written by The Amiga Buddha and Catweasel IDE Driver (part of ide.c) was written by
Geert Uytterhoeven based on the following specifications: Geert Uytterhoeven based on the following specifications:
@ -12,12 +15,12 @@ described in their manuals, no tricks have been used (for
example leaving some address lines out of the equations...). example leaving some address lines out of the equations...).
If you want to configure the board yourself (for example let If you want to configure the board yourself (for example let
a Linux kernel configure the card), look at the Commodore a Linux kernel configure the card), look at the Commodore
Docs. Reading the nibbles should give this information: Docs. Reading the nibbles should give this information::
Vendor number: 4626 ($1212) Vendor number: 4626 ($1212)
product number: 0 (42 for Catweasel Z-II) product number: 0 (42 for Catweasel Z-II)
Serial number: 0 Serial number: 0
Rom-vector: $1000 Rom-vector: $1000
The card should be a Z-II board, size 64K, not for freemem The card should be a Z-II board, size 64K, not for freemem
list, Rom-Vektor is valid, no second Autoconfig-board on the list, Rom-Vektor is valid, no second Autoconfig-board on the
@ -34,6 +37,7 @@ otherwise your chance is only 1:16 to find the board :-).
The local memory-map is even active when mapped to $e8: The local memory-map is even active when mapped to $e8:
============== ===========================================
$0-$7e Autokonfig-space, see Z-II docs. $0-$7e Autokonfig-space, see Z-II docs.
$80-$7fd reserved $80-$7fd reserved
@ -50,50 +54,51 @@ $a00-$aff IDE-Select 2 (Port 1, Register set 0)
$b00-$bff IDE-Select 3 (Port 1, Register set 1) $b00-$bff IDE-Select 3 (Port 1, Register set 1)
$c00-$cff IDE-Select 4 (Port 2, Register set 0, $c00-$cff IDE-Select 4 (Port 2, Register set 0,
Catweasel only!) Catweasel only!)
$d00-$dff IDE-Select 5 (Port 3, Register set 1, $d00-$dff IDE-Select 5 (Port 3, Register set 1,
Catweasel only!) Catweasel only!)
$e00-$eff local expansion port, on Catweasel Z-II the $e00-$eff local expansion port, on Catweasel Z-II the
Catweasel registers are also mapped here. Catweasel registers are also mapped here.
Never touch, use multidisk.device! Never touch, use multidisk.device!
$f00 read only, Byte-access: Bit 7 shows the $f00 read only, Byte-access: Bit 7 shows the
level of the IRQ-line of IDE port 0. level of the IRQ-line of IDE port 0.
$f01-$f3f mirror of $f00 $f01-$f3f mirror of $f00
$f40 read only, Byte-access: Bit 7 shows the $f40 read only, Byte-access: Bit 7 shows the
level of the IRQ-line of IDE port 1. level of the IRQ-line of IDE port 1.
$f41-$f7f mirror of $f40 $f41-$f7f mirror of $f40
$f80 read only, Byte-access: Bit 7 shows the $f80 read only, Byte-access: Bit 7 shows the
level of the IRQ-line of IDE port 2. level of the IRQ-line of IDE port 2.
(Catweasel only!) (Catweasel only!)
$f81-$fbf mirror of $f80 $f81-$fbf mirror of $f80
$fc0 write-only: Writing any value to this $fc0 write-only: Writing any value to this
register enables IRQs to be passed from the register enables IRQs to be passed from the
IDE ports to the Zorro bus. This mechanism IDE ports to the Zorro bus. This mechanism
has been implemented to be compatible with has been implemented to be compatible with
harddisks that are either defective or have harddisks that are either defective or have
a buggy firmware and pull the IRQ line up a buggy firmware and pull the IRQ line up
while starting up. If interrupts would while starting up. If interrupts would
always be passed to the bus, the computer always be passed to the bus, the computer
might not start up. Once enabled, this flag might not start up. Once enabled, this flag
can not be disabled again. The level of the can not be disabled again. The level of the
flag can not be determined by software flag can not be determined by software
(what for? Write to me if it's necessary!). (what for? Write to me if it's necessary!).
$fc1-$fff mirror of $fc0 $fc1-$fff mirror of $fc0
$1000-$ffff Buddha-Rom with offset $1000 in the rom $1000-$ffff Buddha-Rom with offset $1000 in the rom
chip. The addresses $0 to $fff of the rom chip. The addresses $0 to $fff of the rom
chip cannot be read. Rom is Byte-wide and chip cannot be read. Rom is Byte-wide and
mapped to even addresses. mapped to even addresses.
============== ===========================================
The IDE ports issue an INT2. You can read the level of the The IDE ports issue an INT2. You can read the level of the
IRQ-lines of the IDE-ports by reading from the three (two IRQ-lines of the IDE-ports by reading from the three (two
@ -128,7 +133,8 @@ must always be set to 1 to be compatible with later Buddha
versions (if I'll ever update this one). I presume that versions (if I'll ever update this one). I presume that
I'll never use the lower four bits, but they have to be set I'll never use the lower four bits, but they have to be set
to 1 by definition. to 1 by definition.
The values in this table have to be shifted 5 bits to the
The values in this table have to be shifted 5 bits to the
left and or'd with $1f (this sets the lower 5 bits). left and or'd with $1f (this sets the lower 5 bits).
All the timings have in common: Select and IOR/IOW rise at All the timings have in common: Select and IOR/IOW rise at
@ -138,44 +144,36 @@ values are no multiple of 71. One clock-cycle is 71ns long
(exactly 70,5 at 14,18 Mhz on PAL systems). (exactly 70,5 at 14,18 Mhz on PAL systems).
value 0 (Default after reset) value 0 (Default after reset)
497ns Select (7 clock cycles) , IOR/IOW after 172ns (2 clock cycles)
497ns Select (7 clock cycles) , IOR/IOW after 172ns (2 clock cycles) (same timing as the Amiga 1200 does on it's IDE port without
(same timing as the Amiga 1200 does on it's IDE port without accelerator card)
accelerator card)
value 1 value 1
639ns Select (9 clock cycles), IOR/IOW after 243ns (3 clock cycles)
639ns Select (9 clock cycles), IOR/IOW after 243ns (3 clock cycles)
value 2 value 2
781ns Select (11 clock cycles), IOR/IOW after 314ns (4 clock cycles)
781ns Select (11 clock cycles), IOR/IOW after 314ns (4 clock cycles)
value 3 value 3
355ns Select (5 clock cycles), IOR/IOW after 101ns (1 clock cycle)
355ns Select (5 clock cycles), IOR/IOW after 101ns (1 clock cycle)
value 4 value 4
355ns Select (5 clock cycles), IOR/IOW after 172ns (2 clock cycles)
355ns Select (5 clock cycles), IOR/IOW after 172ns (2 clock cycles)
value 5 value 5
355ns Select (5 clock cycles), IOR/IOW after 243ns (3 clock cycles)
355ns Select (5 clock cycles), IOR/IOW after 243ns (3 clock cycles)
value 6 value 6
1065ns Select (15 clock cycles), IOR/IOW after 314ns (4 clock cycles)
1065ns Select (15 clock cycles), IOR/IOW after 314ns (4 clock cycles)
value 7 value 7
355ns Select, (5 clock cycles), IOR/IOW after 101ns (1 clock cycle)
355ns Select, (5 clock cycles), IOR/IOW after 101ns (1 clock cycle)
When accessing IDE registers with A6=1 (for example $84x), When accessing IDE registers with A6=1 (for example $84x),
the timing will always be mode 0 8-bit compatible, no matter the timing will always be mode 0 8-bit compatible, no matter
what you have selected in the speed register: what you have selected in the speed register:
781ns select, IOR/IOW after 4 clock cycles (=314ns) aktive. 781ns select, IOR/IOW after 4 clock cycles (=314ns) aktive.
All the timings with a very short select-signal (the 355ns All the timings with a very short select-signal (the 355ns
fast accesses) depend on the accelerator card used in the fast accesses) depend on the accelerator card used in the
@ -204,7 +202,8 @@ always shows a "no IRQ here" on the Buddha, and accesses to
the third IDE port are going into data's Nirwana on the the third IDE port are going into data's Nirwana on the
Buddha. Buddha.
Jens Schönfeld february 19th, 1997 Jens Schönfeld february 19th, 1997
updated may 27th, 1997
eMail: sysop@nostlgic.tng.oche.de
updated may 27th, 1997
eMail: sysop@nostlgic.tng.oche.de

View File

@ -8,6 +8,7 @@ m68k Architecture
:maxdepth: 2 :maxdepth: 2
kernel-options kernel-options
buddha-driver
.. only:: subproject and html .. only:: subproject and html