VIRTUTECH CONFIDENTIAL    Previous - Up - Next

ide-disk

Provided by
ide
Class Hierarchy
conf-objectlog-objectide-disk
Interfaces Implemented
log_object
Description
Instances of the ide-disk class are generic IDE disks with several of tunable parameters. PIO is supported up to mode 4, and Ultra DMA up to level 2.

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
Optional attribute; read/write access; type: s|[iii].

sector buffer | atapi packet. Current transfer source/destination.

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

Last command.

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

Control register.

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

Cylinder number (cylinder high and cylinder low).

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

Number of logical cylinders.

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

Number of logical heads.

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

Total number of sectors on disk.

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

Number of logical sectors per track.

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

Disk timing model implementing the disksim interface. (Deprecated)

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

Device number in the disksim extension. (Deprecated)

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

Error register.

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

Feature register.

firmware_id
Optional attribute; read/write access; type: String.

Device firmware id. Up to 8 character long string.

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

Geometry valid.

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

Lower four bits of the head register.

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

Object implementing the image interface holding device data.

model_id
Optional attribute; read/write access; type: String.

Device model id. Up to 40 character long string.

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

Set if multiword DMA is enabled.

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

Current multiword DMA mode (upper byte in identify device word 63).

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

Current PIO mode (upper byte in identify device word 51).

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

Device power mode (0==active, 1==idle, 2==standby, 3==sleep).

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

(b0, ..., b2047). Sector buffer.

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

Sector count register.

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

Sector number register.

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

Sectors per interrupt (lower byte in identify device word 59).

serial_number
Optional attribute; read/write access; type: String.

Device serial number. Up to 20 character long string.

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

(f0, ..., f255). Executed ATAPI command count (command i has been issued fi times).

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

Total number of bytes read from device using PIO.

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

Total number of bytes read or written to or from device using DMA.

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

Total number of bytes written to device using PIO.

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

(f0, ..., f255). Executed command count (command i has been issued fi times).

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

Device state.

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

Status register.

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

Transfer base.

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

Transfer bytes remaining.

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

Current transfer address.

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

Transfer finished (device view).

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

DMA finished.

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

Bytes per DRQ.

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

Number of blocks in transfer.

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

Transfer position.

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

Requested length of transfer.

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

Transfer sectors last block.

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

Transfer sectors per block.

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

Transfer sector size.

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

Update address during transfer.

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

Set if UDMA is enabled.

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

Current UDMA mode (upper byte in identify device word 88).

Command List

Commands defined by interface log_object
log, log-group, log-level, log-size, log-type
Commands
add-diff-fileadd a diff file to the image
add-diff-partial-fileadd a partial diff file to the image
add-sun-partitionadd partition from a file
create-partitionadd a partition to disk
create-sun-vtoc-headerwrite a new VTOC to a Sun disk
create-sun-vtoc-partitionwrite partition data in the VTOC on a Sun disk
default-translationget or set the default CHS translation
delete-sun-vtoc-partitiondelete partition data from the VTOC on a Sun disk
dump-sun-partitionwrite partition as a file
infoprint information about the device
print-partition-infoprint info about a pc-style partition
print-partition-tableprint the disk's pc-style partition table
print-sun-vtocprint the VTOC for a Sun disk
save-diff-filesave diff file to disk

Command Descriptions

<ide-disk>.add-diff-file
Synopsis
<ide-disk>.add-diff-file filename
Description
Add a diff file to the list of files for an disk. The diff file was typically created with the 'save-diff-file' command, or by a saved configuration. This is basically the same command as <image>.add-diff-file.
See Also
<ide-disk>.save-diff-file, <image>.add-diff-file
<ide-disk>.add-diff-partial-file
Synopsis
<ide-disk>.add-diff-partial-file filename start size
Description
Add a diff file to the list of files for an disk. The diff file was typically created with the 'save-diff-file' command, by one of the dump-*-partition commands, or by a saved configuration. This is basically the same command as <image>.add-diff-file.
See Also
<ide-disk>.save-diff-file, <image>.add-diff-file
<ide-disk>.add-sun-partition
Synopsis
<ide-disk>.add-sun-partition number file
Description
Adds an image or diff as a sun partition to the current disk.
See Also
<ide-disk>.dump-sun-partition
<ide-disk>.create-partition
Synopsis
<ide-disk>.create-partition partition start_cylinder start_head start_sector end_cylinder end_head end_sector (type_id|"type_name") start_lba size_in_sectors [-boot-indication]
Description
Add a partition to a disk's partition table. Will create a primary PC-style partition with number partition. Any existing partition will be overwritten. The start location of the partition is given both in CHS format with start_cylinder, start_head, start_sector, and in linear format with start_lba. The partition endpoint is specified in CHS format with end_cylinder, end_head, and end_sector. The size in 512-byte sectors is size_in_sectors.

