Commit Graph

1443 Commits

Author SHA1 Message Date
Warner Losh
daff7d3b12 Bump date to Sept 20, the date of the last content change 2006-01-18 05:48:45 +00:00
Ruslan Ermilov
01be9cf125 Fix a misspelled reference. 2006-01-13 11:24:08 +00:00
John Baldwin
61d963bc57 - Don't list sleep() in the NAME section as we haven't had a sleep()
function in years.
- Change the 'ident' paramters to 'wchan' to match <sys/systm.h>.
- Use 'otherwise' in place of 'else' in one place so that this reads like
  English rather than C.
- Document the new msleep_spin() function.
- Add history notes for msleep() and msleep_spin().
2006-01-03 17:00:38 +00:00
Robert Watson
fdd3cfa0aa Back out VFS_LOCK_GIANT.9:1.4, due to losing a race in change/update
against revision 1.3.  No need to include mount.h twice, once will be
quite enough.

Pointed out by:	simon
2006-01-03 14:00:22 +00:00
Ian Dowse
0a9a8c2efa Add basic documentation for many of the kernel USB functions that
USB device drivers use to talk to USB devices. This is probably
still a bit rough and it does not yet include the functions specific
to HID, ethernet, hubs, host controller drivers, task threads or
debugging.
2005-12-31 03:53:02 +00:00
Pawel Jakub Dawidek
104a3dc0eb Update manual page after last memguard changes.
Glanced at by:	simon
2005-12-30 12:28:19 +00:00
Pawel Jakub Dawidek
7b53693f42 Document CTR6() macro. 2005-12-27 11:12:51 +00:00
Robert Watson
92dc287fdd Add missing mount.h include to VFS_LOCK_GIANT() man page.
Submitted by:	Wojciech A. Koszek <dunstan at freebsd dot czest dot pl>
MFC after:	3 days
2005-12-24 08:25:15 +00:00
Poul-Henning Kamp
49091c48d5 Make sbuf_copyin() return the number of bytes copied on success.
Submitted by:	"Wojciech A. Koszek" <dunstan@freebsd.czest.pl>
2005-12-23 11:49:53 +00:00
Simon L. B. Nielsen
b5c4679c1a VFS_LOCK_GIANT and VFS_UNLOCK_GIANT are actually defined in sys/mount.h,
so also include sys/mount.h in SYNOPSIS.

PR:		docs/90541
Submitted by:	Wojciech A. Koszek dunstan^freebsd.czest.pl
MFC after:	1 week
2005-12-18 08:07:30 +00:00
Ruslan Ermilov
a5b0d9050a [mdoc] add missing space before a punctuation type argument. 2005-12-13 17:07:52 +00:00
Scott Long
71bb1f9b0c 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
2005-12-05 23:25:59 +00:00
John Baldwin
267b051a81 - Use .fn to markup untimeout in two places it was missing.
- Reword a confusing sentence.

PR:		docs/89810
Submitted by:	Marius Nuennerich marius dot nuennerich at gmx dot net
MFC after:	3 days
2005-12-01 19:16:35 +00:00
Joel Dahl
19797b2256 s/5.5/6.0/ in HISTORY section.
Discussed with:	ru
2005-11-24 09:25:10 +00:00
Andre Oppermann
cb752e17a9 Remove references to MEXT_ADD_REF, MEXT_REM_REF and MEXT_IS_REF
which were removed with rev. 1.179 of mbuf.h.

Sponsored by:	TCP/IP Optimization Fundraise 2005
2005-11-18 17:04:49 +00:00
Ruslan Ermilov
72d835d0a0 Unbreak and fix markup. 2005-11-18 14:01:11 +00:00
Ruslan Ermilov
78ad54210f -mdoc sweep. 2005-11-18 10:56:28 +00:00
John Baldwin
2ddd41fbec - Clarify when the softc is allocated. It is allocated when a device is
probed and attached, not on the first call to device_get_softc().
- Add a cross reference to DEVICE_PROBE regarding the caveats of using the
  softc in a driver's probe routine.
