Some reported by Stephen Rothwell. The rest were found by running the kernel-doc build script. Some indentation fixes.
Unified · Split
| @@ -3,7 +3,7 @@ drm/imagination PowerVR Graphics Driver · 2 unmodified lines | ||
| 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 | ======== |
| @@ -45,9 +45,6 @@ DEV_QUERY · 44 unmodified lines | ||
| 45 | 45 | drm_pvr_heap |
| 46 | 46 | drm_pvr_dev_query_heap_info |
| 47 | 47 | |
| 48 | −.. kernel-doc:: include/uapi/drm/pvr_drm.h | |
| 49 | − :doc: Flags for DRM_PVR_DEV_QUERY_HEAP_INFO_GET. | |
| 50 | − | |
| 51 | 48 | .. kernel-doc:: include/uapi/drm/pvr_drm.h |
| 52 | 49 | :identifiers: drm_pvr_static_data_area_usage |
| 53 | 50 | drm_pvr_static_data_area |
| @@ -121,7 +118,7 @@ CREATE_FREE_LIST and DESTROY_FREE_LIST · 67 unmodified lines | ||
| 121 | 118 | :identifiers: drm_pvr_ioctl_destroy_free_list_args |
| 122 | 119 | |
| 123 | 120 | CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET |
| 124 | −-------------------------------------- | |
| 121 | +-------------------------------------------- | |
| 125 | 122 | .. kernel-doc:: include/uapi/drm/pvr_drm.h |
| 126 | 123 | :doc: PowerVR IOCTL CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET interfaces |
| 127 | 124 | |
| @@ -86,6 +86,7 @@ pvr_cccb_get_size_of_cmd_with_hdr(u32 cmd_size) · 85 unmodified lines | ||
| 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: |
| @@ -203,17 +203,29 @@ struct pvr_device { · 202 unmodified lines | ||
| 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; |
| @@ -225,8 +237,8 @@ struct pvr_device { · 5 unmodified lines | ||
| 225 | 237 | struct pvr_fw_object *rtn_obj; |
| 226 | 238 | |
| 227 | 239 | /** |
| 228 | − * @rtn: Pointer to CPU mapping of KCCB return slots. Must be accessed by | |
| 229 | − * READ_ONCE()/WRITE_ONCE(). | |
| 240 | + * @rtn: Pointer to CPU mapping of KCCB return slots. Must be | |
| 241 | + * accessed by READ_ONCE()/WRITE_ONCE(). | |
| 230 | 242 | */ |
| 231 | 243 | u32 *rtn; |
| 232 | 244 | |
| @@ -293,14 +305,13 @@ struct pvr_file { · 60 unmodified lines | ||
| 293 | 305 | |
| 294 | 306 | /** |
| 295 | 307 | * @pvr_dev: A reference to the powervr-specific wrapper for the |
| 296 | − * associated device. Saves on repeated calls to | |
| 297 | − * to_pvr_device(). | |
| 308 | + * associated device. Saves on repeated calls to to_pvr_device(). | |
| 298 | 309 | */ |
| 299 | 310 | struct pvr_device *pvr_dev; |
| 300 | 311 | |
| 301 | 312 | /** |
| 302 | 313 | * @ctx_handles: Array of contexts belonging to this file. Array members |
| 303 | − * are of type "struct pvr_context *". | |
| 314 | + * are of type "struct pvr_context *". | |
| 304 | 315 | * |
| 305 | 316 | * This array is used to allocate handles returned to userspace. |
| 306 | 317 | */ |
| @@ -481,7 +481,8 @@ pvr_fw_object_unmap_and_destroy(struct pvr_fw_object *fw_obj) · 480 unmodified lines | ||
| 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. |
| @@ -122,13 +122,13 @@ struct pvr_fw_layout_entry { · 121 unmodified lines | ||
| 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 | |
| @@ -64,6 +64,7 @@ struct pvr_hwrt_dataset { · 63 unmodified lines | ||
| 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. */ |
| @@ -378,7 +378,7 @@ prepare_job_syncs(struct pvr_file *pvr_file, · 377 unmodified lines | ||
| 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,8 +696,6 @@ pvr_jobs_link_geom_frag(struct pvr_job_data *job_data, u32 *job_count) · 311 unmodified lines | ||
| 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. |
| @@ -335,8 +335,9 @@ pvr_mmu_backing_page_fini(struct pvr_mmu_backing_page *page) · 334 unmodified lines | ||
| 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 | * |
| @@ -50,7 +50,7 @@ struct pvr_queue_cccb_fence_ctx { · 49 unmodified lines | ||
| 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,7 +114,7 @@ struct pvr_queue { · 57 unmodified lines | ||
| 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 |
| @@ -42,7 +42,7 @@ struct pvr_vm_context { · 41 unmodified lines | ||
| 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. */ |
| @@ -741,20 +741,18 @@ enum drm_pvr_ctx_priority { · 740 unmodified lines | ||
| 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 | }; |