pt_send(S)

Synopsis

#include <libsdi.h>

int pt_send(pt_handle_t handle, void *scb, size_t scb_length, void *buffer,
	size_t buffer_length, uint_t mode, time_t timeout, time_t *elapsed,
	uint_t *compcode, uint_t *status, void * req_buffer,
	size_t req_buffer_length)

Description

handle

The opaque handle obtained from a previous sdi_open.

scb

A pointer to a complete SCSI command descriptor block as described in the SCSI specification.

scb_length

The length in bytes of the SCSI command pointed to by scb.

buffer

A pointer to a user-supplied data area for use by the specified SCSI command.

buffer_length

The size in bytes of the area pointed to by buffer. If the command does not require a buffer area, buffer_length may be zero.

mode

specifies the direction of data transfer. If the SCSI command returns data to the buffer, it should be set to SCB_READ. If the SCSI command transfer data from the buffer to the SCSI target, it should be set to SCB_WRITE. If buffer_length is set to 0, this element is ignored.

timeout

Specifies the amount of time in milliseconds that SDI should wait for the completion of this command. If the command does not complete before this time is exceeded, SDI will abort the command and return a value in compcode of SDI_TIME.

elapsed

A pointer to variable of type time_t. If the command completes normally, the amount of time the command took to complete is returned here.

compcode

A pointer to an unsigned integer used to return the status of the job. A SCSI command that completes normally returns SDI_ASW. SDI_CKSTAT is returned if the user should check the value of status for more information. There are many other possible values for this field. They can be found in sdi_comm.h. These values are used to indicate failures where no SCSI command completed on the SCSI bus.

status

A pointer to an unsigned integer and is used to return to the user the actual value of the status byte code returned by the target to the initiator during the STATUS phase at the completion of the SCSI command. Its value is only valid if SDI_CKSTAT is returned in compcode. If its value indicates CHECK CONDITION, the user should issue a REQUEST SENSE command to the target that returned the CHECK CONDITION.

req_buffer

A pointer to a user-supplied data area in which the request sense data for this command is returned. Request sense data is only returned if the SCSI command completes with a CHECK CONDITION. If this buffer is supplied it must be at least 18 bytes long.

req_buffer_length

The size in bytes of the area pointed to by req_buffer. This length must be at least 18 bytes if req_buffer is not NULL. If it is not, pt_send will fail with EINVAL.

Return values

If the SCSI command returns with a CHECK CONDITION and req_buffer is not NULL, a REQUEST SENSE command is issued by SDI and the request sense data is returned in req_buffer.

If req_buffer is NULL, a REQUEST SENSE command is not automatically issued by SDI and it is the application's responsibility to issue the REQUEST SENSE command if they need the sense data.

Errors

EINVAL

The argument req_buffer is not NULL and the length given by req_buffer_length is less than 18 bytes.

Usage

Compatibility

Standards conformance

References