Changes in sysfs-driver-ufs

1fd2e77b - scsi: ufs: core: Add device level exception support

Fri, 28 Mar 2025 21:46:13 +0000

scsi: ufs: core: Add device level exception supportThe ufs device JEDEC specification version 4.1 adds support for thedevice level exception events. To support this new device levelexception feature, expose two new sysfs nodes below to provide the userspace access to the device level exception information./sys/bus/platform/drivers/ufshcd/*/device_lvl_exception_count/sys/bus/platform/drivers/ufshcd/*/device_lvl_exception_idThe device_lvl_exception_count sysfs node reports the number of devicelevel exceptions that have occurred since the last time this variable isreset. Writing a value of 0 will reset it. The device_lvl_exception_idreports the exception ID which is the qDeviceLevelExceptionID attributeof the device JEDEC specifications version 4.1 and later. The user spaceapplication can query these sysfs nodes to get more information aboutthe device level exception.Signed-off-by: Bao D. Nguyen Link: https://lore.kernel.org/r/6278d7c125b2f0cf5056f4a647a4b9c1fdd24fc7.1743198325.git.quic_nguyenb@quicinc.comReviewed-by: Peter Wang Reviewed-by: Bart Van Assche Reviewed-by: Arthur Simchaev Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

6d7696b4 - scsi: ABI: sysfs-driver-ufs: Add missing UFS sysfs attributes

Thu, 13 Feb 2025 08:00:08 +0000

scsi: ABI: sysfs-driver-ufs: Add missing UFS sysfs attributesAdd UFS driver sysfs attributes clkscale_enable, clkgate_enable andclkgate_delay_ms to this document.Signed-off-by: Ziqi Chen Link: https://lore.kernel.org/r/20250213080008.2984807-9-quic_ziqichen@quicinc.comReviewed-by: Bean Huo Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

edfaf868 - scsi: ufs: core: Critical health condition

Tue, 11 Feb 2025 06:58:13 +0000

scsi: ufs: core: Critical health conditionMartin hi,The UFS4.1 standard, released on January 8, 2025, added a new exceptionevent: HEALTH_CRITICAL, which notifies the host of a device's criticalhealth condition. This notification implies that the device is approachingthe end of its lifetime based on the amount of performed program/erasecycles.Once an EOL (End-of-Life) exception event is received, we increment adesignated member, which is exposed via a sysfs entry. This new entry, willreport the number of times a critical health event has been reported by aUFS device.To handle this new sysfs entry, userspace applications can use select(),poll(), or epoll() to monitor changes in the critical_health attribute. Thekernel will call sysfs_notify() to signal changes, allowing the userspaceapplication to detect and respond to these changes efficiently.The host can gain further insight into the specific issue by reading one ofthe following attributes: bPreEOLInfo, bDeviceLifeTimeEstA,bDeviceLifeTimeEstB, bWriteBoosterBufferLifeTimeEst, andbRPMBLifeTimeEst. All those are available for reading via the driver'ssysfs entries or through an applicable utility. It is up to userspace toread these attributes if needed.Signed-off-by: Avri Altman Link: https://lore.kernel.org/r/20250211065813.58091-1-avri.altman@wdc.comReviewed-by: Bart Van Assche Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

f51d7481 - scsi: ufs: Add HCI capabilities sysfs group

Sun, 11 Aug 2024 14:37:57 +0000

scsi: ufs: Add HCI capabilities sysfs groupThe standard register map of UFSHCI is comprised of several groups. Thefirst group (starting from offset 0x00), is the host capabilities group.It contains some interesting information that otherwise is not available,e.g. the UFS version of the platform etc.Reviewed-by: Keoseong Park Reviewed-by: Bart Van Assche Reviewed-by: Bean Huo Signed-off-by: Avri Altman Link: https://lore.kernel.org/r/20240811143757.2538212-3-avri.altman@wdc.comSigned-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

600edc66 - scsi: ufs: sysfs: Make max_number_of_rtt read-write

