H H Software SCSI & RAID Devices Driver Download



The SCSI Hard Drive Emulator for retro computing.

The Adaptec 29320LPE, PCIe x1, single-channel Ultra320 SCSI HBA is a low profile SCSI card ideal for attaching tape drives, tape libraries, magneto-optical drives, DVD libraries, JBODs, RAID Arrays and other SCSI peripherals to servers and workstations.


Download

  1. downloads for v3/v4/v5/v5.1/v5.2/v5.5 hardware revisions.
  2. downloads for v6 hardware revisions. This firmware will NOT work on the older boards.

News

[27 Oct 2020]v6.3.2 Bugfix release

  • Increase limit of READ/WRITE BUFFER command for improved compatibility on SGI Irix hosts
  • Add new config option to enable blind writes to improve SD card write performance. This was option was previously enabled default but causes problems with some SCSI hosts. This option must be disabled on 68K Macs if there are errors when writing data.

[22 Apr 2020]v6.3.1 New hardware support

Download Adaptec SCSI RAID Controller for Windows to sCSIAdapter driver. . this program; if not, write to the Free Software Foundation, Inc.,. 51 Franklin St - Fifth Floor, Boston, MA USA./ # ifndef SCSIHINCLUDED # define SCSIHINCLUDED # include ' block.h ' # include ' ibpi.h ' /. @brief Gets the sas host path of the device. This function returns a sysfs path to the sas host that the.

  • New V6 boards have started to ship which require a different firmware file. These boards are silkscreened with 'SCSI2SD V6 / 2020c'. These boards MUST use v6.3.1 or newer firmware.
  • Older boards ('Rev F', 'Rev C', or '6.02') should use the 'revF' v6.3.1 firmware

[20 Feb 2020]v6.3.0 Driver update

  • Firmware updates on Windows now require the UsbDk driver instead of the WinUSB driver. The version of dfu-util that is distributed with scsi2sd-util6 has been modified to work with UsbDk. This should provide a better experience and will resolve issues around driver signing. There is no need to uninstall the previous driver.
  • Bugfix to firmware that prevented some machines from booting

[1 Feb 2020]v6.2.15 Bugfix update

  • Resolved a data corruption issue that affects hosts that transfer more than 512k per write command.

[1 Jan 2020]v6.2.14 Bugfix update

  • Resolved a data corruption issue that affects hosts that transfer more than 64k per write command.
  • Fix invalid CDROM TOC responses (thanks Simon Gander)

[19 Dec 2019]v4.8.4 Bugfix update

  • Fix to prevent sending floppy geometry mode page when not configured as a floppy (Thanks Landon Rodgers)

[12 Dec 2019]scsi2sd-util BETA

  • Testing release of a completely new configuration utility. Please provide any feedback via email
  • Firmware updates not yet implemented in this version
  • The stable version of scsi2sd-util, provided alongside the firmware downloads, will remain available for the foreseeable future

[8 Dec 2019]v6.2.9 Bugfix update

  • Fix to prevent sending floppy geometry mode page when not configured as a floppy (Thanks Landon Rodgers)
Devices

[30 Oct 2019]v6.2.8 Bugfix update

  • Fix regression that caused the firmware to fail all self-test checks.

[9 Oct 2019]v6.2.7 Performance Update

  • Improvements to data throughput, which may assist SCSI hosts with short timeouts.

[10 June 2019]v4.8.3 Bug fix update

  • Improve XEBEC support
  • Add Flexible Disk Drive Geometry SCSI MODE page
  • Fix regression for Kurzweil K2000
  • Add scsi mode page 0 support
  • Fix SD card hotswap bug when the SCSI host is constantly polling

[29 May 2019]v6.2.5 Bug fix update

  • Port XEBEC support from v5 firmware
  • Add Flexible Disk Drive Geometry SCSI MODE page
  • Stability improvements
  • Fix regression from 6.1.3 firmware for Kurzweil K2000
  • Add scsi mode page 0 support
  • Fix SD card hotswap bug when the SCSI host is constantly polling

Overview

SCSI2SD is an emulator for old SCSI hard drives. It allows replacing one or several old broken SCSI drives with a SD memory card.


Unlicenced Copies

Older versions of the SCSI2SD hardware designs were published under the GPL licence. This permits anyone to build their own board from the original or modified designs, so long as they abide by the licence terms.

  • The source/designs of any modifications must be provided to those you distribute the board to.
  • Clones are based on the obsolete V4 design, lack features, and may not be compatible with all the systems listed on these pages.

Artmix is currently selling unlicensed modified clones ('SD SusanoMonster'), and refuses to comply with the GPL. Please do not purchase this board. If you have already purchased, please request the seller provides you with the modified designs under the GPL licence.

Which version should you buy ?

