Skip to contentSkip to conversation

x86, iommu: Fix header comments regarding standard and _FINISH macros

PATCH Applied Aravind Gopalakrishnan 5 participants 8 messages Apr 8, 2015 – Apr 9, 2015 x86

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 x86, iommu: Fix header comments regarding standard and _FINISH macros

The comment line regarding IOMMU_INIT and IOMMU_INIT_FINISH macros is incorrect:
"The standard vs the _FINISH differs in that the _FINISH variant will
continue detecting other IOMMUs in the call list..."
It should be "..the *standard* variant will continue detecting..."

Fix that.

---
 arch/x86/include/asm/iommu_table.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/include/asm/iommu_table.h +1 -1
index f42a047..16845d4 100644
@@ -79,7 +79,7 @@ struct iommu_table_entry {
  *  d). Similar to the 'init', except that this gets called from pci_iommu_init
  *      where we do have a memory allocator.
  *
- * The standard vs the _FINISH differs in that the _FINISH variant will
+ * The standard vs the _FINISH differs in that the standard variant will
  * continue detecting other IOMMUs in the call list after the
  * the detection routine returns a positive number. The _FINISH will
  * stop the execution chain. Both will still call the 'init' and
Signature · 1 line
1.9.1
#1 lore raw
Quoted 18 lines · Aravind Gopalakrishnan

The comment line regarding IOMMU_INIT and IOMMU_INIT_FINISH macros is incorrect:
"The standard vs the _FINISH differs in that the _FINISH variant will
continue detecting other IOMMUs in the call list..."
It should be "..the *standard* variant will continue detecting..."

Fix that.

---
 arch/x86/include/asm/iommu_table.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/include/asm/iommu_table.h +0 -0
index f42a047..16845d4 100644

arch/x86/include/asm/iommu_table.h struct iommu_table_entry { · line 85

Quoted 8 lines
arch/x86/include/asm/iommu_table.h +1 -1
@@ -79,7 +79,7 @@ struct iommu_table_entry {
  *  d). Similar to the 'init', except that this gets called from pci_iommu_init
  *      where we do have a memory allocator.
  *
- * The standard vs the _FINISH differs in that the _FINISH variant will
+ * The standard vs the _FINISH differs in that the standard variant will
  * continue detecting other IOMMUs in the call list after the
  * the detection routine returns a positive number. The _FINISH will
  * stop the execution chain. Both will still call the 'init' and

Applied, thanks.

Signature · 5 lines
Regards/Gruss,
    Boris.

ECO tip #101: Trim your mails when you reply.
--
#2 lore raw
In reply to Aravind Gopalakrishnan
Quoted 18 lines · Aravind Gopalakrishnan

The comment line regarding IOMMU_INIT and IOMMU_INIT_FINISH macros is incorrect:
"The standard vs the _FINISH differs in that the _FINISH variant will
continue detecting other IOMMUs in the call list..."
It should be "..the *standard* variant will continue detecting..."

Fix that.

---
 arch/x86/include/asm/iommu_table.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/include/asm/iommu_table.h +0 -0
index f42a047..16845d4 100644

arch/x86/include/asm/iommu_table.h struct iommu_table_entry { · line 85

Quoted 8 lines
arch/x86/include/asm/iommu_table.h +1 -1
@@ -79,7 +79,7 @@ struct iommu_table_entry {
  *  d). Similar to the 'init', except that this gets called from pci_iommu_init
  *      where we do have a memory allocator.
  *
- * The standard vs the _FINISH differs in that the _FINISH variant will
+ * The standard vs the _FINISH differs in that the standard variant will
  * continue detecting other IOMMUs in the call list after the
  * the detection routine returns a positive number. The _FINISH will
  * stop the execution chain. Both will still call the 'init' and

So while we are touching it, how about making it more readable:

*
* The standard vs the _FINISH variants differ in that the
* standard variant will continue detecting other IOMMUs in the
* call list after the detection routine returns a positive number.
* The _FINISH variant will stop the execution chain. Both variants
* will still call the 'init' and ...
*

I also fixed a 'the the' typo.

Thanks,

Ingo

#3 lore raw
Quoted 9 lines · Ingo Molnar

So while we are touching it, how about making it more readable:

*
* The standard vs the _FINISH variants differ in that the
* standard variant will continue detecting other IOMMUs in the
* call list after the detection routine returns a positive number.
* The _FINISH variant will stop the execution chain. Both variants
* will still call the 'init' and ...
*

I went a step further :-)

---
From: Aravind Gopalakrishnan <[email protected]>
Date: Wed, 8 Apr 2015 10:46:57 -0500
Subject: [PATCH] x86/iommu: Fix header comments regarding standard and _FINISH
macros

The comment line regarding IOMMU_INIT and IOMMU_INIT_FINISH macros is incorrect:

"The standard vs the _FINISH differs in that the _FINISH variant will continue detecting other IOMMUs in the call list..."

It should be "..the *standard* variant will continue detecting..."

Fix that. Also, make it readable while at it.

Fixes 6e9636693373 ("x86, iommu: Update header comments with appropriate naming")
Cc Thomas Gleixner <[email protected]>
Cc H. Peter Anvin <[email protected]>
Cc x86-ml <[email protected]>

Signed-off-by:

---
 arch/x86/include/asm/iommu_table.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
arch/x86/include/asm/iommu_table.h +6 -5
index f42a04735a0a..e37d6b3ad983 100644
@@ -79,11 +79,12 @@ struct iommu_table_entry {
  *  d). Similar to the 'init', except that this gets called from pci_iommu_init
  *      where we do have a memory allocator.
  *
- * The standard vs the _FINISH differs in that the _FINISH variant will
- * continue detecting other IOMMUs in the call list after the
- * the detection routine returns a positive number. The _FINISH will
- * stop the execution chain. Both will still call the 'init' and
- * 'late_init' functions if they are set.
+ * The standard IOMMU_INIT differs from the IOMMU_INIT_FINISH variant
+ * in that the former will continue detecting other IOMMUs in the call
+ * list after the detection routine returns a positive number, while the
+ * latter will stop the execution chain upon first successful detection.
+ * Both variants will still call the 'init' and 'late_init' functions if
+ * they are set.
  */
 #define IOMMU_INIT_FINISH(_detect, _depend, _init, _late_init)		\
 	__IOMMU_INIT(_detect, _depend, _init, _late_init, 1)
Signature · 8 lines
2.3.3

-- 
Regards/Gruss,
    Boris.

ECO tip #101: Trim your mails when you reply.
--
#4 lore raw
Quoted 53 lines · Borislav Petkov
Quoted 9 lines · Ingo Molnar

So while we are touching it, how about making it more readable:

*
* The standard vs the _FINISH variants differ in that the
* standard variant will continue detecting other IOMMUs in the
* call list after the detection routine returns a positive number.
* The _FINISH variant will stop the execution chain. Both variants
* will still call the 'init' and ...
*

I went a step further :-)

