patch-2.0.21 linux/drivers/scsi/README.ncr53c8xx

• Lines: 459
• Date: Sat Sep 14 11:11:11 1996
• Orig file: v2.0.20/linux/drivers/scsi/README.ncr53c8xx
• Orig date: Thu Jul 11 08:19:59 1996

diff -u --recursive --new-file v2.0.20/linux/drivers/scsi/README.ncr53c8xx linux/drivers/scsi/README.ncr53c8xx
@@ -10,7 +10,7 @@
 1.  Introduction
 2.  Supported chips and SCSI features
 3.  Summary of other supported features
-4.  Memory mapped IO versus normal IO
+4.  Memory mapped I/O versus normal I/O
 5.  Tagged command queueing
 6.  Parity checking
 7.  Profiling information
@@ -39,7 +39,7 @@
 maintained by:
           Gerard Roudier              <groudier@club-internet.fr>
 
-The original driver has been written for 386bsd and FreeBSD by
+The original driver has been written for 386bsd and FreeBSD by:
           Wolfgang Stanglmeier        <wolf@cologne.de>
           Stefan Esser                <se@mi.Uni-Koeln.de>
 
@@ -50,14 +50,14 @@
           http://www.symbios.com
 
 This short documentation only describes the features of the NCR53C8XX driver, 
-configuration parameters and control commands available through the proc scsi 
+configuration parameters and control commands available through the proc SCSI
 file system read / write operations.
 
-This driver has been tested ok with linux/i386  and is currently untested
+This driver has been tested OK with linux/i386  and is currently untested
 under linux/Alpha. If you intend to use this driver under linux/Alpha, just 
 try it first with read-only or mounted read-only devices.
 
-I am not a native speaker of English and there is probably lots of 
+I am not a native speaker of English and there are probably lots of 
 mistakes in this README file. Any help will be welcome.
 
 
@@ -68,14 +68,14 @@
 	Synchronous negotiation
 	Disconnection
 	Tagged command queuing
-	Scsi parity checking
+	SCSI parity checking
 	Master parity checking
 
 "Wide negotiation" is supported for chips that allow it.
 The following table shows some characteristics of NCR 8xx family chips:
 
        On board                        Supported by    Tested with
-Chip   SDMS BIOS   Wide   Ultra Scsi   the driver      the driver
+Chip   SDMS BIOS   Wide   Ultra SCSI   the driver      the driver
 ----   ---------   ----   ----------   ------------    -----------
 810        N         N        N            Y             Y
 810A       N         N        N            Y             Y
@@ -84,73 +84,73 @@
 825A       Y         Y        N            Y             Not yet
 875        Y         Y        Y(1)         Y             Not yet
 
-(1) Ultra scsi extensions will be supported in a future release of the 
+(1) Ultra SCSI extensions will be supported in a future release of the 
     driver.
 
 
 3. Summary of other supported features.
 
         Module:                allow to load the driver
-        Memory mapped IO:      increase performances
-        Profiling information: read operations from the proc scsi file system
-        Control commands:      write operations to the proc scsi file system
+        Memory mapped I/O:     increases performance
+        Profiling information: read operations from the proc SCSI file system
+        Control commands:      write operations to the proc SCSI file system
         Debugging information: written to syslog (expert only)
 	Scatter / gather
 	Shared interrupt
 
 
-4. Memory mapped IO versus normal IO
+4. Memory mapped I/O versus normal I/O
 
-Memory mapped IO have less latency than normal IO.
-Since linux-1.3.x, memory mapped IO is used rather than normal IO.
-Memory mapped IO seems to works fine on most hardware configuration, but some 
-bad designed motherboards may break this feature.
-
-During initialisation phase, the driver first tries to use memory mapped io.
-If nothing seems wrong, it will use memory mapped io.
-If a flaw is detected,  it will use normal io.
+Memory mapped I/O has less latency than normal I/O.
+Since linux-1.3.x, memory mapped I/O is used rather than normal I/O.
+Memory mapped I/O seems to work fine on most hardware configurations, but some 
+poorly designed motherboards may break this feature.
+
+During the initialization phase, the driver first tries to use memory mapped
+I/O.  If nothing seems wrong, it will use memory mapped I/O.
+If a flaw is detected, it will use normal I/O.
 
