[PATCH 0/2] cxl: Some ABI doc updates

[PATCH 0/2] cxl: Some ABI doc updates

[Davidlohr Bueso]

Hi,

Two small ABI doc fixes.

Thanks!

Davidlohr Bueso (2):
  cxl: Plug typos in ABI doc
  cxl: Document missing sysfs files

 Documentation/ABI/testing/sysfs-bus-cxl | 26 +++++++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)

-- 
2.39.5

[PATCH 1/2] cxl: Plug typos in ABI doc

[Davidlohr Bueso]

Trivially update where necessary.

Signed-off-by: Davidlohr Bueso <dave@stgolabs.net>
---
 Documentation/ABI/testing/sysfs-bus-cxl | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
index 3f5627a1210a..7bdf0eb79d7c 100644
--- a/Documentation/ABI/testing/sysfs-bus-cxl
+++ b/Documentation/ABI/testing/sysfs-bus-cxl
@@ -1,5 +1,5 @@
 What:		/sys/bus/cxl/flush
-Date:		Januarry, 2022
+Date:		January, 2022
 KernelVersion:	v5.18
 Contact:	linux-cxl@vger.kernel.org
 Description:
@@ -33,7 +33,7 @@ Date:		May, 2023
 KernelVersion:	v6.8
 Contact:	linux-cxl@vger.kernel.org
 Description:
-		(RO) For CXL host platforms that support "QoS Telemmetry"
+		(RO) For CXL host platforms that support "QoS Telemetry"
 		this attribute conveys a comma delimited list of platform
 		specific cookies that identifies a QoS performance class
 		for the volatile partition of the CXL mem device. These
@@ -60,7 +60,7 @@ Date:		May, 2023
 KernelVersion:	v6.8
 Contact:	linux-cxl@vger.kernel.org
 Description:
-		(RO) For CXL host platforms that support "QoS Telemmetry"
+		(RO) For CXL host platforms that support "QoS Telemetry"
 		this attribute conveys a comma delimited list of platform
 		specific cookies that identifies a QoS performance class
 		for the persistent partition of the CXL mem device. These
@@ -423,7 +423,7 @@ Date:		May, 2023
 KernelVersion:	v6.5
 Contact:	linux-cxl@vger.kernel.org
 Description:
-		(RO) For CXL host platforms that support "QoS Telemmetry" this
+		(RO) For CXL host platforms that support "QoS Telemetry" this
 		root-decoder-only attribute conveys a platform specific cookie
 		that identifies a QoS performance class for the CXL Window.
 		This class-id can be compared against a similar "qos_class"
-- 
2.39.5

[PATCH 2/2] cxl: Document missing sysfs files

[Davidlohr Bueso]

Add to the ABI documentation the payload_max and label_storage_size
read-only files, which have been there since the early days.

Signed-off-by: Davidlohr Bueso <dave@stgolabs.net>
---
 Documentation/ABI/testing/sysfs-bus-cxl | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
index 7bdf0eb79d7c..96c7fffa5442 100644
--- a/Documentation/ABI/testing/sysfs-bus-cxl
+++ b/Documentation/ABI/testing/sysfs-bus-cxl
@@ -18,6 +18,24 @@ Description:
 		specification.
 
 
+What:		/sys/bus/cxl/devices/memX/payload_max
+Date:		December, 2020
+KernelVersion:	v5.12
+Contact:	linux-cxl@vger.kernel.org
+Description:
+		(RO) Maximum size (in bytes) of the mailbox command payload
+		registers. Linux caps this at 1Mb if the device reports a
+		larger size.
+
+
+What:		/sys/bus/cxl/devices/memX/label_storage_size
+Date:		May, 2021
+KernelVersion:	v5.13
+Contact:	linux-cxl@vger.kernel.org
+Description:
+		(RO) Size (in bytes) of the Label Storage Area (LSA).
+
+
 What:		/sys/bus/cxl/devices/memX/ram/size
 Date:		December, 2020
 KernelVersion:	v5.12
