Adapter Device Driver Command-Line Parameters

From EDM2
Jump to: navigation, search
Storage Device Driver Reference
  1. About This Book
  2. Introduction to DASD, SCSI, and CD-ROM Programming Interfaces
  3. Installation of OS/2, DASD, SCSI, and CD-ROM Device Drivers
  4. Adapter Device Driver Development Considerations
  5. DASD, SCSI, and CD-ROM Device Manager Interface Specification
  6. Error Handling
  7. Adapter Device Driver Command-Line Parameters
  8. DASD IOCtl Device Driver Test Tool
  9. Optical IOCtl Device Driver Test Tool
  10. Using Filter Device Drivers
  11. Library and Services
  12. CD-ROM Device Manager Interface Specification
  13. CD-ROM Device Driver Test Tool
  14. Building an OS/2 Virtual Disk Driver
  15. OS2DASD.DMD - Technical Reference
  16. Boot Record Architecture
  17. Extended Device Driver Interface Specification
  18. I/O Request Block - C Definitions
  19. OS/2 SCSI Device Driver Interface Specification
  20. Advanced SCSI Programming Interface (ASPI) OS/2 Specification
  21. Adapter Device Driver Interface Questions and Answers
  22. Device Driver Test Tool (DDTT)
  23. Glossary

Reprint Courtesy of International Business Machines Corporation, © International Business Machines Corporation

Following is a diagram of an adapter device driver command-line structure:

BASEDEV=AddName.ADD──►

──►Driver-Parameters──►Adapter-Parameters──►Unit-Parameters─┬┐
                     ▲                    ▲                 ││
                     │                    └─────────────────┘│
                     └───────────────────────────────────────┘

Syntax Conventions

Following are the adapter device driver syntax conventions:

  • Command-line contents are case-insensitive.
  • All command-line options begin with the slash character (/).
  • The exclamation character (!) is a negation operator; that is, it negates the option that follows it. The colon character (:) indicates that a list of one or more unit IDs follows the option.
    *The alphabetic dcharacter (<d>) indicates a decimal digit.
    *The alphabetic hcharacter (<h>) indicates a hexadecimal digit.

Command-Line Parameter Classes

An adapter device driver command line contains three classes of parameters:

  • Adapter Device Driver Parameters
    Adapter device driver parametersapply to all adapters and units managed by an adapter device driver unless overridden by adapter parameters or unit parameters.
  • Adapter Parameters
    Adapter parametersbegin with the (/A) switch and identify a specific adapter card. Parameters following the (/A) switch apply only to the adapter card indicated.
  • Unit Parameters
    Unit parametersapply specific units on an adapter.

Note: In some cases, a parameter may appear as both an Adapter parameter and a Unit parameter. If the host adapter hardware supports specifying a parameter on a per-unit basis, then it is recommended that the adapter device driver support both the per-Adapter and per-Unit forms of the parameter.

SCSI-Specific Parameters

The following diagram illustrates a SCSI adapter device driver parameter structure:

SCSI-Driver-Parameters::= ─┬── /<!>SN ───────────────────►
                           ├── /<!>ET ─►▲
                           ├── /V     ─►│
                           └────────────┘

SCSI-Adapter-Parameters::=
         ───► /A:d ─┬── /S:d   ────┬── /<!>DM ─────►
                    ├── /P:hhhh─►▲ ├── /<!>SN ─►▲
                    └────────────┘ ├── /<!>SN ─►│
                                   ├── /<!>ET ─►│
                                   ├── /I     ─►│
                                   └────────────┘

SCSI-Unit-Parameters::= ──┬── /<!>DM  ────────────┬─────►
                         ▲├── /<!>SM  ─►▲         │
                         │├── /<!>SN  ─►│         │
                         │├── /<!>ET  ─►│         │
                         │├── /<!>HCR ─►│         │
                         │├── /<!>HCW ─►│         │
                         │└─────────────┘         │
                         └────────────────────────┘

