History log of /freebsd-9.3-release/share/man/man9/bus_dma.9
Revision Date Author Comments
(<<< Hide modified files)
(Show modified files >>>)
# 267654 19-Jun-2014 gjb

Copy stable/9 to releng/9.3 as part of the 9.3-RELEASE cycle.

Approved by: re (implicit)
Sponsored by: The FreeBSD Foundation

# 263688 24-Mar-2014 emaste

MFC r263289: Update NetBSD Foundation copyrights to 2-clause BSD

The NetBSD Foundation states "Third parties are encouraged to change the
license on any files which have a 4-clause license contributed to the
NetBSD Foundation to a 2-clause license."

This change removes clauses 3 and 4 from copyright / license blocks that
list The NetBSD Foundation as the only copyright holder.

Sponsored by: The FreeBSD Foundation


# 253584 23-Jul-2013 jimharris

MFC r253434:

Add bus_dmamap_load_bio and bus_dmamap_load_ccb to bus_dma(9).

Approved by: re (marius)


# 241318 07-Oct-2012 jhb

MFC 239906:
Clarify that bus_dma does not stall future load requests once a load is
deferred. The caller is required to enforce that if that is desired.


# 225736 22-Sep-2011 kensmith

Copy head to stable/9 as part of 9.0-RELEASE release cycle.

Approved by: re (implicit)


# 192026 12-May-2009 marius

Correct r190283 (partially reverting it) as on sparc64 BUS_DMA_NOCACHE
actually is only valid for bus_dmamap_load().

MFC after: 3 days


# 190283 22-Mar-2009 rnoland

Correct the documentation to reflect the fact that BUS_DMA_NOCACHE is a
flag to bus_dmamem_alloc() rather than bus_dmamap_load();

Discussed with: kib
MFC after: 3 days


# 185004 16-Nov-2008 marius

- For maximum flexibility, sparc64 supports BUS_DMA_COHERENT also
with bus_dmamap_create() and not only bus_dmamem_alloc() so move
the description of this flag up accordingly in order to document
this fact. While at, it refine this description with an application
example.
- Reword the description of BUS_DMA_NOCACHE as this flag is also
implemented on sparc64.

MFC after: 1 week


# 182962 12-Sep-2008 kib

Remove unneeded comma.

Noted by: kensmith


# 182816 06-Sep-2008 kib

Document BUS_DMA_NOCACHE.

MFC after: 3 days


# 179694 09-Jun-2008 wkoszek

Mark "highaddr" and "lowaddr" appropriately. Change "dma" to "DMA".

Fix spelling mistage found by rodrigc@.

Reviewed by: rodrigc, danger


# 167274 06-Mar-2007 jhb

Some minor tweaks and updates to bus_dma(9) including some additional notes
on the address filter and locking callback.

Reviewed by: ru, scottl


# 165213 14-Dec-2006 mpp

Spelling fixes.


# 162404 18-Sep-2006 ru

Markup fixes.


# 161929 02-Sep-2006 jmg

now that we have bus_get_dma_tag, document it's requirement in
bus_dma_tag_create


# 161782 31-Aug-2006 ru

- Fix some bugs in the descriptions of DMA sync operations.
- Tweak some text so it's less likely to confuse the reader.

OK'ed by: scottl


# 158132 28-Apr-2006 keramida

Typo.


# 158109 28-Apr-2006 scottl

Add a section about locking protocol for busdma.


# 156195 01-Mar-2006 cognet

Note that BUS_DMA_COHERENT currently only affects sparc64 and arm.

Suggested by: scottl


# 156116 28-Feb-2006 jmg

update examples to use the correct terms that was never updated when the
earlier descriptions were gone over...

MFC after: 3 days


# 153380 13-Dec-2005 ru

[mdoc] add missing space before a punctuation type argument.


# 153147 05-Dec-2005 scottl

More review and adjustment for reality that should have happened 3 years
ago. Document the real behavior of bus_dma_tag_create, bus_dmamap_load,
and other functions. Also document their arguments and return values.

MFC After: 3 days


# 152569 18-Nov-2005 ru

-mdoc sweep.


# 149694 01-Sep-2005 scottl

Fix a few small problems and bump the date.

Submitted by: ru


# 149673 31-Aug-2005 scottl

