0001 What: /sys/bus/*/drivers/ufshcd/*/auto_hibern8
0002 Date: March 2018
0003 Contact: linux-scsi@vger.kernel.org
0004 Description:
0005 This file contains the auto-hibernate idle timer setting of a
0006 UFS host controller. A value of '0' means auto-hibernate is not
0007 enabled. Otherwise the value is the number of microseconds of
0008 idle time before the UFS host controller will autonomously put
0009 the link into hibernate state. That will save power at the
0010 expense of increased latency. Note that the hardware supports
0011 10-bit values with a power-of-ten multiplier which allows a
0012 maximum value of 102300000. Refer to the UFS Host Controller
0013 Interface specification for more details.
0014
0015 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_type
0016 What: /sys/bus/platform/devices/*.ufs/device_descriptor/device_type
0017 Date: February 2018
0018 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0019 Description: This file shows the device type. This is one of the UFS
0020 device descriptor parameters. The full information about
0021 the descriptor could be found at UFS specifications 2.1.
0022
0023 The file is read only.
0024
0025 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class
0026 What: /sys/bus/platform/devices/*.ufs/device_descriptor/device_class
0027 Date: February 2018
0028 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0029 Description: This file shows the device class. This is one of the UFS
0030 device descriptor parameters. The full information about
0031 the descriptor could be found at UFS specifications 2.1.
0032
0033 The file is read only.
0034
0035 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class
0036 What: /sys/bus/platform/devices/*.ufs/device_descriptor/device_sub_class
0037 Date: February 2018
0038 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0039 Description: This file shows the UFS storage subclass. This is one of
0040 the UFS device descriptor parameters. The full information
0041 about the descriptor could be found at UFS specifications 2.1.
0042
0043 The file is read only.
0044
0045 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol
0046 What: /sys/bus/platform/devices/*.ufs/device_descriptor/protocol
0047 Date: February 2018
0048 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0049 Description: This file shows the protocol supported by an UFS device.
0050 This is one of the UFS device descriptor parameters.
0051 The full information about the descriptor could be found
0052 at UFS specifications 2.1.
0053
0054 The file is read only.
0055
0056 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns
0057 What: /sys/bus/platform/devices/*.ufs/device_descriptor/number_of_luns
0058 Date: February 2018
0059 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0060 Description: This file shows number of logical units. This is one of
0061 the UFS device descriptor parameters. The full information
0062 about the descriptor could be found at UFS specifications 2.1.
0063
0064 The file is read only.
0065
0066 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns
0067 What: /sys/bus/platform/devices/*.ufs/device_descriptor/number_of_wluns
0068 Date: February 2018
0069 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0070 Description: This file shows number of well known logical units.
0071 This is one of the UFS device descriptor parameters.
0072 The full information about the descriptor could be found
0073 at UFS specifications 2.1.
0074
0075 The file is read only.
0076
0077 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable
0078 What: /sys/bus/platform/devices/*.ufs/device_descriptor/boot_enable
0079 Date: February 2018
0080 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0081 Description: This file shows value that indicates whether the device is
0082 enabled for boot. This is one of the UFS device descriptor
0083 parameters. The full information about the descriptor could
0084 be found at UFS specifications 2.1.
0085
0086 The file is read only.
0087
0088 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable
0089 What: /sys/bus/platform/devices/*.ufs/device_descriptor/descriptor_access_enable
0090 Date: February 2018
0091 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0092 Description: This file shows value that indicates whether the device
0093 descriptor could be read after partial initialization phase
0094 of the boot sequence. This is one of the UFS device descriptor
0095 parameters. The full information about the descriptor could
0096 be found at UFS specifications 2.1.
0097
0098 The file is read only.
0099
0100 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode
0101 What: /sys/bus/platform/devices/*.ufs/device_descriptor/initial_power_mode
0102 Date: February 2018
0103 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0104 Description: This file shows value that defines the power mode after
0105 device initialization or hardware reset. This is one of
0106 the UFS device descriptor parameters. The full information
0107 about the descriptor could be found at UFS specifications 2.1.
0108
0109 The file is read only.
0110
0111 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/high_priority_lun
0112 What: /sys/bus/platform/devices/*.ufs/device_descriptor/high_priority_lun
0113 Date: February 2018
0114 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0115 Description: This file shows the high priority lun. This is one of
0116 the UFS device descriptor parameters. The full information
0117 about the descriptor could be found at UFS specifications 2.1.
0118
0119 The file is read only.
0120
0121 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type
0122 What: /sys/bus/platform/devices/*.ufs/device_descriptor/secure_removal_type
0123 Date: February 2018
0124 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0125 Description: This file shows the secure removal type. This is one of
0126 the UFS device descriptor parameters. The full information
0127 about the descriptor could be found at UFS specifications 2.1.
0128
0129 The file is read only.
0130
0131 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun
0132 What: /sys/bus/platform/devices/*.ufs/device_descriptor/support_security_lun
0133 Date: February 2018
0134 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0135 Description: This file shows whether the security lun is supported.
0136 This is one of the UFS device descriptor parameters.
0137 The full information about the descriptor could be found
0138 at UFS specifications 2.1.
0139
0140 The file is read only.
0141
0142 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency
0143 What: /sys/bus/platform/devices/*.ufs/device_descriptor/bkops_termination_latency
0144 Date: February 2018
0145 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0146 Description: This file shows the background operations termination
0147 latency. This is one of the UFS device descriptor parameters.
0148 The full information about the descriptor could be found
0149 at UFS specifications 2.1.
0150
0151 The file is read only.
0152
0153 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level
0154 What: /sys/bus/platform/devices/*.ufs/device_descriptor/initial_active_icc_level
0155 Date: February 2018
0156 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0157 Description: This file shows the initial active ICC level. This is one
0158 of the UFS device descriptor parameters. The full information
0159 about the descriptor could be found at UFS specifications 2.1.
0160
0161 The file is read only.
0162
0163 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version
0164 What: /sys/bus/platform/devices/*.ufs/device_descriptor/specification_version
0165 Date: February 2018
0166 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0167 Description: This file shows the specification version. This is one
0168 of the UFS device descriptor parameters. The full information
0169 about the descriptor could be found at UFS specifications 2.1.
0170
0171 The file is read only.
0172
0173 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date
0174 What: /sys/bus/platform/devices/*.ufs/device_descriptor/manufacturing_date
0175 Date: February 2018
0176 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0177 Description: This file shows the manufacturing date in BCD format.
0178 This is one of the UFS device descriptor parameters.
0179 The full information about the descriptor could be found
0180 at UFS specifications 2.1.
0181
0182 The file is read only.
0183
0184 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id
0185 What: /sys/bus/platform/devices/*.ufs/device_descriptor/manufacturer_id
0186 Date: February 2018
0187 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0188 Description: This file shows the manufacturer ID. This is one of the
0189 UFS device descriptor parameters. The full information about
0190 the descriptor could be found at UFS specifications 2.1.
0191
0192 The file is read only.
0193
0194 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability
0195 What: /sys/bus/platform/devices/*.ufs/device_descriptor/rtt_capability
0196 Date: February 2018
0197 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0198 Description: This file shows the maximum number of outstanding RTTs
0199 supported by the device. This is one of the UFS device
0200 descriptor parameters. The full information about
0201 the descriptor could be found at UFS specifications 2.1.
0202
0203 The file is read only.
0204
0205 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update
0206 What: /sys/bus/platform/devices/*.ufs/device_descriptor/rtc_update
0207 Date: February 2018
0208 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0209 Description: This file shows the frequency and method of the realtime
0210 clock update. This is one of the UFS device descriptor
0211 parameters. The full information about the descriptor
0212 could be found at UFS specifications 2.1.
0213
0214 The file is read only.
0215
0216 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features
0217 What: /sys/bus/platform/devices/*.ufs/device_descriptor/ufs_features
0218 Date: February 2018
0219 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0220 Description: This file shows which features are supported by the device.
0221 This is one of the UFS device descriptor parameters.
0222 The full information about the descriptor could be
0223 found at UFS specifications 2.1.
0224
0225 The file is read only.
0226
0227 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout
0228 What: /sys/bus/platform/devices/*.ufs/device_descriptor/ffu_timeout
0229 Date: February 2018
0230 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0231 Description: This file shows the FFU timeout. This is one of the
0232 UFS device descriptor parameters. The full information
0233 about the descriptor could be found at UFS specifications 2.1.
0234
0235 The file is read only.
0236
0237 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth
0238 What: /sys/bus/platform/devices/*.ufs/device_descriptor/queue_depth
0239 Date: February 2018
0240 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0241 Description: This file shows the device queue depth. This is one of the
0242 UFS device descriptor parameters. The full information
0243 about the descriptor could be found at UFS specifications 2.1.
0244
0245 The file is read only.
0246
0247 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version
0248 What: /sys/bus/platform/devices/*.ufs/device_descriptor/device_version
0249 Date: February 2018
0250 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0251 Description: This file shows the device version. This is one of the
0252 UFS device descriptor parameters. The full information
0253 about the descriptor could be found at UFS specifications 2.1.
0254
0255 The file is read only.
0256
0257 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa
0258 What: /sys/bus/platform/devices/*.ufs/device_descriptor/number_of_secure_wpa
0259 Date: February 2018
0260 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0261 Description: This file shows number of secure write protect areas
0262 supported by the device. This is one of the UFS device
0263 descriptor parameters. The full information about
0264 the descriptor could be found at UFS specifications 2.1.
0265
0266 The file is read only.
0267
0268 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size
0269 What: /sys/bus/platform/devices/*.ufs/device_descriptor/psa_max_data_size
0270 Date: February 2018
0271 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0272 Description: This file shows the maximum amount of data that may be
0273 written during the pre-soldering phase of the PSA flow.
0274 This is one of the UFS device descriptor parameters.
0275 The full information about the descriptor could be found
0276 at UFS specifications 2.1.
0277
0278 The file is read only.
0279
0280 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout
0281 What: /sys/bus/platform/devices/*.ufs/device_descriptor/psa_state_timeout
0282 Date: February 2018
0283 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0284 Description: This file shows the command maximum timeout for a change
0285 in PSA state. This is one of the UFS device descriptor
0286 parameters. The full information about the descriptor could
0287 be found at UFS specifications 2.1.
0288
0289 The file is read only.
0290
0291
0292 What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/unipro_version
0293 What: /sys/bus/platform/devices/*.ufs/interconnect_descriptor/unipro_version
0294 Date: February 2018
0295 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0296 Description: This file shows the MIPI UniPro version number in BCD format.
0297 This is one of the UFS interconnect descriptor parameters.
0298 The full information about the descriptor could be found at
0299 UFS specifications 2.1.
0300
0301 The file is read only.
0302
0303 What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version
0304 What: /sys/bus/platform/devices/*.ufs/interconnect_descriptor/mphy_version
0305 Date: February 2018
0306 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0307 Description: This file shows the MIPI M-PHY version number in BCD format.
0308 This is one of the UFS interconnect descriptor parameters.
0309 The full information about the descriptor could be found at
0310 UFS specifications 2.1.
0311
0312 The file is read only.
0313
0314
0315 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/raw_device_capacity
0316 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/raw_device_capacity
0317 Date: February 2018
0318 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0319 Description: This file shows the total memory quantity available to
0320 the user to configure the device logical units. This is one
0321 of the UFS geometry descriptor parameters. The full
0322 information about the descriptor could be found at
0323 UFS specifications 2.1.
0324
0325 The file is read only.
0326
0327 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns
0328 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/max_number_of_luns
0329 Date: February 2018
0330 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0331 Description: This file shows the maximum number of logical units
0332 supported by the UFS device. This is one of the UFS
0333 geometry descriptor parameters. The full information about
0334 the descriptor could be found at UFS specifications 2.1.
0335
0336 The file is read only.
0337
0338 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size
0339 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/segment_size
0340 Date: February 2018
0341 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0342 Description: This file shows the segment size. This is one of the UFS
0343 geometry descriptor parameters. The full information about
0344 the descriptor could be found at UFS specifications 2.1.
0345
0346 The file is read only.
0347
0348 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size
0349 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/allocation_unit_size
0350 Date: February 2018
0351 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0352 Description: This file shows the allocation unit size. This is one of
0353 the UFS geometry descriptor parameters. The full information
0354 about the descriptor could be found at UFS specifications 2.1.
0355
0356 The file is read only.
0357
0358 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size
0359 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/min_addressable_block_size
0360 Date: February 2018
0361 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0362 Description: This file shows the minimum addressable block size. This
0363 is one of the UFS geometry descriptor parameters. The full
0364 information about the descriptor could be found at UFS
0365 specifications 2.1.
0366
0367 The file is read only.
0368
0369 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size
0370 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/optimal_read_block_size
0371 Date: February 2018
0372 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0373 Description: This file shows the optimal read block size. This is one
0374 of the UFS geometry descriptor parameters. The full
0375 information about the descriptor could be found at UFS
0376 specifications 2.1.
0377
0378 The file is read only.
0379
0380 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size
0381 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/optimal_write_block_size
0382 Date: February 2018
0383 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0384 Description: This file shows the optimal write block size. This is one
0385 of the UFS geometry descriptor parameters. The full
0386 information about the descriptor could be found at UFS
0387 specifications 2.1.
0388
0389 The file is read only.
0390
0391 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size
0392 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/max_in_buffer_size
0393 Date: February 2018
0394 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0395 Description: This file shows the maximum data-in buffer size. This
0396 is one of the UFS geometry descriptor parameters. The full
0397 information about the descriptor could be found at UFS
0398 specifications 2.1.
0399
0400 The file is read only.
0401
0402 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size
0403 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/max_out_buffer_size
0404 Date: February 2018
0405 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0406 Description: This file shows the maximum data-out buffer size. This
0407 is one of the UFS geometry descriptor parameters. The full
0408 information about the descriptor could be found at UFS
0409 specifications 2.1.
0410
0411 The file is read only.
0412
0413 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size
0414 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/rpmb_rw_size
0415 Date: February 2018
0416 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0417 Description: This file shows the maximum number of RPMB frames allowed
0418 in Security Protocol In/Out. This is one of the UFS geometry
0419 descriptor parameters. The full information about the
0420 descriptor could be found at UFS specifications 2.1.
0421
0422 The file is read only.
0423
0424 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy
0425 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/dyn_capacity_resource_policy
0426 Date: February 2018
0427 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0428 Description: This file shows the dynamic capacity resource policy. This
0429 is one of the UFS geometry descriptor parameters. The full
0430 information about the descriptor could be found at
0431 UFS specifications 2.1.
0432
0433 The file is read only.
0434
0435 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering
0436 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/data_ordering
0437 Date: February 2018
0438 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0439 Description: This file shows support for out-of-order data transfer.
0440 This is one of the UFS geometry descriptor parameters.
0441 The full information about the descriptor could be found at
0442 UFS specifications 2.1.
0443
0444 The file is read only.
0445
0446 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_contexts
0447 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/max_number_of_contexts
0448 Date: February 2018
0449 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0450 Description: This file shows maximum available number of contexts which
0451 are supported by the device. This is one of the UFS geometry
0452 descriptor parameters. The full information about the
0453 descriptor could be found at UFS specifications 2.1.
0454
0455 The file is read only.
0456
0457 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size
0458 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/sys_data_tag_unit_size
0459 Date: February 2018
0460 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0461 Description: This file shows system data tag unit size. This is one of
0462 the UFS geometry descriptor parameters. The full information
0463 about the descriptor could be found at UFS specifications 2.1.
0464
0465 The file is read only.
0466
0467 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size
0468 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/sys_data_tag_resource_size
0469 Date: February 2018
0470 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0471 Description: This file shows maximum storage area size allocated by
0472 the device to handle system data by the tagging mechanism.
0473 This is one of the UFS geometry descriptor parameters.
0474 The full information about the descriptor could be found at
0475 UFS specifications 2.1.
0476
0477 The file is read only.
0478
0479 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types
0480 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/secure_removal_types
0481 Date: February 2018
0482 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0483 Description: This file shows supported secure removal types. This is
0484 one of the UFS geometry descriptor parameters. The full
0485 information about the descriptor could be found at
0486 UFS specifications 2.1.
0487
0488 The file is read only.
0489
0490 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types
0491 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/memory_types
0492 Date: February 2018
0493 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0494 Description: This file shows supported memory types. This is one of
0495 the UFS geometry descriptor parameters. The full
0496 information about the descriptor could be found at
0497 UFS specifications 2.1.
0498
0499 The file is read only.
0500
0501 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units
0502 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/*_memory_max_alloc_units
0503 Date: February 2018
0504 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0505 Description: This file shows the maximum number of allocation units for
0506 different memory types (system code, non persistent,
0507 enhanced type 1-4). This is one of the UFS geometry
0508 descriptor parameters. The full information about the
0509 descriptor could be found at UFS specifications 2.1.
0510
0511 The file is read only.
0512
0513 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor
0514 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/*_memory_capacity_adjustment_factor
0515 Date: February 2018
0516 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0517 Description: This file shows the memory capacity adjustment factor for
0518 different memory types (system code, non persistent,
0519 enhanced type 1-4). This is one of the UFS geometry
0520 descriptor parameters. The full information about the
0521 descriptor could be found at UFS specifications 2.1.
0522
0523 The file is read only.
0524
0525
0526 What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/eol_info
0527 What: /sys/bus/platform/devices/*.ufs/health_descriptor/eol_info
0528 Date: February 2018
0529 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0530 Description: This file shows preend of life information. This is one
0531 of the UFS health descriptor parameters. The full
0532 information about the descriptor could be found at
0533 UFS specifications 2.1.
0534
0535 The file is read only.
0536
0537 What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a
0538 What: /sys/bus/platform/devices/*.ufs/health_descriptor/life_time_estimation_a
0539 Date: February 2018
0540 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0541 Description: This file shows indication of the device life time
0542 (method a). This is one of the UFS health descriptor
0543 parameters. The full information about the descriptor
0544 could be found at UFS specifications 2.1.
0545
0546 The file is read only.
0547
0548 What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b
0549 What: /sys/bus/platform/devices/*.ufs/health_descriptor/life_time_estimation_b
0550 Date: February 2018
0551 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0552 Description: This file shows indication of the device life time
0553 (method b). This is one of the UFS health descriptor
0554 parameters. The full information about the descriptor
0555 could be found at UFS specifications 2.1.
0556
0557 The file is read only.
0558
0559
0560 What: /sys/bus/platform/drivers/ufshcd/*/power_descriptor/active_icc_levels_vcc*
0561 What: /sys/bus/platform/devices/*.ufs/power_descriptor/active_icc_levels_vcc*
0562 Date: February 2018
0563 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0564 Description: This file shows maximum VCC, VCCQ and VCCQ2 value for
0565 active ICC levels from 0 to 15. This is one of the UFS
0566 power descriptor parameters. The full information about
0567 the descriptor could be found at UFS specifications 2.1.
0568
0569 The file is read only.
0570
0571
0572 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/manufacturer_name
0573 What: /sys/bus/platform/devices/*.ufs/string_descriptors/manufacturer_name
0574 Date: February 2018
0575 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0576 Description: This file contains a device manufacturer name string.
0577 The full information about the descriptor could be found at
0578 UFS specifications 2.1.
0579
0580 The file is read only.
0581
0582 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name
0583 What: /sys/bus/platform/devices/*.ufs/string_descriptors/product_name
0584 Date: February 2018
0585 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0586 Description: This file contains a product name string. The full information
0587 about the descriptor could be found at UFS specifications 2.1.
0588
0589 The file is read only.
0590
0591 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id
0592 What: /sys/bus/platform/devices/*.ufs/string_descriptors/oem_id
0593 Date: February 2018
0594 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0595 Description: This file contains a OEM ID string. The full information
0596 about the descriptor could be found at UFS specifications 2.1.
0597
0598 The file is read only.
0599
0600 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number
0601 What: /sys/bus/platform/devices/*.ufs/string_descriptors/serial_number
0602 Date: February 2018
0603 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0604 Description: This file contains a device serial number string. The full
0605 information about the descriptor could be found at
0606 UFS specifications 2.1.
0607
0608 The file is read only.
0609
0610 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision
0611 What: /sys/bus/platform/devices/*.ufs/string_descriptors/product_revision
0612 Date: February 2018
0613 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0614 Description: This file contains a product revision string. The full
0615 information about the descriptor could be found at
0616 UFS specifications 2.1.
0617
0618 The file is read only.
0619
0620
0621 What: /sys/class/scsi_device/*/device/unit_descriptor/boot_lun_id
0622 Date: February 2018
0623 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0624 Description: This file shows boot LUN information. This is one of
0625 the UFS unit descriptor parameters. The full information
0626 about the descriptor could be found at UFS specifications 2.1.
0627
0628 The file is read only.
0629
0630 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_write_protect
0631 Date: February 2018
0632 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0633 Description: This file shows LUN write protection status. This is one of
0634 the UFS unit descriptor parameters. The full information
0635 about the descriptor could be found at UFS specifications 2.1.
0636
0637 The file is read only.
0638
0639 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_queue_depth
0640 Date: February 2018
0641 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0642 Description: This file shows LUN queue depth. This is one of the UFS
0643 unit descriptor parameters. The full information about
0644 the descriptor could be found at UFS specifications 2.1.
0645
0646 The file is read only.
0647
0648 What: /sys/class/scsi_device/*/device/unit_descriptor/psa_sensitive
0649 Date: February 2018
0650 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0651 Description: This file shows PSA sensitivity. This is one of the UFS
0652 unit descriptor parameters. The full information about
0653 the descriptor could be found at UFS specifications 2.1.
0654
0655 The file is read only.
0656
0657 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_memory_type
0658 Date: February 2018
0659 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0660 Description: This file shows LUN memory type. This is one of the UFS
0661 unit descriptor parameters. The full information about
0662 the descriptor could be found at UFS specifications 2.1.
0663
0664 The file is read only.
0665
0666 What: /sys/class/scsi_device/*/device/unit_descriptor/data_reliability
0667 Date: February 2018
0668 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0669 Description: This file defines the device behavior when a power failure
0670 occurs during a write operation. This is one of the UFS
0671 unit descriptor parameters. The full information about
0672 the descriptor could be found at UFS specifications 2.1.
0673
0674 The file is read only.
0675
0676 What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_size
0677 Date: February 2018
0678 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0679 Description: This file shows the size of addressable logical blocks
0680 (calculated as an exponent with base 2). This is one of
0681 the UFS unit descriptor parameters. The full information about
0682 the descriptor could be found at UFS specifications 2.1.
0683
0684 The file is read only.
0685
0686 What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_count
0687 Date: February 2018
0688 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0689 Description: This file shows total number of addressable logical blocks.
0690 This is one of the UFS unit descriptor parameters. The full
0691 information about the descriptor could be found at
0692 UFS specifications 2.1.
0693
0694 The file is read only.
0695
0696 What: /sys/class/scsi_device/*/device/unit_descriptor/erase_block_size
0697 Date: February 2018
0698 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0699 Description: This file shows the erase block size. This is one of
0700 the UFS unit descriptor parameters. The full information
0701 about the descriptor could be found at UFS specifications 2.1.
0702
0703 The file is read only.
0704
0705 What: /sys/class/scsi_device/*/device/unit_descriptor/provisioning_type
0706 Date: February 2018
0707 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0708 Description: This file shows the thin provisioning type. This is one of
0709 the UFS unit descriptor parameters. The full information
0710 about the descriptor could be found at UFS specifications 2.1.
0711
0712 The file is read only.
0713
0714 What: /sys/class/scsi_device/*/device/unit_descriptor/physical_memory_resourse_count
0715 Date: February 2018
0716 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0717 Description: This file shows the total physical memory resources. This is
0718 one of the UFS unit descriptor parameters. The full information
0719 about the descriptor could be found at UFS specifications 2.1.
0720
0721 The file is read only.
0722
0723 What: /sys/class/scsi_device/*/device/unit_descriptor/context_capabilities
0724 Date: February 2018
0725 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0726 Description: This file shows the context capabilities. This is one of
0727 the UFS unit descriptor parameters. The full information
0728 about the descriptor could be found at UFS specifications 2.1.
0729
0730 The file is read only.
0731
0732 What: /sys/class/scsi_device/*/device/unit_descriptor/large_unit_granularity
0733 Date: February 2018
0734 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0735 Description: This file shows the granularity of the LUN. This is one of
0736 the UFS unit descriptor parameters. The full information
0737 about the descriptor could be found at UFS specifications 2.1.
0738
0739 The file is read only.
0740
0741
0742 What: /sys/bus/platform/drivers/ufshcd/*/flags/device_init
0743 What: /sys/bus/platform/devices/*.ufs/flags/device_init
0744 Date: February 2018
0745 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0746 Description: This file shows the device init status. The full information
0747 about the flag could be found at UFS specifications 2.1.
0748
0749 The file is read only.
0750
0751 What: /sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe
0752 What: /sys/bus/platform/devices/*.ufs/flags/permanent_wpe
0753 Date: February 2018
0754 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0755 Description: This file shows whether permanent write protection is enabled.
0756 The full information about the flag could be found at
0757 UFS specifications 2.1.
0758
0759 The file is read only.
0760
0761 What: /sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe
0762 What: /sys/bus/platform/devices/*.ufs/flags/power_on_wpe
0763 Date: February 2018
0764 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0765 Description: This file shows whether write protection is enabled on all
0766 logical units configured as power on write protected. The
0767 full information about the flag could be found at
0768 UFS specifications 2.1.
0769
0770 The file is read only.
0771
0772 What: /sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable
0773 What: /sys/bus/platform/devices/*.ufs/flags/bkops_enable
0774 Date: February 2018
0775 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0776 Description: This file shows whether the device background operations are
0777 enabled. The full information about the flag could be
0778 found at UFS specifications 2.1.
0779
0780 The file is read only.
0781
0782 What: /sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable
0783 What: /sys/bus/platform/devices/*.ufs/flags/life_span_mode_enable
0784 Date: February 2018
0785 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0786 Description: This file shows whether the device life span mode is enabled.
0787 The full information about the flag could be found at
0788 UFS specifications 2.1.
0789
0790 The file is read only.
0791
0792 What: /sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal
0793 What: /sys/bus/platform/devices/*.ufs/flags/phy_resource_removal
0794 Date: February 2018
0795 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0796 Description: This file shows whether physical resource removal is enable.
0797 The full information about the flag could be found at
0798 UFS specifications 2.1.
0799
0800 The file is read only.
0801
0802 What: /sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc
0803 What: /sys/bus/platform/devices/*.ufs/flags/busy_rtc
0804 Date: February 2018
0805 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0806 Description: This file shows whether the device is executing internal
0807 operation related to real time clock. The full information
0808 about the flag could be found at UFS specifications 2.1.
0809
0810 The file is read only.
0811
0812 What: /sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update
0813 What: /sys/bus/platform/devices/*.ufs/flags/disable_fw_update
0814 Date: February 2018
0815 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0816 Description: This file shows whether the device FW update is permanently
0817 disabled. The full information about the flag could be found
0818 at UFS specifications 2.1.
0819
0820 The file is read only.
0821
0822
0823 What: /sys/bus/platform/drivers/ufshcd/*/attributes/boot_lun_enabled
0824 What: /sys/bus/platform/devices/*.ufs/attributes/boot_lun_enabled
0825 Date: February 2018
0826 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0827 Description: This file provides the boot lun enabled UFS device attribute.
0828 The full information about the attribute could be found at
0829 UFS specifications 2.1.
0830
0831 The file is read only.
0832
0833 What: /sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode
0834 What: /sys/bus/platform/devices/*.ufs/attributes/current_power_mode
0835 Date: February 2018
0836 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0837 Description: This file provides the current power mode UFS device attribute.
0838 The full information about the attribute could be found at
0839 UFS specifications 2.1.
0840
0841 The file is read only.
0842
0843 What: /sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level
0844 What: /sys/bus/platform/devices/*.ufs/attributes/active_icc_level
0845 Date: February 2018
0846 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0847 Description: This file provides the active icc level UFS device attribute.
0848 The full information about the attribute could be found at
0849 UFS specifications 2.1.
0850
0851 The file is read only.
0852
0853 What: /sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled
0854 What: /sys/bus/platform/devices/*.ufs/attributes/ooo_data_enabled
0855 Date: February 2018
0856 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0857 Description: This file provides the out of order data transfer enabled UFS
0858 device attribute. The full information about the attribute
0859 could be found at UFS specifications 2.1.
0860
0861 The file is read only.
0862
0863 What: /sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status
0864 What: /sys/bus/platform/devices/*.ufs/attributes/bkops_status
0865 Date: February 2018
0866 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0867 Description: This file provides the background operations status UFS device
0868 attribute. The full information about the attribute could
0869 be found at UFS specifications 2.1.
0870
0871 The file is read only.
0872
0873 What: /sys/bus/platform/drivers/ufshcd/*/attributes/purge_status
0874 What: /sys/bus/platform/devices/*.ufs/attributes/purge_status
0875 Date: February 2018
0876 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0877 Description: This file provides the purge operation status UFS device
0878 attribute. The full information about the attribute could
0879 be found at UFS specifications 2.1.
0880
0881 The file is read only.
0882
0883 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size
0884 What: /sys/bus/platform/devices/*.ufs/attributes/max_data_in_size
0885 Date: February 2018
0886 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0887 Description: This file shows the maximum data size in a DATA IN
0888 UPIU. The full information about the attribute could
0889 be found at UFS specifications 2.1.
0890
0891 The file is read only.
0892
0893 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size
0894 What: /sys/bus/platform/devices/*.ufs/attributes/max_data_out_size
0895 Date: February 2018
0896 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0897 Description: This file shows the maximum number of bytes that can be
0898 requested with a READY TO TRANSFER UPIU. The full information
0899 about the attribute could be found at UFS specifications 2.1.
0900
0901 The file is read only.
0902
0903 What: /sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency
0904 What: /sys/bus/platform/devices/*.ufs/attributes/reference_clock_frequency
0905 Date: February 2018
0906 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0907 Description: This file provides the reference clock frequency UFS device
0908 attribute. The full information about the attribute could
0909 be found at UFS specifications 2.1.
0910
0911 The file is read only.
0912
0913 What: /sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock
0914 What: /sys/bus/platform/devices/*.ufs/attributes/configuration_descriptor_lock
0915 Date: February 2018
0916 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0917 Description: This file shows whether the configuration descriptor is locked.
0918 The full information about the attribute could be found at
0919 UFS specifications 2.1. The file is read only.
0920
0921 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_number_of_rtt
0922 What: /sys/bus/platform/devices/*.ufs/attributes/max_number_of_rtt
0923 Date: February 2018
0924 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0925 Description: This file provides the maximum current number of
0926 outstanding RTTs in device that is allowed. The full
0927 information about the attribute could be found at
0928 UFS specifications 2.1.
0929
0930 The file is read only.
0931
0932 What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control
0933 What: /sys/bus/platform/devices/*.ufs/attributes/exception_event_control
0934 Date: February 2018
0935 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0936 Description: This file provides the exception event control UFS device
0937 attribute. The full information about the attribute could
0938 be found at UFS specifications 2.1.
0939
0940 The file is read only.
0941
0942 What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status
0943 What: /sys/bus/platform/devices/*.ufs/attributes/exception_event_status
0944 Date: February 2018
0945 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0946 Description: This file provides the exception event status UFS device
0947 attribute. The full information about the attribute could
0948 be found at UFS specifications 2.1.
0949
0950 The file is read only.
0951
0952 What: /sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status
0953 What: /sys/bus/platform/devices/*.ufs/attributes/ffu_status
0954 Date: February 2018
0955 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0956 Description: This file provides the ffu status UFS device attribute.
0957 The full information about the attribute could be found at
0958 UFS specifications 2.1.
0959
0960 The file is read only.
0961
0962 What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_state
0963 What: /sys/bus/platform/devices/*.ufs/attributes/psa_state
0964 Date: February 2018
0965 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0966 Description: This file show the PSA feature status. The full information
0967 about the attribute could be found at UFS specifications 2.1.
0968
0969 The file is read only.
0970
0971 What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size
0972 What: /sys/bus/platform/devices/*.ufs/attributes/psa_data_size
0973 Date: February 2018
0974 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0975 Description: This file shows the amount of data that the host plans to
0976 load to all logical units in pre-soldering state.
0977 The full information about the attribute could be found at
0978 UFS specifications 2.1.
0979
0980 The file is read only.
0981
0982
0983 What: /sys/class/scsi_device/*/device/dyn_cap_needed
0984 Date: February 2018
0985 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
0986 Description: This file shows the amount of physical memory needed
0987 to be removed from the physical memory resources pool of
0988 the particular logical unit. The full information about
0989 the attribute could be found at UFS specifications 2.1.
0990
0991 The file is read only.
0992
0993
0994 What: /sys/bus/platform/drivers/ufshcd/*/rpm_lvl
0995 What: /sys/bus/platform/devices/*.ufs/rpm_lvl
0996 Date: September 2014
0997 Contact: Subhash Jadavani <subhashj@codeaurora.org>
0998 Description: This entry could be used to set or show the UFS device
0999 runtime power management level. The current driver
1000 implementation supports 7 levels with next target states:
1001
1002 == ====================================================
1003 0 UFS device will stay active, UIC link will
1004 stay active
1005 1 UFS device will stay active, UIC link will
1006 hibernate
1007 2 UFS device will be moved to sleep, UIC link will
1008 stay active
1009 3 UFS device will be moved to sleep, UIC link will
1010 hibernate
1011 4 UFS device will be powered off, UIC link will
1012 hibernate
1013 5 UFS device will be powered off, UIC link will
1014 be powered off
1015 6 UFS device will be moved to deep sleep, UIC link
1016 will be powered off. Note, deep sleep might not be
1017 supported in which case this value will not be
1018 accepted
1019 == ====================================================
1020
1021 What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
1022 What: /sys/bus/platform/devices/*.ufs/rpm_target_dev_state
1023 Date: February 2018
1024 Contact: Subhash Jadavani <subhashj@codeaurora.org>
1025 Description: This entry shows the target power mode of an UFS device
1026 for the chosen runtime power management level.
1027
1028 The file is read only.
1029
1030 What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state
1031 What: /sys/bus/platform/devices/*.ufs/rpm_target_link_state
1032 Date: February 2018
1033 Contact: Subhash Jadavani <subhashj@codeaurora.org>
1034 Description: This entry shows the target state of an UFS UIC link
1035 for the chosen runtime power management level.
1036
1037 The file is read only.
1038
1039 What: /sys/bus/platform/drivers/ufshcd/*/spm_lvl
1040 What: /sys/bus/platform/devices/*.ufs/spm_lvl
1041 Date: September 2014
1042 Contact: Subhash Jadavani <subhashj@codeaurora.org>
1043 Description: This entry could be used to set or show the UFS device
1044 system power management level. The current driver
1045 implementation supports 7 levels with next target states:
1046
1047 == ====================================================
1048 0 UFS device will stay active, UIC link will
1049 stay active
1050 1 UFS device will stay active, UIC link will
1051 hibernate
1052 2 UFS device will be moved to sleep, UIC link will
1053 stay active
1054 3 UFS device will be moved to sleep, UIC link will
1055 hibernate
1056 4 UFS device will be powered off, UIC link will
1057 hibernate
1058 5 UFS device will be powered off, UIC link will
1059 be powered off
1060 6 UFS device will be moved to deep sleep, UIC link
1061 will be powered off. Note, deep sleep might not be
1062 supported in which case this value will not be
1063 accepted
1064 == ====================================================
1065
1066 What: /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
1067 What: /sys/bus/platform/devices/*.ufs/spm_target_dev_state
1068 Date: February 2018
1069 Contact: Subhash Jadavani <subhashj@codeaurora.org>
1070 Description: This entry shows the target power mode of an UFS device
1071 for the chosen system power management level.
1072
1073 The file is read only.
1074
1075 What: /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state
1076 What: /sys/bus/platform/devices/*.ufs/spm_target_link_state
1077 Date: February 2018
1078 Contact: Subhash Jadavani <subhashj@codeaurora.org>
1079 Description: This entry shows the target state of an UFS UIC link
1080 for the chosen system power management level.
1081
1082 The file is read only.
1083
1084 What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable
1085 What: /sys/bus/platform/devices/*.ufs/monitor/monitor_enable
1086 Date: January 2021
1087 Contact: Can Guo <cang@codeaurora.org>
1088 Description: This file shows the status of performance monitor enablement
1089 and it can be used to start/stop the monitor. When the monitor
1090 is stopped, the performance data collected is also cleared.
1091
1092 What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size
1093 What: /sys/bus/platform/devices/*.ufs/monitor/monitor_chunk_size
1094 Date: January 2021
1095 Contact: Can Guo <cang@codeaurora.org>
1096 Description: This file tells the monitor to focus on requests transferring
1097 data of specific chunk size (in Bytes). 0 means any chunk size.
1098 It can only be changed when monitor is disabled.
1099
1100 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors
1101 What: /sys/bus/platform/devices/*.ufs/monitor/read_total_sectors
1102 Date: January 2021
1103 Contact: Can Guo <cang@codeaurora.org>
1104 Description: This file shows how many sectors (in 512 Bytes) have been
1105 sent from device to host after monitor gets started.
1106
1107 The file is read only.
1108
1109 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy
1110 What: /sys/bus/platform/devices/*.ufs/monitor/read_total_busy
1111 Date: January 2021
1112 Contact: Can Guo <cang@codeaurora.org>
1113 Description: This file shows how long (in micro seconds) has been spent
1114 sending data from device to host after monitor gets started.
1115
1116 The file is read only.
1117
1118 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests
1119 What: /sys/bus/platform/devices/*.ufs/monitor/read_nr_requests
1120 Date: January 2021
1121 Contact: Can Guo <cang@codeaurora.org>
1122 Description: This file shows how many read requests have been sent after
1123 monitor gets started.
1124
1125 The file is read only.
1126
1127 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max
1128 What: /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_max
1129 Date: January 2021
1130 Contact: Can Guo <cang@codeaurora.org>
1131 Description: This file shows the maximum latency (in micro seconds) of
1132 read requests after monitor gets started.
1133
1134 The file is read only.
1135
1136 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min
1137 What: /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_min
1138 Date: January 2021
1139 Contact: Can Guo <cang@codeaurora.org>
1140 Description: This file shows the minimum latency (in micro seconds) of
1141 read requests after monitor gets started.
1142
1143 The file is read only.
1144
1145 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg
1146 What: /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_avg
1147 Date: January 2021
1148 Contact: Can Guo <cang@codeaurora.org>
1149 Description: This file shows the average latency (in micro seconds) of
1150 read requests after monitor gets started.
1151
1152 The file is read only.
1153
1154 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum
1155 What: /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_sum
1156 Date: January 2021
1157 Contact: Can Guo <cang@codeaurora.org>
1158 Description: This file shows the total latency (in micro seconds) of
1159 read requests sent after monitor gets started.
1160
1161 The file is read only.
1162
1163 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors
1164 What: /sys/bus/platform/devices/*.ufs/monitor/write_total_sectors
1165 Date: January 2021
1166 Contact: Can Guo <cang@codeaurora.org>
1167 Description: This file shows how many sectors (in 512 Bytes) have been sent
1168 from host to device after monitor gets started.
1169
1170 The file is read only.
1171
1172 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy
1173 What: /sys/bus/platform/devices/*.ufs/monitor/write_total_busy
1174 Date: January 2021
1175 Contact: Can Guo <cang@codeaurora.org>
1176 Description: This file shows how long (in micro seconds) has been spent
1177 sending data from host to device after monitor gets started.
1178
1179 The file is read only.
1180
1181 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests
1182 What: /sys/bus/platform/devices/*.ufs/monitor/write_nr_requests
1183 Date: January 2021
1184 Contact: Can Guo <cang@codeaurora.org>
1185 Description: This file shows how many write requests have been sent after
1186 monitor gets started.
1187
1188 The file is read only.
1189
1190 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max
1191 What: /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_max
1192 Date: January 2021
1193 Contact: Can Guo <cang@codeaurora.org>
1194 Description: This file shows the maximum latency (in micro seconds) of write
1195 requests after monitor gets started.
1196
1197 The file is read only.
1198
1199 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min
1200 What: /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_min
1201 Date: January 2021
1202 Contact: Can Guo <cang@codeaurora.org>
1203 Description: This file shows the minimum latency (in micro seconds) of write
1204 requests after monitor gets started.
1205
1206 The file is read only.
1207
1208 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg
1209 What: /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_avg
1210 Date: January 2021
1211 Contact: Can Guo <cang@codeaurora.org>
1212 Description: This file shows the average latency (in micro seconds) of write
1213 requests after monitor gets started.
1214
1215 The file is read only.
1216
1217 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum
1218 What: /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_sum
1219 Date: January 2021
1220 Contact: Can Guo <cang@codeaurora.org>
1221 Description: This file shows the total latency (in micro seconds) of write
1222 requests after monitor gets started.
1223
1224 The file is read only.
1225
1226 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
1227 What: /sys/bus/platform/devices/*.ufs/device_descriptor/wb_presv_us_en
1228 Date: June 2020
1229 Contact: Asutosh Das <asutoshd@codeaurora.org>
1230 Description: This entry shows if preserve user-space was configured
1231
1232 The file is read only.
1233
1234 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units
1235 What: /sys/bus/platform/devices/*.ufs/device_descriptor/wb_shared_alloc_units
1236 Date: June 2020
1237 Contact: Asutosh Das <asutoshd@codeaurora.org>
1238 Description: This entry shows the shared allocated units of WB buffer
1239
1240 The file is read only.
1241
1242 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type
1243 What: /sys/bus/platform/devices/*.ufs/device_descriptor/wb_type
1244 Date: June 2020
1245 Contact: Asutosh Das <asutoshd@codeaurora.org>
1246 Description: This entry shows the configured WB type.
1247 0x1 for shared buffer mode. 0x0 for dedicated buffer mode.
1248
1249 The file is read only.
1250
1251 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
1252 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_buff_cap_adj
1253 Date: June 2020
1254 Contact: Asutosh Das <asutoshd@codeaurora.org>
1255 Description: This entry shows the total user-space decrease in shared
1256 buffer mode.
1257 The value of this parameter is 3 for TLC NAND when SLC mode
1258 is used as WriteBooster Buffer. 2 for MLC NAND.
1259
1260 The file is read only.
1261
1262 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units
1263 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_max_alloc_units
1264 Date: June 2020
1265 Contact: Asutosh Das <asutoshd@codeaurora.org>
1266 Description: This entry shows the Maximum total WriteBooster Buffer size
1267 which is supported by the entire device.
1268
1269 The file is read only.
1270
1271 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
1272 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_max_wb_luns
1273 Date: June 2020
1274 Contact: Asutosh Das <asutoshd@codeaurora.org>
1275 Description: This entry shows the maximum number of luns that can support
1276 WriteBooster.
1277
1278 The file is read only.
1279
1280 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
1281 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_sup_red_type
1282 Date: June 2020
1283 Contact: Asutosh Das <asutoshd@codeaurora.org>
1284 Description: The supportability of user space reduction mode
1285 and preserve user space mode.
1286 00h: WriteBooster Buffer can be configured only in
1287 user space reduction type.
1288 01h: WriteBooster Buffer can be configured only in
1289 preserve user space type.
1290 02h: Device can be configured in either user space
1291 reduction type or preserve user space type.
1292
1293 The file is read only.
1294
1295 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
1296 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_sup_wb_type
1297 Date: June 2020
1298 Contact: Asutosh Das <asutoshd@codeaurora.org>
1299 Description: The supportability of WriteBooster Buffer type.
1300
1301 === ==========================================================
1302 00h LU based WriteBooster Buffer configuration
1303 01h Single shared WriteBooster Buffer configuration
1304 02h Supporting both LU based WriteBooster.
1305 Buffer and Single shared WriteBooster Buffer configuration
1306 === ==========================================================
1307
1308 The file is read only.
1309
1310 What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
1311 What: /sys/bus/platform/devices/*.ufs/flags/wb_enable
1312 Date: June 2020
1313 Contact: Asutosh Das <asutoshd@codeaurora.org>
1314 Description: This entry shows the status of WriteBooster.
1315
1316 == ============================
1317 0 WriteBooster is not enabled.
1318 1 WriteBooster is enabled
1319 == ============================
1320
1321 The file is read only.
1322
1323 What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
1324 What: /sys/bus/platform/devices/*.ufs/flags/wb_flush_en
1325 Date: June 2020
1326 Contact: Asutosh Das <asutoshd@codeaurora.org>
1327 Description: This entry shows if flush is enabled.
1328
1329 == =================================
1330 0 Flush operation is not performed.
1331 1 Flush operation is performed.
1332 == =================================
1333
1334 The file is read only.
1335
1336 What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8
1337 What: /sys/bus/platform/devices/*.ufs/flags/wb_flush_during_h8
1338 Date: June 2020
1339 Contact: Asutosh Das <asutoshd@codeaurora.org>
1340 Description: Flush WriteBooster Buffer during hibernate state.
1341
1342 == =================================================
1343 0 Device is not allowed to flush the
1344 WriteBooster Buffer during link hibernate state.
1345 1 Device is allowed to flush the
1346 WriteBooster Buffer during link hibernate state.
1347 == =================================================
1348
1349 The file is read only.
1350
1351 What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf
1352 What: /sys/bus/platform/devices/*.ufs/attributes/wb_avail_buf
1353 Date: June 2020
1354 Contact: Asutosh Das <asutoshd@codeaurora.org>
1355 Description: This entry shows the amount of unused WriteBooster buffer
1356 available.
1357
1358 The file is read only.
1359
1360 What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
1361 What: /sys/bus/platform/devices/*.ufs/attributes/wb_cur_buf
1362 Date: June 2020
1363 Contact: Asutosh Das <asutoshd@codeaurora.org>
1364 Description: This entry shows the amount of unused current buffer.
1365
1366 The file is read only.
1367
1368 What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status
1369 What: /sys/bus/platform/devices/*.ufs/attributes/wb_flush_status
1370 Date: June 2020
1371 Contact: Asutosh Das <asutoshd@codeaurora.org>
1372 Description: This entry shows the flush operation status.
1373
1374
1375 === ======================================
1376 00h idle
1377 01h Flush operation in progress
1378 02h Flush operation stopped prematurely.
1379 03h Flush operation completed successfully
1380 04h Flush operation general failure
1381 === ======================================
1382
1383 The file is read only.
1384
1385 What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est
1386 What: /sys/bus/platform/devices/*.ufs/attributes/wb_life_time_est
1387 Date: June 2020
1388 Contact: Asutosh Das <asutoshd@codeaurora.org>
1389 Description: This entry shows an indication of the WriteBooster Buffer
1390 lifetime based on the amount of performed program/erase cycles
1391
1392 === =============================================
1393 01h 0% - 10% WriteBooster Buffer life time used
1394 ...
1395 0Ah 90% - 100% WriteBooster Buffer life time used
1396 === =============================================
1397
1398 The file is read only.
1399
1400 What: /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
1401 Date: June 2020
1402 Contact: Asutosh Das <asutoshd@codeaurora.org>
1403 Description: This entry shows the configured size of WriteBooster buffer.
1404 0400h corresponds to 4GB.
1405
1406 The file is read only.
1407
1408 What: /sys/bus/platform/drivers/ufshcd/*/wb_on
1409 What: /sys/bus/platform/devices/*.ufs/wb_on
1410 Date: January 2021
1411 Contact: Bean Huo <beanhuo@micron.com>
1412 Description: This node is used to set or display whether UFS WriteBooster is
1413 enabled. Echo 0 to this file to disable UFS WriteBooster or 1 to
1414 enable it. The WriteBooster is enabled after power-on/reset,
1415 however, it will be disabled/enable while CLK scaling down/up
1416 (if the platform supports UFSHCD_CAP_CLK_SCALING). For a
1417 platform that doesn't support UFSHCD_CAP_CLK_SCALING, we can
1418 disable/enable WriteBooster through this sysfs node.
1419
1420 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_version
1421 What: /sys/bus/platform/devices/*.ufs/device_descriptor/hpb_version
1422 Date: June 2021
1423 Contact: Daejun Park <daejun7.park@samsung.com>
1424 Description: This entry shows the HPB specification version.
1425 The full information about the descriptor can be found in the UFS
1426 HPB (Host Performance Booster) Extension specifications.
1427 Example: version 1.2.3 = 0123h
1428
1429 The file is read only.
1430
1431 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_control
1432 What: /sys/bus/platform/devices/*.ufs/device_descriptor/hpb_control
1433 Date: June 2021
1434 Contact: Daejun Park <daejun7.park@samsung.com>
1435 Description: This entry shows an indication of the HPB control mode.
1436 00h: Host control mode
1437 01h: Device control mode
1438
1439 The file is read only.
1440
1441 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_region_size
1442 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/hpb_region_size
1443 Date: June 2021
1444 Contact: Daejun Park <daejun7.park@samsung.com>
1445 Description: This entry shows the bHPBRegionSize which can be calculated
1446 as in the following (in bytes):
1447 HPB Region size = 512B * 2^bHPBRegionSize
1448
1449 The file is read only.
1450
1451 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_number_lu
1452 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/hpb_number_lu
1453 Date: June 2021
1454 Contact: Daejun Park <daejun7.park@samsung.com>
1455 Description: This entry shows the maximum number of HPB LU supported by
1456 the device.
1457 00h: HPB is not supported by the device.
1458 01h ~ 20h: Maximum number of HPB LU supported by the device
1459
1460 The file is read only.
1461
1462 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_subregion_size
1463 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/hpb_subregion_size
1464 Date: June 2021
1465 Contact: Daejun Park <daejun7.park@samsung.com>
1466 Description: This entry shows the bHPBSubRegionSize, which can be
1467 calculated as in the following (in bytes) and shall be a multiple of
1468 logical block size:
1469 HPB Sub-Region size = 512B x 2^bHPBSubRegionSize
1470 bHPBSubRegionSize shall not exceed bHPBRegionSize.
1471
1472 The file is read only.
1473
1474 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_max_active_regions
1475 What: /sys/bus/platform/devices/*.ufs/geometry_descriptor/hpb_max_active_regions
1476 Date: June 2021
1477 Contact: Daejun Park <daejun7.park@samsung.com>
1478 Description: This entry shows the maximum number of active HPB regions that
1479 is supported by the device.
1480
1481 The file is read only.
1482
1483 What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_lu_max_active_regions
1484 Date: June 2021
1485 Contact: Daejun Park <daejun7.park@samsung.com>
1486 Description: This entry shows the maximum number of HPB regions assigned to
1487 the HPB logical unit.
1488
1489 The file is read only.
1490
1491 What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_pinned_region_start_offset
1492 Date: June 2021
1493 Contact: Daejun Park <daejun7.park@samsung.com>
1494 Description: This entry shows the start offset of HPB pinned region.
1495
1496 The file is read only.
1497
1498 What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_number_pinned_regions
1499 Date: June 2021
1500 Contact: Daejun Park <daejun7.park@samsung.com>
1501 Description: This entry shows the number of HPB pinned regions assigned to
1502 the HPB logical unit.
1503
1504 The file is read only.
1505
1506 What: /sys/class/scsi_device/*/device/hpb_stats/hit_cnt
1507 Date: June 2021
1508 Contact: Daejun Park <daejun7.park@samsung.com>
1509 Description: This entry shows the number of reads that changed to HPB read.
1510
1511 The file is read only.
1512
1513 What: /sys/class/scsi_device/*/device/hpb_stats/miss_cnt
1514 Date: June 2021
1515 Contact: Daejun Park <daejun7.park@samsung.com>
1516 Description: This entry shows the number of reads that cannot be changed to
1517 HPB read.
1518
1519 The file is read only.
1520
1521 What: /sys/class/scsi_device/*/device/hpb_stats/rcmd_noti_cnt
1522 Date: June 2021
1523 Contact: Daejun Park <daejun7.park@samsung.com>
1524 Description: This entry shows the number of response UPIUs that has
1525 recommendations for activating sub-regions and/or inactivating region.
1526
1527 The file is read only.
1528
1529 What: /sys/class/scsi_device/*/device/hpb_stats/rcmd_active_cnt
1530 Date: June 2021
1531 Contact: Daejun Park <daejun7.park@samsung.com>
1532 Description: For the HPB device control mode, this entry shows the number of
1533 active sub-regions recommended by response UPIUs. For the HPB host control
1534 mode, this entry shows the number of active sub-regions recommended by the
1535 HPB host control mode heuristic algorithm.
1536
1537 The file is read only.
1538
1539 What: /sys/class/scsi_device/*/device/hpb_stats/rcmd_inactive_cnt
1540 Date: June 2021
1541 Contact: Daejun Park <daejun7.park@samsung.com>
1542 Description: For the HPB device control mode, this entry shows the number of
1543 inactive regions recommended by response UPIUs. For the HPB host control
1544 mode, this entry shows the number of inactive regions recommended by the
1545 HPB host control mode heuristic algorithm.
1546
1547 The file is read only.
1548
1549 What: /sys/class/scsi_device/*/device/hpb_stats/map_req_cnt
1550 Date: June 2021
1551 Contact: Daejun Park <daejun7.park@samsung.com>
1552 Description: This entry shows the number of read buffer commands for
1553 activating sub-regions recommended by response UPIUs.
1554
1555 The file is read only.
1556
1557 What: /sys/class/scsi_device/*/device/hpb_params/requeue_timeout_ms
1558 Date: June 2021
1559 Contact: Daejun Park <daejun7.park@samsung.com>
1560 Description: This entry shows the requeue timeout threshold for write buffer
1561 command in ms. The value can be changed by writing an integer to
1562 this entry.
1563
1564 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_size_hpb_single_cmd
1565 What: /sys/bus/platform/devices/*.ufs/attributes/max_data_size_hpb_single_cmd
1566 Date: June 2021
1567 Contact: Daejun Park <daejun7.park@samsung.com>
1568 Description: This entry shows the maximum HPB data size for using a single HPB
1569 command.
1570
1571 === ========
1572 00h 4KB
1573 01h 8KB
1574 02h 12KB
1575 ...
1576 FFh 1024KB
1577 === ========
1578
1579 The file is read only.
1580
1581 What: /sys/bus/platform/drivers/ufshcd/*/flags/hpb_enable
1582 What: /sys/bus/platform/devices/*.ufs/flags/hpb_enable
1583 Date: June 2021
1584 Contact: Daejun Park <daejun7.park@samsung.com>
1585 Description: This entry shows the status of HPB.
1586
1587 == ============================
1588 0 HPB is not enabled.
1589 1 HPB is enabled
1590 == ============================
1591
1592 The file is read only.
1593
1594 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/activation_thld
1595 Date: February 2021
1596 Contact: Avri Altman <avri.altman@wdc.com>
1597 Description: In host control mode, reads are the major source of activation
1598 trials. Once this threshold hs met, the region is added to the
1599 "to-be-activated" list. Since we reset the read counter upon
1600 write, this include sending a rb command updating the region
1601 ppn as well.
1602
1603 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/normalization_factor
1604 Date: February 2021
1605 Contact: Avri Altman <avri.altman@wdc.com>
1606 Description: In host control mode, we think of the regions as "buckets".
1607 Those buckets are being filled with reads, and emptied on write.
1608 We use entries_per_srgn - the amount of blocks in a subregion as
1609 our bucket size. This applies because HPB1.0 only handles
1610 single-block reads. Once the bucket size is crossed, we trigger
1611 a normalization work - not only to avoid overflow, but mainly
1612 because we want to keep those counters normalized, as we are
1613 using those reads as a comparative score, to make various decisions.
1614 The normalization is dividing (shift right) the read counter by
1615 the normalization_factor. If during consecutive normalizations
1616 an active region has exhausted its reads - inactivate it.
1617
1618 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_enter
1619 Date: February 2021
1620 Contact: Avri Altman <avri.altman@wdc.com>
1621 Description: Region deactivation is often due to the fact that eviction took
1622 place: A region becomes active at the expense of another. This is
1623 happening when the max-active-regions limit has been crossed.
1624 In host mode, eviction is considered an extreme measure. We
1625 want to verify that the entering region has enough reads, and
1626 the exiting region has much fewer reads. eviction_thld_enter is
1627 the min reads that a region must have in order to be considered
1628 a candidate for evicting another region.
1629
1630 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_exit
1631 Date: February 2021
1632 Contact: Avri Altman <avri.altman@wdc.com>
1633 Description: Same as above for the exiting region. A region is considered to
1634 be a candidate for eviction only if it has fewer reads than
1635 eviction_thld_exit.
1636
1637 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_ms
1638 Date: February 2021
1639 Contact: Avri Altman <avri.altman@wdc.com>
1640 Description: In order not to hang on to "cold" regions, we inactivate
1641 a region that has no READ access for a predefined amount of
1642 time - read_timeout_ms. If read_timeout_ms has expired, and the
1643 region is dirty, it is less likely that we can make any use of
1644 HPB reading it so we inactivate it. Still, deactivation has
1645 its overhead, and we may still benefit from HPB reading this
1646 region if it is clean - see read_timeout_expiries.
1647
1648 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_expiries
1649 Date: February 2021
1650 Contact: Avri Altman <avri.altman@wdc.com>
1651 Description: If the region read timeout has expired, but the region is clean,
1652 just re-wind its timer for another spin. Do that as long as it
1653 is clean and did not exhaust its read_timeout_expiries threshold.
1654
1655 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/timeout_polling_interval_ms
1656 Date: February 2021
1657 Contact: Avri Altman <avri.altman@wdc.com>
1658 Description: The frequency with which the delayed worker that checks the
1659 read_timeouts is awakened.
1660
1661 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/inflight_map_req
1662 Date: February 2021
1663 Contact: Avri Altman <avri.altman@wdc.com>
1664 Description: In host control mode the host is the originator of map requests.
1665 To avoid flooding the device with map requests, use a simple throttling
1666 mechanism that limits the number of inflight map requests.