SCSI2SD V6This board offers significantly better performance than the V5.x boards by adding support for synchronous SCSI transfers.

Easy access to virtual disk data over USB.

  • See SCSI2SD V6 Compatibility
SCSI2SD V5.1/V5.2This is a newer version of the V5 board, with software-enabled termination, full-size SD card, and floppy-style power connector.

This version provides a faster startup time than V5, which is needed to boot some Amiga and Staubli machines

SCSI2SD V5.5Plugs directly into an external DB25 connector without a cable. Uses micro SD card.
SCSI2SD V5This is the older version which uses micro SD cards.
SCSI2SD for PowerbookDesigned for Apple Powerbook laptops using 2.5' drives.

Purchase

  • codesrc.com (Australia)
  • Inertial Computing (USA)
  • itead (China)
  • AmigaKit (UK)

3rd party accessories

  • Thingiverse nibblernibbles has created a 3d-printable external enclosure for the SCSI2SD + DB25 adapter. Power can be supplied over USB for hosts which don't supply termination power.
  • SCSI2SD V5 & V6 Bracket by Maya Designs
  • SamplerZone.com External cases for V5.0, V5.1, V5.2, and V6 boards, internal cables for all music samplers, and fully-realized SCSI2SD sampler solutions.

Features

  1. In-built active terminator.
  2. Emulates up to 4 SCSI devices (7 for the V6 version)
  3. Supports sector sizes from 64 bytes to 8192 bytes
  4. Firmware updatable over USB
  5. Highly configurable over USB
    • Selectable SCSI ID
    • Selectable parity support
    • Enable/disable Unit Attention Condition
    • Artificial limits on the SCSI disk size (eg. limit size to 4G to avoid OS bugs)
    • Sector size (can also be set via the SCSI MODE SELECT command, as sent by SCSI format utilities).
  6. External LED connector.

Technical Specifications

V5 hardwareV5.1 hardwareV5.2 hardwareV5.5 hardwareV6 hardware
Internal 50pin Narrow 8-bit SCSI connectorYesYesYesNoYes
DB25 SCSI ConnectorNoOptional DB25 female socket.NoDB25 male socket.

Direct plug-in without cable

No
Synchronous SCSI SupportNoNoNoNoYes

FAST10 (10MB/s) synchronous transfers.

SCSI TerminatorActive Terminator

Resistor packs can be removed from the socket to disable the terminator

Active Terminator

Enabled via software using scsi2sd-util

Active Terminator

Enabled via software using scsi2sd-util

Active Terminator

Always-on

Active Terminator

Enabled via software using scsi2sd-util

SD Card InterfacemicroSD, tested up to 64GB

Communication is via the SPI protocol at 25MHz (3MB/s theoretical max)

Full-size, tested up to 128GB

Communication is via the SPI protocol at 25MHz (3MB/s theoretical max)

Full-size, tested up to 128GB

Communication is via the SPI protocol at 25MHz (3MB/s theoretical max)

microSD, tested up to 64GB

Communication is via the SPI protocol at 25MHz (3MB/s theoretical max)

Full-size SD, tested up to 128GB

Up to 20MB/s

USB InterfaceFirmware updates and configuration

USB 2.0 micro-B

Firmware updates and configuration

USB 2.0 micro-B

Firmware updates and configuration

USB 2.0 micro-B

Firmware updates and configuration

USB 2.0 micro-B

Firmware updates, configuration, and mass-storage

USB 2.0 micro-B. Mass-storage at USB 2.0 FS speeds (1.2MB/s max)

Power5V via standard Molex 4-pin drive connector, USB, or self-powered using the SCSI host termination power.

2.35W maximum (500mA)

DO NOT CONNECT 12V at all if you need to make your own power cable as it risks destroying the board if you accidentally swap the wires.

5V via floppy 4-pin drive connector, USB, or self-powered using the SCSI host termination power.

2.35W maximum (500mA)

DO NOT CONNECT 12V at all if you need to make your own power cable as it risks destroying the board if you accidentally swap the wires.

5V via floppy 4-pin drive connector, USB, or self-powered using the SCSI host termination power.

2.35W maximum (500mA)

DO NOT CONNECT 12V at all if you need to make your own power cable as it risks destroying the board if you accidentally swap the wires.

5V via DB25 SCSI connector, or USB.

2.35W maximum (500mA)

Requires SCSI host that supplies terminator power on pin 25 of the DB25 socket

5V via floppy 4-pin drive connector, USB, or self-powered using the SCSI host termination power.

2.35W maximum (500mA)

Dimensions (L x W x H)5cm x 10cm x 1.5cm10cm x 9cm x 1.5cm10cm x 9cm x 1.5cm7.5cm x 5.5cm x 1.8cm (External case)10cm x 9cm x 1.5cm
Performance

Tested under optimal conditions.For comparison, here are some benchmarks of some older SCSI hardware.

