Merge tag 'trace-printf-v6.13' of git://git.kernel.org/pub/scm/linux/kernel/git/trace...
[drm/drm-misc.git] / Documentation / ABI / testing / sysfs-driver-ufs
blob5fa6655aee84090d302f64bd6a31b277018e230b
1 What:           /sys/bus/*/drivers/ufshcd/*/auto_hibern8
2 Date:           March 2018
3 Contact:        linux-scsi@vger.kernel.org
4 Description:
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
16 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/device_type
17 Date:           February 2018
18 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
19 Description:    This file shows the device type. This is one of the UFS
20                 device descriptor parameters. The full information about
21                 the descriptor could be found at UFS specifications 2.1.
23                 The file is read only.
25 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class
26 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/device_class
27 Date:           February 2018
28 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
29 Description:    This file shows the device class. This is one of the UFS
30                 device descriptor parameters. The full information about
31                 the descriptor could be found at UFS specifications 2.1.
33                 The file is read only.
35 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class
36 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/device_sub_class
37 Date:           February 2018
38 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
39 Description:    This file shows the UFS storage subclass. This is one of
40                 the UFS device descriptor parameters. The full information
41                 about the descriptor could be found at UFS specifications 2.1.
43                 The file is read only.
45 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol
46 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/protocol
47 Date:           February 2018
48 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
49 Description:    This file shows the protocol supported by an UFS device.
50                 This is one of the UFS device descriptor parameters.
51                 The full information about the descriptor could be found
52                 at UFS specifications 2.1.
54                 The file is read only.
56 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns
57 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/number_of_luns
58 Date:           February 2018
59 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
60 Description:    This file shows number of logical units. This is one of
61                 the UFS device descriptor parameters. The full information
62                 about the descriptor could be found at UFS specifications 2.1.
64                 The file is read only.
66 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns
67 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/number_of_wluns
68 Date:           February 2018
69 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
70 Description:    This file shows number of well known logical units.
71                 This is one of the UFS device descriptor parameters.
72                 The full information about the descriptor could be found
73                 at UFS specifications 2.1.
75                 The file is read only.
77 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable
78 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/boot_enable
79 Date:           February 2018
80 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
81 Description:    This file shows value that indicates whether the device is
82                 enabled for boot. This is one of the UFS device descriptor
83                 parameters. The full information about the descriptor could
84                 be found at UFS specifications 2.1.
86                 The file is read only.
88 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable
89 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/descriptor_access_enable
90 Date:           February 2018
91 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
92 Description:    This file shows value that indicates whether the device
93                 descriptor could be read after partial initialization phase
94                 of the boot sequence. This is one of the UFS device descriptor
95                 parameters. The full information about the descriptor could
96                 be found at UFS specifications 2.1.
98                 The file is read only.
100 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode
101 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/initial_power_mode
102 Date:           February 2018
103 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
104 Description:    This file shows value that defines the power mode after
105                 device initialization or hardware reset. 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/high_priority_lun
112 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/high_priority_lun
113 Date:           February 2018
114 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
115 Description:    This file shows the high priority lun. This is one of
116                 the UFS device descriptor parameters. The full information
117                 about the descriptor could be found at UFS specifications 2.1.
119                 The file is read only.
121 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type
122 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/secure_removal_type
123 Date:           February 2018
124 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
125 Description:    This file shows the secure removal type. This is one of
126                 the UFS device descriptor parameters. The full information
127                 about the descriptor could be found at UFS specifications 2.1.
129                 The file is read only.
131 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun
132 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/support_security_lun
133 Date:           February 2018
134 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
135 Description:    This file shows whether the security lun is supported.
136                 This is one of the UFS device descriptor parameters.
137                 The full information about the descriptor could be found
138                 at UFS specifications 2.1.
140                 The file is read only.
142 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency
143 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/bkops_termination_latency
144 Date:           February 2018
145 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
146 Description:    This file shows the background operations termination
147                 latency. This is one of the UFS device descriptor parameters.
148                 The full information about the descriptor could be found
149                 at UFS specifications 2.1.
151                 The file is read only.
153 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level
154 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/initial_active_icc_level
155 Date:           February 2018
156 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
157 Description:    This file shows the initial active ICC level. This is one
158                 of the UFS device descriptor parameters. The full information
159                 about the descriptor could be found at UFS specifications 2.1.
161                 The file is read only.
163 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version
164 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/specification_version
165 Date:           February 2018
166 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
167 Description:    This file shows the specification version. This is one
168                 of the UFS device descriptor parameters. The full information
169                 about the descriptor could be found at UFS specifications 2.1.
171                 The file is read only.
173 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date
174 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/manufacturing_date
175 Date:           February 2018
176 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
177 Description:    This file shows the manufacturing date in BCD format.
178                 This is one of the UFS device descriptor parameters.
179                 The full information about the descriptor could be found
180                 at UFS specifications 2.1.
182                 The file is read only.
184 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id
185 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/manufacturer_id
186 Date:           February 2018
187 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
188 Description:    This file shows the manufacturer ID. This is one of the
189                 UFS device descriptor parameters. The full information about
190                 the descriptor could be found at UFS specifications 2.1.
192                 The file is read only.
194 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability
195 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/rtt_capability
196 Date:           February 2018
197 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
198 Description:    This file shows the maximum number of outstanding RTTs
199                 supported by the device. This is one of the UFS device
200                 descriptor parameters. The full information about
201                 the descriptor could be found at UFS specifications 2.1.
203                 The file is read only.
205 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update
206 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/rtc_update
207 Date:           February 2018
208 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
209 Description:    This file shows the frequency and method of the realtime
210                 clock update. This is one of the UFS device descriptor
211                 parameters. The full information about the descriptor
212                 could be found at UFS specifications 2.1.
214                 The file is read only.
216 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features
217 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/ufs_features
218 Date:           February 2018
219 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
220 Description:    This file shows which features are supported by the device.
221                 This is one of the UFS device descriptor parameters.
222                 The full information about the descriptor could be
223                 found at UFS specifications 2.1.
225                 The file is read only.
227 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout
228 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/ffu_timeout
229 Date:           February 2018
230 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
231 Description:    This file shows the FFU timeout. This is one of the
232                 UFS device descriptor parameters. The full information
233                 about the descriptor could be found at UFS specifications 2.1.
235                 The file is read only.
237 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth
238 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/queue_depth
239 Date:           February 2018
240 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
241 Description:    This file shows the device queue depth. This is one of the
242                 UFS device descriptor parameters. The full information
243                 about the descriptor could be found at UFS specifications 2.1.
245                 The file is read only.
247 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version
248 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/device_version
249 Date:           February 2018
250 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
251 Description:    This file shows the device version. This is one of the
252                 UFS device descriptor parameters. The full information
253                 about the descriptor could be found at UFS specifications 2.1.
255                 The file is read only.
257 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa
258 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/number_of_secure_wpa
259 Date:           February 2018
260 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
261 Description:    This file shows number of secure write protect areas
262                 supported by the device. This is one of the UFS device
263                 descriptor parameters. The full information about
264                 the descriptor could be found at UFS specifications 2.1.
266                 The file is read only.
268 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size
269 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/psa_max_data_size
270 Date:           February 2018
271 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
272 Description:    This file shows the maximum amount of data that may be
273                 written during the pre-soldering phase of the PSA flow.
274                 This is one of the UFS device descriptor parameters.
275                 The full information about the descriptor could be found
276                 at UFS specifications 2.1.
278                 The file is read only.
280 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout
281 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/psa_state_timeout
282 Date:           February 2018
283 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
284 Description:    This file shows the command maximum timeout for a change
285                 in PSA state. This is one of the UFS device descriptor
286                 parameters. The full information about the descriptor could
287                 be found at UFS specifications 2.1.
289                 The file is read only.
292 What:           /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/unipro_version
293 What:           /sys/bus/platform/devices/*.ufs/interconnect_descriptor/unipro_version
294 Date:           February 2018
295 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
296 Description:    This file shows the MIPI UniPro version number in BCD format.
297                 This is one of the UFS interconnect descriptor parameters.
298                 The full information about the descriptor could be found at
299                 UFS specifications 2.1.
301                 The file is read only.
303 What:           /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version
304 What:           /sys/bus/platform/devices/*.ufs/interconnect_descriptor/mphy_version
305 Date:           February 2018
306 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
307 Description:    This file shows the MIPI M-PHY version number in BCD format.
308                 This is one of the UFS interconnect descriptor parameters.
309                 The full information about the descriptor could be found at
310                 UFS specifications 2.1.
312                 The file is read only.
315 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/raw_device_capacity
316 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/raw_device_capacity
317 Date:           February 2018
318 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
319 Description:    This file shows the total memory quantity available to
320                 the user to configure the device logical units. This is one
321                 of the UFS geometry descriptor parameters. The full
322                 information about the descriptor could be found at
323                 UFS specifications 2.1.
325                 The file is read only.
327 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns
328 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/max_number_of_luns
329 Date:           February 2018
330 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
331 Description:    This file shows the maximum number of logical units
332                 supported by the UFS device. This is one of the UFS
333                 geometry descriptor parameters. The full information about
334                 the descriptor could be found at UFS specifications 2.1.
336                 The file is read only.
338 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size
339 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/segment_size
340 Date:           February 2018
341 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
342 Description:    This file shows the segment size. This is one of the UFS
343                 geometry descriptor parameters. The full information about
344                 the descriptor could be found at UFS specifications 2.1.
346                 The file is read only.
348 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size
349 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/allocation_unit_size
350 Date:           February 2018
351 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
352 Description:    This file shows the allocation unit size. This is one of
353                 the UFS geometry descriptor parameters. The full information
354                 about the descriptor could be found at UFS specifications 2.1.
356                 The file is read only.
358 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size
359 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/min_addressable_block_size
360 Date:           February 2018
361 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
362 Description:    This file shows the minimum addressable block size. This
363                 is one of the UFS geometry descriptor parameters. The full
364                 information about the descriptor could be found at UFS
365                 specifications 2.1.
367                 The file is read only.
369 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size
370 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/optimal_read_block_size
371 Date:           February 2018
372 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
373 Description:    This file shows the optimal read block size. This is one
374                 of the UFS geometry descriptor parameters. The full
375                 information about the descriptor could be found at UFS
376                 specifications 2.1.
378                 The file is read only.
380 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size
381 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/optimal_write_block_size
382 Date:           February 2018
383 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
384 Description:    This file shows the optimal write block size. This is one
385                 of the UFS geometry descriptor parameters. The full
386                 information about the descriptor could be found at UFS
387                 specifications 2.1.
389                 The file is read only.
391 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size
392 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/max_in_buffer_size
393 Date:           February 2018
394 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
395 Description:    This file shows the maximum data-in buffer size. This
396                 is one of the UFS geometry descriptor parameters. The full
397                 information about the descriptor could be found at UFS
398                 specifications 2.1.
400                 The file is read only.
402 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size
403 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/max_out_buffer_size
404 Date:           February 2018
405 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
406 Description:    This file shows the maximum data-out buffer size. This
407                 is one of the UFS geometry descriptor parameters. The full
408                 information about the descriptor could be found at UFS
409                 specifications 2.1.
411                 The file is read only.
413 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size
414 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/rpmb_rw_size
415 Date:           February 2018
416 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
417 Description:    This file shows the maximum number of RPMB frames allowed
418                 in Security Protocol In/Out. This is one of the UFS geometry
419                 descriptor parameters. The full information about the
420                 descriptor could be found at UFS specifications 2.1.
422                 The file is read only.
424 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy
425 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/dyn_capacity_resource_policy
426 Date:           February 2018
427 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
428 Description:    This file shows the dynamic capacity resource policy. This
429                 is one of the UFS geometry descriptor parameters. The full
430                 information about the descriptor could be found at
431                 UFS specifications 2.1.
433                 The file is read only.
435 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering
436 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/data_ordering
437 Date:           February 2018
438 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
439 Description:    This file shows support for out-of-order data transfer.
440                 This is one of the UFS geometry descriptor parameters.
441                 The full 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/max_number_of_contexts
447 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/max_number_of_contexts
448 Date:           February 2018
449 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
450 Description:    This file shows maximum available number of contexts which
451                 are supported by the device. This is one of the UFS geometry
452                 descriptor parameters. The full information about the
453                 descriptor could be found at UFS specifications 2.1.
455                 The file is read only.
457 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size
458 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/sys_data_tag_unit_size
459 Date:           February 2018
460 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
461 Description:    This file shows system data tag unit size. This is one of
462                 the UFS geometry descriptor parameters. The full information
463                 about the descriptor could be found at UFS specifications 2.1.
465                 The file is read only.
467 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size
468 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/sys_data_tag_resource_size
469 Date:           February 2018
470 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
471 Description:    This file shows maximum storage area size allocated by
472                 the device to handle system data by the tagging mechanism.
473                 This is one of the UFS geometry descriptor parameters.
474                 The full information about the descriptor could be found at
475                 UFS specifications 2.1.
477                 The file is read only.
479 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types
480 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/secure_removal_types
481 Date:           February 2018
482 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
483 Description:    This file shows supported secure removal types. This is
484                 one of the UFS geometry descriptor parameters. The full
485                 information about the descriptor could be found at
486                 UFS specifications 2.1.
488                 The file is read only.
490 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types
491 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/memory_types
492 Date:           February 2018
493 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
494 Description:    This file shows supported memory types. This is one of
495                 the UFS geometry descriptor parameters. The full
496                 information about the descriptor could be found at
497                 UFS specifications 2.1.
499                 The file is read only.
501 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units
502 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/*_memory_max_alloc_units
503 Date:           February 2018
504 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
505 Description:    This file shows the maximum number of allocation units for
506                 different memory types (system code, non persistent,
507                 enhanced type 1-4). This is one of the UFS geometry
508                 descriptor parameters. The full information about the
509                 descriptor could be found at UFS specifications 2.1.
511                 The file is read only.
513 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor
514 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/*_memory_capacity_adjustment_factor
515 Date:           February 2018
516 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
517 Description:    This file shows the memory capacity adjustment factor for
518                 different memory types (system code, non persistent,
519                 enhanced type 1-4). This is one of the UFS geometry
520                 descriptor parameters. The full information about the
521                 descriptor could be found at UFS specifications 2.1.
523                 The file is read only.
526 What:           /sys/bus/platform/drivers/ufshcd/*/health_descriptor/eol_info
527 What:           /sys/bus/platform/devices/*.ufs/health_descriptor/eol_info
528 Date:           February 2018
529 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
530 Description:    This file shows preend of life information. This is one
531                 of the UFS health descriptor parameters. The full
532                 information about the descriptor could be found at
533                 UFS specifications 2.1.
535                 The file is read only.
537 What:           /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a
538 What:           /sys/bus/platform/devices/*.ufs/health_descriptor/life_time_estimation_a
539 Date:           February 2018
540 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
541 Description:    This file shows indication of the device life time
542                 (method a). This is one of the UFS health descriptor
543                 parameters. The full information about the descriptor
544                 could be found at UFS specifications 2.1.
546                 The file is read only.
548 What:           /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b
549 What:           /sys/bus/platform/devices/*.ufs/health_descriptor/life_time_estimation_b
550 Date:           February 2018
551 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
552 Description:    This file shows indication of the device life time
553                 (method b). This is one of the UFS health descriptor
554                 parameters. The full information about the descriptor
555                 could be found at UFS specifications 2.1.
557                 The file is read only.
560 What:           /sys/bus/platform/drivers/ufshcd/*/power_descriptor/active_icc_levels_vcc*
561 What:           /sys/bus/platform/devices/*.ufs/power_descriptor/active_icc_levels_vcc*
562 Date:           February 2018
563 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
564 Description:    This file shows maximum VCC, VCCQ and VCCQ2 value for
565                 active ICC levels from 0 to 15. This is one of the UFS
566                 power descriptor parameters. The full information about
567                 the descriptor could be found at UFS specifications 2.1.
569                 The file is read only.
572 What:           /sys/bus/platform/drivers/ufshcd/*/string_descriptors/manufacturer_name
573 What:           /sys/bus/platform/devices/*.ufs/string_descriptors/manufacturer_name
574 Date:           February 2018
575 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
576 Description:    This file contains a device manufacturer name string.
577                 The full information about the descriptor could be found at
578                 UFS specifications 2.1.
580                 The file is read only.
582 What:           /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name
583 What:           /sys/bus/platform/devices/*.ufs/string_descriptors/product_name
584 Date:           February 2018
585 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
586 Description:    This file contains a product name string. The full information
587                 about the descriptor could be found at UFS specifications 2.1.
589                 The file is read only.
591 What:           /sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id
592 What:           /sys/bus/platform/devices/*.ufs/string_descriptors/oem_id
593 Date:           February 2018
594 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
595 Description:    This file contains a OEM ID string. The full information
596                 about the descriptor could be found at UFS specifications 2.1.
598                 The file is read only.
600 What:           /sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number
601 What:           /sys/bus/platform/devices/*.ufs/string_descriptors/serial_number
602 Date:           February 2018
603 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
604 Description:    This file contains a device serial number string. The full
605                 information about the descriptor could be found at
606                 UFS specifications 2.1.
608                 The file is read only.
610 What:           /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision
611 What:           /sys/bus/platform/devices/*.ufs/string_descriptors/product_revision
612 Date:           February 2018
613 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
614 Description:    This file contains a product revision string. The full
615                 information about the descriptor could be found at
616                 UFS specifications 2.1.
618                 The file is read only.
621 What:           /sys/class/scsi_device/*/device/unit_descriptor/boot_lun_id
622 Date:           February 2018
623 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
624 Description:    This file shows boot LUN information. This is one of
625                 the UFS unit descriptor parameters. The full information
626                 about 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/lun_write_protect
631 Date:           February 2018
632 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
633 Description:    This file shows LUN write protection status. This is one of
634                 the UFS unit descriptor parameters. The full information
635                 about the descriptor could be found at UFS specifications 2.1.
637                 The file is read only.
639 What:           /sys/class/scsi_device/*/device/unit_descriptor/lun_queue_depth
640 Date:           February 2018
641 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
642 Description:    This file shows LUN queue depth. This is one of the UFS
643                 unit descriptor parameters. The full information about
644                 the descriptor could be found at UFS specifications 2.1.
646                 The file is read only.
648 What:           /sys/class/scsi_device/*/device/unit_descriptor/psa_sensitive
649 Date:           February 2018
650 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
651 Description:    This file shows PSA sensitivity. This is one of the UFS
652                 unit descriptor parameters. The full information about
653                 the descriptor could be found at UFS specifications 2.1.
655                 The file is read only.
657 What:           /sys/class/scsi_device/*/device/unit_descriptor/lun_memory_type
658 Date:           February 2018
659 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
660 Description:    This file shows LUN memory type. This is one of the UFS
661                 unit descriptor parameters. The full information about
662                 the descriptor could be found at UFS specifications 2.1.
664                 The file is read only.
666 What:           /sys/class/scsi_device/*/device/unit_descriptor/data_reliability
667 Date:           February 2018
668 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
669 Description:    This file defines the device behavior when a power failure
670                 occurs during a write operation. This is one of the UFS
671                 unit descriptor parameters. The full information about
672                 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/logical_block_size
677 Date:           February 2018
678 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
679 Description:    This file shows the size of addressable logical blocks
680                 (calculated as an exponent with base 2). This is one of
681                 the UFS unit descriptor parameters. The full information about
682                 the descriptor could be found at UFS specifications 2.1.
684                 The file is read only.
686 What:           /sys/class/scsi_device/*/device/unit_descriptor/logical_block_count
687 Date:           February 2018
688 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
689 Description:    This file shows total number of addressable logical blocks.
690                 This is one of the UFS unit descriptor parameters. The full
691                 information about the descriptor could be found at
692                 UFS specifications 2.1.
694                 The file is read only.
696 What:           /sys/class/scsi_device/*/device/unit_descriptor/erase_block_size
697 Date:           February 2018
698 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
699 Description:    This file shows the erase block size. This is one of
700                 the UFS unit descriptor parameters. The full information
701                 about the descriptor could be found at UFS specifications 2.1.
703                 The file is read only.
705 What:           /sys/class/scsi_device/*/device/unit_descriptor/provisioning_type
706 Date:           February 2018
707 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
708 Description:    This file shows the thin provisioning type. This is one of
709                 the UFS unit descriptor parameters. The full information
710                 about the descriptor could be found at UFS specifications 2.1.
712                 The file is read only.
714 What:           /sys/class/scsi_device/*/device/unit_descriptor/physical_memory_resourse_count
715 Date:           February 2018
716 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
717 Description:    This file shows the total physical memory resources. This is
718                 one of the UFS unit descriptor parameters. The full information
719                 about the descriptor could be found at UFS specifications 2.1.
721                 The file is read only.
723 What:           /sys/class/scsi_device/*/device/unit_descriptor/context_capabilities
724 Date:           February 2018
725 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
726 Description:    This file shows the context capabilities. This is one of
727                 the UFS unit descriptor parameters. The full information
728                 about the descriptor could be found at UFS specifications 2.1.
730                 The file is read only.
732 What:           /sys/class/scsi_device/*/device/unit_descriptor/large_unit_granularity
733 Date:           February 2018
734 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
735 Description:    This file shows the granularity of the LUN. This is one of
736                 the UFS unit descriptor parameters. The full information
737                 about the descriptor could be found at UFS specifications 2.1.
739                 The file is read only.
742 What:           /sys/bus/platform/drivers/ufshcd/*/flags/device_init
743 What:           /sys/bus/platform/devices/*.ufs/flags/device_init
744 Date:           February 2018
745 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
746 Description:    This file shows the device init status. The full information
747                 about the flag could be found at UFS specifications 2.1.
749                 The file is read only.
751 What:           /sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe
752 What:           /sys/bus/platform/devices/*.ufs/flags/permanent_wpe
753 Date:           February 2018
754 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
755 Description:    This file shows whether permanent write protection is enabled.
756                 The full information about the flag could be found at
757                 UFS specifications 2.1.
759                 The file is read only.
761 What:           /sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe
762 What:           /sys/bus/platform/devices/*.ufs/flags/power_on_wpe
763 Date:           February 2018
764 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
765 Description:    This file shows whether write protection is enabled on all
766                 logical units configured as power on write protected. The
767                 full information about the flag could be found at
768                 UFS specifications 2.1.
770                 The file is read only.
772 What:           /sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable
773 What:           /sys/bus/platform/devices/*.ufs/flags/bkops_enable
774 Date:           February 2018
775 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
776 Description:    This file shows whether the device background operations are
777                 enabled. The full information about the flag could be
778                 found at UFS specifications 2.1.
780                 The file is read only.
782 What:           /sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable
783 What:           /sys/bus/platform/devices/*.ufs/flags/life_span_mode_enable
784 Date:           February 2018
785 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
786 Description:    This file shows whether the device life span mode is enabled.
787                 The full information about the flag could be found at
788                 UFS specifications 2.1.
790                 The file is read only.
792 What:           /sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal
793 What:           /sys/bus/platform/devices/*.ufs/flags/phy_resource_removal
794 Date:           February 2018
795 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
796 Description:    This file shows whether physical resource removal is enable.
797                 The full information about the flag could be found at
798                 UFS specifications 2.1.
800                 The file is read only.
802 What:           /sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc
803 What:           /sys/bus/platform/devices/*.ufs/flags/busy_rtc
804 Date:           February 2018
805 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
806 Description:    This file shows whether the device is executing internal
807                 operation related to real time clock. The full information
808                 about the flag could be found at UFS specifications 2.1.
810                 The file is read only.
812 What:           /sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update
813 What:           /sys/bus/platform/devices/*.ufs/flags/disable_fw_update
814 Date:           February 2018
815 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
816 Description:    This file shows whether the device FW update is permanently
817                 disabled. The full information about the flag could be found
818                 at UFS specifications 2.1.
820                 The file is read only.
823 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/boot_lun_enabled
824 What:           /sys/bus/platform/devices/*.ufs/attributes/boot_lun_enabled
825 Date:           February 2018
826 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
827 Description:    This file provides the boot lun enabled UFS device attribute.
828                 The full information about the attribute could be found at
829                 UFS specifications 2.1.
831                 The file is read only.
833 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode
834 What:           /sys/bus/platform/devices/*.ufs/attributes/current_power_mode
835 Date:           February 2018
836 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
837 Description:    This file provides the current power mode UFS device attribute.
838                 The full information about the attribute could be found at
839                 UFS specifications 2.1.
841                 The file is read only.
843 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level
844 What:           /sys/bus/platform/devices/*.ufs/attributes/active_icc_level
845 Date:           February 2018
846 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
847 Description:    This file provides the active icc level UFS device attribute.
848                 The full information about the attribute could be found at
849                 UFS specifications 2.1.
851                 The file is read only.
853 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled
854 What:           /sys/bus/platform/devices/*.ufs/attributes/ooo_data_enabled
855 Date:           February 2018
856 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
857 Description:    This file provides the out of order data transfer enabled UFS
858                 device attribute. The full information about the attribute
859                 could be found at UFS specifications 2.1.
861                 The file is read only.
863 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status
864 What:           /sys/bus/platform/devices/*.ufs/attributes/bkops_status
865 Date:           February 2018
866 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
867 Description:    This file provides the background operations status UFS device
868                 attribute. The full information about the attribute could
869                 be found at UFS specifications 2.1.
871                 The file is read only.
873 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/purge_status
874 What:           /sys/bus/platform/devices/*.ufs/attributes/purge_status
875 Date:           February 2018
876 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
877 Description:    This file provides the purge operation status UFS device
878                 attribute. The full information about the attribute could
879                 be found at UFS specifications 2.1.
881                 The file is read only.
883 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size
884 What:           /sys/bus/platform/devices/*.ufs/attributes/max_data_in_size
885 Date:           February 2018
886 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
887 Description:    This file shows the maximum data size in a DATA IN
888                 UPIU. The full information about the attribute could
889                 be found at UFS specifications 2.1.
891                 The file is read only.
893 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size
894 What:           /sys/bus/platform/devices/*.ufs/attributes/max_data_out_size
895 Date:           February 2018
896 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
897 Description:    This file shows the maximum number of bytes that can be
898                 requested with a READY TO TRANSFER UPIU. The full information
899                 about the attribute could be found at UFS specifications 2.1.
901                 The file is read only.
903 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency
904 What:           /sys/bus/platform/devices/*.ufs/attributes/reference_clock_frequency
905 Date:           February 2018
906 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
907 Description:    This file provides the reference clock frequency UFS device
908                 attribute. The full information about the attribute could
909                 be found at UFS specifications 2.1.
911                 The file is read only.
913 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock
914 What:           /sys/bus/platform/devices/*.ufs/attributes/configuration_descriptor_lock
915 Date:           February 2018
916 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
917 Description:    This file shows whether the configuration descriptor is locked.
918                 The full information about the attribute could be found at
919                 UFS specifications 2.1. The file is read only.
921 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/max_number_of_rtt
922 What:           /sys/bus/platform/devices/*.ufs/attributes/max_number_of_rtt
923 Date:           May 2024
924 Contact:        Avri Altman <avri.altman@wdc.com>
925 Description:    This file provides the maximum current number of
926                 outstanding RTTs in device that is allowed. bMaxNumOfRTT is a
927                 read-write persistent attribute and is equal to two after device
928                 manufacturing. It shall not be set to a value greater than
929                 bDeviceRTTCap value, and it may be set only when the hw queues are
930                 empty.
932                 The file is read write.
934 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control
935 What:           /sys/bus/platform/devices/*.ufs/attributes/exception_event_control
936 Date:           February 2018
937 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
938 Description:    This file provides the exception event control UFS device
939                 attribute. The full information about the attribute could
940                 be found at UFS specifications 2.1.
942                 The file is read only.
944 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status
945 What:           /sys/bus/platform/devices/*.ufs/attributes/exception_event_status
946 Date:           February 2018
947 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
948 Description:    This file provides the exception event status UFS device
949                 attribute. The full information about the attribute could
950                 be found at UFS specifications 2.1.
952                 The file is read only.
954 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status
955 What:           /sys/bus/platform/devices/*.ufs/attributes/ffu_status
956 Date:           February 2018
957 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
958 Description:    This file provides the ffu status UFS device attribute.
959                 The full information about the attribute could be found at
960                 UFS specifications 2.1.
962                 The file is read only.
964 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/psa_state
965 What:           /sys/bus/platform/devices/*.ufs/attributes/psa_state
966 Date:           February 2018
967 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
968 Description:    This file show the PSA feature status. The full information
969                 about the attribute could be found at UFS specifications 2.1.
971                 The file is read only.
973 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size
974 What:           /sys/bus/platform/devices/*.ufs/attributes/psa_data_size
975 Date:           February 2018
976 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
977 Description:    This file shows the amount of data that the host plans to
978                 load to all logical units in pre-soldering state.
979                 The full information about the attribute could be found at
980                 UFS specifications 2.1.
982                 The file is read only.
985 What:           /sys/class/scsi_device/*/device/dyn_cap_needed
986 Date:           February 2018
987 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
988 Description:    This file shows the amount of physical memory needed
989                 to be removed from the physical memory resources pool of
990                 the particular logical unit. The full information about
991                 the attribute could be found at UFS specifications 2.1.
993                 The file is read only.
996 What:           /sys/bus/platform/drivers/ufshcd/*/rpm_lvl
997 What:           /sys/bus/platform/devices/*.ufs/rpm_lvl
998 Date:           September 2014
999 Contact:        Can Guo <quic_cang@quicinc.com>
1000 Description:    This entry could be used to set or show the UFS device
1001                 runtime power management level. The current driver
1002                 implementation supports 7 levels with next target states:
1004                 ==  ====================================================
1005                 0   UFS device will stay active, UIC link will
1006                     stay active
1007                 1   UFS device will stay active, UIC link will
1008                     hibernate
1009                 2   UFS device will be moved to sleep, UIC link will
1010                     stay active
1011                 3   UFS device will be moved to sleep, UIC link will
1012                     hibernate
1013                 4   UFS device will be powered off, UIC link will
1014                     hibernate
1015                 5   UFS device will be powered off, UIC link will
1016                     be powered off
1017                 6   UFS device will be moved to deep sleep, UIC link
1018                     will be powered off. Note, deep sleep might not be
1019                     supported in which case this value will not be
1020                     accepted
1021                 ==  ====================================================
1023 What:           /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
1024 What:           /sys/bus/platform/devices/*.ufs/rpm_target_dev_state
1025 Date:           February 2018
1026 Contact:        Can Guo <quic_cang@quicinc.com>
1027 Description:    This entry shows the target power mode of an UFS device
1028                 for the chosen runtime power management level.
1030                 The file is read only.
1032 What:           /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state
1033 What:           /sys/bus/platform/devices/*.ufs/rpm_target_link_state
1034 Date:           February 2018
1035 Contact:        Can Guo <quic_cang@quicinc.com>
1036 Description:    This entry shows the target state of an UFS UIC link
1037                 for the chosen runtime power management level.
1039                 The file is read only.
1041 What:           /sys/bus/platform/drivers/ufshcd/*/spm_lvl
1042 What:           /sys/bus/platform/devices/*.ufs/spm_lvl
1043 Date:           September 2014
1044 Contact:        Can Guo <quic_cang@quicinc.com>
1045 Description:    This entry could be used to set or show the UFS device
1046                 system power management level. The current driver
1047                 implementation supports 7 levels with next target states:
1049                 ==  ====================================================
1050                 0   UFS device will stay active, UIC link will
1051                     stay active
1052                 1   UFS device will stay active, UIC link will
1053                     hibernate
1054                 2   UFS device will be moved to sleep, UIC link will
1055                     stay active
1056                 3   UFS device will be moved to sleep, UIC link will
1057                     hibernate
1058                 4   UFS device will be powered off, UIC link will
1059                     hibernate
1060                 5   UFS device will be powered off, UIC link will
1061                     be powered off
1062                 6   UFS device will be moved to deep sleep, UIC link
1063                     will be powered off. Note, deep sleep might not be
1064                     supported in which case this value will not be
1065                     accepted
1066                 ==  ====================================================
1068 What:           /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
1069 What:           /sys/bus/platform/devices/*.ufs/spm_target_dev_state
1070 Date:           February 2018
1071 Contact:        Can Guo <quic_cang@quicinc.com>
1072 Description:    This entry shows the target power mode of an UFS device
1073                 for the chosen system power management level.
1075                 The file is read only.
1077 What:           /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state
1078 What:           /sys/bus/platform/devices/*.ufs/spm_target_link_state
1079 Date:           February 2018
1080 Contact:        Can Guo <quic_cang@quicinc.com>
1081 Description:    This entry shows the target state of an UFS UIC link
1082                 for the chosen system power management level.
1084                 The file is read only.
1086 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable
1087 What:           /sys/bus/platform/devices/*.ufs/monitor/monitor_enable
1088 Date:           January 2021
1089 Contact:        Can Guo <quic_cang@quicinc.com>
1090 Description:    This file shows the status of performance monitor enablement
1091                 and it can be used to start/stop the monitor. When the monitor
1092                 is stopped, the performance data collected is also cleared.
1094 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size
1095 What:           /sys/bus/platform/devices/*.ufs/monitor/monitor_chunk_size
1096 Date:           January 2021
1097 Contact:        Can Guo <quic_cang@quicinc.com>
1098 Description:    This file tells the monitor to focus on requests transferring
1099                 data of specific chunk size (in Bytes). 0 means any chunk size.
1100                 It can only be changed when monitor is disabled.
1102 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors
1103 What:           /sys/bus/platform/devices/*.ufs/monitor/read_total_sectors
1104 Date:           January 2021
1105 Contact:        Can Guo <quic_cang@quicinc.com>
1106 Description:    This file shows how many sectors (in 512 Bytes) have been
1107                 sent from device to host after monitor gets started.
1109                 The file is read only.
1111 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy
1112 What:           /sys/bus/platform/devices/*.ufs/monitor/read_total_busy
1113 Date:           January 2021
1114 Contact:        Can Guo <quic_cang@quicinc.com>
1115 Description:    This file shows how long (in micro seconds) has been spent
1116                 sending data from device to host after monitor gets started.
1118                 The file is read only.
1120 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests
1121 What:           /sys/bus/platform/devices/*.ufs/monitor/read_nr_requests
1122 Date:           January 2021
1123 Contact:        Can Guo <quic_cang@quicinc.com>
1124 Description:    This file shows how many read requests have been sent after
1125                 monitor gets started.
1127                 The file is read only.
1129 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max
1130 What:           /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_max
1131 Date:           January 2021
1132 Contact:        Can Guo <quic_cang@quicinc.com>
1133 Description:    This file shows the maximum latency (in micro seconds) of
1134                 read requests after monitor gets started.
1136                 The file is read only.
1138 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min
1139 What:           /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_min
1140 Date:           January 2021
1141 Contact:        Can Guo <quic_cang@quicinc.com>
1142 Description:    This file shows the minimum latency (in micro seconds) of
1143                 read requests after monitor gets started.
1145                 The file is read only.
1147 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg
1148 What:           /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_avg
1149 Date:           January 2021
1150 Contact:        Can Guo <quic_cang@quicinc.com>
1151 Description:    This file shows the average latency (in micro seconds) of
1152                 read requests after monitor gets started.
1154                 The file is read only.
1156 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum
1157 What:           /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_sum
1158 Date:           January 2021
1159 Contact:        Can Guo <quic_cang@quicinc.com>
1160 Description:    This file shows the total latency (in micro seconds) of
1161                 read requests sent after monitor gets started.
1163                 The file is read only.
1165 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors
1166 What:           /sys/bus/platform/devices/*.ufs/monitor/write_total_sectors
1167 Date:           January 2021
1168 Contact:        Can Guo <quic_cang@quicinc.com>
1169 Description:    This file shows how many sectors (in 512 Bytes) have been sent
1170                 from host to device after monitor gets started.
1172                 The file is read only.
1174 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy
1175 What:           /sys/bus/platform/devices/*.ufs/monitor/write_total_busy
1176 Date:           January 2021
1177 Contact:        Can Guo <quic_cang@quicinc.com>
1178 Description:    This file shows how long (in micro seconds) has been spent
1179                 sending data from host to device after monitor gets started.
1181                 The file is read only.
1183 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests
1184 What:           /sys/bus/platform/devices/*.ufs/monitor/write_nr_requests
1185 Date:           January 2021
1186 Contact:        Can Guo <quic_cang@quicinc.com>
1187 Description:    This file shows how many write requests have been sent after
1188                 monitor gets started.
1190                 The file is read only.
1192 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max
1193 What:           /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_max
1194 Date:           January 2021
1195 Contact:        Can Guo <quic_cang@quicinc.com>
1196 Description:    This file shows the maximum latency (in micro seconds) of write
1197                 requests after monitor gets started.
1199                 The file is read only.
1201 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min
1202 What:           /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_min
1203 Date:           January 2021
1204 Contact:        Can Guo <quic_cang@quicinc.com>
1205 Description:    This file shows the minimum latency (in micro seconds) of write
1206                 requests after monitor gets started.
1208                 The file is read only.
1210 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg
1211 What:           /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_avg
1212 Date:           January 2021
1213 Contact:        Can Guo <quic_cang@quicinc.com>
1214 Description:    This file shows the average latency (in micro seconds) of write
1215                 requests after monitor gets started.
1217                 The file is read only.
1219 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum
1220 What:           /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_sum
1221 Date:           January 2021
1222 Contact:        Can Guo <quic_cang@quicinc.com>
1223 Description:    This file shows the total latency (in micro seconds) of write
1224                 requests after monitor gets started.
1226                 The file is read only.
1228 What:           /sys/bus/platform/drivers/ufshcd/*/power_info/lane
1229 What:           /sys/bus/platform/devices/*.ufs/power_info/lane
1230 Date:           September 2023
1231 Contact:        Can Guo <quic_cang@quicinc.com>
1232 Description:    This file shows how many lanes are enabled on the UFS link,
1233                 i.e., an output 2 means UFS link is operating with 2 lanes.
1235                 The file is read only.
1237 What:           /sys/bus/platform/drivers/ufshcd/*/power_info/mode
1238 What:           /sys/bus/platform/devices/*.ufs/power_info/mode
1239 Date:           September 2023
1240 Contact:        Can Guo <quic_cang@quicinc.com>
1241 Description:    This file shows the PA power mode of UFS.
1243                 The file is read only.
1245 What:           /sys/bus/platform/drivers/ufshcd/*/power_info/rate
1246 What:           /sys/bus/platform/devices/*.ufs/power_info/rate
1247 Date:           September 2023
1248 Contact:        Can Guo <quic_cang@quicinc.com>
1249 Description:    This file shows the speed rate of UFS link.
1251                 The file is read only.
1253 What:           /sys/bus/platform/drivers/ufshcd/*/power_info/gear
1254 What:           /sys/bus/platform/devices/*.ufs/power_info/gear
1255 Date:           September 2023
1256 Contact:        Can Guo <quic_cang@quicinc.com>
1257 Description:    This file shows the gear of UFS link.
1259                 The file is read only.
1261 What:           /sys/bus/platform/drivers/ufshcd/*/power_info/dev_pm
1262 What:           /sys/bus/platform/devices/*.ufs/power_info/dev_pm
1263 Date:           September 2023
1264 Contact:        Can Guo <quic_cang@quicinc.com>
1265 Description:    This file shows the UFS device power mode.
1267                 The file is read only.
1269 What:           /sys/bus/platform/drivers/ufshcd/*/power_info/link_state
1270 What:           /sys/bus/platform/devices/*.ufs/power_info/link_state
1271 Date:           September 2023
1272 Contact:        Can Guo <quic_cang@quicinc.com>
1273 Description:    This file shows the state of UFS link.
1275                 The file is read only.
1277 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
1278 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/wb_presv_us_en
1279 Date:           June 2020
1280 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1281 Description:    This entry shows if preserve user-space was configured
1283                 The file is read only.
1285 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units
1286 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/wb_shared_alloc_units
1287 Date:           June 2020
1288 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1289 Description:    This entry shows the shared allocated units of WB buffer
1291                 The file is read only.
1293 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type
1294 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/wb_type
1295 Date:           June 2020
1296 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1297 Description:    This entry shows the configured WB type.
1298                 0x1 for shared buffer mode. 0x0 for dedicated buffer mode.
1300                 The file is read only.
1302 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
1303 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_buff_cap_adj
1304 Date:           June 2020
1305 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1306 Description:    This entry shows the total user-space decrease in shared
1307                 buffer mode.
1308                 The value of this parameter is 3 for TLC NAND when SLC mode
1309                 is used as WriteBooster Buffer. 2 for MLC NAND.
1311                 The file is read only.
1313 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units
1314 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_max_alloc_units
1315 Date:           June 2020
1316 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1317 Description:    This entry shows the Maximum total WriteBooster Buffer size
1318                 which is supported by the entire device.
1320                 The file is read only.
1322 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
1323 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_max_wb_luns
1324 Date:           June 2020
1325 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1326 Description:    This entry shows the maximum number of luns that can support
1327                 WriteBooster.
1329                 The file is read only.
1331 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
1332 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_sup_red_type
1333 Date:           June 2020
1334 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1335 Description:    The supportability of user space reduction mode
1336                 and preserve user space mode.
1337                 00h: WriteBooster Buffer can be configured only in
1338                 user space reduction type.
1339                 01h: WriteBooster Buffer can be configured only in
1340                 preserve user space type.
1341                 02h: Device can be configured in either user space
1342                 reduction type or preserve user space type.
1344                 The file is read only.
1346 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
1347 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_sup_wb_type
1348 Date:           June 2020
1349 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1350 Description:    The supportability of WriteBooster Buffer type.
1352                 ===  ==========================================================
1353                 00h  LU based WriteBooster Buffer configuration
1354                 01h  Single shared WriteBooster Buffer configuration
1355                 02h  Supporting both LU based WriteBooster.
1356                      Buffer and Single shared WriteBooster Buffer configuration
1357                 ===  ==========================================================
1359                 The file is read only.
1361 What:           /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
1362 What:           /sys/bus/platform/devices/*.ufs/flags/wb_enable
1363 Date:           June 2020
1364 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1365 Description:    This entry shows the status of WriteBooster.
1367                 == ============================
1368                 0  WriteBooster is not enabled.
1369                 1  WriteBooster is enabled
1370                 == ============================
1372                 The file is read only.
1374 What:           /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
1375 What:           /sys/bus/platform/devices/*.ufs/flags/wb_flush_en
1376 Date:           June 2020
1377 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1378 Description:    This entry shows if flush is enabled.
1380                 == =================================
1381                 0  Flush operation is not performed.
1382                 1  Flush operation is performed.
1383                 == =================================
1385                 The file is read only.
1387 What:           /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8
1388 What:           /sys/bus/platform/devices/*.ufs/flags/wb_flush_during_h8
1389 Date:           June 2020
1390 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1391 Description:    Flush WriteBooster Buffer during hibernate state.
1393                 == =================================================
1394                 0  Device is not allowed to flush the
1395                    WriteBooster Buffer during link hibernate state.
1396                 1  Device is allowed to flush the
1397                    WriteBooster Buffer during link hibernate state.
1398                 == =================================================
1400                 The file is read only.
1402 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf
1403 What:           /sys/bus/platform/devices/*.ufs/attributes/wb_avail_buf
1404 Date:           June 2020
1405 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1406 Description:    This entry shows the amount of unused WriteBooster buffer
1407                 available.
1409                 The file is read only.
1411 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
1412 What:           /sys/bus/platform/devices/*.ufs/attributes/wb_cur_buf
1413 Date:           June 2020
1414 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1415 Description:    This entry shows the amount of unused current buffer.
1417                 The file is read only.
1419 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status
1420 What:           /sys/bus/platform/devices/*.ufs/attributes/wb_flush_status
1421 Date:           June 2020
1422 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1423 Description:    This entry shows the flush operation status.
1426                 ===  ======================================
1427                 00h  idle
1428                 01h  Flush operation in progress
1429                 02h  Flush operation stopped prematurely.
1430                 03h  Flush operation completed successfully
1431                 04h  Flush operation general failure
1432                 ===  ======================================
1434                 The file is read only.
1436 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est
1437 What:           /sys/bus/platform/devices/*.ufs/attributes/wb_life_time_est
1438 Date:           June 2020
1439 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1440 Description:    This entry shows an indication of the WriteBooster Buffer
1441                 lifetime based on the amount of performed program/erase cycles
1443                 ===  =============================================
1444                 01h  0% - 10% WriteBooster Buffer life time used
1445                 ...
1446                 0Ah  90% - 100% WriteBooster Buffer life time used
1447                 ===  =============================================
1449                 The file is read only.
1451 What:           /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
1452 Date:           June 2020
1453 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1454 Description:    This entry shows the configured size of WriteBooster buffer.
1455                 0400h corresponds to 4GB.
1457                 The file is read only.
1459 What:           /sys/bus/platform/drivers/ufshcd/*/wb_on
1460 What:           /sys/bus/platform/devices/*.ufs/wb_on
1461 Date:           January 2021
1462 Contact:        Bean Huo <beanhuo@micron.com>
1463 Description:    This node is used to set or display whether UFS WriteBooster is
1464                 enabled. Echo 0 to this file to disable UFS WriteBooster or 1 to
1465                 enable it. The WriteBooster is enabled after power-on/reset,
1466                 however, it will be disabled/enable while CLK scaling down/up
1467                 (if the platform supports UFSHCD_CAP_CLK_SCALING). For a
1468                 platform that doesn't support UFSHCD_CAP_CLK_SCALING, we can
1469                 disable/enable WriteBooster through this sysfs node.
1471 What:           /sys/bus/platform/drivers/ufshcd/*/enable_wb_buf_flush
1472 What:           /sys/bus/platform/devices/*.ufs/enable_wb_buf_flush
1473 Date:           July 2022
1474 Contact:        Jinyoung Choi <j-young.choi@samsung.com>
1475 Description:    This entry shows the status of WriteBooster buffer flushing
1476                 and it can be used to enable or disable the flushing.
1477                 If flushing is enabled, the device executes the flush
1478                 operation when the command queue is empty.
1480 What:           /sys/bus/platform/drivers/ufshcd/*/wb_flush_threshold
1481 What:           /sys/bus/platform/devices/*.ufs/wb_flush_threshold
1482 Date:           June 2023
1483 Contact:        Lu Hongfei <luhongfei@vivo.com>
1484 Description:
1485                 wb_flush_threshold represents the threshold for flushing WriteBooster buffer,
1486                 whose value expressed in unit of 10% granularity, such as '1' representing 10%,
1487                 '2' representing 20%, and so on.
1488                 If avail_wb_buff < wb_flush_threshold, it indicates that WriteBooster buffer needs to
1489                 be flushed, otherwise it is not necessary.
1491 Contact:        Daniil Lunev <dlunev@chromium.org>
1492 What:           /sys/bus/platform/drivers/ufshcd/*/capabilities/
1493 What:           /sys/bus/platform/devices/*.ufs/capabilities/
1494 Date:           August 2022
1495 Description:    The group represents the effective capabilities of the
1496                 host-device pair. i.e. the capabilities which are enabled in the
1497                 driver for the specific host controller, supported by the host
1498                 controller and are supported and/or have compatible
1499                 configuration on the device side.
1501 Contact:        Daniil Lunev <dlunev@chromium.org>
1502 What:           /sys/bus/platform/drivers/ufshcd/*/capabilities/clock_scaling
1503 What:           /sys/bus/platform/devices/*.ufs/capabilities/clock_scaling
1504 Date:           August 2022
1505 Contact:        Daniil Lunev <dlunev@chromium.org>
1506 Description:    Indicates status of clock scaling.
1508                 == ============================
1509                 0  Clock scaling is not supported.
1510                 1  Clock scaling is supported.
1511                 == ============================
1513                 The file is read only.
1515 What:           /sys/bus/platform/drivers/ufshcd/*/capabilities/write_booster
1516 What:           /sys/bus/platform/devices/*.ufs/capabilities/write_booster
1517 Date:           August 2022
1518 Contact:        Daniil Lunev <dlunev@chromium.org>
1519 Description:    Indicates status of Write Booster.
1521                 == ============================
1522                 0  Write Booster can not be enabled.
1523                 1  Write Booster can be enabled.
1524                 == ============================
1526                 The file is read only.
1528 What:           /sys/bus/platform/drivers/ufshcd/*/rtc_update_ms
1529 What:           /sys/bus/platform/devices/*.ufs/rtc_update_ms
1530 Date:           November 2023
1531 Contact:        Bean Huo <beanhuo@micron.com>
1532 Description:
1533                 rtc_update_ms indicates how often the host should synchronize or update the
1534                 UFS RTC. If set to 0, this will disable UFS RTC periodic update.
1536 What:           /sys/devices/platform/.../ufshci_capabilities/version
1537 Date:           August 2024
1538 Contact:        Avri Altman <avri.altman@wdc.com>
1539 Description:
1540                 Host Capabilities register group: UFS version register.
1541                 Symbol - VER.  This file shows the UFSHCD version.
1542                 Example: Version 3.12 would be represented as 0000_0312h.
1543                 The file is read only.
1545 What:           /sys/devices/platform/.../ufshci_capabilities/product_id
1546 Date:           August 2024
1547 Contact:        Avri Altman <avri.altman@wdc.com>
1548 Description:
1549                 Host Capabilities register group: product ID register.
1550                 Symbol - HCPID.  This file shows the UFSHCD product id.
1551                 The content of this register is vendor specific.
1552                 The file is read only.
1554 What:           /sys/devices/platform/.../ufshci_capabilities/man_id
1555 Date:           August 2024
1556 Contact:        Avri Altman <avri.altman@wdc.com>
1557 Description:
1558                 Host Capabilities register group: manufacturer ID register.
1559                 Symbol - HCMID. This file shows the UFSHCD manufacturer id.
1560                 The Manufacturer ID is defined by JEDEC in JEDEC-JEP106.
1561                 The file is read only.