- Fix a grammar bogon.

PR:		docs/87176 (1)
Submitted by:	Devon H. O'Dell dodell at offmyserver dot com (1)
MFC after:	3 days
2005-10-13 16:57:53 +00:00
John Baldwin
10ebc7c038 - When bintime was added to this manpage, standalone .Nm changed from
microtime to bintime.  However, one standaline .Nm wasn't changed, and as
  a result, the manpage claimed that bintime was added in both 5.0 and 3.0.
  Fix by listing microtime explicitly.
- Fix a grammar bogon.

PR:		docs/87147 (1)
Submitted by:	Matthew Luckie (1)
MFC after:	3 days
2005-10-13 16:01:28 +00:00
Giorgos Keramidas
d3d902048c Fix a syntax nit (superfluous 'a').
Submitted by:	Anders Hanssen <anders@rethink.no>
2005-10-11 16:05:35 +00:00
John Baldwin
eefd941ba2 Update this manpage:
- Remove references to cpu_critical_*() as they no longer exist.
- Explain that any preemptions that occur during a critical section are
  deferred until the current thread exits the section.
- Remove a bogus example usage of a critical section.
- Note that one can interlock critical sections with spin mutexes in
  certain situations.

MFC after:	3 days
2005-10-05 19:48:21 +00:00
Ruslan Ermilov
bf5a89d1d5 Sort MLINKS. 2005-09-28 07:32:43 +00:00
Max Laier
b6de9e91bd Remove bridge(4) from the tree. if_bridge(4) is a full functional
replacement and has additional features which make it superior.

Discussed on:	-arch
Reviewed by:	thompsa
X-MFC-after:	never (RELENG_6 as transition period)
2005-09-27 18:10:43 +00:00
John Baldwin
4ea211a4f4 - Document atomic_fetchadd(9) and add a MLINK.
- Add arm and ppc to the list of archs not supporting operations on 64-bit
  integers.
- Update the sample code for acquiring a mutex to be more recent and to
  take into account the recent atomic_foo_ptr() changes.

MFC after:	1 week
2005-09-27 17:59:29 +00:00
Robert Watson
6b8a3687a1 Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9).
Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page.

Discussed with:	jeff
MFC after:	3 days
2005-09-21 10:19:57 +00:00
Warner Losh
097fcfeb8f Sprinkle a few stars where they belong. 2005-09-20 02:38:43 +00:00
John Baldwin
a30c1e0a0b Various and sundry improvements:
- Replace 'process' with 'thread' everywhere.
- Update several places to note that that the fact that default mutexes
  may adaptively spin isn't necessarily MD, but is just part of the
  implementation as a whole.
- Clarify the text about MTX_SPIN mutexes only being appropriate for
  INTR_FAST interrupts or other low level scheduler code to make the
  jargon more FreeBSD-ish rather than BSD/OS-ish.
- Also, note that it is possible that interrupts aren't blocked but just
  deferred when a spin lock is held (the whole blocked vs. deferred bit is
  an MD implementation detail).
- Remove statements saying that spin locks must be released in the exact
  opposite order that they were acquired.  This stopped being true several
  years ago when we first added critical sections that stored their state
  in the current thread rather than in struct mtx.
- Note that a mutex must be initialized before it is passed to any other
  mutex function, not just mtx_lock.
- Clarify that mtx_trylock() only operates on MTX_DEF mutexes.
- Simplify the text about possible preemption during a mtx_unlock().
- Use complete English sentences in place of phrases in a few places.
- Clarify that it isn't ever safe to sleep with a mutex held.  The kernel
  tends to panic when you do that.

Requested by:	scottl (7)
MFC after:	3 days
2005-09-13 15:16:50 +00:00
Gleb Smirnoff
d04304d155 Make callout_reset() return a non-zero value if a pending callout
was rescheduled. If there was no pending callout, then return 0.

