From Erik Habbinga: added note on REQUEST SENSE implementation
[mirror/scst/.git] / mpt / README
1 Target driver for LSI/MPT XXX cards
2 ===================================
3
4 Version X.X.X, XX XXX 200X
5 --------------------------
6
7 This driver was originally developed by Hu Gang and then is developed by
8 Erik Habbinga <erikhabbinga@inphase-tech.com>. It is on the early stage
9 of development.
10
11 The current maintainer of this driver is Erik. Please send him all
12 question related to it (CC: scst-devel@lists.sourceforge.net).
13
14 This driver tested only on Linux kernel versions 2.6.15.x.
15
16 Building from the Linux kernel tree
17 -----------------------------------
18
19 To build from the kernel tree, you should:
20
21 1. Link drivers/message/fusion/mpt_scst to $(SCST_DIR)/mpt
22
23 2. Patch drivers/message/fusion/Makefile and
24 drivers/message/fusion/Kconfig by diffs from $(SCST_DIR)/mpt/in-tree
25
26 3. Correct in drivers/message/fusion/Makefile SCST_INC_DIR variable so
27 it points to correct directory with SCST include files.
28
29 Notes on implementation
30 -----------------------
31 The driver takes the mptstm target driver implemented by LSI
32 and ports it to the SCST architecture.
33
34 The LSI hardware returns an error when it realizes that command
35 status and sense data cannot be sent in the same transaction.
36 This happens during non-packetized SCSI command handling (not FC or
37 SAS).  For SCSI implementations, the driver speculatively caches
38 sense data.  If the hardware reports that the sense data could not
39 be sent, the driver will return the cached sense data without
40 involving SCST if the next command is REQUEST SENSE.  Cached sense
41 data is discarded on bus reset or if the next command after sense
42 send failure was not REQUEST SENSE.
43
44 Caching sense data in this fashion probably won't work in a tagged
45 command queuing environment.  If SCSI hardware is being used, the
46 driver inspects responses to the INQUIRY command and clears the
47 BQUE and CMDQUE bits in the standard INQUIRY response to disable
48 tagged command queuing.
49