Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Fri, 15 Jul 2022 17:31:49 -0400
From:   Rodrigo Vivi <rodrigo.vivi@intel.com>
To:     Mauro Carvalho Chehab <mchehab@kernel.org>
CC:     David Airlie <airlied@linux.ie>, <intel-gfx@lists.freedesktop.org>,
        "Lucas De Marchi" <lucas.demarchi@intel.com>,
        <linux-kernel@vger.kernel.org>, <dri-devel@lists.freedesktop.org>
Subject: Re: [Intel-gfx] [PATCH v2 14/39] drm/i915: document kernel-doc
 trivial issues
Message-ID: <YtHcxUNGPk8pdHtR@intel.com>
References: <cover.1657699522.git.mchehab@kernel.org>
 <6eca50ad78a54cadaf8e4deecec2309400c24164.1657699522.git.mchehab@kernel.org>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <6eca50ad78a54cadaf8e4deecec2309400c24164.1657699522.git.mchehab@kernel.org>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?Krdxi5ApWzdIM7ZuPGeZLOGOHQ+ET+xL5cKpT79z/Iyjvd4Y+29TJVZWhpC9?=
 =?us-ascii?Q?cmUP5Tak2ZUwygwtJ4pnuBPsLk8iS3BFbvHYlnHYtcLI84QTD2uVm+2e+Y4U?=
 =?us-ascii?Q?tNv+58ai2HCJDrmKC4yf4pmzstt7YPXNlcyIgDL9J/0kjQhw1Rik8s9QRNBT?=
 =?us-ascii?Q?2YftKwY+yGzy376ivV/jzDibIk9VgzspcqC/d770Agw0ugPPVSzp9kRUP2C2?=
 =?us-ascii?Q?umm0RcOrdgOEmjXxVcOI8/2nQ3tsNa3P9axKrNTYrZt4KR7pxwLa2p06oyVC?=
 =?us-ascii?Q?3yTI99ufCyp4ZlxOL8uuoZekOGaLYmQwsjym3t4O82AFA8aQB1kie25mM+zW?=
 =?us-ascii?Q?0Ncl1zquPQOsk4TkuXd7OW/O5F1nT4B9H578Y2xHf/Yz3NLZ/OVTO2E3zukQ?=
 =?us-ascii?Q?Z6AeGc7yN+ghmNvPcksW030WiiYmnRT5hthdjgTvAS+JJquzS1bDyCRTwhbL?=
 =?us-ascii?Q?UAArbILDuDAj7vZExQ8HLurhxImWCpB6PPTdnIeix5bDOPaO7QCIYU1v3cuO?=
 =?us-ascii?Q?Z9G2yw3VkvLbuUHLm4HwcMv1KaVIM10VitoSvXTFJvbWYZ2qoXglwOl34KfJ?=
 =?us-ascii?Q?wOHDKBasmC1yoDzfvp0Y6PtO4IhCRga8Q9mxbEUJ5oNZc1Dvwbqjg9KHHH9y?=
 =?us-ascii?Q?IRp4rA7WUvMgXWegqpLoUq3gLD4JO1/on5jbvbrYAInQbIFpq+VabqyeMT2/?=
 =?us-ascii?Q?lifBMgt7sbpfigLRmlfn6Ehehs6Jxe4FndhQX2m2ll92HpuWPDcqwA2wYMqE?=
 =?us-ascii?Q?UL2pPswUDtsyGgs5vzQDuTuyWqNnIpJRihD+m8p+7eNBYQORcwE+bIJUAyQx?=
 =?us-ascii?Q?0dgkP/BzNyr6kO1lNLyeqSzCGrPAA6mr3noal6R6X0CAYEIOo/vwaqr/HZIr?=
 =?us-ascii?Q?i6sJB6gNWh4nNcqCeTIBuhD4ZT8R3vrX1mZh/miXnE3iodBBMJSBKuYOxOMi?=
 =?us-ascii?Q?ZWvlAA+td3bgMmSKn8XTa6ENzMReSc6cVvuIye9DAnaNBUhrcL8KQqAMHPpe?=
 =?us-ascii?Q?ZwqtNLdTHlDyHe74E8+SQMVnPGee/SIBA0kQlwfQZDjxnhAgP3PytDHrBZHr?=
 =?us-ascii?Q?DGFDL5i/HzgJoFUa2lR7IPtmq8l8Lu2g4LuU+nrSS1alSs9XvUByGHjMqHkn?=
 =?us-ascii?Q?32c0lpHndwZigIXbuieek6QL6ejuCqDljplMX6BbWq+8RpDZULIfsFes9l7y?=
 =?us-ascii?Q?0+lJEBH1g5p9v2iD9z1YK9CZ08Fh8qcIAsRucVAWG8YYccCakXHidS9QXlvu?=
 =?us-ascii?Q?2O73LNTsTwv050ddbe7e1qWcHKkjyNkgpB4AqJ2pS1WZVV34v5WrxPbNM37F?=
 =?us-ascii?Q?XiKps0PE0S3sslW+aNS1KR56b5Hyjs93EJyzSlY6LXQMMH+f5Yr0li2d6AZN?=
 =?us-ascii?Q?PXhI+c+cQQHXoR/a8f1UdWQ6ETyMuiQrVJyAAL580JU+s0wNSqiripVCKxvK?=
 =?us-ascii?Q?KaxTJ06+9P2m3eWhMPw92v2DlgemZJOTQTjqPBc3iiFERBbAkMWAnWCLpgnp?=
 =?us-ascii?Q?ecRMlX5uPUwf3MP0vur3HlXsFdifd2I8lGSOF94NsL4k/nWAVv82M7cTU4Vy?=
 =?us-ascii?Q?yX/TNFZHMnLWpaxOU7Nto2nDALS1Ru/UmCHDGRIRR4LKbBk80e0+dj2vu4ei?=
 =?us-ascii?Q?Gw=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: f57da322-cf2a-4126-5796-08da66a96f99
X-MS-Exchange-CrossTenant-AuthSource: MN0PR11MB6059.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Jul 2022 21:31:54.1984
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: VRENBkyvcxu6QTGi/wwTbJ9n+4hZkFZwBlrmnrIb+EX1daN97s17mMPk5y2PhgIkMmSnDS2d4d1VZm0fItHyZA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR1101MB2120
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-7.7 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI,
        SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Wed, Jul 13, 2022 at 09:12:02AM +0100, Mauro Carvalho Chehab wrote:
> Fix those kernel-doc warnings:
> 	drivers/gpu/drm/i915/intel_region_ttm.c:199: warning: Function parameter or member 'offset' not described in 'intel_region_ttm_resource_alloc'
> 	drivers/gpu/drm/i915/i915_vma_resource.h:123: warning: Function parameter or member 'wakeref' not described in 'i915_vma_resource'
> 	drivers/gpu/drm/i915/i915_vma.c:1703: warning: Function parameter or member 'vma' not described in 'i915_vma_destroy_locked'
> 	drivers/gpu/drm/i915/i915_vma.c:751: warning: Function parameter or member 'ww' not described in 'i915_vma_insert'
> 	drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c:159: warning: Function parameter or member 'gt' not described in 'intel_gt_fini_hwconfig'
> 	drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c:146: warning: Function parameter or member 'gt' not described in 'intel_gt_init_hwconfig'
> 	drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c:113: warning: expecting prototype for intel_guc_hwconfig_init(). Prototype was for guc_hwconfig_init() instead
> 	drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c:113: warning: Function parameter or member 'gt' not described in 'guc_hwconfig_init'
> 	drivers/gpu/drm/i915/gt/intel_engine_types.h:276: warning: Function parameter or member 'preempt_hang' not described in 'intel_engine_execlists'
> 
> That are due undocumented parameters.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/
> 
>  drivers/gpu/drm/i915/gt/intel_engine_types.h    | 1 +
>  drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c | 5 ++++-
>  drivers/gpu/drm/i915/i915_vma.c                 | 2 ++
>  drivers/gpu/drm/i915/i915_vma_resource.h        | 1 +
>  drivers/gpu/drm/i915/intel_region_ttm.c         | 3 ++-
>  5 files changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i915/gt/intel_engine_types.h b/drivers/gpu/drm/i915/gt/intel_engine_types.h
> index 633a7e5dba3b..7c5ad9071fe7 100644
> --- a/drivers/gpu/drm/i915/gt/intel_engine_types.h
> +++ b/drivers/gpu/drm/i915/gt/intel_engine_types.h
> @@ -271,6 +271,7 @@ struct intel_engine_execlists {
>  	 */
>  	u8 csb_head;
>  
> +	/* private: Used only in selftests */
>  	I915_SELFTEST_DECLARE(struct st_preempt_hang preempt_hang;)
>  };
>  
> diff --git a/drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c b/drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c
> index 4781fccc2687..76f7447302a6 100644
> --- a/drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c
> +++ b/drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c
> @@ -103,7 +103,8 @@ static bool has_table(struct drm_i915_private *i915)
>  }
>  
>  /**
> - * intel_guc_hwconfig_init - Initialize the HWConfig
> + * guc_hwconfig_init - Initialize the HWConfig
> + * @gt: GT structure
>   *
>   * Retrieve the HWConfig table from the GuC and save it locally.
>   * It can then be queried on demand by other users later on.
> @@ -138,6 +139,7 @@ static int guc_hwconfig_init(struct intel_gt *gt)
>  
>  /**
>   * intel_gt_init_hwconfig - Initialize the HWConfig if available
> + * @gt: GT structure
>   *
>   * Retrieve the HWConfig table if available on the current platform.
>   */
> @@ -151,6 +153,7 @@ int intel_gt_init_hwconfig(struct intel_gt *gt)
>  
>  /**
>   * intel_gt_fini_hwconfig - Finalize the HWConfig
> + * @gt: GT structure
>   *
>   * Free up the memory allocation holding the table.
>   */
> diff --git a/drivers/gpu/drm/i915/i915_vma.c b/drivers/gpu/drm/i915/i915_vma.c
> index ef3b04c7e153..ddf348c597b0 100644
> --- a/drivers/gpu/drm/i915/i915_vma.c
> +++ b/drivers/gpu/drm/i915/i915_vma.c
> @@ -733,6 +733,7 @@ bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long color)
>  /**
>   * i915_vma_insert - finds a slot for the vma in its address space
>   * @vma: the vma
> + * @ww: An optional struct i915_gem_ww_ctx
>   * @size: requested size in bytes (can be larger than the VMA)
>   * @alignment: required alignment
>   * @flags: mask of PIN_* flags to use
> @@ -1675,6 +1676,7 @@ static void release_references(struct i915_vma *vma, struct intel_gt *gt,
>  /**
>   * i915_vma_destroy_locked - Remove all weak reference to the vma and put
>   * the initial reference.
> + * @vma: VMA to destroy
>   *
>   * This function should be called when it's decided the vma isn't needed
>   * anymore. The caller must assure that it doesn't race with another lookup
> diff --git a/drivers/gpu/drm/i915/i915_vma_resource.h b/drivers/gpu/drm/i915/i915_vma_resource.h
> index 14a0327b2080..a15271d96b7e 100644
> --- a/drivers/gpu/drm/i915/i915_vma_resource.h
> +++ b/drivers/gpu/drm/i915/i915_vma_resource.h
> @@ -49,6 +49,7 @@ struct i915_page_sizes {
>   * @__subtree_last: Interval tree private member.
>   * @vm: non-refcounted pointer to the vm. This is for internal use only and
>   * this member is cleared after vm_resource unbind.
> + * @wakeref: wakeref used for runtime PM reference.
>   * @mr: The memory region of the object pointed to by the vma.
>   * @ops: Pointer to the backend i915_vma_ops.
>   * @private: Bind backend private info.
> diff --git a/drivers/gpu/drm/i915/intel_region_ttm.c b/drivers/gpu/drm/i915/intel_region_ttm.c
> index 6873808a7015..471a70c50b2c 100644
> --- a/drivers/gpu/drm/i915/intel_region_ttm.c
> +++ b/drivers/gpu/drm/i915/intel_region_ttm.c
> @@ -181,7 +181,8 @@ intel_region_ttm_resource_to_rsgt(struct intel_memory_region *mem,
>  #ifdef CONFIG_DRM_I915_SELFTEST
>  /**
>   * intel_region_ttm_resource_alloc - Allocate memory resources from a region
> - * @mem: The memory region,
> + * @mem: The memory region
> + * @offset: The range start
>   * @size: The requested size in bytes
>   * @flags: Allocation flags
>   *
> -- 
> 2.36.1
>