Up to 2.6MB/s read, 2.3MB/s write

(1.1MB/s on most older SCSI hosts)

Up to 2.6MB/s read, 2.3MB/s write

(1.1MB/s on most older SCSI hosts)

Up to 2.6MB/s read, 2.3MB/s write

(1.1MB/s on most older SCSI hosts)

Up to 1MB/sUp to 10MB/s.

Compatibility

Files

Firmware update utility and configuration tool at:

  1. downloads for v3/v4/v5/v5.1/v5.2/v5.5.
  2. downloads for v6.

These files are currently available for Windows, Linux, and Mac OSX.

A copy of all sources can be obtained via the command:

or (for V6)


Alternatively, the git sources can be viewed using your web browser by clicking here or here (V6)

Howto

  • FormatWithBasiliskII Format an SD card for use with Apple Macintosh hardware using the Basilisk II emulator
Retrieved from 'http://www.codesrc.com/mediawiki/index.php?title=SCSI2SD&oldid=588'

The Solaris DDI/DKI divides the software interface to SCSI devices into two major parts: target drivers and host bus adapter (HBA) drivers. Target refers to a driver for a device on a SCSI bus, such as a disk or a tape drive. Host bus adapter refers to the driver for the SCSI controller on the host machine. SCSA defines the interface between these two components. This chapter discusses target drivers only. See Chapter 15, SCSI Host Bus Adapter Drivers for information on host bus adapter drivers.

Note –

The terms “host bus adapter” or “HBA” used in this manual are equivalent to the phrase “host adapter” defined in SCSI specifications.

This chapter provides information on the following subjects:

Target drivers can be either character or block device drivers, depending on the device. Drivers for tape drives are usually character device drivers, while disks are handled by block device drivers. This chapter describes how to write a SCSI target driver and discusses the additional requirementsthat SCSA places on block and character drivers for SCSI target devices.

The following reference documents provide supplemental information needed by the designers of target drivers and host bus adapter drivers.

Small Computer System Interface 2 (SCSI-2), ANSI/NCITS X3.131-1994, Global Engineering Documents, 1998. ISBN 1199002488.

The Basics of SCSI, Fourth Edition, ANCOT Corporation, 1998. ISBN 0963743988.

Also refer to the SCSI command specification for the target device, provided by the hardware vendor.

The Sun Common SCSI Architecture (SCSA) is the Solaris DDI/DKI programming interface for the transmission of SCSI commands from a target driver to a host bus adapter driver. This interface is independent of the type of host bus adapter hardware, the platform, the processor architecture, and theSCSI command being transported across the interface.

By conforming to the SCSA, the target driver can pass any SCSI command to a target device without knowledge of the hardware implementation of the host bus adapter.

The SCSA conceptually separates building the SCSI command (by the target driver) from transporting the SCSI command and data across the SCSI bus. The architecture defines the software interface between high-level and low-level software components. The higher level software component consists ofone or more SCSI target drivers, which translate I/O requests into SCSI commands appropriate for the peripheral device. Figure 14–1 illustrates the SCSI architecture.

Figure 14–1 SCSA Block Diagram

The lower-level software component consists of a SCSA interface layer and one or more host bus adapter drivers. The target driver is responsible for the generation of the proper SCSI commands required to execute the desired function and for processing the results.

General Flow of Control

Assuming no transport errors occur, the following steps describe the general flow of control for a read or write request.

  1. The target driver's read(9E) or write(9E) entry pointis invoked. physio(9F) is used to lock down memory, prepare a buf structure, and call the strategy routine.

  2. The target driver's strategy(9E) routine checks the request and allocates a scsi_pkt(9S) using scsi_init_pkt(9F).The target driver initializes the packet and sets the SCSI command descriptor block (CDB) using the scsi_setup_cdb(9F) function. The targetdriver also specifies a timeout and provides a pointer to a callback function, which is called by the host bus adapter driver on completion of the command. The buf(9S)pointer should be saved in the SCSI packet's target-private space.

  3. The target driver submits the packet to the host bus adapter driver using scsi_transport(9F). The target driver is thenfree to accept other requests. The target driver should not access the packet while it is in transport. If either the host bus adapter driver or the target supports queueing, new requests can be submitted while the packet is in transport.

  4. As soon as the SCSI bus is free and the target not busy, the host bus adapter driver selects the target and passes the CDB. The target executes the command and performs the requested data transfers.

  5. After the target sends completion status and the command completes, the host bus adapter driver notifies the target driver by calling the completion function that was specified in the SCSI packet. At this time the host bus adapter driver is no longer responsible for the packet, and thetarget driver has regained ownership of the packet.

  6. The SCSI packet's completion routine analyzes the returned information and determines whether the SCSI operation was successful. If a failure has occurred, the target driver retries the command by calling scsi_transport(9F) again. If the host bus adapter driver does not support auto request sense, the target driver must submit a request sense packet to retrieve the sense data in the event of a check condition.

  7. If either the command was completed successfully or cannot be retried, the target driver calls scsi_destroy_pkt(9F), whichsynchronizes the data and frees the packet. If the target driver needs to access the data before freeing the packet, it calls scsi_sync_pkt(9F).

  8. Finally, the target driver notifies the application program that originally requested the read or write that the transaction is complete, either by returning from the read(9E) entry point in the driver (for a character device) or indirectly through biodone(9F).

