xref: /linux/Documentation/ABI/testing/sysfs-driver-ufs (revision 3a39d672e7f48b8d6b91a09afa4b55352773b4b5)
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
15What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_type
16What:		/sys/bus/platform/devices/*.ufs/device_descriptor/device_type
17Date:		February 2018
18Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
19Description:	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
25What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_class
26What:		/sys/bus/platform/devices/*.ufs/device_descriptor/device_class
27Date:		February 2018
28Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
29Description:	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
35What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_sub_class
36What:		/sys/bus/platform/devices/*.ufs/device_descriptor/device_sub_class
37Date:		February 2018
38Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
39Description:	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
45What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/protocol
46What:		/sys/bus/platform/devices/*.ufs/device_descriptor/protocol
47Date:		February 2018
48Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
49Description:	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
56What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_luns
57What:		/sys/bus/platform/devices/*.ufs/device_descriptor/number_of_luns
58Date:		February 2018
59Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
60Description:	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
66What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_wluns
67What:		/sys/bus/platform/devices/*.ufs/device_descriptor/number_of_wluns
68Date:		February 2018
69Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
70Description:	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
77What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/boot_enable
78What:		/sys/bus/platform/devices/*.ufs/device_descriptor/boot_enable
79Date:		February 2018
80Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
81Description:	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
88What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/descriptor_access_enable
89What:		/sys/bus/platform/devices/*.ufs/device_descriptor/descriptor_access_enable
90Date:		February 2018
91Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
92Description:	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
100What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_power_mode
101What:		/sys/bus/platform/devices/*.ufs/device_descriptor/initial_power_mode
102Date:		February 2018
103Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
104Description:	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
111What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/high_priority_lun
112What:		/sys/bus/platform/devices/*.ufs/device_descriptor/high_priority_lun
113Date:		February 2018
114Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
115Description:	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
121What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/secure_removal_type
122What:		/sys/bus/platform/devices/*.ufs/device_descriptor/secure_removal_type
123Date:		February 2018
124Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
125Description:	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
131What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/support_security_lun
132What:		/sys/bus/platform/devices/*.ufs/device_descriptor/support_security_lun
133Date:		February 2018
134Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
135Description:	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
142What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/bkops_termination_latency
143What:		/sys/bus/platform/devices/*.ufs/device_descriptor/bkops_termination_latency
144Date:		February 2018
145Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
146Description:	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
153What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/initial_active_icc_level
154What:		/sys/bus/platform/devices/*.ufs/device_descriptor/initial_active_icc_level
155Date:		February 2018
156Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
157Description:	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
163What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/specification_version
164What:		/sys/bus/platform/devices/*.ufs/device_descriptor/specification_version
165Date:		February 2018
166Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
167Description:	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
173What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturing_date
174What:		/sys/bus/platform/devices/*.ufs/device_descriptor/manufacturing_date
175Date:		February 2018
176Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
177Description:	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
184What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/manufacturer_id
185What:		/sys/bus/platform/devices/*.ufs/device_descriptor/manufacturer_id
186Date:		February 2018
187Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
188Description:	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
194What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtt_capability
195What:		/sys/bus/platform/devices/*.ufs/device_descriptor/rtt_capability
196Date:		February 2018
197Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
198Description:	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
205What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/rtc_update
206What:		/sys/bus/platform/devices/*.ufs/device_descriptor/rtc_update
207Date:		February 2018
208Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
209Description:	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
216What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/ufs_features
217What:		/sys/bus/platform/devices/*.ufs/device_descriptor/ufs_features
218Date:		February 2018
219Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
220Description:	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
227What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/ffu_timeout
228What:		/sys/bus/platform/devices/*.ufs/device_descriptor/ffu_timeout
229Date:		February 2018
230Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
231Description:	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
237What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/queue_depth
238What:		/sys/bus/platform/devices/*.ufs/device_descriptor/queue_depth
239Date:		February 2018
240Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
241Description:	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
247What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/device_version
248What:		/sys/bus/platform/devices/*.ufs/device_descriptor/device_version
249Date:		February 2018
250Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
251Description:	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
257What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/number_of_secure_wpa
258What:		/sys/bus/platform/devices/*.ufs/device_descriptor/number_of_secure_wpa
259Date:		February 2018
260Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
261Description:	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
268What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_max_data_size
269What:		/sys/bus/platform/devices/*.ufs/device_descriptor/psa_max_data_size
270Date:		February 2018
271Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
272Description:	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
280What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/psa_state_timeout
281What:		/sys/bus/platform/devices/*.ufs/device_descriptor/psa_state_timeout
282Date:		February 2018
283Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
284Description:	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
292What:		/sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/unipro_version
293What:		/sys/bus/platform/devices/*.ufs/interconnect_descriptor/unipro_version
294Date:		February 2018
295Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
296Description:	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
303What:		/sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/mphy_version
304What:		/sys/bus/platform/devices/*.ufs/interconnect_descriptor/mphy_version
305Date:		February 2018
306Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
307Description:	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
315What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/raw_device_capacity
316What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/raw_device_capacity
317Date:		February 2018
318Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
319Description:	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
327What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_luns
328What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/max_number_of_luns
329Date:		February 2018
330Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
331Description:	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
338What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/segment_size
339What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/segment_size
340Date:		February 2018
341Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
342Description:	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
348What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/allocation_unit_size
349What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/allocation_unit_size
350Date:		February 2018
351Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
352Description:	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
358What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/min_addressable_block_size
359What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/min_addressable_block_size
360Date:		February 2018
361Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
362Description:	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
369What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_read_block_size
370What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/optimal_read_block_size
371Date:		February 2018
372Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
373Description:	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
380What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/optimal_write_block_size
381What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/optimal_write_block_size
382Date:		February 2018
383Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
384Description:	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
391What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_in_buffer_size
392What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/max_in_buffer_size
393Date:		February 2018
394Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
395Description:	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
402What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_out_buffer_size
403What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/max_out_buffer_size
404Date:		February 2018
405Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
406Description:	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
413What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/rpmb_rw_size
414What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/rpmb_rw_size
415Date:		February 2018
416Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
417Description:	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
424What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/dyn_capacity_resource_policy
425What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/dyn_capacity_resource_policy
426Date:		February 2018
427Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
428Description:	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
435What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/data_ordering
436What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/data_ordering
437Date:		February 2018
438Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
439Description:	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
446What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/max_number_of_contexts
447What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/max_number_of_contexts
448Date:		February 2018
449Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
450Description:	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
457What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_unit_size
458What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/sys_data_tag_unit_size
459Date:		February 2018
460Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
461Description:	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
467What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/sys_data_tag_resource_size
468What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/sys_data_tag_resource_size
469Date:		February 2018
470Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
471Description:	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
479What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/secure_removal_types
480What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/secure_removal_types
481Date:		February 2018
482Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
483Description:	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
490What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/memory_types
491What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/memory_types
492Date:		February 2018
493Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
494Description:	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
501What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_max_alloc_units
502What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/*_memory_max_alloc_units
503Date:		February 2018
504Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
505Description:	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
513What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/*_memory_capacity_adjustment_factor
514What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/*_memory_capacity_adjustment_factor
515Date:		February 2018
516Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
517Description:	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
526What:		/sys/bus/platform/drivers/ufshcd/*/health_descriptor/eol_info
527What:		/sys/bus/platform/devices/*.ufs/health_descriptor/eol_info
528Date:		February 2018
529Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
530Description:	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
537What:		/sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_a
538What:		/sys/bus/platform/devices/*.ufs/health_descriptor/life_time_estimation_a
539Date:		February 2018
540Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
541Description:	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
548What:		/sys/bus/platform/drivers/ufshcd/*/health_descriptor/life_time_estimation_b
549What:		/sys/bus/platform/devices/*.ufs/health_descriptor/life_time_estimation_b
550Date:		February 2018
551Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
552Description:	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
560What:		/sys/bus/platform/drivers/ufshcd/*/power_descriptor/active_icc_levels_vcc*
561What:		/sys/bus/platform/devices/*.ufs/power_descriptor/active_icc_levels_vcc*
562Date:		February 2018
563Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
564Description:	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
572What:		/sys/bus/platform/drivers/ufshcd/*/string_descriptors/manufacturer_name
573What:		/sys/bus/platform/devices/*.ufs/string_descriptors/manufacturer_name
574Date:		February 2018
575Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
576Description:	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
582What:		/sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_name
583What:		/sys/bus/platform/devices/*.ufs/string_descriptors/product_name
584Date:		February 2018
585Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
586Description:	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
591What:		/sys/bus/platform/drivers/ufshcd/*/string_descriptors/oem_id
592What:		/sys/bus/platform/devices/*.ufs/string_descriptors/oem_id
593Date:		February 2018
594Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
595Description:	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
600What:		/sys/bus/platform/drivers/ufshcd/*/string_descriptors/serial_number
601What:		/sys/bus/platform/devices/*.ufs/string_descriptors/serial_number
602Date:		February 2018
603Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
604Description:	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
610What:		/sys/bus/platform/drivers/ufshcd/*/string_descriptors/product_revision
611What:		/sys/bus/platform/devices/*.ufs/string_descriptors/product_revision
612Date:		February 2018
613Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
614Description:	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
621What:		/sys/class/scsi_device/*/device/unit_descriptor/boot_lun_id
622Date:		February 2018
623Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
624Description:	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
630What:		/sys/class/scsi_device/*/device/unit_descriptor/lun_write_protect
631Date:		February 2018
632Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
633Description:	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
639What:		/sys/class/scsi_device/*/device/unit_descriptor/lun_queue_depth
640Date:		February 2018
641Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
642Description:	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
648What:		/sys/class/scsi_device/*/device/unit_descriptor/psa_sensitive
649Date:		February 2018
650Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
651Description:	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
657What:		/sys/class/scsi_device/*/device/unit_descriptor/lun_memory_type
658Date:		February 2018
659Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
660Description:	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
666What:		/sys/class/scsi_device/*/device/unit_descriptor/data_reliability
667Date:		February 2018
668Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
669Description:	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
676What:		/sys/class/scsi_device/*/device/unit_descriptor/logical_block_size
677Date:		February 2018
678Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
679Description:	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
686What:		/sys/class/scsi_device/*/device/unit_descriptor/logical_block_count
687Date:		February 2018
688Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
689Description:	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
696What:		/sys/class/scsi_device/*/device/unit_descriptor/erase_block_size
697Date:		February 2018
698Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
699Description:	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
705What:		/sys/class/scsi_device/*/device/unit_descriptor/provisioning_type
706Date:		February 2018
707Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
708Description:	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
714What:		/sys/class/scsi_device/*/device/unit_descriptor/physical_memory_resourse_count
715Date:		February 2018
716Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
717Description:	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
723What:		/sys/class/scsi_device/*/device/unit_descriptor/context_capabilities
724Date:		February 2018
725Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
726Description:	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
732What:		/sys/class/scsi_device/*/device/unit_descriptor/large_unit_granularity
733Date:		February 2018
734Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
735Description:	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
742What:		/sys/bus/platform/drivers/ufshcd/*/flags/device_init
743What:		/sys/bus/platform/devices/*.ufs/flags/device_init
744Date:		February 2018
745Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
746Description:	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
751What:		/sys/bus/platform/drivers/ufshcd/*/flags/permanent_wpe
752What:		/sys/bus/platform/devices/*.ufs/flags/permanent_wpe
753Date:		February 2018
754Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
755Description:	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
761What:		/sys/bus/platform/drivers/ufshcd/*/flags/power_on_wpe
762What:		/sys/bus/platform/devices/*.ufs/flags/power_on_wpe
763Date:		February 2018
764Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
765Description:	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
772What:		/sys/bus/platform/drivers/ufshcd/*/flags/bkops_enable
773What:		/sys/bus/platform/devices/*.ufs/flags/bkops_enable
774Date:		February 2018
775Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
776Description:	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
782What:		/sys/bus/platform/drivers/ufshcd/*/flags/life_span_mode_enable
783What:		/sys/bus/platform/devices/*.ufs/flags/life_span_mode_enable
784Date:		February 2018
785Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
786Description:	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
792What:		/sys/bus/platform/drivers/ufshcd/*/flags/phy_resource_removal
793What:		/sys/bus/platform/devices/*.ufs/flags/phy_resource_removal
794Date:		February 2018
795Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
796Description:	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
802What:		/sys/bus/platform/drivers/ufshcd/*/flags/busy_rtc
803What:		/sys/bus/platform/devices/*.ufs/flags/busy_rtc
804Date:		February 2018
805Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
806Description:	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
812What:		/sys/bus/platform/drivers/ufshcd/*/flags/disable_fw_update
813What:		/sys/bus/platform/devices/*.ufs/flags/disable_fw_update
814Date:		February 2018
815Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
816Description:	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
823What:		/sys/bus/platform/drivers/ufshcd/*/attributes/boot_lun_enabled
824What:		/sys/bus/platform/devices/*.ufs/attributes/boot_lun_enabled
825Date:		February 2018
826Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
827Description:	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
833What:		/sys/bus/platform/drivers/ufshcd/*/attributes/current_power_mode
834What:		/sys/bus/platform/devices/*.ufs/attributes/current_power_mode
835Date:		February 2018
836Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
837Description:	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
843What:		/sys/bus/platform/drivers/ufshcd/*/attributes/active_icc_level
844What:		/sys/bus/platform/devices/*.ufs/attributes/active_icc_level
845Date:		February 2018
846Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
847Description:	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
853What:		/sys/bus/platform/drivers/ufshcd/*/attributes/ooo_data_enabled
854What:		/sys/bus/platform/devices/*.ufs/attributes/ooo_data_enabled
855Date:		February 2018
856Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
857Description:	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
863What:		/sys/bus/platform/drivers/ufshcd/*/attributes/bkops_status
864What:		/sys/bus/platform/devices/*.ufs/attributes/bkops_status
865Date:		February 2018
866Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
867Description:	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
873What:		/sys/bus/platform/drivers/ufshcd/*/attributes/purge_status
874What:		/sys/bus/platform/devices/*.ufs/attributes/purge_status
875Date:		February 2018
876Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
877Description:	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
883What:		/sys/bus/platform/drivers/ufshcd/*/attributes/max_data_in_size
884What:		/sys/bus/platform/devices/*.ufs/attributes/max_data_in_size
885Date:		February 2018
886Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
887Description:	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
893What:		/sys/bus/platform/drivers/ufshcd/*/attributes/max_data_out_size
894What:		/sys/bus/platform/devices/*.ufs/attributes/max_data_out_size
895Date:		February 2018
896Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
897Description:	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
903What:		/sys/bus/platform/drivers/ufshcd/*/attributes/reference_clock_frequency
904What:		/sys/bus/platform/devices/*.ufs/attributes/reference_clock_frequency
905Date:		February 2018
906Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
907Description:	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
913What:		/sys/bus/platform/drivers/ufshcd/*/attributes/configuration_descriptor_lock
914What:		/sys/bus/platform/devices/*.ufs/attributes/configuration_descriptor_lock
915Date:		February 2018
916Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
917Description:	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
921What:		/sys/bus/platform/drivers/ufshcd/*/attributes/max_number_of_rtt
922What:		/sys/bus/platform/devices/*.ufs/attributes/max_number_of_rtt
923Date:		May 2024
924Contact:	Avri Altman <avri.altman@wdc.com>
925Description:	This file provides the maximum current number of
926		outstanding RTTs in device that is allowed. bMaxNumOfRTT is a
927		read-write persistent attribute and is equal to two after device
928		manufacturing. It shall not be set to a value greater than
929		bDeviceRTTCap value, and it may be set only when the hw queues are
930		empty.
931
932		The file is read write.
933
934What:		/sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_control
935What:		/sys/bus/platform/devices/*.ufs/attributes/exception_event_control
936Date:		February 2018
937Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
938Description:	This file provides the exception event control UFS device
939		attribute. The full information about the attribute could
940		be found at UFS specifications 2.1.
941
942		The file is read only.
943
944What:		/sys/bus/platform/drivers/ufshcd/*/attributes/exception_event_status
945What:		/sys/bus/platform/devices/*.ufs/attributes/exception_event_status
946Date:		February 2018
947Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
948Description:	This file provides the exception event status UFS device
949		attribute. The full information about the attribute could
950		be found at UFS specifications 2.1.
951
952		The file is read only.
953
954What:		/sys/bus/platform/drivers/ufshcd/*/attributes/ffu_status
955What:		/sys/bus/platform/devices/*.ufs/attributes/ffu_status
956Date:		February 2018
957Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
958Description:	This file provides the ffu status UFS device attribute.
959		The full information about the attribute could be found at
960		UFS specifications 2.1.
961
962		The file is read only.
963
964What:		/sys/bus/platform/drivers/ufshcd/*/attributes/psa_state
965What:		/sys/bus/platform/devices/*.ufs/attributes/psa_state
966Date:		February 2018
967Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
968Description:	This file show the PSA feature status. The full information
969		about the attribute could be found at UFS specifications 2.1.
970
971		The file is read only.
972
973What:		/sys/bus/platform/drivers/ufshcd/*/attributes/psa_data_size
974What:		/sys/bus/platform/devices/*.ufs/attributes/psa_data_size
975Date:		February 2018
976Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
977Description:	This file shows the amount of data that the host plans to
978		load to all logical units in pre-soldering state.
979		The full information about the attribute could be found at
980		UFS specifications 2.1.
981
982		The file is read only.
983
984
985What:		/sys/class/scsi_device/*/device/dyn_cap_needed
986Date:		February 2018
987Contact:	Stanislav Nijnikov <stanislav.nijnikov@wdc.com>
988Description:	This file shows the amount of physical memory needed
989		to be removed from the physical memory resources pool of
990		the particular logical unit. The full information about
991		the attribute could be found at UFS specifications 2.1.
992
993		The file is read only.
994
995
996What:		/sys/bus/platform/drivers/ufshcd/*/rpm_lvl
997What:		/sys/bus/platform/devices/*.ufs/rpm_lvl
998Date:		September 2014
999Contact:	Can Guo <quic_cang@quicinc.com>
1000Description:	This entry could be used to set or show the UFS device
1001		runtime power management level. The current driver
1002		implementation supports 7 levels with next target states:
1003
1004		==  ====================================================
1005		0   UFS device will stay active, UIC link will
1006		    stay active
1007		1   UFS device will stay active, UIC link will
1008		    hibernate
1009		2   UFS device will be moved to sleep, UIC link will
1010		    stay active
1011		3   UFS device will be moved to sleep, UIC link will
1012		    hibernate
1013		4   UFS device will be powered off, UIC link will
1014		    hibernate
1015		5   UFS device will be powered off, UIC link will
1016		    be powered off
1017		6   UFS device will be moved to deep sleep, UIC link
1018		    will be powered off. Note, deep sleep might not be
1019		    supported in which case this value will not be
1020		    accepted
1021		==  ====================================================
1022
1023What:		/sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
1024What:		/sys/bus/platform/devices/*.ufs/rpm_target_dev_state
1025Date:		February 2018
1026Contact:	Can Guo <quic_cang@quicinc.com>
1027Description:	This entry shows the target power mode of an UFS device
1028		for the chosen runtime power management level.
1029
1030		The file is read only.
1031
1032What:		/sys/bus/platform/drivers/ufshcd/*/rpm_target_link_state
1033What:		/sys/bus/platform/devices/*.ufs/rpm_target_link_state
1034Date:		February 2018
1035Contact:	Can Guo <quic_cang@quicinc.com>
1036Description:	This entry shows the target state of an UFS UIC link
1037		for the chosen runtime power management level.
1038
1039		The file is read only.
1040
1041What:		/sys/bus/platform/drivers/ufshcd/*/spm_lvl
1042What:		/sys/bus/platform/devices/*.ufs/spm_lvl
1043Date:		September 2014
1044Contact:	Can Guo <quic_cang@quicinc.com>
1045Description:	This entry could be used to set or show the UFS device
1046		system power management level. The current driver
1047		implementation supports 7 levels with next target states:
1048
1049		==  ====================================================
1050		0   UFS device will stay active, UIC link will
1051		    stay active
1052		1   UFS device will stay active, UIC link will
1053		    hibernate
1054		2   UFS device will be moved to sleep, UIC link will
1055		    stay active
1056		3   UFS device will be moved to sleep, UIC link will
1057		    hibernate
1058		4   UFS device will be powered off, UIC link will
1059		    hibernate
1060		5   UFS device will be powered off, UIC link will
1061		    be powered off
1062		6   UFS device will be moved to deep sleep, UIC link
1063		    will be powered off. Note, deep sleep might not be
1064		    supported in which case this value will not be
1065		    accepted
1066		==  ====================================================
1067
1068What:		/sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
1069What:		/sys/bus/platform/devices/*.ufs/spm_target_dev_state
1070Date:		February 2018
1071Contact:	Can Guo <quic_cang@quicinc.com>
1072Description:	This entry shows the target power mode of an UFS device
1073		for the chosen system power management level.
1074
1075		The file is read only.
1076
1077What:		/sys/bus/platform/drivers/ufshcd/*/spm_target_link_state
1078What:		/sys/bus/platform/devices/*.ufs/spm_target_link_state
1079Date:		February 2018
1080Contact:	Can Guo <quic_cang@quicinc.com>
1081Description:	This entry shows the target state of an UFS UIC link
1082		for the chosen system power management level.
1083
1084		The file is read only.
1085
1086What:		/sys/bus/platform/drivers/ufshcd/*/monitor/monitor_enable
1087What:		/sys/bus/platform/devices/*.ufs/monitor/monitor_enable
1088Date:		January 2021
1089Contact:	Can Guo <quic_cang@quicinc.com>
1090Description:	This file shows the status of performance monitor enablement
1091		and it can be used to start/stop the monitor. When the monitor
1092		is stopped, the performance data collected is also cleared.
1093
1094What:		/sys/bus/platform/drivers/ufshcd/*/monitor/monitor_chunk_size
1095What:		/sys/bus/platform/devices/*.ufs/monitor/monitor_chunk_size
1096Date:		January 2021
1097Contact:	Can Guo <quic_cang@quicinc.com>
1098Description:	This file tells the monitor to focus on requests transferring
1099		data of specific chunk size (in Bytes). 0 means any chunk size.
1100		It can only be changed when monitor is disabled.
1101
1102What:		/sys/bus/platform/drivers/ufshcd/*/monitor/read_total_sectors
1103What:		/sys/bus/platform/devices/*.ufs/monitor/read_total_sectors
1104Date:		January 2021
1105Contact:	Can Guo <quic_cang@quicinc.com>
1106Description:	This file shows how many sectors (in 512 Bytes) have been
1107		sent from device to host after monitor gets started.
1108
1109		The file is read only.
1110
1111What:		/sys/bus/platform/drivers/ufshcd/*/monitor/read_total_busy
1112What:		/sys/bus/platform/devices/*.ufs/monitor/read_total_busy
1113Date:		January 2021
1114Contact:	Can Guo <quic_cang@quicinc.com>
1115Description:	This file shows how long (in micro seconds) has been spent
1116		sending data from device to host after monitor gets started.
1117
1118		The file is read only.
1119
1120What:		/sys/bus/platform/drivers/ufshcd/*/monitor/read_nr_requests
1121What:		/sys/bus/platform/devices/*.ufs/monitor/read_nr_requests
1122Date:		January 2021
1123Contact:	Can Guo <quic_cang@quicinc.com>
1124Description:	This file shows how many read requests have been sent after
1125		monitor gets started.
1126
1127		The file is read only.
1128
1129What:		/sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_max
1130What:		/sys/bus/platform/devices/*.ufs/monitor/read_req_latency_max
1131Date:		January 2021
1132Contact:	Can Guo <quic_cang@quicinc.com>
1133Description:	This file shows the maximum latency (in micro seconds) of
1134		read requests after monitor gets started.
1135
1136		The file is read only.
1137
1138What:		/sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_min
1139What:		/sys/bus/platform/devices/*.ufs/monitor/read_req_latency_min
1140Date:		January 2021
1141Contact:	Can Guo <quic_cang@quicinc.com>
1142Description:	This file shows the minimum latency (in micro seconds) of
1143		read requests after monitor gets started.
1144
1145		The file is read only.
1146
1147What:		/sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_avg
1148What:		/sys/bus/platform/devices/*.ufs/monitor/read_req_latency_avg
1149Date:		January 2021
1150Contact:	Can Guo <quic_cang@quicinc.com>
1151Description:	This file shows the average latency (in micro seconds) of
1152		read requests after monitor gets started.
1153
1154		The file is read only.
1155
1156What:		/sys/bus/platform/drivers/ufshcd/*/monitor/read_req_latency_sum
1157What:		/sys/bus/platform/devices/*.ufs/monitor/read_req_latency_sum
1158Date:		January 2021
1159Contact:	Can Guo <quic_cang@quicinc.com>
1160Description:	This file shows the total latency (in micro seconds) of
1161		read requests sent after monitor gets started.
1162
1163		The file is read only.
1164
1165What:		/sys/bus/platform/drivers/ufshcd/*/monitor/write_total_sectors
1166What:		/sys/bus/platform/devices/*.ufs/monitor/write_total_sectors
1167Date:		January 2021
1168Contact:	Can Guo <quic_cang@quicinc.com>
1169Description:	This file shows how many sectors (in 512 Bytes) have been sent
1170		from host to device after monitor gets started.
1171
1172		The file is read only.
1173
1174What:		/sys/bus/platform/drivers/ufshcd/*/monitor/write_total_busy
1175What:		/sys/bus/platform/devices/*.ufs/monitor/write_total_busy
1176Date:		January 2021
1177Contact:	Can Guo <quic_cang@quicinc.com>
1178Description:	This file shows how long (in micro seconds) has been spent
1179		sending data from host to device after monitor gets started.
1180
1181		The file is read only.
1182
1183What:		/sys/bus/platform/drivers/ufshcd/*/monitor/write_nr_requests
1184What:		/sys/bus/platform/devices/*.ufs/monitor/write_nr_requests
1185Date:		January 2021
1186Contact:	Can Guo <quic_cang@quicinc.com>
1187Description:	This file shows how many write requests have been sent after
1188		monitor gets started.
1189
1190		The file is read only.
1191
1192What:		/sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_max
1193What:		/sys/bus/platform/devices/*.ufs/monitor/write_req_latency_max
1194Date:		January 2021
1195Contact:	Can Guo <quic_cang@quicinc.com>
1196Description:	This file shows the maximum latency (in micro seconds) of write
1197		requests after monitor gets started.
1198
1199		The file is read only.
1200
1201What:		/sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_min
1202What:		/sys/bus/platform/devices/*.ufs/monitor/write_req_latency_min
1203Date:		January 2021
1204Contact:	Can Guo <quic_cang@quicinc.com>
1205Description:	This file shows the minimum latency (in micro seconds) of write
1206		requests after monitor gets started.
1207
1208		The file is read only.
1209
1210What:		/sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_avg
1211What:		/sys/bus/platform/devices/*.ufs/monitor/write_req_latency_avg
1212Date:		January 2021
1213Contact:	Can Guo <quic_cang@quicinc.com>
1214Description:	This file shows the average latency (in micro seconds) of write
1215		requests after monitor gets started.
1216
1217		The file is read only.
1218
1219What:		/sys/bus/platform/drivers/ufshcd/*/monitor/write_req_latency_sum
1220What:		/sys/bus/platform/devices/*.ufs/monitor/write_req_latency_sum
1221Date:		January 2021
1222Contact:	Can Guo <quic_cang@quicinc.com>
1223Description:	This file shows the total latency (in micro seconds) of write
1224		requests after monitor gets started.
1225
1226		The file is read only.
1227
1228What:		/sys/bus/platform/drivers/ufshcd/*/power_info/lane
1229What:		/sys/bus/platform/devices/*.ufs/power_info/lane
1230Date:		September 2023
1231Contact:	Can Guo <quic_cang@quicinc.com>
1232Description:	This file shows how many lanes are enabled on the UFS link,
1233		i.e., an output 2 means UFS link is operating with 2 lanes.
1234
1235		The file is read only.
1236
1237What:		/sys/bus/platform/drivers/ufshcd/*/power_info/mode
1238What:		/sys/bus/platform/devices/*.ufs/power_info/mode
1239Date:		September 2023
1240Contact:	Can Guo <quic_cang@quicinc.com>
1241Description:	This file shows the PA power mode of UFS.
1242
1243		The file is read only.
1244
1245What:		/sys/bus/platform/drivers/ufshcd/*/power_info/rate
1246What:		/sys/bus/platform/devices/*.ufs/power_info/rate
1247Date:		September 2023
1248Contact:	Can Guo <quic_cang@quicinc.com>
1249Description:	This file shows the speed rate of UFS link.
1250
1251		The file is read only.
1252
1253What:		/sys/bus/platform/drivers/ufshcd/*/power_info/gear
1254What:		/sys/bus/platform/devices/*.ufs/power_info/gear
1255Date:		September 2023
1256Contact:	Can Guo <quic_cang@quicinc.com>
1257Description:	This file shows the gear of UFS link.
1258
1259		The file is read only.
1260
1261What:		/sys/bus/platform/drivers/ufshcd/*/power_info/dev_pm
1262What:		/sys/bus/platform/devices/*.ufs/power_info/dev_pm
1263Date:		September 2023
1264Contact:	Can Guo <quic_cang@quicinc.com>
1265Description:	This file shows the UFS device power mode.
1266
1267		The file is read only.
1268
1269What:		/sys/bus/platform/drivers/ufshcd/*/power_info/link_state
1270What:		/sys/bus/platform/devices/*.ufs/power_info/link_state
1271Date:		September 2023
1272Contact:	Can Guo <quic_cang@quicinc.com>
1273Description:	This file shows the state of UFS link.
1274
1275		The file is read only.
1276
1277What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
1278What:		/sys/bus/platform/devices/*.ufs/device_descriptor/wb_presv_us_en
1279Date:		June 2020
1280Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1281Description:	This entry shows if preserve user-space was configured
1282
1283		The file is read only.
1284
1285What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_units
1286What:		/sys/bus/platform/devices/*.ufs/device_descriptor/wb_shared_alloc_units
1287Date:		June 2020
1288Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1289Description:	This entry shows the shared allocated units of WB buffer
1290
1291		The file is read only.
1292
1293What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_type
1294What:		/sys/bus/platform/devices/*.ufs/device_descriptor/wb_type
1295Date:		June 2020
1296Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1297Description:	This entry shows the configured WB type.
1298		0x1 for shared buffer mode. 0x0 for dedicated buffer mode.
1299
1300		The file is read only.
1301
1302What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
1303What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_buff_cap_adj
1304Date:		June 2020
1305Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1306Description:	This entry shows the total user-space decrease in shared
1307		buffer mode.
1308		The value of this parameter is 3 for TLC NAND when SLC mode
1309		is used as WriteBooster Buffer. 2 for MLC NAND.
1310
1311		The file is read only.
1312
1313What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_units
1314What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_max_alloc_units
1315Date:		June 2020
1316Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1317Description:	This entry shows the Maximum total WriteBooster Buffer size
1318		which is supported by the entire device.
1319
1320		The file is read only.
1321
1322What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
1323What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_max_wb_luns
1324Date:		June 2020
1325Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1326Description:	This entry shows the maximum number of luns that can support
1327		WriteBooster.
1328
1329		The file is read only.
1330
1331What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
1332What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_sup_red_type
1333Date:		June 2020
1334Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1335Description:	The supportability of user space reduction mode
1336		and preserve user space mode.
1337		00h: WriteBooster Buffer can be configured only in
1338		user space reduction type.
1339		01h: WriteBooster Buffer can be configured only in
1340		preserve user space type.
1341		02h: Device can be configured in either user space
1342		reduction type or preserve user space type.
1343
1344		The file is read only.
1345
1346What:		/sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
1347What:		/sys/bus/platform/devices/*.ufs/geometry_descriptor/wb_sup_wb_type
1348Date:		June 2020
1349Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1350Description:	The supportability of WriteBooster Buffer type.
1351
1352		===  ==========================================================
1353		00h  LU based WriteBooster Buffer configuration
1354		01h  Single shared WriteBooster Buffer configuration
1355		02h  Supporting both LU based WriteBooster.
1356		     Buffer and Single shared WriteBooster Buffer configuration
1357		===  ==========================================================
1358
1359		The file is read only.
1360
1361What:		/sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
1362What:		/sys/bus/platform/devices/*.ufs/flags/wb_enable
1363Date:		June 2020
1364Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1365Description:	This entry shows the status of WriteBooster.
1366
1367		== ============================
1368		0  WriteBooster is not enabled.
1369		1  WriteBooster is enabled
1370		== ============================
1371
1372		The file is read only.
1373
1374What:		/sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
1375What:		/sys/bus/platform/devices/*.ufs/flags/wb_flush_en
1376Date:		June 2020
1377Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1378Description:	This entry shows if flush is enabled.
1379
1380		== =================================
1381		0  Flush operation is not performed.
1382		1  Flush operation is performed.
1383		== =================================
1384
1385		The file is read only.
1386
1387What:		/sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_h8
1388What:		/sys/bus/platform/devices/*.ufs/flags/wb_flush_during_h8
1389Date:		June 2020
1390Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1391Description:	Flush WriteBooster Buffer during hibernate state.
1392
1393		== =================================================
1394		0  Device is not allowed to flush the
1395		   WriteBooster Buffer during link hibernate state.
1396		1  Device is allowed to flush the
1397		   WriteBooster Buffer during link hibernate state.
1398		== =================================================
1399
1400		The file is read only.
1401
1402What:		/sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_buf
1403What:		/sys/bus/platform/devices/*.ufs/attributes/wb_avail_buf
1404Date:		June 2020
1405Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1406Description:	This entry shows the amount of unused WriteBooster buffer
1407		available.
1408
1409		The file is read only.
1410
1411What:		/sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
1412What:		/sys/bus/platform/devices/*.ufs/attributes/wb_cur_buf
1413Date:		June 2020
1414Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1415Description:	This entry shows the amount of unused current buffer.
1416
1417		The file is read only.
1418
1419What:		/sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_status
1420What:		/sys/bus/platform/devices/*.ufs/attributes/wb_flush_status
1421Date:		June 2020
1422Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1423Description:	This entry shows the flush operation status.
1424
1425
1426		===  ======================================
1427		00h  idle
1428		01h  Flush operation in progress
1429		02h  Flush operation stopped prematurely.
1430		03h  Flush operation completed successfully
1431		04h  Flush operation general failure
1432		===  ======================================
1433
1434		The file is read only.
1435
1436What:		/sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_time_est
1437What:		/sys/bus/platform/devices/*.ufs/attributes/wb_life_time_est
1438Date:		June 2020
1439Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1440Description:	This entry shows an indication of the WriteBooster Buffer
1441		lifetime based on the amount of performed program/erase cycles
1442
1443		===  =============================================
1444		01h  0% - 10% WriteBooster Buffer life time used
1445		...
1446		0Ah  90% - 100% WriteBooster Buffer life time used
1447		===  =============================================
1448
1449		The file is read only.
1450
1451What:		/sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
1452Date:		June 2020
1453Contact:	Asutosh Das <quic_asutoshd@quicinc.com>
1454Description:	This entry shows the configured size of WriteBooster buffer.
1455		0400h corresponds to 4GB.
1456
1457		The file is read only.
1458
1459What:		/sys/bus/platform/drivers/ufshcd/*/wb_on
1460What:		/sys/bus/platform/devices/*.ufs/wb_on
1461Date:		January 2021
1462Contact:	Bean Huo <beanhuo@micron.com>
1463Description:	This node is used to set or display whether UFS WriteBooster is
1464		enabled. Echo 0 to this file to disable UFS WriteBooster or 1 to
1465		enable it. The WriteBooster is enabled after power-on/reset,
1466		however, it will be disabled/enable while CLK scaling down/up
1467		(if the platform supports UFSHCD_CAP_CLK_SCALING). For a
1468		platform that doesn't support UFSHCD_CAP_CLK_SCALING, we can
1469		disable/enable WriteBooster through this sysfs node.
1470
1471What:		/sys/bus/platform/drivers/ufshcd/*/enable_wb_buf_flush
1472What:		/sys/bus/platform/devices/*.ufs/enable_wb_buf_flush
1473Date:		July 2022
1474Contact:	Jinyoung Choi <j-young.choi@samsung.com>
1475Description:	This entry shows the status of WriteBooster buffer flushing
1476		and it can be used to enable or disable the flushing.
1477		If flushing is enabled, the device executes the flush
1478		operation when the command queue is empty.
1479
1480What:		/sys/bus/platform/drivers/ufshcd/*/wb_flush_threshold
1481What:		/sys/bus/platform/devices/*.ufs/wb_flush_threshold
1482Date:		June 2023
1483Contact:	Lu Hongfei <luhongfei@vivo.com>
1484Description:
1485		wb_flush_threshold represents the threshold for flushing WriteBooster buffer,
1486		whose value expressed in unit of 10% granularity, such as '1' representing 10%,
1487		'2' representing 20%, and so on.
1488		If avail_wb_buff < wb_flush_threshold, it indicates that WriteBooster buffer needs to
1489		be flushed, otherwise it is not necessary.
1490
1491Contact:	Daniil Lunev <dlunev@chromium.org>
1492What:		/sys/bus/platform/drivers/ufshcd/*/capabilities/
1493What:		/sys/bus/platform/devices/*.ufs/capabilities/
1494Date:		August 2022
1495Description:	The group represents the effective capabilities of the
1496		host-device pair. i.e. the capabilities which are enabled in the
1497		driver for the specific host controller, supported by the host
1498		controller and are supported and/or have compatible
1499		configuration on the device side.
1500
1501Contact:	Daniil Lunev <dlunev@chromium.org>
1502What:		/sys/bus/platform/drivers/ufshcd/*/capabilities/clock_scaling
1503What:		/sys/bus/platform/devices/*.ufs/capabilities/clock_scaling
1504Date:		August 2022
1505Contact:	Daniil Lunev <dlunev@chromium.org>
1506Description:	Indicates status of clock scaling.
1507
1508		== ============================
1509		0  Clock scaling is not supported.
1510		1  Clock scaling is supported.
1511		== ============================
1512
1513		The file is read only.
1514
1515What:		/sys/bus/platform/drivers/ufshcd/*/capabilities/write_booster
1516What:		/sys/bus/platform/devices/*.ufs/capabilities/write_booster
1517Date:		August 2022
1518Contact:	Daniil Lunev <dlunev@chromium.org>
1519Description:	Indicates status of Write Booster.
1520
1521		== ============================
1522		0  Write Booster can not be enabled.
1523		1  Write Booster can be enabled.
1524		== ============================
1525
1526		The file is read only.
1527
1528What:		/sys/bus/platform/drivers/ufshcd/*/rtc_update_ms
1529What:		/sys/bus/platform/devices/*.ufs/rtc_update_ms
1530Date:		November 2023
1531Contact:	Bean Huo <beanhuo@micron.com>
1532Description:
1533		rtc_update_ms indicates how often the host should synchronize or update the
1534		UFS RTC. If set to 0, this will disable UFS RTC periodic update.
1535
1536What:		/sys/devices/platform/.../ufshci_capabilities/version
1537Date:		August 2024
1538Contact:	Avri Altman <avri.altman@wdc.com>
1539Description:
1540		Host Capabilities register group: UFS version register.
1541		Symbol - VER.  This file shows the UFSHCD version.
1542		Example: Version 3.12 would be represented as 0000_0312h.
1543		The file is read only.
1544
1545What:		/sys/devices/platform/.../ufshci_capabilities/product_id
1546Date:		August 2024
1547Contact:	Avri Altman <avri.altman@wdc.com>
1548Description:
1549		Host Capabilities register group: product ID register.
1550		Symbol - HCPID.  This file shows the UFSHCD product id.
1551		The content of this register is vendor specific.
1552		The file is read only.
1553
1554What:		/sys/devices/platform/.../ufshci_capabilities/man_id
1555Date:		August 2024
1556Contact:	Avri Altman <avri.altman@wdc.com>
1557Description:
1558		Host Capabilities register group: manufacturer ID register.
1559		Symbol - HCMID. This file shows the UFSHCD manufacturer id.
1560		The Manufacturer ID is defined by JEDEC in JEDEC-JEP106.
1561		The file is read only.
1562