-- 
2.39.5

Re: [PATCH 1/2] cxl: Plug typos in ABI doc

[Jonathan Cameron]

On Sun, 12 Jan 2025 18:52:39 -0800
Davidlohr Bueso <dave@stgolabs.net> wrote:

> Trivially update where necessary.
> 
> Signed-off-by: Davidlohr Bueso <dave@stgolabs.net>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Re: [PATCH 2/2] cxl: Document missing sysfs files

[Jonathan Cameron]

On Sun, 12 Jan 2025 18:52:40 -0800
Davidlohr Bueso <dave@stgolabs.net> wrote:

> Add to the ABI documentation the payload_max and label_storage_size
> read-only files, which have been there since the early days.
> 
> Signed-off-by: Davidlohr Bueso <dave@stgolabs.net>
> ---
>  Documentation/ABI/testing/sysfs-bus-cxl | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
> index 7bdf0eb79d7c..96c7fffa5442 100644
> --- a/Documentation/ABI/testing/sysfs-bus-cxl
> +++ b/Documentation/ABI/testing/sysfs-bus-cxl
> @@ -18,6 +18,24 @@ Description:
>  		specification.
>  
>  
> +What:		/sys/bus/cxl/devices/memX/payload_max
> +Date:		December, 2020
> +KernelVersion:	v5.12
> +Contact:	linux-cxl@vger.kernel.org
> +Description:
> +		(RO) Maximum size (in bytes) of the mailbox command payload
> +		registers. Linux caps this at 1Mb if the device reports a
> +		larger size.

Spec currently caps it to 1MiB as well so a device reporting larger is buggy
but I guess we don't need to mention that :)
Units wise probably MB or MiB if we are being fusy. I think Mb is mega bit?

MB is slightly more common in ABI docs.  Oddly neither MiB or MB shows
up much. Mb not there at all.

> +
> +
> +What:		/sys/bus/cxl/devices/memX/label_storage_size
> +Date:		May, 2021
> +KernelVersion:	v5.13
> +Contact:	linux-cxl@vger.kernel.org
> +Description:
> +		(RO) Size (in bytes) of the Label Storage Area (LSA).
> +
> +
>  What:		/sys/bus/cxl/devices/memX/ram/size
>  Date:		December, 2020
>  KernelVersion:	v5.12

Re: [PATCH 2/2] cxl: Document missing sysfs files

[Davidlohr Bueso]

On Mon, 13 Jan 2025, Jonathan Cameron wrote:

>Spec currently caps it to 1MiB as well so a device reporting larger is buggy
>but I guess we don't need to mention that :)

Right.

>Units wise probably MB or MiB if we are being fusy. I think Mb is mega bit?

Dave, please shout if you want me to s/Mb/MB in a v2 patch, or if you
can update it when picking up.

Thanks,
Davidlohr

[PATCH 1/2] cxl: Plug typos in ABI doc

[Davidlohr Bueso]

Trivially update where necessary.

Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: Davidlohr Bueso <dave@stgolabs.net>
---
 Documentation/ABI/testing/sysfs-bus-cxl | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
index 3f5627a1210a..7bdf0eb79d7c 100644
--- a/Documentation/ABI/testing/sysfs-bus-cxl
+++ b/Documentation/ABI/testing/sysfs-bus-cxl
@@ -1,5 +1,5 @@
 What:		/sys/bus/cxl/flush
-Date:		Januarry, 2022
+Date:		January, 2022
 KernelVersion:	v5.18
 Contact:	linux-cxl@vger.kernel.org
 Description:
@@ -33,7 +33,7 @@ Date:		May, 2023
 KernelVersion:	v6.8
 Contact:	linux-cxl@vger.kernel.org
 Description:
-		(RO) For CXL host platforms that support "QoS Telemmetry"
+		(RO) For CXL host platforms that support "QoS Telemetry"
 		this attribute conveys a comma delimited list of platform
 		specific cookies that identifies a QoS performance class
 		for the volatile partition of the CXL mem device. These
@@ -60,7 +60,7 @@ Date:		May, 2023
 KernelVersion:	v6.8
 Contact:	linux-cxl@vger.kernel.org
 Description:
-		(RO) For CXL host platforms that support "QoS Telemmetry"
+		(RO) For CXL host platforms that support "QoS Telemetry"
 		this attribute conveys a comma delimited list of platform
 		specific cookies that identifies a QoS performance class
 		for the persistent partition of the CXL mem device. These
@@ -423,7 +423,7 @@ Date:		May, 2023
 KernelVersion:	v6.5
 Contact:	linux-cxl@vger.kernel.org
 Description:
-		(RO) For CXL host platforms that support "QoS Telemmetry" this
+		(RO) For CXL host platforms that support "QoS Telemetry" this
 		root-decoder-only attribute conveys a platform specific cookie
 		that identifies a QoS performance class for the CXL Window.
 		This class-id can be compared against a similar "qos_class"
-- 
2.39.5

Re: [PATCH 1/2] cxl: Plug typos in ABI doc

[Dave Jiang]

On 2/18/25 3:48 PM, Davidlohr Bueso wrote:
> Trivially update where necessary.
> 
> Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Signed-off-by: Davidlohr Bueso <dave@stgolabs.net>

Reviewed-by: Dave Jiang <dave.jiang@intel.com>
> ---
>  Documentation/ABI/testing/sysfs-bus-cxl | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
> index 3f5627a1210a..7bdf0eb79d7c 100644
> --- a/Documentation/ABI/testing/sysfs-bus-cxl
> +++ b/Documentation/ABI/testing/sysfs-bus-cxl
> @@ -1,5 +1,5 @@
>  What:		/sys/bus/cxl/flush
> -Date:		Januarry, 2022
> +Date:		January, 2022
>  KernelVersion:	v5.18
>  Contact:	linux-cxl@vger.kernel.org
>  Description:
> @@ -33,7 +33,7 @@ Date:		May, 2023
>  KernelVersion:	v6.8
>  Contact:	linux-cxl@vger.kernel.org
>  Description:
> -		(RO) For CXL host platforms that support "QoS Telemmetry"
> +		(RO) For CXL host platforms that support "QoS Telemetry"
>  		this attribute conveys a comma delimited list of platform
>  		specific cookies that identifies a QoS performance class
>  		for the volatile partition of the CXL mem device. These
> @@ -60,7 +60,7 @@ Date:		May, 2023
>  KernelVersion:	v6.8
>  Contact:	linux-cxl@vger.kernel.org
>  Description:
> -		(RO) For CXL host platforms that support "QoS Telemmetry"
> +		(RO) For CXL host platforms that support "QoS Telemetry"
>  		this attribute conveys a comma delimited list of platform
>  		specific cookies that identifies a QoS performance class
>  		for the persistent partition of the CXL mem device. These
> @@ -423,7 +423,7 @@ Date:		May, 2023
>  KernelVersion:	v6.5
>  Contact:	linux-cxl@vger.kernel.org
>  Description:
> -		(RO) For CXL host platforms that support "QoS Telemmetry" this
> +		(RO) For CXL host platforms that support "QoS Telemetry" this
>  		root-decoder-only attribute conveys a platform specific cookie
>  		that identifies a QoS performance class for the CXL Window.
>  		This class-id can be compared against a similar "qos_class"

Re: [PATCH 1/2] cxl: Plug typos in ABI doc

[Li Ming]

On 2/19/2025 6:48 AM, Davidlohr Bueso wrote:
> Trivially update where necessary.
>
> Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Signed-off-by: Davidlohr Bueso <dave@stgolabs.net>
Reviewed-by: Li Ming <ming.li@zohomail.com>