SCSA allows the execution of many of such operations, both overlapped and queued, at various points in the process. The model places the management of system resources on the host bus adapter driver. The software interface enables the execution of target driver functions on host bus adapter driversusing SCSI bus adapters of varying degrees of sophistication.

SCSA Functions

SCSA defines functions to manage the allocation and freeing of resources, the sensing and setting of control states, and the transport of SCSI commands. These functions are listed in Table 14–1.

Table 14–1 Standard SCSA Functions

Function Name

Category

Resource management

scsi_dmafree(9F)

scsi_alloc_consistent_buf(9F)

scsi_free_consistent_buf(9F)

Command transport

Transport information and control

scsi_ifsetcap(9F)

scsi_abort(9F)

Error handling

scsi_reset(9F)

scsi_poll(9F)

Polled I/O

scsi_probe(9F)

Probe functions

scsi_unprobe(9F)

scsi_setup_cdb(9F)

CDB initialization function

Note –

If your driver needs to work with a SCSI-1 device, use the makecom(9F) function.

Because SCSI devices are not self-identifying, a hardware configuration file is required for a target driver (see driver.conf(4) and scsi(4) for details). A typical configuration file looks like this:

The system reads the file during autoconfiguration and uses the class property to identify the driver's possible parent. The system then attempts to attach the driver to any parent driver that is of class scsi. All host bus adapter drivers are of thisclass. Using the class property rather than the parent property enables the target driver to be attached to any host bus adapter driver that finds the expected device at the specified target and lunIDs. The target driver is responsible for verifying this in its probe(9E) routine.

Target drivers must include the header file <sys/scsi/scsi.h>.

SCSI target drivers must use the following command to generate a binary module:

scsi_device Structure

The host bus adapter driver allocates and initializes a scsi_device(9S) structure for the target driver before either the probe(9E) or attach(9E)routine is called. This structure stores information about each SCSI logical unit, including pointers to information areas that contain both generic and device-specific information. There is one scsi_device(9S) structure for each logical unit attached to the system. The target driver can retrieve a pointer to this structure by calling ddi_get_driver_private(9F).

Caution –

Because the host bus adapter driver uses the private field in the target device's dev_info structure, target drivers must not use ddi_set_driver_private(9F).

The scsi_device(9S) structure contains the following fields:

sd_address

Data structure that is passed to the SCSI resource allocation routines.

sd_dev

Pointer to the target's dev_info structure.

sd_mutex

Mutex for use by the target driver. This is initialized by the host bus adapter driver and can be used by the target driver as a per-device mutex. Do not hold this mutex across a call to scsi_transport(9F) or scsi_poll(9F). See Chapter 3, Multithreading for more information on mutexes.

sd_inq

Pointer for the target device's SCSI inquiry data. The scsi_probe(9F)routine allocates a buffer, fills it in with inquiry data, and attaches it to this field.

sd_sense

Pointer to a buffer to contain SCSI request sense data from the device. The target driver must allocate and manage this buffer itself; see attach() Entry Point (SCSI Target Drivers).

sd_private

Pointer field for use by the target driver. It is commonly used to store a pointer to a private target driver state structure.

scsi_pkt Structure

The scsi_pkt structure contains the following fields:

pkt_address

Target device's address set by scsi_init_pkt(9F).

pkt_private

Place to store private data for the target driver. It is commonly used to save the buf(9S) pointer for the command.

pkt_comp

Address of the completion routine. The host bus adapter driver calls this routine when it has transported the command. This does not mean that the command succeeded; the target might have been busy or might not have respondedbefore the time-out time elapsed (see the description for pkt_time field). The target driver must supply a valid value in this field, though it can be NULL if the driver does not want to be notified.

Note –

There are two different SCSI callback routines. The pkt_comp field identifies a completion callback routine, which is called when the host bus adapter completes its processing. There is also a resource callback routine, calledwhen currently unavailable resources are likely to be available (as in scsi_init_pkt(9F)).

pkt_flags

Provides additional control information, for example, to transport the command without disconnect privileges (FLAG_NODISCON) or to disable callbacks (FLAG_NOINTR). See the scsi_pkt(9S) man page for details.

pkt_time

