Mac Developer Library

Developer

IOStorageProtocolCharacteristics.h Reference

Options
Deployment Target:

On This Page

IOStorageProtocolCharacteristics.h Reference

Constants

See the Overview section above for header-level documentation.

  • Declaration

    #define kIOPropertyExternalKey "External" #define kIOPropertyFibreChannelAddressIdentifierKey "Address Identifier" #define kIOPropertyFibreChannelALPAKey "AL_PA" #define kIOPropertyFibreChannelCableDescriptionCopperKey "Copper" #define kIOPropertyFibreChannelCableDescriptionFiberOpticKey "Fiber Optic" #define kIOPropertyFibreChannelCableDescriptionKey "Fibre Channel Cabling Type" #define kIOPropertyFibreChannelNodeWorldWideNameKey "Node World Wide Name" #define kIOPropertyFibreChannelPortWorldWideNameKey "Port World Wide Name" #define kIOPropertyInterconnectFileKey "File" #define kIOPropertyInterconnectRAMKey "RAM" #define kIOPropertyInternalExternalKey "Internal/External" #define kIOPropertyInternalKey "Internal" #define kIOPropertyPhysicalInterconnectLocationKey "Physical Interconnect Location" #define kIOPropertyPhysicalInterconnectTypeATA "ATA" #define kIOPropertyPhysicalInterconnectTypeATAPI "ATAPI" #define kIOPropertyPhysicalInterconnectTypeFibreChannel "Fibre Channel Interface" #define kIOPropertyPhysicalInterconnectTypeFireWire "FireWire" #define kIOPropertyPhysicalInterconnectTypeKey "Physical Interconnect" #define kIOPropertyPhysicalInterconnectTypePCI "PCI" #define kIOPropertyPhysicalInterconnectTypeSCSIParallel "SCSI Parallel Interface" #define kIOPropertyPhysicalInterconnectTypeSecureDigital "Secure Digital" #define kIOPropertyPhysicalInterconnectTypeSerialATA "SATA" #define kIOPropertyPhysicalInterconnectTypeSerialAttachedSCSI "SAS" #define kIOPropertyPhysicalInterconnectTypeUSB "USB" #define kIOPropertyPhysicalInterconnectTypeVirtual "Virtual Interface" #define kIOPropertyPortDescriptionKey "Port Description" #define kIOPropertyPortSpeed10GigabitKey "10 Gigabit" #define kIOPropertyPortSpeed12GigabitKey "12 Gigabit" #define kIOPropertyPortSpeed16GigabitKey "16 Gigabit" #define kIOPropertyPortSpeed1_5GigabitKey "1.5 Gigabit" #define kIOPropertyPortSpeed1GigabitKey "1 Gigabit" #define kIOPropertyPortSpeed2GigabitKey "2 Gigabit" #define kIOPropertyPortSpeed3GigabitKey "3 Gigabit" #define kIOPropertyPortSpeed40GigabitKey "40 Gigabit" #define kIOPropertyPortSpeed4GigabitKey "4 Gigabit" #define kIOPropertyPortSpeed6GigabitKey "6 Gigabit" #define kIOPropertyPortSpeed8GigabitKey "8 Gigabit" #define kIOPropertyPortSpeedAutomatic10GigabitKey "Automatic (10 Gigabit)" #define kIOPropertyPortSpeedAutomatic1_5GigabitKey "Automatic (1.5 Gigabit)" #define kIOPropertyPortSpeedAutomatic1GigabitKey "Automatic (1 Gigabit)" #define kIOPropertyPortSpeedAutomatic2GigabitKey "Automatic (2 Gigabit)" #define kIOPropertyPortSpeedAutomatic3GigabitKey "Automatic (3 Gigabit)" #define kIOPropertyPortSpeedAutomatic4GigabitKey "Automatic (4 Gigabit)" #define kIOPropertyPortSpeedAutomatic6GigabitKey "Automatic (6 Gigabit)" #define kIOPropertyPortSpeedAutomatic8GigabitKey "Automatic (8 Gigabit)" #define kIOPropertyPortSpeedAutomaticKey "Automatic" #define kIOPropertyPortSpeedKey "Port Speed" #define kIOPropertyPortStatusKey "Port Status" #define kIOPropertyPortStatusLinkEstablishedKey "Link Established" #define kIOPropertyPortStatusLinkFailedKey "Link Failed" #define kIOPropertyPortStatusNoLinkEstablishedKey "No Link Established" #define kIOPropertyPortTopologyAutomaticKey "Automatic" #define kIOPropertyPortTopologyAutomaticNLPortKey "Automatic (NL_Port)" #define kIOPropertyPortTopologyAutomaticNPortKey "Automatic (N_Port)" #define kIOPropertyPortTopologyKey "Port Topology" #define kIOPropertyPortTopologyNLPortKey "NL_Port" #define kIOPropertyPortTopologyNPortKey "N_Port" #define kIOPropertyProtocolCharacteristicsKey "Protocol Characteristics" #define kIOPropertySASAddressKey "SAS Address" #define kIOPropertySCSIDomainIdentifierKey "SCSI Domain Identifier" #define kIOPropertySCSIInitiatorIdentifierKey "SCSI Initiator Identifier" #define kIOPropertySCSILogicalUnitNumberKey "SCSI Logical Unit Number" #define kIOPropertySCSIParallelSignalingTypeHVDKey "High Voltage Differential" #define kIOPropertySCSIParallelSignalingTypeKey "SCSI Parallel Signaling Type" #define kIOPropertySCSIParallelSignalingTypeLVDKey "Low Voltage Differential" #define kIOPropertySCSIParallelSignalingTypeSEKey "Single Ended" #define kIOPropertySCSIPortIdentifierKey "Unique SCSI Port Identifier" #define kIOPropertySCSIProtocolMultiInitKey "Multiple Initiators" #define kIOPropertySCSITargetIdentifierKey "SCSI Target Identifier"

    Constants

    • kIOPropertyExternalKey

      This key defines the value of External for the key kIOPropertyPhysicalInterconnectLocationKey. If the device is connected to an external bus, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Fibre Channel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. </dict>
      9. </dict>
    • kIOPropertyFibreChannelAddressIdentifierKey

      This key is the 24-bit Address Identifier (S_ID or D_ID) as defined in the FC-FS specification. It contains the address identifier of the source or destination Nx_Port.

      Note: This value can change. It is not a static value.

      Requirement: Optional (only necessary for Fibre Channel Interface).

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Fibre Channel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. <key>Address Identifier</key>
      9. <data>001122</data>
      10. </dict>
      11. </dict>

      Example2:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Address Identifier</key>
      5. <data>001122</data>
      6. </dict>
      7. </dict>
    • kIOPropertyFibreChannelALPAKey

      This key is the 8-bit Arbitrated Loop Physical Address (AL_PA) value as defined in the FC-AL-2 specification.

      Note: This value can change. It is not a static value.

      Requirement: Optional (only necessary for Fibre Channel Interface).

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Fibre Channel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. <key>AL_PA</key>
      9. <data>04</data>
      10. </dict>
      11. </dict>

      Example2:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>AL_PA</key>
      5. <data>04</data>
      6. </dict>
      7. </dict>
    • kIOPropertyFibreChannelCableDescriptionCopperKey

      This key defines the value of Copper for the key kIOPropertyFibreChannelCableDescriptionKey. If the cabling is Copper, this key should be used.

      Requirement: Optional for Fibre Channel Interface interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Fibre Channel Cabling Type</key>
      5. <string>Copper</string>
      6. </dict>
      7. </dict>
    • kIOPropertyFibreChannelCableDescriptionFiberOpticKey

      This key defines the value of Fiber Optic for the key kIOPropertyFibreChannelCableDescriptionKey. If the cabling is Fiber Optic, this key should be used.

      Requirement: Optional for Fibre Channel Interface interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Fibre Channel Cabling Type</key>
      5. <string>Fiber Optic</string>
      6. </dict>
      7. </dict>
    • kIOPropertyFibreChannelCableDescriptionKey

      This key is associated with the cabling type used for this Fibre Channel port. Valid values include "Copper" and "Fiber Optic".

      Requirement: Optional for Fibre Channel Interface. Not defined for any other physical interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Fibre Channel Cabling Type</key>
      5. <string>Copper</string>
      6. </dict>
      7. </dict>
    • kIOPropertyFibreChannelNodeWorldWideNameKey

      This key is the unique 64-bit World Wide Name for the device server node located at this port, or for the initiating host port.

      Requirement: Mandatory for Fibre Channel Interface.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Fibre Channel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. <key>Node World Wide Name</key>
      9. <data>0011223344556677</data>
      10. </dict>
      11. </dict>

      Example2:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Node World Wide Name</key>
      5. <data>0011223344556677</data>
      6. </dict>
      7. </dict>
    • kIOPropertyFibreChannelPortWorldWideNameKey

      This key is the unique 64-bit World Wide Name for the port.

      Requirement: Mandatory for Fibre Channel Interface.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Fibre Channel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. <key>Port World Wide Name</key>
      9. <data>0011223344556677</data>
      10. </dict>
      11. </dict>

      Example2:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port World Wide Name</key>
      5. <data>0011223344556677</data>
      6. </dict>
      7. </dict>
    • kIOPropertyInterconnectFileKey

      This key defines the value of File for the key kIOPropertyPhysicalInterconnectLocationKey. If the device is a file that is being represented as a storage device, this key should be set.

      NOTE: This key should only be used when the Physical Interconnect is set to Virtual Interface.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Virtual Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>File</string>
      8. </dict>
      9. </dict>
    • kIOPropertyInterconnectRAMKey

      This key defines the value of RAM for the key kIOPropertyPhysicalInterconnectLocationKey. If the device is system memory that is being represented as a storage device, this key should be set.

      NOTE: This key should only be used when the Physical Interconnect is set to Virtual Interface.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Virtual Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>RAM</string>
      8. </dict>
      9. </dict>
    • kIOPropertyInternalExternalKey

      This key defines the value of Internal/External for the key kIOPropertyPhysicalInterconnectLocationKey. If the device is connected to a bus and it is indeterminate whether it is internal or external, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SCSI Parallel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal/External</string>
      8. </dict>
      9. </dict>
    • kIOPropertyInternalKey

      This key defines the value of Internal for the key kIOPropertyPhysicalInterconnectLocationKey. If the device is connected to an internal bus, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>ATA</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectLocationKey

      This key is used to define the Physical Interconnect Location.

      Requirement: Mandatory.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SCSI Parallel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeATA

      This key defines the value of ATA for the key kIOPropertyPhysicalInterconnectTypeKey. If the device is connected to an ATA bus, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>ATA</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeATAPI

      This key defines the value of ATAPI for the key kIOPropertyPhysicalInterconnectTypeKey. If the device is connected to an ATA bus and follows the ATAPI command specification, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>ATAPI</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeFibreChannel

      This key defines the value of Fibre Channel Interface for the key kIOPropertyPhysicalInterconnectTypeKey. If the device is connected to a Fibre Channel port, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Fibre Channel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeFireWire

      This key defines the value of USB for the key kIOPropertyPhysicalInterconnectTypeKey. If the device is connected to a FireWire port, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>FireWire</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeKey

      This key is used to define the Physical Interconnect to which a device is attached.

      Requirement: Mandatory.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SCSI Parallel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypePCI

      This key defines the value of PCI for the key kIOPropertyPhysicalInterconnectTypePCI. If the device is connected via PCI, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>PCI</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeSCSIParallel

      This key defines the value of SCSI Parallel Interface for the key kIOPropertyPhysicalInterconnectTypeKey. If the device is connected to a SCSI Parallel port, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SCSI Parallel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeSecureDigital

      This key defines the value of Secure Digital for the key kIOPropertyPhysicalInterconnectTypeSecureDigital. If the device is connected to a Secure Digital port and follows the Secure Digital specification, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Secure Digital</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeSerialATA

      This key defines the value of SATA for the key kIOPropertyPhysicalInterconnectTypeKey. If the device is connected to a SATA bus, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SATA</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeSerialAttachedSCSI

      This key defines the value of SAS for the key kIOPropertyPhysicalInterconnectTypeKey. If the device is connected to a SAS bus, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SAS</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeUSB

      This key defines the value of USB for the key kIOPropertyPhysicalInterconnectTypeKey. If the device is connected to a USB port, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>USB</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPhysicalInterconnectTypeVirtual

      This key defines the value of Virtual Interface for the key kIOPropertyPhysicalInterconnectTypeVirtual. If the device is being made to look like a storage device, but is not such in actuality, such as a File or RAM, this key should be set.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Virtual Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>File</string>
      8. </dict>
      9. </dict>
    • kIOPropertyPortDescriptionKey

      This key is associated with an human readable port description. Examples include "Channel A", "Port 1", etc.

      Requirement: Optional for all interconnects.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Description</key>
      5. <string>Channel A</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed10GigabitKey

      This key defines the value of 10 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 10 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>10 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed12GigabitKey

      This key defines the value of 12 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 12 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>12 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed16GigabitKey

      This key defines the value of 16 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 16 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>16 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed1_5GigabitKey

      This key defines the value of 1.5 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 1.5 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>1.5 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed1GigabitKey

      This key defines the value of 1 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 1 Gigabit per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>1 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed2GigabitKey

      This key defines the value of 2 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 2 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>2 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed3GigabitKey

      This key defines the value of 3 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 3 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>3 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed40GigabitKey

      This key defines the value of 40 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 40 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>40 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed4GigabitKey

      This key defines the value of 4 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 4 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>4 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed6GigabitKey

      This key defines the value of 6 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 6 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>6 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeed8GigabitKey

      This key defines the value of 8 Gigabit for the key kIOPropertyPortSpeedKey. If the speed of the port is 8 Gigabits per second and is not automatically determined (i.e. the user configured the port to be exactly this speed), this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>8 Gigabit</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomatic10GigabitKey

      This key defines the value of Automatic (10 Gigabit) for the key kIOPropertyPortSpeedKey. If the speed of the port is 10 Gigabits per second and is automatically determined by host software, this key should be used. Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (10 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomatic1_5GigabitKey

      This key defines the value of Automatic (1.5 Gigabit) for the key kIOPropertyPortSpeedKey. If the speed of the port is 1.5 Gigabits per second and is automatically determined by host software, this key should be used. Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (1.5 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomatic1GigabitKey

      This key defines the value of Automatic (1 Gigabit) for the key kIOPropertyPortSpeedKey. If the speed of the port is 1 Gigabit per second and is automatically determined by host software, this key should be used. Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (1 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomatic2GigabitKey

      This key defines the value of Automatic (2 Gigabit) for the key kIOPropertyPortSpeedKey. If the speed of the port is 2 Gigabits per second and is automatically determined by host software, this key should be used. Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (2 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomatic3GigabitKey

      This key defines the value of Automatic (3 Gigabit) for the key kIOPropertyPortSpeedKey. If the speed of the port is 3 Gigabits per second and is automatically determined by host software, this key should be used. Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (3 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomatic4GigabitKey

      This key defines the value of Automatic (4 Gigabit) for the key kIOPropertyPortSpeedKey. If the speed of the port is 4 Gigabits per second and is automatically determined by host software, this key should be used. Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (4 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomatic6GigabitKey

      This key defines the value of Automatic (6 Gigabit) for the key kIOPropertyPortSpeedKey. If the speed of the port is 6 Gigabits per second and is automatically determined by host software, this key should be used. Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (6 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomatic8GigabitKey

      This key defines the value of Automatic (8 Gigabit) for the key kIOPropertyPortSpeedKey. If the speed of the port is 8 Gigabits per second and is automatically determined by host software, this key should be used. Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (8 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedAutomaticKey

      This key defines the value of Automatic for the key kIOPropertyPortSpeedKey. If the speed of the port is automatically adjusted by the host/device and a definitive speed is not known, this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortSpeedKey

      This key is associated with the current port speed. The port speed can be any valid speed for the interconnect.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Speed</key>
      5. <string>Automatic (1 Gigabit)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortStatusKey

      This key is associated with the current port status of the physical link. The port status is either "Link Established", "No Link Established", or "Link Failed".

      Note: This value can change when the port status changes. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Status</key>
      5. <string>Link Established</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortStatusLinkEstablishedKey

      This key defines the value of Link Established for the key kIOPropertyPortStatusKey.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Status</key>
      5. <string>Link Established</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortStatusLinkFailedKey

      This key defines the value of Link Failed for the key kIOPropertyPortStatusKey.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Status</key>
      5. <string>Link Failed</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortStatusNoLinkEstablishedKey

      This key defines the value of No Link Established for the key kIOPropertyPortStatusKey.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Status</key>
      5. <string>No Link Established</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortTopologyAutomaticKey

      This key defines the value of Automatic for the key kIOPropertyPortTopologyKey. If the topology of the port is automatically adjusted by the host/device and a definitive topology is not known, this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Topology</key>
      5. <string>Automatic</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortTopologyAutomaticNLPortKey

      This key defines the value of Automatic (NL_Port) for the key kIOPropertyPortTopologyKey. If the topology of the port is NL_Port and is automatically determined by host software, this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Topology</key>
      5. <string>Automatic (NL_Port)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortTopologyAutomaticNPortKey

      This key defines the value of Automatic (N_Port) for the key kIOPropertyPortTopologyKey. If the topology of the port is N_Port and is automatically determined by host software, this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Topology</key>
      5. <string>Automatic (N_Port)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortTopologyKey

      This key is associated with the current port topology. The port topology can be any valid topology for the interconnect.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Topology</key>
      5. <string>Automatic (N_Port)</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortTopologyNLPortKey

      This key defines the value of NL_Port for the key kIOPropertyPortTopologyKey. If the topology of the port is an NL_Port, this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Topology</key>
      5. <string>NL_Port</string>
      6. </dict>
      7. </dict>
    • kIOPropertyPortTopologyNPortKey

      This key defines the value of N_Port for the key kIOPropertyPortTopologyKey. If the topology of the port is an N_Port, this key should be used.

      Note: This value can change. It is not a static value.

      Requirement: Optional for any interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Port Topology</key>
      5. <string>N_Port</string>
      6. </dict>
      7. </dict>
    • kIOPropertyProtocolCharacteristicsKey

      This key is used to define Protocol Characteristics for a particular protocol and it has an associated dictionary which lists the protocol characteristics.

      Requirement: Mandatory

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>ATAPI</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. </dict>
      9. </dict>
    • kIOPropertySASAddressKey

      This key is the unique 64-bit SAS Address for the device server node located at this port, or for the initiating host port.

      Requirement: Mandatory for SAS.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SAS</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. <key>SAS Address</key>
      9. <data>0011223344556677</data>
      10. </dict>
      11. </dict>

      Example2:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>SAS Address</key>
      5. <data>0011223344556677</data>
      6. </dict>
      7. </dict>
    • kIOPropertySCSIDomainIdentifierKey

      An identifier that will uniquely identify this SCSI Domain for the Physical Interconnect type. This identifier is only guaranteed to be unique for any given Physical Interconnect and is not guaranteed to be the same across restarts or shutdowns.

      Requirement: Mandatory for SCSI Parallel Interface and Fibre Channel Interface.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SCSI Parallel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. <key>SCSI Domain Identifier</key>
      9. <integer>0</integer>
      10. </dict>
      11. </dict>
    • kIOPropertySCSIInitiatorIdentifierKey

      An identifier that will uniquely identify this SCSI Initiator for the SCSI Domain.

      Requirement: Mandatory for SCSI Parallel Interface, SAS, and Fibre Channel Interface.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SCSI Parallel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. <key>SCSI Initiator Identifier</key>
      9. <integer>7</integer>
      10. </dict>
      11. </dict>
    • kIOPropertySCSILogicalUnitNumberKey

      This key is the SCSI Logical Unit Number for the device server controlled by the driver.

      Requirement: Mandatory for SCSI Parallel Interface, SAS, and Fibre Channel Interface.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SCSI Parallel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. <key>SCSI Logical Unit Number</key>
      9. <integer>2</integer>
      10. </dict>
      11. </dict>
    • kIOPropertySCSIParallelSignalingTypeHVDKey

      This key defines the value of High Voltage Differential for the key kIOPropertySCSIParallelSignalingTypeKey. If the signaling type of the port is High Voltage Differential, this key should be used.

      Requirement: Optional for SCSI Parallel Interface interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>SCSI Parallel Signaling Type</key>
      5. <string>High Voltage Differential</string>
      6. </dict>
      7. </dict>
    • kIOPropertySCSIParallelSignalingTypeKey

      This key is associated with the signaling type used for this SCSI Parallel bus. Valid values include "High Voltage Differential", "Low Voltage Differential", and "Single Ended".

      Requirement: Optional for SCSI Parallel Interface. Not defined for any other physical interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>SCSI Parallel Signaling Type</key>
      5. <string>High Voltage Differential</string>
      6. </dict>
      7. </dict>
    • kIOPropertySCSIParallelSignalingTypeLVDKey

      This key defines the value of Low Voltage Differential for the key kIOPropertySCSIParallelSignalingTypeKey. If the signaling type of the port is Low Voltage Differential, this key should be used.

      Requirement: Optional for SCSI Parallel Interface interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>SCSI Parallel Signaling Type</key>
      5. <string>Low Voltage Differential</string>
      6. </dict>
      7. </dict>
    • kIOPropertySCSIParallelSignalingTypeSEKey

      This key defines the value of Single Ended for the key kIOPropertySCSIParallelSignalingTypeKey. If the signaling type of the port is Single Ended, this key should be used.

      Requirement: Optional for SCSI Parallel Interface interconnect.

      Example:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>SCSI Parallel Signaling Type</key>
      5. <string>Single Ended</string>
      6. </dict>
      7. </dict>
    • kIOPropertySCSIPortIdentifierKey

      This key is the unique port identifier for the device server node located at this port, or for the initiating host port. The format for this data is allowed to be vendor-specific, as long as it is guaranteed to be unique. Length is arbitrary, to allow for itnerfaces with non-standard identifier rules. It is recommended to have this be a copy of an existing standard unique identifier for this port, should one already exist for your interface type

      Requirement: Mandatory.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Fibre Channel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. <key>Node World Wide Name</key>
      9. <data>0011223344556677</data>
      10. <key>Unique SCSI Port Identifier</key>
      11. <data>0011223344556677</data>
      12. </dict>
      13. </dict>

      Example2:

      1. <dict>
      2. <key>Controller Characteristics</key>
      3. <dict>
      4. <key>Unique SCSI Port Identifier</key>
      5. <data>0011223344556677</data>
      6. </dict>
      7. </dict>
    • kIOPropertySCSIProtocolMultiInitKey

      This protocol characteristics key is used to inform the system that the protocol supports having multiple devices that act as initiators.

      Requirement: Optional.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>Fibre Channel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>External</string>
      8. <key>Multiple Initiators</key>
      9. <string>True</string>
      10. </dict>
      11. </dict>
    • kIOPropertySCSITargetIdentifierKey

      This is the SCSI Target Identifier for a given SCSI Target Device.

      Requirement: Mandatory for SCSI Parallel Interface and Fibre Channel Interface.

      Example:

      1. <dict>
      2. <key>Protocol Characteristics</key>
      3. <dict>
      4. <key>Physical Interconnect</key>
      5. <string>SCSI Parallel Interface</string>
      6. <key>Physical Interconnect Location</key>
      7. <string>Internal</string>
      8. <key>SCSI Target Identifier</key>
      9. <integer>3</integer>
      10. </dict>
      11. </dict>