Merge branch 'upstream-linus' of master.kernel.org:/pub/scm/linux/kernel/git/jgarzik...
[linux-2.6] / Documentation / scsi / g_NCR5380.txt
1 README file for the Linux g_NCR5380 driver.
2
3 (c) 1993 Drew Eckhard
4 NCR53c400 extensions (c) 1994,1995,1996 Kevin Lentin
5
6 This file documents the NCR53c400 extensions by Kevin Lentin and some
7 enhancements to the NCR5380 core.
8
9 This driver supports both NCR5380 and NCR53c400 cards in port or memory
10 mapped modes. Currently this driver can only support one of those mapping
11 modes at a time but it does support both of these chips at the same time.
12 The next release of this driver will support port & memory mapped cards at
13 the same time. It should be able to handle multiple different cards in the
14 same machine.
15
16 The drivers/scsi/Makefile has an override in it for the most common
17 NCR53c400 card, the Trantor T130B in its default configuration:
18         Port: 0x350
19         IRQ : 5
20
21 The NCR53c400 does not support DMA but it does have Pseudo-DMA which is
22 supported by the driver.
23
24 If the default configuration does not work for you, you can use the kernel
25 command lines (eg using the lilo append command):
26         ncr5380=port,irq,dma
27         ncr53c400=port,irq
28 or
29         ncr5380=base,irq,dma
30         ncr53c400=base,irq
31
32 The driver does not probe for any addresses or ports other than those in
33 the OVERRIDE or given to the kernel as above.
34
35 This driver provides some information on what it has detected in
36 /proc/scsi/g_NCR5380/x where x is the scsi card number as detected at boot
37 time. More info to come in the future.
38
39 When NCR53c400 support is compiled in, BIOS parameters will be returned by
40 the driver (the raw 5380 driver does not and I don't plan to fiddle with
41 it!).
42
43 This driver works as a module.
44 When included as a module, parameters can be passed on the insmod/modprobe
45 command line:
46   ncr_irq=xx   the interrupt
47   ncr_addr=xx  the port or base address (for port or memory
48                mapped, resp.)
49   ncr_dma=xx   the DMA
50   ncr_5380=1   to set up for a NCR5380 board
51   ncr_53c400=1 to set up for a NCR53C400 board
52 e.g.
53 modprobe g_NCR5380 ncr_irq=5 ncr_addr=0x350 ncr_5380=1
54   for a port mapped NCR5380 board or
55 modprobe g_NCR5380 ncr_irq=255 ncr_addr=0xc8000 ncr_53c400=1
56   for a memory mapped NCR53C400 board with interrupts disabled.
57
58 (255 should be specified for no or DMA interrupt, 254 to autoprobe for an 
59      IRQ line if overridden on the command line.)
60
61
62 Kevin Lentin
63 K.Lentin@cs.monash.edu.au