Time-out value (in seconds). If the command is not completed within this time, the host bus adapter calls the completion routine with pkt_reason set to CMD_TIMEOUT. The target drivershould set this field to longer than the maximum time the command might take. If the timeout is zero, no timeout is requested. Timeout starts when the command is transmitted on the SCSI bus.

pkt_scbp

Pointer to the SCSI status completion block; this is filled in by the host bus adapter driver.

pkt_cdbp

Pointer to the SCSI command descriptor block, the actual command to be sent to the target device. The host bus adapter driver does not interpret this field. The target driver must fill it in with a command that the target devicecan process.

pkt_resid

Residual of the operation. When allocating DMA resources for a command scsi_init_pkt(9F), pkt_resid indicates the number of bytes for which DMA resources could not be allocated because of DMA hardware scatter-gather or other device limitations. After command transport, pkt_resid indicates thenumber of data bytes not transferred; this is filled in by the host bus adapter driver before the completion routine is called.

pkt_state

Indicates the state of the command. The host bus adapter driver fills in this field as the command progresses. One bit is set in this field for each of the five following command states:

  • STATE_GOT_BUS – Acquired the bus

  • STATE_GOT_TARGET – Selected the target

  • STATE_SENT_CMD – Sent the command

  • STATE_XFERRED_DATA – Transferred data (if appropriate)

  • STATE_GOT_STATUS – Received status from the device

pkt_statistics

Contains transport-related statistics set by the host bus adapter driver.

pkt_reason

Gives the reason the completion routine was called. The main function of the completion routine is to decode this field and take the appropriate action. If the command completed—in other words, if there were no transporterrors—this field is set to CMD_CMPLT; other values in this field indicate an error. After a command is completed, the target driver should examine the pkt_scbp field for a check condition status. See the scsi_pkt(9S) man page for more information.

SCSI target drivers must implement the standard autoconfiguration routines _init(9E), _fini(9E), and _info(9E). See Loadable Driver Interfaces for moreinformation.

probe(9E), attach(9E), detach(9E), and getinfo(9E) are also required, but they must perform SCSI (and SCSA) specific processing.

probe() Entry Point (SCSI Target Drivers)

SCSI target devices are not self-identifying, so target drivers must have a probe(9E) routine. This routine must determine whether the expectedtype of device is present and responding.

The general structure and return codes of the probe(9E) routine are the same as those of other device drivers. SCSI target drivers must usethe scsi_probe(9F) routine in their probe(9E) entry point. scsi_probe(9F) sends a SCSI inquiry command to the device and returns a code indicatingthe result. If the SCSI inquiry command is successful, scsi_probe(9F) allocates a scsi_inquiry(9S) structure and fills it in with the device's inquiry data. Upon return from scsi_probe(9F), the sd_inq field of the scsi_device(9S) structurepoints to this scsi_inquiry(9S) structure.

Because probe(9E) must be stateless, the target driver must call scsi_unprobe(9F) before probe(9E) returns, even if scsi_probe(9F) fails.

Example 14–1 shows a typical probe(9E) routine. It retrieves its scsi_device(9S) structure from the private field of its dev_info structure. It also retrieves the device's SCSI target and logical unit numbers so that itcan print them in messages. The probe(9E) routine then calls scsi_probe(9F) to verify that the expected device (a printer in this case) is present.

If scsi_probe(9F) succeeds, it has attached the device's SCSI inquiry data in a scsi_inquiry(9S) structure to the sd_inq field of the scsi_device(9S) structure. The driver can then determine if the device type is a printer (reported in the inq_dtype field). If it is, the type is reported with scsi_log(9F), using scsi_dname(9F) to convert the device type intoa string.

Example 14–1 SCSI Target Driver probe(9E) Routine

A more thorough probe(9E) routine could also check other fields of the scsi_inquiry(9S) structure as necessary to make sure that the device is of the type expected by a particular driver.

attach() Entry Point (SCSI Target Drivers)

After the probe(9E) routine has verified that the expected device is present, attach(9E) is called. This routine allocates and initializes any per-instance data, creates minor device node information, and restores the hardware state of a device when the device or the system has been suspended. (See The attach() Entry Point for details.) In addition to these steps, a SCSI target driver again calls scsi_probe(9F) to retrieve the device's inquirydata and also creates a SCSI request sense packet. If the attach is successful, the attach() function should not call scsi_unprobe(9F).

Three routines are used to create the request sense packet: scsi_alloc_consistent_buf(9F), scsi_init_pkt(9F), and scsi_setup_cdb(9F). scsi_alloc_consistent_buf(9F) allocates a buffer suitable for consistent DMA and returns apointer to a buf(9S) structure. The advantage of a consistent buffer is that no explicit synchronization of the data is required. In other words, thetarget driver can access the data after the callback. The sd_sense element of the device's scsi_device(9S) structuremust be initialized with the address of the sense buffer. scsi_init_pkt(9F) creates and partially initializes a scsi_pkt(9S) structure. scsi_setup_cdb(9F) creates a SCSI command descriptor block, in this case creating a SCSI request sense command.