SCSI-Target-IDs::=      ─┬┬── d     ──┬┬────────► (d=0-7)
                         │└── (d,d) ──┘│
                         └─── ,     ───┘

Note: All SCSI adapter device drivers must support the following parameters:

/V Verbose
/A Adapter Identification
/DM Enable/Disable DASD Manager Support
/SM Enable/Disable SCSI Manager Support

To insure support of various CD-ROM drives the implementation of the following parameters is recommended:

/SN Enable/Disable Synchronous Negotiation
/ET Enable/Disable Embedded Target Support

Support of the remaining parameters is optional.

SCSI Adapter Device Driver Parameters

/SNSynchronous Negotiation

This parameter indicates a SCSI Host Adapter should attempt to initiate synchronous data transfers. Negating this parameter (/!SN) indicates that the SCSI Host Adapter must not attempt to initiate synchronous data transfers.

/ETEmbedded Targets

This parameter indicates that the adapter device driver must search each SCSI Target for logical units. Negating this parameter (/!ET) indicates that the adapter device driver should only check LUN 0 on each SCSI Target regardless of whether additional Logical Units are present.

/VVerbose

This parameter indicates that the adapter device driver must display diagnostic information during the OS/2 system initialization. The DevHlp_Save_Message device help routine should be used to display this information.

The following format for the displayed information is recommended:

XYZ-2010 OS/2 2.0 Driver (yymmdd)
Copyright (c) 1993 XYZ Inc. All Rights Reserved
 Adapter: 0 Base Port: 0123  IRQ: 10
  Target: 0 LUN: 0  SCSI_Inquiry_Data (Bytes 8-35)
  Target: 1 LUN: 0  SCSI_Inquiry_Data
  Target: 2 LUN: 0  SCSI_Inquiry_Data

/A:dAdapter Index

This parameter specifies the ordering of adapters in the DEVICETABLE returned by the adapter device driver. Normally, adapters are numbered consecutively, starting at 0.

/S:dAdapter Slot ID

For host systems with individually addressable slots, the adapter device driver can designate the location of a host adapter by its slot number, according to the host system's slot addressing scheme. Typically <d> is a small 0-based number specifying the host system slot.

/P::hhhhAdapter Base I/O Port Address

For host systems with non-addressable slots, the adapter device driver can designate the location of a host adapter by its base I/O port address. Typically, <hhhh> is a 3-4 digit hexadecimal number.

Note: In cases where a specific adapter designation is not made, the adapter device driver can apply its own ordering, based on either the base I/O port address or the physical slot address.

Note: In general, an adapter device driver should choose to support only one of the above addressing methods. If an adapter device driver supports more than one addressing method, it must not permit a mix of addressing methods on a single line.

/DMDASD Manager Support

This parameter indicates that this unit must be supported by the IBM-supplied DASD device manager (OS2DASD.DMD). If this parameter is not specified, the default is to permit DASD device manager support. If this parameter is negated, the adapter device driver must set the UF_NODASD_SUPT flag in the UnitFlags field of the DEVICETABLE entry for the device. This parameter is used in conjunction with an OEM-supplied device manager to permit control of specific DASD and SCSI targets.

/SMSCSI Manager Support

This parameter indicates that this unit must be supported by the IBM-supplied SCSI device manager (OS2SCSI.DMD). If this parameter is not specified, the default setting is to permit SCSI device manager support. If this parameter is negated, the adapter device driver must set the UF_NOSCSI_SUPT flag in the UnitFlags field of the DEVICETABLE entry for the device. This parameter is used in conjunction with an OEM-supplied device manager to permit control of specific non-DASD and non-SCSI targets.

/IIgnore Adapter

This parameter indicates that adapter device driver should treat the indicated adapter as an uninstalled adapter. The purpose of this parameter is to allow third party software to manage an entire adapter that would normally be managed by the adapter device driver. When specified, the driver must not create a device table entry for the indicated adapter.

/HCWEnable Hardware Write Caching

