Merge tag 'trace-v5.14-5' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[linux-2.6-block.git] / Documentation / ABI / testing / sysfs-driver-ufs
CommitLineData
ad448378
AH
1What: /sys/bus/*/drivers/ufshcd/*/auto_hibern8
2Date: March 2018
3Contact: linux-scsi@vger.kernel.org
4Description:
5 This file contains the auto-hibernate idle timer setting of a
6 UFS host controller. A value of '0' means auto-hibernate is not
7 enabled. Otherwise the value is the number of microseconds of
8 idle time before the UFS host controller will autonomously put
9 the link into hibernate state. That will save power at the
10 expense of increased latency. Note that the hardware supports
11 10-bit values with a power-of-ten multiplier which allows a
12 maximum value of 102300000. Refer to the UFS Host Controller
13 Interface specification for more details.
14
45bced87
SN
15What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_type
16Date: February 2018
17Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
18Description: This file shows the device type. This is one of the UFS
19 device descriptor parameters. The full information about
20 the descriptor could be found at UFS specifications 2.1.
54a19b4d 21
45bced87
SN
22 The file is read only.
23
24What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class
25Date: February 2018
26Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
27Description: This file shows the device class. This is one of the UFS
28 device descriptor parameters. The full information about
29 the descriptor could be found at UFS specifications 2.1.
54a19b4d 30
45bced87
SN
31 The file is read only.
32
33What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class
34Date: February 2018
35Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
36Description: This file shows the UFS storage subclass. This is one of
37 the UFS device descriptor parameters. The full information
38 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 39
45bced87
SN
40 The file is read only.
41
42What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol
43Date: February 2018
44Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
45Description: This file shows the protocol supported by an UFS device.
46 This is one of the UFS device descriptor parameters.
47 The full information about the descriptor could be found
48 at UFS specifications 2.1.
54a19b4d 49
45bced87
SN
50 The file is read only.
51
52What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns
53Date: February 2018
54Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
55Description: This file shows number of logical units. This is one of
56 the UFS device descriptor parameters. The full information
57 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 58
45bced87
SN
59 The file is read only.
60
61What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns
62Date: February 2018
63Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
64Description: This file shows number of well known logical units.
65 This is one of the UFS device descriptor parameters.
66 The full information about the descriptor could be found
67 at UFS specifications 2.1.
54a19b4d 68
45bced87
SN
69 The file is read only.
70
71What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable
72Date: February 2018
73Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
74Description: This file shows value that indicates whether the device is
75 enabled for boot. This is one of the UFS device descriptor
76 parameters. The full information about the descriptor could
77 be found at UFS specifications 2.1.
54a19b4d 78
45bced87
SN
79 The file is read only.
80
81What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable
82Date: February 2018
83Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
84Description: This file shows value that indicates whether the device
85 descriptor could be read after partial initialization phase
86 of the boot sequence. This is one of the UFS device descriptor
87 parameters. The full information about the descriptor could
88 be found at UFS specifications 2.1.
54a19b4d 89
45bced87
SN
90 The file is read only.
91
92What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode
93Date: February 2018
94Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
95Description: This file shows value that defines the power mode after
96 device initialization or hardware reset. This is one of
97 the UFS device descriptor parameters. The full information
98 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 99
45bced87
SN
100 The file is read only.
101
102What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/high_priority_lun
103Date: February 2018
104Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
105Description: This file shows the high priority lun. This is one of
106 the UFS device descriptor parameters. The full information
107 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 108
45bced87
SN
109 The file is read only.
110
111What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type
112Date: February 2018
113Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
114Description: This file shows the secure removal type. This is one of
115 the UFS device descriptor parameters. The full information
116 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 117
45bced87
SN
118 The file is read only.
119
120What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun
121Date: February 2018
122Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
123Description: This file shows whether the security lun is supported.
124 This is one of the UFS device descriptor parameters.
125 The full information about the descriptor could be found
126 at UFS specifications 2.1.
54a19b4d 127
45bced87
SN
128 The file is read only.
129
130What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency
131Date: February 2018
132Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
133Description: This file shows the background operations termination
134 latency. This is one of the UFS device descriptor parameters.
135 The full information about the descriptor could be found
136 at UFS specifications 2.1.
54a19b4d 137
45bced87
SN
138 The file is read only.
139
140What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level
141Date: February 2018
142Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
143Description: This file shows the initial active ICC level. This is one
144 of the UFS device descriptor parameters. The full information
145 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 146
45bced87
SN
147 The file is read only.
148
149What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version
150Date: February 2018
151Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
152Description: This file shows the specification version. This is one
153 of the UFS device descriptor parameters. The full information
154 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 155
45bced87
SN
156 The file is read only.
157
158What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date
159Date: February 2018
160Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
161Description: This file shows the manufacturing date in BCD format.
162 This is one of the UFS device descriptor parameters.
163 The full information about the descriptor could be found
164 at UFS specifications 2.1.
54a19b4d 165
45bced87
SN
166 The file is read only.
167
168What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id
169Date: February 2018
170Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
3e42d1de 171Description: This file shows the manufacturer ID. This is one of the
45bced87
SN
172 UFS device descriptor parameters. The full information about
173 the descriptor could be found at UFS specifications 2.1.
54a19b4d 174
45bced87
SN
175 The file is read only.
176
177What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability
178Date: February 2018
179Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
180Description: This file shows the maximum number of outstanding RTTs
181 supported by the device. This is one of the UFS device
182 descriptor parameters. The full information about
183 the descriptor could be found at UFS specifications 2.1.
54a19b4d 184
45bced87
SN
185 The file is read only.
186
187What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update
188Date: February 2018
189Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
190Description: This file shows the frequency and method of the realtime
191 clock update. This is one of the UFS device descriptor
192 parameters. The full information about the descriptor
193 could be found at UFS specifications 2.1.
54a19b4d 194
45bced87
SN
195 The file is read only.
196
197What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features
198Date: February 2018
199Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
200Description: This file shows which features are supported by the device.
201 This is one of the UFS device descriptor parameters.
202 The full information about the descriptor could be
203 found at UFS specifications 2.1.
54a19b4d 204
45bced87
SN
205 The file is read only.
206
207What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout
208Date: February 2018
209Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
210Description: This file shows the FFU timeout. This is one of the
211 UFS device descriptor parameters. The full information
212 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 213
45bced87
SN
214 The file is read only.
215
216What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth
217Date: February 2018
218Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
219Description: This file shows the device queue depth. This is one of the
220 UFS device descriptor parameters. The full information
221 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 222
45bced87
SN
223 The file is read only.
224
225What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version
226Date: February 2018
227Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
228Description: This file shows the device version. This is one of the
229 UFS device descriptor parameters. The full information
230 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 231
45bced87
SN
232 The file is read only.
233
234What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa
235Date: February 2018
236Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
237Description: This file shows number of secure write protect areas
238 supported by the device. This is one of the UFS device
239 descriptor parameters. The full information about
240 the descriptor could be found at UFS specifications 2.1.
54a19b4d 241
45bced87
SN
242 The file is read only.
243
244What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size
245Date: February 2018
246Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
247Description: This file shows the maximum amount of data that may be
248 written during the pre-soldering phase of the PSA flow.
249 This is one of the UFS device descriptor parameters.
250 The full information about the descriptor could be found
251 at UFS specifications 2.1.
54a19b4d 252
45bced87
SN
253 The file is read only.
254
255What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout
256Date: February 2018
257Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
258Description: This file shows the command maximum timeout for a change
259 in PSA state. This is one of the UFS device descriptor
260 parameters. The full information about the descriptor could
261 be found at UFS specifications 2.1.
54a19b4d 262
45bced87 263 The file is read only.
8c2582bf
SN
264
265
266What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/unipro_version
267Date: February 2018
268Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
269Description: This file shows the MIPI UniPro version number in BCD format.
270 This is one of the UFS interconnect descriptor parameters.
271 The full information about the descriptor could be found at
272 UFS specifications 2.1.
54a19b4d 273
8c2582bf
SN
274 The file is read only.
275
276What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version
277Date: February 2018
278Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
279Description: This file shows the MIPI M-PHY version number in BCD format.
280 This is one of the UFS interconnect descriptor parameters.
281 The full information about the descriptor could be found at
282 UFS specifications 2.1.
54a19b4d 283
8c2582bf 284 The file is read only.
c720c091
SN
285
286
287What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/raw_device_capacity
288Date: February 2018
289Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
290Description: This file shows the total memory quantity available to
291 the user to configure the device logical units. This is one
292 of the UFS geometry descriptor parameters. The full
293 information about the descriptor could be found at
294 UFS specifications 2.1.
54a19b4d 295
c720c091
SN
296 The file is read only.
297
298What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns
299Date: February 2018
300Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
301Description: This file shows the maximum number of logical units
302 supported by the UFS device. This is one of the UFS
303 geometry descriptor parameters. The full information about
304 the descriptor could be found at UFS specifications 2.1.
54a19b4d 305
c720c091
SN
306 The file is read only.
307
308What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size
309Date: February 2018
310Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
311Description: This file shows the segment size. This is one of the UFS
312 geometry descriptor parameters. The full information about
313 the descriptor could be found at UFS specifications 2.1.
54a19b4d 314
c720c091
SN
315 The file is read only.
316
317What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size
318Date: February 2018
319Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
320Description: This file shows the allocation unit size. This is one of
321 the UFS geometry descriptor parameters. The full information
322 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 323
c720c091
SN
324 The file is read only.
325
326What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size
327Date: February 2018
328Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
329Description: This file shows the minimum addressable block size. This
330 is one of the UFS geometry descriptor parameters. The full
331 information about the descriptor could be found at UFS
332 specifications 2.1.
54a19b4d 333
c720c091
SN
334 The file is read only.
335
336What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size
337Date: February 2018
338Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
339Description: This file shows the optimal read block size. This is one
340 of the UFS geometry descriptor parameters. The full
341 information about the descriptor could be found at UFS
342 specifications 2.1.
54a19b4d 343
c720c091
SN
344 The file is read only.
345
346What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size
347Date: February 2018
348Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
349Description: This file shows the optimal write block size. This is one
350 of the UFS geometry descriptor parameters. The full
351 information about the descriptor could be found at UFS
352 specifications 2.1.
54a19b4d 353
c720c091
SN
354 The file is read only.
355
356What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size
357Date: February 2018
358Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
359Description: This file shows the maximum data-in buffer size. This
360 is one of the UFS geometry descriptor parameters. The full
361 information about the descriptor could be found at UFS
362 specifications 2.1.
54a19b4d 363
c720c091
SN
364 The file is read only.
365
366What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size
367Date: February 2018
368Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
369Description: This file shows the maximum data-out buffer size. This
370 is one of the UFS geometry descriptor parameters. The full
371 information about the descriptor could be found at UFS
372 specifications 2.1.
54a19b4d 373
c720c091
SN
374 The file is read only.
375
376What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size
377Date: February 2018
378Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
379Description: This file shows the maximum number of RPMB frames allowed
380 in Security Protocol In/Out. This is one of the UFS geometry
381 descriptor parameters. The full information about the
382 descriptor could be found at UFS specifications 2.1.
54a19b4d 383
c720c091
SN
384 The file is read only.
385
386What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy
387Date: February 2018
388Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
389Description: This file shows the dynamic capacity resource policy. This
390 is one of the UFS geometry descriptor parameters. The full
391 information about the descriptor could be found at
392 UFS specifications 2.1.
54a19b4d 393
c720c091
SN
394 The file is read only.
395
396What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering
397Date: February 2018
398Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
399Description: This file shows support for out-of-order data transfer.
400 This is one of the UFS geometry descriptor parameters.
401 The full information about the descriptor could be found at
402 UFS specifications 2.1.
54a19b4d 403
c720c091
SN
404 The file is read only.
405
406What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_contexts
407Date: February 2018
408Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
409Description: This file shows maximum available number of contexts which
410 are supported by the device. This is one of the UFS geometry
411 descriptor parameters. The full information about the
412 descriptor could be found at UFS specifications 2.1.
54a19b4d 413
c720c091
SN
414 The file is read only.
415
416What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size
417Date: February 2018
418Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
419Description: This file shows system data tag unit size. This is one of
420 the UFS geometry descriptor parameters. The full information
421 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 422
c720c091
SN
423 The file is read only.
424
425What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size
426Date: February 2018
427Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
428Description: This file shows maximum storage area size allocated by
429 the device to handle system data by the tagging mechanism.
430 This is one of the UFS geometry descriptor parameters.
431 The full information about the descriptor could be found at
432 UFS specifications 2.1.
54a19b4d 433
c720c091
SN
434 The file is read only.
435
436What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types
437Date: February 2018
438Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
439Description: This file shows supported secure removal types. This is
440 one of the UFS geometry descriptor parameters. The full
441 information about the descriptor could be found at
442 UFS specifications 2.1.
54a19b4d 443
c720c091
SN
444 The file is read only.
445
446What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types
447Date: February 2018
448Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
449Description: This file shows supported memory types. This is one of
450 the UFS geometry descriptor parameters. The full
451 information about the descriptor could be found at
452 UFS specifications 2.1.
54a19b4d 453
c720c091
SN
454 The file is read only.
455
456What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units
457Date: February 2018
458Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
459Description: This file shows the maximum number of allocation units for
460 different memory types (system code, non persistent,
461 enhanced type 1-4). This is one of the UFS geometry
462 descriptor parameters. The full information about the
463 descriptor could be found at UFS specifications 2.1.
54a19b4d 464
c720c091
SN
465 The file is read only.
466
467What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor
468Date: February 2018
469Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
470Description: This file shows the memory capacity adjustment factor for
471 different memory types (system code, non persistent,
472 enhanced type 1-4). This is one of the UFS geometry
473 descriptor parameters. The full information about the
474 descriptor could be found at UFS specifications 2.1.
54a19b4d 475
c720c091 476 The file is read only.
c648c2d2
SN
477
478
479What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/eol_info
480Date: February 2018
481Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
482Description: This file shows preend of life information. This is one
483 of the UFS health descriptor parameters. The full
484 information about the descriptor could be found at
485 UFS specifications 2.1.
54a19b4d 486
c648c2d2
SN
487 The file is read only.
488
489What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a
490Date: February 2018
491Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
492Description: This file shows indication of the device life time
493 (method a). This is one of the UFS health descriptor
494 parameters. The full information about the descriptor
495 could be found at UFS specifications 2.1.
54a19b4d 496
c648c2d2
SN
497 The file is read only.
498
499What: /sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b
500Date: February 2018
501Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
502Description: This file shows indication of the device life time
503 (method b). This is one of the UFS health descriptor
504 parameters. The full information about the descriptor
505 could be found at UFS specifications 2.1.
54a19b4d 506
c648c2d2 507 The file is read only.
c2e6e283
SN
508
509
510What: /sys/bus/platform/drivers/ufshcd/*/power_descriptor/active_icc_levels_vcc*
511Date: February 2018
512Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
513Description: This file shows maximum VCC, VCCQ and VCCQ2 value for
514 active ICC levels from 0 to 15. This is one of the UFS
515 power descriptor parameters. The full information about
516 the descriptor could be found at UFS specifications 2.1.
54a19b4d 517
c2e6e283 518 The file is read only.
2238d31c
SN
519
520
521What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/manufacturer_name
522Date: February 2018
523Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
3e42d1de 524Description: This file contains a device manufacturer name string.
2238d31c
SN
525 The full information about the descriptor could be found at
526 UFS specifications 2.1.
54a19b4d 527
2238d31c
SN
528 The file is read only.
529
530What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name
531Date: February 2018
532Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
533Description: This file contains a product name string. The full information
534 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 535
2238d31c
SN
536 The file is read only.
537
538What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id
539Date: February 2018
540Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
541Description: This file contains a OEM ID string. The full information
542 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 543
2238d31c
SN
544 The file is read only.
545
546What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number
547Date: February 2018
548Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
549Description: This file contains a device serial number string. The full
550 information about the descriptor could be found at
551 UFS specifications 2.1.
54a19b4d 552
2238d31c
SN
553 The file is read only.
554
555What: /sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision
556Date: February 2018
557Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
558Description: This file contains a product revision string. The full
559 information about the descriptor could be found at
560 UFS specifications 2.1.
54a19b4d 561
2238d31c 562 The file is read only.
d829fc8a
SN
563
564
565What: /sys/class/scsi_device/*/device/unit_descriptor/boot_lun_id
566Date: February 2018
567Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
568Description: This file shows boot LUN information. This is one of
569 the UFS unit descriptor parameters. The full information
570 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 571
d829fc8a
SN
572 The file is read only.
573
574What: /sys/class/scsi_device/*/device/unit_descriptor/lun_write_protect
575Date: February 2018
576Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
577Description: This file shows LUN write protection status. This is one of
578 the UFS unit descriptor parameters. The full information
579 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 580
d829fc8a
SN
581 The file is read only.
582
583What: /sys/class/scsi_device/*/device/unit_descriptor/lun_queue_depth
584Date: February 2018
585Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
586Description: This file shows LUN queue depth. This is one of the UFS
587 unit descriptor parameters. The full information about
588 the descriptor could be found at UFS specifications 2.1.
54a19b4d 589
d829fc8a
SN
590 The file is read only.
591
592What: /sys/class/scsi_device/*/device/unit_descriptor/psa_sensitive
593Date: February 2018
594Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
595Description: This file shows PSA sensitivity. This is one of the UFS
596 unit descriptor parameters. The full information about
597 the descriptor could be found at UFS specifications 2.1.
54a19b4d 598
d829fc8a
SN
599 The file is read only.
600
601What: /sys/class/scsi_device/*/device/unit_descriptor/lun_memory_type
602Date: February 2018
603Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
604Description: This file shows LUN memory type. This is one of the UFS
605 unit descriptor parameters. The full information about
606 the descriptor could be found at UFS specifications 2.1.
54a19b4d 607
d829fc8a
SN
608 The file is read only.
609
610What: /sys/class/scsi_device/*/device/unit_descriptor/data_reliability
611Date: February 2018
612Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
613Description: This file defines the device behavior when a power failure
614 occurs during a write operation. This is one of the UFS
615 unit descriptor parameters. The full information about
616 the descriptor could be found at UFS specifications 2.1.
54a19b4d 617
d829fc8a
SN
618 The file is read only.
619
620What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_size
621Date: February 2018
622Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
623Description: This file shows the size of addressable logical blocks
624 (calculated as an exponent with base 2). This is one of
625 the UFS unit descriptor parameters. The full information about
626 the descriptor could be found at UFS specifications 2.1.
54a19b4d 627
d829fc8a
SN
628 The file is read only.
629
630What: /sys/class/scsi_device/*/device/unit_descriptor/logical_block_count
631Date: February 2018
632Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
633Description: This file shows total number of addressable logical blocks.
634 This is one of the UFS unit descriptor parameters. The full
635 information about the descriptor could be found at
636 UFS specifications 2.1.
54a19b4d 637
d829fc8a
SN
638 The file is read only.
639
640What: /sys/class/scsi_device/*/device/unit_descriptor/erase_block_size
641Date: February 2018
642Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
643Description: This file shows the erase block size. This is one of
644 the UFS unit descriptor parameters. The full information
645 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 646
d829fc8a
SN
647 The file is read only.
648
649What: /sys/class/scsi_device/*/device/unit_descriptor/provisioning_type
650Date: February 2018
651Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
652Description: This file shows the thin provisioning type. This is one of
653 the UFS unit descriptor parameters. The full information
654 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 655
d829fc8a
SN
656 The file is read only.
657
658What: /sys/class/scsi_device/*/device/unit_descriptor/physical_memory_resourse_count
659Date: February 2018
660Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
661Description: This file shows the total physical memory resources. This is
662 one of the UFS unit descriptor parameters. The full information
663 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 664
d829fc8a
SN
665 The file is read only.
666
667What: /sys/class/scsi_device/*/device/unit_descriptor/context_capabilities
668Date: February 2018
669Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
670Description: This file shows the context capabilities. This is one of
671 the UFS unit descriptor parameters. The full information
672 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 673
d829fc8a
SN
674 The file is read only.
675
676What: /sys/class/scsi_device/*/device/unit_descriptor/large_unit_granularity
677Date: February 2018
678Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
679Description: This file shows the granularity of the LUN. This is one of
680 the UFS unit descriptor parameters. The full information
681 about the descriptor could be found at UFS specifications 2.1.
54a19b4d 682
d829fc8a 683 The file is read only.
d10b2a8e
SN
684
685
686What: /sys/bus/platform/drivers/ufshcd/*/flags/device_init
687Date: February 2018
688Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
689Description: This file shows the device init status. The full information
690 about the flag could be found at UFS specifications 2.1.
54a19b4d 691
d10b2a8e
SN
692 The file is read only.
693
694What: /sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe
695Date: February 2018
696Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
697Description: This file shows whether permanent write protection is enabled.
698 The full information about the flag could be found at
699 UFS specifications 2.1.
54a19b4d 700
d10b2a8e
SN
701 The file is read only.
702
703What: /sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe
704Date: February 2018
705Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
706Description: This file shows whether write protection is enabled on all
707 logical units configured as power on write protected. The
708 full information about the flag could be found at
709 UFS specifications 2.1.
54a19b4d 710
d10b2a8e
SN
711 The file is read only.
712
713What: /sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable
714Date: February 2018
715Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
716Description: This file shows whether the device background operations are
717 enabled. The full information about the flag could be
718 found at UFS specifications 2.1.
54a19b4d 719
d10b2a8e
SN
720 The file is read only.
721
722What: /sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable
723Date: February 2018
724Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
725Description: This file shows whether the device life span mode is enabled.
726 The full information about the flag could be found at
727 UFS specifications 2.1.
54a19b4d 728
d10b2a8e
SN
729 The file is read only.
730
731What: /sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal
732Date: February 2018
733Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
734Description: This file shows whether physical resource removal is enable.
735 The full information about the flag could be found at
736 UFS specifications 2.1.
54a19b4d 737
d10b2a8e
SN
738 The file is read only.
739
740What: /sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc
741Date: February 2018
742Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
743Description: This file shows whether the device is executing internal
744 operation related to real time clock. The full information
745 about the flag could be found at UFS specifications 2.1.
54a19b4d 746
d10b2a8e
SN
747 The file is read only.
748
749What: /sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update
750Date: February 2018
751Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
752Description: This file shows whether the device FW update is permanently
753 disabled. The full information about the flag could be found
754 at UFS specifications 2.1.
54a19b4d 755
d10b2a8e 756 The file is read only.
ec92b59c
SN
757
758
759What: /sys/bus/platform/drivers/ufshcd/*/attributes/boot_lun_enabled
760Date: February 2018
761Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
762Description: This file provides the boot lun enabled UFS device attribute.
763 The full information about the attribute could be found at
764 UFS specifications 2.1.
54a19b4d 765
ec92b59c
SN
766 The file is read only.
767
768What: /sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode
769Date: February 2018
770Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
771Description: This file provides the current power mode UFS device attribute.
772 The full information about the attribute could be found at
773 UFS specifications 2.1.
54a19b4d 774
ec92b59c
SN
775 The file is read only.
776
777What: /sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level
778Date: February 2018
779Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
780Description: This file provides the active icc level UFS device attribute.
781 The full information about the attribute could be found at
782 UFS specifications 2.1.
54a19b4d 783
ec92b59c
SN
784 The file is read only.
785
786What: /sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled
787Date: February 2018
788Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
789Description: This file provides the out of order data transfer enabled UFS
790 device attribute. The full information about the attribute
791 could be found at UFS specifications 2.1.
54a19b4d 792
ec92b59c
SN
793 The file is read only.
794
795What: /sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status
796Date: February 2018
797Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
798Description: This file provides the background operations status UFS device
799 attribute. The full information about the attribute could
800 be found at UFS specifications 2.1.
54a19b4d 801
ec92b59c
SN
802 The file is read only.
803
804What: /sys/bus/platform/drivers/ufshcd/*/attributes/purge_status
805Date: February 2018
806Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
807Description: This file provides the purge operation status UFS device
808 attribute. The full information about the attribute could
809 be found at UFS specifications 2.1.
54a19b4d 810
ec92b59c
SN
811 The file is read only.
812
813What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size
814Date: February 2018
815Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
816Description: This file shows the maximum data size in a DATA IN
817 UPIU. The full information about the attribute could
818 be found at UFS specifications 2.1.
54a19b4d 819
ec92b59c
SN
820 The file is read only.
821
822What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size
823Date: February 2018
824Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
825Description: This file shows the maximum number of bytes that can be
826 requested with a READY TO TRANSFER UPIU. The full information
827 about the attribute could be found at UFS specifications 2.1.
54a19b4d 828
ec92b59c
SN
829 The file is read only.
830
831What: /sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency
832Date: February 2018
833Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
834Description: This file provides the reference clock frequency UFS device
835 attribute. The full information about the attribute could
836 be found at UFS specifications 2.1.
54a19b4d 837
ec92b59c
SN
838 The file is read only.
839
840What: /sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock
841Date: February 2018
842Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
843Description: This file shows whether the configuration descriptor is locked.
844 The full information about the attribute could be found at
845 UFS specifications 2.1. The file is read only.
846
847What: /sys/bus/platform/drivers/ufshcd/*/attributes/max_number_of_rtt
848Date: February 2018
849Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
850Description: This file provides the maximum current number of
851 outstanding RTTs in device that is allowed. The full
852 information about the attribute could be found at
853 UFS specifications 2.1.
54a19b4d 854
ec92b59c
SN
855 The file is read only.
856
857What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control
858Date: February 2018
859Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
860Description: This file provides the exception event control UFS device
861 attribute. The full information about the attribute could
862 be found at UFS specifications 2.1.
54a19b4d 863
ec92b59c
SN
864 The file is read only.
865
866What: /sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status
867Date: February 2018
868Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
869Description: This file provides the exception event status UFS device
870 attribute. The full information about the attribute could
871 be found at UFS specifications 2.1.
54a19b4d 872
ec92b59c
SN
873 The file is read only.
874
875What: /sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status
876Date: February 2018
877Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
878Description: This file provides the ffu status UFS device attribute.
879 The full information about the attribute could be found at
880 UFS specifications 2.1.
54a19b4d 881
ec92b59c
SN
882 The file is read only.
883
884What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_state
885Date: February 2018
886Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
887Description: This file show the PSA feature status. The full information
888 about the attribute could be found at UFS specifications 2.1.
54a19b4d 889
ec92b59c
SN
890 The file is read only.
891
892What: /sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size
893Date: February 2018
894Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
895Description: This file shows the amount of data that the host plans to
896 load to all logical units in pre-soldering state.
897 The full information about the attribute could be found at
898 UFS specifications 2.1.
54a19b4d 899
ec92b59c
SN
900 The file is read only.
901
902
903What: /sys/class/scsi_device/*/device/dyn_cap_needed
904Date: February 2018
905Contact: Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
906Description: This file shows the The amount of physical memory needed
907 to be removed from the physical memory resources pool of
908 the particular logical unit. The full information about
909 the attribute could be found at UFS specifications 2.1.
54a19b4d 910
ec92b59c 911 The file is read only.
114c1aa2
SN
912
913
914What: /sys/bus/platform/drivers/ufshcd/*/rpm_lvl
915Date: September 2014
916Contact: Subhash Jadavani <subhashj@codeaurora.org>
917Description: This entry could be used to set or show the UFS device
918 runtime power management level. The current driver
0b2894cd 919 implementation supports 7 levels with next target states:
54a19b4d
MCC
920
921 == ====================================================
0b2894cd 922 0 UFS device will stay active, UIC link will
54a19b4d 923 stay active
0b2894cd 924 1 UFS device will stay active, UIC link will
54a19b4d 925 hibernate
0b2894cd 926 2 UFS device will be moved to sleep, UIC link will
54a19b4d 927 stay active
0b2894cd 928 3 UFS device will be moved to sleep, UIC link will
54a19b4d 929 hibernate
0b2894cd 930 4 UFS device will be powered off, UIC link will
54a19b4d 931 hibernate
0b2894cd 932 5 UFS device will be powered off, UIC link will
54a19b4d 933 be powered off
0b2894cd 934 6 UFS device will be moved to deep sleep, UIC link
f2cb4b23
LB
935 will be powered off. Note, deep sleep might not be
936 supported in which case this value will not be
937 accepted
54a19b4d 938 == ====================================================
114c1aa2
SN
939
940What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
941Date: February 2018
942Contact: Subhash Jadavani <subhashj@codeaurora.org>
943Description: This entry shows the target power mode of an UFS device
944 for the chosen runtime power management level.
54a19b4d 945
114c1aa2
SN
946 The file is read only.
947
948What: /sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state
949Date: February 2018
950Contact: Subhash Jadavani <subhashj@codeaurora.org>
951Description: This entry shows the target state of an UFS UIC link
952 for the chosen runtime power management level.
54a19b4d 953
114c1aa2
SN
954 The file is read only.
955
956What: /sys/bus/platform/drivers/ufshcd/*/spm_lvl
957Date: September 2014
958Contact: Subhash Jadavani <subhashj@codeaurora.org>
959Description: This entry could be used to set or show the UFS device
960 system power management level. The current driver
0b2894cd 961 implementation supports 7 levels with next target states:
54a19b4d
MCC
962
963 == ====================================================
0b2894cd 964 0 UFS device will stay active, UIC link will
54a19b4d 965 stay active
0b2894cd 966 1 UFS device will stay active, UIC link will
54a19b4d 967 hibernate
0b2894cd 968 2 UFS device will be moved to sleep, UIC link will
54a19b4d 969 stay active
0b2894cd 970 3 UFS device will be moved to sleep, UIC link will
54a19b4d 971 hibernate
0b2894cd 972 4 UFS device will be powered off, UIC link will
54a19b4d 973 hibernate
0b2894cd 974 5 UFS device will be powered off, UIC link will
54a19b4d 975 be powered off
0b2894cd 976 6 UFS device will be moved to deep sleep, UIC link
f2cb4b23
LB
977 will be powered off. Note, deep sleep might not be
978 supported in which case this value will not be
979 accepted
54a19b4d 980 == ====================================================
114c1aa2
SN
981
982What: /sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
983Date: February 2018
984Contact: Subhash Jadavani <subhashj@codeaurora.org>
985Description: This entry shows the target power mode of an UFS device
986 for the chosen system power management level.
54a19b4d 987
114c1aa2
SN
988 The file is read only.
989
990What: /sys/bus/platform/drivers/ufshcd/*/spm_target_link_state
991Date: February 2018
992Contact: Subhash Jadavani <subhashj@codeaurora.org>
993Description: This entry shows the target state of an UFS UIC link
994 for the chosen system power management level.
54a19b4d 995
114c1aa2 996 The file is read only.
f51853fc 997
1d8613a2
CG
998What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable
999Date: January 2021
1000Contact: Can Guo <cang@codeaurora.org>
1001Description: This file shows the status of performance monitor enablement
1002 and it can be used to start/stop the monitor. When the monitor
1003 is stopped, the performance data collected is also cleared.
1004
1005What: /sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size
1006Date: January 2021
1007Contact: Can Guo <cang@codeaurora.org>
1008Description: This file tells the monitor to focus on requests transferring
1009 data of specific chunk size (in Bytes). 0 means any chunk size.
1010 It can only be changed when monitor is disabled.
1011
1012What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors
1013Date: January 2021
1014Contact: Can Guo <cang@codeaurora.org>
1015Description: This file shows how many sectors (in 512 Bytes) have been
1016 sent from device to host after monitor gets started.
1017
1018 The file is read only.
1019
1020What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy
1021Date: January 2021
1022Contact: Can Guo <cang@codeaurora.org>
1023Description: This file shows how long (in micro seconds) has been spent
1024 sending data from device to host after monitor gets started.
1025
1026 The file is read only.
1027
1028What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests
1029Date: January 2021
1030Contact: Can Guo <cang@codeaurora.org>
1031Description: This file shows how many read requests have been sent after
1032 monitor gets started.
1033
1034 The file is read only.
1035
1036What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max
1037Date: January 2021
1038Contact: Can Guo <cang@codeaurora.org>
1039Description: This file shows the maximum latency (in micro seconds) of
1040 read requests after monitor gets started.
1041
1042 The file is read only.
1043
1044What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min
1045Date: January 2021
1046Contact: Can Guo <cang@codeaurora.org>
1047Description: This file shows the minimum latency (in micro seconds) of
1048 read requests after monitor gets started.
1049
1050 The file is read only.
1051
1052What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg
1053Date: January 2021
1054Contact: Can Guo <cang@codeaurora.org>
1055Description: This file shows the average latency (in micro seconds) of
1056 read requests after monitor gets started.
1057
1058 The file is read only.
1059
1060What: /sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum
1061Date: January 2021
1062Contact: Can Guo <cang@codeaurora.org>
1063Description: This file shows the total latency (in micro seconds) of
1064 read requests sent after monitor gets started.
1065
1066 The file is read only.
1067
1068What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors
1069Date: January 2021
1070Contact: Can Guo <cang@codeaurora.org>
1071Description: This file shows how many sectors (in 512 Bytes) have been sent
1072 from host to device after monitor gets started.
1073
1074 The file is read only.
1075
1076What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy
1077Date: January 2021
1078Contact: Can Guo <cang@codeaurora.org>
1079Description: This file shows how long (in micro seconds) has been spent
1080 sending data from host to device after monitor gets started.
1081
1082 The file is read only.
1083
1084What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests
1085Date: January 2021
1086Contact: Can Guo <cang@codeaurora.org>
1087Description: This file shows how many write requests have been sent after
1088 monitor gets started.
1089
1090 The file is read only.
1091
1092What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max
1093Date: January 2021
1094Contact: Can Guo <cang@codeaurora.org>
1095Description: This file shows the maximum latency (in micro seconds) of write
1096 requests after monitor gets started.
1097
1098 The file is read only.
1099
1100What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min
1101Date: January 2021
1102Contact: Can Guo <cang@codeaurora.org>
1103Description: This file shows the minimum latency (in micro seconds) of write
1104 requests after monitor gets started.
1105
1106 The file is read only.
1107
1108What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg
1109Date: January 2021
1110Contact: Can Guo <cang@codeaurora.org>
1111Description: This file shows the average latency (in micro seconds) of write
1112 requests after monitor gets started.
1113
1114 The file is read only.
1115
1116What: /sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum
1117Date: January 2021
1118Contact: Can Guo <cang@codeaurora.org>
1119Description: This file shows the total latency (in micro seconds) of write
1120 requests after monitor gets started.
1121
1122 The file is read only.
1123
f51853fc
AD
1124What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
1125Date: June 2020
1126Contact: Asutosh Das <asutoshd@codeaurora.org>
1127Description: This entry shows if preserve user-space was configured
54a19b4d 1128
f51853fc
AD
1129 The file is read only.
1130
1131What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units
1132Date: June 2020
1133Contact: Asutosh Das <asutoshd@codeaurora.org>
1134Description: This entry shows the shared allocated units of WB buffer
54a19b4d 1135
f51853fc
AD
1136 The file is read only.
1137
1138What: /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type
1139Date: June 2020
1140Contact: Asutosh Das <asutoshd@codeaurora.org>
1141Description: This entry shows the configured WB type.
1142 0x1 for shared buffer mode. 0x0 for dedicated buffer mode.
54a19b4d 1143
f51853fc
AD
1144 The file is read only.
1145
1146What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
1147Date: June 2020
1148Contact: Asutosh Das <asutoshd@codeaurora.org>
1149Description: This entry shows the total user-space decrease in shared
1150 buffer mode.
1151 The value of this parameter is 3 for TLC NAND when SLC mode
1152 is used as WriteBooster Buffer. 2 for MLC NAND.
54a19b4d 1153
f51853fc
AD
1154 The file is read only.
1155
1156What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units
1157Date: June 2020
1158Contact: Asutosh Das <asutoshd@codeaurora.org>
1159Description: This entry shows the Maximum total WriteBooster Buffer size
1160 which is supported by the entire device.
54a19b4d 1161
f51853fc
AD
1162 The file is read only.
1163
1164What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
1165Date: June 2020
1166Contact: Asutosh Das <asutoshd@codeaurora.org>
1167Description: This entry shows the maximum number of luns that can support
1168 WriteBooster.
54a19b4d 1169
f51853fc
AD
1170 The file is read only.
1171
1172What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
1173Date: June 2020
1174Contact: Asutosh Das <asutoshd@codeaurora.org>
1175Description: The supportability of user space reduction mode
1176 and preserve user space mode.
1177 00h: WriteBooster Buffer can be configured only in
1178 user space reduction type.
1179 01h: WriteBooster Buffer can be configured only in
1180 preserve user space type.
1181 02h: Device can be configured in either user space
1182 reduction type or preserve user space type.
54a19b4d 1183
f51853fc
AD
1184 The file is read only.
1185
1186What: /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
1187Date: June 2020
1188Contact: Asutosh Das <asutoshd@codeaurora.org>
1189Description: The supportability of WriteBooster Buffer type.
54a19b4d
MCC
1190
1191 === ==========================================================
1192 00h LU based WriteBooster Buffer configuration
1193 01h Single shared WriteBooster Buffer configuration
1194 02h Supporting both LU based WriteBooster.
1195 Buffer and Single shared WriteBooster Buffer configuration
1196 === ==========================================================
1197
f51853fc
AD
1198 The file is read only.
1199
1200What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
1201Date: June 2020
1202Contact: Asutosh Das <asutoshd@codeaurora.org>
1203Description: This entry shows the status of WriteBooster.
54a19b4d
MCC
1204
1205 == ============================
1206 0 WriteBooster is not enabled.
1207 1 WriteBooster is enabled
1208 == ============================
1209
f51853fc
AD
1210 The file is read only.
1211
1212What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
1213Date: June 2020
1214Contact: Asutosh Das <asutoshd@codeaurora.org>
1215Description: This entry shows if flush is enabled.
54a19b4d
MCC
1216
1217 == =================================
1218 0 Flush operation is not performed.
1219 1 Flush operation is performed.
1220 == =================================
1221
f51853fc
AD
1222 The file is read only.
1223
1224What: /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8
1225Date: June 2020
1226Contact: Asutosh Das <asutoshd@codeaurora.org>
1227Description: Flush WriteBooster Buffer during hibernate state.
54a19b4d
MCC
1228
1229 == =================================================
1230 0 Device is not allowed to flush the
1231 WriteBooster Buffer during link hibernate state.
1232 1 Device is allowed to flush the
1233 WriteBooster Buffer during link hibernate state.
1234 == =================================================
1235
f51853fc
AD
1236 The file is read only.
1237
1238What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf
1239Date: June 2020
1240Contact: Asutosh Das <asutoshd@codeaurora.org>
1241Description: This entry shows the amount of unused WriteBooster buffer
1242 available.
54a19b4d 1243
f51853fc
AD
1244 The file is read only.
1245
1246What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
1247Date: June 2020
1248Contact: Asutosh Das <asutoshd@codeaurora.org>
1249Description: This entry shows the amount of unused current buffer.
54a19b4d 1250
f51853fc
AD
1251 The file is read only.
1252
1253What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status
1254Date: June 2020
1255Contact: Asutosh Das <asutoshd@codeaurora.org>
1256Description: This entry shows the flush operation status.
54a19b4d
MCC
1257
1258
1259 === ======================================
1260 00h idle
1261 01h Flush operation in progress
1262 02h Flush operation stopped prematurely.
1263 03h Flush operation completed successfully
1264 04h Flush operation general failure
1265 === ======================================
1266
f51853fc
AD
1267 The file is read only.
1268
1269What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est
1270Date: June 2020
1271Contact: Asutosh Das <asutoshd@codeaurora.org>
1272Description: This entry shows an indication of the WriteBooster Buffer
1273 lifetime based on the amount of performed program/erase cycles
54a19b4d
MCC
1274
1275 === =============================================
1276 01h 0% - 10% WriteBooster Buffer life time used
f51853fc 1277 ...
54a19b4d
MCC
1278 0Ah 90% - 100% WriteBooster Buffer life time used
1279 === =============================================
1280
f51853fc
AD
1281 The file is read only.
1282
1283What: /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
1284Date: June 2020
1285Contact: Asutosh Das <asutoshd@codeaurora.org>
1286Description: This entry shows the configured size of WriteBooster buffer.
1287 0400h corresponds to 4GB.
54a19b4d 1288
f51853fc 1289 The file is read only.
06aea266
BH
1290
1291What: /sys/bus/platform/drivers/ufshcd/*/wb_on
1292Date: January 2021
1293Contact: Bean Huo <beanhuo@micron.com>
1294Description: This node is used to set or display whether UFS WriteBooster is
1295 enabled. Echo 0 to this file to disable UFS WriteBooster or 1 to
1296 enable it. The WriteBooster is enabled after power-on/reset,
1297 however, it will be disabled/enable while CLK scaling down/up
1298 (if the platform supports UFSHCD_CAP_CLK_SCALING). For a
1299 platform that doesn't support UFSHCD_CAP_CLK_SCALING, we can
1300 disable/enable WriteBooster through this sysfs node.