Note that since a SCSI device is not self-identifying and does not have a reg property, the driver must set the pm-hardware-state property to inform the framework that this device needs to be suspended and resumed.

Example 14–2 shows the SCSI target driver's attach() routine.

Example 14–2 SCSI Target Driver attach(9E) Routine

detach() Entry Point (SCSI Target Drivers)

The detach(9E) entry point is the inverse of attach(9E); it must free all resources that were allocated in attach(). If successful, the detach should call scsi_unprobe(9F). Example 14–3 shows a target driver detach() routine.

Example 14–3 SCSI Target Driver detach(9E) Routine

getinfo() Entry Point (SCSI Target Drivers)

The getinfo(9E) routine for SCSI target drivers is much the same as for other drivers (see The getinfo() Entry Point for more informationon DDI_INFO_DEVT2INSTANCE case). However, in the DDI_INFO_DEVT2DEVINFO case of the getinfo() routine, the target driver must return a pointer to its dev_info node. This pointer can be saved in the driver statestructure or can be retrieved from the sd_dev field of the scsi_device(9S) structure. Example 14–4showsan alternative SCSI target driver getinfo() code fragment.

Example 14–4 Alternative SCSI Target Driver getinfo(9E) Code Fragment

To send a SCSI command to the device, the target driver must create and initialize a scsi_pkt(9S) structure and pass it to the host bus adapterdriver.

scsi_init_pkt() Function

The scsi_init_pkt(9F) routine allocates and zeros a scsi_pkt(9S) structure; it also sets pointers to pkt_private, *pkt_scbp, and *pkt_cdbp. Additionally, it provides a callback mechanism to handle the case where resourcesare not available. This function has the following syntax:

ap

Pointer to a scsi_address structure. This is the sd_address field of the device's scsi_device(9S) structure.

pktp

Pointer to the scsi_pkt(9S) structure to be initialized. If this is setto NULL, a new packet is allocated.

bp

Pointer to a buf(9S) structure. If this is non-NULL and contains a valid bytecount, DMA resources are allocated.

cmdlen

Length of the SCSI command descriptor block in bytes.

statuslen

Required length of the SCSI status completion block in bytes.

privatelen

Number of bytes to allocate for the pkt_private field.

flags

H H Software Scsi & Raid Devices Driver Downloads

Set of flags. Possible bits include:

  • PKT_CONSISTENT – This bit must be set if the DMA buffer was allocated using scsi_alloc_consistent_buf(9F). In this case, the host bus adapter driver guarantees that the data transfer is properly synchronized before performing the target driver's command completion callback.

  • PKT_DMA_PARTIAL – This bit can be set if the driver accepts a partial DMA mapping. If set, scsi_init_pkt(9F)allocates DMA resources with the DDI_DMA_PARTIAL flag set. The pkt_resid field of the scsi_pkt(9S)structure can be returned with a nonzero residual, indicating the number of bytes for which scsi_init_pkt(9F) was unable to allocate DMA resources.

callback

Specifies the action to take if resources are not available. If set to NULL_FUNC, scsi_init_pkt(9F) returns immediately (returning NULL). If set to SLEEP_FUNC, it does not return until resources are available. Any other valid kernel address is interpreted as the address of a function to be called when resources are likely to be available.

arg

Parameter to pass to the callback function.

The scsi_init_pkt() routine synchronizes the data prior to transport. If the driver needs to access the data after transport, it should call scsi_sync_pkt(9F) to flush any intermediate caches. The scsi_sync_pkt() routine can be used to synchronize any cached data.

scsi_sync_pkt() Function

If the target driver needs to resubmit the packet after changing the data, scsi_sync_pkt(9F) must be called before calling scsi_transport(9F). However, if the target driver does not need to access the data, there is no need to call scsi_sync_pkt() after the transport.

scsi_destroy_pkt() Function

The scsi_destroy_pkt(9F) routine synchronizes any remaining cached data associated with the packet, if necessary, and then frees thepacket and associated command, status, and target driver-private data areas. This routine should be called in the command completion routine.

scsi_alloc_consistent_buf() Function

H H Software Scsi & Raid Devices Driver Download Windows 7

For most I/O requests, the data buffer passed to the driver entry points is not accessed directly by the driver; it is just passed on to scsi_init_pkt(9F).If a driver sends SCSI commands that operate on buffers that the driver itself examines (such as the SCSI request sense command), the buffers should be DMA consistent. The scsi_alloc_consistent_buf(9F) routine allocates a buf(9S) structure and a data buffer suitable for DMA-consistentoperations. The HBA will perform any necessary synchronization of the buffer before performing the command completion callback.