Reviewed by:	iedowse, cperciva
2005-09-08 14:20:39 +00:00
Scott Long
a79d1e8314 Fix a few small problems and bump the date.
Submitted by: ru
2005-09-01 19:14:41 +00:00
Scott Long
6f3d270147 More clarification on how bus_dmamap_sync works. Fix bogus text concerning
bus_dmamem_alloc.
2005-08-31 16:55:00 +00:00
Scott Long
1cb112ab25 Clarify the description of the bus_dmasync_op_t operation flags. This has
been misleading and even wrong since the import of the page.
2005-08-26 18:19:01 +00:00
Craig Rodrigues
8ddda52485 Update man page to reflect the fact that VOP_LISTEXTATTR
does not return a list of ASCII NUL terminated strings.
Instead, a list of attribute names is returned, where each
list entry consists of one byte for the name length, followed
by the name, without a terminating ASCII NUL.
This in similar to change 1.17 to extattr_get_file.2

Reviewed by:	rwatson, ru
2005-08-19 12:17:47 +00:00
Murray Stokely
abf91c46d8 Fix typo.
PR:		docs/84660
Submitted by:	Dirk Gouders <gouders@et.bocholt.fh-ge.de>
MFC after:	3 days
2005-08-09 13:55:21 +00:00
Brian Somers
fff86fc443 Fix a typo 2005-08-09 11:55:18 +00:00
Brian Somers
893446fe00 Mention how to ensure that a device hasn't already been identified 2005-08-09 11:14:21 +00:00
Brian Somers
b47668b3ec Fix a couple of typos 2005-08-09 10:30:25 +00:00
Brian Somers
e9b0dcda1a Remove a bogus word 2005-08-08 12:16:53 +00:00
Sam Leffler
9c3fd40489 describe m_align 2005-08-08 00:50:25 +00:00
Christian Brueffer
6fc6b69327 Mention that the softc is zeroed after allocation.
Noticed by:	sam
MFC after:	3 days
2005-08-02 13:54:52 +00:00
Giorgos Keramidas
6fb9b618f5 Fix all the spelling mistakes I could find in the man pages for words
that have at least 3 characters.

MFC after:	1 week
Thanks to:	Music band ``Chingon''
		for keeping me company while searching for these.
2005-07-31 03:30:48 +00:00
Scott Long
bf392eb4b9 Don't cross-reference VFS_START.9 2005-07-27 02:08:59 +00:00
Scott Long
e91f1998a1 Now that VFS_START.9 has been removed, don't try to reference it from the
Makefile.
2005-07-27 02:08:21 +00:00
Hiten Pandya
5e5cdff0f6 Remove the VFS_START(9) manual page because it's no longer relevant. The
entry point was removed as its only consumer was MFS.

Approved by:	re (hrs)
2005-07-26 23:57:37 +00:00
Craig Rodrigues
0167ce0d1d Fix two small grammar mistakes.
Approved by:	das (mentor)
2005-07-22 00:28:22 +00:00
Poul-Henning Kamp
636d90fc5c Make the facility for recognizing BIOS-signatures more general
and return a printable representation.

This fixes recognition of the PC Engines WRAP and improves the
recognition of the Soekris boards (Bios version can now be
seen in the dmesg output for instance).

Also, add watchdog support for PCM-582x platforms.

Submitted by:	Adrian Steinmann <ast@marabu.ch>
Slightly changed by:	phk
PR:	81360
2005-07-21 09:48:37 +00:00
Hiten Pandya
571dba6ec9 Use 'manual page' instead of 'man page' for consistency.
Approved by:	re (hrs)
2005-06-28 20:15:19 +00:00
Ruslan Ermilov
05c89c23e9 Overhaul the markup.
OK'ed by:	imp
Approved by:	re (blanket)
2005-06-25 08:59:05 +00:00
Ruslan Ermilov
a4be0b3cc1 (Mostly) markup fixes.
Approved by:	re (blanket)
2005-06-16 18:46:17 +00:00
Ruslan Ermilov
4f06896130 Assorted markup fixes and minor wordsmithing.
Approved by:	re
2005-06-15 13:31:23 +00:00
Hiten Pandya
d3f9f75425 Add a cross-reference to the pmap_page_init(9) manual page.
Approved by:	re
2005-06-15 00:21:02 +00:00
Warner Losh
751c35718a Don a flack jacket and start to document the FreeBSD bus_space
implementation.  I took the NetBSD man page, and hacked it to, I hope,
to reflect the preliminary version of the bus space that Justin Gibbs
committed as part of the CAM integration in FreeBSD 3.0.

