1What: /sys/bus/*/drivers/ufshcd/*/auto_hibern8 2Date: March 2018 3Contact: linux-scsi@vger.kernel.org 4Description: 5 This file contains the auto-hibernate idle timer setting of a 6 UFS host controller. A value of '0' means auto-hibernate is not 7 enabled. Otherwise the value is the number of microseconds of 8 idle time before the UFS host controller will autonomously put 9 the link into hibernate state. That will save power at the 10 expense of increased latency. Note that the hardware supports 11 10-bit values with a power-of-ten multiplier which allows a 12 maximum value of 102300000. Refer to the UFS Host Controller 13 Interface specification for more details. 14 15What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_type 16Date: February 2018 17Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 18Description: This file shows the device type. This is one of the UFS 19 device descriptor parameters. The full information about 20 the descriptor could be found at UFS specifications 2.1. 21 22 The file is read only. 23 24What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class 25Date: February 2018 26Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 27Description: This file shows the device class. This is one of the UFS 28 device descriptor parameters. The full information about 29 the descriptor could be found at UFS specifications 2.1. 30 31 The file is read only. 32 33What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class 34Date: February 2018 35Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 36Description: This file shows the UFS storage subclass. This is one of 37 the UFS device descriptor parameters. The full information 38 about the descriptor could be found at UFS specifications 2.1. 39 40 The file is read only. 41 42What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol 43Date: February 2018 44Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 45Description: This file shows the protocol supported by an UFS device. 46 This is one of the UFS device descriptor parameters. 47 The full information about the descriptor could be found 48 at UFS specifications 2.1. 49 50 The file is read only. 51 52What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns 53Date: February 2018 54Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 55Description: This file shows number of logical units. This is one of 56 the UFS device descriptor parameters. The full information 57 about the descriptor could be found at UFS specifications 2.1. 58 59 The file is read only. 60 61What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns 62Date: February 2018 63Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 64Description: This file shows number of well known logical units. 65 This is one of the UFS device descriptor parameters. 66 The full information about the descriptor could be found 67 at UFS specifications 2.1. 68 69 The file is read only. 70 71What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable 72Date: February 2018 73Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 74Description: This file shows value that indicates whether the device is 75 enabled for boot. This is one of the UFS device descriptor 76 parameters. The full information about the descriptor could 77 be found at UFS specifications 2.1. 78 79 The file is read only. 80 81What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable 82Date: February 2018 83Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 84Description: This file shows value that indicates whether the device 85 descriptor could be read after partial initialization phase 86 of the boot sequence. This is one of the UFS device descriptor 87 parameters. The full information about the descriptor could 88 be found at UFS specifications 2.1. 89 90 The file is read only. 91 92What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode 93Date: February 2018 94Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 95Description: This file shows value that defines the power mode after 96 device initialization or hardware reset. This is one of 97 the UFS device descriptor parameters. The full information 98 about the descriptor could be found at UFS specifications 2.1. 99 100 The file is read only. 101 102What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/high_priority_lun 103Date: February 2018 104Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 105Description: This file shows the high priority lun. This is one of 106 the UFS device descriptor parameters. The full information 107 about the descriptor could be found at UFS specifications 2.1. 108 109 The file is read only. 110 111What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type 112Date: February 2018 113Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 114Description: This file shows the secure removal type. This is one of 115 the UFS device descriptor parameters. The full information 116 about the descriptor could be found at UFS specifications 2.1. 117 118 The file is read only. 119 120What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun 121Date: February 2018 122Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 123Description: This file shows whether the security lun is supported. 124 This is one of the UFS device descriptor parameters. 125 The full information about the descriptor could be found 126 at UFS specifications 2.1. 127 128 The file is read only. 129 130What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency 131Date: February 2018 132Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 133Description: This file shows the background operations termination 134 latency. This is one of the UFS device descriptor parameters. 135 The full information about the descriptor could be found 136 at UFS specifications 2.1. 137 138 The file is read only. 139 140What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level 141Date: February 2018 142Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 143Description: This file shows the initial active ICC level. This is one 144 of the UFS device descriptor parameters. The full information 145 about the descriptor could be found at UFS specifications 2.1. 146 147 The file is read only. 148 149What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version 150Date: February 2018 151Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 152Description: This file shows the specification version. This is one 153 of the UFS device descriptor parameters. The full information 154 about the descriptor could be found at UFS specifications 2.1. 155 156 The file is read only. 157 158What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date 159Date: February 2018 160Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 161Description: This file shows the manufacturing date in BCD format. 162 This is one of the UFS device descriptor parameters. 163 The full information about the descriptor could be found 164 at UFS specifications 2.1. 165 166 The file is read only. 167 168What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id 169Date: February 2018 170Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 171Description: This file shows the manufacturer ID. This is one of the 172 UFS device descriptor parameters. The full information about 173 the descriptor could be found at UFS specifications 2.1. 174 175 The file is read only. 176 177What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability 178Date: February 2018 179Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 180Description: This file shows the maximum number of outstanding RTTs 181 supported by the device. This is one of the UFS device 182 descriptor parameters. The full information about 183 the descriptor could be found at UFS specifications 2.1. 184 185 The file is read only. 186 187What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update 188Date: February 2018 189Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 190Description: This file shows the frequency and method of the realtime 191 clock update. This is one of the UFS device descriptor 192 parameters. The full information about the descriptor 193 could be found at UFS specifications 2.1. 194 195 The file is read only. 196 197What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features 198Date: February 2018 199Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 200Description: This file shows which features are supported by the device. 201 This is one of the UFS device descriptor parameters. 202 The full information about the descriptor could be 203 found at UFS specifications 2.1. 204 205 The file is read only. 206 207What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout 208Date: February 2018 209Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 210Description: This file shows the FFU timeout. This is one of the 211 UFS device descriptor parameters. The full information 212 about the descriptor could be found at UFS specifications 2.1. 213 214 The file is read only. 215 216What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth 217Date: February 2018 218Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 219Description: This file shows the device queue depth. This is one of the 220 UFS device descriptor parameters. The full information 221 about the descriptor could be found at UFS specifications 2.1. 222 223 The file is read only. 224 225What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version 226Date: February 2018 227Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 228Description: This file shows the device version. This is one of the 229 UFS device descriptor parameters. The full information 230 about the descriptor could be found at UFS specifications 2.1. 231 232 The file is read only. 233 234What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa 235Date: February 2018 236Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 237Description: This file shows number of secure write protect areas 238 supported by the device. This is one of the UFS device 239 descriptor parameters. The full information about 240 the descriptor could be found at UFS specifications 2.1. 241 242 The file is read only. 243 244What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size 245Date: February 2018 246Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 247Description: This file shows the maximum amount of data that may be 248 written during the pre-soldering phase of the PSA flow. 249 This is one of the UFS device descriptor parameters. 250 The full information about the descriptor could be found 251 at UFS specifications 2.1. 252 253 The file is read only. 254 255What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout 256Date: February 2018 257Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 258Description: This file shows the command maximum timeout for a change 259 in PSA state. This is one of the UFS device descriptor 260 parameters. The full information about the descriptor could 261 be found at UFS specifications 2.1. 262 263 The file is read only. 264 265 266What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/unipro_version 267Date: February 2018 268Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 269Description: This file shows the MIPI UniPro version number in BCD format. 270 This is one of the UFS interconnect descriptor parameters. 271 The full information about the descriptor could be found at 272 UFS specifications 2.1. 273 274 The file is read only. 275 276What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version 277Date: February 2018 278Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 279Description: This file shows the MIPI M-PHY version number in BCD format. 280 This is one of the UFS interconnect descriptor parameters. 281 The full information about the descriptor could be found at 282 UFS specifications 2.1. 283 284 The file is read only. 285 286 287What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/raw_device_capacity 288Date: February 2018 289Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 290Description: This file shows the total memory quantity available to 291 the user to configure the device logical units. This is one 292 of the UFS geometry descriptor parameters. The full 293 information about the descriptor could be found at 294 UFS specifications 2.1. 295 296 The file is read only. 297 298What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns 299Date: February 2018 300Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 301Description: This file shows the maximum number of logical units 302 supported by the UFS device. This is one of the UFS 303 geometry descriptor parameters. The full information about 304 the descriptor could be found at UFS specifications 2.1. 305 306 The file is read only. 307 308What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size 309Date: February 2018 310Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 311Description: This file shows the segment size. This is one of the UFS 312 geometry descriptor parameters. The full information about 313 the descriptor could be found at UFS specifications 2.1. 314 315 The file is read only. 316 317What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size 318Date: February 2018 319Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 320Description: This file shows the allocation unit size. This is one of 321 the UFS geometry descriptor parameters. The full information 322 about the descriptor could be found at UFS specifications 2.1. 323 324 The file is read only. 325 326What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size 327Date: February 2018 328Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 329Description: This file shows the minimum addressable block size. This 330 is one of the UFS geometry descriptor parameters. The full 331 information about the descriptor could be found at UFS 332 specifications 2.1. 333 334 The file is read only. 335 336What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size 337Date: February 2018 338Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 339Description: This file shows the optimal read block size. This is one 340 of the UFS geometry descriptor parameters. The full 341 information about the descriptor could be found at UFS 342 specifications 2.1. 343 344 The file is read only. 345 346What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size 347Date: February 2018 348Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 349Description: This file shows the optimal write block size. This is one 350 of the UFS geometry descriptor parameters. The full 351 information about the descriptor could be found at UFS 352 specifications 2.1. 353 354 The file is read only. 355 356What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size 357Date: February 2018 358Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 359Description: This file shows the maximum data-in buffer size. This 360 is one of the UFS geometry descriptor parameters. The full 361 information about the descriptor could be found at UFS 362 specifications 2.1. 363 364 The file is read only. 365 366What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size 367Date: February 2018 368Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 369Description: This file shows the maximum data-out buffer size. This 370 is one of the UFS geometry descriptor parameters. The full 371 information about the descriptor could be found at UFS 372 specifications 2.1. 373 374 The file is read only. 375 376What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size 377Date: February 2018 378Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 379Description: This file shows the maximum number of RPMB frames allowed 380 in Security Protocol In/Out. This is one of the UFS geometry 381 descriptor parameters. The full information about the 382 descriptor could be found at UFS specifications 2.1. 383 384 The file is read only. 385 386What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy 387Date: February 2018 388Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 389Description: This file shows the dynamic capacity resource policy. This 390 is one of the UFS geometry descriptor parameters. The full 391 information about the descriptor could be found at 392 UFS specifications 2.1. 393 394 The file is read only. 395 396What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering 397Date: February 2018 398Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 399Description: This file shows support for out-of-order data transfer. 400 This is one of the UFS geometry descriptor parameters. 401 The full information about the descriptor could be found at 402 UFS specifications 2.1. 403 404 The file is read only. 405 406What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_contexts 407Date: February 2018 408Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 409Description: This file shows maximum available number of contexts which 410 are supported by the device. This is one of the UFS geometry 411 descriptor parameters. The full information about the 412 descriptor could be found at UFS specifications 2.1. 413 414 The file is read only. 415 416What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size 417Date: February 2018 418Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 419Description: This file shows system data tag unit size. This is one of 420 the UFS geometry descriptor parameters. The full information 421 about the descriptor could be found at UFS specifications 2.1. 422 423 The file is read only. 424 425What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size 426Date: February 2018 427Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 428Description: This file shows maximum storage area size allocated by 429 the device to handle system data by the tagging mechanism. 430 This is one of the UFS geometry descriptor parameters. 431 The full information about the descriptor could be found at 432 UFS specifications 2.1. 433 434 The file is read only. 435 436What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types 437Date: February 2018 438Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 439Description: This file shows supported secure removal types. This is 440 one of the UFS geometry descriptor parameters. The full 441 information about the descriptor could be found at 442 UFS specifications 2.1. 443 444 The file is read only. 445 446What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types 447Date: February 2018 448Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 449Description: This file shows supported memory types. This is one of 450 the UFS geometry descriptor parameters. The full 451 information about the descriptor could be found at 452 UFS specifications 2.1. 453 454 The file is read only. 455 456What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units 457Date: February 2018 458Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 459Description: This file shows the maximum number of allocation units for 460 different memory types (system code, non persistent, 461 enhanced type 1-4). This is one of the UFS geometry 462 descriptor parameters. The full information about the 463 descriptor could be found at UFS specifications 2.1. 464 465 The file is read only. 466 467What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor 468Date: February 2018 469Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 470Description: This file shows the memory capacity adjustment factor for 471 different memory types (system code, non persistent, 472 enhanced type 1-4). This is one of the UFS geometry 473 descriptor parameters. The full information about the 474 descriptor could be found at UFS specifications 2.1. 475 476 The file is read only. 477 478 479What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/eol_info 480Date: February 2018 481Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 482Description: This file shows preend of life information. This is one 483 of the UFS health descriptor parameters. The full 484 information about the descriptor could be found at 485 UFS specifications 2.1. 486 487 The file is read only. 488 489What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a 490Date: February 2018 491Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 492Description: This file shows indication of the device life time 493 (method a). This is one of the UFS health descriptor 494 parameters. The full information about the descriptor 495 could be found at UFS specifications 2.1. 496 497 The file is read only. 498 499What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b 500Date: February 2018 501Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 502Description: This file shows indication of the device life time 503 (method b). This is one of the UFS health descriptor 504 parameters. The full information about the descriptor 505 could be found at UFS specifications 2.1. 506 507 The file is read only. 508 509 510What: /sys/bus/platform/drivers/ufshcd/*/power_descriptor/active_icc_levels_vcc* 511Date: February 2018 512Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 513Description: This file shows maximum VCC, VCCQ and VCCQ2 value for 514 active ICC levels from 0 to 15. This is one of the UFS 515 power descriptor parameters. The full information about 516 the descriptor could be found at UFS specifications 2.1. 517 518 The file is read only. 519 520 521What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/manufacturer_name 522Date: February 2018 523Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 524Description: This file contains a device manufacturer name string. 525 The full information about the descriptor could be found at 526 UFS specifications 2.1. 527 528 The file is read only. 529 530What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name 531Date: February 2018 532Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 533Description: This file contains a product name string. The full information 534 about the descriptor could be found at UFS specifications 2.1. 535 536 The file is read only. 537 538What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id 539Date: February 2018 540Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 541Description: This file contains a OEM ID string. The full information 542 about the descriptor could be found at UFS specifications 2.1. 543 544 The file is read only. 545 546What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number 547Date: February 2018 548Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 549Description: This file contains a device serial number string. The full 550 information about the descriptor could be found at 551 UFS specifications 2.1. 552 553 The file is read only. 554 555What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision 556Date: February 2018 557Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 558Description: This file contains a product revision string. The full 559 information about the descriptor could be found at 560 UFS specifications 2.1. 561 562 The file is read only. 563 564 565What: /sys/class/scsi_device/*/device/unit_descriptor/boot_lun_id 566Date: February 2018 567Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 568Description: This file shows boot LUN information. This is one of 569 the UFS unit descriptor parameters. The full information 570 about the descriptor could be found at UFS specifications 2.1. 571 572 The file is read only. 573 574What: /sys/class/scsi_device/*/device/unit_descriptor/lun_write_protect 575Date: February 2018 576Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 577Description: This file shows LUN write protection status. This is one of 578 the UFS unit descriptor parameters. The full information 579 about the descriptor could be found at UFS specifications 2.1. 580 581 The file is read only. 582 583What: /sys/class/scsi_device/*/device/unit_descriptor/lun_queue_depth 584Date: February 2018 585Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 586Description: This file shows LUN queue depth. This is one of the UFS 587 unit descriptor parameters. The full information about 588 the descriptor could be found at UFS specifications 2.1. 589 590 The file is read only. 591 592What: /sys/class/scsi_device/*/device/unit_descriptor/psa_sensitive 593Date: February 2018 594Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 595Description: This file shows PSA sensitivity. This is one of the UFS 596 unit descriptor parameters. The full information about 597 the descriptor could be found at UFS specifications 2.1. 598 599 The file is read only. 600 601What: /sys/class/scsi_device/*/device/unit_descriptor/lun_memory_type 602Date: February 2018 603Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 604Description: This file shows LUN memory type. This is one of the UFS 605 unit descriptor parameters. The full information about 606 the descriptor could be found at UFS specifications 2.1. 607 608 The file is read only. 609 610What: /sys/class/scsi_device/*/device/unit_descriptor/data_reliability 611Date: February 2018 612Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 613Description: This file defines the device behavior when a power failure 614 occurs during a write operation. This is one of the UFS 615 unit descriptor parameters. The full information about 616 the descriptor could be found at UFS specifications 2.1. 617 618 The file is read only. 619 620What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_size 621Date: February 2018 622Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 623Description: This file shows the size of addressable logical blocks 624 (calculated as an exponent with base 2). This is one of 625 the UFS unit descriptor parameters. The full information about 626 the descriptor could be found at UFS specifications 2.1. 627 628 The file is read only. 629 630What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_count 631Date: February 2018 632Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 633Description: This file shows total number of addressable logical blocks. 634 This is one of the UFS unit descriptor parameters. The full 635 information about the descriptor could be found at 636 UFS specifications 2.1. 637 638 The file is read only. 639 640What: /sys/class/scsi_device/*/device/unit_descriptor/erase_block_size 641Date: February 2018 642Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 643Description: This file shows the erase block size. This is one of 644 the UFS unit descriptor parameters. The full information 645 about the descriptor could be found at UFS specifications 2.1. 646 647 The file is read only. 648 649What: /sys/class/scsi_device/*/device/unit_descriptor/provisioning_type 650Date: February 2018 651Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 652Description: This file shows the thin provisioning type. This is one of 653 the UFS unit descriptor parameters. The full information 654 about the descriptor could be found at UFS specifications 2.1. 655 656 The file is read only. 657 658What: /sys/class/scsi_device/*/device/unit_descriptor/physical_memory_resourse_count 659Date: February 2018 660Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 661Description: This file shows the total physical memory resources. This is 662 one of the UFS unit descriptor parameters. The full information 663 about the descriptor could be found at UFS specifications 2.1. 664 665 The file is read only. 666 667What: /sys/class/scsi_device/*/device/unit_descriptor/context_capabilities 668Date: February 2018 669Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 670Description: This file shows the context capabilities. This is one of 671 the UFS unit descriptor parameters. The full information 672 about the descriptor could be found at UFS specifications 2.1. 673 674 The file is read only. 675 676What: /sys/class/scsi_device/*/device/unit_descriptor/large_unit_granularity 677Date: February 2018 678Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 679Description: This file shows the granularity of the LUN. This is one of 680 the UFS unit descriptor parameters. The full information 681 about the descriptor could be found at UFS specifications 2.1. 682 683 The file is read only. 684 685 686What: /sys/bus/platform/drivers/ufshcd/*/flags/device_init 687Date: February 2018 688Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 689Description: This file shows the device init status. The full information 690 about the flag could be found at UFS specifications 2.1. 691 692 The file is read only. 693 694What: /sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe 695Date: February 2018 696Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 697Description: This file shows whether permanent write protection is enabled. 698 The full information about the flag could be found at 699 UFS specifications 2.1. 700 701 The file is read only. 702 703What: /sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe 704Date: February 2018 705Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 706Description: This file shows whether write protection is enabled on all 707 logical units configured as power on write protected. The 708 full information about the flag could be found at 709 UFS specifications 2.1. 710 711 The file is read only. 712 713What: /sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable 714Date: February 2018 715Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 716Description: This file shows whether the device background operations are 717 enabled. The full information about the flag could be 718 found at UFS specifications 2.1. 719 720 The file is read only. 721 722What: /sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable 723Date: February 2018 724Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 725Description: This file shows whether the device life span mode is enabled. 726 The full information about the flag could be found at 727 UFS specifications 2.1. 728 729 The file is read only. 730 731What: /sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal 732Date: February 2018 733Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 734Description: This file shows whether physical resource removal is enable. 735 The full information about the flag could be found at 736 UFS specifications 2.1. 737 738 The file is read only. 739 740What: /sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc 741Date: February 2018 742Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 743Description: This file shows whether the device is executing internal 744 operation related to real time clock. The full information 745 about the flag could be found at UFS specifications 2.1. 746 747 The file is read only. 748 749What: /sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update 750Date: February 2018 751Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 752Description: This file shows whether the device FW update is permanently 753 disabled. The full information about the flag could be found 754 at UFS specifications 2.1. 755 756 The file is read only. 757 758 759What: /sys/bus/platform/drivers/ufshcd/*/attributes/boot_lun_enabled 760Date: February 2018 761Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 762Description: This file provides the boot lun enabled UFS device attribute. 763 The full information about the attribute could be found at 764 UFS specifications 2.1. 765 766 The file is read only. 767 768What: /sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode 769Date: February 2018 770Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 771Description: This file provides the current power mode UFS device attribute. 772 The full information about the attribute could be found at 773 UFS specifications 2.1. 774 775 The file is read only. 776 777What: /sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level 778Date: February 2018 779Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 780Description: This file provides the active icc level UFS device attribute. 781 The full information about the attribute could be found at 782 UFS specifications 2.1. 783 784 The file is read only. 785 786What: /sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled 787Date: February 2018 788Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 789Description: This file provides the out of order data transfer enabled UFS 790 device attribute. The full information about the attribute 791 could be found at UFS specifications 2.1. 792 793 The file is read only. 794 795What: /sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status 796Date: February 2018 797Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 798Description: This file provides the background operations status UFS device 799 attribute. The full information about the attribute could 800 be found at UFS specifications 2.1. 801 802 The file is read only. 803 804What: /sys/bus/platform/drivers/ufshcd/*/attributes/purge_status 805Date: February 2018 806Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 807Description: This file provides the purge operation status UFS device 808 attribute. The full information about the attribute could 809 be found at UFS specifications 2.1. 810 811 The file is read only. 812 813What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size 814Date: February 2018 815Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 816Description: This file shows the maximum data size in a DATA IN 817 UPIU. The full information about the attribute could 818 be found at UFS specifications 2.1. 819 820 The file is read only. 821 822What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size 823Date: February 2018 824Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 825Description: This file shows the maximum number of bytes that can be 826 requested with a READY TO TRANSFER UPIU. The full information 827 about the attribute could be found at UFS specifications 2.1. 828 829 The file is read only. 830 831What: /sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency 832Date: February 2018 833Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 834Description: This file provides the reference clock frequency UFS device 835 attribute. The full information about the attribute could 836 be found at UFS specifications 2.1. 837 838 The file is read only. 839 840What: /sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock 841Date: February 2018 842Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 843Description: This file shows whether the configuration descriptor is locked. 844 The full information about the attribute could be found at 845 UFS specifications 2.1. The file is read only. 846 847What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_number_of_rtt 848Date: February 2018 849Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 850Description: This file provides the maximum current number of 851 outstanding RTTs in device that is allowed. The full 852 information about the attribute could be found at 853 UFS specifications 2.1. 854 855 The file is read only. 856 857What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control 858Date: February 2018 859Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 860Description: This file provides the exception event control UFS device 861 attribute. The full information about the attribute could 862 be found at UFS specifications 2.1. 863 864 The file is read only. 865 866What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status 867Date: February 2018 868Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 869Description: This file provides the exception event status UFS device 870 attribute. The full information about the attribute could 871 be found at UFS specifications 2.1. 872 873 The file is read only. 874 875What: /sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status 876Date: February 2018 877Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 878Description: This file provides the ffu status UFS device attribute. 879 The full information about the attribute could be found at 880 UFS specifications 2.1. 881 882 The file is read only. 883 884What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_state 885Date: February 2018 886Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 887Description: This file show the PSA feature status. The full information 888 about the attribute could be found at UFS specifications 2.1. 889 890 The file is read only. 891 892What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size 893Date: February 2018 894Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 895Description: This file shows the amount of data that the host plans to 896 load to all logical units in pre-soldering state. 897 The full information about the attribute could be found at 898 UFS specifications 2.1. 899 900 The file is read only. 901 902 903What: /sys/class/scsi_device/*/device/dyn_cap_needed 904Date: February 2018 905Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com> 906Description: This file shows the The amount of physical memory needed 907 to be removed from the physical memory resources pool of 908 the particular logical unit. The full information about 909 the attribute could be found at UFS specifications 2.1. 910 911 The file is read only. 912 913 914What: /sys/bus/platform/drivers/ufshcd/*/rpm_lvl 915Date: September 2014 916Contact: Subhash Jadavani <subhashj@codeaurora.org> 917Description: This entry could be used to set or show the UFS device 918 runtime power management level. The current driver 919 implementation supports 7 levels with next target states: 920 921 == ==================================================== 922 0 UFS device will stay active, UIC link will 923 stay active 924 1 UFS device will stay active, UIC link will 925 hibernate 926 2 UFS device will be moved to sleep, UIC link will 927 stay active 928 3 UFS device will be moved to sleep, UIC link will 929 hibernate 930 4 UFS device will be powered off, UIC link will 931 hibernate 932 5 UFS device will be powered off, UIC link will 933 be powered off 934 6 UFS device will be moved to deep sleep, UIC link 935 will be powered off. Note, deep sleep might not be 936 supported in which case this value will not be 937 accepted 938 == ==================================================== 939 940What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state 941Date: February 2018 942Contact: Subhash Jadavani <subhashj@codeaurora.org> 943Description: This entry shows the target power mode of an UFS device 944 for the chosen runtime power management level. 945 946 The file is read only. 947 948What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state 949Date: February 2018 950Contact: Subhash Jadavani <subhashj@codeaurora.org> 951Description: This entry shows the target state of an UFS UIC link 952 for the chosen runtime power management level. 953 954 The file is read only. 955 956What: /sys/bus/platform/drivers/ufshcd/*/spm_lvl 957Date: September 2014 958Contact: Subhash Jadavani <subhashj@codeaurora.org> 959Description: This entry could be used to set or show the UFS device 960 system power management level. The current driver 961 implementation supports 7 levels with next target states: 962 963 == ==================================================== 964 0 UFS device will stay active, UIC link will 965 stay active 966 1 UFS device will stay active, UIC link will 967 hibernate 968 2 UFS device will be moved to sleep, UIC link will 969 stay active 970 3 UFS device will be moved to sleep, UIC link will 971 hibernate 972 4 UFS device will be powered off, UIC link will 973 hibernate 974 5 UFS device will be powered off, UIC link will 975 be powered off 976 6 UFS device will be moved to deep sleep, UIC link 977 will be powered off. Note, deep sleep might not be 978 supported in which case this value will not be 979 accepted 980 == ==================================================== 981 982What: /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state 983Date: February 2018 984Contact: Subhash Jadavani <subhashj@codeaurora.org> 985Description: This entry shows the target power mode of an UFS device 986 for the chosen system power management level. 987 988 The file is read only. 989 990What: /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state 991Date: February 2018 992Contact: Subhash Jadavani <subhashj@codeaurora.org> 993Description: This entry shows the target state of an UFS UIC link 994 for the chosen system power management level. 995 996 The file is read only. 997 998What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable 999Date: January 2021 1000Contact: Can Guo <cang@codeaurora.org> 1001Description: This file shows the status of performance monitor enablement 1002 and it can be used to start/stop the monitor. When the monitor 1003 is stopped, the performance data collected is also cleared. 1004 1005What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size 1006Date: January 2021 1007Contact: Can Guo <cang@codeaurora.org> 1008Description: This file tells the monitor to focus on requests transferring 1009 data of specific chunk size (in Bytes). 0 means any chunk size. 1010 It can only be changed when monitor is disabled. 1011 1012What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors 1013Date: January 2021 1014Contact: Can Guo <cang@codeaurora.org> 1015Description: This file shows how many sectors (in 512 Bytes) have been 1016 sent from device to host after monitor gets started. 1017 1018 The file is read only. 1019 1020What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy 1021Date: January 2021 1022Contact: Can Guo <cang@codeaurora.org> 1023Description: This file shows how long (in micro seconds) has been spent 1024 sending data from device to host after monitor gets started. 1025 1026 The file is read only. 1027 1028What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests 1029Date: January 2021 1030Contact: Can Guo <cang@codeaurora.org> 1031Description: This file shows how many read requests have been sent after 1032 monitor gets started. 1033 1034 The file is read only. 1035 1036What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max 1037Date: January 2021 1038Contact: Can Guo <cang@codeaurora.org> 1039Description: This file shows the maximum latency (in micro seconds) of 1040 read requests after monitor gets started. 1041 1042 The file is read only. 1043 1044What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min 1045Date: January 2021 1046Contact: Can Guo <cang@codeaurora.org> 1047Description: This file shows the minimum latency (in micro seconds) of 1048 read requests after monitor gets started. 1049 1050 The file is read only. 1051 1052What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg 1053Date: January 2021 1054Contact: Can Guo <cang@codeaurora.org> 1055Description: This file shows the average latency (in micro seconds) of 1056 read requests after monitor gets started. 1057 1058 The file is read only. 1059 1060What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum 1061Date: January 2021 1062Contact: Can Guo <cang@codeaurora.org> 1063Description: This file shows the total latency (in micro seconds) of 1064 read requests sent after monitor gets started. 1065 1066 The file is read only. 1067 1068What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors 1069Date: January 2021 1070Contact: Can Guo <cang@codeaurora.org> 1071Description: This file shows how many sectors (in 512 Bytes) have been sent 1072 from host to device after monitor gets started. 1073 1074 The file is read only. 1075 1076What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy 1077Date: January 2021 1078Contact: Can Guo <cang@codeaurora.org> 1079Description: This file shows how long (in micro seconds) has been spent 1080 sending data from host to device after monitor gets started. 1081 1082 The file is read only. 1083 1084What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests 1085Date: January 2021 1086Contact: Can Guo <cang@codeaurora.org> 1087Description: This file shows how many write requests have been sent after 1088 monitor gets started. 1089 1090 The file is read only. 1091 1092What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max 1093Date: January 2021 1094Contact: Can Guo <cang@codeaurora.org> 1095Description: This file shows the maximum latency (in micro seconds) of write 1096 requests after monitor gets started. 1097 1098 The file is read only. 1099 1100What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min 1101Date: January 2021 1102Contact: Can Guo <cang@codeaurora.org> 1103Description: This file shows the minimum latency (in micro seconds) of write 1104 requests after monitor gets started. 1105 1106 The file is read only. 1107 1108What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg 1109Date: January 2021 1110Contact: Can Guo <cang@codeaurora.org> 1111Description: This file shows the average latency (in micro seconds) of write 1112 requests after monitor gets started. 1113 1114 The file is read only. 1115 1116What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum 1117Date: January 2021 1118Contact: Can Guo <cang@codeaurora.org> 1119Description: This file shows the total latency (in micro seconds) of write 1120 requests after monitor gets started. 1121 1122 The file is read only. 1123 1124What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en 1125Date: June 2020 1126Contact: Asutosh Das <asutoshd@codeaurora.org> 1127Description: This entry shows if preserve user-space was configured 1128 1129 The file is read only. 1130 1131What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units 1132Date: June 2020 1133Contact: Asutosh Das <asutoshd@codeaurora.org> 1134Description: This entry shows the shared allocated units of WB buffer 1135 1136 The file is read only. 1137 1138What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type 1139Date: June 2020 1140Contact: Asutosh Das <asutoshd@codeaurora.org> 1141Description: This entry shows the configured WB type. 1142 0x1 for shared buffer mode. 0x0 for dedicated buffer mode. 1143 1144 The file is read only. 1145 1146What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj 1147Date: June 2020 1148Contact: Asutosh Das <asutoshd@codeaurora.org> 1149Description: This entry shows the total user-space decrease in shared 1150 buffer mode. 1151 The value of this parameter is 3 for TLC NAND when SLC mode 1152 is used as WriteBooster Buffer. 2 for MLC NAND. 1153 1154 The file is read only. 1155 1156What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units 1157Date: June 2020 1158Contact: Asutosh Das <asutoshd@codeaurora.org> 1159Description: This entry shows the Maximum total WriteBooster Buffer size 1160 which is supported by the entire device. 1161 1162 The file is read only. 1163 1164What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns 1165Date: June 2020 1166Contact: Asutosh Das <asutoshd@codeaurora.org> 1167Description: This entry shows the maximum number of luns that can support 1168 WriteBooster. 1169 1170 The file is read only. 1171 1172What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type 1173Date: June 2020 1174Contact: Asutosh Das <asutoshd@codeaurora.org> 1175Description: The supportability of user space reduction mode 1176 and preserve user space mode. 1177 00h: WriteBooster Buffer can be configured only in 1178 user space reduction type. 1179 01h: WriteBooster Buffer can be configured only in 1180 preserve user space type. 1181 02h: Device can be configured in either user space 1182 reduction type or preserve user space type. 1183 1184 The file is read only. 1185 1186What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type 1187Date: June 2020 1188Contact: Asutosh Das <asutoshd@codeaurora.org> 1189Description: The supportability of WriteBooster Buffer type. 1190 1191 === ========================================================== 1192 00h LU based WriteBooster Buffer configuration 1193 01h Single shared WriteBooster Buffer configuration 1194 02h Supporting both LU based WriteBooster. 1195 Buffer and Single shared WriteBooster Buffer configuration 1196 === ========================================================== 1197 1198 The file is read only. 1199 1200What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable 1201Date: June 2020 1202Contact: Asutosh Das <asutoshd@codeaurora.org> 1203Description: This entry shows the status of WriteBooster. 1204 1205 == ============================ 1206 0 WriteBooster is not enabled. 1207 1 WriteBooster is enabled 1208 == ============================ 1209 1210 The file is read only. 1211 1212What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en 1213Date: June 2020 1214Contact: Asutosh Das <asutoshd@codeaurora.org> 1215Description: This entry shows if flush is enabled. 1216 1217 == ================================= 1218 0 Flush operation is not performed. 1219 1 Flush operation is performed. 1220 == ================================= 1221 1222 The file is read only. 1223 1224What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8 1225Date: June 2020 1226Contact: Asutosh Das <asutoshd@codeaurora.org> 1227Description: Flush WriteBooster Buffer during hibernate state. 1228 1229 == ================================================= 1230 0 Device is not allowed to flush the 1231 WriteBooster Buffer during link hibernate state. 1232 1 Device is allowed to flush the 1233 WriteBooster Buffer during link hibernate state. 1234 == ================================================= 1235 1236 The file is read only. 1237 1238What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf 1239Date: June 2020 1240Contact: Asutosh Das <asutoshd@codeaurora.org> 1241Description: This entry shows the amount of unused WriteBooster buffer 1242 available. 1243 1244 The file is read only. 1245 1246What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf 1247Date: June 2020 1248Contact: Asutosh Das <asutoshd@codeaurora.org> 1249Description: This entry shows the amount of unused current buffer. 1250 1251 The file is read only. 1252 1253What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status 1254Date: June 2020 1255Contact: Asutosh Das <asutoshd@codeaurora.org> 1256Description: This entry shows the flush operation status. 1257 1258 1259 === ====================================== 1260 00h idle 1261 01h Flush operation in progress 1262 02h Flush operation stopped prematurely. 1263 03h Flush operation completed successfully 1264 04h Flush operation general failure 1265 === ====================================== 1266 1267 The file is read only. 1268 1269What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est 1270Date: June 2020 1271Contact: Asutosh Das <asutoshd@codeaurora.org> 1272Description: This entry shows an indication of the WriteBooster Buffer 1273 lifetime based on the amount of performed program/erase cycles 1274 1275 === ============================================= 1276 01h 0% - 10% WriteBooster Buffer life time used 1277 ... 1278 0Ah 90% - 100% WriteBooster Buffer life time used 1279 === ============================================= 1280 1281 The file is read only. 1282 1283What: /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units 1284Date: June 2020 1285Contact: Asutosh Das <asutoshd@codeaurora.org> 1286Description: This entry shows the configured size of WriteBooster buffer. 1287 0400h corresponds to 4GB. 1288 1289 The file is read only. 1290 1291What: /sys/bus/platform/drivers/ufshcd/*/wb_on 1292Date: January 2021 1293Contact: Bean Huo <beanhuo@micron.com> 1294Description: This node is used to set or display whether UFS WriteBooster is 1295 enabled. Echo 0 to this file to disable UFS WriteBooster or 1 to 1296 enable it. The WriteBooster is enabled after power-on/reset, 1297 however, it will be disabled/enable while CLK scaling down/up 1298 (if the platform supports UFSHCD_CAP_CLK_SCALING). For a 1299 platform that doesn't support UFSHCD_CAP_CLK_SCALING, we can 1300 disable/enable WriteBooster through this sysfs node. 1301 1302What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_version 1303Date: June 2021 1304Contact: Daejun Park <daejun7.park@samsung.com> 1305Description: This entry shows the HPB specification version. 1306 The full information about the descriptor can be found in the UFS 1307 HPB (Host Performance Booster) Extension specifications. 1308 Example: version 1.2.3 = 0123h 1309 1310 The file is read only. 1311 1312What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_control 1313Date: June 2021 1314Contact: Daejun Park <daejun7.park@samsung.com> 1315Description: This entry shows an indication of the HPB control mode. 1316 00h: Host control mode 1317 01h: Device control mode 1318 1319 The file is read only. 1320 1321What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_region_size 1322Date: June 2021 1323Contact: Daejun Park <daejun7.park@samsung.com> 1324Description: This entry shows the bHPBRegionSize which can be calculated 1325 as in the following (in bytes): 1326 HPB Region size = 512B * 2^bHPBRegionSize 1327 1328 The file is read only. 1329 1330What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_number_lu 1331Date: June 2021 1332Contact: Daejun Park <daejun7.park@samsung.com> 1333Description: This entry shows the maximum number of HPB LU supported by 1334 the device. 1335 00h: HPB is not supported by the device. 1336 01h ~ 20h: Maximum number of HPB LU supported by the device 1337 1338 The file is read only. 1339 1340What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_subregion_size 1341Date: June 2021 1342Contact: Daejun Park <daejun7.park@samsung.com> 1343Description: This entry shows the bHPBSubRegionSize, which can be 1344 calculated as in the following (in bytes) and shall be a multiple of 1345 logical block size: 1346 HPB Sub-Region size = 512B x 2^bHPBSubRegionSize 1347 bHPBSubRegionSize shall not exceed bHPBRegionSize. 1348 1349 The file is read only. 1350 1351What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_max_active_regions 1352Date: June 2021 1353Contact: Daejun Park <daejun7.park@samsung.com> 1354Description: This entry shows the maximum number of active HPB regions that 1355 is supported by the device. 1356 1357 The file is read only. 1358 1359What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_lu_max_active_regions 1360Date: June 2021 1361Contact: Daejun Park <daejun7.park@samsung.com> 1362Description: This entry shows the maximum number of HPB regions assigned to 1363 the HPB logical unit. 1364 1365 The file is read only. 1366 1367What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_pinned_region_start_offset 1368Date: June 2021 1369Contact: Daejun Park <daejun7.park@samsung.com> 1370Description: This entry shows the start offset of HPB pinned region. 1371 1372 The file is read only. 1373 1374What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_number_pinned_regions 1375Date: June 2021 1376Contact: Daejun Park <daejun7.park@samsung.com> 1377Description: This entry shows the number of HPB pinned regions assigned to 1378 the HPB logical unit. 1379 1380 The file is read only. 1381 1382What: /sys/class/scsi_device/*/device/hpb_stats/hit_cnt 1383Date: June 2021 1384Contact: Daejun Park <daejun7.park@samsung.com> 1385Description: This entry shows the number of reads that changed to HPB read. 1386 1387 The file is read only. 1388 1389What: /sys/class/scsi_device/*/device/hpb_stats/miss_cnt 1390Date: June 2021 1391Contact: Daejun Park <daejun7.park@samsung.com> 1392Description: This entry shows the number of reads that cannot be changed to 1393 HPB read. 1394 1395 The file is read only. 1396 1397What: /sys/class/scsi_device/*/device/hpb_stats/rb_noti_cnt 1398Date: June 2021 1399Contact: Daejun Park <daejun7.park@samsung.com> 1400Description: This entry shows the number of response UPIUs that has 1401 recommendations for activating sub-regions and/or inactivating region. 1402 1403 The file is read only. 1404 1405What: /sys/class/scsi_device/*/device/hpb_stats/rb_active_cnt 1406Date: June 2021 1407Contact: Daejun Park <daejun7.park@samsung.com> 1408Description: This entry shows the number of active sub-regions recommended by 1409 response UPIUs. 1410 1411 The file is read only. 1412 1413What: /sys/class/scsi_device/*/device/hpb_stats/rb_inactive_cnt 1414Date: June 2021 1415Contact: Daejun Park <daejun7.park@samsung.com> 1416Description: This entry shows the number of inactive regions recommended by 1417 response UPIUs. 1418 1419 The file is read only. 1420 1421What: /sys/class/scsi_device/*/device/hpb_stats/map_req_cnt 1422Date: June 2021 1423Contact: Daejun Park <daejun7.park@samsung.com> 1424Description: This entry shows the number of read buffer commands for 1425 activating sub-regions recommended by response UPIUs. 1426 1427 The file is read only. 1428 1429What: /sys/class/scsi_device/*/device/hpb_params/requeue_timeout_ms 1430Date: June 2021 1431Contact: Daejun Park <daejun7.park@samsung.com> 1432Description: This entry shows the requeue timeout threshold for write buffer 1433 command in ms. The value can be changed by writing an integer to 1434 this entry. 1435 1436What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_size_hpb_single_cmd 1437Date: June 2021 1438Contact: Daejun Park <daejun7.park@samsung.com> 1439Description: This entry shows the maximum HPB data size for using a single HPB 1440 command. 1441 1442 === ======== 1443 00h 4KB 1444 01h 8KB 1445 02h 12KB 1446 ... 1447 FFh 1024KB 1448 === ======== 1449 1450 The file is read only. 1451 1452What: /sys/bus/platform/drivers/ufshcd/*/flags/hpb_enable 1453Date: June 2021 1454Contact: Daejun Park <daejun7.park@samsung.com> 1455Description: This entry shows the status of HPB. 1456 1457 == ============================ 1458 0 HPB is not enabled. 1459 1 HPB is enabled 1460 == ============================ 1461 1462 The file is read only. 1463 1464What: /sys/class/scsi_device/*/device/hpb_param_sysfs/activation_thld 1465Date: February 2021 1466Contact: Avri Altman <avri.altman@wdc.com> 1467Description: In host control mode, reads are the major source of activation 1468 trials. Once this threshold hs met, the region is added to the 1469 "to-be-activated" list. Since we reset the read counter upon 1470 write, this include sending a rb command updating the region 1471 ppn as well. 1472 1473What: /sys/class/scsi_device/*/device/hpb_param_sysfs/normalization_factor 1474Date: February 2021 1475Contact: Avri Altman <avri.altman@wdc.com> 1476Description: In host control mode, we think of the regions as "buckets". 1477 Those buckets are being filled with reads, and emptied on write. 1478 We use entries_per_srgn - the amount of blocks in a subregion as 1479 our bucket size. This applies because HPB1.0 only handles 1480 single-block reads. Once the bucket size is crossed, we trigger 1481 a normalization work - not only to avoid overflow, but mainly 1482 because we want to keep those counters normalized, as we are 1483 using those reads as a comparative score, to make various decisions. 1484 The normalization is dividing (shift right) the read counter by 1485 the normalization_factor. If during consecutive normalizations 1486 an active region has exhausted its reads - inactivate it. 1487 1488What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_enter 1489Date: February 2021 1490Contact: Avri Altman <avri.altman@wdc.com> 1491Description: Region deactivation is often due to the fact that eviction took 1492 place: A region becomes active at the expense of another. This is 1493 happening when the max-active-regions limit has been crossed. 1494 In host mode, eviction is considered an extreme measure. We 1495 want to verify that the entering region has enough reads, and 1496 the exiting region has much fewer reads. eviction_thld_enter is 1497 the min reads that a region must have in order to be considered 1498 a candidate for evicting another region. 1499 1500What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_exit 1501Date: February 2021 1502Contact: Avri Altman <avri.altman@wdc.com> 1503Description: Same as above for the exiting region. A region is considered to 1504 be a candidate for eviction only if it has fewer reads than 1505 eviction_thld_exit. 1506 1507What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_ms 1508Date: February 2021 1509Contact: Avri Altman <avri.altman@wdc.com> 1510Description: In order not to hang on to "cold" regions, we inactivate 1511 a region that has no READ access for a predefined amount of 1512 time - read_timeout_ms. If read_timeout_ms has expired, and the 1513 region is dirty, it is less likely that we can make any use of 1514 HPB reading it so we inactivate it. Still, deactivation has 1515 its overhead, and we may still benefit from HPB reading this 1516 region if it is clean - see read_timeout_expiries. 1517 1518What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_expiries 1519Date: February 2021 1520Contact: Avri Altman <avri.altman@wdc.com> 1521Description: If the region read timeout has expired, but the region is clean, 1522 just re-wind its timer for another spin. Do that as long as it 1523 is clean and did not exhaust its read_timeout_expiries threshold. 1524 1525What: /sys/class/scsi_device/*/device/hpb_param_sysfs/timeout_polling_interval_ms 1526Date: February 2021 1527Contact: Avri Altman <avri.altman@wdc.com> 1528Description: The frequency with which the delayed worker that checks the 1529 read_timeouts is awakened. 1530 1531What: /sys/class/scsi_device/*/device/hpb_param_sysfs/inflight_map_req 1532Date: February 2021 1533Contact: Avri Altman <avri.altman@wdc.com> 1534Description: In host control mode the host is the originator of map requests. 1535 To avoid flooding the device with map requests, use a simple throttling 1536 mechanism that limits the number of inflight map requests. 1537