Thu, 30 May 2024 14:25:09 +0000

scsi: ufs: sysfs: Make max_number_of_rtt read-writeGiven the importance of the RTT parameter, we want to be able to configureit via sysfs. This is because UFS users should be discouraged from changeUFS device parameters without the UFSHCI driver being aware of thesechanges.Signed-off-by: Avri Altman Link: https://lore.kernel.org/r/20240530142510.734-4-avri.altman@wdc.comReviewed-by: Bart Van Assche Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

838f595a - scsi: ufs: core: Add sysfs node for UFS RTC update

Tue, 12 Dec 2023 22:08:25 +0000

scsi: ufs: core: Add sysfs node for UFS RTC updateIntroduce a sysfs node named 'rtc_update_ms' within the kernel, enablinguser to adjust the RTC periodic update frequency to suit the specificrequirements of the system and UFS. Also, this patch allows the user todisable/enable periodic update RTC in the UFS idle time.Signed-off-by: Bean Huo Link: https://lore.kernel.org/r/20231212220825.85255-4-beanhuo@iokpp.deAcked-by: Avri Altman Reviewed-by: Thomas Weißschuh Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

4f6dd2a4 - scsi: ufs: ufs-sysfs: Expose UFS power info

Thu, 02 Nov 2023 01:58:36 +0000

scsi: ufs: ufs-sysfs: Expose UFS power infoHaving UFS power info available in sysfs makes it easier to tell the stateof the link during runtime considering we have a bunch of power savingfeatures and various combinations for backward compatibility.Reviewed-by: Manivannan Sadhasivam Reviewed-by: Bean Huo Reviewed-by: Bart Van Assche Signed-off-by: Can Guo Link: https://lore.kernel.org/r/1698890324-7374-1-git-send-email-quic_cang@quicinc.comReviewed-by: Avri Altman Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

7e9609d2 - scsi: ufs: core: Remove HPB support

Wed, 19 Jul 2023 16:55:41 +0000

scsi: ufs: core: Remove HPB supportInterest among UFS users in HPB has reduced significantly. I am not awareof any current users of the HPB functionality. Hence remove HPB supportfrom the kernel.A note: the work in JEDEC on a successor for HPB is nearing completion.Zoned storage for UFS or ZUFS combines the UFS standard with ZBC-2.Acked-by: Avri Altman Reviewed-by: Bean Huo Cc: Adrian Hunter Cc: ChanWoo Lee Cc: Daejun Park Cc: Keoseong Park Signed-off-by: Bart Van Assche Link: https://lore.kernel.org/r/20230719165758.2787573-1-bvanassche@acm.orgSigned-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

ef470b86 - scsi: ufs: core: Update contact email for monitor sysfs nodes

Fri, 30 Jun 2023 00:39:09 +0000

scsi: ufs: core: Update contact email for monitor sysfs nodesUpdate contact email addresses for Can Guo and Asutosh Das, replace SubhashJadavani's contact.Signed-off-by: Can Guo Link: https://lore.kernel.org/r/20230630003913.3713155-1-quic_cang@quicinc.comSigned-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

e3d55626 - scsi: ufs: wb: Add explicit flush_threshold sysfs attribute

Tue, 13 Jun 2023 02:22:34 +0000

scsi: ufs: wb: Add explicit flush_threshold sysfs attributeThere are three flags that control Write Booster Feature: 1. WB ON/OFF 2. WB Hibern Flush ON/OFF (implicitly) 3. WB Flush ON/OFF (explicit)In the case of "Hibern Flush", one of the conditions for flush WB buffer isthat avail_wb_buff < wb_flush_threshold.As we know, different users have different requirements for powerconsumption and performance. Therefore, we need the ability to manually setwb_flush_threshold, so that users can easily and flexibly adjust thewb_flush_threshold value, thereby achieving a balance between powerconsumption and performance.So the sysfs attribute that controls this is necessary.wb_flush_threshold represents the threshold for flushing WB buffer, whosevalue expressed in unit of 10% granularity, such as '1' representing 10%,'2' representing 20%, and so on.Signed-off-by: Lu Hongfei Link: https://lore.kernel.org/r/20230613022240.16595-1-luhongfei@vivo.comReviewed-by: Bart Van Assche Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