This isn't perfect, but it is better than we have now (which is, ahem,
nothing).  Please coordinate changes to the file through me through
the 6.0 release.

Approved by: re (blanket for this one file)
2005-06-14 03:40:01 +00:00
Hiten Pandya
30de9c50b0 Update prototype for function pmap_init(), it no longer has the arguments
phys_start and phys_end.

Remove a stale documentation not about dis/uncontiguous memory.

Update manual page date while I am around these ends.

Reviewed by:	alc
2005-06-10 17:19:27 +00:00
Hiten Pandya
27c3fa33d9 Add manual page for newly added pmap_page_init(9) function, part of the
PMAP KPI.

Reviewed-by:	alc
2005-06-10 17:16:16 +00:00
Brooks Davis
fc74a9f93a Stop embedding struct ifnet at the top of driver softcs. Instead the
struct ifnet or the layer 2 common structure it was embedded in have
been replaced with a struct ifnet pointer to be filled by a call to the
new function, if_alloc(). The layer 2 common structure is also allocated
via if_alloc() based on the interface type. It is hung off the new
struct ifnet member, if_l2com.

This change removes the size of these structures from the kernel ABI and
will allow us to better manage them as interfaces come and go.

Other changes of note:
 - Struct arpcom is no longer referenced in normal interface code.
   Instead the Ethernet address is accessed via the IFP2ENADDR() macro.
   To enforce this ac_enaddr has been renamed to _ac_enaddr.
 - The second argument to ether_ifattach is now always the mac address
   from driver private storage rather than sometimes being ac_enaddr.

Reviewed by:	sobomax, sam
2005-06-10 16:49:24 +00:00
Brooks Davis
55d81cdbc0 Add missing Va in ifi_epoch entry. 2005-06-06 00:21:28 +00:00
Hiten Pandya
e36734401f Accomodate for parameter name change, 'cnp' to 'data'.
Submitted-by: 	Andrew R. Reiter <arr@watson.org>
2005-05-24 12:33:29 +00:00
Nate Lawson
96ab794b26 Document that the returned pointer should be freed even if the number
of items returned is 0.
2005-05-20 05:04:22 +00:00
Gleb Smirnoff
fff7ff711b Document taskqueue_drain(). 2005-05-19 18:31:42 +00:00
David E. O'Brien
6ffd2f532c Clarify the header. 2005-05-17 15:03:50 +00:00
Ruslan Ermilov
580325d4cf Recover the original Berkeley RCS id, and fix the description of
format for source files when it comes to $FreeBSD$.
2005-05-17 14:20:42 +00:00
Giorgos Keramidas
b31dd0b724 Remove a duplicate 'comment' to fix the syntax of a sentence. 2005-05-17 01:25:57 +00:00
Sam Leffler
cf82599dcc update for recent api changes 2005-05-01 02:12:44 +00:00
Gleb Smirnoff
f9e6931c3d Manpage for unit allocator functions.
Reviewed by:	phk
2005-04-20 19:11:05 +00:00
Joseph Koshy
265cd33757 Bring API documentation for sleepqueue(9) in sync with the code
in -current.

Reviewed by:	ru
2005-04-19 16:30:25 +00:00
Joseph Koshy
4c49b002e0 Document taskqueue_run_fast(). Markup 'Giant' with ".Va".
Reviewed by:	ru
2005-04-19 16:23:00 +00:00
Robert Watson
e551d45211 Modify the alq(9) alq_open() API to accept a file creation mode, rather
than defaulting the cmode argument to vn_open() to 0.  Supply a default
argument of ALQ_DEFAULT_CMODE (0600) in current callers.

