From: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Matthew Brost <matthew.brost@intel.com>,
Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>,
Balasubramani Vivekanandan <balasubramani.vivekanandan@intel.com>,
David Airlie <airlied@linux.ie>,
Jordan Justen <jordan.l.justen@intel.com>,
intel-gfx@lists.freedesktop.org,
Lucas De Marchi <lucas.demarchi@intel.com>,
Umesh Nerlige Ramappa <umesh.nerlige.ramappa@intel.com>,
linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
Rodrigo Vivi <rodrigo.vivi@intel.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
John Harrison <John.C.Harrison@Intel.com>
Subject: [PATCH v2 14/39] drm/i915: document kernel-doc trivial issues
Date: Wed, 13 Jul 2022 09:12:02 +0100 [thread overview]
Message-ID: <6eca50ad78a54cadaf8e4deecec2309400c24164.1657699522.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1657699522.git.mchehab@kernel.org>
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>
---
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
next prev parent reply other threads:[~2022-07-13 8:15 UTC|newest]
Thread overview: 92+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-13 8:11 [PATCH v2 00/39] drm/i915: fix kernel-doc issues Mauro Carvalho Chehab
2022-07-13 8:11 ` [PATCH v2 01/39] drm/i915/gvt: Fix kernel-doc for intel_gvt_switch_mmio() Mauro Carvalho Chehab
2022-07-13 21:54 ` Rodrigo Vivi
2022-07-13 22:00 ` Rodrigo Vivi
2022-07-14 8:50 ` [Intel-gfx] " Mauro Carvalho Chehab
2022-07-13 8:11 ` [PATCH v2 02/39] drm/i915/gvt: Fix kernel-doc for intel_vgpu_default_mmio_write Mauro Carvalho Chehab
2022-07-13 21:55 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:11 ` [PATCH v2 03/39] drm/i915/gvt: Fix kernel-doc for intel_vgpu_*_resource() Mauro Carvalho Chehab
2022-07-13 22:02 ` Rodrigo Vivi
2022-07-13 8:11 ` [PATCH v2 04/39] drm/i915: fix kernel-doc trivial warnings on i915/*.[ch] files Mauro Carvalho Chehab
2022-07-13 22:02 ` Rodrigo Vivi
2022-07-13 8:11 ` [PATCH v2 05/39] drm/i915: display: fix kernel-doc markup warnings Mauro Carvalho Chehab
2022-07-13 22:05 ` Rodrigo Vivi
2022-07-14 9:56 ` [Intel-gfx] " Mauro Carvalho Chehab
2022-07-13 8:11 ` [PATCH v2 06/39] drm/i915: gt: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-07-13 22:07 ` [Intel-gfx] " Rodrigo Vivi
2022-07-14 10:01 ` Mauro Carvalho Chehab
2022-07-13 8:11 ` [PATCH v2 07/39] drm/i915: gvt: fix kernel-doc trivial warnings Mauro Carvalho Chehab
2022-07-13 22:08 ` Rodrigo Vivi
2022-07-14 4:23 ` Zhenyu Wang
2022-07-13 8:11 ` [PATCH v2 08/39] drm/i915: gem: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-07-13 8:51 ` Das, Nirmoy
2022-07-13 8:11 ` [PATCH v2 09/39] drm/i915: intel_wakeref.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-13 22:09 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:11 ` [PATCH v2 10/39] drm/i915: i915_gem_ttm: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-13 9:02 ` Das, Nirmoy
2022-07-13 8:11 ` [PATCH v2 11/39] drm/i915: i915_gem_ttm_pm.c: fix kernel-doc markups Mauro Carvalho Chehab
2022-08-09 10:23 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 12/39] drm/i915: gem: add kernel-doc description for some function parameters Mauro Carvalho Chehab
2022-07-13 9:09 ` Das, Nirmoy
2022-07-13 8:12 ` [PATCH v2 13/39] drm/i915: i915_gpu_error.c: document dump_flags Mauro Carvalho Chehab
2022-07-15 21:38 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` Mauro Carvalho Chehab [this message]
2022-07-15 21:31 ` [Intel-gfx] [PATCH v2 14/39] drm/i915: document kernel-doc trivial issues Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 15/39] drm/i915: intel_dp_link_training.c: fix kernel-doc markup Mauro Carvalho Chehab
2022-08-09 9:51 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 18:53 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 16/39] drm/i915: intel_fb: fix a kernel-doc issue with Sphinx Mauro Carvalho Chehab
2022-07-15 21:40 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 18:58 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 17/39] drm/i915: skl_scaler: fix return value kernel-doc markup Mauro Carvalho Chehab
2022-07-15 21:42 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 18/39] drm/i915: intel_pm.c: fix some ascii artwork at kernel-doc Mauro Carvalho Chehab
2022-08-09 9:55 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 19:17 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 19/39] drm/i915: i915_gem_region.h: fix i915_gem_apply_to_region_ops doc Mauro Carvalho Chehab
2022-08-09 9:59 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 20/39] drm/i915: i915_gem_wait.c: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-15 21:25 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 21/39] drm/i915: fix i915_gem_ttm_move.c DOC: markup Mauro Carvalho Chehab
2022-07-15 21:41 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 22/39] drm/i915: stop using kernel-doc markups for something else Mauro Carvalho Chehab
2022-07-15 21:34 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 23/39] drm/i915: dvo_ch7xxx.c: use SPDX header Mauro Carvalho Chehab
2022-07-15 21:41 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 24/39] drm/i915: dvo_sil164.c: " Mauro Carvalho Chehab
2022-07-15 21:35 ` Rodrigo Vivi
2022-07-15 22:16 ` Joe Perches
2022-07-18 11:38 ` [Intel-gfx] " Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 25/39] drm/i915: i915_vma_resource.c: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-15 21:32 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 26/39] drm/i915: i915_gem.c fix a kernel-doc issue Mauro Carvalho Chehab
2022-07-15 21:26 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 27/39] drm/i915: i915_scatterlist.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-15 21:33 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 28/39] drm/i915: i915_deps: use a shorter title markup Mauro Carvalho Chehab
2022-07-15 21:32 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 29/39] docs: gpu: i915.rst: display: add kernel-doc markups Mauro Carvalho Chehab
2022-08-09 9:57 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 30/39] docs: gpu: i915.rst: gt: add more " Mauro Carvalho Chehab
2022-08-09 10:01 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 19:35 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 31/39] docs: gpu: i915.rst: GuC: " Mauro Carvalho Chehab
2022-08-09 10:12 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 32/39] docs: gpu: i915.rst: GVT: " Mauro Carvalho Chehab
2022-08-09 9:56 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 33/39] docs: gpu: i915.rst: PM: " Mauro Carvalho Chehab
2022-08-09 10:03 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 34/39] docs: gpu: i915.rst: GEM/TTM: " Mauro Carvalho Chehab
2022-08-09 10:02 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 35/39] docs: gpu: i915.rst: add the remaining kernel-doc markup files Mauro Carvalho Chehab
2022-08-09 10:20 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 19:43 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 36/39] drm/i915 i915_gem_object_types.h: document struct i915_lut_handle Mauro Carvalho Chehab
2022-08-09 10:09 ` Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 37/39] drm/i915: document struct drm_i915_gem_object Mauro Carvalho Chehab
2022-08-09 10:08 ` [Intel-gfx] " Rodrigo Vivi
2022-07-13 8:12 ` [PATCH v2 38/39] drm/i915: add descriptions for some RPM macros at intel_gt_pm.h Mauro Carvalho Chehab
2022-08-09 10:12 ` [Intel-gfx] " Rodrigo Vivi
2022-09-06 19:47 ` Mauro Carvalho Chehab
2022-07-13 8:12 ` [PATCH v2 39/39] drm/i915: add GuC functions to the documentation Mauro Carvalho Chehab
2022-08-09 10:13 ` Rodrigo Vivi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6eca50ad78a54cadaf8e4deecec2309400c24164.1657699522.git.mchehab@kernel.org \
--to=mchehab@kernel.org \
--cc=John.C.Harrison@Intel.com \
--cc=airlied@linux.ie \
--cc=balasubramani.vivekanandan@intel.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=jordan.l.justen@intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lucas.demarchi@intel.com \
--cc=matthew.brost@intel.com \
--cc=rodrigo.vivi@intel.com \
--cc=tvrtko.ursulin@linux.intel.com \
--cc=umesh.nerlige.ramappa@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).