Commit Graph

57 Commits

Author SHA1 Message Date
Warner Losh
e66c6b993e da.4: Don't document softtimeout
kern.cam.da.default_softtimeout currently does nothing. It sets a value
in the CCB that SIMs could look at, only none do. Leave it undocumented
until it actually does something. It was introduced to allow a 'soft
recovery' to be started when things were taking too long in the SIM by
not scheduling new I/O, or other measures the SIM knew would help when
it seemed like things were getting 'backed up'. No SIM in the FreeBSD
tree implements this and scsi_da doesn't use it other than to pass it
down, so best remove it from the documentation until it does something.

Sponsored by:		Netflix
Fixes:			53af9c235f
Reviewed by:		gbe
Differential Review:	https://reviews.freebsd.org/D36518
2022-09-10 13:51:37 -06:00
Felix Johnson
53af9c235f da.4: Add some sysctl descriptions
Add descriptions for the following sysctl's:

- kern.cam.da.default_softtimeout
- kern.cam.da.disable_wp_protection
- kern.cam.da.enable_biospeedup
- kern.cam.da.enable_uma_ccbs
- kern.cam.da.poll_period
- kern.cam.da.send_ordered

While here, fix some mandocs warnings.

PR:		258727
Reported by:	Felix Johnson <felix dot the dot red at gmail dot com>
Reviewed by:	debdrup, pauamma, gbe
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D32278
2022-09-10 09:44:08 +02:00
Warner Losh
4d21bbd1e7 Provide a nda man page. Add cross referneces. Bump dates.
Also, CAM is a storage subsystem, not a SCSI/ATA one these days.

Sponsored by: Netflix
2017-12-21 04:23:00 +00:00
Enji Cooper
fe3a3f3a79 kern.cam.da.X.delete_method: add -width to .Bl macro call
Now the section width is set appropriately per the BIO_DELETE
parameter being described.

Reported by:	make manlint
MFC after:	1 week
Sponsored by:	Dell EMC Isilon
2017-03-02 06:02:17 +00:00
Alexander Motin
0ac03010f6 Make delete method set via kern.cam.da.X.delete_method persistent.
This allows to set delete method via tunable, before device capabilities
are known.  Also allow ZERO method for devices not reporting LBP, if user
explicitly requests it -- it may be useful if storage supports compression
and WRITE SAME, but does not support UNMAP.

MFC after:	2 weeks
2015-10-11 18:26:06 +00:00
Edward Tomasz Napierala
b8c19fd719 It's 2015, and some people are still trying to use fdisk and then
go asking what debug flags to set for GEOM to make it work.  Advice
them to use gpart(8) instead.

Something similar should probably done with disklabel,
but I need to rewrite the disklabel examples first.

Reviewed by:	wblock@
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D3315
2015-09-02 14:08:43 +00:00
Alexander Motin
4f8244bbf7 Document sort_io_queue sysctls/tunables.
MFC after:	1 week
2014-10-22 08:54:10 +00:00
Glen Barber
814b16ba92 Fix some Xr references:
- ada(4): ad(4) - removed, ada(4) would be a self-referencing entry
- cd(4): ad(4) -> ada(4)
- da(4): ad(4) -> ada(4)
- DEVICE_PROBE(9):  ugen(5) -> ugen(4)
- ed(4): dhclinet(8) -> dhclient(8) (typo)
- lmc(4): Netgraph(4) -> netgraph(4)
- security(7): rc.conf(8) -> rc.conf(5)
- sfxge(4): cpuset(8) -> cpuset(1)
- sbp(4): sysctl(1) -> sysctl(8)
- portindex(5): build(1) -> build(7)
- u3g(4): usbconfig(5) -> usbconfig(8)
- usb_quirk(4): usbconfig(5) -> usbconfig(8)

Found with:	textproc/igor
MFC after:	3 days
2012-02-09 04:37:30 +00:00
Alexander Motin
2baf3a137d Add links to cam(4). 2010-03-04 11:09:49 +00:00
Ruslan Ermilov
81ae4b8da9 Markup fixes. 2006-09-18 15:24:20 +00:00
John Baldwin
ab6258cfc4 - Axe the PARTITIONING and IOCTLS section as this has been made obsolete
now that all that stuff has been abstracted out of the disk drivers with
  GEOM.
- Reference bsdlabel(8) rather than disklabel(8).

