[PATCH 0/2] accel/qaic documentation fixes

[PATCH 0/2] accel/qaic documentation fixes

[Bagas Sanjaya]

Hi,

Here are two documentation (indentation) fixes for accel/qaic as reported in
linux-next ([1], [2]).

Enjoy!

[1]: https://lore.kernel.org/linux-next/20251110132401.200d88bd@canb.auug.org.au/
[2]: https://lore.kernel.org/linux-next/20251110135038.29e96051@canb.auug.org.au/

Bagas Sanjaya (2):
  accel/qaic: Separate DBC_STATE_* definition list
  accel/qaic: Format DBC states table in sysfs ABI documentation

 Documentation/ABI/stable/sysfs-driver-qaic | 17 ++++++++++-------
 Documentation/accel/qaic/aic100.rst        |  1 +
 2 files changed, 11 insertions(+), 7 deletions(-)


base-commit: a2b0c33e9423cd06133304e2f81c713849059b10
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 1/2] accel/qaic: Separate DBC_STATE_* definition list

[Bagas Sanjaya]

Stephen Rothwell reports htmldocs warnings when merging drm-misc tree:

Documentation/accel/qaic/aic100.rst:502: ERROR: Unexpected indentation. [docutils]
Documentation/accel/qaic/aic100.rst:504: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]

Fix these by separating DBC_STATE_* definition list from preceding
paragraph.

Fixes: 9675093acea04c ("accel/qaic: Implement basic SSR handling")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251110132401.200d88bd@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/accel/qaic/aic100.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/accel/qaic/aic100.rst b/Documentation/accel/qaic/aic100.rst
index 3b287c3987d269..41331cf580b118 100644
--- a/Documentation/accel/qaic/aic100.rst
+++ b/Documentation/accel/qaic/aic100.rst
@@ -498,6 +498,7 @@ it desires to recover the workload.
 
 When SSR occurs for a specific NSP, the assigned DBC goes through the
 following state transactions in order:
+
 DBC_STATE_BEFORE_SHUTDOWN
 	Indicates that the affected NSP was found in an unrecoverable error
 	condition.
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 2/2] accel/qaic: Format DBC states table in sysfs ABI documentation

[Bagas Sanjaya]

Stephen Rothwell reports htmldocs warnings when merging drm-misc tree:

Documentation/ABI/stable/sysfs-driver-qaic:1: ERROR: Unexpected indentation. [docutils]
Documentation/ABI/stable/sysfs-driver-qaic:1: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
Documentation/ABI/stable/sysfs-driver-qaic:1: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]

These are caused by DMA Bridge channel (DBC) states list in sysfs ABI
docs. Format it as a table to fix them.

Fixes: f286066ed9df38 ("accel/qaic: Add DMA Bridge Channel(DBC) sysfs and uevents")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251110135038.29e96051@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/ABI/stable/sysfs-driver-qaic | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/Documentation/ABI/stable/sysfs-driver-qaic b/Documentation/ABI/stable/sysfs-driver-qaic
index e5876935e62b34..c767a93342b3c9 100644
--- a/Documentation/ABI/stable/sysfs-driver-qaic
+++ b/Documentation/ABI/stable/sysfs-driver-qaic
@@ -3,14 +3,17 @@ Date:		October 2025
 KernelVersion:	6.19
 Contact:	Jeff Hugo <jeff.hugo@oss.qualcomm.com>
 Description:	Represents the current state of DMA Bridge channel (DBC). Below are the possible
-		states,
-		IDLE (0) -		DBC is free and can be activated
-		ASSIGNED (1) -		DBC is activated and a workload is running on device
-		BEFORE_SHUTDOWN (2) -	Sub-system associated with this workload has crashed and
+		states:
+
+		===================	==========================================================
+		IDLE (0)		DBC is free and can be activated
+		ASSIGNED (1)		DBC is activated and a workload is running on device
+		BEFORE_SHUTDOWN (2)	Sub-system associated with this workload has crashed and
 					it will shutdown soon
-		AFTER_SHUTDOWN (3) -	Sub-system associated with this workload has crashed and
+		AFTER_SHUTDOWN (3)	Sub-system associated with this workload has crashed and
 					it has shutdown
-		BEFORE_POWER_UP (4) -	Sub-system associated with this workload is shutdown and
+		BEFORE_POWER_UP (4)	Sub-system associated with this workload is shutdown and
 					it will be powered up soon
