Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
IronPort-SDR: 2wx60tWQItal1bTrOBqdA/2jDtV+zWct9SEToLbcL8I6jBX4EDZeVo0PlF//IfYSKqomx0ld9E
 RZKGliOp/Xj/8izJKpeEGfbLAQrfmkiIbNcVO4opAnq4bAC6exxDUR8UZWBtoKD5NsySjFpt2M
 VpOFWlLIORNd7S77oN+o8b5t4fJshPlFHDfrJlJGSI0BqjsBNXbgSD8ge5Yx4JTdd+KQqLDiuq
 6nNV589ZrZV2sTcqz3gs2m/jn5BipymAe3eci5LNiGdGl9T+0u3wTVIqDskpkCpKs/I8vFPfKI
 zvs=
From:   Avri Altman <Avri.Altman@wdc.com>
To:     Asutosh Das <asutoshd@codeaurora.org>,
        "gregkh@google.com" <gregkh@google.com>,
        "cang@codeaurora.org" <cang@codeaurora.org>,
        "martin.petersen@oracle.com" <martin.petersen@oracle.com>
CC:     "linux-scsi@vger.kernel.org" <linux-scsi@vger.kernel.org>,
        open list <linux-kernel@vger.kernel.org>
Subject: RE: [PATCH 1/1] Documentation:sysfs-ufs: Add WriteBooster
 documentation
Thread-Topic: [PATCH 1/1] Documentation:sysfs-ufs: Add WriteBooster
 documentation
Thread-Index: AQHWPoHvCtU+Wdx150Ku3J+9F2SH8qjX5J7w
Date:   Sun, 14 Jun 2020 09:53:26 +0000
Message-ID: <SN6PR04MB464016DB3CD7D3A1583169E2FC9F0@SN6PR04MB4640.namprd04.prod.outlook.com>
References: <1591723067-22998-1-git-send-email-asutoshd@codeaurora.org>
In-Reply-To: <1591723067-22998-1-git-send-email-asutoshd@codeaurora.org>
Accept-Language: en-US
Content-Language: en-US
wdcipoutbound: EOP-TRUE
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: 15935005-f86c-4fb1-5544-08d81048c8b4
X-MS-Exchange-CrossTenant-originalarrivaltime: 14 Jun 2020 09:53:26.1737
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: b61c8803-16f3-4c35-9b17-6f65f441df86
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: gOMOPNhMnmINQP8czhJNAqO9B9ZDICwAVQKVNsjRgUl83FO7ZUukmzwEz2EJGROR4BqgJ/87JuySkhyVAvny4w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN2PR04MB2350
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

>=20
> Adds sysfs documentation for WriteBooster entries.
>=20
> Signed-off-by: Asutosh Das <asutoshd@codeaurora.org>
Acked-by: Avri Altman <avri.altman@wdc.com>

Maybe insert each field following the fields of the same descriptor, attrib=
utes, flags etc.

