os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Clean up the newbus chapter for the following

Browse source 
errors found by textproc/igor:
- wrap long line
- leave an empty line after <title> tag
- use two spaces at sentence start
This commit is contained in:
Benedict Reuschling 2018-09-23 10:29:39 +00:00
parent e5fa3a7b99
commit 97da13d078
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=52291
1 changed files with 42 additions and 21 deletions

63
en_US.ISO8859-1/books/arch-handbook/newbus/chapter.xml
View file

@ -22,18 +22,38 @@
Provided under the FreeBSD Documentation License.
-->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="newbus">
<info><title>Newbus</title>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="newbus">
<info>
<title>Newbus</title>
<authorgroup>
<author><personname><firstname>Jeroen</firstname><surname>Ruigrok van der Werven (asmodai)</surname></personname><affiliation>
<address><email>asmodai@FreeBSD.org</email></address>
</affiliation><contrib>Written by </contrib></author>
<author><personname><firstname>Hiten</firstname><surname>Pandya</surname></personname><affiliation>
<address><email>hiten@uk.FreeBSD.org</email></address>
</affiliation></author>
<author>
<personname>
<firstname>Jeroen</firstname>
<surname>Ruigrok van der Werven (asmodai)</surname>
</personname>
<affiliation>
<address>
<email>asmodai@FreeBSD.org</email>
</address>
</affiliation>
<contrib>Written by </contrib>
</author>
<author>
<personname>
<firstname>Hiten</firstname>
<surname>Pandya</surname>
</personname>
<affiliation>
<address>
<email>hiten@uk.FreeBSD.org</email>
</address>
</affiliation>
</author>
</authorgroup>
</info>
<para><emphasis>Special thanks to Matthew N. Dodd, Warner Losh, Bill
Paul, Doug Rabson, Mike Smith, Peter Wemm and Scott
@ -79,11 +99,11 @@
<para><emphasis>Block devices</emphasis> performed in a way that
used fixed size blocks [of data]. This type of driver
depended on the so-called <emphasis>buffer cache</emphasis>,
which had cached accessed blocks of data in a
dedicated part of memory. Often this buffer cache was
based on write-behind, which meant that when data was modified
in memory it got synced to disk whenever the system did its
periodical disk flushing, thus optimizing writes.</para>
which had cached accessed blocks of data in a dedicated part
of memory. Often this buffer cache was based on write-behind,
which meant that when data was modified in memory it got
synced to disk whenever the system did its periodical disk
flushing, thus optimizing writes.</para>
</sect2>
<sect2>
@ -143,7 +163,7 @@
entity in the system. For instance each PCI device is
represented by a Newbus device. Any device in the system can
have children; a device which has children is often called a
<emphasis><quote>bus</quote></emphasis>. Examples of common
<emphasis><quote>bus</quote></emphasis>. Examples of common
busses in the system are ISA and PCI, which manage lists of
devices attached to ISA and PCI busses respectively.</para>
@ -193,9 +213,10 @@
port-mapped registers (some hardware supports both).</para>
<para>This support is integrated into the resource allocation
mechanism. When a resource is allocated, a driver can retrieve
the associated <varname remap="structfield">bus_space_tag_t</varname> and
<varname remap="structfield">bus_space_handle_t</varname> from the
mechanism. When a resource is allocated, a driver can retrieve
the associated <varname
remap="structfield">bus_space_tag_t</varname> and <varname
remap="structfield">bus_space_handle_t</varname> from the
resource.</para>
<para>Newbus also allows for definitions of interface methods in
@ -219,12 +240,12 @@
table declared by the driver. A device can later
<emphasis>detach</emphasis> from its driver and
<emphasis>re-attach</emphasis> to a new driver with a new method
table. This allows dynamic replacement of drivers which can be
table. This allows dynamic replacement of drivers which can be
useful for driver development.</para>
<para>The interfaces are described by an interface definition
language similar to the language used to define vnode operations
for file systems. The interface would be stored in a methods
for file systems. The interface would be stored in a methods
file (which would normally be named
<filename>foo_if.m</filename>).</para>
@ -279,7 +300,7 @@
contains methods suitable for devices which have children,
including methods to access bus specific per-device information
<footnote><para>&man.bus.generic.read.ivar.9; and
&man.bus.generic.write.ivar.9;</para></footnote>, event
&man.bus.generic.write.ivar.9;</para></footnote>, event
notification
(<emphasis><literal>child_detached</literal></emphasis>,
<emphasis><literal>driver_added</literal></emphasis>) and