Initial import from FreeBSD RELENG_4:
[dragonfly.git] / share / man / man4 / man4.i386 / wd.4
1 .\"
2 .\" Copyright (c) 1994 Wilko Bulte
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 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. The name of the author may not be used to endorse or promote products
14 .\"    derived from this software withough specific prior written permission
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/share/man/man4/man4.i386/wd.4,v 1.19.2.3 2001/08/17 13:08:46 ru Exp $
28 .\"
29 .Dd August 31, 1994
30 .Dt WD 4 i386
31 .Os
32 .Sh NAME
33 .Nm wd
34 .Nd generic WD100x/IDE disk controller driver
35 .Sh SYNOPSIS
36 .Cd "device wdc0 at isa? port IO_WD1 irq 14" Op flags Ar flags
37 .Cd device wd0 at wdc0 drive 0
38 .Cd "device wd1 at wdc0 drive 1" Op flags Ar flags
39 .Sh DESCRIPTION
40 This driver provides access to disks connected to controllers that emulate
41 the Western Digital WD100x series.
42 This range of controllers includes WD1003
43 type ST412 controllers, WD1007 ESDI controllers and also the generic IDE
44 controllers found on most motherboards.
45 .Pp
46 Your controller documentation is usually quick to point out any WD100x
47 compatibility.
48 .Pp
49 You can convey a number of hints and instructions to the driver using
50 the
51 .Ar flags
52 parameter.
53 .Pp
54 For each drive there are six bit-fields encoded in a 16 bit integer:
55 .Bl -tag -width 0x0000
56 .It 0x8000
57 Test and use the 32bit transfer capability of the drive.
58 .It 0x4000
59 If drive looks like it's coming out of sleep mode, assume it's
60 confused and reinitialize it.
61 .It 0x2000
62 Probe for and use the bus-mastering DMA capabilities of modern
63 PCI chipsets.
64 .It 0x1000
65 Use LBA addressing instead of the default CHS addressing.
66 .It 0x0f00
67 Force number of heads to ((flags & 0xf00)>>8), recalculate number
68 of cylinders to match.
69 .It 0x00ff
70 Test and use multi-sector transfer mode of this drive, max number of
71 sectors attempted is (flags & 0x00ff).
72 .El
73 .Pp
74 The flags can be specified on the line for the drive as a 16 bit int,
75 or on the controller line as a 32 bit int, where the top 16 bit is
76 relevant to the highest numbered drive.
77 .Sh FILES
78 .Bl -tag -width Pa -compact
79 .It Pa /dev/wd*
80 wd device nodes
81 .It Pa /sys/i386/conf/GENERIC
82 sample generic kernel config file for (a.o.) wd based systems
83 .It Pa /sys/i386/isa/wd.c
84 driver source
85 .El
86 .Sh NOTES
87 This driver will soon be completely replaced by the ata and ad drivers.