More clarification on how bus_dmamap_sync works. Fix bogus text concerning
bus_dmamem_alloc.


# 149510 26-Aug-2005 scottl

Clarify the description of the bus_dmasync_op_t operation flags. This has
been misleading and even wrong since the import of the page.


# 147398 15-Jun-2005 ru

Assorted markup fixes and minor wordsmithing.

Approved by: re


# 141851 13-Feb-2005 ru

Expand contractions.


# 141849 13-Feb-2005 ru

who's -> whose


# 140429 18-Jan-2005 brueffer

Typo fixes.

MFC after: 3 days


# 140317 15-Jan-2005 scottl

Document bus_dmamap_load_mbuf_sg()


# 139592 02-Jan-2005 krion

Remove trailing spaces.

Reviewed by: brueffer
MFC after: 3 days


# 136763 22-Oct-2004 scottl

Correct and clarify some very incorrect text.


# 134330 26-Aug-2004 imp

Add reference to vslock(9) for locking user address pages into core.

Suggested by: alc


# 134278 24-Aug-2004 imp

Clarify what the lockfunc is used for. When it will be called and
when it won't be called. The old wording was correct, but not
sufficiently specific to understand when and how it would be called.
The new wording describes the current implementation's usage (which
should be updated if other appropriate times are decided upon),
specifically that it is called only when the load operation is
deferred to keep the locking state consistent. When the operation
isn't deferred, the calling routine is assumed to have a coherent
locking world.

Reviewed by: scottl


# 134230 23-Aug-2004 imp

Even in a 80 column, fixed point font, there's plenty of room for all
the arguments to bus_dmamap_load, so don't use '...' but list the
actual args. '...' usually means a variable number of args (cf
printf(3)), but bus_dmamap_load takes a fixed number of arguments.


# 134229 23-Aug-2004 imp

In the SYNOPSIS section, move the bus_dmamem_alloc function prototype
to just before bus_dmamem_free, which is (a) more logical; (b) likely
what was originally intended and (c) matches the order in the NAME and
FUNCTIONS sections.


# 133499 11-Aug-2004 jmg

fix description of the macros for BUS_DMASYNC opertions. It's from the CPU's
point of view... Add a reference to a better description of what the ops
do...

Reviewed by: scottl


# 131549 04-Jul-2004 scottl

Document that boundaries cannot be smaller than the max segment size.


# 131530 03-Jul-2004 ru

Mechanically kill hard sentence breaks and double whitespaces.


# 131463 02-Jul-2004 scottl

Small grammar fix.


# 130843 21-Jun-2004 mpp

Spelling fixes.


# 129231 14-May-2004 hmp

mdoc(7) police:

* remove an extra comma at the end of the .Nm list


# 121377 22-Oct-2003 hmp

Mdoc Janitor:

* Remove hard sentence breaks from last commit to this file.


# 118086 27-Jul-2003 mux

Document the new BUS_DMA_ZERO flag.


# 117192 03-Jul-2003 scottl

Update the rest of the busdma man page for the change in bus_dma_tag_create()


# 117190 03-Jul-2003 scottl

Update the busdma manpage to reflect the recent API change to
bus_dma_tag_create.


# 117085 30-Jun-2003 jmg

move maxsegsz down a bit so that the arg definition order matches the
calling order.


# 116807 25-Jun-2003 mux

Backout part of my previous commit dealing with bus_dmasync_op_t
documentation since people think it was better the way it was before.

Requested by: gibbs (some time ago)


# 116309 13-Jun-2003 mux

- Document the fact that you can specify several DMA operations to
bus_dmamap_sync() by OR'ing them together.
- Don't document what BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE and
BUS_DMASYNC_POSTREAD|BUS_DMASYNC_POSTWRITE is supposed to do when
passed to bus_dmamap_sync(). There are other possible combinations
and the reader just needs to know what the individual flags do and
that he can combine different DMA operations.
- Use .An when listing authors.

Reviewed by: hmp


# 115420 30-May-2003 hmp

Add the bus_dma(9) manual page to our section 9 collection. It
provides comprehensive documentation on FreeBSD's Bus DMA interface.

Approved by: gibbs, re@ (scottl)
Reviewed by: gibbs, scottl, des, sam, jake, tmm