ich777/linux_media
1
0
Fork 0
mirror of https://github.com/tbsdtv/linux_media.git synced 2025-07-24 05:01:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

scsi: docs: convert sym53c8xx_2.txt to ReST

Browse Source 
Link: https://lore.kernel.org/r/08202c87294d61d147ec4ac784219d20805cdeb5.1583136624.git.mchehab+huawei@kernel.org
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
This commit is contained in:
Mauro Carvalho Chehab
2020-03-02 09:16:11 +01:00
committed by Martin K. Petersen
parent 110a89b1ca
commit f02e84d29e
3 changed files with 630 additions and 468 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/scsi/index.rst
View File

@@ -42,5 +42,6 @@ Linux SCSI Subsystem
smartpqi smartpqi
st st
sym53c500_cs sym53c500_cs
sym53c8xx_2
scsi_transport_srp/figures scsi_transport_srp/figures

445
Documentation/scsi/sym53c8xx_2.txt → Documentation/scsi/sym53c8xx_2.rst
View File

@@ -1,13 +1,20 @@
.. SPDX-License-Identifier: GPL-2.0
=========================================
The Linux SYM-2 driver documentation file The Linux SYM-2 driver documentation file
=========================================
Written by Gerard Roudier <groudier@free.fr> Written by Gerard Roudier <groudier@free.fr>
21 Rue Carnot 21 Rue Carnot
95170 DEUIL LA BARRE - FRANCE 95170 DEUIL LA BARRE - FRANCE
Updated by Matthew Wilcox <matthew@wil.cx> Updated by Matthew Wilcox <matthew@wil.cx>
2004-10-09 2004-10-09
===============================================================================
.. Contents
1. Introduction 1. Introduction
2. Supported chips and SCSI features 2. Supported chips and SCSI features
@@ -53,16 +60,16 @@ Updated by Matthew Wilcox <matthew@wil.cx>
17.2 Symbios NVRAM layout 17.2 Symbios NVRAM layout
17.3 Tekram NVRAM layout 17.3 Tekram NVRAM layout
===============================================================================
1. Introduction 1. Introduction
===============
This driver supports the whole SYM53C8XX family of PCI-SCSI controllers. This driver supports the whole SYM53C8XX family of PCI-SCSI controllers.
It also support the subset of LSI53C10XX PCI-SCSI controllers that are based It also support the subset of LSI53C10XX PCI-SCSI controllers that are based
on the SYM53C8XX SCRIPTS language. on the SYM53C8XX SCRIPTS language.
It replaces the sym53c8xx+ncr53c8xx driver bundle and shares its core code It replaces the sym53c8xx+ncr53c8xx driver bundle and shares its core code
with the FreeBSD SYM-2 driver. The `glue' that allows this driver to work with the FreeBSD SYM-2 driver. The 'glue' that allows this driver to work
under Linux is contained in 2 files named sym_glue.h and sym_glue.c. under Linux is contained in 2 files named sym_glue.h and sym_glue.c.
Other drivers files are intended not to depend on the Operating System Other drivers files are intended not to depend on the Operating System
on which the driver is used. on which the driver is used.
@@ -70,25 +77,30 @@ on which the driver is used.
The history of this driver can be summarized as follows: The history of this driver can be summarized as follows:
1993: ncr driver written for 386bsd and FreeBSD by: 1993: ncr driver written for 386bsd and FreeBSD by:
Wolfgang Stanglmeier <wolf@cologne.de>
Stefan Esser <se@mi.Uni-Koeln.de> - Wolfgang Stanglmeier <wolf@cologne.de>
- Stefan Esser <se@mi.Uni-Koeln.de>
1996: port of the ncr driver to Linux-1.2.13 and rename it ncr53c8xx. 1996: port of the ncr driver to Linux-1.2.13 and rename it ncr53c8xx.
Gerard Roudier
- Gerard Roudier
1998: new sym53c8xx driver for Linux based on LOAD/STORE instruction and that 1998: new sym53c8xx driver for Linux based on LOAD/STORE instruction and that
adds full support for the 896 but drops support for early NCR devices. adds full support for the 896 but drops support for early NCR devices.
Gerard Roudier
- Gerard Roudier
1999: port of the sym53c8xx driver to FreeBSD and support for the LSI53C1010 1999: port of the sym53c8xx driver to FreeBSD and support for the LSI53C1010
33 MHz and 66MHz Ultra-3 controllers. The new driver is named `sym'. 33 MHz and 66MHz Ultra-3 controllers. The new driver is named 'sym'.
Gerard Roudier
2000: Add support for early NCR devices to FreeBSD `sym' driver. - Gerard Roudier
2000: Add support for early NCR devices to FreeBSD 'sym' driver.
Break the driver into several sources and separate the OS glue Break the driver into several sources and separate the OS glue
code from the core code that can be shared among different O/Ses. code from the core code that can be shared among different O/Ses.
Write a glue code for Linux. Write a glue code for Linux.
Gerard Roudier
- Gerard Roudier
2004: Remove FreeBSD compatibility code. Remove support for versions of 2004: Remove FreeBSD compatibility code. Remove support for versions of
Linux before 2.6. Start using Linux facilities. Linux before 2.6. Start using Linux facilities.
@@ -106,64 +118,91 @@ SCSI standard documentations are available at T10 site:
Useful SCSI tools written by Eric Youngdale are part of most Linux Useful SCSI tools written by Eric Youngdale are part of most Linux
distributions: distributions:
scsiinfo: command line tool
scsi-config: TCL/Tk tool using scsiinfo ============ ==========================
scsiinfo command line tool
scsi-config TCL/Tk tool using scsiinfo
============ ==========================
2. Supported chips and SCSI features 2. Supported chips and SCSI features
====================================
The following features are supported for all chips: The following features are supported for all chips:
Synchronous negotiation - Synchronous negotiation
Disconnection - Disconnection
Tagged command queuing - Tagged command queuing
SCSI parity checking - SCSI parity checking
PCI Master parity checking - PCI Master parity checking
Other features depends on chip capabilities. Other features depends on chip capabilities.
The driver notably uses optimized SCRIPTS for devices that support The driver notably uses optimized SCRIPTS for devices that support
LOAD/STORE and handles PHASE MISMATCH from SCRIPTS for devices that LOAD/STORE and handles PHASE MISMATCH from SCRIPTS for devices that
support the corresponding feature. support the corresponding feature.
The following table shows some characteristics of the chip family. The following table shows some characteristics of the chip family.
On board LOAD/STORE HARDWARE +--------+-----------+-----+-----------+------------+------------+---------+
Chip SDMS BIOS Wide SCSI std. Max. sync SCRIPTS PHASE MISMATCH | | | | | |Load/store |Hardware |
---- --------- ---- --------- ---------- ---------- -------------- | |On board | | | |scripts |phase |
810 N N FAST10 10 MB/s N N |Chip |SDMS BIOS |Wide |SCSI std. | Max. sync | |mismatch |
810A N N FAST10 10 MB/s Y N +--------+-----------+-----+-----------+------------+------------+---------+
815 Y N FAST10 10 MB/s N N |810 | N | N | FAST10 | 10 MB/s | N | N |
825 Y Y FAST10 20 MB/s N N +--------+-----------+-----+-----------+------------+------------+---------+
825A Y Y FAST10 20 MB/s Y N |810A | N | N | FAST10 | 10 MB/s | Y | N |
860 N N FAST20 20 MB/s Y N +--------+-----------+-----+-----------+------------+------------+---------+
875 Y Y FAST20 40 MB/s Y N |815 | Y | N | FAST10 | 10 MB/s | N | N |
875A Y Y FAST20 40 MB/s Y Y +--------+-----------+-----+-----------+------------+------------+---------+
876 Y Y FAST20 40 MB/s Y N |825 | Y | Y | FAST10 | 20 MB/s | N | N |
895 Y Y FAST40 80 MB/s Y N +--------+-----------+-----+-----------+------------+------------+---------+
895A Y Y FAST40 80 MB/s Y Y |825A | Y | Y | FAST10 | 20 MB/s | Y | N |
896 Y Y FAST40 80 MB/s Y Y +--------+-----------+-----+-----------+------------+------------+---------+
897 Y Y FAST40 80 MB/s Y Y |860 | N | N | FAST20 | 20 MB/s | Y | N |
1510D Y Y FAST40 80 MB/s Y Y +--------+-----------+-----+-----------+------------+------------+---------+
1010 Y Y FAST80 160 MB/s Y Y |875 | Y | Y | FAST20 | 40 MB/s | Y | N |
1010_66* Y Y FAST80 160 MB/s Y Y +--------+-----------+-----+-----------+------------+------------+---------+
|875A | Y | Y | FAST20 | 40 MB/s | Y | Y |
+--------+-----------+-----+-----------+------------+------------+---------+
|876 | Y | Y | FAST20 | 40 MB/s | Y | N |
+--------+-----------+-----+-----------+------------+------------+---------+
|895 | Y | Y | FAST40 | 80 MB/s | Y | N |
+--------+-----------+-----+-----------+------------+------------+---------+
|895A | Y | Y | FAST40 | 80 MB/s | Y | Y |
+--------+-----------+-----+-----------+------------+------------+---------+
|896 | Y | Y | FAST40 | 80 MB/s | Y | Y |
+--------+-----------+-----+-----------+------------+------------+---------+
|897 | Y | Y | FAST40 | 80 MB/s | Y | Y |
+--------+-----------+-----+-----------+------------+------------+---------+
|1510D | Y | Y | FAST40 | 80 MB/s | Y | Y |
+--------+-----------+-----+-----------+------------+------------+---------+
|1010 | Y | Y | FAST80 |160 MB/s | Y | Y |
+--------+-----------+-----+-----------+------------+------------+---------+
|1010_66 | Y | Y | FAST80 |160 MB/s | Y | Y |
|[1]_ | | | | | | |
+--------+-----------+-----+-----------+------------+------------+---------+
* Chip supports 33MHz and 66MHz PCI bus clock. .. [1] Chip supports 33MHz and 66MHz PCI bus clock.
Summary of other supported features: Summary of other supported features:
Module: allow to load the driver :Module: allow to load the driver
Memory mapped I/O: increases performance :Memory mapped I/O: increases performance
Control commands: write operations to the proc SCSI file system :Control commands: write operations to the proc SCSI file system
Debugging information: written to syslog (expert only) :Debugging information: written to syslog (expert only)
Scatter / gather :Serial NVRAM: Symbios and Tekram formats
Shared interrupt
Boot setup commands - Scatter / gather
Serial NVRAM: Symbios and Tekram formats - Shared interrupt
- Boot setup commands
3. Advantages of this driver for newer chips. 3. Advantages of this driver for newer chips.
=============================================
3.1 Optimized SCSI SCRIPTS. 3.1 Optimized SCSI SCRIPTS
--------------------------
All chips except the 810, 815 and 825, support new SCSI SCRIPTS instructions All chips except the 810, 815 and 825, support new SCSI SCRIPTS instructions
named LOAD and STORE that allow to move up to 1 DWORD from/to an IO register named LOAD and STORE that allow to move up to 1 DWORD from/to an IO register
@@ -179,6 +218,7 @@ driver also incorporates a different SCRIPTS set based on MEMORY MOVE, in
order to provide support for the entire SYM53C8XX chips family. order to provide support for the entire SYM53C8XX chips family.
3.2 New features appeared with the SYM53C896 3.2 New features appeared with the SYM53C896
--------------------------------------------
Newer chips (see above) allows handling of the phase mismatch context from Newer chips (see above) allows handling of the phase mismatch context from
SCRIPTS (avoids the phase mismatch interrupt that stops the SCSI processor SCRIPTS (avoids the phase mismatch interrupt that stops the SCSI processor
@@ -191,6 +231,7 @@ registers for bit 32-63. Another interesting feature is that LOAD/STORE
instructions that address the on-chip RAM (8k) remain internal to the chip. instructions that address the on-chip RAM (8k) remain internal to the chip.
4. Memory mapped I/O versus normal I/O 4. Memory mapped I/O versus normal I/O
======================================
Memory mapped I/O has less latency than normal I/O and is the recommended Memory mapped I/O has less latency than normal I/O and is the recommended
way for doing IO with PCI devices. Memory mapped I/O seems to work fine on way for doing IO with PCI devices. Memory mapped I/O seems to work fine on
@@ -199,6 +240,7 @@ this feature. A configuration option is provided for normal I/O to be
used but the driver defaults to MMIO. used but the driver defaults to MMIO.
5. Tagged command queueing 5. Tagged command queueing
==========================
Queuing more than 1 command at a time to a device allows it to perform Queuing more than 1 command at a time to a device allows it to perform
optimizations based on actual head positions and its mechanical optimizations based on actual head positions and its mechanical
@@ -206,9 +248,11 @@ characteristics. This feature may also reduce average command latency.
In order to really gain advantage of this feature, devices must have In order to really gain advantage of this feature, devices must have
a reasonable cache size (No miracle is to be expected for a low-end a reasonable cache size (No miracle is to be expected for a low-end
hard disk with 128 KB or less). hard disk with 128 KB or less).
Some known old SCSI devices do not properly support tagged command queuing. Some known old SCSI devices do not properly support tagged command queuing.
Generally, firmware revisions that fix this kind of problems are available Generally, firmware revisions that fix this kind of problems are available
at respective vendor web/ftp sites. at respective vendor web/ftp sites.
All I can say is that I never have had problem with tagged queuing using All I can say is that I never have had problem with tagged queuing using
this driver and its predecessors. Hard disks that behaved correctly for this driver and its predecessors. Hard disks that behaved correctly for
me using tagged commands are the following: me using tagged commands are the following:
@@ -241,7 +285,7 @@ commands is probably just resource wasting.
If your controller does not have NVRAM or if it is managed by the SDMS If your controller does not have NVRAM or if it is managed by the SDMS
BIOS/SETUP, you can configure tagged queueing feature and device queue BIOS/SETUP, you can configure tagged queueing feature and device queue
depths from the boot command-line. For example: depths from the boot command-line. For example::
sym53c8xx=tags:4/t2t3q15-t4q7/t1u0q32 sym53c8xx=tags:4/t2t3q15-t4q7/t1u0q32
@@ -271,11 +315,14 @@ The heuristic used by the driver in handling QUEUE FULL ensures that the
impact on performances is not too bad. You can get rid of the messages by impact on performances is not too bad. You can get rid of the messages by
setting verbose level to zero, as follow: setting verbose level to zero, as follow:
1st method: boot your system using 'sym53c8xx=verb:0' option. 1st method:
2nd method: apply "setverbose 0" control command to the proc fs entry boot your system using 'sym53c8xx=verb:0' option.
2nd method:
apply "setverbose 0" control command to the proc fs entry
corresponding to your controller after boot-up. corresponding to your controller after boot-up.
6. Parity checking 6. Parity checking
==================
The driver supports SCSI parity checking and PCI bus master parity The driver supports SCSI parity checking and PCI bus master parity
checking. These features must be enabled in order to ensure safe checking. These features must be enabled in order to ensure safe
@@ -284,6 +331,7 @@ with parity. The options to defeat parity checking have been removed
from the driver. from the driver.
7. Profiling information 7. Profiling information
========================
This driver does not provide profiling information as did its predecessors. This driver does not provide profiling information as did its predecessors.
This feature was not this useful and added complexity to the code. This feature was not this useful and added complexity to the code.
@@ -291,10 +339,11 @@ As the driver code got more complex, I have decided to remove everything
that didn't seem actually useful. that didn't seem actually useful.
8. Control commands 8. Control commands
===================
Control commands can be sent to the driver with write operations to Control commands can be sent to the driver with write operations to
the proc SCSI file system. The generic command syntax is the the proc SCSI file system. The generic command syntax is the
following: following::
echo "<verb> <parameters>" >/proc/scsi/sym53c8xx/0 echo "<verb> <parameters>" >/proc/scsi/sym53c8xx/0
(assumes controller number is 0) (assumes controller number is 0)
@@ -305,72 +354,82 @@ apply to all targets of the SCSI chain (except the controller).
Available commands: Available commands:
8.1 Set minimum synchronous period factor 8.1 Set minimum synchronous period factor
-----------------------------------------
setsync <target> <period factor> setsync <target> <period factor>
target: target number :target: target number
period: minimum synchronous period. :period: minimum synchronous period.
Maximum speed = 1000/(4*period factor) except for special Maximum speed = 1000/(4*period factor) except for special
cases below. cases below.
Specify a period of 0, to force asynchronous transfer mode. Specify a period of 0, to force asynchronous transfer mode.
9 means 12.5 nano-seconds synchronous period - 9 means 12.5 nano-seconds synchronous period
10 means 25 nano-seconds synchronous period - 10 means 25 nano-seconds synchronous period
11 means 30 nano-seconds synchronous period - 11 means 30 nano-seconds synchronous period
12 means 50 nano-seconds synchronous period - 12 means 50 nano-seconds synchronous period
8.2 Set wide size 8.2 Set wide size
-----------------
setwide <target> <size> setwide <target> <size>
target: target number :target: target number
size: 0=8 bits, 1=16bits :size: 0=8 bits, 1=16bits
8.3 Set maximum number of concurrent tagged commands 8.3 Set maximum number of concurrent tagged commands
----------------------------------------------------
settags <target> <tags> settags <target> <tags>
target: target number :target: target number
tags: number of concurrent tagged commands :tags: number of concurrent tagged commands
must not be greater than configured (default: 16) must not be greater than configured (default: 16)
8.4 Set debug mode 8.4 Set debug mode
------------------
setdebug <list of debug flags> setdebug <list of debug flags>
Available debug flags: Available debug flags:
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 alloc print info about memory allocations (ccb, lcb)
scatter: print info about the scatter process queue print info about insertions into the command start queue
scripts: print info about the script binding process result print sense data on CHECK CONDITION status
tiny: print minimal debugging information scatter print info about the scatter process
timing: print timing information of the NCR chip scripts print info about the script binding process
nego: print information about SCSI negotiations tiny print minimal debugging information
phase: print information on script interruptions timing print timing information of the NCR chip
nego print information about SCSI negotiations
phase print information on script interruptions
======== ========================================================
Use "setdebug" with no argument to reset debug flags. Use "setdebug" with no argument to reset debug flags.
8.5 Set flag (no_disc) 8.5 Set flag (no_disc)
----------------------
setflag <target> <flag> setflag <target> <flag>
target: target number :target: target number
For the moment, only one flag is available: For the moment, only one flag is available:
no_disc: not allow target to disconnect. no_disc: not allow target to disconnect.
Do not specify any flag in order to reset the flag. For example: Do not specify any flag in order to reset the flag. For example:
- setflag 4
setflag 4
will reset no_disc flag for target 4, so will allow it disconnections. will reset no_disc flag for target 4, so will allow it disconnections.
- setflag all setflag all
will allow disconnection for all devices on the SCSI bus. will allow disconnection for all devices on the SCSI bus.
8.6 Set verbose level 8.6 Set verbose level
---------------------
setverbose #level setverbose #level
@@ -378,22 +437,27 @@ Available commands:
th driver verbose level after boot-up. th driver verbose level after boot-up.
8.7 Reset all logical units of a target 8.7 Reset all logical units of a target
---------------------------------------
resetdev <target> resetdev <target>
target: target number :target: target number
The driver will try to send a BUS DEVICE RESET message to the target. The driver will try to send a BUS DEVICE RESET message to the target.
8.8 Abort all tasks of all logical units of a target 8.8 Abort all tasks of all logical units of a target
----------------------------------------------------
cleardev <target> cleardev <target>
target: target number :target: target number
The driver will try to send a ABORT message to all the logical units The driver will try to send a ABORT message to all the logical units
of the target. of the target.
9. Configuration parameters 9. Configuration parameters
===========================
Under kernel configuration tools (make menuconfig, for example), it is Under kernel configuration tools (make menuconfig, for example), it is
possible to change some default driver configuration parameters. possible to change some default driver configuration parameters.
@@ -423,13 +487,15 @@ Synchronous transfers frequency (default answer: 80)
0 means "asynchronous data transfers". 0 means "asynchronous data transfers".
10. Boot setup commands 10. Boot setup commands
=======================
10.1 Syntax 10.1 Syntax
-----------
Setup commands can be passed to the driver either at boot time or as Setup commands can be passed to the driver either at boot time or as
parameters to modprobe, as described in Documentation/admin-guide/kernel-parameters.rst parameters to modprobe, as described in Documentation/admin-guide/kernel-parameters.rst
Example of boot setup command under lilo prompt: Example of boot setup command under lilo prompt::
lilo: linux root=/dev/sda2 sym53c8xx.cmd_per_lun=4 sym53c8xx.sync=10 sym53c8xx.debug=0x200 lilo: linux root=/dev/sda2 sym53c8xx.cmd_per_lun=4 sym53c8xx.sync=10 sym53c8xx.debug=0x200
@@ -438,52 +504,84 @@ lilo: linux root=/dev/sda2 sym53c8xx.cmd_per_lun=4 sym53c8xx.sync=10 sym53c8xx.d
- set DEBUG_NEGO flag. - set DEBUG_NEGO flag.
The following command will install the driver module with the same The following command will install the driver module with the same
options as above. options as above::
modprobe sym53c8xx cmd_per_lun=4 sync=10 debug=0x200 modprobe sym53c8xx cmd_per_lun=4 sync=10 debug=0x200
10.2 Available arguments 10.2 Available arguments
------------------------
10.2.1 Default number of tagged commands 10.2.1 Default number of tagged commands
cmd_per_lun=0 (or cmd_per_lun=1) tagged command queuing disabled ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
cmd_per_lun=#tags (#tags > 1) tagged command queuing enabled - cmd_per_lun=0 (or cmd_per_lun=1) tagged command queuing disabled
- cmd_per_lun=#tags (#tags > 1) tagged command queuing enabled
#tags will be truncated to the max queued commands configuration parameter. #tags will be truncated to the max queued commands configuration parameter.
10.2.2 Burst max 10.2.2 Burst max
^^^^^^^^^^^^^^^^
========== ======================================================
burst=0 burst disabled burst=0 burst disabled
burst=255 get burst length from initial IO register settings. burst=255 get burst length from initial IO register settings.
burst=#x burst enabled (1<<#x burst transfers max) burst=#x burst enabled (1<<#x burst transfers max)
#x is an integer value which is log base 2 of the burst transfers max.
#x is an integer value which is log base 2 of the burst
transfers max.
========== ======================================================
By default the driver uses the maximum value supported by the chip. By default the driver uses the maximum value supported by the chip.
10.2.3 LED support 10.2.3 LED support
^^^^^^^^^^^^^^^^^^
===== ===================
led=1 enable LED support led=1 enable LED support
led=0 disable LED support led=0 disable LED support
===== ===================
Do not enable LED support if your scsi board does not use SDMS BIOS. Do not enable LED support if your scsi board does not use SDMS BIOS.
(See 'Configuration parameters') (See 'Configuration parameters')
10.2.4 Differential mode 10.2.4 Differential mode
^^^^^^^^^^^^^^^^^^^^^^^^
====== =================================
diff=0 never set up diff mode diff=0 never set up diff mode
diff=1 set up diff mode if BIOS set it diff=1 set up diff mode if BIOS set it
diff=2 always set up diff mode diff=2 always set up diff mode
diff=3 set diff mode if GPIO3 is not set diff=3 set diff mode if GPIO3 is not set
====== =================================
10.2.5 IRQ mode 10.2.5 IRQ mode
^^^^^^^^^^^^^^^
====== ================================================
irqm=0 always open drain irqm=0 always open drain
irqm=1 same as initial settings (assumed BIOS settings) irqm=1 same as initial settings (assumed BIOS settings)
irqm=2 always totem pole irqm=2 always totem pole
====== ================================================
10.2.6 Check SCSI BUS 10.2.6 Check SCSI BUS
^^^^^^^^^^^^^^^^^^^^^
buschk=<option bits> buschk=<option bits>
Available option bits: Available option bits:
0x0: No check.
0x1: Check and do not attach the controller on error. === ================================================
0x2: Check and just warn on error. 0x0 No check.
0x1 Check and do not attach the controller on error.
0x2 Check and just warn on error.
=== ================================================
10.2.7 Suggest a default SCSI id for hosts 10.2.7 Suggest a default SCSI id for hosts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
========== ==========================================
hostid=255 no id suggested. hostid=255 no id suggested.
hostid=#x (0 < x < 7) x suggested for hosts SCSI id. hostid=#x (0 < x < 7) x suggested for hosts SCSI id.
========== ==========================================
If a host SCSI id is available from the NVRAM, the driver will ignore If a host SCSI id is available from the NVRAM, the driver will ignore
any value suggested as boot option. Otherwise, if a suggested value any value suggested as boot option. Otherwise, if a suggested value
@@ -492,14 +590,25 @@ options as above.
7 if the hardware value is zero. 7 if the hardware value is zero.
10.2.8 Verbosity level 10.2.8 Verbosity level
^^^^^^^^^^^^^^^^^^^^^^^
====== ========
verb=0 minimal verb=0 minimal
verb=1 normal verb=1 normal
verb=2 too much verb=2 too much
====== ========
10.2.9 Debug mode 10.2.9 Debug mode
^^^^^^^^^^^^^^^^^
========= ====================================
debug=0 clear debug flags debug=0 clear debug flags
debug=#x set debug flags debug=#x set debug flags
#x is an integer value combining the following power-of-2 values:
#x is an integer value combining the
following power-of-2 values:
============= ======
DEBUG_ALLOC 0x1 DEBUG_ALLOC 0x1
DEBUG_PHASE 0x2 DEBUG_PHASE 0x2
DEBUG_POLL 0x4 DEBUG_POLL 0x4
@@ -513,30 +622,48 @@ options as above.
DEBUG_TAGS 0x400 DEBUG_TAGS 0x400
DEBUG_FREEZE 0x800 DEBUG_FREEZE 0x800
DEBUG_RESTART 0x1000 DEBUG_RESTART 0x1000
============= ======
========= ====================================
You can play safely with DEBUG_NEGO. However, some of these flags may You can play safely with DEBUG_NEGO. However, some of these flags may
generate bunches of syslog messages. generate bunches of syslog messages.
10.2.10 Settle delay 10.2.10 Settle delay
^^^^^^^^^^^^^^^^^^^^
======== ===================
settle=n delay for n seconds settle=n delay for n seconds
======== ===================
After a bus reset, the driver will delay for n seconds before talking After a bus reset, the driver will delay for n seconds before talking
to any device on the bus. The default is 3 seconds and safe mode will to any device on the bus. The default is 3 seconds and safe mode will
default it to 10. default it to 10.
10.2.11 Serial NVRAM 10.2.11 Serial NVRAM
NB: option not currently implemented. ^^^^^^^^^^^^^^^^^^^^
.. Note:: option not currently implemented.
======= =========================================
nvram=n do not look for serial NVRAM nvram=n do not look for serial NVRAM
nvram=y test controllers for onboard serial NVRAM nvram=y test controllers for onboard serial NVRAM
======= =========================================
(alternate binary form) (alternate binary form)
nvram=<bits options> nvram=<bits options>
==== =================================================================
0x01 look for NVRAM (equivalent to nvram=y) 0x01 look for NVRAM (equivalent to nvram=y)
0x02 ignore NVRAM "Synchronous negotiation" parameters for all devices 0x02 ignore NVRAM "Synchronous negotiation" parameters for all devices
0x04 ignore NVRAM "Wide negotiation" parameter for all devices 0x04 ignore NVRAM "Wide negotiation" parameter for all devices
0x08 ignore NVRAM "Scan at boot time" parameter for all devices 0x08 ignore NVRAM "Scan at boot time" parameter for all devices
0x80 also attach controllers set to OFF in the NVRAM (sym53c8xx only) 0x80 also attach controllers set to OFF in the NVRAM (sym53c8xx only)
==== =================================================================
10.2.12 Exclude a host from being attached 10.2.12 Exclude a host from being attached
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
excl=<io_address>,... excl=<io_address>,...
Prevent host at a given io address from being attached. Prevent host at a given io address from being attached.
@@ -544,20 +671,25 @@ options as above.
driver not to attach hosts at address 0xb400 and 0xc000. driver not to attach hosts at address 0xb400 and 0xc000.
10.3 Converting from old style options 10.3 Converting from old style options
--------------------------------------
Previously, the sym2 driver accepted arguments of the form::
Previously, the sym2 driver accepted arguments of the form
sym53c8xx=tags:4,sync:10,debug:0x200 sym53c8xx=tags:4,sync:10,debug:0x200
As a result of the new module parameters, this is no longer available. As a result of the new module parameters, this is no longer available.
Most of the options have remained the same, but tags has become Most of the options have remained the same, but tags has become
cmd_per_lun to reflect its different purposes. The sample above would cmd_per_lun to reflect its different purposes. The sample above would
be specified as: be specified as::
modprobe sym53c8xx cmd_per_lun=4 sync=10 debug=0x200 modprobe sym53c8xx cmd_per_lun=4 sync=10 debug=0x200
or on the kernel boot line as: or on the kernel boot line as::
sym53c8xx.cmd_per_lun=4 sym53c8xx.sync=10 sym53c8xx.debug=0x200 sym53c8xx.cmd_per_lun=4 sym53c8xx.sync=10 sym53c8xx.debug=0x200
10.4 SCSI BUS checking boot option. 10.4 SCSI BUS checking boot option
----------------------------------
When this option is set to a non-zero value, the driver checks SCSI lines When this option is set to a non-zero value, the driver checks SCSI lines
logic state, 100 micro-seconds after having asserted the SCSI RESET line. logic state, 100 micro-seconds after having asserted the SCSI RESET line.
@@ -565,15 +697,19 @@ The driver just reads SCSI lines and checks all lines read FALSE except RESET.
Since SCSI devices shall release the BUS at most 800 nano-seconds after SCSI Since SCSI devices shall release the BUS at most 800 nano-seconds after SCSI
RESET has been asserted, any signal to TRUE may indicate a SCSI BUS problem. RESET has been asserted, any signal to TRUE may indicate a SCSI BUS problem.
Unfortunately, the following common SCSI BUS problems are not detected: Unfortunately, the following common SCSI BUS problems are not detected:
- Only 1 terminator installed. - Only 1 terminator installed.
- Misplaced terminators. - Misplaced terminators.
- Bad quality terminators. - Bad quality terminators.
On the other hand, either bad cabling, broken devices, not conformant On the other hand, either bad cabling, broken devices, not conformant
devices, ... may cause a SCSI signal to be wrong when te driver reads it. devices, ... may cause a SCSI signal to be wrong when te driver reads it.
15. SCSI problem troubleshooting 15. SCSI problem troubleshooting
================================
15.1 Problem tracking 15.1 Problem tracking
---------------------
Most SCSI problems are due to a non conformant SCSI bus or too buggy Most SCSI problems are due to a non conformant SCSI bus or too buggy
devices. If unfortunately you have SCSI problems, you can check the devices. If unfortunately you have SCSI problems, you can check the
@@ -607,16 +743,17 @@ hard disks. Good SCSI hard disks with a large cache gain advantage of
tagged commands queuing. tagged commands queuing.
15.2 Understanding hardware error reports 15.2 Understanding hardware error reports
-----------------------------------------
When the driver detects an unexpected error condition, it may display a When the driver detects an unexpected error condition, it may display a
message of the following pattern. message of the following pattern::
sym0:1: ERROR (0:48) (1-21-65) (f/95/0) @ (script 7c0:19000000). sym0:1: ERROR (0:48) (1-21-65) (f/95/0) @ (script 7c0:19000000).
sym0: script cmd = 19000000 sym0: script cmd = 19000000
sym0: regdump: da 10 80 95 47 0f 01 07 75 01 81 21 80 01 09 00. sym0: regdump: da 10 80 95 47 0f 01 07 75 01 81 21 80 01 09 00.
Some fields in such a message may help you understand the cause of the Some fields in such a message may help you understand the cause of the
problem, as follows: problem, as follows::
sym0:1: ERROR (0:48) (1-21-65) (f/95/0) @ (script 7c0:19000000). sym0:1: ERROR (0:48) (1-21-65) (f/95/0) @ (script 7c0:19000000).
.....A.........B.C....D.E..F....G.H..I.......J.....K...L....... .....A.........B.C....D.E..F....G.H..I.......J.....K...L.......
@@ -626,32 +763,38 @@ Field A : target number.
error occurs. error occurs.
Field B : DSTAT io register (DMA STATUS) Field B : DSTAT io register (DMA STATUS)
Bit 0x40 : MDPE Master Data Parity Error ======== =============================================================
Bit 0x40 MDPE Master Data Parity Error
Data parity error detected on the PCI BUS. Data parity error detected on the PCI BUS.
Bit 0x20 : BF Bus Fault Bit 0x20 BF Bus Fault
PCI bus fault condition detected PCI bus fault condition detected
Bit 0x01 : IID Illegal Instruction Detected Bit 0x01 IID Illegal Instruction Detected
Set by the chip when it detects an Illegal Instruction format Set by the chip when it detects an Illegal Instruction format
on some condition that makes an instruction illegal. on some condition that makes an instruction illegal.
Bit 0x80 : DFE Dma Fifo Empty Bit 0x80 DFE Dma Fifo Empty
Pure status bit that does not indicate an error. Pure status bit that does not indicate an error.
======== =============================================================
If the reported DSTAT value contains a combination of MDPE (0x40), If the reported DSTAT value contains a combination of MDPE (0x40),
BF (0x20), then the cause may be likely due to a PCI BUS problem. BF (0x20), then the cause may be likely due to a PCI BUS problem.
Field C : SIST io register (SCSI Interrupt Status) Field C : SIST io register (SCSI Interrupt Status)
Bit 0x08 : SGE SCSI GROSS ERROR ======== ==================================================================
Bit 0x08 SGE SCSI GROSS ERROR
Indicates that the chip detected a severe error condition Indicates that the chip detected a severe error condition
on the SCSI BUS that prevents the SCSI protocol from functioning on the SCSI BUS that prevents the SCSI protocol from functioning
properly. properly.
Bit 0x04 : UDC Unexpected Disconnection Bit 0x04 UDC Unexpected Disconnection
Indicates that the device released the SCSI BUS when the chip Indicates that the device released the SCSI BUS when the chip
was not expecting this to happen. A device may behave so to was not expecting this to happen. A device may behave so to
indicate the SCSI initiator that an error condition not reportable using the SCSI protocol has occurred. indicate the SCSI initiator that an error condition not reportable using the SCSI protocol has occurred.
Bit 0x02 : RST SCSI BUS Reset Bit 0x02 RST SCSI BUS Reset
Generally SCSI targets do not reset the SCSI BUS, although any Generally SCSI targets do not reset the SCSI BUS, although any
device on the BUS can reset it at any time. device on the BUS can reset it at any time.
Bit 0x01 : PAR Parity Bit 0x01 PAR Parity
SCSI parity error detected. SCSI parity error detected.
======== ==================================================================
On a faulty SCSI BUS, any error condition among SGE (0x08), UDC (0x04) and On a faulty SCSI BUS, any error condition among SGE (0x08), UDC (0x04) and
PAR (0x01) may be detected by the chip. If your SCSI system sometimes PAR (0x01) may be detected by the chip. If your SCSI system sometimes
encounters such error conditions, especially SCSI GROSS ERROR, then a SCSI encounters such error conditions, especially SCSI GROSS ERROR, then a SCSI
@@ -659,6 +802,7 @@ Field C : SIST io register (SCSI Interrupt Status)
For fields D,E,F,G and H, you may look into the sym53c8xx_defs.h file For fields D,E,F,G and H, you may look into the sym53c8xx_defs.h file
that contains some minimal comments on IO register bits. that contains some minimal comments on IO register bits.
Field D : SOCL Scsi Output Control Latch Field D : SOCL Scsi Output Control Latch
This register reflects the state of the SCSI control lines the This register reflects the state of the SCSI control lines the
chip want to drive or compare against. chip want to drive or compare against.
@@ -681,8 +825,10 @@ You are not required to decode and understand them, unless you want to help
maintain the driver code. maintain the driver code.
17. Serial NVRAM (added by Richard Waltham: dormouse@farsrobt.demon.co.uk) 17. Serial NVRAM (added by Richard Waltham: dormouse@farsrobt.demon.co.uk)
==========================================================================
17.1 Features 17.1 Features
-------------
Enabling serial NVRAM support enables detection of the serial NVRAM included Enabling serial NVRAM support enables detection of the serial NVRAM included
on Symbios and some Symbios compatible host adaptors, and Tekram boards. The on Symbios and some Symbios compatible host adaptors, and Tekram boards. The
@@ -706,18 +852,33 @@ adaptors but does not cause problems either.)
The parameters the driver is able to get from the NVRAM depend on the The parameters the driver is able to get from the NVRAM depend on the
data format used, as follow: data format used, as follow:
Tekram format Symbios format +-------------------------------+------------------+--------------+
General and host parameters | |Tekram format |Symbios format|
Boot order N Y +-------------------------------+------------------+--------------+
Host SCSI ID Y Y |General and host parameters | | |
SCSI parity checking Y Y +-------------------------------+------------------+--------------+
Verbose boot messages N Y | * Boot order | N | Y |
SCSI devices parameters +-------------------------------+------------------+--------------+
Synchronous transfer speed Y Y | * Host SCSI ID | Y | Y |
Wide 16 / Narrow Y Y +-------------------------------+------------------+--------------+
Tagged Command Queuing enabled Y Y | * SCSI parity checking | Y | Y |
Disconnections enabled Y Y +-------------------------------+------------------+--------------+
Scan at boot time N Y | * Verbose boot messages | N | Y |
+-------------------------------+------------------+--------------+
|SCSI devices parameters |
+-------------------------------+------------------+--------------+
| * Synchronous transfer speed | Y | Y |
+-------------------------------+------------------+--------------+
| * Wide 16 / Narrow | Y | Y |
+-------------------------------+------------------+--------------+
| * Tagged Command Queuing | Y | Y |
| enabled | | |
+-------------------------------+------------------+--------------+
| * Disconnections enabled | Y | Y |
+-------------------------------+------------------+--------------+
| * Scan at boot time | N | Y |
+-------------------------------+------------------+--------------+
In order to speed up the system boot, for each device configured without In order to speed up the system boot, for each device configured without
the "scan at boot time" option, the driver forces an error on the the "scan at boot time" option, the driver forces an error on the
@@ -725,9 +886,10 @@ first TEST UNIT READY command received for this device.
17.2 Symbios NVRAM layout 17.2 Symbios NVRAM layout
-------------------------
typical data at NVRAM address 0x100 (53c810a NVRAM)::
typical data at NVRAM address 0x100 (53c810a NVRAM)
-----------------------------------------------------------
00 00 00 00
64 01 64 01
8e 0b 8e 0b
@@ -782,14 +944,18 @@ typical data at NVRAM address 0x100 (53c810a NVRAM)
fe fe fe fe
00 00 00 00
00 00 00 00
-----------------------------------------------------------
NVRAM layout details NVRAM layout details
NVRAM Address 0x000-0x0ff not used ============= =================
NVRAM Address
============= =================
0x000-0x0ff not used
0x100-0x26f initialised data 0x100-0x26f initialised data
0x270-0x7ff not used 0x270-0x7ff not used
============= =================
general layout general layout::
header - 6 bytes, header - 6 bytes,
data - 356 bytes (checksum is byte sum of this data) data - 356 bytes (checksum is byte sum of this data)
@@ -797,7 +963,7 @@ general layout
--- ---
total 368 bytes total 368 bytes
data area layout data area layout::
controller set up - 20 bytes controller set up - 20 bytes
boot configuration - 56 bytes (4x14 bytes) boot configuration - 56 bytes (4x14 bytes)
@@ -806,14 +972,13 @@ data area layout
--- ---
total 356 bytes total 356 bytes
----------------------------------------------------------- header::
header
00 00 - ?? start marker 00 00 - ?? start marker
64 01 - byte count (lsb/msb excludes header/trailer) 64 01 - byte count (lsb/msb excludes header/trailer)
8e 0b - checksum (lsb/msb excludes header/trailer) 8e 0b - checksum (lsb/msb excludes header/trailer)
-----------------------------------------------------------
controller set up controller set up::
00 30 00 00 00 00 07 00 00 00 00 00 00 00 07 04 10 04 00 00 00 30 00 00 00 00 07 00 00 00 00 00 00 00 07 04 10 04 00 00
| | | | | | | |
@@ -837,10 +1002,10 @@ current set up for any of the controllers.
default set up is identical for 53c810a and 53c875 NVRAM default set up is identical for 53c810a and 53c875 NVRAM
(Removable Media added Symbios BIOS version 4.09) (Removable Media added Symbios BIOS version 4.09)
-----------------------------------------------------------
boot configuration boot configuration
boot order set by order of the devices in this table boot order set by order of the devices in this table::
04 00 0f 00 00 10 00 50 00 00 01 00 00 62 -- 1st controller 04 00 0f 00 00 10 00 50 00 00 01 00 00 62 -- 1st controller
04 00 03 00 00 10 00 58 00 00 01 00 00 63 2nd controller 04 00 03 00 00 10 00 58 00 00 01 00 00 63 2nd controller
@@ -859,8 +1024,8 @@ remaining bytes unknown - they do not appear to change in my
current set up current set up
default set up is identical for 53c810a and 53c875 NVRAM default set up is identical for 53c810a and 53c875 NVRAM
-----------------------------------------------------------
device set up (up to 16 devices - includes controller) device set up (up to 16 devices - includes controller)::
0f 00 08 08 64 00 0a 00 - id 0 0f 00 08 08 64 00 0a 00 - id 0
0f 00 08 08 64 00 0a 00 0f 00 08 08 64 00 0a 00
@@ -903,11 +1068,13 @@ current set up
(but it could be max bus width) (but it could be max bus width)
default set up for 53c810a NVRAM default set up for 53c810a NVRAM
default set up for 53c875 NVRAM - bus width - 0x10 default set up for 53c875 NVRAM
- bus width - 0x10
- sync offset ? - 0x10 - sync offset ? - 0x10
- sync period - 0x30 - sync period - 0x30
-----------------------------------------------------------
?? spare device space (32 bit bus ??) ?? spare device space (32 bit bus ??)::
00 00 00 00 00 00 00 00 (19x8bytes) 00 00 00 00 00 00 00 00 (19x8bytes)
. .
@@ -915,23 +1082,21 @@ default set up for 53c875 NVRAM - bus width - 0x10
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
default set up is identical for 53c810a and 53c875 NVRAM default set up is identical for 53c810a and 53c875 NVRAM
-----------------------------------------------------------
trailer trailer::
fe fe - ? end marker ? fe fe - ? end marker ?
00 00 00 00
00 00 00 00
default set up is identical for 53c810a and 53c875 NVRAM default set up is identical for 53c810a and 53c875 NVRAM
-----------------------------------------------------------
17.3 Tekram NVRAM layout 17.3 Tekram NVRAM layout
------------------------
nvram 64x16 (1024 bit) nvram 64x16 (1024 bit)
Drive settings Drive settings::
Drive ID 0-15 (addr 0x0yyyy0 = device setup, yyyy = ID) Drive ID 0-15 (addr 0x0yyyy0 = device setup, yyyy = ID)
(addr 0x0yyyy1 = 0x0000) (addr 0x0yyyy1 = 0x0000)
@@ -972,7 +1137,7 @@ Drive ID 0-15 (addr 0x0yyyy0 = device setup, yyyy = ID)
Global settings Global settings
Host flags 0 (addr 0x100000, 32) Host flags 0 (addr 0x100000, 32)::
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
| | | | | | | | | | | | | | | | | | | | | | | |
@@ -1000,7 +1165,7 @@ Host flags 0 (addr 0x100000, 32)
as BIOS dev 1 - boot device as BIOS dev 1 - boot device
2 - all 2 - all
Host flags 1 (addr 0x100001, 33) Host flags 1 (addr 0x100001, 33)::
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
| | | | | | | | | | | |
@@ -1018,7 +1183,7 @@ Host flags 1 (addr 0x100001, 33)
3 - 16 3 - 16
4 - 32 4 - 32
Host flags 2 (addr 0x100010, 34) Host flags 2 (addr 0x100010, 34)::
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
| |
@@ -1031,7 +1196,7 @@ checksum = 0x1234 - (sum addr 0-63)
---------------------------------------------------------------------------- ----------------------------------------------------------------------------
default nvram data: default nvram data::
0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000
0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000 0x0037 0x0000
@@ -1042,7 +1207,3 @@ default nvram data:
0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000
0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000
0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0xfbbc 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0xfbbc
===============================================================================
End of Linux SYM-2 driver documentation file

2
drivers/scsi/Kconfig
View File

@@ -921,7 +921,7 @@ config SCSI_SYM53C8XX_2
language. It does not support LSI53C10XX Ultra-320 PCI-X SCSI language. It does not support LSI53C10XX Ultra-320 PCI-X SCSI
controllers; you need to use the Fusion MPT driver for that. controllers; you need to use the Fusion MPT driver for that.
Please read <file:Documentation/scsi/sym53c8xx_2.txt> for more Please read <file:Documentation/scsi/sym53c8xx_2.rst> for more
information. information.
config SCSI_SYM53C8XX_DMA_ADDRESSING_MODE config SCSI_SYM53C8XX_DMA_ADDRESSING_MODE