Caution –

scsi_alloc_consistent_buf(9F) uses scarce system resources; use it sparingly.

scsi_free_consistent_buf() Function

scsi_free_consistent_buf(9F) releases a buf(9S) structure and the associated data buffer allocated with scsi_alloc_consistent_buf(9F). See attach() Entry Point (SCSI Target Drivers) and detach() Entry Point (SCSI Target Drivers) for examples.

The host bus adapter driver is responsible for transmitting the command to the device and handling the low-level SCSI protocol. The scsi_transport(9F)routine hands a packet to the host bus adapter driver for transmission. The target driver has the responsibility to create a valid scsi_pkt(9S)structure.

Building a Command

The routine scsi_init_pkt(9F) allocates space for a SCSI CDB, allocates DMA resources if necessary, and sets the pkt_flagsfield, as shown in this example:

This example creates a new packet and allocates DMA resources as specified in the passed buf(9S) structure pointer. A SCSI CDB is allocated fora Group 0 (6-byte) command, the pkt_flags field is set to zero, but no space is allocated for the pkt_private field. This call to scsi_init_pkt(9F), because of the SLEEP_FUNC parameter, waits indefinitely for resources if none are currently available.

The next step is to initialize the SCSI CDB, using the scsi_setup_cdb(9F) function:

This example builds a Group 0 command descriptor block and fills in the pkt_cdbp field as follows:

  • The command itself (byte 0) is set from the parameter (SCMD_READ).

  • The address field (bits 0-4 of byte 1 and bytes 2 and 3) is set from bp->b_blkno.

  • The count field (byte 4) is set from the last parameter. In this case it is set to bp->b_bcount>>DEV_BSHIFT, where DEV_BSHIFT is the byte count of the transfer converted to the number of blocks.

Note –

scsi_setup_cdb(9F) does not support setting a target device's logical unit number (LUN) in bits 5-7 of byte 1 of the SCSI commandblock, as defined by SCSI-1. For SCSI-1 devices requiring the LUN bits set in the command block, use makecom_g0(9F) (or equivalent) rather than scsi_setup_cdb(9F).

After initializing the SCSI CDB, initialize three other fields in the packet and store as a pointer to the packet in the state structure.

The buf(9S) pointer is saved in the pkt_private field for later use in the completion routine.

Setting Target Capabilities

The target drivers use scsi_ifsetcap(9F) to set the capabilities of the host adapter driver. A cap is a name-valuepair whose name is a null terminated character string and whose value is an integer. The current value of a capability can be retrieved using scsi_ifgetcap(9F). scsi_ifsetcap(9F) allows capabilities to be set for all targets on the bus.

In general, however, setting capabilities of targets that are not owned by the target driver is not recommended and is not universally supported by HBA drivers. Some capabilities (such as disconnect and synchronous) can be set by default by the HBA driver but others might need to be set explicitlyby the target driver (wide-xfer or tagged-queueing, for example).

Transporting a Command

After creating and filling in the scsi_pkt(9S) structure, the final step is to hand it to the host bus adapter driver using scsi_transport(9F):

The other return values from scsi_transport(9F) are:

  • TRAN_BUSY – There is already a command in progress for the specified target.

  • TRAN_BADPKT – The DMA count in the packet was too large, or the host adapter driver rejected this packet for other reasons.

  • TRAN_FATAL_ERROR – The host adapter driver is unable to accept this packet.

Caution –

The mutex sd_mutex in the scsi_device(9S) structure must not be held across a call to scsi_transport(9F).

If scsi_transport(9F) returns TRAN_ACCEPT, the packet is the responsibility of the host bus adapter driverand should not be accessed by the target driver until the command completion routine is called.

Synchronous scsi_transport() Function

If FLAG_NOINTR is set in the packet, then scsi_transport(9F) will not return until the command is complete,and no callback will be performed.

Note –

Do not use FLAG_NOINTR in interrupt context.

Command Completion

Once the host bus adapter driver has done all it can with the command, it invokes the packet's completion callback routine, passing a pointer to the scsi_pkt(9S) structure as a parameter. The completion routine decodes the packet and takes the appropriate action.

Example 14–5 presents a simple completion callback routine. This code checks for transport failures and gives up rather than retrying the command. If the target is busy, extra code is required to resubmit the command at a later time.

If the command results in a check condition, the target driver needs to send a request sense command unless auto request sense has been enabled.

Otherwise, the command succeeded. If this is the end of processing for the command, it destroys the packet and calls biodone(9F).

In the event of a transport error (such as a bus reset or parity problem), the target driver can resubmit the packet using scsi_transport(9F).There is no need to change any values in the packet prior to resubmitting.

Example 14–5 does not attempt to retry incomplete commands.

Note –

