IOStorageDeviceCharacteristics.h

Overview

Use the links in the table of contents to the left to access the documentation.



Macro Definitions

kIOPropertyBytesPerPhysicalSectorKey
kIOPropertyCylinderCountKey
kIOPropertyDeviceCharacteristicsKey
kIOPropertyHeadCountKey
kIOPropertyLogicalBlockSizeKey
kIOPropertyMediumRotationRateKey
kIOPropertyMediumTypeKey
kIOPropertyMediumTypeRotationalKey
kIOPropertyMediumTypeSolidStateKey
kIOPropertyPhysicalBlockSizeKey
kIOPropertyProductNameKey
kIOPropertyProductRevisionLevelKey
kIOPropertyProductSerialNumberKey
kIOPropertyRigidDiskGeometryKey
kIOPropertySectorCountPerTrackKey
kIOPropertySupportedBDFeaturesKey
kIOPropertySupportedCDFeaturesKey
kIOPropertySupportedDVDFeaturesKey
kIOPropertyTargetDiskModeKey
kIOPropertyVendorNameKey

kIOPropertyBytesPerPhysicalSectorKey


#define kIOPropertyBytesPerPhysicalSectorKey "Bytes per Physical Sector" 
Discussion

This key is used to define the number of heads for a particular medium.

Requirement: Mandatory element of the Rigid Disk Geometry dictionary.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>Rigid Disk Geometry</key>
		<dict>
			<key>Sector Count per Track</key>
			<integer>12345</integer>
			<key>Head Count</key>
			<integer>12</integer>
			<key>Cylinder Count</key>
			<integer>12345</integer>
			<key>Bytes per Physical Sector</key>
			<integer>512</integer>
		</dict>
	</dict>
</dict>


kIOPropertyCylinderCountKey


#define kIOPropertyCylinderCountKey "Cylinder Count" 
Discussion

This key is used to define the number of heads for a particular medium.

Requirement: Mandatory element of the Rigid Disk Geometry dictionary.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>Rigid Disk Geometry</key>
		<dict>
			<key>Sector Count per Track</key>
			<integer>12345</integer>
			<key>Head Count</key>
			<integer>12</integer>
			<key>Cylinder Count</key>
			<integer>12345</integer>
			<key>Bytes per Physical Sector</key>
			<integer>512</integer>
		</dict>
	</dict>
</dict>


kIOPropertyDeviceCharacteristicsKey


#define kIOPropertyDeviceCharacteristicsKey "Device Characteristics" 
Discussion

This key is used to define Device Characteristics for a particular device and it has an associated dictionary which lists the device characteristics. The device characteristics are Command Set specific and are listed in the header files for each command set.

Requirement: Mandatory

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
	</dict>
</dict>


kIOPropertyHeadCountKey


#define kIOPropertyHeadCountKey "Head Count" 
Discussion

This key is used to define the number of heads for a particular medium.

Requirement: Mandatory element of the Rigid Disk Geometry dictionary.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>Rigid Disk Geometry</key>
		<dict>
			<key>Sector Count per Track</key>
			<integer>12345</integer>
			<key>Head Count</key>
			<integer>12</integer>
			<key>Cylinder Count</key>
			<integer>12345</integer>
			<key>Bytes per Physical Sector</key>
			<integer>512</integer>
		</dict>
	</dict>
</dict>


kIOPropertyLogicalBlockSizeKey


#define kIOPropertyLogicalBlockSizeKey "Logical Block Size" 
Discussion

This key is used to define the logical block size of a hard disk drive.

Requirement: Mandatory for hard disk drives with logical block size other than 512 bytes or that does not match its physical block size.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>Physical Block Size</key>
		<integer>4096</integer>
		<key>Logical Block Size</key>
		<integer>512</integer>
	</dict>
</dict>


kIOPropertyMediumRotationRateKey


#define kIOPropertyMediumRotationRateKey "Rotation Rate" 
Discussion

This key is used to indicate the medium rotation rate in RPM of the device.

Requirement: Optional.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>AAPL</string>
		<key>Product Name</key>
		<string>FireWire Target</string>
		<key>Product Revision Level</key>
		<string>0000</string>
		<key>Rotation Rate</key>
		<integer>7200</integer>
	</dict>
</dict>


kIOPropertyMediumTypeKey


#define kIOPropertyMediumTypeKey "Medium Type" 
Discussion

This key is used to indicate the medium type of the device.

Requirement: Optional.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>AAPL</string>
		<key>Product Name</key>
		<string>FireWire Target</string>
		<key>Product Revision Level</key>
		<string>0000</string>
		<key>Medium Type</key>
		<string>Rotational</string>
	</dict>
</dict>


kIOPropertyMediumTypeRotationalKey


#define kIOPropertyMediumTypeRotationalKey "Rotational" 
Discussion

This key is used to indicate the medium type of the device is rotational.

Requirement: Optional.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>AAPL</string>
		<key>Product Name</key>
		<string>FireWire Target</string>
		<key>Product Revision Level</key>
		<string>0000</string>
		<key>Medium Type</key>
		<string>Rotational</string>
	</dict>
</dict>


kIOPropertyMediumTypeSolidStateKey


#define kIOPropertyMediumTypeSolidStateKey "Solid State" 
Discussion

This key is used to indicate the medium type of the device is solid state.

