hc
2023-12-11 d2ccde1c8e90d38cee87a1b0309ad2827f3fd30d
kernel/Documentation/ABI/testing/sysfs-driver-ufs
....@@ -18,6 +18,7 @@
1818 Description: This file shows the device type. This is one of the UFS
1919 device descriptor parameters. The full information about
2020 the descriptor could be found at UFS specifications 2.1.
21
+
2122 The file is read only.
2223
2324 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class
....@@ -26,6 +27,7 @@
2627 Description: This file shows the device class. This is one of the UFS
2728 device descriptor parameters. The full information about
2829 the descriptor could be found at UFS specifications 2.1.
30
+
2931 The file is read only.
3032
3133 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class
....@@ -34,6 +36,7 @@
3436 Description: This file shows the UFS storage subclass. This is one of
3537 the UFS device descriptor parameters. The full information
3638 about the descriptor could be found at UFS specifications 2.1.
39
+
3740 The file is read only.
3841
3942 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol
....@@ -43,6 +46,7 @@
4346 This is one of the UFS device descriptor parameters.
4447 The full information about the descriptor could be found
4548 at UFS specifications 2.1.
49
+
4650 The file is read only.
4751
4852 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns
....@@ -51,6 +55,7 @@
5155 Description: This file shows number of logical units. This is one of
5256 the UFS device descriptor parameters. The full information
5357 about the descriptor could be found at UFS specifications 2.1.
58
+
5459 The file is read only.
5560
5661 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns
....@@ -60,6 +65,7 @@
6065 This is one of the UFS device descriptor parameters.
6166 The full information about the descriptor could be found
6267 at UFS specifications 2.1.
68
+
6369 The file is read only.
6470
6571 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable
....@@ -69,6 +75,7 @@
6975 enabled for boot. This is one of the UFS device descriptor
7076 parameters. The full information about the descriptor could
7177 be found at UFS specifications 2.1.
78
+
7279 The file is read only.
7380
7481 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable
....@@ -79,6 +86,7 @@
7986 of the boot sequence. This is one of the UFS device descriptor
8087 parameters. The full information about the descriptor could
8188 be found at UFS specifications 2.1.
89
+
8290 The file is read only.
8391
8492 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode
....@@ -88,6 +96,7 @@
8896 device initialization or hardware reset. This is one of
8997 the UFS device descriptor parameters. The full information
9098 about the descriptor could be found at UFS specifications 2.1.
99
+
91100 The file is read only.
92101
93102 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/high_priority_lun
....@@ -96,6 +105,7 @@
96105 Description: This file shows the high priority lun. This is one of
97106 the UFS device descriptor parameters. The full information
98107 about the descriptor could be found at UFS specifications 2.1.
108
+
99109 The file is read only.
100110
101111 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type
....@@ -104,6 +114,7 @@
104114 Description: This file shows the secure removal type. This is one of
105115 the UFS device descriptor parameters. The full information
106116 about the descriptor could be found at UFS specifications 2.1.
117
+
107118 The file is read only.
108119
109120 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun
....@@ -113,6 +124,7 @@
113124 This is one of the UFS device descriptor parameters.
114125 The full information about the descriptor could be found
115126 at UFS specifications 2.1.
127
+
116128 The file is read only.
117129
118130 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency
....@@ -122,6 +134,7 @@
122134 latency. This is one of the UFS device descriptor parameters.
123135 The full information about the descriptor could be found
124136 at UFS specifications 2.1.
137
+
125138 The file is read only.
126139
127140 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level
....@@ -130,6 +143,7 @@
130143 Description: This file shows the initial active ICC level. This is one
131144 of the UFS device descriptor parameters. The full information
132145 about the descriptor could be found at UFS specifications 2.1.
146
+
133147 The file is read only.
134148
135149 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version
....@@ -138,6 +152,7 @@
138152 Description: This file shows the specification version. This is one
139153 of the UFS device descriptor parameters. The full information
140154 about the descriptor could be found at UFS specifications 2.1.
155
+
141156 The file is read only.
142157
143158 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date
....@@ -147,6 +162,7 @@
147162 This is one of the UFS device descriptor parameters.
148163 The full information about the descriptor could be found
149164 at UFS specifications 2.1.
165
+
150166 The file is read only.
151167
152168 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id
....@@ -155,6 +171,7 @@
155171 Description: This file shows the manufacturee ID. This is one of the
156172 UFS device descriptor parameters. The full information about
157173 the descriptor could be found at UFS specifications 2.1.
174
+
158175 The file is read only.
159176
160177 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability
....@@ -164,6 +181,7 @@
164181 supported by the device. This is one of the UFS device
165182 descriptor parameters. The full information about
166183 the descriptor could be found at UFS specifications 2.1.
184
+
167185 The file is read only.
168186
169187 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update
....@@ -173,6 +191,7 @@
173191 clock update. This is one of the UFS device descriptor
174192 parameters. The full information about the descriptor
175193 could be found at UFS specifications 2.1.
194
+
176195 The file is read only.
177196
178197 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features
....@@ -182,6 +201,7 @@
182201 This is one of the UFS device descriptor parameters.
183202 The full information about the descriptor could be
184203 found at UFS specifications 2.1.
204
+
185205 The file is read only.
186206
187207 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout
....@@ -190,6 +210,7 @@
190210 Description: This file shows the FFU timeout. This is one of the
191211 UFS device descriptor parameters. The full information
192212 about the descriptor could be found at UFS specifications 2.1.
213
+
193214 The file is read only.
194215
195216 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth
....@@ -198,6 +219,7 @@
198219 Description: This file shows the device queue depth. This is one of the
199220 UFS device descriptor parameters. The full information
200221 about the descriptor could be found at UFS specifications 2.1.
222
+
201223 The file is read only.
202224
203225 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version
....@@ -206,6 +228,7 @@
206228 Description: This file shows the device version. This is one of the
207229 UFS device descriptor parameters. The full information
208230 about the descriptor could be found at UFS specifications 2.1.
231
+
209232 The file is read only.
210233
211234 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa
....@@ -215,6 +238,7 @@
215238 supported by the device. This is one of the UFS device
216239 descriptor parameters. The full information about
217240 the descriptor could be found at UFS specifications 2.1.
241
+
218242 The file is read only.
219243
220244 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size
....@@ -225,6 +249,7 @@
225249 This is one of the UFS device descriptor parameters.
226250 The full information about the descriptor could be found
227251 at UFS specifications 2.1.
252
+
228253 The file is read only.
229254
230255 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout
....@@ -234,6 +259,7 @@
234259 in PSA state. This is one of the UFS device descriptor
235260 parameters. The full information about the descriptor could
236261 be found at UFS specifications 2.1.
262
+
237263 The file is read only.
238264
239265
....@@ -244,6 +270,7 @@
244270 This is one of the UFS interconnect descriptor parameters.
245271 The full information about the descriptor could be found at
246272 UFS specifications 2.1.
273
+
247274 The file is read only.
248275
249276 What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version
....@@ -253,6 +280,7 @@
253280 This is one of the UFS interconnect descriptor parameters.
254281 The full information about the descriptor could be found at
255282 UFS specifications 2.1.
283
+
256284 The file is read only.
257285
258286
....@@ -264,6 +292,7 @@
264292 of the UFS geometry descriptor parameters. The full
265293 information about the descriptor could be found at
266294 UFS specifications 2.1.
295
+
267296 The file is read only.
268297
269298 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns
....@@ -273,6 +302,7 @@
273302 supported by the UFS device. This is one of the UFS
274303 geometry descriptor parameters. The full information about
275304 the descriptor could be found at UFS specifications 2.1.
305
+
276306 The file is read only.
277307
278308 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size
....@@ -281,6 +311,7 @@
281311 Description: This file shows the segment size. This is one of the UFS
282312 geometry descriptor parameters. The full information about
283313 the descriptor could be found at UFS specifications 2.1.
314
+
284315 The file is read only.
285316
286317 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size
....@@ -289,6 +320,7 @@
289320 Description: This file shows the allocation unit size. This is one of
290321 the UFS geometry descriptor parameters. The full information
291322 about the descriptor could be found at UFS specifications 2.1.
323
+
292324 The file is read only.
293325
294326 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size
....@@ -298,6 +330,7 @@
298330 is one of the UFS geometry descriptor parameters. The full
299331 information about the descriptor could be found at UFS
300332 specifications 2.1.
333
+
301334 The file is read only.
302335
303336 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size
....@@ -307,6 +340,7 @@
307340 of the UFS geometry descriptor parameters. The full
308341 information about the descriptor could be found at UFS
309342 specifications 2.1.
343
+
310344 The file is read only.
311345
312346 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size
....@@ -316,6 +350,7 @@
316350 of the UFS geometry descriptor parameters. The full
317351 information about the descriptor could be found at UFS
318352 specifications 2.1.
353
+
319354 The file is read only.
320355
321356 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size
....@@ -325,6 +360,7 @@
325360 is one of the UFS geometry descriptor parameters. The full
326361 information about the descriptor could be found at UFS
327362 specifications 2.1.
363
+
328364 The file is read only.
329365
330366 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size
....@@ -334,6 +370,7 @@
334370 is one of the UFS geometry descriptor parameters. The full
335371 information about the descriptor could be found at UFS
336372 specifications 2.1.
373
+
337374 The file is read only.
338375
339376 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size
....@@ -343,6 +380,7 @@
343380 in Security Protocol In/Out. This is one of the UFS geometry
344381 descriptor parameters. The full information about the
345382 descriptor could be found at UFS specifications 2.1.
383
+
346384 The file is read only.
347385
348386 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy
....@@ -352,6 +390,7 @@
352390 is one of the UFS geometry descriptor parameters. The full
353391 information about the descriptor could be found at
354392 UFS specifications 2.1.
393
+
355394 The file is read only.
356395
357396 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering
....@@ -361,6 +400,7 @@
361400 This is one of the UFS geometry descriptor parameters.
362401 The full information about the descriptor could be found at
363402 UFS specifications 2.1.
403
+
364404 The file is read only.
365405
366406 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_contexts
....@@ -370,6 +410,7 @@
370410 are supported by the device. This is one of the UFS geometry
371411 descriptor parameters. The full information about the
372412 descriptor could be found at UFS specifications 2.1.
413
+
373414 The file is read only.
374415
375416 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size
....@@ -378,6 +419,7 @@
378419 Description: This file shows system data tag unit size. This is one of
379420 the UFS geometry descriptor parameters. The full information
380421 about the descriptor could be found at UFS specifications 2.1.
422
+
381423 The file is read only.
382424
383425 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size
....@@ -388,6 +430,7 @@
388430 This is one of the UFS geometry descriptor parameters.
389431 The full information about the descriptor could be found at
390432 UFS specifications 2.1.
433
+
391434 The file is read only.
392435
393436 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types
....@@ -397,6 +440,7 @@
397440 one of the UFS geometry descriptor parameters. The full
398441 information about the descriptor could be found at
399442 UFS specifications 2.1.
443
+
400444 The file is read only.
401445
402446 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types
....@@ -406,6 +450,7 @@
406450 the UFS geometry descriptor parameters. The full
407451 information about the descriptor could be found at
408452 UFS specifications 2.1.
453
+
409454 The file is read only.
410455
411456 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units
....@@ -416,6 +461,7 @@
416461 enhanced type 1-4). This is one of the UFS geometry
417462 descriptor parameters. The full information about the
418463 descriptor could be found at UFS specifications 2.1.
464
+
419465 The file is read only.
420466
421467 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor
....@@ -426,6 +472,7 @@
426472 enhanced type 1-4). This is one of the UFS geometry
427473 descriptor parameters. The full information about the
428474 descriptor could be found at UFS specifications 2.1.
475
+
429476 The file is read only.
430477
431478
....@@ -436,6 +483,7 @@
436483 of the UFS health descriptor parameters. The full
437484 information about the descriptor could be found at
438485 UFS specifications 2.1.
486
+
439487 The file is read only.
440488
441489 What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a
....@@ -445,6 +493,7 @@
445493 (method a). This is one of the UFS health descriptor
446494 parameters. The full information about the descriptor
447495 could be found at UFS specifications 2.1.
496
+
448497 The file is read only.
449498
450499 What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b
....@@ -454,6 +503,7 @@
454503 (method b). This is one of the UFS health descriptor
455504 parameters. The full information about the descriptor
456505 could be found at UFS specifications 2.1.
506
+
457507 The file is read only.
458508
459509
....@@ -464,6 +514,7 @@
464514 active ICC levels from 0 to 15. This is one of the UFS
465515 power descriptor parameters. The full information about
466516 the descriptor could be found at UFS specifications 2.1.
517
+
467518 The file is read only.
468519
469520
....@@ -473,6 +524,7 @@
473524 Description: This file contains a device manufactureer name string.
474525 The full information about the descriptor could be found at
475526 UFS specifications 2.1.
527
+
476528 The file is read only.
477529
478530 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name
....@@ -480,6 +532,7 @@
480532 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
481533 Description: This file contains a product name string. The full information
482534 about the descriptor could be found at UFS specifications 2.1.
535
+
483536 The file is read only.
484537
485538 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id
....@@ -487,6 +540,7 @@
487540 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
488541 Description: This file contains a OEM ID string. The full information
489542 about the descriptor could be found at UFS specifications 2.1.
543
+
490544 The file is read only.
491545
492546 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number
....@@ -495,6 +549,7 @@
495549 Description: This file contains a device serial number string. The full
496550 information about the descriptor could be found at
497551 UFS specifications 2.1.
552
+
498553 The file is read only.
499554
500555 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision
....@@ -503,6 +558,7 @@
503558 Description: This file contains a product revision string. The full
504559 information about the descriptor could be found at
505560 UFS specifications 2.1.
561
+
506562 The file is read only.
507563
508564
....@@ -512,6 +568,7 @@
512568 Description: This file shows boot LUN information. This is one of
513569 the UFS unit descriptor parameters. The full information
514570 about the descriptor could be found at UFS specifications 2.1.
571
+
515572 The file is read only.
516573
517574 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_write_protect
....@@ -520,6 +577,7 @@
520577 Description: This file shows LUN write protection status. This is one of
521578 the UFS unit descriptor parameters. The full information
522579 about the descriptor could be found at UFS specifications 2.1.
580
+
523581 The file is read only.
524582
525583 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_queue_depth
....@@ -528,6 +586,7 @@
528586 Description: This file shows LUN queue depth. This is one of the UFS
529587 unit descriptor parameters. The full information about
530588 the descriptor could be found at UFS specifications 2.1.
589
+
531590 The file is read only.
532591
533592 What: /sys/class/scsi_device/*/device/unit_descriptor/psa_sensitive
....@@ -536,6 +595,7 @@
536595 Description: This file shows PSA sensitivity. This is one of the UFS
537596 unit descriptor parameters. The full information about
538597 the descriptor could be found at UFS specifications 2.1.
598
+
539599 The file is read only.
540600
541601 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_memory_type
....@@ -544,6 +604,7 @@
544604 Description: This file shows LUN memory type. This is one of the UFS
545605 unit descriptor parameters. The full information about
546606 the descriptor could be found at UFS specifications 2.1.
607
+
547608 The file is read only.
548609
549610 What: /sys/class/scsi_device/*/device/unit_descriptor/data_reliability
....@@ -553,6 +614,7 @@
553614 occurs during a write operation. This is one of the UFS
554615 unit descriptor parameters. The full information about
555616 the descriptor could be found at UFS specifications 2.1.
617
+
556618 The file is read only.
557619
558620 What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_size
....@@ -562,6 +624,7 @@
562624 (calculated as an exponent with base 2). This is one of
563625 the UFS unit descriptor parameters. The full information about
564626 the descriptor could be found at UFS specifications 2.1.
627
+
565628 The file is read only.
566629
567630 What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_count
....@@ -571,6 +634,7 @@
571634 This is one of the UFS unit descriptor parameters. The full
572635 information about the descriptor could be found at
573636 UFS specifications 2.1.
637
+
574638 The file is read only.
575639
576640 What: /sys/class/scsi_device/*/device/unit_descriptor/erase_block_size
....@@ -579,6 +643,7 @@
579643 Description: This file shows the erase block size. This is one of
580644 the UFS unit descriptor parameters. The full information
581645 about the descriptor could be found at UFS specifications 2.1.
646
+
582647 The file is read only.
583648
584649 What: /sys/class/scsi_device/*/device/unit_descriptor/provisioning_type
....@@ -587,6 +652,7 @@
587652 Description: This file shows the thin provisioning type. This is one of
588653 the UFS unit descriptor parameters. The full information
589654 about the descriptor could be found at UFS specifications 2.1.
655
+
590656 The file is read only.
591657
592658 What: /sys/class/scsi_device/*/device/unit_descriptor/physical_memory_resourse_count
....@@ -595,6 +661,7 @@
595661 Description: This file shows the total physical memory resources. This is
596662 one of the UFS unit descriptor parameters. The full information
597663 about the descriptor could be found at UFS specifications 2.1.
664
+
598665 The file is read only.
599666
600667 What: /sys/class/scsi_device/*/device/unit_descriptor/context_capabilities
....@@ -603,6 +670,7 @@
603670 Description: This file shows the context capabilities. This is one of
604671 the UFS unit descriptor parameters. The full information
605672 about the descriptor could be found at UFS specifications 2.1.
673
+
606674 The file is read only.
607675
608676 What: /sys/class/scsi_device/*/device/unit_descriptor/large_unit_granularity
....@@ -611,6 +679,7 @@
611679 Description: This file shows the granularity of the LUN. This is one of
612680 the UFS unit descriptor parameters. The full information
613681 about the descriptor could be found at UFS specifications 2.1.
682
+
614683 The file is read only.
615684
616685
....@@ -619,6 +688,7 @@
619688 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
620689 Description: This file shows the device init status. The full information
621690 about the flag could be found at UFS specifications 2.1.
691
+
622692 The file is read only.
623693
624694 What: /sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe
....@@ -627,6 +697,7 @@
627697 Description: This file shows whether permanent write protection is enabled.
628698 The full information about the flag could be found at
629699 UFS specifications 2.1.
700
+
630701 The file is read only.
631702
632703 What: /sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe
....@@ -636,6 +707,7 @@
636707 logical units configured as power on write protected. The
637708 full information about the flag could be found at
638709 UFS specifications 2.1.
710
+
639711 The file is read only.
640712
641713 What: /sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable
....@@ -644,6 +716,7 @@
644716 Description: This file shows whether the device background operations are
645717 enabled. The full information about the flag could be
646718 found at UFS specifications 2.1.
719
+
647720 The file is read only.
648721
649722 What: /sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable
....@@ -652,6 +725,7 @@
652725 Description: This file shows whether the device life span mode is enabled.
653726 The full information about the flag could be found at
654727 UFS specifications 2.1.
728
+
655729 The file is read only.
656730
657731 What: /sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal
....@@ -660,6 +734,7 @@
660734 Description: This file shows whether physical resource removal is enable.
661735 The full information about the flag could be found at
662736 UFS specifications 2.1.
737
+
663738 The file is read only.
664739
665740 What: /sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc
....@@ -668,6 +743,7 @@
668743 Description: This file shows whether the device is executing internal
669744 operation related to real time clock. The full information
670745 about the flag could be found at UFS specifications 2.1.
746
+
671747 The file is read only.
672748
673749 What: /sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update
....@@ -676,6 +752,7 @@
676752 Description: This file shows whether the device FW update is permanently
677753 disabled. The full information about the flag could be found
678754 at UFS specifications 2.1.
755
+
679756 The file is read only.
680757
681758
....@@ -685,6 +762,7 @@
685762 Description: This file provides the boot lun enabled UFS device attribute.
686763 The full information about the attribute could be found at
687764 UFS specifications 2.1.
765
+
688766 The file is read only.
689767
690768 What: /sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode
....@@ -693,6 +771,7 @@
693771 Description: This file provides the current power mode UFS device attribute.
694772 The full information about the attribute could be found at
695773 UFS specifications 2.1.
774
+
696775 The file is read only.
697776
698777 What: /sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level
....@@ -701,6 +780,7 @@
701780 Description: This file provides the active icc level UFS device attribute.
702781 The full information about the attribute could be found at
703782 UFS specifications 2.1.
783
+
704784 The file is read only.
705785
706786 What: /sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled
....@@ -709,6 +789,7 @@
709789 Description: This file provides the out of order data transfer enabled UFS
710790 device attribute. The full information about the attribute
711791 could be found at UFS specifications 2.1.
792
+
712793 The file is read only.
713794
714795 What: /sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status
....@@ -717,6 +798,7 @@
717798 Description: This file provides the background operations status UFS device
718799 attribute. The full information about the attribute could
719800 be found at UFS specifications 2.1.
801
+
720802 The file is read only.
721803
722804 What: /sys/bus/platform/drivers/ufshcd/*/attributes/purge_status
....@@ -725,6 +807,7 @@
725807 Description: This file provides the purge operation status UFS device
726808 attribute. The full information about the attribute could
727809 be found at UFS specifications 2.1.
810
+
728811 The file is read only.
729812
730813 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size
....@@ -733,6 +816,7 @@
733816 Description: This file shows the maximum data size in a DATA IN
734817 UPIU. The full information about the attribute could
735818 be found at UFS specifications 2.1.
819
+
736820 The file is read only.
737821
738822 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size
....@@ -741,6 +825,7 @@
741825 Description: This file shows the maximum number of bytes that can be
742826 requested with a READY TO TRANSFER UPIU. The full information
743827 about the attribute could be found at UFS specifications 2.1.
828
+
744829 The file is read only.
745830
746831 What: /sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency
....@@ -749,6 +834,7 @@
749834 Description: This file provides the reference clock frequency UFS device
750835 attribute. The full information about the attribute could
751836 be found at UFS specifications 2.1.
837
+
752838 The file is read only.
753839
754840 What: /sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock
....@@ -765,6 +851,7 @@
765851 outstanding RTTs in device that is allowed. The full
766852 information about the attribute could be found at
767853 UFS specifications 2.1.
854
+
768855 The file is read only.
769856
770857 What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control
....@@ -773,6 +860,7 @@
773860 Description: This file provides the exception event control UFS device
774861 attribute. The full information about the attribute could
775862 be found at UFS specifications 2.1.
863
+
776864 The file is read only.
777865
778866 What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status
....@@ -781,6 +869,7 @@
781869 Description: This file provides the exception event status UFS device
782870 attribute. The full information about the attribute could
783871 be found at UFS specifications 2.1.
872
+
784873 The file is read only.
785874
786875 What: /sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status
....@@ -789,6 +878,7 @@
789878 Description: This file provides the ffu status UFS device attribute.
790879 The full information about the attribute could be found at
791880 UFS specifications 2.1.
881
+
792882 The file is read only.
793883
794884 What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_state
....@@ -796,6 +886,7 @@
796886 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
797887 Description: This file show the PSA feature status. The full information
798888 about the attribute could be found at UFS specifications 2.1.
889
+
799890 The file is read only.
800891
801892 What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size
....@@ -805,6 +896,7 @@
805896 load to all logical units in pre-soldering state.
806897 The full information about the attribute could be found at
807898 UFS specifications 2.1.
899
+
808900 The file is read only.
809901
810902
....@@ -815,6 +907,7 @@
815907 to be removed from the physical memory resources pool of
816908 the particular logical unit. The full information about
817909 the attribute could be found at UFS specifications 2.1.
910
+
818911 The file is read only.
819912
820913
....@@ -824,24 +917,28 @@
824917 Description: This entry could be used to set or show the UFS device
825918 runtime power management level. The current driver
826919 implementation supports 6 levels with next target states:
827
- 0 - an UFS device will stay active, an UIC link will
828
- stay active
829
- 1 - an UFS device will stay active, an UIC link will
830
- hibernate
831
- 2 - an UFS device will moved to sleep, an UIC link will
832
- stay active
833
- 3 - an UFS device will moved to sleep, an UIC link will
834
- hibernate
835
- 4 - an UFS device will be powered off, an UIC link will
836
- hibernate
837
- 5 - an UFS device will be powered off, an UIC link will
838
- be powered off
920
+
921
+ == ====================================================
922
+ 0 an UFS device will stay active, an UIC link will
923
+ stay active
924
+ 1 an UFS device will stay active, an UIC link will
925
+ hibernate
926
+ 2 an UFS device will moved to sleep, an UIC link will
927
+ stay active
928
+ 3 an UFS device will moved to sleep, an UIC link will
929
+ hibernate
930
+ 4 an UFS device will be powered off, an UIC link will
931
+ hibernate
932
+ 5 an UFS device will be powered off, an UIC link will
933
+ be powered off
934
+ == ====================================================
839935
840936 What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
841937 Date: February 2018
842938 Contact: Subhash Jadavani <subhashj@codeaurora.org>
843939 Description: This entry shows the target power mode of an UFS device
844940 for the chosen runtime power management level.
941
+
845942 The file is read only.
846943
847944 What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state
....@@ -849,6 +946,7 @@
849946 Contact: Subhash Jadavani <subhashj@codeaurora.org>
850947 Description: This entry shows the target state of an UFS UIC link
851948 for the chosen runtime power management level.
949
+
852950 The file is read only.
853951
854952 What: /sys/bus/platform/drivers/ufshcd/*/spm_lvl
....@@ -857,24 +955,28 @@
857955 Description: This entry could be used to set or show the UFS device
858956 system power management level. The current driver
859957 implementation supports 6 levels with next target states:
860
- 0 - an UFS device will stay active, an UIC link will
861
- stay active
862
- 1 - an UFS device will stay active, an UIC link will
863
- hibernate
864
- 2 - an UFS device will moved to sleep, an UIC link will
865
- stay active
866
- 3 - an UFS device will moved to sleep, an UIC link will
867
- hibernate
868
- 4 - an UFS device will be powered off, an UIC link will
869
- hibernate
870
- 5 - an UFS device will be powered off, an UIC link will
871
- be powered off
958
+
959
+ == ====================================================
960
+ 0 an UFS device will stay active, an UIC link will
961
+ stay active
962
+ 1 an UFS device will stay active, an UIC link will
963
+ hibernate
964
+ 2 an UFS device will moved to sleep, an UIC link will
965
+ stay active
966
+ 3 an UFS device will moved to sleep, an UIC link will
967
+ hibernate
968
+ 4 an UFS device will be powered off, an UIC link will
969
+ hibernate
970
+ 5 an UFS device will be powered off, an UIC link will
971
+ be powered off
972
+ == ====================================================
872973
873974 What: /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
874975 Date: February 2018
875976 Contact: Subhash Jadavani <subhashj@codeaurora.org>
876977 Description: This entry shows the target power mode of an UFS device
877978 for the chosen system power management level.
979
+
878980 The file is read only.
879981
880982 What: /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state
....@@ -882,4 +984,534 @@
882984 Contact: Subhash Jadavani <subhashj@codeaurora.org>
883985 Description: This entry shows the target state of an UFS UIC link
884986 for the chosen system power management level.
987
+
885988 The file is read only.
989
+
990
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable
991
+Date: January 2021
992
+Contact: Can Guo <cang@codeaurora.org>
993
+Description: This file shows the status of performance monitor enablement
994
+ and it can be used to start/stop the monitor. When the monitor
995
+ is stopped, the performance data collected is also cleared.
996
+
997
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size
998
+Date: January 2021
999
+Contact: Can Guo <cang@codeaurora.org>
1000
+Description: This file tells the monitor to focus on requests transferring
1001
+ data of specific chunk size (in Bytes). 0 means any chunk size.
1002
+ It can only be changed when monitor is disabled.
1003
+
1004
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors
1005
+Date: January 2021
1006
+Contact: Can Guo <cang@codeaurora.org>
1007
+Description: This file shows how many sectors (in 512 Bytes) have been
1008
+ sent from device to host after monitor gets started.
1009
+
1010
+ The file is read only.
1011
+
1012
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy
1013
+Date: January 2021
1014
+Contact: Can Guo <cang@codeaurora.org>
1015
+Description: This file shows how long (in micro seconds) has been spent
1016
+ sending data from device to host after monitor gets started.
1017
+
1018
+ The file is read only.
1019
+
1020
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests
1021
+Date: January 2021
1022
+Contact: Can Guo <cang@codeaurora.org>
1023
+Description: This file shows how many read requests have been sent after
1024
+ monitor gets started.
1025
+
1026
+ The file is read only.
1027
+
1028
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max
1029
+Date: January 2021
1030
+Contact: Can Guo <cang@codeaurora.org>
1031
+Description: This file shows the maximum latency (in micro seconds) of
1032
+ read requests after monitor gets started.
1033
+
1034
+ The file is read only.
1035
+
1036
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min
1037
+Date: January 2021
1038
+Contact: Can Guo <cang@codeaurora.org>
1039
+Description: This file shows the minimum latency (in micro seconds) of
1040
+ read requests after monitor gets started.
1041
+
1042
+ The file is read only.
1043
+
1044
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg
1045
+Date: January 2021
1046
+Contact: Can Guo <cang@codeaurora.org>
1047
+Description: This file shows the average latency (in micro seconds) of
1048
+ read requests after monitor gets started.
1049
+
1050
+ The file is read only.
1051
+
1052
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum
1053
+Date: January 2021
1054
+Contact: Can Guo <cang@codeaurora.org>
1055
+Description: This file shows the total latency (in micro seconds) of
1056
+ read requests sent after monitor gets started.
1057
+
1058
+ The file is read only.
1059
+
1060
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors
1061
+Date: January 2021
1062
+Contact: Can Guo <cang@codeaurora.org>
1063
+Description: This file shows how many sectors (in 512 Bytes) have been sent
1064
+ from host to device after monitor gets started.
1065
+
1066
+ The file is read only.
1067
+
1068
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy
1069
+Date: January 2021
1070
+Contact: Can Guo <cang@codeaurora.org>
1071
+Description: This file shows how long (in micro seconds) has been spent
1072
+ sending data from host to device after monitor gets started.
1073
+
1074
+ The file is read only.
1075
+
1076
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests
1077
+Date: January 2021
1078
+Contact: Can Guo <cang@codeaurora.org>
1079
+Description: This file shows how many write requests have been sent after
1080
+ monitor gets started.
1081
+
1082
+ The file is read only.
1083
+
1084
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max
1085
+Date: January 2021
1086
+Contact: Can Guo <cang@codeaurora.org>
1087
+Description: This file shows the maximum latency (in micro seconds) of write
1088
+ requests after monitor gets started.
1089
+
1090
+ The file is read only.
1091
+
1092
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min
1093
+Date: January 2021
1094
+Contact: Can Guo <cang@codeaurora.org>
1095
+Description: This file shows the minimum latency (in micro seconds) of write
1096
+ requests after monitor gets started.
1097
+
1098
+ The file is read only.
1099
+
1100
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg
1101
+Date: January 2021
1102
+Contact: Can Guo <cang@codeaurora.org>
1103
+Description: This file shows the average latency (in micro seconds) of write
1104
+ requests after monitor gets started.
1105
+
1106
+ The file is read only.
1107
+
1108
+What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum
1109
+Date: January 2021
1110
+Contact: Can Guo <cang@codeaurora.org>
1111
+Description: This file shows the total latency (in micro seconds) of write
1112
+ requests after monitor gets started.
1113
+
1114
+ The file is read only.
1115
+
1116
+What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
1117
+Date: June 2020
1118
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1119
+Description: This entry shows if preserve user-space was configured
1120
+
1121
+ The file is read only.
1122
+
1123
+What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units
1124
+Date: June 2020
1125
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1126
+Description: This entry shows the shared allocated units of WB buffer
1127
+
1128
+ The file is read only.
1129
+
1130
+What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type
1131
+Date: June 2020
1132
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1133
+Description: This entry shows the configured WB type.
1134
+ 0x1 for shared buffer mode. 0x0 for dedicated buffer mode.
1135
+
1136
+ The file is read only.
1137
+
1138
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
1139
+Date: June 2020
1140
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1141
+Description: This entry shows the total user-space decrease in shared
1142
+ buffer mode.
1143
+ The value of this parameter is 3 for TLC NAND when SLC mode
1144
+ is used as WriteBooster Buffer. 2 for MLC NAND.
1145
+
1146
+ The file is read only.
1147
+
1148
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units
1149
+Date: June 2020
1150
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1151
+Description: This entry shows the Maximum total WriteBooster Buffer size
1152
+ which is supported by the entire device.
1153
+
1154
+ The file is read only.
1155
+
1156
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
1157
+Date: June 2020
1158
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1159
+Description: This entry shows the maximum number of luns that can support
1160
+ WriteBooster.
1161
+
1162
+ The file is read only.
1163
+
1164
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
1165
+Date: June 2020
1166
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1167
+Description: The supportability of user space reduction mode
1168
+ and preserve user space mode.
1169
+ 00h: WriteBooster Buffer can be configured only in
1170
+ user space reduction type.
1171
+ 01h: WriteBooster Buffer can be configured only in
1172
+ preserve user space type.
1173
+ 02h: Device can be configured in either user space
1174
+ reduction type or preserve user space type.
1175
+
1176
+ The file is read only.
1177
+
1178
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
1179
+Date: June 2020
1180
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1181
+Description: The supportability of WriteBooster Buffer type.
1182
+
1183
+ === ==========================================================
1184
+ 00h LU based WriteBooster Buffer configuration
1185
+ 01h Single shared WriteBooster Buffer configuration
1186
+ 02h Supporting both LU based WriteBooster.
1187
+ Buffer and Single shared WriteBooster Buffer configuration
1188
+ === ==========================================================
1189
+
1190
+ The file is read only.
1191
+
1192
+What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
1193
+Date: June 2020
1194
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1195
+Description: This entry shows the status of WriteBooster.
1196
+
1197
+ == ============================
1198
+ 0 WriteBooster is not enabled.
1199
+ 1 WriteBooster is enabled
1200
+ == ============================
1201
+
1202
+ The file is read only.
1203
+
1204
+What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
1205
+Date: June 2020
1206
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1207
+Description: This entry shows if flush is enabled.
1208
+
1209
+ == =================================
1210
+ 0 Flush operation is not performed.
1211
+ 1 Flush operation is performed.
1212
+ == =================================
1213
+
1214
+ The file is read only.
1215
+
1216
+What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8
1217
+Date: June 2020
1218
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1219
+Description: Flush WriteBooster Buffer during hibernate state.
1220
+
1221
+ == =================================================
1222
+ 0 Device is not allowed to flush the
1223
+ WriteBooster Buffer during link hibernate state.
1224
+ 1 Device is allowed to flush the
1225
+ WriteBooster Buffer during link hibernate state.
1226
+ == =================================================
1227
+
1228
+ The file is read only.
1229
+
1230
+What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf
1231
+Date: June 2020
1232
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1233
+Description: This entry shows the amount of unused WriteBooster buffer
1234
+ available.
1235
+
1236
+ The file is read only.
1237
+
1238
+What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
1239
+Date: June 2020
1240
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1241
+Description: This entry shows the amount of unused current buffer.
1242
+
1243
+ The file is read only.
1244
+
1245
+What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status
1246
+Date: June 2020
1247
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1248
+Description: This entry shows the flush operation status.
1249
+
1250
+
1251
+ === ======================================
1252
+ 00h idle
1253
+ 01h Flush operation in progress
1254
+ 02h Flush operation stopped prematurely.
1255
+ 03h Flush operation completed successfully
1256
+ 04h Flush operation general failure
1257
+ === ======================================
1258
+
1259
+ The file is read only.
1260
+
1261
+What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est
1262
+Date: June 2020
1263
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1264
+Description: This entry shows an indication of the WriteBooster Buffer
1265
+ lifetime based on the amount of performed program/erase cycles
1266
+
1267
+ === =============================================
1268
+ 01h 0% - 10% WriteBooster Buffer life time used
1269
+ ...
1270
+ 0Ah 90% - 100% WriteBooster Buffer life time used
1271
+ === =============================================
1272
+
1273
+ The file is read only.
1274
+
1275
+What: /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
1276
+Date: June 2020
1277
+Contact: Asutosh Das <asutoshd@codeaurora.org>
1278
+Description: This entry shows the configured size of WriteBooster buffer.
1279
+ 0400h corresponds to 4GB.
1280
+
1281
+ The file is read only.
1282
+
1283
+What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_version
1284
+Date: June 2021
1285
+Contact: Daejun Park <daejun7.park@samsung.com>
1286
+Description: This entry shows the HPB specification version.
1287
+ The full information about the descriptor could be found at UFS
1288
+ HPB (Host Performance Booster) Extension specifications.
1289
+ Example: version 1.2.3 = 0123h
1290
+
1291
+ The file is read only.
1292
+
1293
+What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_control
1294
+Date: June 2021
1295
+Contact: Daejun Park <daejun7.park@samsung.com>
1296
+Description: This entry shows an indication of the HPB control mode.
1297
+ 00h: Host control mode
1298
+ 01h: Device control mode
1299
+
1300
+ The file is read only.
1301
+
1302
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_region_size
1303
+Date: June 2021
1304
+Contact: Daejun Park <daejun7.park@samsung.com>
1305
+Description: This entry shows the bHPBRegionSize which can be calculated
1306
+ as in the following (in bytes):
1307
+ HPB Region size = 512B * 2^bHPBRegionSize
1308
+
1309
+ The file is read only.
1310
+
1311
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_number_lu
1312
+Date: June 2021
1313
+Contact: Daejun Park <daejun7.park@samsung.com>
1314
+Description: This entry shows the maximum number of HPB LU supported by
1315
+ the device.
1316
+ 00h: HPB is not supported by the device.
1317
+ 01h ~ 20h: Maximum number of HPB LU supported by the device
1318
+
1319
+ The file is read only.
1320
+
1321
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_subregion_size
1322
+Date: June 2021
1323
+Contact: Daejun Park <daejun7.park@samsung.com>
1324
+Description: This entry shows the bHPBSubRegionSize, which can be
1325
+ calculated as in the following (in bytes) and shall be a multiple of
1326
+ logical block size:
1327
+ HPB Sub-Region size = 512B x 2^bHPBSubRegionSize
1328
+ bHPBSubRegionSize shall not exceed bHPBRegionSize.
1329
+
1330
+ The file is read only.
1331
+
1332
+What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_max_active_regions
1333
+Date: June 2021
1334
+Contact: Daejun Park <daejun7.park@samsung.com>
1335
+Description: This entry shows the maximum number of active HPB regions that
1336
+ is supported by the device.
1337
+
1338
+ The file is read only.
1339
+
1340
+What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_lu_max_active_regions
1341
+Date: June 2021
1342
+Contact: Daejun Park <daejun7.park@samsung.com>
1343
+Description: This entry shows the maximum number of HPB regions assigned to
1344
+ the HPB logical unit.
1345
+
1346
+ The file is read only.
1347
+
1348
+What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_pinned_region_start_offset
1349
+Date: June 2021
1350
+Contact: Daejun Park <daejun7.park@samsung.com>
1351
+Description: This entry shows the start offset of HPB pinned region.
1352
+
1353
+ The file is read only.
1354
+
1355
+What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_number_pinned_regions
1356
+Date: June 2021
1357
+Contact: Daejun Park <daejun7.park@samsung.com>
1358
+Description: This entry shows the number of HPB pinned regions assigned to
1359
+ the HPB logical unit.
1360
+
1361
+ The file is read only.
1362
+
1363
+What: /sys/class/scsi_device/*/device/hpb_stats/hit_cnt
1364
+Date: June 2021
1365
+Contact: Daejun Park <daejun7.park@samsung.com>
1366
+Description: This entry shows the number of reads that changed to HPB read.
1367
+
1368
+ The file is read only.
1369
+
1370
+What: /sys/class/scsi_device/*/device/hpb_stats/miss_cnt
1371
+Date: June 2021
1372
+Contact: Daejun Park <daejun7.park@samsung.com>
1373
+Description: This entry shows the number of reads that cannot be changed to
1374
+ HPB read.
1375
+
1376
+ The file is read only.
1377
+
1378
+What: /sys/class/scsi_device/*/device/hpb_stats/rb_noti_cnt
1379
+Date: June 2021
1380
+Contact: Daejun Park <daejun7.park@samsung.com>
1381
+Description: This entry shows the number of response UPIUs that has
1382
+ recommendations for activating sub-regions and/or inactivating region.
1383
+
1384
+ The file is read only.
1385
+
1386
+What: /sys/class/scsi_device/*/device/hpb_stats/rb_active_cnt
1387
+Date: June 2021
1388
+Contact: Daejun Park <daejun7.park@samsung.com>
1389
+Description: This entry shows the number of active sub-regions recommended by
1390
+ response UPIUs.
1391
+
1392
+ The file is read only.
1393
+
1394
+What: /sys/class/scsi_device/*/device/hpb_stats/rb_inactive_cnt
1395
+Date: June 2021
1396
+Contact: Daejun Park <daejun7.park@samsung.com>
1397
+Description: This entry shows the number of inactive regions recommended by
1398
+ response UPIUs.
1399
+
1400
+ The file is read only.
1401
+
1402
+What: /sys/class/scsi_device/*/device/hpb_stats/map_req_cnt
1403
+Date: June 2021
1404
+Contact: Daejun Park <daejun7.park@samsung.com>
1405
+Description: This entry shows the number of read buffer commands for
1406
+ activating sub-regions recommended by response UPIUs.
1407
+
1408
+ The file is read only.
1409
+
1410
+What: /sys/class/scsi_device/*/device/hpb_params/requeue_timeout_ms
1411
+Date: June 2021
1412
+Contact: Daejun Park <daejun7.park@samsung.com>
1413
+Description: This entry shows the requeue timeout threshold for write buffer
1414
+ command in ms. This value can be changed by writing proper integer to
1415
+ this entry.
1416
+
1417
+What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_size_hpb_single_cmd
1418
+Date: June 2021
1419
+Contact: Daejun Park <daejun7.park@samsung.com>
1420
+Description: This entry shows the maximum HPB data size for using single HPB
1421
+ command.
1422
+
1423
+ === ========
1424
+ 00h 4KB
1425
+ 01h 8KB
1426
+ 02h 12KB
1427
+ ...
1428
+ FFh 1024KB
1429
+ === ========
1430
+
1431
+ The file is read only.
1432
+
1433
+What: /sys/bus/platform/drivers/ufshcd/*/flags/hpb_enable
1434
+Date: June 2021
1435
+Contact: Daejun Park <daejun7.park@samsung.com>
1436
+Description: This entry shows the status of HPB.
1437
+
1438
+ == ============================
1439
+ 0 HPB is not enabled.
1440
+ 1 HPB is enabled
1441
+ == ============================
1442
+
1443
+ The file is read only.
1444
+
1445
+What: /sys/class/scsi_device/*/device/hpb_param_sysfs/activation_thld
1446
+Date: February 2021
1447
+Contact: Avri Altman <avri.altman@wdc.com>
1448
+Description: In host control mode, reads are the major source of activation
1449
+ trials. once this threshold hs met, the region is added to the
1450
+ "to-be-activated" list. Since we reset the read counter upon
1451
+ write, this include sending a rb command updating the region
1452
+ ppn as well.
1453
+
1454
+What: /sys/class/scsi_device/*/device/hpb_param_sysfs/normalization_factor
1455
+Date: February 2021
1456
+Contact: Avri Altman <avri.altman@wdc.com>
1457
+Description: In host control mode, We think of the regions as "buckets".
1458
+ Those buckets are being filled with reads, and emptied on write.
1459
+ We use entries_per_srgn - the amount of blocks in a subregion as
1460
+ our bucket size. This applies because HPB1.0 only concern a
1461
+ single-block reads. Once the bucket size is crossed, we trigger
1462
+ a normalization work - not only to avoid overflow, but mainly
1463
+ because we want to keep those counters normalized, as we are
1464
+ using those reads as a comparative score, to make various decisions.
1465
+ The normalization is dividing (shift right) the read counter by
1466
+ the normalization_factor. If during consecutive normalizations
1467
+ an active region has exhaust its reads - inactivate it.
1468
+
1469
+What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_enter
1470
+Date: February 2021
1471
+Contact: Avri Altman <avri.altman@wdc.com>
1472
+Description: Region deactivation is often due to the fact that eviction took
1473
+ place: a region become active on the expense of another. This is
1474
+ happening when the max-active-regions limit has crossed.
1475
+ In host mode, eviction is considered an extreme measure. We
1476
+ want to verify that the entering region has enough reads, and
1477
+ the exiting region has much less reads. eviction_thld_enter is
1478
+ the min reads that a region must have in order to be considered
1479
+ as a candidate to evict other region.
1480
+
1481
+What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_exit
1482
+Date: February 2021
1483
+Contact: Avri Altman <avri.altman@wdc.com>
1484
+Description: same as above for the exiting region. A region is consider to
1485
+ be a candidate to be evicted, only if it has less reads than
1486
+ eviction_thld_exit.
1487
+
1488
+What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_ms
1489
+Date: February 2021
1490
+Contact: Avri Altman <avri.altman@wdc.com>
1491
+Description: In order not to hang on to “cold” regions, we shall inactivate
1492
+ a region that has no READ access for a predefined amount of
1493
+ time - read_timeout_ms. If read_timeout_ms has expired, and the
1494
+ region is dirty - it is less likely that we can make any use of
1495
+ HPB-READing it. So we inactivate it. Still, deactivation has
1496
+ its overhead, and we may still benefit from HPB-READing this
1497
+ region if it is clean - see read_timeout_expiries.
1498
+
1499
+What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_expiries
1500
+Date: February 2021
1501
+Contact: Avri Altman <avri.altman@wdc.com>
1502
+Description: if the region read timeout has expired, but the region is clean,
1503
+ just re-wind its timer for another spin. Do that as long as it
1504
+ is clean and did not exhaust its read_timeout_expiries threshold.
1505
+
1506
+What: /sys/class/scsi_device/*/device/hpb_param_sysfs/timeout_polling_interval_ms
1507
+Date: February 2021
1508
+Contact: Avri Altman <avri.altman@wdc.com>
1509
+Description: the frequency in which the delayed worker that checks the
1510
+ read_timeouts is awaken.
1511
+
1512
+What: /sys/class/scsi_device/*/device/hpb_param_sysfs/inflight_map_req
1513
+Date: February 2021
1514
+Contact: Avri Altman <avri.altman@wdc.com>
1515
+Description: in host control mode the host is the originator of map requests.
1516
+ To not flood the device with map requests, use a simple throttling
1517
+ mechanism that limits the number of inflight map requests.