1 What: /sys/bus/*/drivers/ufshcd/*/auto_hibern8
3 Contact: linux-scsi@vger.kernel.org
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.
15 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_type
17 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
18 Description: 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.
22 The file is read only.
24 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class
26 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
27 Description: 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.
31 The file is read only.
33 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class
35 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
36 Description: 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.
40 The file is read only.
42 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol
44 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
45 Description: 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.
50 The file is read only.
52 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns
54 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
55 Description: 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.
59 The file is read only.
61 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns
63 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
64 Description: 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.
69 The file is read only.
71 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable
73 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
74 Description: 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.
79 The file is read only.
81 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable
83 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
84 Description: 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.
90 The file is read only.
92 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode
94 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
95 Description: 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.
100 The file is read only.
102 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/high_priority_lun
104 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
105 Description: 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.
109 The file is read only.
111 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type
113 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
114 Description: 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.
118 The file is read only.
120 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun
122 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
123 Description: 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.
128 The file is read only.
130 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency
132 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
133 Description: 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.
138 The file is read only.
140 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level
142 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
143 Description: 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.
147 The file is read only.
149 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version
151 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
152 Description: 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.
156 The file is read only.
158 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date
160 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
161 Description: 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.
166 The file is read only.
168 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id
170 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
171 Description: This file shows the manufacturer ID. This is one of the
172 UFS device descriptor parameters. The full information about
173 the descriptor could be found at UFS specifications 2.1.
175 The file is read only.
177 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability
179 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
180 Description: 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.
185 The file is read only.
187 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update
189 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
190 Description: 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.
195 The file is read only.
197 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features
199 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
200 Description: 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.
205 The file is read only.
207 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout
209 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
210 Description: 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.
214 The file is read only.
216 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth
218 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
219 Description: 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.
223 The file is read only.
225 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version
227 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
228 Description: 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.
232 The file is read only.
234 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa
236 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
237 Description: 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.
242 The file is read only.
244 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size
246 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
247 Description: 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.
253 The file is read only.
255 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout
257 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
258 Description: 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.
263 The file is read only.
266 What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/unipro_version
268 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
269 Description: 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.
274 The file is read only.
276 What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version
278 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
279 Description: 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.
284 The file is read only.
287 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/raw_device_capacity
289 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
290 Description: 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.
296 The file is read only.
298 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns
300 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
301 Description: 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.
306 The file is read only.
308 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size
310 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
311 Description: 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.
315 The file is read only.
317 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size
319 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
320 Description: 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.
324 The file is read only.
326 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size
328 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
329 Description: 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
334 The file is read only.
336 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size
338 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
339 Description: 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
344 The file is read only.
346 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size
348 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
349 Description: 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
354 The file is read only.
356 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size
358 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
359 Description: 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
364 The file is read only.
366 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size
368 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
369 Description: 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
374 The file is read only.
376 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size
378 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
379 Description: 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.
384 The file is read only.
386 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy
388 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
389 Description: 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.
394 The file is read only.
396 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering
398 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
399 Description: 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.
404 The file is read only.
406 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_contexts
408 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
409 Description: 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.
414 The file is read only.
416 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size
418 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
419 Description: 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.
423 The file is read only.
425 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size
427 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
428 Description: 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.
434 The file is read only.
436 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types
438 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
439 Description: 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.
444 The file is read only.
446 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types
448 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
449 Description: 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.
454 The file is read only.
456 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units
458 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
459 Description: 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.
465 The file is read only.
467 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor
469 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
470 Description: 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.
476 The file is read only.
479 What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/eol_info
481 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
482 Description: 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.
487 The file is read only.
489 What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a
491 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
492 Description: 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.
497 The file is read only.
499 What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b
501 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
502 Description: 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.
507 The file is read only.
510 What: /sys/bus/platform/drivers/ufshcd/*/power_descriptor/active_icc_levels_vcc*
512 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
513 Description: 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.
518 The file is read only.
521 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/manufacturer_name
523 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
524 Description: This file contains a device manufacturer name string.
525 The full information about the descriptor could be found at
526 UFS specifications 2.1.
528 The file is read only.
530 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name
532 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
533 Description: This file contains a product name string. The full information
534 about the descriptor could be found at UFS specifications 2.1.
536 The file is read only.
538 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id
540 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
541 Description: This file contains a OEM ID string. The full information
542 about the descriptor could be found at UFS specifications 2.1.
544 The file is read only.
546 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number
548 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
549 Description: This file contains a device serial number string. The full
550 information about the descriptor could be found at
551 UFS specifications 2.1.
553 The file is read only.
555 What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision
557 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
558 Description: This file contains a product revision string. The full
559 information about the descriptor could be found at
560 UFS specifications 2.1.
562 The file is read only.
565 What: /sys/class/scsi_device/*/device/unit_descriptor/boot_lun_id
567 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
568 Description: 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.
572 The file is read only.
574 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_write_protect
576 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
577 Description: 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.
581 The file is read only.
583 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_queue_depth
585 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
586 Description: 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.
590 The file is read only.
592 What: /sys/class/scsi_device/*/device/unit_descriptor/psa_sensitive
594 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
595 Description: 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.
599 The file is read only.
601 What: /sys/class/scsi_device/*/device/unit_descriptor/lun_memory_type
603 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
604 Description: 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.
608 The file is read only.
610 What: /sys/class/scsi_device/*/device/unit_descriptor/data_reliability
612 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
613 Description: 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.
618 The file is read only.
620 What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_size
622 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
623 Description: 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.
628 The file is read only.
630 What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_count
632 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
633 Description: 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.
638 The file is read only.
640 What: /sys/class/scsi_device/*/device/unit_descriptor/erase_block_size
642 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
643 Description: 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.
647 The file is read only.
649 What: /sys/class/scsi_device/*/device/unit_descriptor/provisioning_type
651 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
652 Description: 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.
656 The file is read only.
658 What: /sys/class/scsi_device/*/device/unit_descriptor/physical_memory_resourse_count
660 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
661 Description: 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.
665 The file is read only.
667 What: /sys/class/scsi_device/*/device/unit_descriptor/context_capabilities
669 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
670 Description: 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.
674 The file is read only.
676 What: /sys/class/scsi_device/*/device/unit_descriptor/large_unit_granularity
678 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
679 Description: 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.
683 The file is read only.
686 What: /sys/bus/platform/drivers/ufshcd/*/flags/device_init
688 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
689 Description: This file shows the device init status. The full information
690 about the flag could be found at UFS specifications 2.1.
692 The file is read only.
694 What: /sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe
696 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
697 Description: 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.
701 The file is read only.
703 What: /sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe
705 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
706 Description: 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.
711 The file is read only.
713 What: /sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable
715 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
716 Description: 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.
720 The file is read only.
722 What: /sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable
724 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
725 Description: 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.
729 The file is read only.
731 What: /sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal
733 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
734 Description: 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.
738 The file is read only.
740 What: /sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc
742 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
743 Description: 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.
747 The file is read only.
749 What: /sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update
751 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
752 Description: 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.
756 The file is read only.
759 What: /sys/bus/platform/drivers/ufshcd/*/attributes/boot_lun_enabled
761 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
762 Description: 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.
766 The file is read only.
768 What: /sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode
770 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
771 Description: 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.
775 The file is read only.
777 What: /sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level
779 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
780 Description: 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.
784 The file is read only.
786 What: /sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled
788 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
789 Description: 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.
793 The file is read only.
795 What: /sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status
797 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
798 Description: 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.
802 The file is read only.
804 What: /sys/bus/platform/drivers/ufshcd/*/attributes/purge_status
806 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
807 Description: 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.
811 The file is read only.
813 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size
815 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
816 Description: 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.
820 The file is read only.
822 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size
824 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
825 Description: 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.
829 The file is read only.
831 What: /sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency
833 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
834 Description: 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.
838 The file is read only.
840 What: /sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock
842 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
843 Description: 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.
847 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_number_of_rtt
849 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
850 Description: 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.
855 The file is read only.
857 What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control
859 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
860 Description: 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.
864 The file is read only.
866 What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status
868 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
869 Description: 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.
873 The file is read only.
875 What: /sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status
877 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
878 Description: 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.
882 The file is read only.
884 What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_state
886 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
887 Description: This file show the PSA feature status. The full information
888 about the attribute could be found at UFS specifications 2.1.
890 The file is read only.
892 What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size
894 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
895 Description: 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.
900 The file is read only.
903 What: /sys/class/scsi_device/*/device/dyn_cap_needed
905 Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
906 Description: 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.
911 The file is read only.
914 What: /sys/bus/platform/drivers/ufshcd/*/rpm_lvl
916 Contact: Subhash Jadavani <subhashj@codeaurora.org>
917 Description: 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:
921 == ====================================================
922 0 UFS device will stay active, UIC link will
924 1 UFS device will stay active, UIC link will
926 2 UFS device will be moved to sleep, UIC link will
928 3 UFS device will be moved to sleep, UIC link will
930 4 UFS device will be powered off, UIC link will
932 5 UFS device will be powered off, UIC link will
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
938 == ====================================================
940 What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
942 Contact: Subhash Jadavani <subhashj@codeaurora.org>
943 Description: This entry shows the target power mode of an UFS device
944 for the chosen runtime power management level.
946 The file is read only.
948 What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state
950 Contact: Subhash Jadavani <subhashj@codeaurora.org>
951 Description: This entry shows the target state of an UFS UIC link
952 for the chosen runtime power management level.
954 The file is read only.
956 What: /sys/bus/platform/drivers/ufshcd/*/spm_lvl
958 Contact: Subhash Jadavani <subhashj@codeaurora.org>
959 Description: This entry could be used to set or show the UFS device
960 system power management level. The current driver
961 implementation supports 7 levels with next target states:
963 == ====================================================
964 0 UFS device will stay active, UIC link will
966 1 UFS device will stay active, UIC link will
968 2 UFS device will be moved to sleep, UIC link will
970 3 UFS device will be moved to sleep, UIC link will
972 4 UFS device will be powered off, UIC link will
974 5 UFS device will be powered off, UIC link will
976 6 UFS device will be moved to deep sleep, UIC link
977 will be powered off. Note, deep sleep might not be
978 supported in which case this value will not be
980 == ====================================================
982 What: /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
984 Contact: Subhash Jadavani <subhashj@codeaurora.org>
985 Description: This entry shows the target power mode of an UFS device
986 for the chosen system power management level.
988 The file is read only.
990 What: /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state
992 Contact: Subhash Jadavani <subhashj@codeaurora.org>
993 Description: This entry shows the target state of an UFS UIC link
994 for the chosen system power management level.
996 The file is read only.
998 What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable
1000 Contact: Can Guo <cang@codeaurora.org>
1001 Description: This file shows the status of performance monitor enablement
1002 and it can be used to start/stop the monitor. When the monitor
1003 is stopped, the performance data collected is also cleared.
1005 What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size
1007 Contact: Can Guo <cang@codeaurora.org>
1008 Description: This file tells the monitor to focus on requests transferring
1009 data of specific chunk size (in Bytes). 0 means any chunk size.
1010 It can only be changed when monitor is disabled.
1012 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors
1014 Contact: Can Guo <cang@codeaurora.org>
1015 Description: This file shows how many sectors (in 512 Bytes) have been
1016 sent from device to host after monitor gets started.
1018 The file is read only.
1020 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy
1022 Contact: Can Guo <cang@codeaurora.org>
1023 Description: This file shows how long (in micro seconds) has been spent
1024 sending data from device to host after monitor gets started.
1026 The file is read only.
1028 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests
1030 Contact: Can Guo <cang@codeaurora.org>
1031 Description: This file shows how many read requests have been sent after
1032 monitor gets started.
1034 The file is read only.
1036 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max
1038 Contact: Can Guo <cang@codeaurora.org>
1039 Description: This file shows the maximum latency (in micro seconds) of
1040 read requests after monitor gets started.
1042 The file is read only.
1044 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min
1046 Contact: Can Guo <cang@codeaurora.org>
1047 Description: This file shows the minimum latency (in micro seconds) of
1048 read requests after monitor gets started.
1050 The file is read only.
1052 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg
1054 Contact: Can Guo <cang@codeaurora.org>
1055 Description: This file shows the average latency (in micro seconds) of
1056 read requests after monitor gets started.
1058 The file is read only.
1060 What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum
1062 Contact: Can Guo <cang@codeaurora.org>
1063 Description: This file shows the total latency (in micro seconds) of
1064 read requests sent after monitor gets started.
1066 The file is read only.
1068 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors
1070 Contact: Can Guo <cang@codeaurora.org>
1071 Description: This file shows how many sectors (in 512 Bytes) have been sent
1072 from host to device after monitor gets started.
1074 The file is read only.
1076 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy
1078 Contact: Can Guo <cang@codeaurora.org>
1079 Description: This file shows how long (in micro seconds) has been spent
1080 sending data from host to device after monitor gets started.
1082 The file is read only.
1084 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests
1086 Contact: Can Guo <cang@codeaurora.org>
1087 Description: This file shows how many write requests have been sent after
1088 monitor gets started.
1090 The file is read only.
1092 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max
1094 Contact: Can Guo <cang@codeaurora.org>
1095 Description: This file shows the maximum latency (in micro seconds) of write
1096 requests after monitor gets started.
1098 The file is read only.
1100 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min
1102 Contact: Can Guo <cang@codeaurora.org>
1103 Description: This file shows the minimum latency (in micro seconds) of write
1104 requests after monitor gets started.
1106 The file is read only.
1108 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg
1110 Contact: Can Guo <cang@codeaurora.org>
1111 Description: This file shows the average latency (in micro seconds) of write
1112 requests after monitor gets started.
1114 The file is read only.
1116 What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum
1118 Contact: Can Guo <cang@codeaurora.org>
1119 Description: This file shows the total latency (in micro seconds) of write
1120 requests after monitor gets started.
1122 The file is read only.
1124 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
1126 Contact: Asutosh Das <asutoshd@codeaurora.org>
1127 Description: This entry shows if preserve user-space was configured
1129 The file is read only.
1131 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units
1133 Contact: Asutosh Das <asutoshd@codeaurora.org>
1134 Description: This entry shows the shared allocated units of WB buffer
1136 The file is read only.
1138 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type
1140 Contact: Asutosh Das <asutoshd@codeaurora.org>
1141 Description: This entry shows the configured WB type.
1142 0x1 for shared buffer mode. 0x0 for dedicated buffer mode.
1144 The file is read only.
1146 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
1148 Contact: Asutosh Das <asutoshd@codeaurora.org>
1149 Description: This entry shows the total user-space decrease in shared
1151 The value of this parameter is 3 for TLC NAND when SLC mode
1152 is used as WriteBooster Buffer. 2 for MLC NAND.
1154 The file is read only.
1156 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units
1158 Contact: Asutosh Das <asutoshd@codeaurora.org>
1159 Description: This entry shows the Maximum total WriteBooster Buffer size
1160 which is supported by the entire device.
1162 The file is read only.
1164 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
1166 Contact: Asutosh Das <asutoshd@codeaurora.org>
1167 Description: This entry shows the maximum number of luns that can support
1170 The file is read only.
1172 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
1174 Contact: Asutosh Das <asutoshd@codeaurora.org>
1175 Description: The supportability of user space reduction mode
1176 and preserve user space mode.
1177 00h: WriteBooster Buffer can be configured only in
1178 user space reduction type.
1179 01h: WriteBooster Buffer can be configured only in
1180 preserve user space type.
1181 02h: Device can be configured in either user space
1182 reduction type or preserve user space type.
1184 The file is read only.
1186 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
1188 Contact: Asutosh Das <asutoshd@codeaurora.org>
1189 Description: The supportability of WriteBooster Buffer type.
1191 === ==========================================================
1192 00h LU based WriteBooster Buffer configuration
1193 01h Single shared WriteBooster Buffer configuration
1194 02h Supporting both LU based WriteBooster.
1195 Buffer and Single shared WriteBooster Buffer configuration
1196 === ==========================================================
1198 The file is read only.
1200 What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
1202 Contact: Asutosh Das <asutoshd@codeaurora.org>
1203 Description: This entry shows the status of WriteBooster.
1205 == ============================
1206 0 WriteBooster is not enabled.
1207 1 WriteBooster is enabled
1208 == ============================
1210 The file is read only.
1212 What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
1214 Contact: Asutosh Das <asutoshd@codeaurora.org>
1215 Description: This entry shows if flush is enabled.
1217 == =================================
1218 0 Flush operation is not performed.
1219 1 Flush operation is performed.
1220 == =================================
1222 The file is read only.
1224 What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8
1226 Contact: Asutosh Das <asutoshd@codeaurora.org>
1227 Description: Flush WriteBooster Buffer during hibernate state.
1229 == =================================================
1230 0 Device is not allowed to flush the
1231 WriteBooster Buffer during link hibernate state.
1232 1 Device is allowed to flush the
1233 WriteBooster Buffer during link hibernate state.
1234 == =================================================
1236 The file is read only.
1238 What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf
1240 Contact: Asutosh Das <asutoshd@codeaurora.org>
1241 Description: This entry shows the amount of unused WriteBooster buffer
1244 The file is read only.
1246 What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
1248 Contact: Asutosh Das <asutoshd@codeaurora.org>
1249 Description: This entry shows the amount of unused current buffer.
1251 The file is read only.
1253 What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status
1255 Contact: Asutosh Das <asutoshd@codeaurora.org>
1256 Description: This entry shows the flush operation status.
1259 === ======================================
1261 01h Flush operation in progress
1262 02h Flush operation stopped prematurely.
1263 03h Flush operation completed successfully
1264 04h Flush operation general failure
1265 === ======================================
1267 The file is read only.
1269 What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est
1271 Contact: Asutosh Das <asutoshd@codeaurora.org>
1272 Description: This entry shows an indication of the WriteBooster Buffer
1273 lifetime based on the amount of performed program/erase cycles
1275 === =============================================
1276 01h 0% - 10% WriteBooster Buffer life time used
1278 0Ah 90% - 100% WriteBooster Buffer life time used
1279 === =============================================
1281 The file is read only.
1283 What: /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
1285 Contact: Asutosh Das <asutoshd@codeaurora.org>
1286 Description: This entry shows the configured size of WriteBooster buffer.
1287 0400h corresponds to 4GB.
1289 The file is read only.
1291 What: /sys/bus/platform/drivers/ufshcd/*/wb_on
1293 Contact: Bean Huo <beanhuo@micron.com>
1294 Description: This node is used to set or display whether UFS WriteBooster is
1295 enabled. Echo 0 to this file to disable UFS WriteBooster or 1 to
1296 enable it. The WriteBooster is enabled after power-on/reset,
1297 however, it will be disabled/enable while CLK scaling down/up
1298 (if the platform supports UFSHCD_CAP_CLK_SCALING). For a
1299 platform that doesn't support UFSHCD_CAP_CLK_SCALING, we can
1300 disable/enable WriteBooster through this sysfs node.
1302 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_version
1304 Contact: Daejun Park <daejun7.park@samsung.com>
1305 Description: This entry shows the HPB specification version.
1306 The full information about the descriptor can be found in the UFS
1307 HPB (Host Performance Booster) Extension specifications.
1308 Example: version 1.2.3 = 0123h
1310 The file is read only.
1312 What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_control
1314 Contact: Daejun Park <daejun7.park@samsung.com>
1315 Description: This entry shows an indication of the HPB control mode.
1316 00h: Host control mode
1317 01h: Device control mode
1319 The file is read only.
1321 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_region_size
1323 Contact: Daejun Park <daejun7.park@samsung.com>
1324 Description: This entry shows the bHPBRegionSize which can be calculated
1325 as in the following (in bytes):
1326 HPB Region size = 512B * 2^bHPBRegionSize
1328 The file is read only.
1330 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_number_lu
1332 Contact: Daejun Park <daejun7.park@samsung.com>
1333 Description: This entry shows the maximum number of HPB LU supported by
1335 00h: HPB is not supported by the device.
1336 01h ~ 20h: Maximum number of HPB LU supported by the device
1338 The file is read only.
1340 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_subregion_size
1342 Contact: Daejun Park <daejun7.park@samsung.com>
1343 Description: This entry shows the bHPBSubRegionSize, which can be
1344 calculated as in the following (in bytes) and shall be a multiple of
1346 HPB Sub-Region size = 512B x 2^bHPBSubRegionSize
1347 bHPBSubRegionSize shall not exceed bHPBRegionSize.
1349 The file is read only.
1351 What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/hpb_max_active_regions
1353 Contact: Daejun Park <daejun7.park@samsung.com>
1354 Description: This entry shows the maximum number of active HPB regions that
1355 is supported by the device.
1357 The file is read only.
1359 What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_lu_max_active_regions
1361 Contact: Daejun Park <daejun7.park@samsung.com>
1362 Description: This entry shows the maximum number of HPB regions assigned to
1363 the HPB logical unit.
1365 The file is read only.
1367 What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_pinned_region_start_offset
1369 Contact: Daejun Park <daejun7.park@samsung.com>
1370 Description: This entry shows the start offset of HPB pinned region.
1372 The file is read only.
1374 What: /sys/class/scsi_device/*/device/unit_descriptor/hpb_number_pinned_regions
1376 Contact: Daejun Park <daejun7.park@samsung.com>
1377 Description: This entry shows the number of HPB pinned regions assigned to
1378 the HPB logical unit.
1380 The file is read only.
1382 What: /sys/class/scsi_device/*/device/hpb_stats/hit_cnt
1384 Contact: Daejun Park <daejun7.park@samsung.com>
1385 Description: This entry shows the number of reads that changed to HPB read.
1387 The file is read only.
1389 What: /sys/class/scsi_device/*/device/hpb_stats/miss_cnt
1391 Contact: Daejun Park <daejun7.park@samsung.com>
1392 Description: This entry shows the number of reads that cannot be changed to
1395 The file is read only.
1397 What: /sys/class/scsi_device/*/device/hpb_stats/rb_noti_cnt
1399 Contact: Daejun Park <daejun7.park@samsung.com>
1400 Description: This entry shows the number of response UPIUs that has
1401 recommendations for activating sub-regions and/or inactivating region.
1403 The file is read only.
1405 What: /sys/class/scsi_device/*/device/hpb_stats/rb_active_cnt
1407 Contact: Daejun Park <daejun7.park@samsung.com>
1408 Description: This entry shows the number of active sub-regions recommended by
1411 The file is read only.
1413 What: /sys/class/scsi_device/*/device/hpb_stats/rb_inactive_cnt
1415 Contact: Daejun Park <daejun7.park@samsung.com>
1416 Description: This entry shows the number of inactive regions recommended by
1419 The file is read only.
1421 What: /sys/class/scsi_device/*/device/hpb_stats/map_req_cnt
1423 Contact: Daejun Park <daejun7.park@samsung.com>
1424 Description: This entry shows the number of read buffer commands for
1425 activating sub-regions recommended by response UPIUs.
1427 The file is read only.
1429 What: /sys/class/scsi_device/*/device/hpb_params/requeue_timeout_ms
1431 Contact: Daejun Park <daejun7.park@samsung.com>
1432 Description: This entry shows the requeue timeout threshold for write buffer
1433 command in ms. The value can be changed by writing an integer to
1436 What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_size_hpb_single_cmd
1438 Contact: Daejun Park <daejun7.park@samsung.com>
1439 Description: This entry shows the maximum HPB data size for using a single HPB
1450 The file is read only.
1452 What: /sys/bus/platform/drivers/ufshcd/*/flags/hpb_enable
1454 Contact: Daejun Park <daejun7.park@samsung.com>
1455 Description: This entry shows the status of HPB.
1457 == ============================
1458 0 HPB is not enabled.
1460 == ============================
1462 The file is read only.
1464 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/activation_thld
1466 Contact: Avri Altman <avri.altman@wdc.com>
1467 Description: In host control mode, reads are the major source of activation
1468 trials. Once this threshold hs met, the region is added to the
1469 "to-be-activated" list. Since we reset the read counter upon
1470 write, this include sending a rb command updating the region
1473 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/normalization_factor
1475 Contact: Avri Altman <avri.altman@wdc.com>
1476 Description: In host control mode, we think of the regions as "buckets".
1477 Those buckets are being filled with reads, and emptied on write.
1478 We use entries_per_srgn - the amount of blocks in a subregion as
1479 our bucket size. This applies because HPB1.0 only handles
1480 single-block reads. Once the bucket size is crossed, we trigger
1481 a normalization work - not only to avoid overflow, but mainly
1482 because we want to keep those counters normalized, as we are
1483 using those reads as a comparative score, to make various decisions.
1484 The normalization is dividing (shift right) the read counter by
1485 the normalization_factor. If during consecutive normalizations
1486 an active region has exhausted its reads - inactivate it.
1488 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_enter
1490 Contact: Avri Altman <avri.altman@wdc.com>
1491 Description: Region deactivation is often due to the fact that eviction took
1492 place: A region becomes active at the expense of another. This is
1493 happening when the max-active-regions limit has been crossed.
1494 In host mode, eviction is considered an extreme measure. We
1495 want to verify that the entering region has enough reads, and
1496 the exiting region has much fewer reads. eviction_thld_enter is
1497 the min reads that a region must have in order to be considered
1498 a candidate for evicting another region.
1500 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/eviction_thld_exit
1502 Contact: Avri Altman <avri.altman@wdc.com>
1503 Description: Same as above for the exiting region. A region is considered to
1504 be a candidate for eviction only if it has fewer reads than
1507 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_ms
1509 Contact: Avri Altman <avri.altman@wdc.com>
1510 Description: In order not to hang on to "cold" regions, we inactivate
1511 a region that has no READ access for a predefined amount of
1512 time - read_timeout_ms. If read_timeout_ms has expired, and the
1513 region is dirty, it is less likely that we can make any use of
1514 HPB reading it so we inactivate it. Still, deactivation has
1515 its overhead, and we may still benefit from HPB reading this
1516 region if it is clean - see read_timeout_expiries.
1518 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/read_timeout_expiries
1520 Contact: Avri Altman <avri.altman@wdc.com>
1521 Description: If the region read timeout has expired, but the region is clean,
1522 just re-wind its timer for another spin. Do that as long as it
1523 is clean and did not exhaust its read_timeout_expiries threshold.
1525 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/timeout_polling_interval_ms
1527 Contact: Avri Altman <avri.altman@wdc.com>
1528 Description: The frequency with which the delayed worker that checks the
1529 read_timeouts is awakened.
1531 What: /sys/class/scsi_device/*/device/hpb_param_sysfs/inflight_map_req
1533 Contact: Avri Altman <avri.altman@wdc.com>
1534 Description: In host control mode the host is the originator of map requests.
1535 To avoid flooding the device with map requests, use a simple throttling
1536 mechanism that limits the number of inflight map requests.