Requirement: Optional.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>AAPL</string>
		<key>Product Name</key>
		<string>FireWire Target</string>
		<key>Product Revision Level</key>
		<string>0000</string>
		<key>Medium Type</key>
		<string>Solid State</string>
	</dict>
</dict>


kIOPropertyPhysicalBlockSizeKey


#define kIOPropertyPhysicalBlockSizeKey "Physical Block Size" 
Discussion

This key is used to define the physical block size of a hard disk drive.

Requirement: Mandatory for hard disk drives with physical block size other than 512 bytes.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>Physical Block Size</key>
		<integer>4096</integer>
		<key>Logical Block Size</key>
		<integer>512</integer>
	</dict>
</dict>


kIOPropertyProductNameKey


#define kIOPropertyProductNameKey "Product Name" 
Discussion

This key is used to define the Product Name for a particular device and it has an associated string.

Requirement: Mandatory

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
	</dict>
</dict>


kIOPropertyProductRevisionLevelKey


#define kIOPropertyProductRevisionLevelKey "Product Revision Level" 
Discussion

This key is used to define the Product Revision Level for a particular device and it has an associated string.

Requirement: Mandatory

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
	</dict>
</dict>


kIOPropertyProductSerialNumberKey


#define kIOPropertyProductSerialNumberKey "Serial Number" 
Discussion

This key is used to define the Product Serial Number for a particular device and it has an associated data.

Requirement: Mandatory

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>Serial Number</key>
		<string>123456789</string>
	</dict>
</dict>


kIOPropertyRigidDiskGeometryKey


#define kIOPropertyRigidDiskGeometryKey "Rigid Disk Geometry" 
Discussion

This key is used to define a dictionary containing rigid disk geometry information.

Requirement: Optional. If a device publishes this dictionary, it must publish all key/value pairs which are deemed Mandatory.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>Rigid Disk Geometry</key>
		<dict>
			<key>Sector Count per Track</key>
			<integer>12345</integer>
			<key>Head Count</key>
			<integer>12</integer>
			<key>Cylinder Count</key>
			<integer>12345</integer>
			<key>Bytes per Physical Sector</key>
			<integer>512</integer>
		</dict>
	</dict>
</dict>


kIOPropertySectorCountPerTrackKey


#define kIOPropertySectorCountPerTrackKey "Sector Count per Track" 
Discussion

This key is used to define the number of sectors per each track for a particular medium.

Requirement: Mandatory element of the Rigid Disk Geometry dictionary.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>Rigid Disk Geometry</key>
		<dict>
			<key>Sector Count per Track</key>
			<integer>12345</integer>
		</dict>
	</dict>
</dict>


kIOPropertySupportedBDFeaturesKey


#define kIOPropertySupportedBDFeaturesKey "BD Features" 
Discussion

This key is used to define the supported BD Features for a particular optical device and it has an associated bitfield. See for definitions of the bits and associated bitmasks.

Requirement: Mandatory for optical devices (Peripheral Device Type 05h).

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>SuperDrive</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>CD Features</key>
		<integer>1663</integer>
		<key>DVD Features</key>
		<integer>103</integer>
		<key>BD Features</key>
		<integer>21</integer>
	</dict>
</dict>


kIOPropertySupportedCDFeaturesKey


#define kIOPropertySupportedCDFeaturesKey "CD Features" 
Discussion

This key is used to define the supported CD Features for a particular optical device and it has an associated bitfield. See for definitions of the bits and associated bitmasks.

Requirement: Mandatory for optical devices (Peripheral Device Type 05h).

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>SuperDrive</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>CD Features</key>
		<integer>1663</integer>
		<key>DVD Features</key>
		<integer>103</integer>
	</dict>
</dict>


kIOPropertySupportedDVDFeaturesKey


#define kIOPropertySupportedDVDFeaturesKey "DVD Features" 
Discussion

This key is used to define the supported DVD Features for a particular optical device and it has an associated bitfield. See for definitions of the bits and associated bitmasks.

Requirement: Mandatory for optical devices (Peripheral Device Type 05h).

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>SuperDrive</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
		<key>CD Features</key>
		<integer>1663</integer>
		<key>DVD Features</key>
		<integer>103</integer>
	</dict>
</dict>


kIOPropertyTargetDiskModeKey


#define kIOPropertyTargetDiskModeKey "Target Disk Mode" 
Discussion

This key is used to indicate the device is another computer in Target Disk Mode.

Requirement: Optional.

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>AAPL</string>
		<key>Product Name</key>
		<string>FireWire Target</string>
		<key>Product Revision Level</key>
		<string>0000</string>
		<key>Target Disk Mode</key>
		<true/>
	</dict>
</dict>


kIOPropertyVendorNameKey


#define kIOPropertyVendorNameKey "Vendor Name" 
Discussion

This key is used to define the Vendor Name for a particular device and it has an associated string.

Requirement: Mandatory

Example:

<dict>
	<key>Device Characteristics</key>
	<dict>
		<key>Vendor Name</key>
		<string>Apple</string>
		<key>Product Name</key>
		<string>iPod</string>
		<key>Product Revision Level</key>
		<string>1.0</string>
	</dict>
</dict>

 

Did this document help you? Yes It's good, but... Not helpful...

 

Last Updated: 2009-10-15