Commit a752b070 authored by Zhenyu Wang's avatar Zhenyu Wang

drm/i915/gvt: Fix function comment doc errors

Caught by W=1 to fix left wrong function comment doc.
Reviewed-by: default avatarHang Yuan <hang.yuan@intel.com>
Signed-off-by: default avatarZhenyu Wang <zhenyuw@linux.intel.com>
parent 63ef2623
...@@ -56,6 +56,10 @@ static const u8 pci_cfg_space_rw_bmp[PCI_INTERRUPT_LINE + 4] = { ...@@ -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_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. * Use this function to write virtual cfg space memory.
* For standard cfg space, only RW bits can be changed, * 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, ...@@ -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 * 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: * Returns:
* Zero on success, negative error code if failed. * 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, ...@@ -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 * 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: * Returns:
* Zero on success, negative error code if failed. * Zero on success, negative error code if failed.
......
...@@ -462,6 +462,7 @@ void intel_vgpu_clean_display(struct intel_vgpu *vgpu) ...@@ -462,6 +462,7 @@ void intel_vgpu_clean_display(struct intel_vgpu *vgpu)
/** /**
* intel_vgpu_init_display- initialize vGPU virtual display emulation * intel_vgpu_init_display- initialize vGPU virtual display emulation
* @vgpu: a vGPU * @vgpu: a vGPU
* @resolution: resolution index for intel_vgpu_edid
* *
* This function is used to initialize vGPU virtual display emulation stuffs * This function is used to initialize vGPU virtual display emulation stuffs
* *
......
...@@ -340,6 +340,9 @@ static int gmbus2_mmio_write(struct intel_vgpu *vgpu, unsigned int offset, ...@@ -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 * intel_gvt_i2c_handle_gmbus_read - emulate gmbus register mmio read
* @vgpu: a vGPU * @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 * 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, ...@@ -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 * intel_gvt_i2c_handle_gmbus_write - emulate gmbus register mmio write
* @vgpu: a vGPU * @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 * This function is used to emulate gmbus register mmio write
* *
...@@ -437,6 +443,9 @@ static inline int get_aux_ch_reg(unsigned int offset) ...@@ -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 * intel_gvt_i2c_handle_aux_ch_write - emulate AUX channel register write
* @vgpu: a vGPU * @vgpu: a vGPU
* @port_idx: port index
* @offset: reg offset
* @p_data: write ptr
* *
* This function is used to emulate AUX channel register write * This function is used to emulate AUX channel register write
* *
......
...@@ -1113,6 +1113,10 @@ static inline void ppgtt_generate_shadow_entry(struct intel_gvt_gtt_entry *se, ...@@ -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, * Return 1 if 2MB huge gtt shadowing is possilbe, 0 if miscondition,
* negtive if found err. * negtive if found err.
*/ */
...@@ -1942,7 +1946,7 @@ void intel_vgpu_unpin_mm(struct intel_vgpu_mm *mm) ...@@ -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 * 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 * 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 * 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) ...@@ -2462,8 +2466,7 @@ static int setup_spt_oos(struct intel_gvt *gvt)
/** /**
* intel_vgpu_find_ppgtt_mm - find a PPGTT mm object * intel_vgpu_find_ppgtt_mm - find a PPGTT mm object
* @vgpu: a vGPU * @vgpu: a vGPU
* @page_table_level: PPGTT page table level * @pdps: pdp root array
* @root_entry: PPGTT page table root pointers
* *
* This function is used to find a PPGTT mm object from mm object pool * This function is used to find a PPGTT mm object from mm object pool
* *
......
...@@ -188,7 +188,6 @@ static const struct intel_gvt_ops intel_gvt_ops = { ...@@ -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 * 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 * 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 * 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) ...@@ -302,7 +301,7 @@ static int init_service_thread(struct intel_gvt *gvt)
/** /**
* intel_gvt_clean_device - clean a GVT device * 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 * This function is called at the driver unloading stage, to free the
* resources owned by a GVT device. * resources owned by a GVT device.
......
...@@ -3405,6 +3405,7 @@ bool intel_gvt_in_force_nonpriv_whitelist(struct intel_gvt *gvt, ...@@ -3405,6 +3405,7 @@ bool intel_gvt_in_force_nonpriv_whitelist(struct intel_gvt *gvt,
* @offset: register offset * @offset: register offset
* @pdata: data buffer * @pdata: data buffer
* @bytes: data length * @bytes: data length
* @is_read: read or write
* *
* Returns: * Returns:
* Zero on success, negative error code if failed. * Zero on success, negative error code if failed.
......
...@@ -39,6 +39,7 @@ ...@@ -39,6 +39,7 @@
/** /**
* intel_vgpu_gpa_to_mmio_offset - translate a GPA to MMIO offset * intel_vgpu_gpa_to_mmio_offset - translate a GPA to MMIO offset
* @vgpu: a vGPU * @vgpu: a vGPU
* @gpa: guest physical address
* *
* Returns: * Returns:
* Zero on success, negative error code if failed * 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, ...@@ -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 * intel_vgpu_reset_mmio - reset virtual MMIO space
* @vgpu: a vGPU * @vgpu: a vGPU
* * @dmlr: whether this is device model level reset
*/ */
void intel_vgpu_reset_mmio(struct intel_vgpu *vgpu, bool dmlr) void intel_vgpu_reset_mmio(struct intel_vgpu *vgpu, bool dmlr)
{ {
......
...@@ -216,7 +216,6 @@ static void virt_vbt_generation(struct vbt *v) ...@@ -216,7 +216,6 @@ static void virt_vbt_generation(struct vbt *v)
/** /**
* intel_vgpu_init_opregion - initialize the stuff used to emulate opregion * intel_vgpu_init_opregion - initialize the stuff used to emulate opregion
* @vgpu: a vGPU * @vgpu: a vGPU
* @gpa: guest physical address of opregion
* *
* Returns: * Returns:
* Zero on success, negative error code if failed. * Zero on success, negative error code if failed.
......
...@@ -41,6 +41,8 @@ struct intel_vgpu_page_track *intel_vgpu_find_page_track( ...@@ -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 * intel_vgpu_register_page_track - register a guest page to be tacked
* @vgpu: a vGPU * @vgpu: a vGPU
* @gfn: the gfn of guest page * @gfn: the gfn of guest page
* @handler: page track handler
* @priv: tracker private
* *
* Returns: * Returns:
* zero on success, negative error code if failed. * zero on success, negative error code if failed.
......
...@@ -1135,6 +1135,7 @@ int intel_vgpu_setup_submission(struct intel_vgpu *vgpu) ...@@ -1135,6 +1135,7 @@ int intel_vgpu_setup_submission(struct intel_vgpu *vgpu)
/** /**
* intel_vgpu_select_submission_ops - select virtual submission interface * intel_vgpu_select_submission_ops - select virtual submission interface
* @vgpu: a vGPU * @vgpu: a vGPU
* @engine_mask: either ALL_ENGINES or target engine mask
* @interface: expected vGPU virtual submission interface * @interface: expected vGPU virtual submission interface
* *
* This function is called when guest configures submission interface. * This function is called when guest configures submission interface.
...@@ -1187,7 +1188,7 @@ int intel_vgpu_select_submission_ops(struct intel_vgpu *vgpu, ...@@ -1187,7 +1188,7 @@ int intel_vgpu_select_submission_ops(struct intel_vgpu *vgpu,
/** /**
* intel_vgpu_destroy_workload - destroy a vGPU workload * intel_vgpu_destroy_workload - destroy a vGPU workload
* @vgpu: a vGPU * @workload: workload to destroy
* *
* This function is called when destroy a vGPU workload. * This function is called when destroy a vGPU workload.
* *
...@@ -1279,6 +1280,7 @@ static int prepare_mm(struct intel_vgpu_workload *workload) ...@@ -1279,6 +1280,7 @@ static int prepare_mm(struct intel_vgpu_workload *workload)
/** /**
* intel_vgpu_create_workload - create a vGPU workload * intel_vgpu_create_workload - create a vGPU workload
* @vgpu: a vGPU * @vgpu: a vGPU
* @ring_id: ring index
* @desc: a guest context descriptor * @desc: a guest context descriptor
* *
* This function is called when creating a vGPU workload. * This function is called when creating a vGPU workload.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment