Fixed multiple kernel-docs warnings
Signed-off-by: Muhammad Muzammil <[email protected]>
---
include/uapi/linux/iommufd.h | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/include/uapi/linux/iommufd.h b/include/uapi/linux/iommufd.h
index 50f98f01fe10..2211f1b53d6e 100644
--- a/include/uapi/linux/iommufd.h
+++ b/include/uapi/linux/iommufd.h
@@ -419,7 +419,7 @@ enum iommu_hw_info_type {
};
/**
- * enum iommufd_hw_info_capabilities
+ * enum iommufd_hw_capabilities
* @IOMMU_HW_CAP_DIRTY_TRACKING: IOMMU hardware support for dirty tracking
* If available, it means the following APIs
* are supported:
@@ -486,6 +486,7 @@ enum iommufd_hwpt_set_dirty_tracking_flags {
* @size: sizeof(struct iommu_hwpt_set_dirty_tracking)
* @flags: Combination of enum iommufd_hwpt_set_dirty_tracking_flags
* @hwpt_id: HW pagetable ID that represents the IOMMU domain
+ * @__reserved: Must be 0
*
* Toggle dirty tracking on an HW pagetable.
*/
@@ -499,12 +500,12 @@ struct iommu_hwpt_set_dirty_tracking {
IOMMUFD_CMD_HWPT_SET_DIRTY_TRACKING)
/**
- * enum iommufd_get_dirty_bitmap_flags - Flags for getting dirty bits
- * @IOMMU_GET_DIRTY_BITMAP_NO_CLEAR: Just read the PTEs without clearing any
- * dirty bits metadata. This flag can be
- * passed in the expectation where the next
- * operation is an unmap of the same IOVA
- * range.
+ * enum iommufd_hwpt_get_dirty_bitmap_flags - Flags for getting dirty bits
+ * @IOMMU_HWPT_GET_DIRTY_BITMAP_NO_CLEAR: Just read the PTEs without clearing any
+ * dirty bits metadata. This flag can be
+ * passed in the expectation where the next
+ * operation is an unmap of the same IOVA
+ * range.
*
*/
enum iommufd_hwpt_get_dirty_bitmap_flags {
@@ -521,6 +522,7 @@ enum iommufd_hwpt_get_dirty_bitmap_flags {
* @page_size: page size granularity of each bit in the bitmap
* @data: bitmap where to set the dirty bits. The bitmap bits each
* represent a page_size which you deviate from an arbitrary iova.
+ * @__reserved: Must be 0
*
* Checking a given IOVA is dirty:
*
--
2.27.0
Hi all,
Can anyone review and approve this patch?
On Mon, Oct 23, 2023 at 3:39 PM Muhammad Muzammil
<[email protected]> wrote:
>
> Fixed multiple kernel-docs warnings
>
> Signed-off-by: Muhammad Muzammil <[email protected]>
> ---
> include/uapi/linux/iommufd.h | 16 +++++++++-------
> 1 file changed, 9 insertions(+), 7 deletions(-)
>
> diff --git a/include/uapi/linux/iommufd.h b/include/uapi/linux/iommufd.h
> index 50f98f01fe10..2211f1b53d6e 100644
> --- a/include/uapi/linux/iommufd.h
> +++ b/include/uapi/linux/iommufd.h
> @@ -419,7 +419,7 @@ enum iommu_hw_info_type {
> };
>
> /**
> - * enum iommufd_hw_info_capabilities
> + * enum iommufd_hw_capabilities
> * @IOMMU_HW_CAP_DIRTY_TRACKING: IOMMU hardware support for dirty tracking
> * If available, it means the following APIs
> * are supported:
> @@ -486,6 +486,7 @@ enum iommufd_hwpt_set_dirty_tracking_flags {
> * @size: sizeof(struct iommu_hwpt_set_dirty_tracking)
> * @flags: Combination of enum iommufd_hwpt_set_dirty_tracking_flags
> * @hwpt_id: HW pagetable ID that represents the IOMMU domain
> + * @__reserved: Must be 0
> *
> * Toggle dirty tracking on an HW pagetable.
> */
> @@ -499,12 +500,12 @@ struct iommu_hwpt_set_dirty_tracking {
> IOMMUFD_CMD_HWPT_SET_DIRTY_TRACKING)
>
> /**
> - * enum iommufd_get_dirty_bitmap_flags - Flags for getting dirty bits
> - * @IOMMU_GET_DIRTY_BITMAP_NO_CLEAR: Just read the PTEs without clearing any
> - * dirty bits metadata. This flag can be
> - * passed in the expectation where the next
> - * operation is an unmap of the same IOVA
> - * range.
> + * enum iommufd_hwpt_get_dirty_bitmap_flags - Flags for getting dirty bits
> + * @IOMMU_HWPT_GET_DIRTY_BITMAP_NO_CLEAR: Just read the PTEs without clearing any
> + * dirty bits metadata. This flag can be
> + * passed in the expectation where the next
> + * operation is an unmap of the same IOVA
> + * range.
> *
> */
> enum iommufd_hwpt_get_dirty_bitmap_flags {
> @@ -521,6 +522,7 @@ enum iommufd_hwpt_get_dirty_bitmap_flags {
> * @page_size: page size granularity of each bit in the bitmap
> * @data: bitmap where to set the dirty bits. The bitmap bits each
> * represent a page_size which you deviate from an arbitrary iova.
> + * @__reserved: Must be 0
> *
> * Checking a given IOVA is dirty:
> *
> --
> 2.27.0
>
On 24/10/2023 10:48, Muhammad Muzammil wrote:
> Hi all,
>
> Can anyone review and approve this patch?
>
The series that introduced the errors will have it fixed in next version -- I
had fixed it myself when it was reported to me by linux-next integration.
It should hit soon (few hours) in the list (in time for tomorrow's linux-next
build) fixed but fixed in the individual patches that introduced the issue.
There are a couple more changes involved in such version fixing other issues,
hence it took a day more that I originally intended.
Another contributor submitted similar thing:
[1]
https://lore.kernel.org/linux-iommu/[email protected]/
> On Mon, Oct 23, 2023 at 3:39 PM Muhammad Muzammil
> <[email protected]> wrote:
>>
>> Fixed multiple kernel-docs warnings
>>
>> Signed-off-by: Muhammad Muzammil <[email protected]>
>> ---
>> include/uapi/linux/iommufd.h | 16 +++++++++-------
>> 1 file changed, 9 insertions(+), 7 deletions(-)
>>
>> diff --git a/include/uapi/linux/iommufd.h b/include/uapi/linux/iommufd.h
>> index 50f98f01fe10..2211f1b53d6e 100644
>> --- a/include/uapi/linux/iommufd.h
>> +++ b/include/uapi/linux/iommufd.h
>> @@ -419,7 +419,7 @@ enum iommu_hw_info_type {
>> };
>>
>> /**
>> - * enum iommufd_hw_info_capabilities
>> + * enum iommufd_hw_capabilities
>> * @IOMMU_HW_CAP_DIRTY_TRACKING: IOMMU hardware support for dirty tracking
>> * If available, it means the following APIs
>> * are supported:
>> @@ -486,6 +486,7 @@ enum iommufd_hwpt_set_dirty_tracking_flags {
>> * @size: sizeof(struct iommu_hwpt_set_dirty_tracking)
>> * @flags: Combination of enum iommufd_hwpt_set_dirty_tracking_flags
>> * @hwpt_id: HW pagetable ID that represents the IOMMU domain
>> + * @__reserved: Must be 0
>> *
>> * Toggle dirty tracking on an HW pagetable.
>> */
>> @@ -499,12 +500,12 @@ struct iommu_hwpt_set_dirty_tracking {
>> IOMMUFD_CMD_HWPT_SET_DIRTY_TRACKING)
>>
>> /**
>> - * enum iommufd_get_dirty_bitmap_flags - Flags for getting dirty bits
>> - * @IOMMU_GET_DIRTY_BITMAP_NO_CLEAR: Just read the PTEs without clearing any
>> - * dirty bits metadata. This flag can be
>> - * passed in the expectation where the next
>> - * operation is an unmap of the same IOVA
>> - * range.
>> + * enum iommufd_hwpt_get_dirty_bitmap_flags - Flags for getting dirty bits
>> + * @IOMMU_HWPT_GET_DIRTY_BITMAP_NO_CLEAR: Just read the PTEs without clearing any
>> + * dirty bits metadata. This flag can be
>> + * passed in the expectation where the next
>> + * operation is an unmap of the same IOVA
>> + * range.
>> *
>> */
>> enum iommufd_hwpt_get_dirty_bitmap_flags {
>> @@ -521,6 +522,7 @@ enum iommufd_hwpt_get_dirty_bitmap_flags {
>> * @page_size: page size granularity of each bit in the bitmap
>> * @data: bitmap where to set the dirty bits. The bitmap bits each
>> * represent a page_size which you deviate from an arbitrary iova.
>> + * @__reserved: Must be 0
>> *
>> * Checking a given IOVA is dirty:
>> *
>> --
>> 2.27.0
>>
>