bus_dma.9: Add a few lines about bus_dmamap_load_ccb().
authorSascha Wildner <saw@online.de>
Sat, 27 Jan 2018 10:14:56 +0000 (11:14 +0100)
committerSascha Wildner <saw@online.de>
Sat, 27 Jan 2018 10:14:56 +0000 (11:14 +0100)
While doing, add a comment to the function.

share/man/man9/Makefile
share/man/man9/bus_dma.9
sys/platform/pc64/x86_64/busdma_machdep.c

index 75a1be2..34986c3 100644 (file)
@@ -262,6 +262,7 @@ MLINKS+=bus_dma.9 busdma.9 \
        bus_dma.9 bus_dmamap_create.9 \
        bus_dma.9 bus_dmamap_destroy.9 \
        bus_dma.9 bus_dmamap_load.9 \
+       bus_dma.9 bus_dmamap_load_ccb.9 \
        bus_dma.9 bus_dmamap_load_mbuf.9 \
        bus_dma.9 bus_dmamap_load_mbuf_defrag.9 \
        bus_dma.9 bus_dmamap_load_mbuf_segment.9 \
index c09003e..d856dee 100644 (file)
@@ -69,7 +69,7 @@
 .\" $FreeBSD: /repoman/r/ncvs/src/share/man/man9/bus_dma.9,v 1.7 2003/07/27 14:05:29 mux Exp $
 .\" $NetBSD: bus_dma.9,v 1.25 2002/10/14 13:43:16 wiz Exp $
 .\"
-.Dd January 11, 2010
+.Dd January 27, 2018
 .Dt BUS_DMA 9
 .Os
 .Sh NAME
@@ -79,6 +79,7 @@
 .Nm bus_dmamap_create ,
 .Nm bus_dmamap_destroy ,
 .Nm bus_dmamap_load ,
+.Nm bus_dmamap_load_ccb ,
 .Nm bus_dmamap_load_mbuf ,
 .Nm bus_dmamap_load_mbuf_segment ,
 .Nm bus_dmamap_load_mbuf_defrag ,
 "bus_size_t buflen" "bus_dmamap_callback_t *callback" "void *callback_arg" \
 "int flags"
 .Ft int
+.Fn bus_dmamap_load_ccb "bus_dma_tag_t dmat" "bus_dmamap_t map" \
+"union ccb *ccb" "bus_dmamap_callback_t *callback" "void *callback_arg" \
+"int flags"
+.Ft int
 .Fn bus_dmamap_load_mbuf "bus_dma_tag_t dmat" "bus_dmamap_t map" \
 "struct mbuf *mbuf" "bus_dmamap_callback2_t *callback" "void *callback_arg" \
 "int flags"
@@ -235,7 +240,9 @@ Client specified callback for receiving mapping information resulting from
 the load of a
 .Vt bus_dmamap_t
 via
-.Fn bus_dmamap_load .
+.Fn bus_dmamap_load
+or
+.Fn bus_dmamap_load_ccb .
 Callbacks are of the format:
 .Bl -tag -width compact
 .It Ft void
@@ -598,6 +605,12 @@ This array is only valid during the scope of the callback function.
 A mapping could not be achieved within the segment constraints provided
 in the tag even though the requested allocation size was less than maxsize.
 .El
+.It Fn bus_dmamap_load_ccb "dmat" "map" "ccb" "callback" "callback_arg" "flags"
+This is a variation of
+.Fn bus_dmamap_load
+which maps data pointed to by
+.Fa ccb
+for DMA transfers.
 .It Fn bus_dmamap_load_mbuf "dmat" "map" "mbuf" "callback2" "callback_arg" \
 "flags"
 This is a variation of
index 2f13143..66a6442 100644 (file)
@@ -846,6 +846,9 @@ bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
        return 0;
 }
 
+/*
+ * Like _bus_dmamap_load(), but for ccb.
+ */
 int
 bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb,
     bus_dmamap_callback_t *callback, void *callback_arg, int flags)