Skip to content

Commit

Permalink
zorro.txt: standardize document format
Browse files Browse the repository at this point in the history
Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- Use right marks for titles;
- Use authorship marks;
- Mark literals and literal blocks;
- Use autonumbered list for references.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
mchehab authored and Jonathan Corbet committed Jul 14, 2017
1 parent 29c8c4a commit 998ff0b
Showing 1 changed file with 30 additions and 29 deletions.
59 changes: 30 additions & 29 deletions Documentation/zorro.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
Writing Device Drivers for Zorro Devices
----------------------------------------
========================================
Writing Device Drivers for Zorro Devices
========================================

Written by Geert Uytterhoeven <[email protected]>
Last revised: September 5, 2003
:Author: Written by Geert Uytterhoeven <[email protected]>
:Last revised: September 5, 2003


1. Introduction
---------------
Introduction
------------

The Zorro bus is the bus used in the Amiga family of computers. Thanks to
AutoConfig(tm), it's 100% Plug-and-Play.
Expand All @@ -20,12 +21,12 @@ There are two types of Zorro buses, Zorro II and Zorro III:
with Zorro II. The Zorro III address space lies outside the first 16 MB.


2. Probing for Zorro Devices
----------------------------
Probing for Zorro Devices
-------------------------

Zorro devices are found by calling `zorro_find_device()', which returns a
pointer to the `next' Zorro device with the specified Zorro ID. A probe loop
for the board with Zorro ID `ZORRO_PROD_xxx' looks like:
Zorro devices are found by calling ``zorro_find_device()``, which returns a
pointer to the ``next`` Zorro device with the specified Zorro ID. A probe loop
for the board with Zorro ID ``ZORRO_PROD_xxx`` looks like::

struct zorro_dev *z = NULL;

Expand All @@ -35,8 +36,8 @@ for the board with Zorro ID `ZORRO_PROD_xxx' looks like:
...
}

`ZORRO_WILDCARD' acts as a wildcard and finds any Zorro device. If your driver
supports different types of boards, you can use a construct like:
``ZORRO_WILDCARD`` acts as a wildcard and finds any Zorro device. If your driver
supports different types of boards, you can use a construct like::

struct zorro_dev *z = NULL;

Expand All @@ -49,24 +50,24 @@ supports different types of boards, you can use a construct like:
}


3. Zorro Resources
------------------
Zorro Resources
---------------

Before you can access a Zorro device's registers, you have to make sure it's
not yet in use. This is done using the I/O memory space resource management
functions:
functions::

request_mem_region()
release_mem_region()

Shortcuts to claim the whole device's address space are provided as well:
Shortcuts to claim the whole device's address space are provided as well::

zorro_request_device
zorro_release_device


4. Accessing the Zorro Address Space
------------------------------------
Accessing the Zorro Address Space
---------------------------------

The address regions in the Zorro device resources are Zorro bus address
regions. Due to the identity bus-physical address mapping on the Zorro bus,
Expand All @@ -78,26 +79,26 @@ The treatment of these regions depends on the type of Zorro space:
explicitly using z_ioremap().

Conversion from bus/physical Zorro II addresses to kernel virtual addresses
and vice versa is done using:
and vice versa is done using::

virt_addr = ZTWO_VADDR(bus_addr);
bus_addr = ZTWO_PADDR(virt_addr);

- Zorro III address space must be mapped explicitly using z_ioremap() first
before it can be accessed:
before it can be accessed::

virt_addr = z_ioremap(bus_addr, size);
...
z_iounmap(virt_addr);


5. References
-------------
References
----------

linux/include/linux/zorro.h
linux/include/uapi/linux/zorro.h
linux/include/uapi/linux/zorro_ids.h
linux/arch/m68k/include/asm/zorro.h
linux/drivers/zorro
/proc/bus/zorro
#. linux/include/linux/zorro.h
#. linux/include/uapi/linux/zorro.h
#. linux/include/uapi/linux/zorro_ids.h
#. linux/arch/m68k/include/asm/zorro.h
#. linux/drivers/zorro
#. /proc/bus/zorro

0 comments on commit 998ff0b

Please sign in to comment.