7ac0908534fcf8c2904c72aa2ed876239dd8b1f2
[dragonfly.git] / share / man / man4 / ahc.4
1 .\"
2 .\" Copyright (c) 1995, 1996, 1997, 1998, 2000
3 .\"     Justin T. Gibbs.  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 without 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/ahc.4,v 1.38.2.1 2006/06/05 19:30:28 brueffer Exp $
28 .\" $DragonFly: src/share/man/man4/ahc.4,v 1.7 2008/05/02 02:05:05 swildner Exp $
29 .\"
30 .Dd September 26, 2007
31 .Dt AHC 4
32 .Os
33 .Sh NAME
34 .Nm ahc
35 .Nd Adaptec VL/EISA/PCI SCSI host adapter driver
36 .Sh SYNOPSIS
37 To compile this driver into the kernel,
38 place the following lines in your
39 kernel configuration file:
40 .Bd -ragged -offset indent
41 .Cd "device scbus"
42 .Cd "device ahc"
43 .Pp
44 For one or more VL/EISA cards:
45 .Cd "device eisa"
46 .Pp
47 For one or more PCI cards:
48 .Cd "device pci"
49 .Pp
50 To allow PCI adapters to use memory mapped I/O if enabled:
51 .Cd options AHC_ALLOW_MEMIO
52 .Pp
53 To compile in debugging code:
54 .Cd options AHC_DEBUG
55 .Cd options AHC_DEBUG_OPTS=<bitmask of options>
56 .Cd options AHC_REG_PRETTY_PRINT
57 .Pp
58 To configure one or more controllers to assume the target role:
59 .Cd options AHC_TMODE_ENABLE <bitmask of units>
60 .Ed
61 .Pp
62 Alternatively, to load the driver as a
63 module at boot time, place the following lines in
64 .Xr loader.conf 5 :
65 .Bd -literal -offset indent
66 ahc_load="YES"
67 ahc_eisa_load="YES"
68 ahc_isa_load="YES"
69 ahc_pci_load="YES"
70 .Ed
71 .Sh DESCRIPTION
72 This driver provides access to the
73 .Tn SCSI
74 bus(es) connected to the Adaptec AIC77xx and AIC78xx
75 host adapter chips.
76 .Pp
77 Driver features include support for twin and wide busses,
78 fast, ultra or ultra2 synchronous transfers depending on controller type,
79 tagged queueing, SCB paging, and target mode.
80 .Pp
81 Memory mapped I/O can be enabled for PCI devices with the
82 .Dq Dv AHC_ALLOW_MEMIO
83 configuration option.
84 Memory mapped I/O is more efficient than the alternative, programmed I/O.
85 Most PCI BIOSes will map devices so that either technique for communicating
86 with the card is available.
87 In some cases,
88 usually when the PCI device is sitting behind a PCI->PCI bridge,
89 the BIOS may fail to properly initialize the chip for memory mapped I/O.
90 The typical symptom of this problem is a system hang if memory mapped I/O
91 is attempted.
92 Most modern motherboards perform the initialization correctly and work fine
93 with this option enabled.
94 .Pp
95 The
96 .Dv AHC_DEBUG_OPTS
97 option is used to control which diagnostic messages are printed to the
98 console when
99 .Dv AHC_DEBUG
100 is enabled.
101 Logically OR the following bits together:
102 .Bl -column -offset indent ".Em Value" ".Em Function"
103 .It Em Value Ta Em Function
104 .It 0x0001 Ta Show miscellaneous information
105 .It 0x0002 Ta Show sense data
106 .It 0x0004 Ta Show Serial EEPROM contents
107 .It 0x0008 Ta Show bus termination settings
108 .It 0x0010 Ta Show host memory usage
109 .It 0x0020 Ta Show SCSI protocol messages
110 .\".It 0x0040 XXX: AHC_SHOW_DV
111 .It 0x0080 Ta Show selection timeouts
112 .It 0x0200 Ta Show Queue Full status
113 .It 0x0400 Ta Show SCB queue status
114 .It 0x0800 Ta Show inbound packet information
115 .\".It 0x1000 XXX: AHC_SHOW_MASKED_ERRORS
116 .It 0x2000 Ta Enable extra diagnostic code in the firmware
117 .El
118 .Pp
119 The
120 .Dv AHC_REG_PRETTY_PRINT
121 option compiles in support for human-readable bit definitions for each register
122 that is printed by the debugging code.
123 .Pp
124 Individual controllers may be configured to operate in the target role
125 through the
126 .Dq Dv AHC_TMODE_ENABLE
127 configuration option.
128 The value assigned to this option should be a bitmap
129 of all units where target mode is desired.
130 For example, a value of 0x25, would enable target mode on units 0, 2, and 5.
131 A value of 0x8a enables it for units 1, 3, and 7.
132 .Pp
133 Per target configuration performed in the
134 .Tn SCSI-Select
135 menu, accessible at boot
136 in
137 .No non- Ns Tn EISA
138 models,
139 or through an
140 .Tn EISA
141 configuration utility for
142 .Tn EISA
143 models,
144 is honored by this driver.
145 This includes synchronous/asynchronous transfers,
146 maximum synchronous negotiation rate,
147 wide transfers,
148 disconnection,
149 the host adapter's SCSI ID,
150 and,
151 in the case of
152 .Tn EISA
153 Twin Channel controllers,
154 the primary channel selection.
155 For systems that store non-volatile settings in a system specific manner
156 rather than a serial eeprom directly connected to the aic7xxx controller,
157 the
158 .Tn BIOS
159 must be enabled for the driver to access this information.
160 This restriction applies to all
161 .Tn EISA
162 and many motherboard configurations.
163 .Pp
164 Note that I/O addresses are determined automatically by the probe routines,
165 but care should be taken when using a 284x
166 .Pq Tn VESA No local bus controller
167 in an
168 .Tn EISA
169 system.
170 The jumpers setting the I/O area for the 284x should match the
171 .Tn EISA
172 slot into which the card is inserted to prevent conflicts with other
173 .Tn EISA
174 cards.
175 .Pp
176 Performance and feature sets vary throughout the aic7xxx product line.
177 The following table provides a comparison of the different chips supported
178 by the
179 .Nm
180 driver.
181 Note that wide and twin channel features, although always supported
182 by a particular chip, may be disabled in a particular motherboard or card
183 design.
184 .Bd -ragged -compact
185 .Bl -column "aic7770 " "MIPS " "EISA/VL " "MaxSync " "MaxWidth " "SCBs " "1 2 3 4 5 6 7 8 "
186 .It Em Chip Ta Em MIPS Ta Em Bus Ta Em MaxSync Ta Em MaxWidth Ta Em SCBs Ta Em Features
187 .It aic7770 Ta 10 Ta EISA/VL Ta 10MHz Ta 16Bit Ta 4 Ta 1
188 .It aic7850 Ta 10 Ta PCI/32 Ta 10MHz Ta 8Bit Ta 3
189 .It aic7860 Ta 10 Ta PCI/32 Ta 20MHz Ta 8Bit Ta 3
190 .It aic7870 Ta 10 Ta PCI/32 Ta 10MHz Ta 16Bit Ta 16
191 .It aic7880 Ta 10 Ta PCI/32 Ta 20MHz Ta 16Bit Ta 16
192 .It aic7890 Ta 20 Ta PCI/32 Ta 40MHz Ta 16Bit Ta 16 Ta "    3 4 5 6 7 8"
193 .It aic7891 Ta 20 Ta PCI/64 Ta 40MHz Ta 16Bit Ta 16 Ta "    3 4 5 6 7 8"
194 .It aic7892 Ta 20 Ta PCI/64 Ta 80MHz Ta 16Bit Ta 16 Ta "    3 4 5 6 7 8"
195 .It aic7895 Ta 15 Ta PCI/32 Ta 20MHz Ta 16Bit Ta 16 Ta "  2 3 4 5"
196 .It aic7895C Ta 15 Ta PCI/32 Ta 20MHz Ta 16Bit Ta 16 Ta "  2 3 4 5     8"
197 .It aic7896 Ta 20 Ta PCI/32 Ta 40MHz Ta 16Bit Ta 16 Ta "  2 3 4 5 6 7 8"
198 .It aic7897 Ta 20 Ta PCI/64 Ta 40MHz Ta 16Bit Ta 16 Ta "  2 3 4 5 6 7 8"
199 .It aic7899 Ta 20 Ta PCI/64 Ta 80MHz Ta 16Bit Ta 16 Ta "  2 3 4 5 6 7 8"
200 .El
201 .Pp
202 .Bl -enum -compact
203 .It
204 Multiplexed Twin Channel Device - One controller servicing two busses.
205 .It
206 Multi-function Twin Channel Device - Two controllers on one chip.
207 .It
208 Command Channel Secondary DMA Engine - Allows scatter gather list and
209 SCB prefetch.
210 .It
211 64 Byte SCB Support - SCSI CDB is embedded in the SCB to eliminate an extra DMA.
212 .It
213 Block Move Instruction Support - Doubles the speed of certain sequencer
214 operations.
215 .It
216 .Sq Bayonet
217 style Scatter Gather Engine - Improves S/G prefetch performance.
218 .It
219 Queuing Registers - Allows queueing of new transactions without pausing the
220 sequencer.
221 .It
222 Multiple Target IDs - Allows the controller to respond to selection as a
223 target on multiple SCSI IDs.
224 .El
225 .Ed
226 .Sh HARDWARE
227 The
228 .Nm
229 driver supports the following
230 .Tn SCSI
231 host adapter chips and
232 .Tn SCSI
233 controller cards:
234 .Pp
235 .Bl -bullet -compact
236 .It
237 Adaptec
238 .Tn AIC7770
239 host adapter chip
240 .It
241 Adaptec
242 .Tn AIC7850
243 host adapter chip
244 .It
245 Adaptec
246 .Tn AIC7860
247 host adapter chip
248 .It
249 Adaptec
250 .Tn AIC7870
251 host adapter chip
252 .It
253 Adaptec
254 .Tn AIC7880
255 host adapter chip
256 .It
257 Adaptec
258 .Tn AIC7890
259 host adapter chip
260 .It
261 Adaptec
262 .Tn AIC7891
263 host adapter chip
264 .It
265 Adaptec
266 .Tn AIC7892
267 host adapter chip
268 .It
269 Adaptec
270 .Tn AIC7895
271 host adapter chip
272 .It
273 Adaptec
274 .Tn AIC7896
275 host adapter chip
276 .It
277 Adaptec
278 .Tn AIC7897
279 host adapter chip
280 .It
281 Adaptec
282 .Tn AIC7899
283 host adapter chip
284 .It
285 Adaptec
286 .Tn 274X(W)
287 .It
288 Adaptec
289 .Tn 274X(T)
290 .It
291 Adaptec
292 .Tn 284X
293 .It
294 Adaptec
295 .Tn 2910
296 .It
297 Adaptec
298 .Tn 2915
299 .It
300 Adaptec
301 .Tn 2920
302 .It
303 Adaptec
304 .Tn 2930C
305 .It
306 Adaptec
307 .Tn 2930U2
308 .It
309 Adaptec
310 .Tn 2940
311 .It
312 Adaptec
313 .Tn 2940J
314 .It
315 Adaptec
316 .Tn 2940N
317 .It
318 Adaptec
319 .Tn 2940U
320 .It
321 Adaptec
322 .Tn 2940AU
323 .It
324 Adaptec
325 .Tn 2940UW
326 .It
327 Adaptec
328 .Tn 2940UW Dual
329 .It
330 Adaptec
331 .Tn 2940UW Pro
332 .It
333 Adaptec
334 .Tn 2940U2W
335 .It
336 Adaptec
337 .Tn 2940U2B
338 .It
339 Adaptec
340 .Tn 2950U2W
341 .It
342 Adaptec
343 .Tn 2950U2B
344 .It
345 Adaptec
346 .Tn 19160B
347 .It
348 Adaptec
349 .Tn 29160B
350 .It
351 Adaptec
352 .Tn 29160N
353 .It
354 Adaptec
355 .Tn 3940
356 .It
357 Adaptec
358 .Tn 3940U
359 .It
360 Adaptec
361 .Tn 3940AU
362 .It
363 Adaptec
364 .Tn 3940UW
365 .It
366 Adaptec
367 .Tn 3940AUW
368 .It
369 Adaptec
370 .Tn 3940U2W
371 .It
372 Adaptec
373 .Tn 3950U2
374 .It
375 Adaptec
376 .Tn 3960
377 .It
378 Adaptec
379 .Tn 39160
380 .It
381 Adaptec
382 .Tn 3985
383 .It
384 Adaptec
385 .Tn 4944UW
386 .It
387 NEC PC-9821Xt13 (PC-98)
388 .It
389 NEC RvII26 (PC-98)
390 .It
391 NEC PC-9821X-B02L/B09 (PC-98)
392 .It
393 NEC SV-98/2-B03 (PC-98)
394 .It
395 Many motherboards with on-board
396 .Tn SCSI
397 support
398 .El
399 .Sh SCSI CONTROL BLOCKS (SCBs)
400 Every transaction sent to a device on the SCSI bus is assigned a
401 .Sq SCSI Control Block
402 (SCB).
403 The SCB contains all of the information required by the
404 controller to process a transaction.
405 The chip feature table lists
406 the number of SCBs that can be stored in on-chip memory.
407 All chips
408 with model numbers greater than or equal to 7870 allow for the on chip
409 SCB space to be augmented with external SRAM up to a maximum of 255 SCBs.
410 Very few Adaptec controller configurations have external SRAM.
411 .Pp
412 If external SRAM is not available, SCBs are a limited resource.
413 Using the SCBs in a straight forward manner would only allow the driver to
414 handle as many concurrent transactions as there are physical SCBs.
415 To fully utilize the SCSI bus and the devices on it,
416 requires much more concurrency.
417 The solution to this problem is
418 .Em SCB Paging ,
419 a concept similar to memory paging.
420 SCB paging takes advantage of
421 the fact that devices usually disconnect from the SCSI bus for long
422 periods of time without talking to the controller.
423 The SCBs for disconnected transactions are only of use to the controller
424 when the transfer is resumed.
425 When the host queues another transaction
426 for the controller to execute, the controller firmware will use a
427 free SCB if one is available.
428 Otherwise, the state of the most recently
429 disconnected (and therefore most likely to stay disconnected) SCB is
430 saved, via dma, to host memory, and the local SCB reused to start
431 the new transaction.
432 This allows the controller to queue up to
433 255 transactions regardless of the amount of SCB space.
434 Since the
435 local SCB space serves as a cache for disconnected transactions, the
436 more SCB space available, the less host bus traffic consumed saving
437 and restoring SCB data.
438 .Sh SEE ALSO
439 .Xr aha 4 ,
440 .Xr ahb 4 ,
441 .Xr cd 4 ,
442 .Xr da 4 ,
443 .Xr sa 4 ,
444 .Xr scsi 4
445 .Sh HISTORY
446 The
447 .Nm
448 driver appeared in
449 .Fx 2.0 .
450 .Sh AUTHORS
451 The
452 .Nm
453 driver, the
454 .Tn AIC7xxx
455 sequencer-code assembler,
456 and the firmware running on the aic7xxx chips was written by
457 .An Justin T. Gibbs .
458 .Sh BUGS
459 Some Quantum drives (at least the Empire 2100 and 1080s) will not run on an
460 .Tn AIC7870
461 Rev B in synchronous mode at 10MHz.
462 Controllers with this problem have a
463 42 MHz clock crystal on them and run slightly above 10MHz.
464 This confuses the drive and hangs the bus.
465 Setting a maximum synchronous negotiation rate of 8MHz in the
466 .Tn SCSI-Select
467 utility will allow normal operation.
468 .Pp
469 Although the Ultra2 and Ultra160 products have sufficient instruction
470 ram space to support both the initiator and target roles concurrently,
471 this configuration is disabled in favor of allowing the target role
472 to respond on multiple target ids.
473 A method for configuring dual role mode should be provided.
474 .Pp
475 Tagged Queuing is not supported in target mode.
476 .Pp
477 Reselection in target mode fails to function correctly on all high
478 voltage differential boards as shipped by Adaptec.
479 Information on
480 how to modify HVD board to work correctly in target mode is available
481 from Adaptec.