-		AFTER_POWER_UP (5) -	Sub-system associated with this workload is now powered up
+		AFTER_POWER_UP (5)	Sub-system associated with this workload is now powered up
+		===================	==========================================================
 Users:		Any userspace application or clients interested in DBC state.
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 2/2] accel/qaic: Format DBC states table in sysfs ABI documentation

[Randy Dunlap]

On 11/9/25 7:59 PM, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warnings when merging drm-misc tree:
> 
> Documentation/ABI/stable/sysfs-driver-qaic:1: ERROR: Unexpected indentation. [docutils]
> Documentation/ABI/stable/sysfs-driver-qaic:1: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
> Documentation/ABI/stable/sysfs-driver-qaic:1: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
> 
> These are caused by DMA Bridge channel (DBC) states list in sysfs ABI
> docs. Format it as a table to fix them.
> 
> Fixes: f286066ed9df38 ("accel/qaic: Add DMA Bridge Channel(DBC) sysfs and uevents")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251110135038.29e96051@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  Documentation/ABI/stable/sysfs-driver-qaic | 17 ++++++++++-------
>  1 file changed, 10 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/ABI/stable/sysfs-driver-qaic b/Documentation/ABI/stable/sysfs-driver-qaic
> index e5876935e62b34..c767a93342b3c9 100644
> --- a/Documentation/ABI/stable/sysfs-driver-qaic
> +++ b/Documentation/ABI/stable/sysfs-driver-qaic
> @@ -3,14 +3,17 @@ Date:		October 2025
>  KernelVersion:	6.19
>  Contact:	Jeff Hugo <jeff.hugo@oss.qualcomm.com>
>  Description:	Represents the current state of DMA Bridge channel (DBC). Below are the possible
> -		states,
> -		IDLE (0) -		DBC is free and can be activated
> -		ASSIGNED (1) -		DBC is activated and a workload is running on device
> -		BEFORE_SHUTDOWN (2) -	Sub-system associated with this workload has crashed and
> +		states:
> +
> +		===================	==========================================================
> +		IDLE (0)		DBC is free and can be activated
> +		ASSIGNED (1)		DBC is activated and a workload is running on device
> +		BEFORE_SHUTDOWN (2)	Sub-system associated with this workload has crashed and
>  					it will shutdown soon
> -		AFTER_SHUTDOWN (3) -	Sub-system associated with this workload has crashed and
> +		AFTER_SHUTDOWN (3)	Sub-system associated with this workload has crashed and
>  					it has shutdown
> -		BEFORE_POWER_UP (4) -	Sub-system associated with this workload is shutdown and
> +		BEFORE_POWER_UP (4)	Sub-system associated with this workload is shutdown and
>  					it will be powered up soon
> -		AFTER_POWER_UP (5) -	Sub-system associated with this workload is now powered up
> +		AFTER_POWER_UP (5)	Sub-system associated with this workload is now powered up
> +		===================	==========================================================
>  Users:		Any userspace application or clients interested in DBC state.

-- 
~Randy

Re: [PATCH 1/2] accel/qaic: Separate DBC_STATE_* definition list

[Randy Dunlap]

On 11/9/25 7:59 PM, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warnings when merging drm-misc tree:
> 
> Documentation/accel/qaic/aic100.rst:502: ERROR: Unexpected indentation. [docutils]
> Documentation/accel/qaic/aic100.rst:504: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
> 
> Fix these by separating DBC_STATE_* definition list from preceding
> paragraph.
> 
> Fixes: 9675093acea04c ("accel/qaic: Implement basic SSR handling")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251110132401.200d88bd@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  Documentation/accel/qaic/aic100.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/accel/qaic/aic100.rst b/Documentation/accel/qaic/aic100.rst
> index 3b287c3987d269..41331cf580b118 100644
> --- a/Documentation/accel/qaic/aic100.rst
> +++ b/Documentation/accel/qaic/aic100.rst
> @@ -498,6 +498,7 @@ it desires to recover the workload.
>  
>  When SSR occurs for a specific NSP, the assigned DBC goes through the
>  following state transactions in order:
> +
>  DBC_STATE_BEFORE_SHUTDOWN
>  	Indicates that the affected NSP was found in an unrecoverable error
>  	condition.

-- 
~Randy

Re: [PATCH 1/2] accel/qaic: Separate DBC_STATE_* definition list

