share/man/man4/nata.4

   1 .\"
   2 .\" Copyright (c) 2003 Søren Schmidt <sos@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer,
  10 .\"    without modification, immediately at the beginning of the file.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/share/man/man4/ata.4,v 1.72 2007/03/10 12:44:22 brueffer Exp $
  29 .\"
  30 .Dd February 22, 2014
  31 .Dt NATA 4
  32 .Os
  33 .Sh NAME
  34 .Nm nata ,
  35 .Nm acd ,
  36 .Nm ad ,
  37 .Nm afd ,
  38 .Nm ast
  39 .Nd generic ATA/ATAPI disk controller driver
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 For ISA based ATA/ATAPI support:
  46 .Cd device isa
  47 .Cd device nata0 at isa? port IO_WD1 irq 14
  48 .Cd device nata1 at isa? port IO_WD2 irq 15
  49 .Pp
  50 For PCI based ATA/ATAPI support:
  51 .Cd device pci
  52 .Cd device nata
  53 .Pp
  54 To support ATA compliant disk drives:
  55 .Cd device natadisk
  56 .Pp
  57 To support ATA software RAIDs:
  58 .Cd device nataraid
  59 .Pp
  60 To support ATAPI CDROM, DVD and CD/DVD burner drives:
  61 .Cd device natapicd
  62 .Pp
  63 To support ATAPI floppy drives:
  64 .Cd device natapifd
  65 .Pp
  66 To support ATAPI tape drives:
  67 .Cd device natapist
  68 .Ed
  69 .Pp
  70 Alternatively, to load the driver as a
  71 module at boot time, place the following line in
  72 .Xr loader.conf 5 :
  73 .Bd -literal -offset indent
  74 nata_load="YES"
  75 natacard_load="YES"
  76 natadisk_load="YES"
  77 nataisa_load="YES"
  78 natapci_load="YES"
  79 natapicd_load="YES"
  80 natapifd_load="YES"
  81 natapist_load="YES"
  82 natausb_load="YES"
  83 .Ed
  84 .Pp
  85 The following tunables are settable from the loader:
  86 .Bl -ohang
  87 .It Va hw.ata.ata_dma
  88 set to 1 for DMA access, 0 for PIO (default is DMA).
  89 .It Va hw.ata.atapi_dma
  90 set to 1 for DMA access, 0 for PIO (default is DMA).
  91 .It Va hw.ata.wc
  92 set to 1 to enable Write Caching, 0 to disable (default is enabled).
  93 .Em WARNING :
  94 can cause data loss on power failures and crashes.
  95 .El
  96 .Sh DESCRIPTION
  97 The
  98 .Nm
  99 driver provides access to ATA (IDE) and SerialATA disk drives,
 100 ATAPI CDROM/DVD drives, ZIP/LS120 ATAPI drives and ATAPI tape drives
 101 connected to controllers according to the ATA/ATAPI standards.
 102 .Pp
 103 The currently supported ATA/SATA controller chips are:
 104 .Pp
 105 .Bl -tag -width "Silicon Image:" -compact
 106 .It Acard:
 107 ATP850P, ATP860A, ATP860R, ATP865A, ATP865R.
 108 .It ALI:
 109 M5229, M5281, M5287, M5288, M5289.
 110 .It AMD:
 111 AMD756, AMD766, AMD768, AMD8111.
 112 .It ATI:
 113 IXP200, IXP300, IXP400.
 114 .It CMD:
 115 CMD646, CMD646U2, CMD648, CMD649.
 116 .It Cypress:
 117 Cypress 82C693.
 118 .It Cyrix:
 119 Cyrix 5530.
 120 .It HighPoint:
 121 HPT302, HPT366, HPT368, HPT370, HPT371, HPT372, HPT372N, HPT374.
 122 .It Intel:
 123 6300ESB, 31244, PIIX, PIIX3, PIIX4, ESB2, ICH, ICH0, ICH2, ICH3, ICH4, ICH5, ICH6, ICH7, ICH8, ICH9.
 124 .It ITE:
 125 IT8211F, IT8212F.
 126 .It JMicron:
 127 JMB360, JMB361, JMB363, JMB365, JMB366, JMB368.
 128 .It Marvell
 129 88SX5040, 88SX5041, 88SX5080, 88SX5081, 88SX6041, 88SX6081, 88SX6101, 88SX6141.
 130 .It National:
 131 SC1100.
 132 .It NetCell:
 133 NC3000, NC5000.
 134 .It nVidia:
 135 nForce, nForce2, nForce2 MCP, nForce3, nForce3 MCP, nForce3 Pro, nForce4.
 136 .It Promise:
 137 PDC20246, PDC20262, PDC20263, PDC20265, PDC20267, PDC20268, PDC20269, PDC20270, PDC20271, PDC20275, PDC20276, PDC20277, PDC20318, PDC20319, PDC20371, PDC20375, PDC20376, PDC20377, PDC20378, PDC20379, PDC20571, PDC20575, PDC20579, PDC20580, PDC20617, PDC20618, PDC20619, PDC20620, PDC20621, PDC20622, PDC40518, PDC40519, PDC40718, PDC40719.
 138 .It ServerWorks:
 139 HT1000, ROSB4, CSB5, CSB6, K2, Frodo4, Frodo8.
 140 .It Silicon Image:
 141 SiI0680, SiI3112, SiI3114, SiI3124, SiI3132, SiI3512.
 142 .It SiS:
 143 SIS180, SIS181, SIS182, SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630, SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962, SIS963, SIS964, SIS965.
 144 .It VIA:
 145 VT6410, VT6420, VT6421, VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686, VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237, VT8237A, VT8251.
 146 .El
 147 .Pp
 148 Unknown ATA chipsets are supported in PIO modes, and if the standard
 149 busmaster DMA registers are present and contain valid setup, DMA is
 150 also enabled, although the max mode is limited to UDMA33, as it is
 151 not known what the chipset can do and how to program it.
 152 .Pp
 153 The
 154 .Nm
 155 driver can change the transfer mode and various other parameters
 156 when the system is up and running.
 157 See
 158 .Xr natacontrol 8 .
 159 .Pp
 160 The
 161 .Nm
 162 driver sets the maximum transfer mode supported by the hardware as default.
 163 However the
 164 .Nm
 165 driver sometimes warns:
 166 .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".
 167 This means that the
 168 .Nm
 169 driver has detected that the required 80 conductor cable is not present
 170 or could not be detected properly, or that one of the devices on the
 171 channel only accepts up to UDMA2/ATA33.
 172 .Pp
 173 Unknown ATAPI devices are initialized to DMA mode if the
 174 .Va hw.ata.atapi_dma
 175 tunable is set to 1 and they support at least UDMA33 transfers.
 176 Otherwise they are set to PIO mode because severe DMA problems are
 177 common even if the device capabilities indicate support.
 178 You can always try to set DMA mode on an ATAPI device using
 179 .Xr natacontrol 8 ,
 180 but be aware that your hardware might
 181 .Em not
 182 support it and can potentially
 183 .Em hang
 184 the entire system causing data loss.
 185 .Sh FILES
 186 .Bl -tag -width ".Pa /sys/config/GENERIC" -compact
 187 .It Pa /dev/ad*
 188 ATA disk device nodes
 189 .It Pa /dev/ar*
 190 ATA RAID device nodes
 191 .It Pa /dev/acd*
 192 ATAPI CD-ROM device nodes
 193 .It Pa /dev/afd*
 194 ATAPI floppy drive device nodes
 195 .It Pa /dev/ast*
 196 ATAPI tape drive device nodes
 197 .It Pa /sys/config/GENERIC
 198 sample generic kernel config file for
 199 .Nm
 200 based systems
 201 .El
 202 .Sh NOTES
 203 Please remember that in order to use UDMA4/ATA66 and above modes you
 204 .Em must
 205 use 80 conductor cables.
 206 Please assure that ribbon cables are no longer than 45cm.
 207 In case of rounded ATA cables, the length depends on the quality of the cables.
 208 SATA cables can be up to 1m long according to the specification.
 209 .Pp
 210 Static device numbering (enabled with the
 211 .Dv ATA_STATIC_ID
 212 kernel option) reserves a number for each possibly connected disk,
 213 even when not present.
 214 This is useful in hotswap scenarios where disks should always show up
 215 as the same numbered device, and not depend on attach order.
 216 .Pp
 217 Native Command Queuing (NCQ) on SATA drives is not yet supported.
 218 .Sh SEE ALSO
 219 .Xr ahci 4 ,
 220 .Xr natapicam 4 ,
 221 .Xr nataraid 4 ,
 222 .Xr sili 4 ,
 223 .Xr burncd 8 ,
 224 .Xr natacontrol 8
 225 .Sh HISTORY
 226 The
 227 .Xr ata 4
 228 driver first appeared in
 229 .Fx 4.0 .
 230 A later version was imported into
 231 .Dx 1.7
 232 as
 233 .Nm .
 234 .Sh AUTHORS
 235 .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org