-However, it's possible that memory mapped io does not work properly and the 
+However, it's possible that memory mapped I/O does not work properly and the 
 driver has not detected the problem.
 
-The configuration option CONFIG_SCSI_NCR53C8XX_IOMAPPED allow to force the 
-driver to use normal io in all cases.
+The configuration option CONFIG_SCSI_NCR53C8XX_IOMAPPED forces the 
+driver to use normal I/O in all cases.
 
 
 5. Tagged command queueing
 
-Some scsi devices donnot support properly tagged command queuing.
-A safe configuration can be to not enable tagged command queuing support at 
+Some SCSI devices do not properly support tagged command queuing.
+A safe configuration is to not enable tagged command queuing support at 
 boot-up, and to enable support of it with the control command "settags" 
 described further in this text.
 
-Once you are sure that all your devices support properly tagged command queuing,
+Once you are sure that all your devices properly support tagged command queuing,
 you can enable it by default with the CONFIG_SCSI_NCR53C8XX_TAGGED_QUEUE 
 configuration option.
 
 
 6. Parity checking
 
-The driver supports scsi parity checking and PCI bus master parity checking.
+The driver supports SCSI parity checking and PCI bus master parity checking.
 These features must be enabled in order to ensure safe data transfers.
 However, some flawed devices or mother boards will have problems with 
 parity. You can disable parity by choosing first "CONFIG_EXPERIMENTAL".
 Then, "make config" will allow to set the following configuration options:
 
-   CONFIG_SCSI_NCR53C8XX_DISABLE_PARITY_CHECK  (disable scsi parity checking)
+   CONFIG_SCSI_NCR53C8XX_DISABLE_PARITY_CHECK  (disable SCSI parity checking)
    CONFIG_SCSI_NCR53C8XX_DISABLE_MPARITY_CHECK (disable master parity checking)
 
 
 7. Profiling information
 
-Profiling information are available through the proc scsi file system.
+Profiling information is available through the proc SCSI file system.
 The device associated with a host has the following pathname:
           /proc/scsi/ncr53c8xx/N     (N=0,1,2 ....)
 
-Generally, only 1 board is used on hardware configuration, and the device is:
+Generally, only 1 board is used on hardware configuration, and that device is:
           /proc/scsi/ncr53c8xx/0
 
-However, if the driver has been made as module, the number of the host is 
+However, if the driver has been made as module, the number of the hosts is 
 incremented each time the driver is loaded.
 
 In order to display profiling information, just enter:
@@ -175,8 +175,8 @@
   ms_post      = 1320
 -------------------------------------------------------
 
-General information is easy to understand. The device id and the 
-revision id identify the scsi chip as follows:
+General information is easy to understand. The device ID and the 
+revision ID identify the SCSI chip as follows:
 
 Chip    Device id     Revision Id
 ----    ---------     -----------
@@ -188,11 +188,11 @@
 825A      0x3            >= 0x10
 875       0xf
 
-The profiling information is updated upon completion of scsi commands.
-The data structure is allocated and zeroed when the host adapter is 
+The profiling information is updated upon completion of SCSI commands.
+A data structure is allocated and zeroed when the host adapter is 
 attached. So, if the driver is a module, the profile counters are cleared each 
 time the driver is loaded.
-The "clearprof" command allow to clear these counters at any time.
+The "clearprof" command allows you to clear these counters at any time.
 
 The following counters are available:
 ("num" prefix means "number of", "ms" means milli-seconds)
@@ -206,8 +206,8 @@
 	Example above: 671 MB transferred
 
 num_disc
-	Number of scsi disconnections
-	Example above: 25763 scsi disconnections
+	Number of SCSI disconnections
+	Example above: 25763 SCSI disconnections
 
 num_break
 	number of script interruptions (phase mismatch)