Normally, the target driver's callback function is called in interrupt context. Consequently, the callback function should never sleep.

Example 14–5 SCSI Driver Completion Routine

Reuse of Packets

A target driver can reuse packets in the following ways:

  • Resubmit the packet unchanged.

  • Use scsi_sync_pkt(9F) to synchronize the data, then process the data in the driver and resubmit.

  • Free DMA resources, using scsi_dmafree(9F), and pass the pkt pointer to scsi_init_pkt(9F) for binding to a new bp. The target driver is responsible for reinitializing the packet. The CDB has to have the same length as the previousCDB.

  • If partial DMA was allocated during the first call to scsi_init_pkt(9F), subsequent calls to scsi_init_pkt(9F) can be made for the same packet and bp to adjust the DMA resources to the next portion of the transfer.

Auto-Request Sense Mode

Auto-request sense mode is most desirable if tagged or untagged queuing is used. A contingent allegiance condition is cleared by any subsequent command and, consequently, the sense data is lost. Most HBA drivers will start the next command before performing the target drivercallback. Other HBA drivers can use a separate and lower-priority thread to perform the callbacks, which might increase the time needed to notify the target driver that the packet completed with a check condition. In this case, the target driver might not be able to submit a request sense command in timeto retrieve the sense data.

To avoid this loss of sense data, the HBA driver, or controller, should issue a request sense command as soon as a check condition has been detected; this mode is known as auto-request sense mode. Note that not all HBA drivers are capable of auto-request sense mode, and some can only operate withauto-request sense mode enabled.

A target driver enables auto-request-sense mode by using scsi_ifsetcap(9F). Example 14–6 shows enabling auto request sense.

Example 14–6 Enabling Auto Request Sense

When a packet is allocated using scsi_init_pkt(9F) and auto request sense is desired on this packet, then the target driver must requestadditional space for the status block to hold the auto request sense structure. The sense length used in the request sense command is sizeof (structscsi_extended_sense). Auto request sense can be disabled per individual packet by just allocating sizeof (structscsi_status) for the status block.

The packet is submitted using scsi_transport(9F) as usual. When a check condition occurs on this packet, the host adapter driver takesthe following steps:

  • Issues a request sense command if the controller doesn't have auto-request-sense capability

  • Obtains the sense data

  • Fills in the scsi_arq_status information in the packet's status block

  • Sets STATE_ARQ_DONE in the packet's pkt_state field

  • Calls the packet's callback handler (pkt_comp())

H H Software Scsi & Raid Devices Driver Download Windows 10

The target driver's callback routine should verify that sense data is available by checking the STATE_ARQ_DONE bit in pkt_state, which implies that a check condition has occurred and a request sense has been performed. If auto-request-sense hasbeen temporarily disabled in a packet, there is no guarantee that the sense data can be retrieved at a later time.

The target driver should then verify whether the auto request sense command completed successfully and decode the sense data.

Dump Handling

The dump(9E) entry point is used to copy a portion of virtual address space directly to the specified device in the case of system failure orcheckpoint operation. See the cpr(7) and dump(9E) man pages. The dump(9E) entry point must be capable of performing this operation without the use ofinterrupts.

The arguments for dump() are as follows. dev is the device number of the dump device, addr is the kernel virtual address at which to start the dump, blkno is the first destination block on the device,and nblk is the number of blocks to dump.

Example 14–7 dump(9E) Routine

SCSA defines a global variable, scsi_options, which can be used for debug and control. The defined bits in scsi_options can be found in the file <sys/scsi/conf/autoconf.h>. The following table describes the use of thesebits.

Table 14–2 SCSA Options

Option

Description

SCSI_OPTIONS_DR

Enables global disconnect/reconnect

SCSI_OPTIONS_SYNC

Enables global synchronous transfer capability

SCSI_OPTIONS_LINK

Enables global link support

SCSI_OPTIONS_PARITY

Enables global parity support

SCSI_OPTIONS_TAG

Enables global tagged queuing support

SCSI_OPTIONS_FAST

Enables global FAST SCSI support: 10 Mbytes/sec transfers, as opposed to 5 Mbytes/sec

SCSI_OPTIONS_FAST20

Enables global FAST20 SCSI support: 20 Mbytes/sec transfers

SCSI_OPTIONS_FAST40

Enables global FAST40 SCSI support: 40 Mbytes/sec transfers

SCSI_OPTIONS_FAST80

Enables global FAST80 SCSI support: 80 Mbytes/sec transfers

SCSI_OPTIONS_WIDE

Enables global WIDE SCSI

Note –

H H Software Scsi & Raid Devices Driver Download 64-bit

The setting of scsi_options affects all host adapter and target drivers present on the system (as opposed to scsi_ifsetcap(9F). Refer to the scsi_hba_attach(9F) man page for information on controlling these options for a particular host adapter.