[PATCH v2] KVM: arm64: fix doc warnings in mmu code

[Xiaofei Tan]

Hi Will,

Thanks for your advices, will accept all of them.

On 2020/9/16 16:37, Will Deacon wrote:
> On Wed, Sep 16, 2020 at 10:00:39AM +0800, Xiaofei Tan wrote:
>> Fix following warnings caused by mismatch bewteen function parameters
>> and comments.
>> arch/arm64/kvm/mmu.c:128: warning: Function parameter or member 'mmu' not described in '__unmap_stage2_range'
>> arch/arm64/kvm/mmu.c:128: warning: Function parameter or member 'may_block' not described in '__unmap_stage2_range'
>> arch/arm64/kvm/mmu.c:128: warning: Excess function parameter 'kvm' description in '__unmap_stage2_range'
>> arch/arm64/kvm/mmu.c:499: warning: Function parameter or member 'writable' not described in 'kvm_phys_addr_ioremap'
>> arch/arm64/kvm/mmu.c:538: warning: Function parameter or member 'mmu' not described in 'stage2_wp_range'
>> arch/arm64/kvm/mmu.c:538: warning: Excess function parameter 'kvm' description in 'stage2_wp_range'
>>
>> Signed-off-by: Xiaofei Tan <tanxiaofei at huawei.com>
>> ---
>>  arch/arm64/kvm/mmu.c | 6 ++++--
>>  1 file changed, 4 insertions(+), 2 deletions(-)
>>
>> diff --git a/arch/arm64/kvm/mmu.c b/arch/arm64/kvm/mmu.c
>> index e8a51799..909e995 100644
>> --- a/arch/arm64/kvm/mmu.c
>> +++ b/arch/arm64/kvm/mmu.c
>> @@ -114,9 +114,10 @@ static bool kvm_is_device_pfn(unsigned long pfn)
>>   */
>>  /**
>>   * unmap_stage2_range -- Clear stage2 page table entries to unmap a range
>> - * @kvm:   The VM pointer
>> + * @mmu:   pointer to mmu structure to operate on
>>   * @start: The intermediate physical base address of the range to unmap
>>   * @size:  The size of the area to unmap
>> + * @may_block: The flag that if block is allowed here
> 
> Whether or not we are permitted to block.
> 
>>   *
>>   * Clear a range of stage-2 mappings, lowering the various ref-counts.  Must
>>   * be called while holding mmu_lock (unless for freeing the stage2 pgd before
>> @@ -493,6 +494,7 @@ void kvm_free_stage2_pgd(struct kvm_s2_mmu *mmu)
>>   * @guest_ipa:	The IPA at which to insert the mapping
>>   * @pa:		The physical address of the device
>>   * @size:	The size of the mapping
>> + * @writable:   If it is writable here
> 
> Whether or not to create a writable mapping.
> 
>>   */
>>  int kvm_phys_addr_ioremap(struct kvm *kvm, phys_addr_t guest_ipa,
>>  			  phys_addr_t pa, unsigned long size, bool writable)
>> @@ -530,7 +532,7 @@ int kvm_phys_addr_ioremap(struct kvm *kvm, phys_addr_t guest_ipa,
>>  
>>  /**
>>   * stage2_wp_range() - write protect stage2 memory region range
>> - * @kvm:	The KVM pointer
>> + * @mmu:        pointer to mmu structure to operate on
> 
> The KVM stage-2 MMU pointer.
> 
> Will
> 
> .
> 

-- 
 thanks
tanxiaofei