From: Thomas Nikolajsen Date: Mon, 29 Mar 2010 23:24:28 +0000 (+0200) Subject: ahci/sili.4 - Document sysctl nodes & loader tunables X-Git-Tag: v2.7.1~37^2~41 X-Git-Url: http://gitweb.dragonflybsd.org/dragonfly.git/commitdiff_plain/d856dabcbed9b8cd6ee5641ed50a4ea981e8eeb5 ahci/sili.4 - Document sysctl nodes & loader tunables Also sili(4) isn't tested on SiI3531 yet; while in config(8) files: fix white space. --- diff --git a/share/man/man4/ahci.4 b/share/man/man4/ahci.4 index 31df26e..9f9aa60 100644 --- a/share/man/man4/ahci.4 +++ b/share/man/man4/ahci.4 @@ -48,11 +48,6 @@ Although .Nm controllers are actual ATA controllers, the driver emulates SCSI via a translation layer. -.Pp -Setting the lowest bit (0x1) of the driver flags forces -.Nm -to negotiate SATA 1 (1.5 Gb/s) transfer speeds only. -It may be useful where higher speeds are unstable. .Sh LOADER TUNABLES The following hints may be set in .Xr loader.conf 5 @@ -77,7 +72,14 @@ driver is disabled the .Xr nata 4 driver will typically pick up the .Nm -devices, albeit under the "ad" disk name rather than the "da" disk name. +devices, albeit under the +.Pa ad +disk name rather than the +.Pa da +disk name. +.Bd -literal -offset indent +hint.ahci.disabled=1 +.Ed .Pp The .Nm @@ -86,10 +88,15 @@ if necessary, and can also be told to refrain from attempting to send certain higher-level ATA commands to initialize ATA features which some devices might not properly implement. .Bd -literal -offset indent -hint.ahci.disabled=1 hint.ahci.force150=1 hint.ahci.nofeatures=1 .Ed +.Sh SYSCTL VARIABLES +Link power management can be set with the sysctl +.Va hw.ahci%d.%d.link_pwr_mgmt +to 0 for `disabled', 1 for `medium', and 2 for `aggressive'. +Link power state can be read with the sysctl +.Va hw.ahci%d.%d.link_pwr_state . .Sh SEE ALSO .Xr intro 4 , .Xr nata 4 , @@ -117,4 +124,4 @@ It was ported to .Dx by .An Matt Dillon Aq dillon@apollo.backplane.com -who added new features such as port multiplier support. +who added new features such as hot-plug and port multiplier support. diff --git a/share/man/man4/sili.4 b/share/man/man4/sili.4 index a768098..7d064a3 100644 --- a/share/man/man4/sili.4 +++ b/share/man/man4/sili.4 @@ -19,7 +19,7 @@ .Os .Sh NAME .Nm sili -.Nd Silicon Image 3124/3132/3531 SATA controller +.Nd Silicon Image 3124/3132 SATA controller .Sh SYNOPSIS To compile this driver into the kernel, place the following line in your @@ -38,12 +38,55 @@ sili_load="YES" The .Nm driver provides support for SATA controllers using the Silicon Image -3124/3132/3531 SATALink chipsets. +3124/3132 SATALink chipsets. .Pp Although .Nm controllers are actual ATA controllers, the driver emulates SCSI via a translation layer. +.Sh LOADER TUNABLES +The following hints may be set in +.Xr loader.conf 5 +to control the +.Nm +driver's behavior. +Note that the hint need only exist, so removing it requires commenting it out. +.Pp +Usually both the +.Xr nata 4 +and the +.Nm +drivers are loaded. +The +.Xr nata 4 +driver will pick up any ata-like devices which the +.Nm +driver misses. +If the +.Nm +driver is disabled the +.Xr nata 4 +driver will typically pick up the +.Nm +devices, albeit under the +.Pa ad +disk name rather than the +.Pa da +disk name. +.Bd -literal -offset indent +hint.sili.disabled=1 +.Ed +.Pp +The +.Nm +driver can be told to force a lower-speed 1.5Gb link speed +if necessary, and can also be told to refrain from attempting to send +certain higher-level ATA commands to initialize ATA features which +some devices might not properly implement. +.Bd -literal -offset indent +hint.sili.force150=1 +hint.sili.nofeatures=1 +.Ed .Sh SEE ALSO .Xr ahci 4 , .Xr intro 4 , @@ -70,4 +113,5 @@ for It was ported to .Dx by -.An Matt Dillon Aq dillon@apollo.backplane.com . +.An Matt Dillon Aq dillon@apollo.backplane.com +who added new features such as hot-plug and port multiplier support. diff --git a/sys/config/GENERIC b/sys/config/GENERIC index def0d86..e27f63a 100644 --- a/sys/config/GENERIC +++ b/sys/config/GENERIC @@ -86,7 +86,7 @@ device fd1 at fdc0 drive 1 # device ahci -# Sil3124/3132/3531 driver +# SiI3124/3132 driver # device sili @@ -97,7 +97,7 @@ device natadisk # ATA disk drives device natapicd # ATAPI CDROM drives device natapifd # ATAPI floppy drives device natapist # ATAPI tape drives -device natapicam # Emulate ATAPI devices as SCSI +device natapicam # Emulate ATAPI devices as SCSI device nataraid # support for ATA software RAID # controllers device natausb # ATA-over-USB support @@ -124,7 +124,7 @@ device mpt # LSI-Logic MPT/Fusion device ncr # NCR/Symbios Logic device sym # NCR/Symbios Logic (newer chipsets) options SYM_SETUP_LP_PROBE_MAP=0x40 - # Allow ncr to attach legacy NCR devices when + # Allow ncr to attach legacy NCR devices when # both sym and ncr are configured device adv0 at isa? diff --git a/sys/config/LINT b/sys/config/LINT index eb226ab..e53edc1 100644 --- a/sys/config/LINT +++ b/sys/config/LINT @@ -74,7 +74,7 @@ makeoptions CONF_CFLAGS=-fno-builtin #Don't allow use of memcmp, etc. # with changing the parameters. MAXDSIZ is the maximum that the # limit can be set to, and the DFLDSIZ is the default value for # the limit. MAXSSIZ is the maximum that the stack limit can be -# set to. You might want to set the default lower than the max, +# set to. You might want to set the default lower than the max, # and explicitly set the maximum with a shell command for processes # that regularly exceed the limit like INND. # @@ -163,7 +163,7 @@ cpu I686_CPU # aka Pentium Pro(tm) # do that. If this is not done on a multi-core cpu, EXTINT and NMI # get routed to the INTR/NMI pins on *BOTH* cores simultaneously, causing # two INTA ack cycles one of which will almost certainly result in a -# spurious interrupt vector being presented. This is often visible as +# spurious interrupt vector being presented. This is often visible as # an unmaskable IRQ 7 which occurs for every normal interrupt that occurs # on a system. # @@ -295,7 +295,7 @@ options NO_MEMORY_HOLE options MATH_EMULATE #Support for x87 emulation ##################################################################### -# COMPATIBILITY OPTIONS +# COMPATIBILITY OPTIONS # # Implement system calls compatible with 4.3BSD and older versions of @@ -708,7 +708,7 @@ device hfa #FORE PCA-200E ATM PCI # accurate scheduling of the CPU time between kernel network processing # and other activities. The drawback is a moderate (up to 1/pollhz seconds) # potential increase in response times. See polling(4) for further details. -# +# options DEVICE_POLLING # IFPOLL_ENABLE adds hardware queues' based polling @@ -779,7 +779,7 @@ options MD_NSECT=40000 # Allow this many swap-devices. # # In order to manage swap, the system must reserve bitmap space that -# scales with the largest mounted swap device multiplied by NSWAPDEV, +# scales with the largest mounted swap device multiplied by NSWAPDEV, # regardless of whether other swap devices exist or not. So it # is not a good idea to make this value too large. options NSWAPDEV=5 @@ -857,7 +857,7 @@ options HZ=100 # The following options are used for debugging clock behavior only, and # should not be used for production systems. -# +# # CLK_CALIBRATION_LOOP will run the clock calibration loop at startup # until the user presses a key. @@ -1140,7 +1140,7 @@ options VGA_WIDTH90 # support 90 column modes # To include support for VESA video modes options VESA options VESA_DEBUG=2 # enable VESA debug output - + # Splash screen at start up! Screen savers require this too. pseudo-device splash @@ -1282,7 +1282,7 @@ device ips # device ahci -# Sil3124/3132/3531 driver +# SiI3124/3132 driver # device sili @@ -1699,7 +1699,7 @@ device pci # PCI options # -#Enable pci resources left off by a "lazy" BIOS. +#Enable pci resources left off by a "lazy" BIOS. # options COMPAT_OLDPCI #FreeBSD 2.2 and 3.x compatibility shims @@ -1745,8 +1745,8 @@ options AHD_REG_PRETTY_PRINT # 82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II # and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver # replaces the old al, ax, dm, pn and mx drivers. List of brands: -# Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110, -# SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX, +# Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110, +# SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX, # LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204, # KNE110TX. # @@ -1834,7 +1834,7 @@ options AHD_REG_PRETTY_PRINT # # The `vr' device provides support for various fast ethernet adapters # based on the VIA Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' -# chips, including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking +# chips, including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking # Technologies PN102TX, and the AOpen/Acer ALN-320. # # The `vx' device provides support for the 3Com 3C590 and 3C595 @@ -1933,7 +1933,7 @@ device trm # Tekram DC395U/UW/F and DC315U # Allows the ncr to take precedence # 1 (1<<0) -> 810a, 860 # 2 (1<<1) -> 825a, 875, 885, 895 - # 4 (1<<2) -> 895a, 896, 1510d + # 4 (1<<2) -> 895a, 896, 1510d #options SYM_SETUP_SCSI_DIFF #-HVD support for 825a, 875, 885 # disabled:0 (default), enabled:1 #options SYM_SETUP_PCI_PARITY #-PCI parity checking @@ -2124,7 +2124,7 @@ device lm#3 at wbsio? # ifpi - AVM Fritz!Card PCI driver # ifpi2 - AVM Fritz!Card PCI driver Version 2 # ihfc - Cologne Chip HFC ISA/ISA-PnP chipset driver -# ifpnp - AVM Fritz!Card PnP driver +# ifpnp - AVM Fritz!Card PnP driver # itjc - Siemens ISAC / TJNet Tiger300/320 chipset # # i4b active ISDN cards support contains the following hardware drivers: @@ -2135,7 +2135,7 @@ device lm#3 at wbsio? # be uncommented to enable support for a given card ! # # In addition to a hardware driver (and probably an option) the mandatory -# ISDN protocol stack devices and the mandatory support device must be +# ISDN protocol stack devices and the mandatory support device must be # enabled as well as one or more devices from the optional devices section. # #--------------------------------------------------------------------------- @@ -2193,7 +2193,7 @@ options SEDLBAUER #device isic # # Dynalink IS64PH -options DYNALINK +options DYNALINK #device isic # # ELSA QuickStep 1000pro ISA @@ -2446,7 +2446,7 @@ options VM_BCACHE_SIZE_MAX="(100*1024*1024)" # Tune the swap zone KVA reservation, in bytes. The default is typically # 70 MB, giving the system the ability to manage a maximum of 28GB worth -# of swapped out data. +# of swapped out data. # options VM_SWZONE_SIZE_MAX="(50*1024*1024)" @@ -2469,7 +2469,7 @@ options PANIC_REBOOT_WAIT_TIME=16 # Attempt to bypass the buffer cache and put data directly into the # userland buffer for read operation when O_DIRECT flag is set on the # file. Both offset and length of the read operation must be -# multiples of the physical media sector size. +# multiples of the physical media sector size. # options DIRECTIO @@ -2852,7 +2852,7 @@ options ALTQ_DEBUG #for debugging # SCTP options SCTP -options SCTP_DEBUG +options SCTP_DEBUG options SCTP_USE_ADLER32 options SCTP_HIGH_SPEED options SCTP_STAT_LOGGING diff --git a/sys/config/X86_64_GENERIC b/sys/config/X86_64_GENERIC index 8e3748f..17b31df 100644 --- a/sys/config/X86_64_GENERIC +++ b/sys/config/X86_64_GENERIC @@ -68,7 +68,7 @@ device pci # device ahci -# Sil3124/3132/3531 driver +# SiI3124/3132 driver # device sili @@ -79,7 +79,7 @@ device natadisk # ATA disk drives device natapicd # ATAPI CDROM drives device natapifd # ATAPI floppy drives device natapist # ATAPI tape drives -device natapicam # Emulate ATAPI devices as SCSI +device natapicam # Emulate ATAPI devices as SCSI device nataraid # support for ATA software RAID # controllers device natausb # ATA-over-USB support @@ -106,7 +106,7 @@ device mpt # LSI-Logic MPT/Fusion device ncr # NCR/Symbios Logic device sym # NCR/Symbios Logic (newer chipsets) options SYM_SETUP_LP_PROBE_MAP=0x40 - # Allow ncr to attach legacy NCR devices when + # Allow ncr to attach legacy NCR devices when # both sym and ncr are configured device adv0 at isa?