Discussed with/pointed out by:	hmp
Reveiwed by:	jeff, hmp
MFC after:	3 days
2005-04-16 12:12:27 +00:00
Joseph Koshy
3bbf58f9be Add a 'SEE ALSO' section. 2005-04-15 14:46:59 +00:00
Pawel Jakub Dawidek
ba9bc36af1 Add missing links.
MFC after:	2 weeks
2005-04-15 10:57:34 +00:00
Pawel Jakub Dawidek
c5e1d51bcd Create links to crypto.9 for every crypto(9) function.
OK'ed by:	sam
MFC after:	2 weeks
2005-04-09 18:38:54 +00:00
Nate Lawson
f86f6ce6e4 Hook up new man page for devclass_get_drivers() to build
Reminded by:	ru
2005-04-07 17:27:14 +00:00
Nate Lawson
4abfd70c87 Document that devclass_get_maxunit(9) returns one greater than the current
highest unit.

Reviewed by:	dfr
MFC after:	2 weeks
2005-04-04 15:37:59 +00:00
Nate Lawson
fada20b989 Add devclass_get_drivers(9) which provides an array of pointers to driver
instances in a given devclass.  This is useful for systems that want to
call code in driver static methods, similar to device_identify().

Reviewed by:	dfr
MFC after:	2 weeks
2005-04-04 15:26:51 +00:00
Christian Brueffer
63575b5712 Bump .Dd for the previous commit. 2005-03-28 10:28:57 +00:00
Christian Brueffer
c97dc39f02 The make_dev(9) functions no longer handle dev_ts, but struct cdevs.
PR:		78172
Submitted by:	"Wojciech A. Koszek" <dunstan@freebsd.czest.pl>
MFC after:	3 days
2005-03-28 08:57:07 +00:00
John-Mark Gurney
7ac139a904 add m_copyup function.. This can be used to help make our ip stack less
alignment restrictive, and help performance on some ethernet cards which
currently copy the entire packet a couple bytes to get the packet aligned
properly...

Wordsmithing by:	dwhite
Obtained from:	NetBSD (code only)
I'll clean it up later:	rwatson
2005-03-17 19:34:57 +00:00
Warner Losh
f3011a7c10 Clarify that the end argument meaning for rman_reserve_resource_bound
is the highest acceptable value for the ending of the resource being
allocated.  One could also believe that it is the highest starting
value of the resource.  The code definitely expects the former, but I
could find no documentation of this apart from TFSC.
2005-03-15 23:58:55 +00:00
Poul-Henning Kamp
b1b785b27d Mangle a manpage. 2005-03-14 15:38:34 +00:00
John-Mark Gurney
ada6ba6ef3 spell resource correctly...
MFC after:	3 days
2005-03-09 07:56:09 +00:00
Hiten Pandya
97ad30b96a Remove stale information in IMPLEMENTATION NOTES section about alq_open()
using the calling thread's ucred.

While I am there, fix references to my name.
2005-03-09 01:56:48 +00:00
Hiten Pandya
830d03bc97 Make note of the ktrdump(8) utility in the opening paragraph of this
manual page.

Fix indentation of code block in EXAMPLE section so the manual page
can be viewed in a 80 column window.
2005-03-08 01:37:36 +00:00
Christian Brueffer
eafe5f8307 Correct a macro name.
PR:		78171
Submitted by:	"Wojciech A. Koszek" <dunstan@freebsd.czest.pl>
MFC after:	3 days
2005-02-28 02:02:27 +00:00
Brooks Davis
bc9d299133 Change the definition of struct if_data's member ifi_epoch from wall
clock time to uptime because wall clock time may go backwards.

This is a change in the API which will impact SNMP agents who are using
ifi_epoch to set RFC2233's ifCounterDiscontinuityTime.  None are know to
exist today.  This will not impact applications that are using the
<index, epoch> tuple to verify interface uniqueness except that it
eliminates a race which could lead to a false assumption of uniqueness.

