CVS log for src/share/man/man9/bus_space.9

Up to [cvs.NetBSD.org] / src / share / man / man9

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

Remove Li without effect.

bus_space(9): Update barrier semantics to match reality and sense.

As proposed on tech-kern:
https://mail-index.netbsd.org/tech-kern/2022/07/16/msg028249.html

tl;dr:
- bus_space_barrier is needed only with prefetchable/cacheable.
- BUS_SPACE_BARRIER_READ is like membar_acquire.
- BUS_SPACE_BARRIER_WRITE is like membar_release.
- READ|WRITE is like membar_sync.

Sort errors. Remove superfluous macros.

Replace xref mb(9) by xref membar_ops(3).

Sync with HEAD

Sync with HEAD

Merge "userland" to be consistent with other man pages.

Sync with HEAD

Use Nm instead of Xr to itself. Add missing space. Bump date for previous.

update manpage with reality WRT BUS_SPACE_BARRIER_SYNC and
BUS_SPACE_BARRIER_X_BEFORE_Y flags

Fix typo. Use .An -nosplit.

Use .An for authors.  From PR misc/49516

sync with head

Added missing newline, as proposed by Petri Laakso in PR kern/46721.

Remove trailing whitespace, use Er for errors, break some lines to avoid
unintended markup.

Describe bus_space_tag_create(9) and bus_space_tag_destroy(9) for
implementing bus spaces in MI code.

(This documentation may be several hours ahead of the implementation,
sorry.)

Document bus_space_reserve(9), bus_space_reserve_subregion(9),
bus_space_release(9), bus_space_reservation_map(9),
bus_space_reservation_unmap(9), bus_space_reservation_addr(9),
bus_space_reservation_size(9), bus_space_handle_is_equal(9).

Bump date.

Switch machine/bus.h references to machine/bus_defs.h and
machine/bus_funcs.h references.

Document bus_space_physload(9), bus_space_physunload(9),
bus_space_physload_device(9), and bus_space_physunload_device(9).

file bus_space.9 was added on branch uebayasi-xip on 2010-07-29 04:44:34 +0000

Describe bus_space_is_equal(9).

Change some references to <machine/bus.h> to <sys/bus.h>.  MI drivers
should #include <sys/bus.h>. <sys/bus.h> #includes <machine/bus.h> for
the MD implementation details.

Use .In instead of .Aq Pa for header files.

Sync with HEAD.

Third (and last) commit. See http://mail-index.netbsd.org/source-changes/2009/05/13/msg221222.html

Instead of .Xo + .Fo and .Fc / .Xc, just use .Fn. We don't want to
support a troff with macro argument limit. OK wiz.

Sync with HEAD.

sync with head.

Move to 2 clause license

sync with head.

sync with HEAD

file bus_space.9 was added on branch mjf-devfs2 on 2008-06-02 13:21:41 +0000

Fix the mb(9) xref.

Fix Dd argument.

Add manpage for memory barrier ops. Not enabled in the Makefile yet.

u_intN_t -> uintN_t

Pa Aq -> Aq Pa.

Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.

preceeding -> preceding
Pointed out by Igor Sobrado in PR misc/19636.

New sentence, new line.

Move a comma. Closes PR 18600 by Hiten Pandya.

small typo

Remove a superfluous 'no'. kern/17022 by John Heasley.

Generate <>& symbolically. I'm avoiding .../dist/... directories for now.

Whitespace nits, and a paragraph fix.

New fine-grained BUS_SPACE_SYNC* operations.  Since these are completely
machine dependent, port maintainers need to implement them themselves.

Drop some .Pp, sort sections.

Define the bus_space_mmap() method for mmap'ing bus space into
user programs.

Fix typos, punctuation and whitespace.

`existent', not `existant'

Fix typos reported in misc/13053 by Patrick Welche.
Whitespace nit cleanup while I'm here.

Document the bus_space_peek_N() and bus_space_poke_N() families
of functions, as proposed on tech-kern.

These provide a way to safely access bus space without crashing
the system if nothing responds on the bus.  c.f. `badaddr()'.

Pull up 1.15: terminate an unterminated .Bl
approved by jhawk

Terminate an unterminated .Bl.

Approved by thorpej
Pull up revisions 1.13 and 1.14--
Add some basic bus_space_*stream_N documentation.  ...and note that
functions that take a count should be called with a non-zero count.

As noted by jhawk--'count' is a function argument when I note that that
functions which take a count of bytes have undefined results if the specified
(count) is zero.

Add some basic bus_space_*stream_N documentation.

The datap argument to bus_space_write_{multi,region}_* should be const.

-document the BUS_SPACE_MAP_PREFETCHABLE flag introduced a while ago
-add a missing link: bus_space_vaddr() to get a pointer from a handle;
 needed to make the BUS_SPACE_MAP_LINEAR flag useful

More .Os cleanups.  .Os is defined in the tmac.doc-common file,
so we shouldn't override it with versions in the manpages.  Many more to
come.

Fix formatting errors (bad sentence breaks).

s/count/flags/ in bus_space_barrier() section.

macroize BSD, NetBSD, FreeBSD and misc cleanup

s.SYNOPSIS.DESCRIPTION., fixes PR kern/4898
by NAKAJIMA Yoshihiro <nakayosh@kcn.or.jp>

fix pasto, from Rafal Boni in PR misc/4673

pull up from trunk: add missing .Nm sections

add missing .Nm sections

clean up the copy_region text slightly

Rename busdma -> bus_dma

bus_space_*() function manual page.  Written by me (as plain text),
converted to use the doc macros by Christos, then severely cleaned,
hacked, and improved by me.