| UID | title | description | old-location | tech.root | ms.date | keywords | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | f1_keywords | topic_type | api_type | api_location | api_name | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NE:ufs.UFS_ATTRIBUTES_DESCRIPTOR |
UFS_ATTRIBUTES_DESCRIPTOR (ufs.h) |
UFS_ATTRIBUTES_DESCRIPTOR describes the different types of attributes used by Universal Flash Storage (UFS) descriptors. |
storage\ufs_attributes_descriptor.htm |
storage |
03/29/2018 |
|
UFS_ATTRIBUTES_DESCRIPTOR, UFS_ATTRIBUTES_DESCRIPTOR enumeration [Storage Devices], UFS_Obsolete, UFS_Reserved01, UFS_Reserved02, UFS_Reserved03, UFS_bActiveICCLevel, UFS_bBackgroundOpStatus, UFS_bBootLunEn, UFS_bConfigDescrLock, UFS_bCurrentPowerMode, UFS_bDeviceFFUStatus, UFS_bMaxDataInSize, UFS_bMaxDataOutSize, UFS_bMaxNumOfRTT, UFS_bOutOfOrderDataEn, UFS_bPSAState, UFS_bPurgeStatus, UFS_bRefClkFreq, UFS_dDynCapNeeded, UFS_dPSADataSize, UFS_dSecondsPassed, UFS_wContextConf, UFS_wExceptionEventControl, UFS_wExceptionEventStatus, storage.ufs_attributes_descriptor, ufs/UFS_ATTRIBUTES_DESCRIPTOR, ufs/UFS_Obsolete, ufs/UFS_Reserved01, ufs/UFS_Reserved02, ufs/UFS_Reserved03, ufs/UFS_bActiveICCLevel, ufs/UFS_bBackgroundOpStatus, ufs/UFS_bBootLunEn, ufs/UFS_bConfigDescrLock, ufs/UFS_bCurrentPowerMode, ufs/UFS_bDeviceFFUStatus, ufs/UFS_bMaxDataInSize, ufs/UFS_bMaxDataOutSize, ufs/UFS_bMaxNumOfRTT, ufs/UFS_bOutOfOrderDataEn, ufs/UFS_bPSAState, ufs/UFS_bPurgeStatus, ufs/UFS_bRefClkFreq, ufs/UFS_dDynCapNeeded, ufs/UFS_dPSADataSize, ufs/UFS_dSecondsPassed, ufs/UFS_wContextConf, ufs/UFS_wExceptionEventControl, ufs/UFS_wExceptionEventStatus |
ufs.h |
Windows |
Windows 10, version 1709 |
Windows Server 2016 |
Windows |
UFS_ATTRIBUTES_DESCRIPTOR |
|
|
|
|
|
UFS_ATTRIBUTES_DESCRIPTOR describes the different types of attributes used by Universal Flash Storage (UFS) descriptors.
Indicates if the Boot Logical Unit Number(LUN) is enabled.
Reserved for future use.
Indicates the current power mode. Contains one of the following values:
| Value | Description |
|---|---|
| 0x00 | Idle power mode. |
| 0x10 | Pre-Active power mode. |
| 0x11 | Active power mode. |
| 0x20 | Pre-Sleep power mode. |
| 0x22 | Universal Flash Storage (UFS)-Sleep power mode. |
| 0x30 | 40% to 50% of the device's estimated life time has been used. |
| 0x33 | 50% to 60% of the device's estimated life time has been used. |
| All other values | Reserved for future use. |
Specifies the maximum current consumption allowed during Active Mode. Value ranges from 0x00 to 0x0F.
Specifies if out-of-order data transfer is enabled
Specifies if the device has a need for background operations. Contains one of the following values:
| Value | Description |
|---|---|
| 0x00 | Device requires no background operations. |
| 0x01 | Device has a non-critical need of background operations. |
| 0x02 | Device has a performance impacted-based need of background operations. |
| 0x03 | Device has a critical need of background operations. |
Specifies the current purge operation's status.
Specifies the maximum data size in a DATA IN UFS Protocol Information Units (UPIU). This parameter can be written by the host only when all logical unit task queues are empty.
Specifies the maximum data-out size. This parameter can be written by the host only when all logical unit task queues are empty.
Specifies the dynamic capacity need.
Specifies the reference clock frequency value.
| Value | Description |
|---|---|
| 0x00 | 19.2 MHz |
| 0x01 | 26 MHz |
| 0x02 | 38.4 MHz |
| 0x03 | 52 MHz |
Specifies if the configuration descriptor is locked.
Defines the current maximum number of outstanding READY TO TRANSFER UPIU’s (RTT's) that are allowed. This value can be set by the host.
Specifies the Exception Event Controller. UFS_wExceptionEventControl enables the setting of the EVENT_ALERT bit in the Device Information field, which is contained in the RESPONSE UPIU.
Specifies a bitmap of each exception event status.A bit will be set only if the relevant event has occurred (regardless of the UFS_wExceptionEventControl status). Contains the following bits:
| Bit | Value |
|---|---|
| 0 | DYNCAP_NEEDED |
| 1 | SYSPOOL_EXHAUSTED |
| 2 | URGENT_BKOPS |
| 3 to 15 | Reserved. |
Specifies the time passed in seconds.
Specifies the context attribute.
Obsolete
Reserved for future use.
Reserved for future use.
Specifies the Device Field Firmware Update (FFU) status.
| Value | Description |
|---|---|
| 0x00 | No information on the FFU status. |
| 0x01 | Successful microcode update. |
| 0x02 | Microcode corruption error. |
| 0x03 | Internal error. |
| 0x04 | Microcode version mismatch. |
| 0x05 to 0xFE | Reserved. |
| 0xFF | General Error. |
Specifies the current Product State Awareness (PSA) State.
| Value | State | Description |
|---|---|---|
| 0x00 | Off | PSA feature is off. |
| 0x01 | Pre-solder | PSA feature is on and the device is in a pre-soldering state. |
| 0x02 | Loading Complete | The PSA feature is on. The host will set to this value after the host finished writing data during pre-soldering state. |
| 0x03 | Soldered | PSA feature is no longer available. Set by the Device to indicate it is in a post-soldering state. This attribute is locked after it is in ‘Soldered’ state. |
Specifies the amount of data that the host plans to load to all logical units with bPSASensitive set to 1.
UFS_bCurrentPowerMode is the only attribute the device is required to return in any power mode. If the device is not in Active power mode or Idle power mode, a QUERY REQUEST UPIU to access descriptors, flags, or attributes other than bCurrentPowerMode may fail.
UFS_bDeviceFFUStatus value is kept after power cycle, hardware reset or any other type of reset. This attribute may change value when a microcode activation event occurs.
UFS_bMaxDataInSize is equal to bMaxInBufferSize when a UFS device is shipped.