2286ade0 - scsi: ufs: core: Print UFSHCD capabilities in controller's sysfs node

Sun, 28 Aug 2022 22:18:58 +0000

scsi: ufs: core: Print UFSHCD capabilities in controller's sysfs nodeUserspace may want to manually control when the data should go intoWriteBooster buffer. The control happens via "wb_on" node, but presently,there is no simple way to check if WriteBooster is supported andenabled.Expose the Write Booster and Clock Scaling capabilities to be able todetermine if the Write Booster is available and if its manual control isblocked by Clock Scaling mechanism.Link: https://lore.kernel.org/r/20220829081845.v8.1.Ibf9efc9be50783eeee55befa2270b7d38552354c@changeidReviewed-by: Bart Van Assche Signed-off-by: Daniil Lunev Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

6c4148ce - scsi: ufs: wb: Add explicit flush sysfs attribute

Thu, 04 Aug 2022 07:53:54 +0000

scsi: ufs: wb: Add explicit flush sysfs attributeThere is the following quirk to bypass "WB Flush" in Write Booster. - UFSHCI_QUIRK_SKIP_MANUAL_WB_FLUSH_CTRLIf this quirk is not set, there is no knob that can control "WB Flush".There are three flags that control Write Booster Feature: 1. WB ON/OFF 2. WB Hibern Flush ON/OFF (implicitly) 3. WB Flush ON/OFF (explicit)The sysfs attribute that controls the WB was implemented. (1)In the case of "Hibern Flush", it is always good to turn on. Control maynot be required. (2)Finally, "Flush" may be necessary because the Auto-Hibern8 is not supportedin a specific environment. So the sysfs attribute that controls this isnecessary. (3)Link: https://lore.kernel.org/r/20220804075354epcms2p8c21c894b4e28840c5fc651875b7f435f@epcms2p8Reviewed-by: Avri Altman Signed-off-by: Jinyoung Choi Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

d4300c55 - scsi: ufs: ufshpb: Change sysfs node hpb_stats/rb_* prefix to start with rcmd_*

Thu, 05 May 2022 13:47:05 +0000

scsi: ufs: ufshpb: Change sysfs node hpb_stats/rb_* prefix to start with rcmd_*According to the documentation of the sysfs nodes rb_noti_cnt,rb_active_cnt and rb_inactive_cnt, these are all related to HPBrecommendation in UPIU response packet. 'rcmd' (recommendation) should bethe correct abbreviation.Change the sysfs documentation about these sysfs nodes to highlight whatthey mean under different HPB control modes.Link: https://lore.kernel.org/r/20220505134707.35929-5-huobean@gmail.comReviewed-by: Keoseong Park Signed-off-by: Bean Huo Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

a4bcbf71 - scsi: Documentation: Fix typo in sysfs-driver-ufs

Wed, 06 Oct 2021 15:48:03 +0000

scsi: Documentation: Fix typo in sysfs-driver-ufsRemove repeated word: "the The amount"Link: https://lore.kernel.org/r/20211006154804.135184-1-sohaib.amhmd@gmail.comSigned-off-by: Sohaib Mohamed Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

e080f247 - ABI: sysfs-driver-ufs: Add another What for platform drivers

Mon, 27 Sep 2021 13:59:49 +0000

