xref: /netbsd-src/share/man/man4/ahd.4 (revision 01869ca4d24a86379a68731bf9706a9f0820fe4e)
1.\"	$NetBSD: ahd.4,v 1.6 2017/07/03 21:30:58 wiz Exp $
2.\"
3.\" Copyright (c) 1995, 1996, 1997, 1998, 2000
4.\" 	Justin T. Gibbs.  All rights reserved.
5.\" Copyright (c) 2002
6.\"	Scott Long.  All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of the author may not be used to endorse or promote products
17.\"    derived from this software without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\" $FreeBSD: /repoman/r/ncvs/src/share/man/man4/ahd.4,v 1.5 2004/07/04 14:17:41 simon Exp $
31.\"
32.Dd May 16, 2009
33.Dt AHD 4
34.Os
35.Sh NAME
36.Nm ahd
37.Nd Adaptec PCI/PCI-X Ultra320 SCSI host adapter driver
38.Sh SYNOPSIS
39For one or more PCI/PCI-X cards:
40.\".Bd -ragged -offset indent -compact
41.Cd "ahd* at pci? dev ? function ?"
42.Pp
43To compile in debugging code:
44.Bd -ragged -offset indent -compact
45.Cd options AHD_DEBUG
46.Cd options AHD_DEBUG_OPTS=<bitmask of options>
47.Cd options AHD_REG_PRETTY_PRINT
48.Ed
49.Pp
50.\" To configure one or more controllers to assume the target role:
51.\" .Bd -ragged -offset indent -compact
52.\" .Cd options AHD_TMODE_ENABLE=<bitmask of units>
53.\" .Ed
54.\" .Pp
55.\" For one or more
56.\" .Tn SCSI
57.\" busses:
58.\" .Bd -ragged -offset indent -compact
59.\" .Cd device scbus
60.\" .Ed
61For
62.Tn SCSI
63busses:
64.Cd scsibus* at ahd?
65.Sh DESCRIPTION
66This driver provides access to the
67.Tn SCSI
68bus(ses) connected to Adaptec
69.Tn AIC79xx
70host adapter chips.
71.Pp
72Driver features include support for narrow and wide busses,
73fast, ultra, ultra2, ultra160, and ultra320 synchronous transfers,
74packetized transfers, tagged queueing,
75.\" 512 SCB's, and target mode.
76and 512 SCBs.
77.Pp
78The
79.Dv AHD_DEBUG_OPTS
80option is used to control which diagnostic messages are printed to the
81console when
82.Dv AHD_DEBUG
83is enabled.
84Logically OR the following bits together:
85.Bl -column -offset indent '0x0001' 'Function'
86.It Em Value Ta Em Function
87.It 0x0001 Ta Show miscellaneous information
88.It 0x0002 Ta Show sense data
89.It 0x0004 Ta Show Serial EEPROM contents
90.It 0x0008 Ta Show bus termination settings
91.It 0x0010 Ta Show host memory usage
92.It 0x0020 Ta Show SCSI protocol messages
93.It 0x0040 Ta Show mode pointer of the chip register window
94.It 0x0080 Ta Show selection timeouts
95.It 0x0100 Ta Show FIFO usage messages
96.It 0x0200 Ta Show Queue Full status
97.It 0x0400 Ta Show SCB queue status
98.It 0x0800 Ta Show inbound packet information
99.It 0x1000 Ta Show S/G list information
100.It 0x2000 Ta Enable extra diagnostic code in the firmware
101.El
102.Pp
103The
104.Dv AHD_REG_PRETTY_PRINT
105option compiles in support for human-readable bit definitions for each register
106that is printed by the debugging code.
107However, it also bloats the compiled
108size of the driver by approximately 215KB.
109.\" .Pp
110.\" Individual controllers may be configured to operate in the target role
111.\" through the
112.\" .Dv AHD_TMODE_ENABLE
113.\" configuration option.
114.\" The value assigned to this option should be a bitmap
115.\" of all units where target mode is desired.
116.\" For example, a value of 0x25 would enable target mode on units 0, 2, and 5.
117.\" Note that target mode is only supported for ultra160 speeds and below.
118.\" .Pp
119.\" Per target configuration performed in the
120.\" .Tn SCSI-Select
121.\" menu, accessible at boot,
122.\" is honored by this driver.
123.\" This includes synchronous/asynchronous transfers,
124.\" maximum synchronous negotiation rate, wide transfers, disconnection,
125.\" and the host adapter's
126.\" .Tn SCSI
127.\" ID.
128.Sh HARDWARE
129The
130.Nm
131driver supports the following:
132.Pp
133.Bl -bullet -compact
134.It
135Adaptec
136.Tn AIC7901
137host adapter chip
138.It
139Adaptec
140.Tn AIC7901A
141host adapter chip
142.It
143Adaptec
144.Tn AIC7902
145host adapter chip
146.It
147Adaptec
148.Tn 29320
149host adapter
150.It
151Adaptec
152.Tn 39320
153host adapter
154.It
155Many motherboards with on-board
156.Tn SCSI
157support
158.El
159.Sh SEE ALSO
160.Xr ahc 4 ,
161.Xr cd 4 ,
162.Xr ch 4 ,
163.\" .Xr da 4 ,
164.Xr intro 4 ,
165.\" .Xr sa 4 ,
166.Xr scsi 4 ,
167.Xr sd 4 ,
168.Xr ses 4 ,
169.Xr st 4
170.Sh HISTORY
171The
172.Nm
173driver first appeared in
174.Fx 4.7
175and
176.Nx 2.0 .
177.Sh AUTHORS
178The
179.Nm
180driver, the
181.Tn AIC7xxx
182sequencer-code assembler,
183and the firmware running on the aic79xx chips was written by
184.An Justin T. Gibbs .
185.Nx
186porting is done by Pascal Renauld, Frank van der Linden,
187Jason Thorpe, and Allen Briggs.
188This manual page is based on the
189.Xr ahc 4
190manual page.
191.\" .Sh BUGS
192.\" The current generation of 79xx chips do not support target mode in Ultra320
193.\" mode.
194.\" Target mode in general has not been well tested in this driver.
195