Module Name: src
Committed By: uwe
Date: Wed Oct 9 21:17:16 UTC 2024
Modified Files:
src/share/man/man9: bus_dma.9
Log Message:
bus_dma(9): g/c pleonastic "are as follows"
It's repated to the point of being a vocal tic.
To generate a diff of this commit:
cvs rdiff -u -r1.73 -r1.74 src/share/man/man9/bus_dma.9
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man9/bus_dma.9
diff -u src/share/man/man9/bus_dma.9:1.73 src/share/man/man9/bus_dma.9:1.74
--- src/share/man/man9/bus_dma.9:1.73 Wed Oct 9 21:08:34 2024
+++ src/share/man/man9/bus_dma.9 Wed Oct 9 21:17:16 2024
@@ -1,4 +1,4 @@
-.\" $NetBSD: bus_dma.9,v 1.73 2024/10/09 21:08:34 uwe Exp $
+.\" $NetBSD: bus_dma.9,v 1.74 2024/10/09 21:17:16 uwe Exp $
.\"
.\" Copyright (c) 1996, 1997, 1998, 2001, 2005, 2006 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -256,7 +256,6 @@ member indicates the number of segments
.It Fn bus_dmamap_create "tag" "size" "nsegments" "maxsegsz" "boundary" "flags" "dmamp"
Allocates a DMA handle and initializes it according to the parameters
provided.
-Arguments are as follows:
.Bl -tag -width nsegments -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -285,7 +284,6 @@ If no boundary condition needs to be obs
.Fa boundary
argument of 0 should be used.
.It Fa flags
-Flags are defined as follows:
.Bl -tag -width BUS_DMA_ALLOCNOW -compact
.It Dv BUS_DMA_WAITOK
It is safe to wait (sleep) for resources during this call.
@@ -319,7 +317,6 @@ Behavior is not defined if invalid argum
Returns 0 on success, or an error code to indicate mode of failure.
.It Fn bus_dmamap_destroy "tag" "dmam"
Frees all resources associated with a given DMA handle.
-Arguments are as follows:
.Bl -tag -width dmam -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -341,7 +338,6 @@ always succeeds.
.It Fn bus_dmamap_load "tag" "dmam" "buf" "buflen" "p" "flags"
Loads a DMA handle with mappings for a DMA transfer.
It assumes that all pages involved in a DMA transfer are wired.
-Arguments are as follows:
.Bl -tag -width buflen -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -361,7 +357,6 @@ Otherwise, the buffer is assumed to be i
.Fa p Ap s
address space.
.It Fa flags
-are defined as follows:
.Bl -tag -width "BUS_DMA_STREAMING" -compact
.It Dv BUS_DMA_WAITOK
It is safe to wait (sleep) for resources during this call.
@@ -473,7 +468,6 @@ The
argument is the size of the DMA transfer.
.It Fn bus_dmamap_unload "tag" "dmam"
Deletes the mappings for a given DMA handle.
-Arguments are as follows:
.Bl -tag -width dmam -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -513,7 +507,6 @@ If given valid arguments,
always succeeds.
.It Fn bus_dmamap_sync "tag" "dmam" "offset" "len" "ops"
Performs pre- and post-DMA operation cache and/or buffer synchronization.
-Arguments are as follows:
.Bl -tag -width offset -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -653,7 +646,6 @@ can be used for this purpose.
Allocations will always be rounded to the hardware page size.
Callers may wish to take advantage of this, and cluster allocation of small
data structures.
-Arguments are as follows:
.Bl -tag -width alignment -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -684,7 +676,6 @@ of segments that the allocated memory ma
.It Fa rsegs
Used to return the actual number of segments the memory contains.
.It Fa flags
-Flags are defined as follows:
.Bl -tag -width BUS_DMA_STREAMING -compact
.It Dv BUS_DMA_WAITOK
It is safe to wait (sleep) for resources during this call.
@@ -726,7 +717,6 @@ Frees memory previously allocated by
.Fn bus_dmamem_alloc .
Any mappings
will be invalidated.
-Arguments are as follows:
.Bl -tag -width nsegs -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -749,7 +739,6 @@ always succeeds.
Maps memory allocated with
.Fn bus_dmamem_alloc
into kernel virtual address space.
-Arguments are as follows:
.Bl -tag -width flags -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -766,7 +755,6 @@ The size of the mapping.
.It Fa kvap
Filled in to specify the kernel virtual address where the memory is mapped.
.It Fa flags
-Flags are defined as follows:
.Bl -tag -width BUS_DMA_COHERENT -compact
.It Dv BUS_DMA_WAITOK
It is safe to wait (sleep) for resources during this call.
@@ -838,7 +826,6 @@ Unmaps memory previously mapped with
.Fn bus_dmamem_map ,
freeing the
kernel virtual address space used by the mapping.
-The arguments are as follows:
.Bl -tag -width size -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -861,7 +848,6 @@ Provides support for user
of DMA-safe memory.
This function is to be called by a device driver's (*d_mmap)() entry
point, which is called by the device pager for each page to be mapped.
-The arguments are as follows:
.Bl -tag -width nsegs -compact
.It Fa tag
This is the bus_dma_tag_t passed down from the parent driver via
@@ -880,7 +866,6 @@ The offset of the page in DMA memory whi
.It Fa prot
The protection codes for the mapping.
.It Fa flags
-Flags are defined as follows:
.Bl -tag -width BUS_DMA_COHERENT -compact
.It Dv BUS_DMA_WAITOK
It is safe to wait (sleep) for resources during this call.
@@ -914,7 +899,6 @@ that do not support the full address spa
Not all ports implement this method; on ports where it is unavailable,
.Er EOPNOTSUPP
is returned.
-The arguments are as follows:
.Bl -tag -width max_addr -compact
.It Fa tag
This is the bus_dma_tag_t to subregion.
@@ -925,7 +909,6 @@ The largest address this new tag can add
.It Fa newtag
Pointer filled in with the address of the new bus_dma_tag_t.
.It Fa flags
-Flags are defined as follows:
.Bl -tag -width BUS_DMA_WAITOK -compact
.It Dv BUS_DMA_WAITOK
It is safe to wait (sleep) for resources during this call.