---
From: Aravind Gopalakrishnan <[email protected]>
Date: Wed, 8 Apr 2015 10:46:57 -0500
Subject: [PATCH] x86/iommu: Fix header comments regarding standard and _FINISH
macros

The comment line regarding IOMMU_INIT and IOMMU_INIT_FINISH macros is incorrect:

"The standard vs the _FINISH differs in that the _FINISH variant will continue detecting other IOMMUs in the call list..."

It should be "..the *standard* variant will continue detecting..."

Fix that. Also, make it readable while at it.

Fixes 6e9636693373 ("x86, iommu: Update header comments with appropriate naming")
Cc Thomas Gleixner <[email protected]>
Cc H. Peter Anvin <[email protected]>
Cc x86-ml <[email protected]>

Signed-off-by:

---
 arch/x86/include/asm/iommu_table.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
arch/x86/include/asm/iommu_table.h +0 -4
index f42a04735a0a..e37d6b3ad983 100644
@@ -79,11 +79,12 @@ struct iommu_table_entry {
  *  d). Similar to the 'init', except that this gets called from pci_iommu_init
  *      where we do have a memory allocator.
  *
- * The standard vs the _FINISH differs in that the _FINISH variant will
- * continue detecting other IOMMUs in the call list after the
- * the detection routine returns a positive number. The _FINISH will
- * stop the execution chain. Both will still call the 'init' and

arch/x86/include/asm/iommu_table.h struct iommu_table_entry { · line 90

Quoted 10 lines
arch/x86/include/asm/iommu_table.h +6 -1
- * 'late_init' functions if they are set.
+ * The standard IOMMU_INIT differs from the IOMMU_INIT_FINISH variant
+ * in that the former will continue detecting other IOMMUs in the call
+ * list after the detection routine returns a positive number, while the
+ * latter will stop the execution chain upon first successful detection.
+ * Both variants will still call the 'init' and 'late_init' functions if
+ * they are set.
  */
 #define IOMMU_INIT_FINISH(_detect, _depend, _init, _late_init)		\
 	__IOMMU_INIT(_detect, _depend, _init, _late_init, 1)

Sounds good to me!

Thanks,

Ingo

#5 lore raw
In reply to Borislav Petkov
Quoted 34 lines · Borislav Petkov
Quoted 6 lines · Ingo Molnar

So while we are touching it, how about making it more readable:

*
* The standard vs the _FINISH variants differ in that the
* standard variant will continue detecting other IOMMUs in the
* call list after the detection routine returns a positive

number.

Quoted 1 line

* The _FINISH variant will stop the execution chain. Both

variants

Quoted 2 lines

* will still call the 'init' and ...
*

I went a step further :-)

---
From: Aravind Gopalakrishnan <[email protected]>
Date: Wed, 8 Apr 2015 10:46:57 -0500
Subject: [PATCH] x86/iommu: Fix header comments regarding standard and _FINISH
macros