[Jeff Hugo]

On 11/9/2025 8:59 PM, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warnings when merging drm-misc tree:
> 
> Documentation/accel/qaic/aic100.rst:502: ERROR: Unexpected indentation. [docutils]
> Documentation/accel/qaic/aic100.rst:504: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
> 
> Fix these by separating DBC_STATE_* definition list from preceding
> paragraph.
> 
> Fixes: 9675093acea04c ("accel/qaic: Implement basic SSR handling")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251110132401.200d88bd@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Jeff Hugo <jeff.hugo@oss.qualcomm.com>

Re: [PATCH 2/2] accel/qaic: Format DBC states table in sysfs ABI documentation

[Jeff Hugo]

On 11/9/2025 8:59 PM, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warnings when merging drm-misc tree:
> 
> Documentation/ABI/stable/sysfs-driver-qaic:1: ERROR: Unexpected indentation. [docutils]
> Documentation/ABI/stable/sysfs-driver-qaic:1: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
> Documentation/ABI/stable/sysfs-driver-qaic:1: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
> 
> These are caused by DMA Bridge channel (DBC) states list in sysfs ABI
> docs. Format it as a table to fix them.
> 
> Fixes: f286066ed9df38 ("accel/qaic: Add DMA Bridge Channel(DBC) sysfs and uevents")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251110135038.29e96051@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Jeff Hugo <jeff.hugo@oss.qualcomm.com>

Re: [PATCH 0/2] accel/qaic documentation fixes

[Jeff Hugo]

On 11/9/2025 8:59 PM, Bagas Sanjaya wrote:
> Hi,
> 
> Here are two documentation (indentation) fixes for accel/qaic as reported in
> linux-next ([1], [2]).
> 
> Enjoy!
> 
> [1]: https://lore.kernel.org/linux-next/20251110132401.200d88bd@canb.auug.org.au/
> [2]: https://lore.kernel.org/linux-next/20251110135038.29e96051@canb.auug.org.au/
> 
> Bagas Sanjaya (2):
>    accel/qaic: Separate DBC_STATE_* definition list
>    accel/qaic: Format DBC states table in sysfs ABI documentation
> 
>   Documentation/ABI/stable/sysfs-driver-qaic | 17 ++++++++++-------
>   Documentation/accel/qaic/aic100.rst        |  1 +
>   2 files changed, 11 insertions(+), 7 deletions(-)
> 
> 
> base-commit: a2b0c33e9423cd06133304e2f81c713849059b10


Thank you for the fixes. Yet again I am impressed by having your fixes 
in my inbox before I even see the reports.

I'll get these merged to drm-misc-next where the offending issues 
currently reside.  I anticipate getting that done later today.

-Jeff

Re: [PATCH 0/2] accel/qaic documentation fixes

[Jeff Hugo]

On 11/9/2025 8:59 PM, Bagas Sanjaya wrote:
> Hi,
> 
> Here are two documentation (indentation) fixes for accel/qaic as reported in
> linux-next ([1], [2]).
> 
> Enjoy!
> 
> [1]: https://lore.kernel.org/linux-next/20251110132401.200d88bd@canb.auug.org.au/
> [2]: https://lore.kernel.org/linux-next/20251110135038.29e96051@canb.auug.org.au/
> 
> Bagas Sanjaya (2):
>    accel/qaic: Separate DBC_STATE_* definition list
>    accel/qaic: Format DBC states table in sysfs ABI documentation
> 
>   Documentation/ABI/stable/sysfs-driver-qaic | 17 ++++++++++-------
>   Documentation/accel/qaic/aic100.rst        |  1 +
>   2 files changed, 11 insertions(+), 7 deletions(-)
> 
> 
> base-commit: a2b0c33e9423cd06133304e2f81c713849059b10

Pushed to drm-misc-next.

-Jeff

Re: [PATCH 0/2] accel/qaic documentation fixes

[Bagas Sanjaya]

On Mon, Nov 10, 2025 at 11:54:59AM -0700, Jeff Hugo wrote:
> Thank you for the fixes. Yet again I am impressed by having your fixes in my
> inbox before I even see the reports.
> 
> I'll get these merged to drm-misc-next where the offending issues currently
> reside.  I anticipate getting that done later today.

Thank you for the compliment!

-- 
An old man doll... just what I always wanted! - Clara