Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / sysfs-driver-ufs
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.
14
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.
22
23                 The file is read only.
24
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.
32
33                 The file is read only.
34
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.
42
43                 The file is read only.
44
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.
53
54                 The file is read only.
55
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.
63
64                 The file is read only.
65
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.
74
75                 The file is read only.
76
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.
85
86                 The file is read only.
87
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.
97
98                 The file is read only.
99
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.
108
109                 The file is read only.
110
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.
118
119                 The file is read only.
120
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.
128
129                 The file is read only.
130
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.
139
140                 The file is read only.
141
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.
150
151                 The file is read only.
152
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.
160
161                 The file is read only.
162
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.
170
171                 The file is read only.
172
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.
181
182                 The file is read only.
183
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.
191
192                 The file is read only.
193
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.
202
203                 The file is read only.
204
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.
213
214                 The file is read only.
215
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.
224
225                 The file is read only.
226
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.
234
235                 The file is read only.
236
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.
244
245                 The file is read only.
246
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.
254
255                 The file is read only.
256
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.
265
266                 The file is read only.
267
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.
277
278                 The file is read only.
279
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.
288
289                 The file is read only.
290
291
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.
300
301                 The file is read only.
302
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.
311
312                 The file is read only.
313
314
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.
324
325                 The file is read only.
326
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.
335
336                 The file is read only.
337
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.
345
346                 The file is read only.
347
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.
355
356                 The file is read only.
357
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.
366
367                 The file is read only.
368
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.
377
378                 The file is read only.
379
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.
388
389                 The file is read only.
390
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.
399
400                 The file is read only.
401
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.
410
411                 The file is read only.
412
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.
421
422                 The file is read only.
423
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.
432
433                 The file is read only.
434
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.
443
444                 The file is read only.
445
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.
454
455                 The file is read only.
456
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.
464
465                 The file is read only.
466
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.
476
477                 The file is read only.
478
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.
487
488                 The file is read only.
489
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.
498
499                 The file is read only.
500
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.
510
511                 The file is read only.
512
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.
522
523                 The file is read only.
524
525
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.
534
535                 The file is read only.
536
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.
545
546                 The file is read only.
547
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.
556
557                 The file is read only.
558
559
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.
568
569                 The file is read only.
570
571
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.
579
580                 The file is read only.
581
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.
588
589                 The file is read only.
590
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.
597
598                 The file is read only.
599
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.
607
608                 The file is read only.
609
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.
617
618                 The file is read only.
619
620
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.
627
628                 The file is read only.
629
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.
636
637                 The file is read only.
638
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.
645
646                 The file is read only.
647
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.
654
655                 The file is read only.
656
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.
663
664                 The file is read only.
665
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.
673
674                 The file is read only.
675
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.
683
684                 The file is read only.
685
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.
693
694                 The file is read only.
695
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.
702
703                 The file is read only.
704
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.
711
712                 The file is read only.
713
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.
720
721                 The file is read only.
722
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.
729
730                 The file is read only.
731
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.
738
739                 The file is read only.
740
741
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.
748
749                 The file is read only.
750
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.
758
759                 The file is read only.
760
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.
769
770                 The file is read only.
771
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.
779
780                 The file is read only.
781
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.
789
790                 The file is read only.
791
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.
799
800                 The file is read only.
801
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.
809
810                 The file is read only.
811
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.
819
820                 The file is read only.
821
822
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.
830
831                 The file is read only.
832
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.
840
841                 The file is read only.
842
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.
850
851                 The file is read only.
852
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.
860
861                 The file is read only.
862
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.
870
871                 The file is read only.
872
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.
880
881                 The file is read only.
882
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.
890
891                 The file is read only.
892
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.
900
901                 The file is read only.
902
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.
910
911                 The file is read only.
912
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.
920
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:           February 2018
924 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
925 Description:    This file provides the maximum current number of
926                 outstanding RTTs in device that is allowed. The full
927                 information about the attribute could be found at
928                 UFS specifications 2.1.
929
930                 The file is read only.
931
932 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control
933 What:           /sys/bus/platform/devices/*.ufs/attributes/exception_event_control
934 Date:           February 2018
935 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
936 Description:    This file provides the exception event control UFS device
937                 attribute. The full information about the attribute could
938                 be found at UFS specifications 2.1.
939
940                 The file is read only.
941
942 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status
943 What:           /sys/bus/platform/devices/*.ufs/attributes/exception_event_status
944 Date:           February 2018
945 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
946 Description:    This file provides the exception event status UFS device
947                 attribute. The full information about the attribute could
948                 be found at UFS specifications 2.1.
949
950                 The file is read only.
951
952 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status
953 What:           /sys/bus/platform/devices/*.ufs/attributes/ffu_status
954 Date:           February 2018
955 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
956 Description:    This file provides the ffu status UFS device attribute.
957                 The full information about the attribute could be found at
958                 UFS specifications 2.1.
959
960                 The file is read only.
961
962 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/psa_state
963 What:           /sys/bus/platform/devices/*.ufs/attributes/psa_state
964 Date:           February 2018
965 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
966 Description:    This file show the PSA feature status. The full information
967                 about the attribute could be found at UFS specifications 2.1.
968
969                 The file is read only.
970
971 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size
972 What:           /sys/bus/platform/devices/*.ufs/attributes/psa_data_size
973 Date:           February 2018
974 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
975 Description:    This file shows the amount of data that the host plans to
976                 load to all logical units in pre-soldering state.
977                 The full information about the attribute could be found at
978                 UFS specifications 2.1.
979
980                 The file is read only.
981
982
983 What:           /sys/class/scsi_device/*/device/dyn_cap_needed
984 Date:           February 2018
985 Contact:        Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
986 Description:    This file shows the amount of physical memory needed
987                 to be removed from the physical memory resources pool of
988                 the particular logical unit. The full information about
989                 the attribute could be found at UFS specifications 2.1.
990
991                 The file is read only.
992
993
994 What:           /sys/bus/platform/drivers/ufshcd/*/rpm_lvl
995 What:           /sys/bus/platform/devices/*.ufs/rpm_lvl
996 Date:           September 2014
997 Contact:        Can Guo <quic_cang@quicinc.com>
998 Description:    This entry could be used to set or show the UFS device
999                 runtime power management level. The current driver
1000                 implementation supports 7 levels with next target states:
1001
1002                 ==  ====================================================
1003                 0   UFS device will stay active, UIC link will
1004                     stay active
1005                 1   UFS device will stay active, UIC link will
1006                     hibernate
1007                 2   UFS device will be moved to sleep, UIC link will
1008                     stay active
1009                 3   UFS device will be moved to sleep, UIC link will
1010                     hibernate
1011                 4   UFS device will be powered off, UIC link will
1012                     hibernate
1013                 5   UFS device will be powered off, UIC link will
1014                     be powered off
1015                 6   UFS device will be moved to deep sleep, UIC link
1016                     will be powered off. Note, deep sleep might not be
1017                     supported in which case this value will not be
1018                     accepted
1019                 ==  ====================================================
1020
1021 What:           /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
1022 What:           /sys/bus/platform/devices/*.ufs/rpm_target_dev_state
1023 Date:           February 2018
1024 Contact:        Can Guo <quic_cang@quicinc.com>
1025 Description:    This entry shows the target power mode of an UFS device
1026                 for the chosen runtime power management level.
1027
1028                 The file is read only.
1029
1030 What:           /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state
1031 What:           /sys/bus/platform/devices/*.ufs/rpm_target_link_state
1032 Date:           February 2018
1033 Contact:        Can Guo <quic_cang@quicinc.com>
1034 Description:    This entry shows the target state of an UFS UIC link
1035                 for the chosen runtime power management level.
1036
1037                 The file is read only.
1038
1039 What:           /sys/bus/platform/drivers/ufshcd/*/spm_lvl
1040 What:           /sys/bus/platform/devices/*.ufs/spm_lvl
1041 Date:           September 2014
1042 Contact:        Can Guo <quic_cang@quicinc.com>
1043 Description:    This entry could be used to set or show the UFS device
1044                 system power management level. The current driver
1045                 implementation supports 7 levels with next target states:
1046
1047                 ==  ====================================================
1048                 0   UFS device will stay active, UIC link will
1049                     stay active
1050                 1   UFS device will stay active, UIC link will
1051                     hibernate
1052                 2   UFS device will be moved to sleep, UIC link will
1053                     stay active
1054                 3   UFS device will be moved to sleep, UIC link will
1055                     hibernate
1056                 4   UFS device will be powered off, UIC link will
1057                     hibernate
1058                 5   UFS device will be powered off, UIC link will
1059                     be powered off
1060                 6   UFS device will be moved to deep sleep, UIC link
1061                     will be powered off. Note, deep sleep might not be
1062                     supported in which case this value will not be
1063                     accepted
1064                 ==  ====================================================
1065
1066 What:           /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
1067 What:           /sys/bus/platform/devices/*.ufs/spm_target_dev_state
1068 Date:           February 2018
1069 Contact:        Can Guo <quic_cang@quicinc.com>
1070 Description:    This entry shows the target power mode of an UFS device
1071                 for the chosen system power management level.
1072
1073                 The file is read only.
1074
1075 What:           /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state
1076 What:           /sys/bus/platform/devices/*.ufs/spm_target_link_state
1077 Date:           February 2018
1078 Contact:        Can Guo <quic_cang@quicinc.com>
1079 Description:    This entry shows the target state of an UFS UIC link
1080                 for the chosen system power management level.
1081
1082                 The file is read only.
1083
1084 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable
1085 What:           /sys/bus/platform/devices/*.ufs/monitor/monitor_enable
1086 Date:           January 2021
1087 Contact:        Can Guo <quic_cang@quicinc.com>
1088 Description:    This file shows the status of performance monitor enablement
1089                 and it can be used to start/stop the monitor. When the monitor
1090                 is stopped, the performance data collected is also cleared.
1091
1092 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size
1093 What:           /sys/bus/platform/devices/*.ufs/monitor/monitor_chunk_size
1094 Date:           January 2021
1095 Contact:        Can Guo <quic_cang@quicinc.com>
1096 Description:    This file tells the monitor to focus on requests transferring
1097                 data of specific chunk size (in Bytes). 0 means any chunk size.
1098                 It can only be changed when monitor is disabled.
1099
1100 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors
1101 What:           /sys/bus/platform/devices/*.ufs/monitor/read_total_sectors
1102 Date:           January 2021
1103 Contact:        Can Guo <quic_cang@quicinc.com>
1104 Description:    This file shows how many sectors (in 512 Bytes) have been
1105                 sent from device to host after monitor gets started.
1106
1107                 The file is read only.
1108
1109 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy
1110 What:           /sys/bus/platform/devices/*.ufs/monitor/read_total_busy
1111 Date:           January 2021
1112 Contact:        Can Guo <quic_cang@quicinc.com>
1113 Description:    This file shows how long (in micro seconds) has been spent
1114                 sending data from device to host after monitor gets started.
1115
1116                 The file is read only.
1117
1118 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests
1119 What:           /sys/bus/platform/devices/*.ufs/monitor/read_nr_requests
1120 Date:           January 2021
1121 Contact:        Can Guo <quic_cang@quicinc.com>
1122 Description:    This file shows how many read requests have been sent after
1123                 monitor gets started.
1124
1125                 The file is read only.
1126
1127 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max
1128 What:           /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_max
1129 Date:           January 2021
1130 Contact:        Can Guo <quic_cang@quicinc.com>
1131 Description:    This file shows the maximum latency (in micro seconds) of
1132                 read requests after monitor gets started.
1133
1134                 The file is read only.
1135
1136 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min
1137 What:           /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_min
1138 Date:           January 2021
1139 Contact:        Can Guo <quic_cang@quicinc.com>
1140 Description:    This file shows the minimum latency (in micro seconds) of
1141                 read requests after monitor gets started.
1142
1143                 The file is read only.
1144
1145 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg
1146 What:           /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_avg
1147 Date:           January 2021
1148 Contact:        Can Guo <quic_cang@quicinc.com>
1149 Description:    This file shows the average latency (in micro seconds) of
1150                 read requests after monitor gets started.
1151
1152                 The file is read only.
1153
1154 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum
1155 What:           /sys/bus/platform/devices/*.ufs/monitor/read_req_latency_sum
1156 Date:           January 2021
1157 Contact:        Can Guo <quic_cang@quicinc.com>
1158 Description:    This file shows the total latency (in micro seconds) of
1159                 read requests sent after monitor gets started.
1160
1161                 The file is read only.
1162
1163 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors
1164 What:           /sys/bus/platform/devices/*.ufs/monitor/write_total_sectors
1165 Date:           January 2021
1166 Contact:        Can Guo <quic_cang@quicinc.com>
1167 Description:    This file shows how many sectors (in 512 Bytes) have been sent
1168                 from host to device after monitor gets started.
1169
1170                 The file is read only.
1171
1172 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy
1173 What:           /sys/bus/platform/devices/*.ufs/monitor/write_total_busy
1174 Date:           January 2021
1175 Contact:        Can Guo <quic_cang@quicinc.com>
1176 Description:    This file shows how long (in micro seconds) has been spent
1177                 sending data from host to device after monitor gets started.
1178
1179                 The file is read only.
1180
1181 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests
1182 What:           /sys/bus/platform/devices/*.ufs/monitor/write_nr_requests
1183 Date:           January 2021
1184 Contact:        Can Guo <quic_cang@quicinc.com>
1185 Description:    This file shows how many write requests have been sent after
1186                 monitor gets started.
1187
1188                 The file is read only.
1189
1190 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max
1191 What:           /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_max
1192 Date:           January 2021
1193 Contact:        Can Guo <quic_cang@quicinc.com>
1194 Description:    This file shows the maximum latency (in micro seconds) of write
1195                 requests after monitor gets started.
1196
1197                 The file is read only.
1198
1199 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min
1200 What:           /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_min
1201 Date:           January 2021
1202 Contact:        Can Guo <quic_cang@quicinc.com>
1203 Description:    This file shows the minimum latency (in micro seconds) of write
1204                 requests after monitor gets started.
1205
1206                 The file is read only.
1207
1208 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg
1209 What:           /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_avg
1210 Date:           January 2021
1211 Contact:        Can Guo <quic_cang@quicinc.com>
1212 Description:    This file shows the average latency (in micro seconds) of write
1213                 requests after monitor gets started.
1214
1215                 The file is read only.
1216
1217 What:           /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum
1218 What:           /sys/bus/platform/devices/*.ufs/monitor/write_req_latency_sum
1219 Date:           January 2021
1220 Contact:        Can Guo <quic_cang@quicinc.com>
1221 Description:    This file shows the total latency (in micro seconds) of write
1222                 requests after monitor gets started.
1223
1224                 The file is read only.
1225
1226 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
1227 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/wb_presv_us_en
1228 Date:           June 2020
1229 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1230 Description:    This entry shows if preserve user-space was configured
1231
1232                 The file is read only.
1233
1234 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units
1235 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/wb_shared_alloc_units
1236 Date:           June 2020
1237 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1238 Description:    This entry shows the shared allocated units of WB buffer
1239
1240                 The file is read only.
1241
1242 What:           /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type
1243 What:           /sys/bus/platform/devices/*.ufs/device_descriptor/wb_type
1244 Date:           June 2020
1245 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1246 Description:    This entry shows the configured WB type.
1247                 0x1 for shared buffer mode. 0x0 for dedicated buffer mode.
1248
1249                 The file is read only.
1250
1251 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
1252 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_buff_cap_adj
1253 Date:           June 2020
1254 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1255 Description:    This entry shows the total user-space decrease in shared
1256                 buffer mode.
1257                 The value of this parameter is 3 for TLC NAND when SLC mode
1258                 is used as WriteBooster Buffer. 2 for MLC NAND.
1259
1260                 The file is read only.
1261
1262 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units
1263 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_max_alloc_units
1264 Date:           June 2020
1265 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1266 Description:    This entry shows the Maximum total WriteBooster Buffer size
1267                 which is supported by the entire device.
1268
1269                 The file is read only.
1270
1271 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
1272 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_max_wb_luns
1273 Date:           June 2020
1274 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1275 Description:    This entry shows the maximum number of luns that can support
1276                 WriteBooster.
1277
1278                 The file is read only.
1279
1280 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
1281 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_sup_red_type
1282 Date:           June 2020
1283 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1284 Description:    The supportability of user space reduction mode
1285                 and preserve user space mode.
1286                 00h: WriteBooster Buffer can be configured only in
1287                 user space reduction type.
1288                 01h: WriteBooster Buffer can be configured only in
1289                 preserve user space type.
1290                 02h: Device can be configured in either user space
1291                 reduction type or preserve user space type.
1292
1293                 The file is read only.
1294
1295 What:           /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
1296 What:           /sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_sup_wb_type
1297 Date:           June 2020
1298 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1299 Description:    The supportability of WriteBooster Buffer type.
1300
1301                 ===  ==========================================================
1302                 00h  LU based WriteBooster Buffer configuration
1303                 01h  Single shared WriteBooster Buffer configuration
1304                 02h  Supporting both LU based WriteBooster.
1305                      Buffer and Single shared WriteBooster Buffer configuration
1306                 ===  ==========================================================
1307
1308                 The file is read only.
1309
1310 What:           /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
1311 What:           /sys/bus/platform/devices/*.ufs/flags/wb_enable
1312 Date:           June 2020
1313 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1314 Description:    This entry shows the status of WriteBooster.
1315
1316                 == ============================
1317                 0  WriteBooster is not enabled.
1318                 1  WriteBooster is enabled
1319                 == ============================
1320
1321                 The file is read only.
1322
1323 What:           /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
1324 What:           /sys/bus/platform/devices/*.ufs/flags/wb_flush_en
1325 Date:           June 2020
1326 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1327 Description:    This entry shows if flush is enabled.
1328
1329                 == =================================
1330                 0  Flush operation is not performed.
1331                 1  Flush operation is performed.
1332                 == =================================
1333
1334                 The file is read only.
1335
1336 What:           /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8
1337 What:           /sys/bus/platform/devices/*.ufs/flags/wb_flush_during_h8
1338 Date:           June 2020
1339 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1340 Description:    Flush WriteBooster Buffer during hibernate state.
1341
1342                 == =================================================
1343                 0  Device is not allowed to flush the
1344                    WriteBooster Buffer during link hibernate state.
1345                 1  Device is allowed to flush the
1346                    WriteBooster Buffer during link hibernate state.
1347                 == =================================================
1348
1349                 The file is read only.
1350
1351 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf
1352 What:           /sys/bus/platform/devices/*.ufs/attributes/wb_avail_buf
1353 Date:           June 2020
1354 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1355 Description:    This entry shows the amount of unused WriteBooster buffer
1356                 available.
1357
1358                 The file is read only.
1359
1360 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
1361 What:           /sys/bus/platform/devices/*.ufs/attributes/wb_cur_buf
1362 Date:           June 2020
1363 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1364 Description:    This entry shows the amount of unused current buffer.
1365
1366                 The file is read only.
1367
1368 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status
1369 What:           /sys/bus/platform/devices/*.ufs/attributes/wb_flush_status
1370 Date:           June 2020
1371 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1372 Description:    This entry shows the flush operation status.
1373
1374
1375                 ===  ======================================
1376                 00h  idle
1377                 01h  Flush operation in progress
1378                 02h  Flush operation stopped prematurely.
1379                 03h  Flush operation completed successfully
1380                 04h  Flush operation general failure
1381                 ===  ======================================
1382
1383                 The file is read only.
1384
1385 What:           /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est
1386 What:           /sys/bus/platform/devices/*.ufs/attributes/wb_life_time_est
1387 Date:           June 2020
1388 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1389 Description:    This entry shows an indication of the WriteBooster Buffer
1390                 lifetime based on the amount of performed program/erase cycles
1391
1392                 ===  =============================================
1393                 01h  0% - 10% WriteBooster Buffer life time used
1394                 ...
1395                 0Ah  90% - 100% WriteBooster Buffer life time used
1396                 ===  =============================================
1397
1398                 The file is read only.
1399
1400 What:           /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
1401 Date:           June 2020
1402 Contact:        Asutosh Das <quic_asutoshd@quicinc.com>
1403 Description:    This entry shows the configured size of WriteBooster buffer.
1404                 0400h corresponds to 4GB.
1405
1406                 The file is read only.
1407
1408 What:           /sys/bus/platform/drivers/ufshcd/*/wb_on
1409 What:           /sys/bus/platform/devices/*.ufs/wb_on
1410 Date:           January 2021
1411 Contact:        Bean Huo <beanhuo@micron.com>
1412 Description:    This node is used to set or display whether UFS WriteBooster is
1413                 enabled. Echo 0 to this file to disable UFS WriteBooster or 1 to
1414                 enable it. The WriteBooster is enabled after power-on/reset,
1415                 however, it will be disabled/enable while CLK scaling down/up
1416                 (if the platform supports UFSHCD_CAP_CLK_SCALING). For a
1417                 platform that doesn't support UFSHCD_CAP_CLK_SCALING, we can
1418                 disable/enable WriteBooster through this sysfs node.
1419
1420 What:           /sys/bus/platform/drivers/ufshcd/*/enable_wb_buf_flush
1421 What:           /sys/bus/platform/devices/*.ufs/enable_wb_buf_flush
1422 Date:           July 2022
1423 Contact:        Jinyoung Choi <j-young.choi@samsung.com>
1424 Description:    This entry shows the status of WriteBooster buffer flushing
1425                 and it can be used to enable or disable the flushing.
1426                 If flushing is enabled, the device executes the flush
1427                 operation when the command queue is empty.
1428
1429 What:           /sys/bus/platform/drivers/ufshcd/*/wb_flush_threshold
1430 What:           /sys/bus/platform/devices/*.ufs/wb_flush_threshold
1431 Date:           June 2023
1432 Contact:        Lu Hongfei <luhongfei@vivo.com>
1433 Description:
1434                 wb_flush_threshold represents the threshold for flushing WriteBooster buffer,
1435                 whose value expressed in unit of 10% granularity, such as '1' representing 10%,
1436                 '2' representing 20%, and so on.
1437                 If avail_wb_buff < wb_flush_threshold, it indicates that WriteBooster buffer needs to
1438                 be flushed, otherwise it is not necessary.
1439
1440 Contact:        Daniil Lunev <dlunev@chromium.org>
1441 What:           /sys/bus/platform/drivers/ufshcd/*/capabilities/
1442 What:           /sys/bus/platform/devices/*.ufs/capabilities/
1443 Date:           August 2022
1444 Description:    The group represents the effective capabilities of the
1445                 host-device pair. i.e. the capabilities which are enabled in the
1446                 driver for the specific host controller, supported by the host
1447                 controller and are supported and/or have compatible
1448                 configuration on the device side.
1449
1450 Contact:        Daniil Lunev <dlunev@chromium.org>
1451 What:           /sys/bus/platform/drivers/ufshcd/*/capabilities/clock_scaling
1452 What:           /sys/bus/platform/devices/*.ufs/capabilities/clock_scaling
1453 Date:           August 2022
1454 Contact:        Daniil Lunev <dlunev@chromium.org>
1455 Description:    Indicates status of clock scaling.
1456
1457                 == ============================
1458                 0  Clock scaling is not supported.
1459                 1  Clock scaling is supported.
1460                 == ============================
1461
1462                 The file is read only.
1463
1464 What:           /sys/bus/platform/drivers/ufshcd/*/capabilities/write_booster
1465 What:           /sys/bus/platform/devices/*.ufs/capabilities/write_booster
1466 Date:           August 2022
1467 Contact:        Daniil Lunev <dlunev@chromium.org>
1468 Description:    Indicates status of Write Booster.
1469
1470                 == ============================
1471                 0  Write Booster can not be enabled.
1472                 1  Write Booster can be enabled.
1473                 == ============================
1474
1475                 The file is read only.
1476