Ok'd by:	phk, scottl (1)
Submitted by:	Björn König (2)
2005-11-29 16:51:49 +00:00
Ruslan Ermilov
0227791b40 Expand *n't contractions. 2005-02-13 22:25:33 +00:00
Ruslan Ermilov
5203edcdc5 Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00
Ruslan Ermilov
d37ea99837 Removed trailing whitespace. 2004-07-02 19:07:33 +00:00
Ruslan Ermilov
fe08efe680 mdoc(7): Use the new feature of the .In macro. 2003-09-08 19:57:22 +00:00
Kenneth D. Merry
cb32189e23 Move dynamic sysctl(8) variable creation for the cd(4) and da(4) drivers
out of cdregister() and daregister(), which are run from interrupt context.

The sysctl code does blocking mallocs (M_WAITOK), which causes problems
if malloc(9) actually needs to sleep.

The eventual fix for this issue will involve moving the CAM probe process
inside a kernel thread.  For now, though, I have fixed the issue by moving
dynamic sysctl variable creation for these two drivers to a task queue
running in a kernel thread.

The existing task queues (taskqueue_swi and taskqueue_swi_giant) run in
software interrupt handlers, which wouldn't fix the problem at hand.  So I
have created a new task queue, taskqueue_thread, that runs inside a kernel
thread.  (It also runs outside of Giant -- clients must explicitly acquire
and release Giant in their taskqueue functions.)

scsi_cd.c:	Remove sysctl variable creation code from cdregister(), and
		move it to a new function, cdsysctlinit().  Queue
		cdsysctlinit() to the taskqueue_thread taskqueue once we
		have fully registered the cd(4) driver instance.

scsi_da.c:	Remove sysctl variable creation code from daregister(), and
		move it to move it to a new function, dasysctlinit().
		Queue dasysctlinit() to the taskqueue_thread taskqueue once
		we have fully registered the da(4) instance.

taskqueue.h:	Declare the new taskqueue_thread taskqueue, update some
		comments.

subr_taskqueue.c:
		Create the new kernel thread taskqueue.  This taskqueue
		runs outside of Giant, so any functions queued to it would
		need to explicitly acquire/release Giant if they need it.

cd.4:		Update the cd(4) man page to talk about the minimum command
		size sysctl/loader tunable.  Also note that the changer
		variables are available as loader tunables as well.

da.4:		Update the da(4) man page to cover the retry_count,
		default_timeout and minimum_cmd_size sysctl variables/loader
		tunables.  Remove references to /dev/r???, they aren't used
		any longer.

cd.9:		Update the cd(9) man page to describe the CD_Q_10_BYTE_ONLY
		quirk.

taskqueue.9:	Update the taskqueue(9) man page to describe the new thread
		task queue, and the taskqueue_swi_giant queue.

MFC after:	3 days
2003-09-03 04:46:28 +00:00
Ruslan Ermilov
b5e7e99950 Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00
Ruslan Ermilov
8d5d039f80 Uniformly refer to a file system as "file system".
Approved by:	re
2002-12-12 17:26:04 +00:00
Tom Rhodes
0e85d620bc More file system > filesystem 2002-05-16 05:21:58 +00:00
Mike Pritchard
f87717fa8b Ispell sweep of share/man/man4. 2002-01-21 12:09:13 +00:00
Kazutaka YOKOTA
547d4262b2 Update man pages in the section 4 to match the reality in -CURRENT.
- Change lines referring to kernel configuration file:
        device foo0 at isa port xxx irq yyy...
  to
        device foo
  Describe resource "hints" in /boot/device.hints.

- Try to describe resource allocation and probe/attach behavior in the
  newbus framework.
2001-10-13 09:08:37 +00:00
Dima Dorfman
b196d1ce5c Consistently use 'queueing' instead of 'queuing'. Both spellings are
correct, but the former seems to be preferred.  This makes all of the
section-4 manual pages consistent in this respect.
2001-08-25 21:58:58 +00:00
Ruslan Ermilov
3d45e180f4 mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00
Ruslan Ermilov
eb0838029f mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00
Ruslan Ermilov
c2d03ea879 Eliminate mdocNG warnings caused by misplaced or extraneous macro calls. 2001-02-28 17:38:53 +00:00
Ruslan Ermilov
4b66483fd8 mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00
Ruslan Ermilov
b5c508fba3 Use Fx macro wherever possible. 2000-11-14 11:20:58 +00:00
Ruslan Ermilov
888bb0ddd2 Fixed typo: .ar -> .Ar 2000-11-06 15:18:56 +00:00
Jeroen Ruigrok van der Werven
eddc45e797 Update @freebsd.org email addresses to @FreeBSD.org as is the
precedent.
2000-10-26 15:30:44 +00:00
Ollivier Robert
2d311b79cd - link ata.4 to {acd,ad,afd,ast}.4
- add the reference to ad.4 in da.4.