@@ -222,7 +222,7 @@
 	Example above: 18038 interruptions "on the fly"
 
 ms_setup
-	Elapsed time for scsi commands setups
+	Elapsed time for SCSI commands setups
 	Example above: 4.94 seconds
 
 ms_data
@@ -230,12 +230,12 @@
 	Example above: 369.94 seconds spent for data transfer
 
 ms_disc
-	Elapsed time for scsi disconnections
+	Elapsed time for SCSI disconnections
 	Example above: 183.09 seconds spent disconnected
 
 ms_post
 	Elapsed time for command post processing
-	(time from scsi status get to command completion call)
+	(time from SCSI status get to command completion call)
 	Example above: 1.32 seconds spent for post processing
 
 Due to the 1/100 second tick of the system clock, "ms_post" time may be 
@@ -243,13 +243,13 @@
 
 In the example above, we got 18038 interrupts "on the fly" and only 1673 script 
 breaks probably due to disconnections inside a segment of the scatter list. 
-It is an excellent result due to the fact that the driver tries to use small 
+This is an excellent result due to the fact that the driver tries to use small 
 data segments (512) for the scatter list. The CPU load of this rescatter process 
-is acceptable. Unlike other scsi processors, NCR53C8XX controllers do not need  
-large data chunks in order to get better performances, and it seems that it 
-is the opposite.
-The scatter/gather algorithm of the middle scsi driver is not optimal for 
-NCR scsi processors and should be tunable according to host type.
+is acceptable. Unlike other SCSI processors, NCR53C8XX controllers do not need  
+large data chunks in order to get better performance, and it seems that it 
+is just the opposite.
+The scatter/gather algorithm of the middle SCSI driver is not optimal for 
+NCR SCSI processors and should be tunable according to host type.
 
 You can tune the "wished" segment size for the scatterlist by changing the 
 following "define" in the file ncr53c8xx.h.
@@ -261,7 +261,7 @@
 8. Control commands
 
 Control commands can be sent to the driver with write operations to the 
-proc scsi file system. The generic command syntax is the following:
+proc SCSI file system. The generic command syntax is the following:
 
       echo "<verb> <parameters>" >/proc/scsi/ncr53c8xx/0
       (assumes controller number is 0)
@@ -311,14 +311,14 @@
     setdebug <list of debug flags>
 
     Available debug flags:
-        alloc:   print infos about memory allocations (ccb, lcb)
-        queue:   print infos about insertions into the command start queue
+        alloc:   print info about memory allocations (ccb, lcb)
+        queue:   print info about insertions into the command start queue
         result:  print sense data on CHECK CONDITION status
-        scatter: print infos about the scatter process
-        scripts: print infos about the script binding process
+        scatter: print info about the scatter process
+        scripts: print info about the script binding process
 	tiny:    print minimal debugging information
-	timing:  print timing information of the ncr chip.
-	nego:    print information about scsi negotiations
+	timing:  print timing information of the NCR chip
+	nego:    print information about SCSI negotiations
 	phase:   print information on script interruptions
 
 
@@ -327,38 +327,38 @@
     clearprof
 
     The profile counters are automatically cleared when the amount of data 
-    transfered reach 1000 GB in order to avoid overflow.
-    The "clearprof" command allow to clear these counters at any time.
+    transfered reaches 1000 GB in order to avoid overflow.
+    The "clearprof" command allows you to clear these counters at any time.
 
 
 9. Configuration parameters
 
 If the firmware of all your devices is perfect enough, all the features 
 supported by the driver can be enabled at start-up.
-However, if only one has a flaw for some scsi feature, you can disable the 
+However, if only one has a flaw for some SCSI feature, you can disable the 
 support by the driver of this feature at linux start-up and enable this 
 feature after boot-up only for devices that support it safely.
 
 CONFIG_SCSI_NCR53C8XX_IOMAPPED       (default answer: n)