ABI: sysfs-driver-ufs: Add another What for platform driversThe current what expressions: What: /sys/bus/platform/drivers/ufshcd/*/...Doesn't actually match what (some?) platform drivers actuallyexport. For instance, drivers/scsi/ufs/ufs-hisi.c actuallycreates the sysfs struct for ufshcd inside this directory: /sys/devices/platform/soc/ff3c0000.ufsWhich has those aliases: /sys/devices/virtual/devlink/platform:fff35000.crg_ctrl--platform:ff3c0000.ufs/consumer/ /sys/bus/platform/drivers/ufshcd-hisi/ff3c0000.ufs/ /sys/bus/platform/devices/soc/ff3c0000.ufs/ /sys/bus/platform/devices/ff3c0000.ufs/So, add another What: for such files that will match thedevice ufs entries, e. g.: What: /sys/bus/platform/devices/*.ufs/Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/bc61469964bbcabe38d12aa88f2734d38a8741e5.1632750608.git.mchehab+huawei@kernel.orgSigned-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

f95f59a2 - scsi: ufs: ufshpb: Make host mode parameters configurable

Mon, 12 Jul 2021 09:50:39 +0000

scsi: ufs: ufshpb: Make host mode parameters configurableElaborate some more on the host control mode logic parameters, explainingwhat they do and how to configure them.Link: https://lore.kernel.org/r/20210712095039.8093-13-avri.altman@wdc.comReviewed-by: Daejun Park Signed-off-by: Avri Altman Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

41d8a933 - scsi: ufs: ufshpb: Add HPB 2.0 support

Mon, 12 Jul 2021 09:00:25 +0000

scsi: ufs: ufshpb: Add HPB 2.0 supportVersion 2.0 of HBP supports reads of varying sizes from 4KB to 1MB.A read operation <= 32KB is supported as single HPB read. A read between36KB and 1MB is supported by a combination of write buffer command and HPBread command to deliver more PPN. The write buffer commands may not beissued immediately due to busy tags. To use HPB read more aggressively, thedriver can requeue the write buffer command. The requeue threshold isimplemented as timeout and can be modified with requeue_timeout_ms entry insysfs.[mkp: REQ_OP_DRV_* and blk_rq_is_passthrough()]Link: https://lore.kernel.org/r/20210712090025epcms2p3b3d94f6f1b2cfa394e3d9ba130ca0fa7@epcms2p3Tested-by: Can Guo Tested-by: Stanley Chu Reviewed-by: Greg Kroah-Hartman Reviewed-by: Can Guo Reviewed-by: Bean Huo Reviewed-by: Stanley Chu Signed-off-by: Daejun Park Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

f02bc975 - scsi: ufs: ufshpb: Introduce Host Performance Buffer feature

Mon, 12 Jul 2021 08:58:30 +0000

scsi: ufs: ufshpb: Introduce Host Performance Buffer featureImplement Host Performance Buffer (HPB) initialization and add functioncalls to UFS core driver.NAND flash-based storage devices, including UFS, have mechanisms totranslate logical addresses of I/O requests to the corresponding physicaladdresses of the flash storage. In UFS, logical-to-physical-address (L2P)map data, which is required to identify the physical address for therequested I/Os, can only be partially stored in SRAM from NAND flash. Dueto this partial loading, accessing the flash address area, where the L2Pinformation for that address is not loaded in the SRAM, can result inserious performance degradation.The basic concept of HPB is to cache L2P mapping entries in host systemmemory so that both physical block address (PBA) and logical block address(LBA) can be delivered in HPB read command. The HPB read command allows toread data faster than a regular read command in UFS since it provides thephysical address (HPB Entry) of the desired logical block in addition toits logical address. The UFS device can access the physical block in NANDdirectly without searching and uploading L2P mapping table. This improvesread performance because the NAND read operation for uploading L2P mappingtable is removed.In HPB initialization, the host checks if the UFS device supports HPBfeature and retrieves related device capabilities. Then, HPB parameters areconfigured in the device.Total start-up time of popular applications was measured and the differenceobserved between HPB being enabled and disabled. Popular applications are12 game apps and 24 non-game apps. Each test cycle consists of running 36applications in sequence. We repeated the cycle for observing performanceimprovement by L2P mapping cache hit in HPB.The following is the test environment: - kernel version: 4.4.0 - RAM: 8GB - UFS 2.1 (64GB)Results: +-------+----------+----------+-------+ | cycle | baseline | with HPB | diff | +-------+----------+----------+-------+ | 1 | 272.4 | 264.9 | -7.5 | | 2 | 250.4 | 248.2 | -2.2 | | 3 | 226.2 | 215.6 | -10.6 | | 4 | 230.6 | 214.8 | -15.8 | | 5 | 232.0 | 218.1 | -13.9 | | 6 | 231.9 | 212.6 | -19.3 | +-------+----------+----------+-------+We also measured HPB performance using iozone: $ iozone -r 4k -+n -i2 -ecI -t 16 -l 16 -u 16 -s $IO_RANGE/16 -F \ mnt/tmp_1 mnt/tmp_2 mnt/tmp_3 mnt/tmp_4 mnt/tmp_5 mnt/tmp_6 mnt/tmp_7 \ mnt/tmp_8 mnt/tmp_9 mnt/tmp_10 mnt/tmp_11 mnt/tmp_12 mnt/tmp_13 \ mnt/tmp_14 mnt/tmp_15 mnt/tmp_16Results: +----------+--------+---------+ | IO range | HPB on | HPB off | +----------+--------+---------+ | 1 GB | 294.8 | 300.87 | | 4 GB | 293.51 | 179.35 | | 8 GB | 294.85 | 162.52 | | 16 GB | 293.45 | 156.26 | | 32 GB | 277.4 | 153.25 | +----------+--------+---------+Link: https://lore.kernel.org/r/20210712085830epcms2p8c1288b7f7a81b044158a18232617b572@epcms2p8Reported-by: kernel test robot Tested-by: Bean Huo Tested-by: Can Guo Tested-by: Stanley Chu Reviewed-by: Greg Kroah-Hartman Reviewed-by: Bart Van Assche Reviewed-by: Can Guo Reviewed-by: Bean Huo Reviewed-by: Stanley Chu Acked-by: Avri Altman Signed-off-by: Daejun Park Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

1d8613a2 - scsi: ufs: core: Introduce HBA performance monitor sysfs nodes

Thu, 22 Apr 2021 02:28:39 +0000

scsi: ufs: core: Introduce HBA performance monitor sysfs nodesAdd a new sysfs group which has nodes to monitor data/request transferperformance. This sysfs group has nodes showing total sectors/requeststransferred, total busy time spent and max/min/avg/sum latencies. Thisgroup can be enhanced later to show more UFS driver layer performancestatistics data during runtime.Link: https://lore.kernel.org/r/1619058521-35307-2-git-send-email-cang@codeaurora.orgReviewed-by: Daejun Park Acked-by: Bean Huo Signed-off-by: Can Guo Signed-off-by: Martin K. Petersen List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs

3e42d1de - docs: typo fixes in Documentation/ABI/

Thu, 13 May 2021 13:31:10 +0000

docs: typo fixes in Documentation/ABI/Fix the following typos in the Documentation/ABI/ directory:- In file obsolete/sysfs-cpuidle, change "obselete" for "obsolete".- In file removed/sysfs-kernel-uids, change "propotional" for "proportional".- In directory stable/, fix the following words: "associtated" for "associated", "hexidecimal" for "hexadecimal", "vlue" for "value", "csed" for "caused" and "wrtie" for "write". This updates a total of five files.- In directory testing/, fix the following words: "subystem" for "subsystem", "isochrnous" for "isochronous", "Desctiptors" for "Descriptors", "picutre" for "picture", "capture" for "capture", "occured" for "ocurred", "connnected" for "connected","agressively" for "aggressively","manufacturee" for "manufacturer" and "transaction" for "transaction", "malformatted" for "incorrectly formated" ,"internel" for "internal", "writtento" for "written to", "specificed" for "specified", "beyound" for "beyond", "Symetric" for "Symmetric". This updates a total of eleven files.Signed-off-by: Carlos Bilbao Reviewed-by: Randy Dunlap Reviewed-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/5710038.lOV4Wx5bFT@iron-maidenSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/ABI/testing/sysfs-driver-ufs