[PATCH v2 2/3] drm/i915/gvt: Fix function comment doc errors

Yuan, Hang hang.yuan at intel.com
Thu Aug 2 05:34:12 UTC 2018


Reviewed-by: Hang Yuan <hang.yuan at intel.com>

> -----Original Message-----
> From: intel-gvt-dev [mailto:intel-gvt-dev-bounces at lists.freedesktop.org] On
> Behalf Of Zhenyu Wang
> Sent: Tuesday, July 31, 2018 11:02 AM
> To: intel-gvt-dev at lists.freedesktop.org
> Subject: [PATCH v2 2/3] drm/i915/gvt: Fix function comment doc errors
> 
> Caught by W=1 to fix left wrong function comment doc.
> 
> Signed-off-by: Zhenyu Wang <zhenyuw at linux.intel.com>
> ---
>  drivers/gpu/drm/i915/gvt/cfg_space.c  | 12 ++++++++++++
>  drivers/gpu/drm/i915/gvt/display.c    |  1 +
>  drivers/gpu/drm/i915/gvt/edid.c       |  9 +++++++++
>  drivers/gpu/drm/i915/gvt/gtt.c        |  9 ++++++---
>  drivers/gpu/drm/i915/gvt/gvt.c        |  3 +--
>  drivers/gpu/drm/i915/gvt/handlers.c   |  1 +
>  drivers/gpu/drm/i915/gvt/mmio.c       |  3 ++-
>  drivers/gpu/drm/i915/gvt/opregion.c   |  1 -
>  drivers/gpu/drm/i915/gvt/page_track.c |  2 ++
> drivers/gpu/drm/i915/gvt/scheduler.c  |  4 +++-
>  10 files changed, 37 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i915/gvt/cfg_space.c
> b/drivers/gpu/drm/i915/gvt/cfg_space.c
> index c62346fdc05d..19cf1bbe059d 100644
> --- a/drivers/gpu/drm/i915/gvt/cfg_space.c
> +++ b/drivers/gpu/drm/i915/gvt/cfg_space.c
> @@ -56,6 +56,10 @@ static const u8
> pci_cfg_space_rw_bmp[PCI_INTERRUPT_LINE + 4] = {
> 
>  /**
>   * vgpu_pci_cfg_mem_write - write virtual cfg space memory
> + * @vgpu: target vgpu
> + * @off: offset
> + * @src: src ptr to write
> + * @bytes: number of bytes
>   *
>   * Use this function to write virtual cfg space memory.
>   * For standard cfg space, only RW bits can be changed, @@ -91,6 +95,10
> @@ static void vgpu_pci_cfg_mem_write(struct intel_vgpu *vgpu, unsigned
> int off,
> 
>  /**
>   * intel_vgpu_emulate_cfg_read - emulate vGPU configuration space read
> + * @vgpu: target vgpu
> + * @offset: offset
> + * @p_data: return data ptr
> + * @bytes: number of bytes to read
>   *
>   * Returns:
>   * Zero on success, negative error code if failed.
> @@ -278,6 +286,10 @@ static int emulate_pci_bar_write(struct intel_vgpu
> *vgpu, unsigned int offset,
> 
>  /**
>   * intel_vgpu_emulate_cfg_read - emulate vGPU configuration space write
> + * @vgpu: target vgpu
> + * @offset: offset
> + * @p_data: write data ptr
> + * @bytes: number of bytes to write
>   *
>   * Returns:
>   * Zero on success, negative error code if failed.
> diff --git a/drivers/gpu/drm/i915/gvt/display.c
> b/drivers/gpu/drm/i915/gvt/display.c
> index 6ee50cb328f8..379fc81da863 100644
> --- a/drivers/gpu/drm/i915/gvt/display.c
> +++ b/drivers/gpu/drm/i915/gvt/display.c
> @@ -462,6 +462,7 @@ void intel_vgpu_clean_display(struct intel_vgpu
> *vgpu)
>  /**
>   * intel_vgpu_init_display- initialize vGPU virtual display emulation
>   * @vgpu: a vGPU
> + * @resolution: resolution index for intel_vgpu_edid
>   *
>   * This function is used to initialize vGPU virtual display emulation stuffs
>   *
> diff --git a/drivers/gpu/drm/i915/gvt/edid.c
> b/drivers/gpu/drm/i915/gvt/edid.c index 4b98539025c5..5d4bb35bb889
> 100644
> --- a/drivers/gpu/drm/i915/gvt/edid.c
> +++ b/drivers/gpu/drm/i915/gvt/edid.c
> @@ -340,6 +340,9 @@ static int gmbus2_mmio_write(struct intel_vgpu
> *vgpu, unsigned int offset,
>  /**
>   * intel_gvt_i2c_handle_gmbus_read - emulate gmbus register mmio read
>   * @vgpu: a vGPU
> + * @offset: reg offset
> + * @p_data: data return buffer
> + * @bytes: access data length
>   *
>   * This function is used to emulate gmbus register mmio read
>   *
> @@ -365,6 +368,9 @@ int intel_gvt_i2c_handle_gmbus_read(struct
> intel_vgpu *vgpu,
>  /**
>   * intel_gvt_i2c_handle_gmbus_write - emulate gmbus register mmio write
>   * @vgpu: a vGPU
> + * @offset: reg offset
> + * @p_data: data return buffer
> + * @bytes: access data length
>   *
>   * This function is used to emulate gmbus register mmio write
>   *
> @@ -437,6 +443,9 @@ static inline int get_aux_ch_reg(unsigned int offset)
>  /**
>   * intel_gvt_i2c_handle_aux_ch_write - emulate AUX channel register write
>   * @vgpu: a vGPU
> + * @port_idx: port index
> + * @offset: reg offset
> + * @p_data: write ptr
>   *
>   * This function is used to emulate AUX channel register write
>   *
> diff --git a/drivers/gpu/drm/i915/gvt/gtt.c b/drivers/gpu/drm/i915/gvt/gtt.c
> index 156ceeeb7446..f1a4cb1b8438 100644
> --- a/drivers/gpu/drm/i915/gvt/gtt.c
> +++ b/drivers/gpu/drm/i915/gvt/gtt.c
> @@ -1113,6 +1113,10 @@ static inline void
> ppgtt_generate_shadow_entry(struct intel_gvt_gtt_entry *se,  }
> 
>  /**
> + * Check if can do 2M page
> + * @vgpu: target vgpu
> + * @entry: target pfn's gtt entry
> + *
>   * Return 1 if 2MB huge gtt shadowing is possilbe, 0 if miscondition,
>   * negtive if found err.
>   */
> @@ -1942,7 +1946,7 @@ void intel_vgpu_unpin_mm(struct intel_vgpu_mm
> *mm)
> 
>  /**
>   * intel_vgpu_pin_mm - increase the pin count of a vGPU mm object
> - * @vgpu: a vGPU
> + * @mm: target vgpu mm
>   *
>   * This function is called when user wants to use a vGPU mm object. If this
>   * mm object hasn't been shadowed yet, the shadow will be populated at
> this @@ -2462,8 +2466,7 @@ static int setup_spt_oos(struct intel_gvt *gvt)
>  /**
>   * intel_vgpu_find_ppgtt_mm - find a PPGTT mm object
>   * @vgpu: a vGPU
> - * @page_table_level: PPGTT page table level
> - * @root_entry: PPGTT page table root pointers
> + * @pdps: pdp root array
>   *
>   * This function is used to find a PPGTT mm object from mm object pool
>   *
> diff --git a/drivers/gpu/drm/i915/gvt/gvt.c b/drivers/gpu/drm/i915/gvt/gvt.c
> index 712f9d14e720..e14416d97e73 100644
> --- a/drivers/gpu/drm/i915/gvt/gvt.c
> +++ b/drivers/gpu/drm/i915/gvt/gvt.c
> @@ -188,7 +188,6 @@ static const struct intel_gvt_ops intel_gvt_ops = {
> 
>  /**
>   * intel_gvt_init_host - Load MPT modules and detect if we're running in
> host
> - * @gvt: intel gvt device
>   *
>   * This function is called at the driver loading stage. If failed to find a
>   * loadable MPT module or detect currently we're running in a VM, then
> GVT-g @@ -302,7 +301,7 @@ static int init_service_thread(struct intel_gvt
> *gvt)
> 
>  /**
>   * intel_gvt_clean_device - clean a GVT device
> - * @gvt: intel gvt device
> + * @dev_priv: i915 private
>   *
>   * This function is called at the driver unloading stage, to free the
>   * resources owned by a GVT device.
> diff --git a/drivers/gpu/drm/i915/gvt/handlers.c
> b/drivers/gpu/drm/i915/gvt/handlers.c
> index e2e252c67de8..131b37b038f0 100644
> --- a/drivers/gpu/drm/i915/gvt/handlers.c
> +++ b/drivers/gpu/drm/i915/gvt/handlers.c
> @@ -3405,6 +3405,7 @@ bool intel_gvt_in_force_nonpriv_whitelist(struct
> intel_gvt *gvt,
>   * @offset: register offset
>   * @pdata: data buffer
>   * @bytes: data length
> + * @is_read: read or write
>   *
>   * Returns:
>   * Zero on success, negative error code if failed.
> diff --git a/drivers/gpu/drm/i915/gvt/mmio.c
> b/drivers/gpu/drm/i915/gvt/mmio.c index 2be1be2cf49a..dcd31e3781df
> 100644
> --- a/drivers/gpu/drm/i915/gvt/mmio.c
> +++ b/drivers/gpu/drm/i915/gvt/mmio.c
> @@ -39,6 +39,7 @@
>  /**
>   * intel_vgpu_gpa_to_mmio_offset - translate a GPA to MMIO offset
>   * @vgpu: a vGPU
> + * @gpa: guest physical address
>   *
>   * Returns:
>   * Zero on success, negative error code if failed @@ -228,7 +229,7 @@ int
> intel_vgpu_emulate_mmio_write(struct intel_vgpu *vgpu, uint64_t pa,
>  /**
>   * intel_vgpu_reset_mmio - reset virtual MMIO space
>   * @vgpu: a vGPU
> - *
> + * @dmlr: whether this is device model level reset
>   */
>  void intel_vgpu_reset_mmio(struct intel_vgpu *vgpu, bool dmlr)  { diff --git
> a/drivers/gpu/drm/i915/gvt/opregion.c
> b/drivers/gpu/drm/i915/gvt/opregion.c
> index fa75a2eead90..82586c8e434f 100644
> --- a/drivers/gpu/drm/i915/gvt/opregion.c
> +++ b/drivers/gpu/drm/i915/gvt/opregion.c
> @@ -216,7 +216,6 @@ static void virt_vbt_generation(struct vbt *v)
>  /**
>   * intel_vgpu_init_opregion - initialize the stuff used to emulate opregion
>   * @vgpu: a vGPU
> - * @gpa: guest physical address of opregion
>   *
>   * Returns:
>   * Zero on success, negative error code if failed.
> diff --git a/drivers/gpu/drm/i915/gvt/page_track.c
> b/drivers/gpu/drm/i915/gvt/page_track.c
> index 256d0db8bbb1..84856022528e 100644
> --- a/drivers/gpu/drm/i915/gvt/page_track.c
> +++ b/drivers/gpu/drm/i915/gvt/page_track.c
> @@ -41,6 +41,8 @@ struct intel_vgpu_page_track
> *intel_vgpu_find_page_track(
>   * intel_vgpu_register_page_track - register a guest page to be tacked
>   * @vgpu: a vGPU
>   * @gfn: the gfn of guest page
> + * @handler: page track handler
> + * @priv: tracker private
>   *
>   * Returns:
>   * zero on success, negative error code if failed.
> diff --git a/drivers/gpu/drm/i915/gvt/scheduler.c
> b/drivers/gpu/drm/i915/gvt/scheduler.c
> index 928818f218f7..b42631f91771 100644
> --- a/drivers/gpu/drm/i915/gvt/scheduler.c
> +++ b/drivers/gpu/drm/i915/gvt/scheduler.c
> @@ -1133,6 +1133,7 @@ int intel_vgpu_setup_submission(struct intel_vgpu
> *vgpu)
>  /**
>   * intel_vgpu_select_submission_ops - select virtual submission interface
>   * @vgpu: a vGPU
> + * @engine_mask: either ALL_ENGINES or target engine mask
>   * @interface: expected vGPU virtual submission interface
>   *
>   * This function is called when guest configures submission interface.
> @@ -1185,7 +1186,7 @@ int intel_vgpu_select_submission_ops(struct
> intel_vgpu *vgpu,
> 
>  /**
>   * intel_vgpu_destroy_workload - destroy a vGPU workload
> - * @vgpu: a vGPU
> + * @workload: workload to destroy
>   *
>   * This function is called when destroy a vGPU workload.
>   *
> @@ -1277,6 +1278,7 @@ static int prepare_mm(struct intel_vgpu_workload
> *workload)
>  /**
>   * intel_vgpu_create_workload - create a vGPU workload
>   * @vgpu: a vGPU
> + * @ring_id: ring index
>   * @desc: a guest context descriptor
>   *
>   * This function is called when creating a vGPU workload.
> --
> 2.18.0
> 
> _______________________________________________
> intel-gvt-dev mailing list
> intel-gvt-dev at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gvt-dev


More information about the intel-gvt-dev mailing list