summaryrefslogtreecommitdiffstats
path: root/share/man/man9
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-07-03 18:29:24 +0000
committerru <ru@FreeBSD.org>2004-07-03 18:29:24 +0000
commit1cf159866714352fd8d7789b97068220cbb5a1a4 (patch)
tree5526e5113f4e9589bb734483867453b89a7ca4e6 /share/man/man9
parentbf15efbfc56854d6fb20bb4ff7801d7549fe2bfd (diff)
downloadFreeBSD-src-1cf159866714352fd8d7789b97068220cbb5a1a4.zip
FreeBSD-src-1cf159866714352fd8d7789b97068220cbb5a1a4.tar.gz
Mechanically kill hard sentence breaks and double whitespaces.
Diffstat (limited to 'share/man/man9')
-rw-r--r--share/man/man9/BUS_CONFIG_INTR.92
-rw-r--r--share/man/man9/DEVICE_DETACH.94
-rw-r--r--share/man/man9/DEVICE_IDENTIFY.92
-rw-r--r--share/man/man9/DEVICE_PROBE.95
-rw-r--r--share/man/man9/MD5.95
-rw-r--r--share/man/man9/boot.92
-rw-r--r--share/man/man9/buf.97
-rw-r--r--share/man/man9/bus_dma.914
-rw-r--r--share/man/man9/bus_release_resource.94
-rw-r--r--share/man/man9/device_add_child.94
-rw-r--r--share/man/man9/devstat.913
-rw-r--r--share/man/man9/g_access.92
-rw-r--r--share/man/man9/g_event.92
-rw-r--r--share/man/man9/ithread.92
-rw-r--r--share/man/man9/kobj.92
-rw-r--r--share/man/man9/mac.92
-rw-r--r--share/man/man9/mbpool.984
-rw-r--r--share/man/man9/mbuf.92
-rw-r--r--share/man/man9/mi_switch.92
-rw-r--r--share/man/man9/microseq.96
-rw-r--r--share/man/man9/mutex.94
-rw-r--r--share/man/man9/pci.96
-rw-r--r--share/man/man9/pseudofs.92
-rw-r--r--share/man/man9/random.96
-rw-r--r--share/man/man9/spl.92
-rw-r--r--share/man/man9/style.94
-rw-r--r--share/man/man9/sysctl_add_oid.94
-rw-r--r--share/man/man9/sysctl_ctx_init.94
-rw-r--r--share/man/man9/utopia.977
-rw-r--r--share/man/man9/vref.92
30 files changed, 171 insertions, 106 deletions
diff --git a/share/man/man9/BUS_CONFIG_INTR.9 b/share/man/man9/BUS_CONFIG_INTR.9
index b5b0207..ccd90a0 100644
--- a/share/man/man9/BUS_CONFIG_INTR.9
+++ b/share/man/man9/BUS_CONFIG_INTR.9
@@ -44,7 +44,7 @@ The
.Nm
method allows bus or device drivers to provide interrupt polarity and trigger
mode to parent busses.
-This typically bubbles all the way up to the root bus (e.g. nexus) where the
+This typically bubbles all the way up to the root bus (e.g.\& nexus) where the
necessary actions are taken to actually program the hardware.
Since the
.Nm
diff --git a/share/man/man9/DEVICE_DETACH.9 b/share/man/man9/DEVICE_DETACH.9
index 7ff379a..ae88a28 100644
--- a/share/man/man9/DEVICE_DETACH.9
+++ b/share/man/man9/DEVICE_DETACH.9
@@ -43,11 +43,11 @@
Detach a device.
This can be called if the user is replacing the
driver software or if a device is about to be physically removed from
-the system (e.g. for pccard devices).
+the system (e.g.\& for pccard devices).
.Pp
The method should deallocate any system resources allocated during the
.Xr DEVICE_ATTACH 9
-method and reset the hardware to a sane state (i.e. disable interrupts
+method and reset the hardware to a sane state (i.e., disable interrupts
etc.)
.Sh RETURN VALUES
Zero is returned on success, otherwise an appropriate error is returned.
diff --git a/share/man/man9/DEVICE_IDENTIFY.9 b/share/man/man9/DEVICE_IDENTIFY.9
index 1794c4c..bdea57b 100644
--- a/share/man/man9/DEVICE_IDENTIFY.9
+++ b/share/man/man9/DEVICE_IDENTIFY.9
@@ -41,7 +41,7 @@
.Fn DEVICE_IDENTIFY "driver_t *driver" "device_t parent"
.Sh DESCRIPTION
The identify function for a device is only needed for devices on busses
-that cannot identify their children independently, e.g. the ISA bus.
+that cannot identify their children independently, e.g.\& the ISA bus.
It is used to recognize the device (usually done by accessing non-ambiguous
registers in the hardware) and to tell the kernel about it and thus
creating a new device instance.
diff --git a/share/man/man9/DEVICE_PROBE.9 b/share/man/man9/DEVICE_PROBE.9
index 5c4b00f..e809975 100644
--- a/share/man/man9/DEVICE_PROBE.9
+++ b/share/man/man9/DEVICE_PROBE.9
@@ -74,10 +74,11 @@ returned, the driver can assume that it will be the one attached, but
must not hold any resources when the probe routine returns.
.Sh RETURN VALUES
A value equal to or less than zero indicates success, greater than
-zero indicates an error (errno). For values equal to or less than
+zero indicates an error (errno).
+For values equal to or less than
zero: zero indicates highest priority, no further probing is done;
for a value less than zero, the lower the value the lower the
-priority, e.g. -100 indicates a lower priority than -50.
+priority, e.g.\& -100 indicates a lower priority than -50.
.Sh SEE ALSO
.Xr device 9 ,
.Xr DEVICE_ATTACH 9 ,
diff --git a/share/man/man9/MD5.9 b/share/man/man9/MD5.9
index 4a85e14..d51a9fc 100644
--- a/share/man/man9/MD5.9
+++ b/share/man/man9/MD5.9
@@ -48,8 +48,9 @@
.Sh DESCRIPTION
The
.Nm
-module implements the RSA Data Security, Inc. MD5 Message-Digest Algorithm
-(MD5). It produces 128-bit MD5 Digest of data.
+module implements the RSA Data Security, Inc.\& MD5 Message-Digest Algorithm
+(MD5).
+It produces 128-bit MD5 Digest of data.
.Pp
.Bl -hang -width MD5Transformxxx
.It Pa MD5Init
diff --git a/share/man/man9/boot.9 b/share/man/man9/boot.9
index 4318038..cbd0099 100644
--- a/share/man/man9/boot.9
+++ b/share/man/man9/boot.9
@@ -71,7 +71,7 @@ syncs and unmounts the system disks by calling
.It
Disables interrupts.
.It
-If rebooting after a crash (i.e. if
+If rebooting after a crash (i.e., if
.Dv RB_DUMP
is set in
.Fa howto ,
diff --git a/share/man/man9/buf.9 b/share/man/man9/buf.9
index b809b82..2343e27 100644
--- a/share/man/man9/buf.9
+++ b/share/man/man9/buf.9
@@ -68,7 +68,7 @@ bits.
These bits are generally set and cleared in groups based on the device
block size of the device backing the page.
Complete page's worth are often
-referred to using the VM_PAGE_BITS_ALL bitmask (i.e. 0xFF if the hardware page
+referred to using the VM_PAGE_BITS_ALL bitmask (i.e., 0xFF if the hardware page
size is 4096).
.Pp
VM buffers also keep track of a byte-granular dirty range and valid range.
@@ -111,9 +111,10 @@ This
can create confusion within file system devices that use delayed-writes because
you wind up with pages marked clean that are actually still dirty.
If not
-treated carefully, these pages could be thrown away! Indeed, a number of
+treated carefully, these pages could be thrown away!
+Indeed, a number of
serious bugs related to this hack were not fixed until the 2.2.8/3.0 release.
-The kernel uses an instantiated VM buffer (i.e. struct buf) to place-mark pages
+The kernel uses an instantiated VM buffer (i.e., struct buf) to place-mark pages
in this special state.
The buffer is typically flagged B_DELWRI.
When a
diff --git a/share/man/man9/bus_dma.9 b/share/man/man9/bus_dma.9
index 92fd687..2221368 100644
--- a/share/man/man9/bus_dma.9
+++ b/share/man/man9/bus_dma.9
@@ -176,7 +176,7 @@ field contains the device visible address of the DMA segment, and
contains the length of the DMA segment.
Although the DMA segments returned by a mapping call will adhere to
all restrictions necessary for a successful DMA operation, some conversion
-(e.g. a conversion from host byte order to the device's byte order) is
+(e.g.\& a conversion from host byte order to the device's byte order) is
almost always required when presenting segment information to the device.
.It Vt bus_dmamap_t
A machine-dependent opaque type describing an individual mapping.
@@ -197,7 +197,7 @@ Callbacks are of the format:
The
.Fa callback_arg
is the callback argument passed to dmamap load functions.
-The
+The
.Fa segs
and
.Fa nseg
@@ -216,7 +216,7 @@ the load of a
.Vt bus_dmamap_t
via
.Fn bus_dmamap_load_uio
-or
+or
.Fn bus_dmamap_load_mbuf .
.sp
Callback2s are of the format:
@@ -372,7 +372,7 @@ DMA mapping associated with this tag.
.It Fa nsegments
Number of discontinuities (scatter/gather segments) allowed
in a DMA mapped region.
-If there is no restriction,
+If there is no restriction,
.Dv BUS_SPACE_UNRESTRICTED
may be specified.
.It Fa maxsegsz
@@ -399,7 +399,7 @@ is used.
Optional argument to be passed to the function specified by
.Fa lockfunc .
.It Fa dmat
-Pointer to a bus_dma_tag_t where the resulting DMA tag will
+Pointer to a bus_dma_tag_t where the resulting DMA tag will
be stored.
.El
.Pp
@@ -634,7 +634,7 @@ returned via
.Fa mapp .
Arguments are as follows:
.Bl -tag -width alignment -compact
-.It Fa dmat
+.It Fa dmat
DMA tag describing the constraints of the DMA mapping.
.It Fa vaddr
Pointer to a pointer that will hold the returned KVA mapping of
@@ -646,7 +646,7 @@ Flags are defined as follows:
The routine can safely wait (sleep) for resources.
.It Dv BUS_DMA_NOWAIT
The routine is not allowed to wait for resources.
-If resources are not available,
+If resources are not available,
.Dv ENOMEM
is returned.
.It Dv BUS_DMA_COHERENT
diff --git a/share/man/man9/bus_release_resource.9 b/share/man/man9/bus_release_resource.9
index cf0afa0..e4322af 100644
--- a/share/man/man9/bus_release_resource.9
+++ b/share/man/man9/bus_release_resource.9
@@ -46,7 +46,7 @@
.Sh DESCRIPTION
Free a resource allocated by
.Xr bus_alloc_resource 9 .
-The resource must not be in use on release, i.e. call an appropriate function
+The resource must not be in use on release, i.e., call an appropriate function
before (e.g.\&
.Xr bus_teardown_intr 9
for IRQs).
@@ -72,7 +72,7 @@ value must be the same as the one returned by
.Fa r
is the pointer to
.Va struct res ,
-i.e. the resource itself,
+i.e., the resource itself,
returned by
.Xr bus_alloc_resource 9 .
.El
diff --git a/share/man/man9/device_add_child.9 b/share/man/man9/device_add_child.9
index 68877ad..eedc8cc 100644
--- a/share/man/man9/device_add_child.9
+++ b/share/man/man9/device_add_child.9
@@ -74,14 +74,14 @@ Normally unit numbers will be chosen automatically by the system and a
unit number of
.Dv -1
should be given.
-When a specific unit number is desired (e.g. for wiring a particular
+When a specific unit number is desired (e.g.\& for wiring a particular
piece of hardware to a pre-configured unit number), that unit should
be passed.
If the specified unit number is already allocated, a new
unit will be allocated and a diagnostic message printed.
.Pp
If the devices attached to a bus must be probed in a specific order
-(e.g. for the ISA bus some devices are sensitive to failed probe attempts
+(e.g.\& for the ISA bus some devices are sensitive to failed probe attempts
of unrelated drivers and therefore must be probed first),
the
.Fa order
diff --git a/share/man/man9/devstat.9 b/share/man/man9/devstat.9
index adf6c71..ceaec6e 100644
--- a/share/man/man9/devstat.9
+++ b/share/man/man9/devstat.9
@@ -74,7 +74,8 @@ statistics while utilizing a minimum amount of CPU time to record them.
Thus, no statistical calculations are actually performed in the kernel
portion of the
.Nm
-code. Instead, that is left for user programs to handle.
+code.
+Instead, that is left for user programs to handle.
.Pp
.Fn devstat_add_entry
registers a device with the
@@ -90,7 +91,7 @@ The
.Va devstat
structure, allocated and zeroed by the client.
.It dev_name
-The device name. e.g. da, cd, sa.
+The device name, e.g.\& da, cd, sa.
.It unit_number
Device unit number.
.It block_size
@@ -105,8 +106,8 @@ Flags indicating operations supported or not supported by the device.
See below for details.
.It device_type
The device type.
-This is broken into three sections: base device type
-(e.g. direct access, CDROM, sequential access), interface type (IDE, SCSI
+This is broken into three sections: base device type
+(e.g.\& direct access, CDROM, sequential access), interface type (IDE, SCSI
or other) and a pass-through flag to indicate pas-through devices.
See below for a complete list of types.
.It priority
@@ -269,8 +270,8 @@ These flags are primarily intended to serve as an aid
to userland programs that decipher the statistics.
.It device_type
This is the device type.
-It consists of three parts: the device type
-(e.g. direct access, CDROM, sequential access, etc.), the interface (IDE,
+It consists of three parts: the device type
+(e.g.\& direct access, CDROM, sequential access, etc.), the interface (IDE,
SCSI or other) and whether or not the device in question is a pass-through
driver.
See below for a complete list of device types.
diff --git a/share/man/man9/g_access.9 b/share/man/man9/g_access.9
index 1b4bf61..40d175c 100644
--- a/share/man/man9/g_access.9
+++ b/share/man/man9/g_access.9
@@ -70,7 +70,7 @@ No\-operation is not permitted
=
.Va 0 ) .
.Pp
-The provider's geom must have an access method defined (eg. gp->access).
+The provider's geom must have an access method defined (e.g.\& gp->access).
.Pp
The topology lock has to be held.
.Sh RETURN VALUES
diff --git a/share/man/man9/g_event.9 b/share/man/man9/g_event.9
index f0a512c..5f2b636 100644
--- a/share/man/man9/g_event.9
+++ b/share/man/man9/g_event.9
@@ -45,7 +45,7 @@ The GEOM framework has its own event queue to inform classes about important
events.
The event queue can be also used by GEOM classes themselves, for example
to work around some restrictions in the I/O path, where sleeping, heavy weight
-tasks, etc. are not permitted.
+tasks, etc.\& are not permitted.
.Pp
The
.Fn g_post_event
diff --git a/share/man/man9/ithread.9 b/share/man/man9/ithread.9
index 3388453..2a8c272 100644
--- a/share/man/man9/ithread.9
+++ b/share/man/man9/ithread.9
@@ -350,5 +350,5 @@ Currently
represents both an interrupt source and an interrupt thread.
There should be a separate
.Vt struct isrc
-that contains a vector number, enable and disable functions, etc. that
+that contains a vector number, enable and disable functions, etc.\& that
an ithread holds a reference to.
diff --git a/share/man/man9/kobj.9 b/share/man/man9/kobj.9
index 6c5de34..ee013d1 100644
--- a/share/man/man9/kobj.9
+++ b/share/man/man9/kobj.9
@@ -68,7 +68,7 @@ and is only slightly more expensive than a direct function call,
making kernel objects suitable for performance-critical algorithms.
.Pp
Suitable uses for kernel objects are any algorithms which need some
-kind of polymorphism (i.e. many different objects which can be treated
+kind of polymorphism (i.e., many different objects which can be treated
in a uniform way).
The common behaviour of the objects is described by a suitable
interface and each different type of object is implemented by a
diff --git a/share/man/man9/mac.9 b/share/man/man9/mac.9
index a6b3410..5218fa9 100644
--- a/share/man/man9/mac.9
+++ b/share/man/man9/mac.9
@@ -182,7 +182,7 @@ This man page was written by
This software was contributed to the
.Fx
Project by Network Associates Laboratories, the Security Research
-Division of Network Associates Inc. under DARPA/SPAWAR contract
+Division of Network Associates Inc.\& under DARPA/SPAWAR contract
N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.
diff --git a/share/man/man9/mbpool.9 b/share/man/man9/mbpool.9
index f7c0286..cda3ba8 100644
--- a/share/man/man9/mbpool.9
+++ b/share/man/man9/mbpool.9
@@ -66,30 +66,41 @@ Mbuf pools are intended to help drivers for interface cards that need huge
amounts of receive buffers and additionally provides a mapping between these
buffers and 32-bit handles.
.Pp
-An example of these cards are the Fore/Marconi ForeRunnerHE cards. These
+An example of these cards are the Fore/Marconi ForeRunnerHE cards.
+These
employ up to 8 receive groups, each with two buffer pools, each of which
-can contain up to 8192. This gives a total maximum number of more than
-100000 buffers. Even with a more moderate configuration the card eats several
-thousand buffers. Each of these buffers must be mapped for DMA. While for
+can contain up to 8192.
+This gives a total maximum number of more than
+100000 buffers.
+Even with a more moderate configuration the card eats several
+thousand buffers.
+Each of these buffers must be mapped for DMA.
+While for
machines without an IOMMU and with lesser than 4GByte memory this is not
a problem, for other machines this may quickly eat up all available IOMMU
-address space and/or bounce buffers. On the sparc64 the default IO page size
+address space and/or bounce buffers.
+On the sparc64 the default IO page size
is 16k, so mapping a simple mbuf wastes 31/32 of the address space.
.Pp
Another problem with most of these cards is that they support putting a 32-bit
handle into the buffer descriptor together with the physical address.
This handle is reflected back to the driver when the buffer is filled and
-assists the driver in finding the buffer in host memory. For 32-bit machines
-usually the virtual address of the buffer is used as the handle. This does not
+assists the driver in finding the buffer in host memory.
+For 32-bit machines
+usually the virtual address of the buffer is used as the handle.
+This does not
work for 64-machines for obvious reasons so a mapping is needed between
-these handles and the buffers. This mapping should be possible without
+these handles and the buffers.
+This mapping should be possible without
searching lists and the like.
.Pp
An mbuf pool overcomes both problems by allocating DMA-able memory page wise
-with a per-pool configurable page size. Each page is divided into a number
+with a per-pool configurable page size.
+Each page is divided into a number
equally-sized chunks the last
.Dv MBPOOL_TRAILER_SIZE
-of which are used by the pool code (4 bytes). The rest of each chunk is
+of which are used by the pool code (4 bytes).
+The rest of each chunk is
usable as buffer.
There is a per-pool limit on pages that will be allocated.
.Pp
@@ -99,7 +110,8 @@ A buffer may be in one of three states:
.It free
none of the flags is set.
.It on-card
-both flags are set. The buffer is assumed to be handed over to the card and
+both flags are set.
+The buffer is assumed to be handed over to the card and
waiting to be filled.
.It used
The buffer was returned by the card and is now travelling through the system.
@@ -113,14 +125,16 @@ to be used to create and map the memory pages via
.Fn bus_dmamem_alloc .
The
.Fa chunk_size
-includes the pool overhead. That means to get buffers for 5 ATM cells
-(240 bytes) a chunk size of 256 should be specified. This results in 12 unused
-bytes between the buffer and the pool overhead of four byte. The total
+includes the pool overhead.
+That means to get buffers for 5 ATM cells
+(240 bytes) a chunk size of 256 should be specified.
+This results in 12 unused
+bytes between the buffer and the pool overhead of four byte.
+The total
maximum number of buffers in a pool is
.Fa max_pages *
-(
-.Fa page_size /
-.Fa chunk_size ).
+.Fa ( page_size /
+.Fa chunk_size ) .
The maximum value for
.Fa max_pages
is 2^14-1 (16383) and the maximum of
@@ -134,9 +148,11 @@ is set into the variable pointed to by
.Pp
A pool is destroyed with
.Fn mbp_destroy .
-This frees all pages and the pool structure itself. If compiled with
+This frees all pages and the pool structure itself.
+If compiled with
.Dv DIAGNOSTICS
-the code checks that all buffers are free. If not a warning message is issued
+the code checks that all buffers are free.
+If not a warning message is issued
to the console.
.Pp
A buffer is allocate with
@@ -147,47 +163,57 @@ address into the variable pointed to by
The handle is stored into the variable pointed to by
.Fa hp .
The two most significant bits and the 7 least significant bits of the handle
-are unused by the pool code and may be used by the caller. These are
+are unused by the pool code and may be used by the caller.
+These are
automatically stripped when passing a handle to one of the other functions.
If a buffer cannot be allocated (either because the maximum number of pages
is reached, no memory is available or the memory cannot be mapped) NULL is
-returned. If a buffer could be allocated it is in the on-card state.
+returned.
+If a buffer could be allocated it is in the on-card state.
.Pp
When the buffer is returned by the card the driver calls
.Fn mbp_get
-with the handle. This function returns the virtual address of the buffer
-and clears the on-card bit. The buffer is now in the used state.
+with the handle.
+This function returns the virtual address of the buffer
+and clears the on-card bit.
+The buffer is now in the used state.
The function
.Fn mbp_get_keep
differs from
.Fn mbp_get
-in that it does not clear the on-card bit. This can be used for buffers
+in that it does not clear the on-card bit.
+This can be used for buffers
that are returned
.Sq partially
by the card.
.Pp
A buffer is freed by calling
.Fn mbp_free
-with the virtual address of the buffer. This clears the used bit, and
-puts the buffer on the free list of the pool. Note, that free buffers
+with the virtual address of the buffer.
+This clears the used bit, and
+puts the buffer on the free list of the pool.
+Note, that free buffers
are NOT returned to the system.
The function
.Fn mbp_ext_free can be given to
.Fn m_extadd
-as the free function. The user argument must be the pointer to
+as the free function.
+The user argument must be the pointer to
the pool.
.Pp
Before using the contents of a buffer returned by the card the driver
must call
.Fn mbp_sync
-with the appropriate parameters. This results in a call to
+with the appropriate parameters.
+This results in a call to
.Fn bus_dmamap_sync
for the buffer.
.Pp
All buffers in the pool that are currently in the on-card state can be freed
with a call to
.Fn mbp_card_free .
-This may be called by the driver when it stops the interface. Buffers in
+This may be called by the driver when it stops the interface.
+Buffers in
the used state are not freed by this call.
.Pp
For debugging it is possible to call
diff --git a/share/man/man9/mbuf.9 b/share/man/man9/mbuf.9
index 02c174b..5f564fd 100644
--- a/share/man/man9/mbuf.9
+++ b/share/man/man9/mbuf.9
@@ -449,7 +449,7 @@ This macro operates on an
It is an optimized wrapper for
.Fn m_prepend
that can make use of possible empty space before data
-(e.g. left after trimming of a link-layer header).
+(e.g.\& left after trimming of a link-layer header).
The new
.Vt mbuf chain
pointer or
diff --git a/share/man/man9/mi_switch.9 b/share/man/man9/mi_switch.9
index f6e5d73..bfc2fbe 100644
--- a/share/man/man9/mi_switch.9
+++ b/share/man/man9/mi_switch.9
@@ -75,7 +75,7 @@ voluntarily relinquishes the CPU to wait for some resource to become
available.
.It
after handling a trap
-(e.g. a system call, device interrupt)
+(e.g.\& a system call, device interrupt)
when the kernel prepares a return to user-mode execution.
This case is
typically handled by machine dependent trap-handling code after detection
diff --git a/share/man/man9/microseq.9 b/share/man/man9/microseq.9
index e7748df..c4197d9 100644
--- a/share/man/man9/microseq.9
+++ b/share/man/man9/microseq.9
@@ -59,7 +59,8 @@ Thus, any register described later has the same semantic than its counterpart
in a PC parallel port.
For more info about ISA/ECP programming, get the
Microsoft standard referenced as "Extended Capabilities Port Protocol and
-ISA interface Standard". Registers described later are standard parallel port
+ISA interface Standard".
+Registers described later are standard parallel port
registers.
.Pp
Mask macros are defined in the standard ppbus include files for each valid
@@ -467,7 +468,8 @@ and then execute the microsequence.
.Ss The microsequencer
The microsequencer is executed either at ppbus or adapter level (see
.Xr ppbus 4
-for info about ppbus system layers). Most of the microsequencer is executed
+for info about ppbus system layers).
+Most of the microsequencer is executed
at ppc level to avoid ppbus to adapter function call overhead.
But some
actions like deciding whereas the transfer is IEEE1284-1994 compliant are
diff --git a/share/man/man9/mutex.9 b/share/man/man9/mutex.9
index 2f8ec7d..107458b 100644
--- a/share/man/man9/mutex.9
+++ b/share/man/man9/mutex.9
@@ -192,7 +192,7 @@ on behalf of the currently running kernel thread.
If another kernel thread is holding the mutex,
the caller will be disconnected from the CPU
until the mutex is available
-(i.e. it will sleep).
+(i.e., it will sleep).
.Pp
The
.Fn mtx_lock_spin
@@ -402,7 +402,7 @@ for this reason spin locks will disable all interrupts
Spin locks are fairly specialized locks
that are intended to be held for very short periods of time;
their primary purpose is to protect portions of the code
-that implement default (i.e. sleep) locks.
+that implement default (i.e., sleep) locks.
.Ss Initialization Options
The options passed in the
.Fa opts
diff --git a/share/man/man9/pci.9 b/share/man/man9/pci.9
index 76d35ea..55ed70a 100644
--- a/share/man/man9/pci.9
+++ b/share/man/man9/pci.9
@@ -119,7 +119,8 @@ or
.Dv PCIM_CMD_PORTEN
bit in the
.Dv PCIR_COMMAND
-register appropriately. The
+register appropriately.
+The
.Fn pci_disable_io
function clears the appropriate bit.
The
@@ -202,7 +203,8 @@ of a PCI device, given its
.Fa vendor
and
.Fa device
-IDs. Note that there can be multiple matches for this search; this function
+IDs.
+Note that there can be multiple matches for this search; this function
only returns the first matching device.
.Sh IMPLEMENTATION NOTES
The
diff --git a/share/man/man9/pseudofs.9 b/share/man/man9/pseudofs.9
index 4e5cc8b..6230b14 100644
--- a/share/man/man9/pseudofs.9
+++ b/share/man/man9/pseudofs.9
@@ -44,7 +44,7 @@ and
It takes care of all the hairy bits like interfacing with the VFS
system, enforcing access control, keeping track of file numbers, and
cloning files and directories that are process-specific.
-The consumer module, i.e. the module that implements the actual guts
+The consumer module, i.e., the module that implements the actual guts
of the file system, needs only provide the directory structure
(represented by a collection of structures declared and initialized by
macros provided by
diff --git a/share/man/man9/random.9 b/share/man/man9/random.9
index de41aa5..426774e 100644
--- a/share/man/man9/random.9
+++ b/share/man/man9/random.9
@@ -86,7 +86,8 @@ argument.
The
.Fn read_random
function is used to return entropy directly from the entropy device
-if it has been loaded. If the entropy device is not loaded, then
+if it has been loaded.
+If the entropy device is not loaded, then
the
.Fa buffer
is filled with output generated by
@@ -95,7 +96,8 @@ The
.Fa buffer
is filled with no more than
.Fa count
-bytes. It is advised that
+bytes.
+It is advised that
.Fn read_random
is not used; instead use
.Fn arc4rand
diff --git a/share/man/man9/spl.9 b/share/man/man9/spl.9
index f819af7..fd9e3bc 100644
--- a/share/man/man9/spl.9
+++ b/share/man/man9/spl.9
@@ -191,7 +191,7 @@ Note that the interrupt handler should
.Em never
reduce the priority level.
It is automatically called as it had
-raised the interrupt priority to its own level, i.e. further interrupts
+raised the interrupt priority to its own level, i.e., further interrupts
of the same group are being blocked.
.Sh HISTORY
The interrupt priority levels appeared in a very early version of
diff --git a/share/man/man9/style.9 b/share/man/man9/style.9
index ace7cf2..5038c18 100644
--- a/share/man/man9/style.9
+++ b/share/man/man9/style.9
@@ -354,7 +354,7 @@ typedef const long baz; /* This is baz. */
.Pp
All functions are prototyped somewhere.
.Pp
-Function prototypes for private functions (i.e. functions not used
+Function prototypes for private functions (i.e., functions not used
elsewhere) go at the top of the first source module.
Functions
local to one source module should be declared
@@ -665,7 +665,7 @@ not:
.Pp
Do not use
.Ic \&!
-for tests unless it is a boolean, e.g. use
+for tests unless it is a boolean, e.g.\& use
.Bd -literal
if (*p == '\e0')
.Ed
diff --git a/share/man/man9/sysctl_add_oid.9 b/share/man/man9/sysctl_add_oid.9
index 68d40a1..cb16d26 100644
--- a/share/man/man9/sysctl_add_oid.9
+++ b/share/man/man9/sysctl_add_oid.9
@@ -185,7 +185,7 @@
.Sh DESCRIPTION
These functions and macros provide an interface
for creating and deleting sysctl oids at runtime
-(e.g. during lifetime of a module).
+(e.g.\& during lifetime of a module).
The alternative method,
based on linker sets (see
.In sys/linker_set.h
@@ -223,7 +223,7 @@ macro, where the
.Fa OID_NAME
argument is name of the parent oid of type
.Dv CTLTYPE_NODE
-(i.e. the name displayed by
+(i.e., the name displayed by
.Xr sysctl 8 ,
preceded by underscore, and with all dots replaced with underscores).
.Pp
diff --git a/share/man/man9/sysctl_ctx_init.9 b/share/man/man9/sysctl_ctx_init.9
index 4c7dc73..44d34ae 100644
--- a/share/man/man9/sysctl_ctx_init.9
+++ b/share/man/man9/sysctl_ctx_init.9
@@ -69,7 +69,7 @@ for managing dynamically created oids.
The sysctl context is responsible for keeping track of created oids,
as well as their proper removal when needed.
It adds a simple transactional aspect to oid removal operations;
-i.e. if a removal operation fails part way,
+i.e., if a removal operation fails part way,
it is possible to roll back the sysctl tree
to its previous state.
.Pp
@@ -145,7 +145,7 @@ maintain their original positions in the tree.
The second step actually performs the deletion of the dynamic oids.
.Xr sysctl_remove_oid 9
iterates through the context list,
-starting from beginning (i.e. the newest entries).
+starting from beginning (i.e., the newest entries).
.Em Important :
this time, the function not only deletes the oids from the tree,
but also frees their memory (provided that oid_refcnt == 0),
diff --git a/share/man/man9/utopia.9 b/share/man/man9/utopia.9
index 6ed0663..f35fca6 100644
--- a/share/man/man9/utopia.9
+++ b/share/man/man9/utopia.9
@@ -57,7 +57,7 @@
.Ft int
.Fn utopia_update_carrier "struct utopia *utp"
.Ft int
-.Fn utopia_set_loopback "struct utopia *utp" "u_int mode"
+.Fn utopia_set_loopback "struct utopia *utp" "u_int mode"
.Ft void
.Fn utopia_intr "struct utopia *utp"
.Ft void
@@ -128,8 +128,10 @@ Pointer to the driver's private data (softc).
.It Va media
Pointer to the driver's media structure.
.Ir Va lock
-Pointer to a mutex provided by the driver. This mutex is used to synchronize
-with the kernel thread that handles device polling. It is locked in several
+Pointer to a mutex provided by the driver.
+This mutex is used to synchronize
+with the kernel thread that handles device polling.
+It is locked in several
places:
.Bl -enum -offset indent
.It
@@ -146,7 +148,7 @@ kernel thread the mutex is locked and the
.Fn utopia_carrier_update
function is called with this mutex locked.
This will result in the driver's
-.Fn readregs
+.Fn readregs
function being called with the mutex locked.
.It
In the sysctl handlers the mutex will be locked before calling into the driver's
@@ -156,18 +158,22 @@ or
functions.
.El
.It Va flags
-Flags set by either the driver or the utopia module. The following flags are
+Flags set by either the driver or the utopia module.
+The following flags are
defined:
.Bl -tag -width XXX
.It Dv UTP_FL_NORESET
If this flag is set the module will not try to write the
-SUNI master reset register. (set by the driver)
+SUNI master reset register.
+(set by the driver)
.It Dv UTP_FL_POLL_CARRIER
If this flag is set the module will periodically poll the carrier state
-(as opposed to interrupt driven carrier state changes). (set by the driver)
+(as opposed to interrupt driven carrier state changes).
+(set by the driver)
.El
.It Va state
-Flags describing the current state of the phy chip. These are managed
+Flags describing the current state of the phy chip.
+These are managed
by the module:
.Bl -tag -width XXX
.It Dv UTP_ST_ACTIVE
@@ -189,7 +195,8 @@ Cell scrambling is switched off.
The attach routine has been run successfully.
.El
.It Va carrier
-The carrier state of the interface. This field can have one of three values:
+The carrier state of the interface.
+This field can have one of three values:
.Bl -tag -width XXX
.It Dv UTP_CARR_UNKNOWN
Carrier state is still unknown.
@@ -199,14 +206,18 @@ Carrier has been detected.
Carrier has been lost.
.El
.It Va loopback
-This is the current loopback mode of the interface. Note, that not all
-chips support all loopback modes. Refer to the chip documentation. The
+This is the current loopback mode of the interface.
+Note, that not all
+chips support all loopback modes.
+Refer to the chip documentation.
+The
following modes may be supported:
.Bl -tag -width XXX
.It Dv UTP_LOOP_NONE
No loopback, normal operation.
.It Dv UTP_LOOP_TIME
-Timing source loopback. The transmitter clock is driven by the receive clock.
+Timing source loopback.
+The transmitter clock is driven by the receive clock.
.It Dv UTP_LOOP_DIAG
Diagnostic loopback.
.It Dv UTP_LOOP_LINE
@@ -219,8 +230,14 @@ Twisted pair diagnostic loopback.
Diagnostic path loopback.
.El
.It Va chip
+<<<<<<< utopia.9
+This points the a function vector for chip specific functions.
+Two fields
+in this vector a publically available:
+=======
This points the a function vector for chip specific functions. Two fields
in this vector are publicly available:
+>>>>>>> 1.3
.Bl -tag -width XXX
.It Va type
This is the type of the detected PHY chip.
@@ -241,7 +258,8 @@ The following functions are used by the driver during attach/detach and/or
initialisation/stopping the interface:
.Bl -tag -width XXX
.It Fn utopia_attach
-Attach the PHY chip. This is called with a preallocated
+Attach the PHY chip.
+This is called with a preallocated
.Vt "struct utopia"
(which may be part of the driver's softc).
The module initializes all fields of the utopia state and the media field.
@@ -253,17 +271,22 @@ On success 0 is returned and the
.Dv UTP_ST_ATTACHED
flag is set.
.It Fn utopia_detach
-Remove the utopia attachment from the system. This cancels all outstanding polling
+Remove the utopia attachment from the system.
+This cancels all outstanding polling
timeouts.
.It Fn utopia_start
-Start operation of that PHY. This should be called at a time
-when the PHY registers are known to be accessible. This may be either in
+Start operation of that PHY.
+This should be called at a time
+when the PHY registers are known to be accessible.
+This may be either in
the driver's attach function or when the interface is set running.
.It Fn utopia_stop
-Stop operation of the PHY attachment. This may be called either in the detach
+Stop operation of the PHY attachment.
+This may be called either in the detach
function of the driver or when the interface is brought down.
.It Fn utopia_init_media
-This must be called if the media field in the ATM MIB was changed. The function
+This must be called if the media field in the ATM MIB was changed.
+The function
makes sure, that the ifmedia fields contain the same information as the
ATM MIB.
.It Fn utopia_reset_media
@@ -275,19 +298,23 @@ is running:
.Bl -tag -width XXX
.It Fn utopia_reset
Reset the operational parameters to the default state (SONET, idle cells,
-scrambling enabled). Returns 0 on success, an error code otherwise leaving
+scrambling enabled).
+Returns 0 on success, an error code otherwise leaving
the state undefined.
.It Fn utopia_set_sdh
If the argument is zero the chip is switched to Sonet mode, if it is non-zero
-the chip is switched to SDH mode. Returns 0 on success, an error code otherwise
+the chip is switched to SDH mode.
+Returns 0 on success, an error code otherwise
leaving the previous state.
.It Fn utopia_set_unass
If the argument is zero the chip is switched to produce idle cells, if it is
-non-zero the chip is switched to produce unassigned cells. Returns 0 on success,
+non-zero the chip is switched to produce unassigned cells.
+Returns 0 on success,
an error code otherwise leaving the previous state.
.It Fn utopia_set_noscramb
If the argument is zero enables scrambling, if it is
-non-zero disables scrambling. Returns 0 on success,
+non-zero disables scrambling.
+Returns 0 on success,
an error code otherwise leaving the previous state.
.It Fn utopia_update_carrier
Check the carrier state and update the carrier field in the state structure.
@@ -295,10 +322,12 @@ This will generate a message to the netgraph stack if the carrier state changes.
For chips that are polled this is called automatically, for interrupt
driven attachments this must be called on interrupts from the PHY chip.
.It Fn utopia_set_loopback
-Set the loopback mode of the chip. Returns 0 on success, an error code
+Set the loopback mode of the chip.
+Returns 0 on success, an error code
otherwise leaving the previous state.
.It Fn utopia_intr
-Called when an interrupt from the PHY chip is detected. This resets the
+Called when an interrupt from the PHY chip is detected.
+This resets the
interrupt state by reading all registers and, if the interrupt was from the
RSOP, checks the carrier state.
.It Fn utopia_update_stats
diff --git a/share/man/man9/vref.9 b/share/man/man9/vref.9
index 819fe20..6fffb8b 100644
--- a/share/man/man9/vref.9
+++ b/share/man/man9/vref.9
@@ -53,7 +53,7 @@ are using the vnode.
This allows the system to detect when a vnode is
no longer being used and can be safely recycled for a different file.
.Pp
-Any code in the system which is using a vnode (e.g. during the
+Any code in the system which is using a vnode (e.g.\& during the
operation of some algorithm or to store in a data structure) should
call
.Fn vref .
OpenPOWER on IntegriCloud