Thanks,
Avri
=20
> ---
>  Documentation/ABI/testing/sysfs-driver-ufs | 136
> +++++++++++++++++++++++++++++
>  1 file changed, 136 insertions(+)
>=20
> diff --git a/Documentation/ABI/testing/sysfs-driver-ufs
> b/Documentation/ABI/testing/sysfs-driver-ufs
> index 016724e..d1a3521 100644
> --- a/Documentation/ABI/testing/sysfs-driver-ufs
> +++ b/Documentation/ABI/testing/sysfs-driver-ufs
> @@ -883,3 +883,139 @@ Contact:  Subhash Jadavani
> <subhashj@codeaurora.org>
>  Description:   This entry shows the target state of an UFS UIC link
>                 for the chosen system power management level.
>                 The file is read only.
> +
> +What:
> /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_presv_us_en
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows if preserve user-space was configured
> +               The file is read only.
> +
> +What:
> /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_shared_alloc_unit=
s
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the shared allocated units of WB buffer
> +               The file is read only.
> +
> +What:          /sys/bus/platform/drivers/ufshcd/*/device_descriptor/wb_t=
ype
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the configured WB type.
> +               0x1 for shared buffer mode. 0x0 for dedicated buffer mode=
.
> +               The file is read only.
> +
> +What:
> /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_buff_cap_adj
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the total user-space decrease in shared
> +               buffer mode.
> +               The value of this parameter is 3 for TLC NAND when SLC mo=
de
> +               is used as WriteBooster Buffer. 2 for MLC NAND.
> +               The file is read only.
> +
> +What:
> /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_alloc_unit
> s
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the Maximum total WriteBooster Buffer si=
ze
> +               which is supported by the entire device.
> +               The file is read only.
> +
> +What:
> /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_max_wb_luns
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the maximum number of luns that can
> support
> +               WriteBooster.
> +               The file is read only.
> +
> +What:
> /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_red_type
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   The supportability of user space reduction mode
> +               and preserve user space mode.
> +               00h: WriteBooster Buffer can be configured only in
> +               user space reduction type.
> +               01h: WriteBooster Buffer can be configured only in
> +               preserve user space type.
> +               02h: Device can be configured in either user space
> +               reduction type or preserve user space type.
> +               The file is read only.
> +
> +What:
> /sys/bus/platform/drivers/ufshcd/*/geometry_descriptor/wb_sup_wb_type
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   The supportability of WriteBooster Buffer type.
> +               00h: LU based WriteBooster Buffer configuration
> +               01h: Single shared WriteBooster Buffer
> +               configuration
> +               02h: Supporting both LU based WriteBooster
> +               Buffer and Single shared WriteBooster Buffer
> +               configuration
> +               The file is read only.
> +
> +What:          /sys/bus/platform/drivers/ufshcd/*/flags/wb_enable
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the status of WriteBooster.
> +               0: WriteBooster is not enabled.
> +               1: WriteBooster is enabled
> +               The file is read only.
> +
> +What:          /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_en
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows if flush is enabled.
> +               0: Flush operation is not performed.
> +               1: Flush operation is performed.
> +               The file is read only.
> +
> +What:          /sys/bus/platform/drivers/ufshcd/*/flags/wb_flush_during_=
h8
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   Flush WriteBooster Buffer during hibernate state.
> +               0: Device is not allowed to flush the
> +               WriteBooster Buffer during link hibernate
> +               state.
> +               1: Device is allowed to flush the
> +               WriteBooster Buffer during link hibernate
> +               state
> +               The file is read only.
> +
> +What:          /sys/bus/platform/drivers/ufshcd/*/attributes/wb_avail_bu=
f
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the amount of unused WriteBooster buffer
> +               available.
> +               The file is read only.
> +
> +What:          /sys/bus/platform/drivers/ufshcd/*/attributes/wb_cur_buf
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the amount of unused current buffer.
> +               The file is read only.
> +
> +What:          /sys/bus/platform/drivers/ufshcd/*/attributes/wb_flush_st=
atus
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the flush operation status.
> +               00h: idle
> +               01h: Flush operation in progress
> +               02h: Flush operation stopped prematurely.
> +               03h: Flush operation completed successfully
> +               04h: Flush operation general failure
> +               The file is read only.
> +
> +What:          /sys/bus/platform/drivers/ufshcd/*/attributes/wb_life_tim=
e_est
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows an indication of the WriteBooster Buffer
> +               lifetime based on the amount of performed program/erase c=
ycles
> +               01h: 0% - 10% WriteBooster Buffer life time used
> +               ...
> +               0Ah: 90% - 100% WriteBooster Buffer life time used
> +               The file is read only.
> +
> +What:
> /sys/class/scsi_device/*/device/unit_descriptor/wb_buf_alloc_units
> +Date:          June 2020
> +Contact:       Asutosh Das <asutoshd@codeaurora.org>
> +Description:   This entry shows the configured size of WriteBooster buff=
er.
> +               0400h corresponds to 4GB.
> +               The file is read only.
> --
> Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum, a Linu=
x
> Foundation Collaborative Project.