[src/trunk]: src/share/man/man9 Clarify that bus_dmamem_alloc boundary can be...

[riastradh <riastradh%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/f08095d33e28
branches:  trunk
changeset: 834621:f08095d33e28
user:      riastradh <riastradh%NetBSD.org@localhost>
date:      Mon Aug 20 14:23:27 2018 +0000

description:
Clarify that bus_dmamem_alloc boundary can be zero for no constraint.

diffstat:

 share/man/man9/bus_dma.9 |  8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

diffs (29 lines):

diff -r 66d1fb294370 -r f08095d33e28 share/man/man9/bus_dma.9
--- a/share/man/man9/bus_dma.9  Mon Aug 20 11:46:44 2018 +0000
+++ b/share/man/man9/bus_dma.9  Mon Aug 20 14:23:27 2018 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: bus_dma.9,v 1.65 2017/11/12 21:14:33 riastradh Exp $
+.\" $NetBSD: bus_dma.9,v 1.66 2018/08/20 14:23:27 riastradh Exp $
 .\"
 .\" Copyright (c) 1996, 1997, 1998, 2001, 2005, 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -533,8 +533,7 @@
 If given valid arguments,
 .Fn bus_dmamap_sync
 always succeeds.
-.\" XXX: This does not work with all the arguments.
-.It Fn bus_dmamem_alloc "tag" "size" "alignment" "boundary" "segs" "..."
+.It Fn bus_dmamem_alloc "tag" "size" "alignment" "boundary" "segs" "nsegs" "rsegs" "flags"
 Allocates memory that is "DMA safe" for the bus corresponding to the
 given tag.
 .Pp
@@ -571,6 +570,9 @@
 (relative to zero).
 This value must be a power of two.
 A boundary value less than the size of the allocation is invalid.
+If no boundary condition needs to be observed, a
+.Fa boundary
+argument of 0 should be used.
 .It Fa segs
 An array of bus_dma_segment_t's, filled in as memory is allocated,
 representing the opaque addresses of the memory chunks.