-    Answer "y" if you suspect your mother board to not allow memory mapped IO.
-    May slow down a little performances.
+    Answer "y" if you suspect your mother board to not allow memory mapped I/O.
+    May slow down performance a little.
 
 CONFIG_SCSI_NCR53C8XX_TAGGED_QUEUE    (default answer: n)
-    Answer "y" if you are sure that all your scsi devices that are able to 
+    Answer "y" if you are sure that all your SCSI devices that are able to 
     accept tagged commands will proceed safely.
 
 CONFIG_SCSI_NCR53C8XX_FORCE_ASYNCHRONOUS (default answer: n)
-    This option allow to force asynchronous transfer mode for all scsi devices. 
+    This option forces asynchronous transfer mode for all SCSI devices. 
  
 CONFIG_SCSI_NCR53C8XX_FORCE_SYNC_NEGO (default answer: n)
-    Force synchronous negotiation for all scsi-2 devices.
-    Some scsi-2 devices do not report this feature in byte 7 of inquiry 
-    response and however support it properly (TAMARACK scanners for example).
+    Force synchronous negotiation for all SCSI-2 devices.
+    Some SCSI-2 devices do not report this feature in byte 7 of inquiry 
+    response but do support it properly (TAMARACK scanners for example).
 
 CONFIG_SCSI_NCR53C8XX_NO_DISCONNECT   (default and only reasonnable answer: n)
-    If you suspect a device of yours to not support properly disconnections,
-    you can answer "y". Then, all scsi devices will never disconnect the bus 
-    even while long scsi operations.
+    If you suspect a device of yours does not properly support disconnections,
+    you can answer "y". Then, all SCSI devices will never disconnect the bus 
+    even while performing long SCSI operations.
 
 
 10. Some constants and flags of the ncr53c8xx.h header files
@@ -368,17 +368,17 @@
 Do that only if you know what you are doing.
 
 SCSI_NCR_IOMAPPED		(default: not defined)
-	If defined, normal IO is forced.
+	If defined, normal I/O is forced.
 
 SCSI_NCR_SHARE_IRQ		(default: defined)
-	If defined, request shared irq.
+	If defined, request shared IRQ.
 	
 SCSI_NCR_MAX_TAGS		(default: 4)
 	Maximum number of simultaneous tagged commands to a device.
 	Can be changed by "settags <target> <maxtags>"
 
 SCSI_NCR_ALWAYS_SIMPLE_TAG	(default: defined)
-	Use SIMPLE TAG for read and write commands
+	Use SIMPLE TAG for read and write commands.
 	Can be changed by "setorder <ordered|simple|default>"
 
 SCSI_NCR_TAGGED_QUEUE_DISABLED	(default: defined)
@@ -389,38 +389,38 @@
 	If defined, targets are not allowed to disconnect.
 
 SCSI_NCR_FORCE_SYNC_NEGO	(default: not defined)
-	If defined, synchronous negotiation is tried for all scsi-2 devices.
+	If defined, synchronous negotiation is tried for all SCSI-2 devices.
 	Can be changed by "setsync <target> <period>"
 
 SCSI_NCR_DISABLE_MPARITY_CHECK	(default: not defined)
 	If defined, master parity checking is disabled.
 
 SCSI_NCR_DISABLE_PARITY_CHECK	(default: not defined)
-	If defined, scsi parity checking is disabled.
+	If defined, SCSI parity checking is disabled.
 
 SCSI_NCR_PROFILE		(default: defined)
-	If defined, profile information are gathered
+	If defined, profiling information is gathered.
 
 SCSI_NCR_MAX_SCATTER		(default: 128)
 	Scatter list size of the driver ccb.
 
 SCSI_NCR_SEGMENT_SIZE		(default: 512)
-	If defined, the driver try to use scatter segments of this size.
+	If defined, the driver will try to use scatter segments of this size.
 	If not defined, the Linux scatter list is used as is.
 
 SCSI_NCR_MAX_TARGET		(default: 16)
