AuxXxilium/linux_dsm_epyc7002
1
0
Fork 0
mirror of https://github.com/AuxXxilium/linux_dsm_epyc7002.git synced 2025-03-01 18:54:59 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity

zorro.txt: standardize document format

Browse Source 
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 <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2017-05-17 09:55:46 -03:00 committed by Jonathan Corbet
parent 29c8c4ac95
commit 998ff0b579
1 changed files with 30 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
Documentation/zorro.txt
View File

@ -1,12 +1,13 @@
Writing Device Drivers for Zorro Devices ========================================
---------------------------------------- Writing Device Drivers for Zorro Devices
========================================
Written by Geert Uytterhoeven <geert@linux-m68k.org> :Author: Written by Geert Uytterhoeven <geert@linux-m68k.org>
Last revised: September 5, 2003 :Last revised: September 5, 2003
1. Introduction Introduction
--------------- ------------
The Zorro bus is the bus used in the Amiga family of computers. Thanks to The Zorro bus is the bus used in the Amiga family of computers. Thanks to
AutoConfig(tm), it's 100% Plug-and-Play. AutoConfig(tm), it's 100% Plug-and-Play.
@ -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. 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 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 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: for the board with Zorro ID ``ZORRO_PROD_xxx`` looks like::
struct zorro_dev *z = NULL; struct zorro_dev *z = NULL;
@ -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 ``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: supports different types of boards, you can use a construct like::
struct zorro_dev *z = NULL; struct zorro_dev *z = NULL;
@ -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 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 not yet in use. This is done using the I/O memory space resource management
functions: functions::
request_mem_region() request_mem_region()
release_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_request_device
zorro_release_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 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, regions. Due to the identity bus-physical address mapping on the Zorro bus,
@ -78,26 +79,26 @@ The treatment of these regions depends on the type of Zorro space:
explicitly using z_ioremap(). explicitly using z_ioremap().
Conversion from bus/physical Zorro II addresses to kernel virtual addresses 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); virt_addr = ZTWO_VADDR(bus_addr);
bus_addr = ZTWO_PADDR(virt_addr); bus_addr = ZTWO_PADDR(virt_addr);
- Zorro III address space must be mapped explicitly using z_ioremap() first - 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); virt_addr = z_ioremap(bus_addr, size);
... ...
z_iounmap(virt_addr); z_iounmap(virt_addr);
5. References References
------------- ----------
linux/include/linux/zorro.h #. linux/include/linux/zorro.h
linux/include/uapi/linux/zorro.h #. linux/include/uapi/linux/zorro.h
linux/include/uapi/linux/zorro_ids.h #. linux/include/uapi/linux/zorro_ids.h
linux/arch/m68k/include/asm/zorro.h #. linux/arch/m68k/include/asm/zorro.h
linux/drivers/zorro #. linux/drivers/zorro
/proc/bus/zorro #. /proc/bus/zorro