Sun Common SCSI Architecture Overview

The Sun Common SCSI Architecture (SCSA) is the Solaris 2.7 SPARC 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 the SCSI 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 of one or more SCSI target drivers, which translate I/O requests into SCSI commands appropriate for the peripheral device. Figure 13-1 illustrates the SCSI architecture.

Figure 13-1 SCSA Block Diagram

The lower-level software component consists of a SCSA interface layer and one or more host bus adapter drivers. The host bus adapter driver has several responsibilities. It must:

• Manage host bus adapter hardware.

• Accept SCSI commands from the SCSI target driver.

• Transport the commands to the specified SCSI target device.

• Perform any data transfers that the command requires.

• Collect status.

• Handle auto-request sense (optional).

• Inform the target driver of command completion (or failure).

See Chapter 14, SCSI Host Bus Adapter Driversfor more information.

The target driver is completely responsible for the generation of the proper SCSI commands required to execute the desired function.

General Flow of Control

Before transferring data, ensure that the disk is spun up. When transferring data to or from a user address space (using the read(9E) or write(9E) entry points), SCSI target character device drivers must use physio(9F), which locks down memory, prepares a buf(9S) structure, and calls the driver's strategy(9E) routine.

physio(9F) locks down the user buffer into memory before issuing a SCSI command. The file system locks down memory for block device drivers. See Chapter 9, "Drivers for Block Devices", for more information on writing a strategy(9E) entry point and Chapter 8, "Drivers for Character Devices", for more information on using physio(9F).

Assuming no transport errors occur, the following steps describe the general flow of control for a read or write request, starting from the call to the target driver's strategy routine.

1. 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_cbd(9F) function. The target driver 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.

2. The target driver submits the packet to the host bus adapter driver using scsi_transport(9F). The target driver is then free 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.

3. 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. The target controls the SCSI bus phase transitions. The host bus adapter just responds to these transitions until the command is completed.

4. After the target sends completion status and disconnects, 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 the target driver has regained ownership of the packet.

5. 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 may retry 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.

6. If either the command was completed successfully or cannot be retried, the target driver calls scsi_destroy_pkt(9F), which synchronizes 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).

7. 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).

The 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 drivers using SCSI bus adapters of varying degrees of intelligence.

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 listed in Table 13-1.

Table 13-1 Standard SCSA Functions

Function Name	Category
scsi_init_pkt(9F)	Resource management
scsi_sync_pkt(9F)
scsi_dmafree(9F)
scsi_destroy_pkt(9F)
scsi_alloc_consistent_buf(9F)
scsi_free_consistent_buf(9F)
scsi_transport(9F)	Command transport
scsi_ifgetcap(9F)	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 that if a driver needs to work with a SCSI-1 device, it should use the makecom(9F) functions listed in Table 13-2.

SCSA Compatibility Functions

The functions listed in Table 13-2 are maintained for source and binary compatibility with previous releases. However, new drivers should use the new functions listed in Table 13-1.

Table 13-2 SCSA Compatibility Functions

Function Name	Category
scsi_resalloc(9F)	Resource management
scsi_resfree(9F)
scsi_pktalloc(9F)
scsi_pktfree(9F)
scsi_dmaget(9F)
get_pktiopb(9F)
free_pktiopb(9F)
scsi_slave(9F)	Probe functions
scsi_unslave(9F)
makecom_g0(9F)	CDB initialization functions
makecom_g1(9F)
makecom_g0_s(9F)
makecom_g5(9F)