-	Max number of target per host.
+	Max number of targets per host.
 
 SCSI_NCR_MAX_HOST		(default: 2)
 	Max number of host controllers.
 
 SCSI_NCR_SETTLE_TIME		(default: 2)
-	Number of seconds the driver wait after reset.
+	Number of seconds the driver will wait after reset.
 
 SCSI_NCR_TIMEOUT_ALERT		(default: 3)
 	If a pending command will time out after this amount of seconds,
 	an ordered tag is used for the next command.
-	Avoid timeouts for unordered tagged commands.
+	Avoids timeouts for unordered tagged commands.
 
 SCSI_NCR_CAN_QUEUE		(default: 7*SCSI_NCR_MAX_TAGS)
 	Max number of commands that can be queued to a host.
@@ -432,7 +432,7 @@
 	Max size of the Linux scatter/gather list.
 
 SCSI_NCR_MAX_LUN	(default: 8)
-	Max number of luns per target
+	Max number of LUNs per target.
 
 
 11. Provided files
@@ -474,9 +474,9 @@
 
 This install script only supports linux-1.2.13 and linux-1.3.45 to 1.3.100.
 
-This procedure just move the standard driver files to SAVE_53 sub-directory 
+This procedure just moves the standard driver files to SAVE_53 sub-directory 
 of linux/drivers/scsi, copies the drivers file to that directory and patches 
-the scsi Makefile.
+the SCSI Makefile.
 The standard driver can be restored with Uninstall.ncr53c8xx
 
 	If your linux directory is at the standard location
@@ -497,7 +497,7 @@
 		Since release 1.3.90, additionnal configuation parameters 
 		have been added for the standard NCR driver.
 		Just reply Y or N as you want to these questions;
-		The NCR53C8XX driver ignore those parameters.
+		The NCR53C8XX driver ignores those parameters.
 
 	If you prefer the standard NCR driver of Linux:
 	just enter:
@@ -509,9 +509,9 @@
 
 13. Installation procedure for Linux version 2
 
-This procedure add the driver to the kernel tree.
+This procedure adds the driver to the kernel tree.
 Using "make config" you can choose between the standard driver and the BSD one.
-It is possible to configure the both drivers as module and to switch from one 
+It is possible to configure both drivers as modules and to switch from one 
 to the other at run time.
 Take care to unload the current driver module before loading the other one.
 
@@ -532,9 +532,9 @@
 
 14. Control commands under linux-1.2.13
 
-Profile data and control commands using the proc scsi file system are not 
+Profiling data and control commands using the proc SCSI file system are not 
 available for linux-1.2.13.
-The only control command available is "scsitag" which allows to enable 
+The only control command available is "scsitag" which allows you to enable
 tagged command queuing support after linux boot-up.
 
 Tagged command queueing is disabled by default at system startup.
@@ -549,19 +549,19 @@
 
 15.1 Tagged commands with Iomega Jaz device
 
-I never tried such devices, however it has been reported to me the following:
+I have not tried this device, however it has been reported to me the following:
 This device is capable of Tagged command queuing. However while spinning up,
-it rejects Tagged commands. This behaviour is conforms to 6.8.2 of scsi-2 
+it rejects Tagged commands. This behaviour is conforms to 6.8.2 of SCSI-2 
 specifications. The current behaviour of the driver in that situation is not 
 satisfying. So do not enable Tagged command queuing for devices that are able 
 to spin down.
-The other problems that may appear are timeouts. The only way to avoid timeouts 
+The other problem that may appear is timeouts. The only way to avoid timeouts 
 seems to edit linux/drivers/scsi/sd.c and to increase the current timeout 
 values.
 
 15.2 Tagged command queuing cannot be disabled at run time
 
-Once Tagged command queuing has been enabled, the driver will not allow to 
+Once Tagged command queuing has been enabled, the driver will not allow you to 
 disable this feature ("settags <target> 0" is not supported).
 This problem is due to some limitations of the code added to the Linux version 
 of the driver.