This parameter is used to control adapter-implemented deferred-write caching for those adapters that support it. If this parameter is not specified, this feature must be enabled. If this parameter is negated, deferred write caching must be disabled on the specified units. Host adapters that do not implement on-board caching, or that do not have direct control over the operation of the cache, must ignore this parameter if specified.

/HCREnable Hardware Read Caching

This parameter is used to control adapter-implemented Read caching for those adapters that support it. If this parameter is not specified, this feature must be enabled. If this parameter is negated, Read caching must be disabled on the specified units. Host adapters that do not implement on-board caching, or do not have direct control over the operation of the cache, must ignore this parameter if specified.

d,d...SCSI Embedded Target ID

The above parameters can be followed by a colon (:) with a list of SCSI target IDs, separated by commas. The logical unit number (LUN) for the specified SCSI target is presumed to be 0.

(d,d),(d,d)...SCSI Target/LUN ID

The above parameters can be followed by a colon (:) with a list of SCSI target/LUN pairs in parentheses.

Diskette-Specific Parameters

The following diagram illustrates a diskette-specific adapter device driver parameter structure:

Diskette-Driver-Parameters::= ─┬── /MCA ─────────────────────►
                               │          ▲
                               └──────────┘
Diskette-Adapter-Parameters::=
                   ───► /A:d ──┬────────────────┬──────┬─────►
                              ▲├── /DMZ:d     ─►│      │
                              │├── /IRQ:dd    ─►│      │
                              │├── /PORT:hhhh ─►│      │
                              │└────────────────┘      │
                              └────────────────────────┘

Diskette-Unit-Parameters::=
                   ───► /U:d ──┬─► /<!>AHS             ──┬┬┬─►
                    ▲         ▲├── /F:Drive Capacity   ─►│││
                    │         │├── /SPEC:Specify-Bytes ─►│││
                    │         │├── /CL:Changeline-Type ─►│││
                    │         │└─────────────────────────┘││
                    │         └───────────────────────────┘│
                    └──────────────────────────────────────┘

Drive Capacity  =  ────────────┬── 360KB  ───────────────────►
                               ├── 1.2MB  ─►▲
                               ├── 720KB  ──│
                               ├── 1.44MB ─►│
                               ├── 2.88MB ─►│
                               └────────────┘

Specify-Bytes   =  ──────────────► hh,hh  ───────────────────►


Changeline-Type =  ───────────┬┬─► /AT  ──┬┬─────────────────►
                              │└── /PS2 ──┘│
                              └─── None ───┘

Diskette Adapter Device Driver Parameters

/MCAInstall Adapter Device Driver on uChannel machines

This parameter informs the IBM1FLPY adapter device driver to install on uChannel machines. The default is not to install on uChannel machines.

/DMA:dDMA Channel Number

This parameter specifies the DMA channel number that must be used for the diskette adapter. DMA Channel 2 is used if this parameter is not specified.

/IRQ:ddInterrupt Level

This parameter specifies the interrupt level that must be used for the diskette adapter. IRQ 6 is used if this parameter is not specified.

/U:dUnit Number

This parameter specifies the diskette drive number to which options following this parameter apply. Diskette drive numbers start at 0.

Note: To define a third diskette drive on a controller, the /U and /F parameters must be specified.

/AHSAutomatic Head Switch

This parameter informs the driver to use a diskette controller feature that automatically switches from Head 0 -> 1. This improves performance by reading both sides of the diskette in a single operation. The default is to enable this option. It may be disabled by negating this parameter.

/F:ccccDrive Capacity

This parameter overrides the BIOS-supplied drive capacity information, enabling the use of drives that the host system's BIOS does not properly recognize. The drive capacity must be suffixed by a (KB) or an (MB).

/SPEC:hh,hhDrive Specify Bytes

This parameter permits the setting of diskette controller specify bytes. This is used for drives with unusual or non-standard timing requirements. The correct setting of this parameter varies with drive manufacturers and must be obtained from the drive vendor.