The comment line regarding IOMMU_INIT and IOMMU_INIT_FINISH macros is incorrect:

"The standard vs the _FINISH differs in that the _FINISH variant will continue detecting other IOMMUs in the call list..."

It should be "..the *standard* variant will continue detecting..."

Fix that. Also, make it readable while at it.

Fixes 6e9636693373 ("x86, iommu: Update header comments with
Quoted 8 lines

appropriate naming")
Cc: Thomas Gleixner <[email protected]>
Cc: H. Peter Anvin <[email protected]>
Cc: x86-ml <[email protected]>
Cc: [email protected]
Link:
http://lkml.kernel.org/r/[email protected]
Signed-off-by:

What is with that empty SoB?

Otherwise Reviewed-by: Konrad Rzeszutek Wilk <[email protected]>

Quoted 32 lines

---
arch/x86/include/asm/iommu_table.h | 11 ++++++-----

1 file changed, 6 insertions(+), 5 deletions(-)
arch/x86/include/asm/iommu_table.h +0 -0
index f42a04735a0a..e37d6b3ad983 100644
@@ -79,11 +79,12 @@ struct iommu_table_entry {
 *  d). Similar to the 'init', except that this gets called from

pci_iommu_init
* where we do have a memory allocator.
*
- * The standard vs the _FINISH differs in that the _FINISH variant will
- * continue detecting other IOMMUs in the call list after the
- * the detection routine returns a positive number. The _FINISH will
- * stop the execution chain. Both will still call the 'init' and
- * 'late_init' functions if they are set.
+ * The standard IOMMU_INIT differs from the IOMMU_INIT_FINISH variant
+ * in that the former will continue detecting other IOMMUs in the call
+ * list after the detection routine returns a positive number, while the
+ * latter will stop the execution chain upon first successful detection.
+ * Both variants will still call the 'init' and 'late_init' functions if
+ * they are set.
*/

#define IOMMU_INIT_FINISH(_detect, _depend, _init, _late_init)		\
	__IOMMU_INIT(_detect, _depend, _init, _late_init, 1)
#6 lore raw
Quoted 4 lines · Konrad Rzeszutek Wilk
Quoted 2 lines

http://lkml.kernel.org/r/[email protected]
Signed-off-by:

What is with that empty SoB?

I'm invisible :-)

Anyway, Ingo applied the correct version.

Signature · 5 lines
Regards/Gruss,
    Boris.

ECO tip #101: Trim your mails when you reply.
--
#7 lore raw

[tip:x86/cleanups] x86/iommu: Fix header comments regarding standard and _FINISH macros

In reply to Aravind Gopalakrishnan
x86/iommu: Fix header comments regarding standard and _FINISH macros
Commit-ID:  b44915927ca88084a7292e4ddd4cf91036f365e1
Gitweb:     http://git.kernel.org/tip/b44915927ca88084a7292e4ddd4cf91036f365e1
Author:     Aravind Gopalakrishnan <[email protected]>
AuthorDate: Thu, 9 Apr 2015 10:51:48 +0200
Committer:  Ingo Molnar <[email protected]>
CommitDate: Thu, 9 Apr 2015 10:56:31 +0200

x86/iommu: Fix header comments regarding standard and _FINISH macros

The comment line regarding IOMMU_INIT and IOMMU_INIT_FINISH macros is incorrect:

"The standard vs the _FINISH differs in that the _FINISH variant will continue detecting other IOMMUs in the call list..."

It should be "..the *standard* variant will continue detecting..."

Fix that. Also, make it readable while at it.

Cc H. Peter Anvin <[email protected]>
Cc Thomas Gleixner <[email protected]>
Fixes 6e9636693373 ("x86, iommu: Update header comments with appropriate naming")
---
 arch/x86/include/asm/iommu_table.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
arch/x86/include/asm/iommu_table.h +6 -5
index f42a047..e37d6b3 100644
@@ -79,11 +79,12 @@ struct iommu_table_entry {
  *  d). Similar to the 'init', except that this gets called from pci_iommu_init
  *      where we do have a memory allocator.
  *
- * The standard vs the _FINISH differs in that the _FINISH variant will
- * continue detecting other IOMMUs in the call list after the
- * the detection routine returns a positive number. The _FINISH will
- * stop the execution chain. Both will still call the 'init' and
- * 'late_init' functions if they are set.
+ * The standard IOMMU_INIT differs from the IOMMU_INIT_FINISH variant
+ * in that the former will continue detecting other IOMMUs in the call
+ * list after the detection routine returns a positive number, while the
+ * latter will stop the execution chain upon first successful detection.
+ * Both variants will still call the 'init' and 'late_init' functions if
+ * they are set.
  */
 #define IOMMU_INIT_FINISH(_detect, _depend, _init, _late_init)		\
 	__IOMMU_INIT(_detect, _depend, _init, _late_init, 1)