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

[Ingo Molnar <mingo@kernel.org>]

* 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