Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

drm/imagination: Numerous documentation fixes.

Some reported by Stephen Rothwell. The rest were found by running the
kernel-doc build script.
Some indentation fixes.

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202311241526.Y2WZeUau-lkp@intel.com/
Signed-off-by: Donald Robson <donald.robson@imgtec.com>
Signed-off-by: Maxime Ripard <mripard@kernel.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20231128173507.95119-1-donald.robson@imgtec.com

authored by

Donald Robson and committed by
Maxime Ripard
3cc808e3 325b71e8

+38 -30
+1 -1
Documentation/gpu/imagination/index.rst
··· 3 3 ======================================= 4 4 5 5 .. kernel-doc:: drivers/gpu/drm/imagination/pvr_drv.c 6 - :doc: PowerVR Graphics Driver 6 + :doc: PowerVR (Series 6 and later) and IMG Graphics Driver 7 7 8 8 Contents 9 9 ========
+1 -4
Documentation/gpu/imagination/uapi.rst
··· 46 46 drm_pvr_dev_query_heap_info 47 47 48 48 .. kernel-doc:: include/uapi/drm/pvr_drm.h 49 - :doc: Flags for DRM_PVR_DEV_QUERY_HEAP_INFO_GET. 50 - 51 - .. kernel-doc:: include/uapi/drm/pvr_drm.h 52 49 :identifiers: drm_pvr_static_data_area_usage 53 50 drm_pvr_static_data_area 54 51 drm_pvr_dev_query_static_data_areas ··· 118 121 :identifiers: drm_pvr_ioctl_destroy_free_list_args 119 122 120 123 CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET 121 - -------------------------------------- 124 + -------------------------------------------- 122 125 .. kernel-doc:: include/uapi/drm/pvr_drm.h 123 126 :doc: PowerVR IOCTL CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET interfaces 124 127
+1
drivers/gpu/drm/imagination/pvr_cccb.h
··· 86 86 87 87 /** 88 88 * pvr_cccb_cmdseq_can_fit() - Check if a command sequence can fit in the CCCB. 89 + * @pvr_cccb: Target Client CCB. 89 90 * @size: Command sequence size. 90 91 * 91 92 * Returns:
+18 -7
drivers/gpu/drm/imagination/pvr_device.h
··· 203 203 struct mutex lock; 204 204 } queues; 205 205 206 + /** 207 + * @watchdog: Watchdog for communications with firmware. 208 + */ 206 209 struct { 207 210 /** @work: Work item for watchdog callback. */ 208 211 struct delayed_work work; 209 212 210 - /** @old_kccb_cmds_executed: KCCB command execution count at last watchdog poll. */ 213 + /** 214 + * @old_kccb_cmds_executed: KCCB command execution count at last 215 + * watchdog poll. 216 + */ 211 217 u32 old_kccb_cmds_executed; 212 218 213 - /** @kccb_stall_count: Number of watchdog polls KCCB has been stalled for. */ 219 + /** 220 + * @kccb_stall_count: Number of watchdog polls KCCB has been 221 + * stalled for. 222 + */ 214 223 u32 kccb_stall_count; 215 224 } watchdog; 216 225 226 + /** 227 + * @kccb: Circular buffer for communications with firmware. 228 + */ 217 229 struct { 218 230 /** @ccb: Kernel CCB. */ 219 231 struct pvr_ccb ccb; ··· 237 225 struct pvr_fw_object *rtn_obj; 238 226 239 227 /** 240 - * @rtn: Pointer to CPU mapping of KCCB return slots. Must be accessed by 241 - * READ_ONCE()/WRITE_ONCE(). 228 + * @rtn: Pointer to CPU mapping of KCCB return slots. Must be 229 + * accessed by READ_ONCE()/WRITE_ONCE(). 242 230 */ 243 231 u32 *rtn; 244 232 ··· 305 293 306 294 /** 307 295 * @pvr_dev: A reference to the powervr-specific wrapper for the 308 - * associated device. Saves on repeated calls to 309 - * to_pvr_device(). 296 + * associated device. Saves on repeated calls to to_pvr_device(). 310 297 */ 311 298 struct pvr_device *pvr_dev; 312 299 313 300 /** 314 301 * @ctx_handles: Array of contexts belonging to this file. Array members 315 - * are of type "struct pvr_context *". 302 + * are of type "struct pvr_context *". 316 303 * 317 304 * This array is used to allocate handles returned to userspace. 318 305 */
+2 -1
drivers/gpu/drm/imagination/pvr_fw.h
··· 481 481 } 482 482 483 483 /** 484 - * pvr_fw_get_dma_addr() - Get DMA address for given offset in firmware object 484 + * pvr_fw_object_get_dma_addr() - Get DMA address for given offset in firmware 485 + * object. 485 486 * @fw_obj: Pointer to object to lookup address in. 486 487 * @offset: Offset within object to lookup address at. 487 488 * @dma_addr_out: Pointer to location to store DMA address.
+4 -4
drivers/gpu/drm/imagination/pvr_fw_info.h
··· 122 122 * struct pvr_fw_device_info_header - Device information header. 123 123 */ 124 124 struct pvr_fw_device_info_header { 125 - /* BRN Mask size (in u64s). */ 125 + /** @brn_mask_size: BRN mask size (in u64s). */ 126 126 u64 brn_mask_size; 127 - /* ERN Mask size (in u64s). */ 127 + /** @ern_mask_size: ERN mask size (in u64s). */ 128 128 u64 ern_mask_size; 129 - /* Feature Mask size (in u64s). */ 129 + /** @feature_mask_size: Feature mask size (in u64s). */ 130 130 u64 feature_mask_size; 131 - /* Feature Parameter size (in u64s). */ 131 + /** @feature_param_size: Feature parameter size (in u64s). */ 132 132 u64 feature_param_size; 133 133 }; 134 134
+1
drivers/gpu/drm/imagination/pvr_hwrt.h
··· 64 64 /** @common_fw_obj: FW object representing common FW-side structure. */ 65 65 struct pvr_fw_object *common_fw_obj; 66 66 67 + /** @common: Common HWRT data. */ 67 68 struct rogue_fwif_hwrtdata_common common; 68 69 69 70 /** @data: HWRT data structures belonging to this set. */
+1 -3
drivers/gpu/drm/imagination/pvr_job.c
··· 378 378 379 379 /** 380 380 * prepare_job_syncs_for_each() - Prepare all sync objects for an array of jobs. 381 - * @file: PowerVR file. 381 + * @pvr_file: PowerVR file. 382 382 * @job_data: Array of precreated jobs and their sync_ops. 383 383 * @job_count: Number of jobs. 384 384 * @signal_array: xarray to receive signal sync objects. ··· 696 696 * @pvr_dev: Target PowerVR device. 697 697 * @pvr_file: Pointer to PowerVR file structure. 698 698 * @args: Ioctl args. 699 - * @job_count: Number of jobs in @jobs_args. On error this will be updated 700 - * with the index into @jobs_args where the error occurred. 701 699 * 702 700 * This initial implementation is entirely synchronous; on return the GPU will 703 701 * be idle. This will not be the case for future implementations.
+2 -1
drivers/gpu/drm/imagination/pvr_mmu.c
··· 335 335 336 336 /** 337 337 * pvr_mmu_backing_page_sync() - Flush a MMU backing page from the CPU to the 338 - * device. 338 + * device. 339 339 * @page: Target backing page. 340 + * @flags: MMU flush flags. Must be one of %PVR_MMU_SYNC_LEVEL_*_FLAGS. 340 341 * 341 342 * .. caution:: 342 343 *
+2 -2
drivers/gpu/drm/imagination/pvr_queue.h
··· 50 50 */ 51 51 struct pvr_job *job; 52 52 53 - /** @lock: Lock protecting access to the job object. */ 53 + /** @job_lock: Lock protecting access to the job object. */ 54 54 struct mutex job_lock; 55 55 }; 56 56 ··· 114 114 } timeline_ufo; 115 115 116 116 /** 117 - * last_queued_job_scheduled_fence: The scheduled fence of the last 117 + * @last_queued_job_scheduled_fence: The scheduled fence of the last 118 118 * job queued to this queue. 119 119 * 120 120 * We use it to insert frag -> geom dependencies when issuing combined
+1 -1
drivers/gpu/drm/imagination/pvr_vm.c
··· 42 42 /** @mmu_ctx: The context for binding to physical memory. */ 43 43 struct pvr_mmu_context *mmu_ctx; 44 44 45 - /** @gpuva_mgr: GPUVA manager object associated with this context. */ 45 + /** @gpuvm_mgr: GPUVM object associated with this context. */ 46 46 struct drm_gpuvm gpuvm_mgr; 47 47 48 48 /** @lock: Global lock on this VM. */
+4 -6
include/uapi/drm/pvr_drm.h
··· 741 741 */ 742 742 enum drm_pvr_ctx_type { 743 743 /** 744 - * @DRM_PVR_CTX_TYPE_RENDER: Render context. Use &struct 745 - * drm_pvr_ioctl_create_render_context_args for context creation arguments. 744 + * @DRM_PVR_CTX_TYPE_RENDER: Render context. 746 745 */ 747 746 DRM_PVR_CTX_TYPE_RENDER = 0, 748 747 749 748 /** 750 - * @DRM_PVR_CTX_TYPE_COMPUTE: Compute context. Use &struct 751 - * drm_pvr_ioctl_create_compute_context_args for context creation arguments. 749 + * @DRM_PVR_CTX_TYPE_COMPUTE: Compute context. 752 750 */ 753 751 DRM_PVR_CTX_TYPE_COMPUTE, 754 752 755 753 /** 756 - * @DRM_PVR_CTX_TYPE_TRANSFER_FRAG: Transfer context for fragment data masters. Use 757 - * &struct drm_pvr_ioctl_create_transfer_context_args for context creation arguments. 754 + * @DRM_PVR_CTX_TYPE_TRANSFER_FRAG: Transfer context for fragment data 755 + * master. 758 756 */ 759 757 DRM_PVR_CTX_TYPE_TRANSFER_FRAG, 760 758 };