VIRTUTECH CONFIDENTIAL    Previous - Up - Next

scsi-cdrom

Provided by

scsi-cdrom

Class Hierarchy

conf-object → log-object → scsi-cdrom

Interfaces Implemented

log_object, event_poster

Description

Generic CD-ROM with SCSI interface.

Attributes

Attributes inherited from class conf-object

attributes, classname, component, iface, name, object_id, queue

Attributes inherited from class log-object

access_count, log_buffer, log_buffer_last, log_buffer_size, log_group_mask, log_groups, log_level, log_type_mask

Attribute List

buf_len

Optional attribute; read/write access; type: unknown type.

Length left to transfer to host.

cd_locked

Optional attribute; read/write access; type: unknown type.

Set to 1 if the CD media is locked (by software) in the drive.

cd_media

Optional attribute; read/write access; type: unknown type.

Connected CD media. This object must implement the 'cdrom-media' interface. Set to NIL to eject current media.

cmd_bytes

Optional attribute; read/write access; type: unknown type.

The command bytes received so far.

cmd_len

Optional attribute; read/write access; type: unknown type.

Length of the command received from the host.

command

Optional attribute; read/write access; type: unknown type.

The current SCSI command.

data_buffer

Optional attribute; read/write access; type: unknown type.

Buffer with data to transfer.

data_len

Optional attribute; read/write access; type: unknown type.

The length of data to transfer.

lun

Optional attribute; read/write access; type: unknown type.

The currently selected LUN (logical unit).

max_data_width

Optional attribute; read/write access; type: unknown type.

The maximum supported data transfer width in bytes.

may_disc

Optional attribute; read/write access; type: unknown type.

Set to 1 if the CD-ROM may disconnect from the current session.

media_changed

Optional attribute; read/write access; type: unknown type.

Set to 1 if the CD media has changed and no command has been issued to it.

memory

Optional attribute; read/write access; type: unknown type.

Backdoor access: Name of a memory space object, that implements the 'lookup' interface.

mesg_buffer

Optional attribute; read/write access; type: unknown type.

Buffer with SCSI message to transfer.

mesg_bytes

Optional attribute; read/write access; type: unknown type.

The message bytes received so far.

mesg_len

Optional attribute; read/write access; type: unknown type.

Length of the message received from the host.

mode_pages

Optional attribute; read/write access; type: unknown type.

Mode pages for the disk.

model

Optional attribute; read/write access; type: unknown type.

Model name of the disk.

ns_per_transfer

Optional attribute; read/write access; type: Integer.

The constant delay, in nanoseconds, for a CD-ROM transfer. This delay will be added to the size-dependent delay set by the 'ns_per_unit' attribute. Note that this is not the same as average seek time for random accesses. (This attribute will be replaced by a more detailed timing model in the future.)

ns_per_unit

Optional attribute; read/write access; type: Integer.

The number of nanoseconds it takes to transfer data of the size set in the 'timing_unit_size' attribute. This delay will be added to the constant delay set in the 'ns_per_transfer' attribute. (This attribute will be replaced by a more detailed timing model in the future.)

queue_length

Optional attribute; read/write access; type: unknown type.

Length of SCSI command queue (not implemented).

req_size

Optional attribute; read/write access; type: unknown type.

Length of data requested from host.

reselect_id

Optional attribute; read/write access; type: unknown type.

SCSI ID of controller to reselect.

reselect_op

Optional attribute; read/write access; type: unknown type.

Operation that will continue after reselection.

reselection_support

Optional attribute; read/write access; type: unknown type.

Set to 1 if the CD-ROM supports reselection (not functional).

reserved_flag

Optional attribute; read/write access; type: unknown type.

Set if the device is reserved.

reserved_id

Optional attribute; read/write access; type: unknown type.

SCSI ID of the initiator that is allowed to use the reserved device. Only valid if the 'reserved_flag' attribute is 1.

reserved_initiator

Optional attribute; read/write access; type: unknown type.

SCSI ID of the initiator that performed the reservation of the device. Only valid if the 'reserved_flag' attribute is 1.

revision

Optional attribute; read/write access; type: unknown type.

Revision string of the disk.

scsi_bus

Required attribute; read/write access; type: unknown type.

Name of the SCSI bus the CD-ROM is connected to. This object must implement the 'scsi-bus' interface.

scsi_commands

Pseudo attribute; read-only access; ; integer indexed; indexed type: String.

Pseudo attribute returning the SCSI command name (as a string) given an integer index representing the command.

scsi_target

Required attribute; read/write access; type: unknown type.

Target ID on the SCSI bus for the CD-ROM.

sector_data

Pseudo attribute; read/write access; ; integer indexed; indexed type: Data.

Can be used to access a sector (2048 bytes) on the CD-ROM.

sectors_read

Session attribute; read-only access; type: Integer.

Number of sectors read in the current simulation session.

sectors_written

Session attribute; read-only access; type: Integer.

Number of sectors written in the current simulation session.

selection_time

Optional attribute; read/write access; type: Float.

The selection time on the SCSI bus in seconds.

sense_key

Optional attribute; read/write access; type: unknown type.

Current Sense Key code.

stat_buffer

Optional attribute; read/write access; type: unknown type.

Buffer with Status to transfer.

stat_len

Optional attribute; read/write access; type: unknown type.

The length of the status field to transfer.

synchronous_support

Optional attribute; read/write access; type: unknown type.

Set to 1 if the CD-ROM supports synchronous transfers (no-op).

timing_unit_size

Optional attribute; read/write access; type: Integer.

The amount of data (in bytes) that the is used to calculate CD-ROM delays together with the 'ns_per_unit' attribute. (This attribute will be replaced by a more detailed timing model in the future.)

transfer

Optional attribute; read/write access; type: unknown type.

List of active transfer buffers for data message and status.

vendor

Optional attribute; read/write access; type: unknown type.

Vendor name of the disk.

vendor_specific_id

Optional attribute; read/write access; type: unknown type.

Vendor Specific string for the disk - often used as serial id.

vpd_pages

Optional attribute; read/write access; type: unknown type.

VPD pages for the disk.

Command List

Commands defined by interface log_object

log, log-group, log-level, log-size, log-type

Commands

eject	eject media from CD-ROM drive
info	print information about the device
insert	insert medium in CD-ROM drive
status	print status of the device

Command Descriptions

<scsi-cdrom>.eject

Synopsis

<scsi-cdrom>.eject

Description

Eject a media from the CD-ROM drive. The media must have been previously inserted with the 'insert' command.

<scsi-cdrom>.info

Synopsis

<scsi-cdrom>.info

Description

Print detailed information about the configuration of the device.

<scsi-cdrom>.insert

Synopsis

<scsi-cdrom>.insert medium

Description

Insert a medium in the CD-ROM drive. The medium is the name of a CD-ROM media object, e.g. a file-cdrom or host-cdrom object.

<scsi-cdrom>.status

Synopsis

<scsi-cdrom>.status

Description

Print detailed information about the current status of the device.

VIRTUTECH CONFIDENTIAL    Previous - Up - Next