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

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

[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.

Signed-off-by: Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com>
---
 arch/x86/include/asm/iommu_table.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/include/asm/iommu_table.h b/arch/x86/include/asm/iommu_table.h
index f42a047..16845d4 100644
--- a/arch/x86/include/asm/iommu_table.h
+++ b/arch/x86/include/asm/iommu_table.h
@@ -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
-- 
1.9.1

Re: [PATCH] x86, iommu: Fix header comments regarding standard and _FINISH macros

[Borislav Petkov]

On Wed, Apr 08, 2015 at 10:46:57AM -0500, Aravind Gopalakrishnan wrote:
> 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.
> 
> Signed-off-by: Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com>
> ---
>  arch/x86/include/asm/iommu_table.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/arch/x86/include/asm/iommu_table.h b/arch/x86/include/asm/iommu_table.h
> index f42a047..16845d4 100644
> --- a/arch/x86/include/asm/iommu_table.h
> +++ b/arch/x86/include/asm/iommu_table.h
> @@ -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.

-- 
Regards/Gruss,
    Boris.

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

Re: [PATCH] x86, iommu: Fix header comments regarding standard and _FINISH macros

[Ingo Molnar]

* Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com> wrote:

> 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.
> 
> Signed-off-by: Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com>
> ---
>  arch/x86/include/asm/iommu_table.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/arch/x86/include/asm/iommu_table.h b/arch/x86/include/asm/iommu_table.h
> index f42a047..16845d4 100644
> --- a/arch/x86/include/asm/iommu_table.h
> +++ b/arch/x86/include/asm/iommu_table.h
> @@ -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

Re: [PATCH] x86, iommu: Fix header comments regarding standard and _FINISH macros

[Borislav Petkov]

On Thu, Apr 09, 2015 at 09:37:44AM +0200, Ingo Molnar wrote:
> 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 <Aravind.Gopalakrishnan@amd.com>
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.

Signed-off-by: Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com>
Fixes: 6e9636693373 ("x86, iommu: Update header comments with appropriate naming")
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: H. Peter Anvin <hpa@zytor.com>
Cc: x86-ml <x86@kernel.org>
Cc: konrad.wilk@oracle.com
Link: http://lkml.kernel.org/r/1428508017-5316-1-git-send-email-Aravind.Gopalakrishnan@amd.com
Signed-off-by: 
---
 arch/x86/include/asm/iommu_table.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/arch/x86/include/asm/iommu_table.h b/arch/x86/include/asm/iommu_table.h
index f42a04735a0a..e37d6b3ad983 100644
--- a/arch/x86/include/asm/iommu_table.h
+++ b/arch/x86/include/asm/iommu_table.h
@@ -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)
-- 
2.3.3

-- 
Regards/Gruss,
    Boris.

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

Re: [PATCH] x86, iommu: Fix header comments regarding standard and _FINISH macros

[Ingo Molnar]

* Borislav Petkov <bp@suse.de> wrote:

> On Thu, Apr 09, 2015 at 09:37:44AM +0200, Ingo Molnar wrote:
> > 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 <Aravind.Gopalakrishnan@amd.com>
> 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.
> 
> Signed-off-by: Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com>
> Fixes: 6e9636693373 ("x86, iommu: Update header comments with appropriate naming")
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: H. Peter Anvin <hpa@zytor.com>
> Cc: x86-ml <x86@kernel.org>
> Cc: konrad.wilk@oracle.com
> Link: http://lkml.kernel.org/r/1428508017-5316-1-git-send-email-Aravind.Gopalakrishnan@amd.com
> Signed-off-by: 
> ---
>  arch/x86/include/asm/iommu_table.h | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
> diff --git a/arch/x86/include/asm/iommu_table.h b/arch/x86/include/asm/iommu_table.h
> index f42a04735a0a..e37d6b3ad983 100644
> --- a/arch/x86/include/asm/iommu_table.h
> +++ b/arch/x86/include/asm/iommu_table.h
> @@ -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)

Sounds good to me!

Thanks,

	Ingo

Re: [PATCH] x86, iommu: Fix header comments regarding standard and _FINISH macros

[Konrad Rzeszutek Wilk]

On April 9, 2015 3:54:08 AM EDT, Borislav Petkov <bp@suse.de> wrote:
>On Thu, Apr 09, 2015 at 09:37:44AM +0200, Ingo Molnar wrote:
>> 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 <Aravind.Gopalakrishnan@amd.com>
>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.
>
>Signed-off-by: Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com>
>Fixes: 6e9636693373 ("x86, iommu: Update header comments with
>appropriate naming")
>Cc: Thomas Gleixner <tglx@linutronix.de>
>Cc: H. Peter Anvin <hpa@zytor.com>
>Cc: x86-ml <x86@kernel.org>
>Cc: konrad.wilk@oracle.com
>Link:
>http://lkml.kernel.org/r/1428508017-5316-1-git-send-email-Aravind.Gopalakrishnan@amd.com
>Signed-off-by: 

What is with that empty SoB?


Otherwise Reviewed-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
>---
> arch/x86/include/asm/iommu_table.h | 11 ++++++-----
> 1 file changed, 6 insertions(+), 5 deletions(-)
>
>diff --git a/arch/x86/include/asm/iommu_table.h
>b/arch/x86/include/asm/iommu_table.h
>index f42a04735a0a..e37d6b3ad983 100644
>--- a/arch/x86/include/asm/iommu_table.h
>+++ b/arch/x86/include/asm/iommu_table.h
>@@ -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)

Re: [PATCH] x86, iommu: Fix header comments regarding standard and _FINISH macros

[Borislav Petkov]

On Thu, Apr 09, 2015 at 06:31:17AM -0400, Konrad Rzeszutek Wilk wrote:
> >http://lkml.kernel.org/r/1428508017-5316-1-git-send-email-Aravind.Gopalakrishnan@amd.com
> >Signed-off-by: 
> 
> What is with that empty SoB?

I'm invisible :-)

Anyway, Ingo applied the correct version.

-- 
Regards/Gruss,
    Boris.

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

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

[tip-bot for Aravind Gopalakrishnan]

Commit-ID:  b44915927ca88084a7292e4ddd4cf91036f365e1
Gitweb:     http://git.kernel.org/tip/b44915927ca88084a7292e4ddd4cf91036f365e1
Author:     Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com>
AuthorDate: Thu, 9 Apr 2015 10:51:48 +0200
Committer:  Ingo Molnar <mingo@kernel.org>
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.

Signed-off-by: Aravind Gopalakrishnan <Aravind.Gopalakrishnan@amd.com>
Signed-off-by: Borislav Petkov <bp@suse.de>
Cc: H. Peter Anvin <hpa@zytor.com>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: konrad.wilk@oracle.com
Fixes: 6e9636693373 ("x86, iommu: Update header comments with appropriate naming")
Link: http://lkml.kernel.org/r/1428508017-5316-1-git-send-email-Aravind.Gopalakrishnan@amd.com
Signed-off-by: Ingo Molnar <mingo@kernel.org>
---
 arch/x86/include/asm/iommu_table.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/arch/x86/include/asm/iommu_table.h b/arch/x86/include/asm/iommu_table.h
index f42a047..e37d6b3 100644
--- a/arch/x86/include/asm/iommu_table.h
+++ b/arch/x86/include/asm/iommu_table.h
@@ -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)