IOStorageDeviceCharacteristics.h Reference

Declared in
IOStorageDeviceCharacteristics.h

Overview

Included Headers

  • <IOKit/storage/IOStorageProtocolCharacteristics.h>

Constants

See the Overview section above for header-level documentation.

Miscellaneous Defines

   
#define kIOPropertyBytesPerPhysicalSectorKey "Bytes per Physical Sector"
#define kIOPropertyCylinderCountKey "Cylinder Count"
#define kIOPropertyDeviceCharacteristicsKey "Device Characteristics"
#define kIOPropertyHeadCountKey "Head Count"
#define kIOPropertyLogicalBlockSizeKey "Logical Block Size"
#define kIOPropertyMediumRotationRateKey "Rotation Rate"
#define kIOPropertyMediumTypeKey "Medium Type"
#define kIOPropertyMediumTypeRotationalKey "Rotational"
#define kIOPropertyMediumTypeSolidStateKey "Solid State"
#define kIOPropertyPhysicalBlockSizeKey "Physical Block Size"
#define kIOPropertyProductNameKey "Product Name"
#define kIOPropertyProductRevisionLevelKey "Product Revision Level"
#define kIOPropertyProductSerialNumberKey "Serial Number"
#define kIOPropertyRigidDiskGeometryKey "Rigid Disk Geometry"
#define kIOPropertySectorCountPerTrackKey "Sector Count per Track"
#define kIOPropertySupportedBDFeaturesKey "BD Features"
#define kIOPropertySupportedCDFeaturesKey "CD Features"
#define kIOPropertySupportedDVDFeaturesKey "DVD Features"
#define kIOPropertyTargetDiskModeKey "Target Disk Mode"
#define kIOPropertyVendorNameKey "Vendor Name"
Constants
kIOPropertyBytesPerPhysicalSectorKey

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>

Available in OS X v10.3 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyCylinderCountKey

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>

Available in OS X v10.3 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyDeviceCharacteristicsKey

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>

Available in OS X v10.1 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyHeadCountKey

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>

Available in OS X v10.3 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyLogicalBlockSizeKey

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>

Available in OS X v10.5 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyMediumRotationRateKey

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>

Available in OS X v10.6 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyMediumTypeKey

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>

Available in OS X v10.6 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyMediumTypeRotationalKey

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>

Available in OS X v10.6 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyMediumTypeSolidStateKey

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>

Available in OS X v10.6 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyPhysicalBlockSizeKey

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>

Available in OS X v10.5 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyProductNameKey

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>

Available in OS X v10.1 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyProductRevisionLevelKey

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>

Available in OS X v10.1 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyProductSerialNumberKey

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>

Available in OS X v10.4 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyRigidDiskGeometryKey

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>

Available in OS X v10.3 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertySectorCountPerTrackKey

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>

Available in OS X v10.3 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertySupportedBDFeaturesKey

This key is used to define the supported BD Features for a particular optical device and it has an associated bitfield. See <IOKit/scsi/IOSCSIMultimediaCommandsDevice.h> 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>

Available in OS X v10.5 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertySupportedCDFeaturesKey

This key is used to define the supported CD Features for a particular optical device and it has an associated bitfield. See <IOKit/scsi/IOSCSIMultimediaCommandsDevice.h> 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>

Available in OS X v10.3 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertySupportedDVDFeaturesKey

This key is used to define the supported DVD Features for a particular optical device and it has an associated bitfield. See <IOKit/scsi/IOSCSIMultimediaCommandsDevice.h> 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>

Available in OS X v10.3 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyTargetDiskModeKey

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>

Available in OS X v10.6 and later.

Declared in IOStorageDeviceCharacteristics.h.

kIOPropertyVendorNameKey

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>

Available in OS X v10.1 and later.

Declared in IOStorageDeviceCharacteristics.h.