The slight overspecification of the parameters is there because they depend on how the BIOS translates the disk geometry to the BIOS geometry. All CHS coordinates given to this command should be in the translated BIOS geometry.

The partition boot bit is enabled with the -boot-indication flag (default off).

The partition type can either raw numerical code, or a symbolic name. The following symbolic names are understood by the command: "unused" (0x0), "DOS 12-bit FAT" (0x1), "DOS 3.0+ 16-bit FAT" (0x4), "DOS 3.3+ extended" (0x5), "DOS 3.31+ 16-bit FAT" (0x6), "OS/2 IFS" (0x7), "OS/2 boot manager" (0xa), "Win95 32-bit FAT" (0xb), "Win95 32-bit FAT, LBA" (0xc), "Win95 16-bit FAT, LBA" (0xe), "Win95 extended, LBA" (0xf), "Linux swap" (0x82), "Linux native" (0x83), "Linux extended" (0x85), "Linux LVM" (0x8e), "BSD/386" (0xa5), "OpenBSD" (0xa6), "NetBSD" (0xa9), and "BeOS" (0xeb).

See Also
<ide-disk>.print-partition-table
<ide-disk>.create-sun-vtoc-header
Synopsis
<ide-disk>.create-sun-vtoc-header [C] [H] [S] [-quiet]
Description
Create and write a new VTOC to a Sun disk. The geometry information written is taken from the configuration attribute 'geometry' of the disk, unless specified with the C, H and S parameters. A new empty partition table is also created, with only the standard 'backup' partition as number 2. -quiet makes the command silent in case of success.
See Also
<ide-disk>.print-sun-vtoc, <ide-disk>.create-sun-vtoc-partition, <ide-disk>.delete-sun-vtoc-partition
<ide-disk>.create-sun-vtoc-partition
Synopsis
<ide-disk>.create-sun-vtoc-partition number "tag" "flag" start-block num-blocks [-quiet]
Description
Write partition information to the VTOC on a Sun disk. This command does not change the format of the disk, and it does not create any file system on the partition. Only the 'Volume Table Of Contents' is modified. No checking is performed to make sure that partitions do not overlap, or that they do not exceed the disk size. -quiet makes the command silent in case of success.
See Also
<ide-disk>.print-sun-vtoc, <ide-disk>.create-sun-vtoc-header, <ide-disk>.delete-sun-vtoc-partition
<ide-disk>.default-translation
Synopsis
<ide-disk>.default-translation [C] [H] [S]
Description
Set the default CHS translation of a disk, or get the current one if no arguments are given.
<ide-disk>.delete-sun-vtoc-partition
Synopsis
<ide-disk>.delete-sun-vtoc-partition number [-quiet]
Description
Delete the information in the VTOC on a Sun disk for the specified partition. No other modification on the disk is performed. -quiet makes the command silent in case of success.
See Also
<ide-disk>.print-sun-vtoc, <ide-disk>.create-sun-vtoc-header, <ide-disk>.create-sun-vtoc-partition
<ide-disk>.dump-sun-partition
Synopsis
<ide-disk>.dump-sun-partition number file
Description
Write all data from a Sun disk partition to the specified file in raw format.
See Also
<ide-disk>.print-sun-vtoc, <ide-disk>.add-sun-partition
<ide-disk>.info
Synopsis
<ide-disk>.info
Description
Print detailed information about the configuration of the device.
<ide-disk>.print-partition-info
Synopsis
<ide-disk>.print-partition-info num ["filename"]
Description
Print information about a partition. If a filename is given, then suitable partition parameters for use with image aware e2tools will be written to that file.
<ide-disk>.print-partition-table
Synopsis
<ide-disk>.print-partition-table
Description
Print the PC-style partition table for a disk.
See Also
<ide-disk>.create-partition
<ide-disk>.print-sun-vtoc
Synopsis
<ide-disk>.print-sun-vtoc
Description
Print the contents of the VTOC (volume table of contents) for a Sun disk. This is similar to the Solaris 'prtvtoc' command.
See Also
<ide-disk>.create-sun-vtoc-header, <ide-disk>.create-sun-vtoc-partition, <ide-disk>.delete-sun-vtoc-partition
<ide-disk>.save-diff-file
Synopsis
<ide-disk>.save-diff-file filename
Description
Writes changes to the image as a diff file in craff format. This is basically the same command as <image>.safe-diff-file.
See Also
<ide-disk>.add-diff-file, <image>.save-diff-file

VIRTUTECH CONFIDENTIAL    Previous - Up - Next