xref: /illumos-gate/usr/src/man/man9f/scsi_setup_cdb.9f (revision d48be21240dfd051b689384ce2b23479d757f2d8)
te
Copyright (c) 2006, Sun Microsystems, Inc. , All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SCSI_SETUP_CDB 9F "Jan 16, 2006"
NAME
scsi_setup_cdb - setup SCSI command descriptor block (CDB)
SYNOPSIS
int scsi_setup_cdb(union scsi_cdb *cdbp, uchar_t cmd, uint_t addr,
 uint_t cnt, uint_t othr_cdb_data);
INTERFACE LEVEL
illumos DDI specific (illumos DDI).
PARAMETERS
cdbp

Pointer to command descriptor block.

cmd

The first byte of the SCSI group 0, 1, 2, 4, or 5 CDB.

addr

Pointer to the location of the data.

cnt

Data transfer length in units defined by the SCSI device type. For sequential devices cnt is the number of bytes. For block devices, cnt is the number of blocks.

othr_cdb_data

Additional CDB data.

DESCRIPTION
The scsi_setup_cdb() function initializes a group 0, 1, 2, 4, or 5 type of command descriptor block pointed to by cdbp using cmd, addr, cnt, othr_cdb_data.

addr should be set to 0 for commands having no addressing information (for example, group 0 READ command for sequential access devices). othr_cdb_data should be additional CDB data for Group 4 commands; otherwise, it should be set to 0.

The scsi_setup_cdb() function does not set the LUN bits in CDB[1] as the makecom(9F) functions do. Also, the fixed bit for sequential access device commands is not set.

RETURN VALUES
The scsi_setup_cdb() function returns: 1

Upon success.

0

Upon failure.

CONTEXT
These functions can be called from a user, interrupt, or kernel context.
SEE ALSO
makecom (9F), scsi_pkt (9S)

Writing Device Drivers

American National Standard Small Computer System Interface-2 (SCSI-2)

American National Standard SCSI-3 Primary Commands (SPC)