summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authormav <mav@FreeBSD.org>2010-03-31 08:15:32 +0000
committermav <mav@FreeBSD.org>2010-03-31 08:15:32 +0000
commit6a1200e3b4b530e863c6e2fc03574dbe5ceee671 (patch)
tree96e668d0299c1e725f555d84470bb88e0e63ff74 /share
parent32bf731233c06df0e325ce0fc5ac2e507d15f328 (diff)
downloadFreeBSD-src-6a1200e3b4b530e863c6e2fc03574dbe5ceee671.zip
FreeBSD-src-6a1200e3b4b530e863c6e2fc03574dbe5ceee671.tar.gz
MFC r204565:
Some style and language improvements. Submitted by: ru
Diffstat (limited to 'share')
-rw-r--r--share/man/man4/ahci.428
-rw-r--r--share/man/man4/siis.428
2 files changed, 32 insertions, 24 deletions
diff --git a/share/man/man4/ahci.4 b/share/man/man4/ahci.4
index b3d2e23..675bab6 100644
--- a/share/man/man4/ahci.4
+++ b/share/man/man4/ahci.4
@@ -48,9 +48,10 @@ module at boot time, place the following line in
ahci_load="YES"
.Ed
.Pp
-The following tunables are settable from the loader:
+The following tunables are settable from the
+.Xr loader 8 :
.Bl -ohang
-.It Va hint.ahci.X.msi
+.It Va hint.ahci. Ns Ar X Ns Va .msi
controls Message Signaled Interrupts (MSI) usage by the specified controller
.Bl -tag -compact
.It 0
@@ -60,15 +61,15 @@ single MSI vector used, if supported (default);
.It 2
multiple MSI vectors used, if supported;
.El
-.It Va hint.ahci.X.ccc
+.It Va hint.ahci. Ns Ar X Ns Va .ccc
controls Command Completion Coalescing (CCC) usage by the specified controller.
Non-zero value enables CCC and defines maximum time (in ms), request can wait
for interrupt, if there are some more requests present on controller queue.
CCC reduces number of context switches on systems with many parallel requests,
but it can decrease disk performance on some workloads due to additional
command latency.
-.It Va hint.ahcich.X.pm_level
-controls SATA interface Power Management for specified channel,
+.It Va hint.ahcich. Ns Ar X Ns Va .pm_level
+controls SATA interface Power Management for the specified channel,
allowing some power to be saved at the cost of additional command
latency.
Possible values:
@@ -92,18 +93,20 @@ Because of artificial entering latency, performance degradation in modes
.Pp
Note that interface Power Management is not compatible with
device presence detection.
-You will have to reset bus manually on device hot-plug.
-.It Va hint.ahcich.X.sata_rev
+A manual bus reset is needed on device hot-plug.
+.It Va hint.ahcich. Ns Ar X Ns Va .sata_rev
setting to nonzero value limits maximum SATA revision (speed).
Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
.El
.Sh DESCRIPTION
-This driver provides the CAM subsystem with native access to the
+This driver provides the
+.Xr CAM 4
+subsystem with native access to the
.Tn SATA
ports of AHCI-compatible controllers.
Each SATA port found is represented to CAM as a separate bus with one
target, or, if HBA supports Port Multipliers, 16 targets.
-Most of the bus-management details are handled by the SATA-specific
+Most of the bus-management details are handled by the SATA-specific
transport of CAM.
Connected ATA disks are handled by the ATA protocol disk peripheral driver
.Xr ada 4 .
@@ -121,7 +124,8 @@ and Message Signaled Interrupts.
.Pp
AHCI hardware is also supported by ataahci driver from
.Xr ata 4
-subsystem. If both drivers are loaded at the same time, this one will be
+subsystem.
+If both drivers are loaded at the same time, this one will be
given precedence as the more functional of the two.
.Sh HARDWARE
The
@@ -134,11 +138,11 @@ it supports AHCI part of legacy-PATA + AHCI-SATA combined controllers,
such as JMicron JMB36x and Marvell 88SX61xx.
.Sh SEE ALSO
.Xr ada 4 ,
+.Xr ata 4 ,
.Xr cd 4 ,
.Xr da 4 ,
.Xr sa 4 ,
-.Xr scsi 4 ,
-.Xr ata 4
+.Xr scsi 4
.Sh HISTORY
The
.Nm
diff --git a/share/man/man4/siis.4 b/share/man/man4/siis.4
index ab67cbc..8f70839 100644
--- a/share/man/man4/siis.4
+++ b/share/man/man4/siis.4
@@ -48,12 +48,13 @@ module at boot time, place the following line in
siis_load="YES"
.Ed
.Pp
-The following tunables are settable from the loader:
+The following tunables are settable from the
+.Xr loader 8 :
.Bl -ohang
-.It Va hint.siis.X.msi
+.It Va hint.siis. Ns Ar X Ns Va .msi
controls Message Signaled Interrupts (MSI) usage by the specified controller.
-.It Va hint.siisch.X.pm_level
-controls SATA interface Power Management for specified channel,
+.It Va hint.siisch. Ns Ar X Ns Va .pm_level
+controls SATA interface Power Management for the specified channel,
allowing some power to be saved at the cost of additional command
latency.
Possible values:
@@ -65,13 +66,15 @@ device is allowed to initiate PM state change, host is passive.
.El
Note that interface Power Management is not compatible with
device presence detection.
-You will have to reset bus manually on device hot-plug.
-.It Va hint.siisch.X.sata_rev
+A manual bus reset is needed on device hot-plug.
+.It Va hint.siisch. Ns Ar X Ns Va .sata_rev
setting to nonzero value limits maximum SATA revision (speed).
Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
.El
.Sh DESCRIPTION
-This driver provides the CAM subsystem native access to the
+This driver provides the
+.Xr CAM 4
+subsystem with native access to the
.Tn SATA
ports of controller.
Each SATA port is represented to CAM as a separate bus with 16 targets.
@@ -90,14 +93,15 @@ Port Multipliers (including FIS-based switching), hardware command queues
(31 command per port), Native Command Queuing, SATA interface Power Management,
device hot-plug and Message Signaled Interrupts.
.Pp
-Same hardware is also supported by atasiliconimage driver from
+Same hardware is also supported by the atasiliconimage driver from
.Xr ata 4
-subsystem. If both drivers are loaded at the same time, this one will be
+subsystem.
+If both drivers are loaded at the same time, this one will be
given precedence as the more functional of the two.
.Sh HARDWARE
The
.Nm
-driver supports following controllers:
+driver supports the following controllers:
.Bl -bullet -compact
.It
SiI3124
@@ -108,11 +112,11 @@ SiI3531
.El
.Sh SEE ALSO
.Xr ada 4 ,
+.Xr ata 4 ,
.Xr cd 4 ,
.Xr da 4 ,
.Xr sa 4 ,
-.Xr scsi 4 ,
-.Xr ata 4
+.Xr scsi 4
.Sh HISTORY
The
.Nm
OpenPOWER on IntegriCloud