Because this is a behavior change, bump __FreeBSD_version.

Discussed with:	re (jhb, scottl)
MFC after:	3 days
Pointed out by:	pkh (way back at EuroBSDCon)
Pointy hat:	brooks
2005-02-25 19:46:41 +00:00
Gleb Smirnoff
4291a5982a Fix prototype for bpf_mtap2().
MFC after:	3 days
2005-02-25 15:58:05 +00:00
Christian Brueffer
64716bfbf4 Connect memguard(9) to the build. 2005-02-22 17:42:12 +00:00
Christian Brueffer
a3256b8880 Xref memguard(9) 2005-02-22 17:20:20 +00:00
Christian Brueffer
f8cd5f23d4 First cut at a manpage for the MemGuard debugging allocator.
most content from:	bmilekic
mdoc lessons by:	ru
2005-02-22 17:18:27 +00:00
Pawel Jakub Dawidek
6201b4ec28 Copyright year update. 2005-02-16 22:24:15 +00:00
Ruslan Ermilov
6009275136 Don't say that mtx_lock() will "sleep" if another kernel thread is
holding the mutex, say it will "block".  Later in this manual page
we say that sleeping while holding a mutex isn't allowed, and this
can be confusing.

Submitted by:	jhb
2005-02-15 23:52:35 +00:00
Ruslan Ermilov
423ac68026 Expand contractions. 2005-02-15 09:27:00 +00:00
Ruslan Ermilov
36a142c455 Expand contractions. 2005-02-13 23:45:54 +00:00
Ruslan Ermilov
59892d33e5 who's -> whose 2005-02-13 23:23:30 +00:00
Ruslan Ermilov
0227791b40 Expand *n't contractions. 2005-02-13 22:25:33 +00:00
Robert Watson
9e95400e5b Add a bit more caveat text about MUTEX_PROFILING -- try to avoid using it
with other profiling and debugging options, such as INVARIANTS, WITNESS,
kernel profiling, etc.  They all interfere with each other nastily and
will generate fairly useless results.
2005-02-11 15:17:57 +00:00
Ruslan Ermilov
6b806d21d1 Fixed the misplaced $FreeBSD$. 2005-02-09 18:07:17 +00:00
Nate Lawson
5b68bf38ab Update device_find_child(9) to return the first matching child if unit
is set to -1.

Reviewed by:	dfr, imp
2005-02-08 18:00:29 +00:00
Ian Dowse
98c926b20f Add a mechanism for associating a mutex with a callout when the
callout is first initialised, using a new function callout_init_mtx().
The callout system will acquire this mutex before calling the callout
function and release it on return.

In addition, the callout system uses the mutex to avoid most of the
complications and race conditions inherent in asynchronous timer
facilities, so mutex-protected callouts have much simpler semantics.
As long as the mutex is held when invoking callout_stop() or
callout_reset(), then these functions will guarantee that the callout
will be stopped, even if softclock() had already begun to process
the callout.

Existing Giant-locked callouts will automatically pick up the new
race-free semantics. This should close a number of race conditions
in the USB code and probably other areas of the kernel too.

There should be no change in behaviour for "MP-safe" callouts; these
still need to use the techniques mentioned in timeout(9) to avoid
race conditions.
2005-02-07 02:47:33 +00:00
Christian Brueffer
f9d04d3672 Remove Xref to nonexistant cap.3
Ok'ed by:	rwatson
MFC after:	3 days
2005-02-05 14:16:35 +00:00
Christian Brueffer
82e9524e14 Xref mac_lomac.4 instead of lomac.4
MFC after:	3 days
2005-02-05 13:36:33 +00:00
Joseph Koshy
a4230398d3 Note that functions alq_flush() and alq_post() should not be called in
contexts where sleeping is disallowed.

Pointed out by:	ru
2005-02-05 02:39:07 +00:00
Pawel Jakub Dawidek
2c7f46173e Improve EIO error description and mention that it can also occur while
writting.

MFC after:	3 days
2005-02-04 11:18:46 +00:00