Replace quotes with more appropriate tags,

in preparation of applying other fixes.

Inspired by:    Ceri <setantae@submonkey.net>
This commit is contained in:
Giorgos Keramidas 2002-02-16 22:54:50 +00:00
parent 29fa736d61
commit 50ce76a93c
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=12213
2 changed files with 34 additions and 34 deletions

View file

@ -23,7 +23,7 @@
only pseudo-code. It avoids the details irrelevant to the only pseudo-code. It avoids the details irrelevant to the
subject of the discussion. The real-life examples can be found subject of the discussion. The real-life examples can be found
in the source code of real drivers. In particular the drivers in the source code of real drivers. In particular the drivers
"ep" and "aha" are good sources of information.</para> <literal>ep</literal> and <literal>aha</literal> are good sources of information.</para>
</sect1> </sect1>
<sect1> <sect1>
@ -49,7 +49,7 @@
functions.</para> functions.</para>
<para>The list of bus methods implemented by an ISA driver is like <para>The list of bus methods implemented by an ISA driver is like
one for any other bus. For a hypothetical driver named "xxx" one for any other bus. For a hypothetical driver named <quote>xxx</quote>
they would be:</para> they would be:</para>
<itemizedlist> <itemizedlist>
@ -198,7 +198,7 @@
<listitem><para><function>char <listitem><para><function>char
*device_get_name(dev)</function> Get the driver name, such *device_get_name(dev)</function> Get the driver name, such
as "xxx" for our example.</para></listitem> as <literal>"xxx"</literal> for our example.</para></listitem>
<listitem><para><function>int device_get_unit(dev)</function> <listitem><para><function>int device_get_unit(dev)</function>
Get the unit number (units are numbered from 0 for the Get the unit number (units are numbered from 0 for the
@ -206,7 +206,7 @@
<listitem><para><function>char <listitem><para><function>char
*device_get_nameunit(dev)</function> Get the device name *device_get_nameunit(dev)</function> Get the device name
including the unit number, such as "xxx0", "xxx1" and so including the unit number, such as <quote>xxx0</quote>, <quote>xxx1</quote> and so
on.</para></listitem> on.</para></listitem>
<listitem><para><function>char <listitem><para><function>char
@ -263,10 +263,10 @@
at all and some allow the driver to read the IRQ setting from at all and some allow the driver to read the IRQ setting from
the device configuration ports. If a machine has multiple ISA the device configuration ports. If a machine has multiple ISA
buses the exact bus may be specified in the configuration buses the exact bus may be specified in the configuration
line, like "isa0" or "isa1", otherwise the device would be line, like <literal>isa0</literal> or <literal>isa1</literal>, otherwise the device would be
searched for on all the ISA buses.</para> searched for on all the ISA buses.</para>
<para>"sensitive" is a resource requesting that this device must <para><literal>sensitive</literal> is a resource requesting that this device must
be probed before all non-sensitive devices. It is supported be probed before all non-sensitive devices. It is supported
but does not seem to be used in any current driver.</para> but does not seem to be used in any current driver.</para>
@ -307,7 +307,7 @@
prevent them from being probed as legacy devices.</para> prevent them from being probed as legacy devices.</para>
<para>The probe routines of non-PnP devices marked as <para>The probe routines of non-PnP devices marked as
"sensitive" are called. If probe for a device went <literal>sensitive</literal> are called. If probe for a device went
successfully, the attach routine is called for it.</para> successfully, the attach routine is called for it.</para>
<para>The probe and attach routines of all non-PNP devices are <para>The probe and attach routines of all non-PNP devices are
@ -427,7 +427,7 @@
has two memory regions if would have resources of type has two memory regions if would have resources of type
SYS_RES_MEMORY numbered 0 and 1. The resource type has SYS_RES_MEMORY numbered 0 and 1. The resource type has
nothing to do with the C language type, all the resource nothing to do with the C language type, all the resource
values have the C language type "unsigned long" and must be values have the C language type <literal>unsigned long</literal> and must be
cast as necessary. The resource numbers do not have to be cast as necessary. The resource numbers do not have to be
contiguous although for ISA they normally would be. The contiguous although for ISA they normally would be. The
permitted resource numbers for ISA devices are:</para> permitted resource numbers for ISA devices are:</para>
@ -652,8 +652,8 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>handler</emphasis> - pointer to the handler <para><emphasis>handler</emphasis> - pointer to the handler
function, the type driver_intr_t is defined as "void function, the type driver_intr_t is defined as <function>void
driver_intr_t(void *)"</para> driver_intr_t(void *)</function></para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>arg</emphasis> - the argument passed to the <para><emphasis>arg</emphasis> - the argument passed to the
@ -763,7 +763,7 @@
into a map. Each page of this memory will be checked for into a map. Each page of this memory will be checked for
conformance to the map requirement. If it conforms then it is conformance to the map requirement. If it conforms then it is
left at its original location. If it is not then a fresh left at its original location. If it is not then a fresh
conformant "bounce page" is allocated and used as intermediate conformant <quote>bounce page</quote> is allocated and used as intermediate
storage. When writing the data from the non-conformant storage. When writing the data from the non-conformant
original pages they will be copied to their bounce pages first original pages they will be copied to their bounce pages first
and then transferred from the bounce pages to the device. When and then transferred from the bounce pages to the device. When
@ -792,13 +792,13 @@
<para><emphasis>parent</emphasis> - parent tag, or NULL to <para><emphasis>parent</emphasis> - parent tag, or NULL to
create a top-level tag <emphasis>alignment</emphasis> - create a top-level tag <emphasis>alignment</emphasis> -
required physical alignment of the memory area to be required physical alignment of the memory area to be
allocated for this tag. Use value 1 for "no specific allocated for this tag. Use value 1 for <quote>no specific
alignment". Applies only to the future alignment</quote>. Applies only to the future
<function>bus_dmamem_alloc()</function> but not <function>bus_dmamem_alloc()</function> but not
<function>bus_dmamap_create()</function> calls. <function>bus_dmamap_create()</function> calls.
<emphasis>boundary</emphasis> - physical address <emphasis>boundary</emphasis> - physical address
boundary that must not be crossed when allocating the boundary that must not be crossed when allocating the
memory. Use value 0 for "no boundary". Applies only to memory. Use value 0 for <quote>no boundary</quote>. Applies only to
the future <function>bus_dmamem_alloc()</function> but the future <function>bus_dmamem_alloc()</function> but
not <function>bus_dmamap_create()</function> calls. not <function>bus_dmamap_create()</function> calls.
Must be power of 2. If the memory is planned to be used Must be power of 2. If the memory is planned to be used
@ -1895,7 +1895,7 @@
better to be done in <function>probe()</function>: if this better to be done in <function>probe()</function>: if this
probe would drive some other sensitive device crazy. The probe would drive some other sensitive device crazy. The
probe routines are ordered with consideration of the probe routines are ordered with consideration of the
"sensitive" flag: the sensitive devices get probed first and <literal>sensitive</literal> flag: the sensitive devices get probed first and
the rest of devices later. But the the rest of devices later. But the
<function>identify()</function> routines are called before <function>identify()</function> routines are called before
any probes, so they show no respect to the sensitive devices any probes, so they show no respect to the sensitive devices
@ -1916,8 +1916,8 @@
<para> <para>
Finally allocate and activate a piece of port address space Finally allocate and activate a piece of port address space
(special values of start and end mean "use those we set by (special values of start and end mean <quote>use those we set by
<function>bus_set_resource()</function>"): <function>bus_set_resource()</function></quote>):
</para> </para>
<programlisting> <programlisting>

View file

@ -23,7 +23,7 @@
only pseudo-code. It avoids the details irrelevant to the only pseudo-code. It avoids the details irrelevant to the
subject of the discussion. The real-life examples can be found subject of the discussion. The real-life examples can be found
in the source code of real drivers. In particular the drivers in the source code of real drivers. In particular the drivers
"ep" and "aha" are good sources of information.</para> <literal>ep</literal> and <literal>aha</literal> are good sources of information.</para>
</sect1> </sect1>
<sect1> <sect1>
@ -49,7 +49,7 @@
functions.</para> functions.</para>
<para>The list of bus methods implemented by an ISA driver is like <para>The list of bus methods implemented by an ISA driver is like
one for any other bus. For a hypothetical driver named "xxx" one for any other bus. For a hypothetical driver named <quote>xxx</quote>
they would be:</para> they would be:</para>
<itemizedlist> <itemizedlist>
@ -198,7 +198,7 @@
<listitem><para><function>char <listitem><para><function>char
*device_get_name(dev)</function> Get the driver name, such *device_get_name(dev)</function> Get the driver name, such
as "xxx" for our example.</para></listitem> as <literal>"xxx"</literal> for our example.</para></listitem>
<listitem><para><function>int device_get_unit(dev)</function> <listitem><para><function>int device_get_unit(dev)</function>
Get the unit number (units are numbered from 0 for the Get the unit number (units are numbered from 0 for the
@ -206,7 +206,7 @@
<listitem><para><function>char <listitem><para><function>char
*device_get_nameunit(dev)</function> Get the device name *device_get_nameunit(dev)</function> Get the device name
including the unit number, such as "xxx0", "xxx1" and so including the unit number, such as <quote>xxx0</quote>, <quote>xxx1</quote> and so
on.</para></listitem> on.</para></listitem>
<listitem><para><function>char <listitem><para><function>char
@ -263,10 +263,10 @@
at all and some allow the driver to read the IRQ setting from at all and some allow the driver to read the IRQ setting from
the device configuration ports. If a machine has multiple ISA the device configuration ports. If a machine has multiple ISA
buses the exact bus may be specified in the configuration buses the exact bus may be specified in the configuration
line, like "isa0" or "isa1", otherwise the device would be line, like <literal>isa0</literal> or <literal>isa1</literal>, otherwise the device would be
searched for on all the ISA buses.</para> searched for on all the ISA buses.</para>
<para>"sensitive" is a resource requesting that this device must <para><literal>sensitive</literal> is a resource requesting that this device must
be probed before all non-sensitive devices. It is supported be probed before all non-sensitive devices. It is supported
but does not seem to be used in any current driver.</para> but does not seem to be used in any current driver.</para>
@ -307,7 +307,7 @@
prevent them from being probed as legacy devices.</para> prevent them from being probed as legacy devices.</para>
<para>The probe routines of non-PnP devices marked as <para>The probe routines of non-PnP devices marked as
"sensitive" are called. If probe for a device went <literal>sensitive</literal> are called. If probe for a device went
successfully, the attach routine is called for it.</para> successfully, the attach routine is called for it.</para>
<para>The probe and attach routines of all non-PNP devices are <para>The probe and attach routines of all non-PNP devices are
@ -427,7 +427,7 @@
has two memory regions if would have resources of type has two memory regions if would have resources of type
SYS_RES_MEMORY numbered 0 and 1. The resource type has SYS_RES_MEMORY numbered 0 and 1. The resource type has
nothing to do with the C language type, all the resource nothing to do with the C language type, all the resource
values have the C language type "unsigned long" and must be values have the C language type <literal>unsigned long</literal> and must be
cast as necessary. The resource numbers do not have to be cast as necessary. The resource numbers do not have to be
contiguous although for ISA they normally would be. The contiguous although for ISA they normally would be. The
permitted resource numbers for ISA devices are:</para> permitted resource numbers for ISA devices are:</para>
@ -652,8 +652,8 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>handler</emphasis> - pointer to the handler <para><emphasis>handler</emphasis> - pointer to the handler
function, the type driver_intr_t is defined as "void function, the type driver_intr_t is defined as <function>void
driver_intr_t(void *)"</para> driver_intr_t(void *)</function></para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>arg</emphasis> - the argument passed to the <para><emphasis>arg</emphasis> - the argument passed to the
@ -763,7 +763,7 @@
into a map. Each page of this memory will be checked for into a map. Each page of this memory will be checked for
conformance to the map requirement. If it conforms then it is conformance to the map requirement. If it conforms then it is
left at its original location. If it is not then a fresh left at its original location. If it is not then a fresh
conformant "bounce page" is allocated and used as intermediate conformant <quote>bounce page</quote> is allocated and used as intermediate
storage. When writing the data from the non-conformant storage. When writing the data from the non-conformant
original pages they will be copied to their bounce pages first original pages they will be copied to their bounce pages first
and then transferred from the bounce pages to the device. When and then transferred from the bounce pages to the device. When
@ -792,13 +792,13 @@
<para><emphasis>parent</emphasis> - parent tag, or NULL to <para><emphasis>parent</emphasis> - parent tag, or NULL to
create a top-level tag <emphasis>alignment</emphasis> - create a top-level tag <emphasis>alignment</emphasis> -
required physical alignment of the memory area to be required physical alignment of the memory area to be
allocated for this tag. Use value 1 for "no specific allocated for this tag. Use value 1 for <quote>no specific
alignment". Applies only to the future alignment</quote>. Applies only to the future
<function>bus_dmamem_alloc()</function> but not <function>bus_dmamem_alloc()</function> but not
<function>bus_dmamap_create()</function> calls. <function>bus_dmamap_create()</function> calls.
<emphasis>boundary</emphasis> - physical address <emphasis>boundary</emphasis> - physical address
boundary that must not be crossed when allocating the boundary that must not be crossed when allocating the
memory. Use value 0 for "no boundary". Applies only to memory. Use value 0 for <quote>no boundary</quote>. Applies only to
the future <function>bus_dmamem_alloc()</function> but the future <function>bus_dmamem_alloc()</function> but
not <function>bus_dmamap_create()</function> calls. not <function>bus_dmamap_create()</function> calls.
Must be power of 2. If the memory is planned to be used Must be power of 2. If the memory is planned to be used
@ -1895,7 +1895,7 @@
better to be done in <function>probe()</function>: if this better to be done in <function>probe()</function>: if this
probe would drive some other sensitive device crazy. The probe would drive some other sensitive device crazy. The
probe routines are ordered with consideration of the probe routines are ordered with consideration of the
"sensitive" flag: the sensitive devices get probed first and <literal>sensitive</literal> flag: the sensitive devices get probed first and
the rest of devices later. But the the rest of devices later. But the
<function>identify()</function> routines are called before <function>identify()</function> routines are called before
any probes, so they show no respect to the sensitive devices any probes, so they show no respect to the sensitive devices
@ -1916,8 +1916,8 @@
<para> <para>
Finally allocate and activate a piece of port address space Finally allocate and activate a piece of port address space
(special values of start and end mean "use those we set by (special values of start and end mean <quote>use those we set by
<function>bus_set_resource()</function>"): <function>bus_set_resource()</function></quote>):
</para> </para>
<programlisting> <programlisting>