/CL:cltChangeline Type

This parameter permits changing the interpretation of the media change detection signals. The changeline signal can be interpreted according to PC-AT* or PS/2* standards; or checking of the changeline signal can be disabled using this parameter.

ST-506/IDE-Specific Parameters

The following diagram illustrates a ST-506/IDE unit parameter structure:

ST-506-Driver-Parameters::= ─┬─► /V ─────────────────────►
                             │        ▲
                             └────────┘
ST-506-Adapter-Parameters::=
       ──► /A:d ───┬──────────────────────────┬──────────►
                 ▲ ├── /I         ─►▲         │
                 │ ├── /<!>R      ─►│         │
                 │ ├── /IRQ:dd    ─►│         │
                 │ ├── /PORT:hhhh ─►│         │
                 │ └────────────────┘         │
                 └────────────────────────────┘

ST-506-Unit-Parameters::=
      ───► /U:d ───┬─► /GEO ─┬─► dd               ──┬┬┬┬─►
       ▲          ▲│         ├── (dddd,dddd,dddd) ─►││││
       │          ││         └──────────────────────┘│││
       │          │├── /T:dddd  ─────────────────────┤││
       │          │├── /SMS     ─────────────────────┤││
       │          │└── /LBA     ─────────────────────┘││
       │          └───────────────────────────────────┘│
       └───────────────────────────────────────────────┘

ST-506/IDE Adapter Device Driver Parameters

/V Verbose - Display driver information
This parameter displays the adapter device driver level, disk controller status and drive geometry information during the OS/2 system initialization.
/I Ignore Adapter
This parameter indicates that the IBM1S506 driver should not attempt to initialize the adapter indicated.
This adapter device driver automatically attempts to locate and initialize both the primary and secondary adapters. In some cases other DASD controllers may appear between the primary and secondary IDE controllers. In these cases the system should be configured as follows:
BASEDEV=IBM1S506.ADD /V /A:1 /I
BASEDEV=MOREDASD.ADD
BASEDEV=IBM1S506.ADD /V /A:0 /I
/<!>R Reset Adapter
If this parameter is negated (/!R), adapter resets are disabled. In most cases resets are beneficial to assist in recovering from transient hardware problems such as lost interrupts, timeouts, or commands a particular adapter may not support.
However, for some ESDI adapters, options set by vendor unique commands such as "Sector Sparing" may be lost after a reset. Setting this switch is recommended for ESDI adapters with disks formatted using "Sector Sparing".

/IRQ:dd Interrupt Level

This parameter overrides the default IRQ Number for the adapter indicated. The default IRQ address for Adapter 0 is (14) and for Adapter 1 is (15).

/U:d Unit Number

This parameter specifies the fixed disk drive number to which options following this parameter apply. Fixed disk drive numbers start at 0.

/GEO Drive Geometry

This parameter overrides the Cylinder/Head/Sector geometry for the unit selected. The fourth parameter is the Write Precompensation Cylinder which may be omitted for drives which do not require precompensation. As an alternate format standard BIOS drive types may be used. Types (0-47) are supported. User defined types 47-49 should be entered directly by in the previous format. If a second set of geometry is present, then the first set specifies the physical geometry of the drive, and the second set indicates the translated geometry which is reported to the OS/2 system.

/T:dddd Drive Timeout

This parameter indicates the total allowable error recover time for a request. Error recovery times < 5 seconds will be ignored. This parameter defaults to 30 seconds. A shorter interval may be desirable for fault tolerant applications.

/SMS Enable Multple Block I/O Support

This parameter enables Set Multiple Support which the improves performance of some IDE drives. If the drive does not have this feature, this switch will be ignored. The /V - (Verbose) option will indicate whether this feature has been enabled on a particular drive.

/LBA Enable LBA Support

This parameter enables Logical Block Support for IDE drives which support this option. The /V - (Verbose) option will indicate whether this feature has been enabled on a particular drive.