MFC candidate.

Submitted by:	sheldonh, mpp
2000-07-04 16:32:46 +00:00
Ollivier Robert
2ae7523515 Insert a reference to ata.4.
Discussed with:	phk
2000-07-04 10:01:12 +00:00
Ollivier Robert
b388f1b766 Oops, there's no ad.4. 2000-07-04 09:37:06 +00:00
Ollivier Robert
fddc77af6f Replace a reference to wd(4) to ad(4).
Found by:	phk
2000-07-04 09:32:11 +00:00
Alexey Zelkin
547be285ff . insert forgotten by someone "Space Mode on" directive. It caused displaying
of all macros placed after FILES section w/o any space characters.
. slightly correct usage of .An macros.
2000-05-12 09:10:40 +00:00
Alexey Zelkin
2865e1d51a Use .An macro for declare Authors Name in AUTHORS section 2000-05-12 08:32:56 +00:00
Sheldon Hearn
6d249eee27 Remove single-space hard sentence breaks. These degrade the quality
of the typeset output, tend to make diffs harder to read and provide
bad examples for new-comers to mdoc.
2000-03-01 14:50:24 +00:00
Jeroen Ruigrok van der Werven
6b713d5806 First round of config related changes to the manpages.
device blah0 -> device blah for PCI devices and busses.
2000-01-23 15:04:20 +00:00
Peter Wemm
7f3dea244c $Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00
Nik Clayton
6ef8f5893d transparant -> transparent
PR:             docs/8472
Submitted by:   Craig Leres <leres@ee.lbl.gov>
1999-08-12 23:03:34 +00:00
Chris Costello
e861b0f57e Fix a few typos and misspellings, grabbed from PR#8472 1999-08-09 14:31:04 +00:00
Chris Costello
b6df42f810 Remove reference to nonexistant man page `da(9)' 1999-08-09 02:35:55 +00:00
Bruce Evans
39fbb9465e Fixed previous fix (dad -> rda via rad). 1999-06-07 16:36:41 +00:00
Joseph Koshy
b5d512fa68 Correct typos.
PR:		docs/12068
Submitted by:	Steve Coltrin <spcoltri@io.com>
1999-06-07 05:18:24 +00:00
Kenneth D. Merry
acea824638 Devices are hardwired with "unit 0", not "lun 0" as was in these man pages.
Also, update the pass(4) man page to indicate that some CCBs must be
sent through the xpt(4) device and cannot be sent through a pass device.

PR:		8826
1999-05-08 21:28:18 +00:00
Tim Vanderhoek
d732587c28 Fix a bunch typos, one fix of which is from docs/10794 1999-04-30 06:37:16 +00:00
Kenneth D. Merry
c70e20d81a Update the da(4) man page for CAM. The da.4 man page was repository-copied
from the sd.4 man page.

This includes a discussion of write caching and its effects.

Reviewed by:	ken
Submitted by:	gibbs
1998-10-16 03:28:12 +00:00
John Polstra
93abe8fedb Correct the name of a header file that is referenced. 1997-04-01 04:04:09 +00:00
Peter Wemm
e25aeca937 Revert $FreeBSD$ back to $Id$ 1997-02-22 13:26:29 +00:00
John-Mark Gurney
f79219c3ea added man page for /dev/sysmouse. (and activate it)
plus add appropriate xrefs now that we have {cd,sd,st}.9
1997-02-20 15:14:59 +00:00
Jordan K. Hubbard
1130b656e5 Make the long-awaited change from $Id$ to $FreeBSD$
This will make a number of things easier in the future, as well as (finally!)
avoiding the Id-smashing problem which has plagued developers for so long.

Boy, I'm glad we're not using sup anymore.  This update would have been
insane otherwise.
1997-01-14 07:20:47 +00:00