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 manufacturee 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 manufactureer 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 accepted 937 == ==================================================== 938 939What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state 940Date: February 2018 941Contact: Subhash Jadavani <subhashj@codeaurora.org> 942Description: This entry shows the target power mode of an UFS device 943 for the chosen runtime power management level. 944 945 The file is read only. 946 947What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state 948Date: February 2018 949Contact: Subhash Jadavani <subhashj@codeaurora.org> 950Description: This entry shows the target state of an UFS UIC link 951 for the chosen runtime power management level. 952 953 The file is read only. 954 955What: /sys/bus/platform/drivers/ufshcd/*/spm_lvl 956Date: September 2014 957Contact: Subhash Jadavani <subhashj@codeaurora.org> 958Description: This entry could be used to set or show the UFS device 959 system power management level. The current driver 960 implementation supports 7 levels with next target states: 961 962 == ==================================================== 963 0 UFS device will stay active, UIC link will 964 stay active 965 1 UFS device will stay active, UIC link will 966 hibernate 967 2 UFS device will be moved to sleep, UIC link will 968 stay active 969 3 UFS device will be moved to sleep, UIC link will 970 hibernate 971 4 UFS device will be powered off, UIC link will 972 hibernate 973 5 UFS device will be powered off, UIC link will 974 be powered off 975 6 UFS device will be moved to deep sleep, UIC link 976 will be powered off. Note, deep sleep might not be 977 supported in which case this value will not be accepted 978 == ==================================================== 979 980What: /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state 981Date: February 2018 982Contact: Subhash Jadavani <subhashj@codeaurora.org> 983Description: This entry shows the target power mode of an UFS device 984 for the chosen system power management level. 985 986 The file is read only. 987 988What: /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state 989Date: February 2018 990Contact: Subhash Jadavani <subhashj@codeaurora.org> 991Description: This entry shows the target state of an UFS UIC link 992 for the chosen system power management level. 993 994 The file is read only. 995 996What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable 997Date: January 2021 998Contact: Can Guo <cang@codeaurora.org> 999Description: This file shows the status of performance monitor enablement 1000 and it can be used to start/stop the monitor. When the monitor 1001 is stopped, the performance data collected is also cleared. 1002 1003What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size 1004Date: January 2021 1005Contact: Can Guo <cang@codeaurora.org> 1006Description: This file tells the monitor to focus on requests transferring 1007 data of specific chunk size (in Bytes). 0 means any chunk size. 1008 It can only be changed when monitor is disabled. 1009 1010What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors 1011Date: January 2021 1012Contact: Can Guo <cang@codeaurora.org> 1013Description: This file shows how many sectors (in 512 Bytes) have been 1014 sent from device to host after monitor gets started. 1015 1016 The file is read only. 1017 1018What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy 1019Date: January 2021 1020Contact: Can Guo <cang@codeaurora.org> 1021Description: This file shows how long (in micro seconds) has been spent 1022 sending data from device to host after monitor gets started. 1023 1024 The file is read only. 1025 1026What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests 1027Date: January 2021 1028Contact: Can Guo <cang@codeaurora.org> 1029Description: This file shows how many read requests have been sent after 1030 monitor gets started. 1031 1032 The file is read only. 1033 1034What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max 1035Date: January 2021 1036Contact: Can Guo <cang@codeaurora.org> 1037Description: This file shows the maximum latency (in micro seconds) of 1038 read requests after monitor gets started. 1039 1040 The file is read only. 1041 1042What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min 1043Date: January 2021 1044Contact: Can Guo <cang@codeaurora.org> 1045Description: This file shows the minimum latency (in micro seconds) of 1046 read requests after monitor gets started. 1047 1048 The file is read only. 1049 1050What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg 1051Date: January 2021 1052Contact: Can Guo <cang@codeaurora.org> 1053Description: This file shows the average latency (in micro seconds) of 1054 read requests after monitor gets started. 1055 1056 The file is read only. 1057 1058What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum 1059Date: January 2021 1060Contact: Can Guo <cang@codeaurora.org> 1061Description: This file shows the total latency (in micro seconds) of 1062 read requests sent after monitor gets started. 1063 1064 The file is read only. 1065 1066What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors 1067Date: January 2021 1068Contact: Can Guo <cang@codeaurora.org> 1069Description: This file shows how many sectors (in 512 Bytes) have been sent 1070 from host to device after monitor gets started. 1071 1072 The file is read only. 1073 1074What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy 1075Date: January 2021 1076Contact: Can Guo <cang@codeaurora.org> 1077Description: This file shows how long (in micro seconds) has been spent 1078 sending data from host to device after monitor gets started. 1079 1080 The file is read only. 1081 1082What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests 1083Date: January 2021 1084Contact: Can Guo <cang@codeaurora.org> 1085Description: This file shows how many write requests have been sent after 1086 monitor gets started. 1087 1088 The file is read only. 1089 1090What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max 1091Date: January 2021 1092Contact: Can Guo <cang@codeaurora.org> 1093Description: This file shows the maximum latency (in micro seconds) of write 1094 requests after monitor gets started. 1095 1096 The file is read only. 1097 1098What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min 1099Date: January 2021 1100Contact: Can Guo <cang@codeaurora.org> 1101Description: This file shows the minimum latency (in micro seconds) of write 1102 requests after monitor gets started. 1103 1104 The file is read only. 1105 1106What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg 1107Date: January 2021 1108Contact: Can Guo <cang@codeaurora.org> 1109Description: This file shows the average latency (in micro seconds) of write 1110 requests after monitor gets started. 1111 1112 The file is read only. 1113 1114What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum 1115Date: January 2021 1116Contact: Can Guo <cang@codeaurora.org> 1117Description: This file shows the total latency (in micro seconds) of write 1118 requests after monitor gets started. 1119 1120 The file is read only. 1121 1122What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en 1123Date: June 2020 1124Contact: Asutosh Das <asutoshd@codeaurora.org> 1125Description: This entry shows if preserve user-space was configured 1126 1127 The file is read only. 1128 1129What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units 1130Date: June 2020 1131Contact: Asutosh Das <asutoshd@codeaurora.org> 1132Description: This entry shows the shared allocated units of WB buffer 1133 1134 The file is read only. 1135 1136What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type 1137Date: June 2020 1138Contact: Asutosh Das <asutoshd@codeaurora.org> 1139Description: This entry shows the configured WB type. 1140 0x1 for shared buffer mode. 0x0 for dedicated buffer mode. 1141 1142 The file is read only. 1143 1144What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj 1145Date: June 2020 1146Contact: Asutosh Das <asutoshd@codeaurora.org> 1147Description: This entry shows the total user-space decrease in shared 1148 buffer mode. 1149 The value of this parameter is 3 for TLC NAND when SLC mode 1150 is used as WriteBooster Buffer. 2 for MLC NAND. 1151 1152 The file is read only. 1153 1154What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units 1155Date: June 2020 1156Contact: Asutosh Das <asutoshd@codeaurora.org> 1157Description: This entry shows the Maximum total WriteBooster Buffer size 1158 which is supported by the entire device. 1159 1160 The file is read only. 1161 1162What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns 1163Date: June 2020 1164Contact: Asutosh Das <asutoshd@codeaurora.org> 1165Description: This entry shows the maximum number of luns that can support 1166 WriteBooster. 1167 1168 The file is read only. 1169 1170What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type 1171Date: June 2020 1172Contact: Asutosh Das <asutoshd@codeaurora.org> 1173Description: The supportability of user space reduction mode 1174 and preserve user space mode. 1175 00h: WriteBooster Buffer can be configured only in 1176 user space reduction type. 1177 01h: WriteBooster Buffer can be configured only in 1178 preserve user space type. 1179 02h: Device can be configured in either user space 1180 reduction type or preserve user space type. 1181 1182 The file is read only. 1183 1184What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type 1185Date: June 2020 1186Contact: Asutosh Das <asutoshd@codeaurora.org> 1187Description: The supportability of WriteBooster Buffer type. 1188 1189 === ========================================================== 1190 00h LU based WriteBooster Buffer configuration 1191 01h Single shared WriteBooster Buffer configuration 1192 02h Supporting both LU based WriteBooster. 1193 Buffer and Single shared WriteBooster Buffer configuration 1194 === ========================================================== 1195 1196 The file is read only. 1197 1198What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable 1199Date: June 2020 1200Contact: Asutosh Das <asutoshd@codeaurora.org> 1201Description: This entry shows the status of WriteBooster. 1202 1203 == ============================ 1204 0 WriteBooster is not enabled. 1205 1 WriteBooster is enabled 1206 == ============================ 1207 1208 The file is read only. 1209 1210What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en 1211Date: June 2020 1212Contact: Asutosh Das <asutoshd@codeaurora.org> 1213Description: This entry shows if flush is enabled. 1214 1215 == ================================= 1216 0 Flush operation is not performed. 1217 1 Flush operation is performed. 1218 == ================================= 1219 1220 The file is read only. 1221 1222What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8 1223Date: June 2020 1224Contact: Asutosh Das <asutoshd@codeaurora.org> 1225Description: Flush WriteBooster Buffer during hibernate state. 1226 1227 == ================================================= 1228 0 Device is not allowed to flush the 1229 WriteBooster Buffer during link hibernate state. 1230 1 Device is allowed to flush the 1231 WriteBooster Buffer during link hibernate state. 1232 == ================================================= 1233 1234 The file is read only. 1235 1236What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf 1237Date: June 2020 1238Contact: Asutosh Das <asutoshd@codeaurora.org> 1239Description: This entry shows the amount of unused WriteBooster buffer 1240 available. 1241 1242 The file is read only. 1243 1244What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf 1245Date: June 2020 1246Contact: Asutosh Das <asutoshd@codeaurora.org> 1247Description: This entry shows the amount of unused current buffer. 1248 1249 The file is read only. 1250 1251What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status 1252Date: June 2020 1253Contact: Asutosh Das <asutoshd@codeaurora.org> 1254Description: This entry shows the flush operation status. 1255 1256 1257 === ====================================== 1258 00h idle 1259 01h Flush operation in progress 1260 02h Flush operation stopped prematurely. 1261 03h Flush operation completed successfully 1262 04h Flush operation general failure 1263 === ====================================== 1264 1265 The file is read only. 1266 1267What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est 1268Date: June 2020 1269Contact: Asutosh Das <asutoshd@codeaurora.org> 1270Description: This entry shows an indication of the WriteBooster Buffer 1271 lifetime based on the amount of performed program/erase cycles 1272 1273 === ============================================= 1274 01h 0% - 10% WriteBooster Buffer life time used 1275 ... 1276 0Ah 90% - 100% WriteBooster Buffer life time used 1277 === ============================================= 1278 1279 The file is read only. 1280 1281What: /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units 1282Date: June 2020 1283Contact: Asutosh Das <asutoshd@codeaurora.org> 1284Description: This entry shows the configured size of WriteBooster buffer. 1285 0400h corresponds to 4GB. 1286 1287 The file is read only. 1288 1289What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_version 1290Date: June 2021 1291Contact: Daejun Park <daejun7.park@samsung.com> 1292Description: This entry shows the HPB specification version. 1293 The full information about the descriptor could be found at UFS 1294 HPB (Host Performance Booster) Extension specifications. 1295 Example: version 1.2.3 = 0123h 1296 1297 The file is read only. 1298 1299What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_control 1300Date: June 2021 1301Contact: Daejun Park <daejun7.park@samsung.com> 1302Description: This entry shows an indication of the HPB control mode. 1303 00h: Host control mode 1304 01h: Device control mode 1305 1306 The file is read only. 1307 1308What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_region_size 1309Date: June 2021 1310Contact: Daejun Park <daejun7.park@samsung.com> 1311Description: This entry shows the bHPBRegionSize which can be calculated 1312 as in the following (in bytes): 1313 HPB Region size = 512B * 2^bHPBRegionSize 1314 1315 The file is read only. 1316 1317What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_number_lu 1318Date: June 2021 1319Contact: Daejun Park <daejun7.park@samsung.com> 1320Description: This entry shows the maximum number of HPB LU supported by 1321 the device. 1322 00h: HPB is not supported by the device. 1323 01h ~ 20h: Maximum number of HPB LU supported by the device 1324 1325 The file is read only. 1326 1327What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_subregion_size 1328Date: June 2021 1329Contact: Daejun Park <daejun7.park@samsung.com> 1330Description: This entry shows the bHPBSubRegionSize, which can be 1331 calculated as in the following (in bytes) and shall be a multiple of 1332 logical block size: 1333 HPB Sub-Region size = 512B x 2^bHPBSubRegionSize 1334 bHPBSubRegionSize shall not exceed bHPBRegionSize. 1335 1336 The file is read only. 1337 1338What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_max_active_regions 1339Date: June 2021 1340Contact: Daejun Park <daejun7.park@samsung.com> 1341Description: This entry shows the maximum number of active HPB regions that 1342 is supported by the device. 1343 1344 The file is read only. 1345 1346What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_lu_max_active_regions 1347Date: June 2021 1348Contact: Daejun Park <daejun7.park@samsung.com> 1349Description: This entry shows the maximum number of HPB regions assigned to 1350 the HPB logical unit. 1351 1352 The file is read only. 1353 1354What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_pinned_region_start_offset 1355Date: June 2021 1356Contact: Daejun Park <daejun7.park@samsung.com> 1357Description: This entry shows the start offset of HPB pinned region. 1358 1359 The file is read only. 1360 1361What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_number_pinned_regions 1362Date: June 2021 1363Contact: Daejun Park <daejun7.park@samsung.com> 1364Description: This entry shows the number of HPB pinned regions assigned to 1365 the HPB logical unit. 1366 1367 The file is read only. 1368 1369What: /sys/class/scsi_device/*/device/hpb_stats/hit_cnt 1370Date: June 2021 1371Contact: Daejun Park <daejun7.park@samsung.com> 1372Description: This entry shows the number of reads that changed to HPB read. 1373 1374 The file is read only. 1375 1376What: /sys/class/scsi_device/*/device/hpb_stats/miss_cnt 1377Date: June 2021 1378Contact: Daejun Park <daejun7.park@samsung.com> 1379Description: This entry shows the number of reads that cannot be changed to 1380 HPB read. 1381 1382 The file is read only. 1383 1384What: /sys/class/scsi_device/*/device/hpb_stats/rb_noti_cnt 1385Date: June 2021 1386Contact: Daejun Park <daejun7.park@samsung.com> 1387Description: This entry shows the number of response UPIUs that has 1388 recommendations for activating sub-regions and/or inactivating region. 1389 1390 The file is read only. 1391 1392What: /sys/class/scsi_device/*/device/hpb_stats/rb_active_cnt 1393Date: June 2021 1394Contact: Daejun Park <daejun7.park@samsung.com> 1395Description: This entry shows the number of active sub-regions recommended by 1396 response UPIUs. 1397 1398 The file is read only. 1399 1400What: /sys/class/scsi_device/*/device/hpb_stats/rb_inactive_cnt 1401Date: June 2021 1402Contact: Daejun Park <daejun7.park@samsung.com> 1403Description: This entry shows the number of inactive regions recommended by 1404 response UPIUs. 1405 1406 The file is read only. 1407 1408What: /sys/class/scsi_device/*/device/hpb_stats/map_req_cnt 1409Date: June 2021 1410Contact: Daejun Park <daejun7.park@samsung.com> 1411Description: This entry shows the number of read buffer commands for 1412 activating sub-regions recommended by response UPIUs. 1413 1414 The file is read only. 1415 1416What: /sys/class/scsi_device/*/device/hpb_params/requeue_timeout_ms 1417Date: June 2021 1418Contact: Daejun Park <daejun7.park@samsung.com> 1419Description: This entry shows the requeue timeout threshold for write buffer 1420 command in ms. This value can be changed by writing proper integer to 1421 this entry. 1422 1423What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_size_hpb_single_cmd 1424Date: June 2021 1425Contact: Daejun Park <daejun7.park@samsung.com> 1426Description: This entry shows the maximum HPB data size for using single HPB 1427 command. 1428 1429 === ======== 1430 00h 4KB 1431 01h 8KB 1432 02h 12KB 1433 ... 1434 FFh 1024KB 1435 === ======== 1436 1437 The file is read only. 1438 1439What: /sys/bus/platform/drivers/ufshcd/*/flags/hpb_enable 1440Date: June 2021 1441Contact: Daejun Park <daejun7.park@samsung.com> 1442Description: This entry shows the status of HPB. 1443 1444 == ============================ 1445 0 HPB is not enabled. 1446 1 HPB is enabled 1447 == ============================ 1448 1449 The file is read only. 1450 1451What: /sys/class/scsi_device/*/device/hpb_param_sysfs/activation_thld 1452Date: February 2021 1453Contact: Avri Altman <avri.altman@wdc.com> 1454Description: In host control mode, reads are the major source of activation 1455 trials. once this threshold hs met, the region is added to the 1456 "to-be-activated" list. Since we reset the read counter upon 1457 write, this include sending a rb command updating the region 1458 ppn as well. 1459 1460What: /sys/class/scsi_device/*/device/hpb_param_sysfs/normalization_factor 1461Date: February 2021 1462Contact: Avri Altman <avri.altman@wdc.com> 1463Description: In host control mode, We think of the regions as "buckets". 1464 Those buckets are being filled with reads, and emptied on write. 1465 We use entries_per_srgn - the amount of blocks in a subregion as 1466 our bucket size. This applies because HPB1.0 only concern a 1467 single-block reads. Once the bucket size is crossed, we trigger 1468 a normalization work - not only to avoid overflow, but mainly 1469 because we want to keep those counters normalized, as we are 1470 using those reads as a comparative score, to make various decisions. 1471 The normalization is dividing (shift right) the read counter by 1472 the normalization_factor. If during consecutive normalizations 1473 an active region has exhaust its reads - inactivate it. 1474 1475What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_enter 1476Date: February 2021 1477Contact: Avri Altman <avri.altman@wdc.com> 1478Description: Region deactivation is often due to the fact that eviction took 1479 place: a region become active on the expense of another. This is 1480 happening when the max-active-regions limit has crossed. 1481 In host mode, eviction is considered an extreme measure. We 1482 want to verify that the entering region has enough reads, and 1483 the exiting region has much less reads. eviction_thld_enter is 1484 the min reads that a region must have in order to be considered 1485 as a candidate to evict other region. 1486 1487What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_exit 1488Date: February 2021 1489Contact: Avri Altman <avri.altman@wdc.com> 1490Description: same as above for the exiting region. A region is consider to 1491 be a candidate to be evicted, only if it has less reads than 1492 eviction_thld_exit. 1493 1494What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_ms 1495Date: February 2021 1496Contact: Avri Altman <avri.altman@wdc.com> 1497Description: In order not to hang on to “cold” regions, we shall inactivate 1498 a region that has no READ access for a predefined amount of 1499 time - read_timeout_ms. If read_timeout_ms has expired, and the 1500 region is dirty - it is less likely that we can make any use of 1501 HPB-READing it. So we inactivate it. Still, deactivation has 1502 its overhead, and we may still benefit from HPB-READing this 1503 region if it is clean - see read_timeout_expiries. 1504 1505What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_expiries 1506Date: February 2021 1507Contact: Avri Altman <avri.altman@wdc.com> 1508Description: if the region read timeout has expired, but the region is clean, 1509 just re-wind its timer for another spin. Do that as long as it 1510 is clean and did not exhaust its read_timeout_expiries threshold. 1511 1512What: /sys/class/scsi_device/*/device/hpb_param_sysfs/timeout_polling_interval_ms 1513Date: February 2021 1514Contact: Avri Altman <avri.altman@wdc.com> 1515Description: the frequency in which the delayed worker that checks the 1516 read_timeouts is awaken. 1517 1518What: /sys/class/scsi_device/*/device/hpb_param_sysfs/inflight_map_req 1519Date: February 2021 1520Contact: Avri Altman <avri.altman@wdc.com> 1521Description: in host control mode the host is the originator of map requests. 1522 To not flood the device with map requests, use a simple throttling 1523 mechanism that limits the number of inflight map requests. 1524