History

drm/imagination: Numerous documentation fixes.

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

Donald Robson committed 2 years ago

Commit 3cc808e1 parent 325b71e12 files · +38 −30Browse files

Unified · Split

12 files
  1. Documentation/gpu/imagination/index.rst +1 −1
  2. Documentation/gpu/imagination/uapi.rst +1 −4
  3. drivers/gpu/drm/imagination/pvr_cccb.h +1 −0
  4. drivers/gpu/drm/imagination/pvr_device.h +18 −7
  5. drivers/gpu/drm/imagination/pvr_fw.h +2 −1
  6. drivers/gpu/drm/imagination/pvr_fw_info.h +4 −4
  7. drivers/gpu/drm/imagination/pvr_hwrt.h +1 −0
  8. drivers/gpu/drm/imagination/pvr_job.c +1 −3
  9. drivers/gpu/drm/imagination/pvr_mmu.c +2 −1
  10. drivers/gpu/drm/imagination/pvr_queue.h +2 −2
  11. drivers/gpu/drm/imagination/pvr_vm.c +1 −1
  12. include/uapi/drm/pvr_drm.h +4 −6
Documentation/gpu/imagination/index.rst+1−1
@@ -3,7 +3,7 @@ drm/imagination PowerVR Graphics Driver · 2 unmodified lines
33 =======================================
44
55 .. 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
77
88 Contents
99 ========
Documentation/gpu/imagination/uapi.rst+1−4
@@ -45,9 +45,6 @@ DEV_QUERY · 44 unmodified lines
4545 drm_pvr_heap
4646 drm_pvr_dev_query_heap_info
4747
48−.. kernel-doc:: include/uapi/drm/pvr_drm.h
49− :doc: Flags for DRM_PVR_DEV_QUERY_HEAP_INFO_GET.
50−
5148 .. kernel-doc:: include/uapi/drm/pvr_drm.h
5249 :identifiers: drm_pvr_static_data_area_usage
5350 drm_pvr_static_data_area
@@ -121,7 +118,7 @@ CREATE_FREE_LIST and DESTROY_FREE_LIST · 67 unmodified lines
121118 :identifiers: drm_pvr_ioctl_destroy_free_list_args
122119
123120 CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET
124−--------------------------------------
121+--------------------------------------------
125122 .. kernel-doc:: include/uapi/drm/pvr_drm.h
126123 :doc: PowerVR IOCTL CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET interfaces
127124
drivers/gpu/drm/imagination/pvr_cccb.h+1−0
@@ -86,6 +86,7 @@ pvr_cccb_get_size_of_cmd_with_hdr(u32 cmd_size) · 85 unmodified lines
8686
8787 /**
8888 * pvr_cccb_cmdseq_can_fit() - Check if a command sequence can fit in the CCCB.
89+ * @pvr_cccb: Target Client CCB.
8990 * @size: Command sequence size.
9091 *
9192 * Returns:
drivers/gpu/drm/imagination/pvr_device.h+18−7
@@ -203,17 +203,29 @@ struct pvr_device { · 202 unmodified lines
203203 struct mutex lock;
204204 } queues;
205205
206+ /**
207+ * @watchdog: Watchdog for communications with firmware.
208+ */
206209 struct {
207210 /** @work: Work item for watchdog callback. */
208211 struct delayed_work work;
209212
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+ */
211217 u32 old_kccb_cmds_executed;
212218
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+ */
214223 u32 kccb_stall_count;
215224 } watchdog;
216225
226+ /**
227+ * @kccb: Circular buffer for communications with firmware.
228+ */
217229 struct {
218230 /** @ccb: Kernel CCB. */
219231 struct pvr_ccb ccb;
@@ -225,8 +237,8 @@ struct pvr_device { · 5 unmodified lines
225237 struct pvr_fw_object *rtn_obj;
226238
227239 /**
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().
230242 */
231243 u32 *rtn;
232244
@@ -293,14 +305,13 @@ struct pvr_file { · 60 unmodified lines
293305
294306 /**
295307 * @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().
298309 */
299310 struct pvr_device *pvr_dev;
300311
301312 /**
302313 * @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 *".
304315 *
305316 * This array is used to allocate handles returned to userspace.
306317 */
drivers/gpu/drm/imagination/pvr_fw.h+2−1
@@ -481,7 +481,8 @@ pvr_fw_object_unmap_and_destroy(struct pvr_fw_object *fw_obj) · 480 unmodified lines
481481 }
482482
483483 /**
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.
485486 * @fw_obj: Pointer to object to lookup address in.
486487 * @offset: Offset within object to lookup address at.
487488 * @dma_addr_out: Pointer to location to store DMA address.
drivers/gpu/drm/imagination/pvr_fw_info.h+4−4
@@ -122,13 +122,13 @@ struct pvr_fw_layout_entry { · 121 unmodified lines
122122 * struct pvr_fw_device_info_header - Device information header.
123123 */
124124 struct pvr_fw_device_info_header {
125− /* BRN Mask size (in u64s). */
125+ /** @brn_mask_size: BRN mask size (in u64s). */
126126 u64 brn_mask_size;
127− /* ERN Mask size (in u64s). */
127+ /** @ern_mask_size: ERN mask size (in u64s). */
128128 u64 ern_mask_size;
129− /* Feature Mask size (in u64s). */
129+ /** @feature_mask_size: Feature mask size (in u64s). */
130130 u64 feature_mask_size;
131− /* Feature Parameter size (in u64s). */
131+ /** @feature_param_size: Feature parameter size (in u64s). */
132132 u64 feature_param_size;
133133 };
134134
drivers/gpu/drm/imagination/pvr_hwrt.h+1−0
@@ -64,6 +64,7 @@ struct pvr_hwrt_dataset { · 63 unmodified lines
6464 /** @common_fw_obj: FW object representing common FW-side structure. */
6565 struct pvr_fw_object *common_fw_obj;
6666
67+ /** @common: Common HWRT data. */
6768 struct rogue_fwif_hwrtdata_common common;
6869
6970 /** @data: HWRT data structures belonging to this set. */
drivers/gpu/drm/imagination/pvr_job.c+1−3
@@ -378,7 +378,7 @@ prepare_job_syncs(struct pvr_file *pvr_file, · 377 unmodified lines
378378
379379 /**
380380 * prepare_job_syncs_for_each() - Prepare all sync objects for an array of jobs.
381− * @file: PowerVR file.
381+ * @pvr_file: PowerVR file.
382382 * @job_data: Array of precreated jobs and their sync_ops.
383383 * @job_count: Number of jobs.
384384 * @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
696696 * @pvr_dev: Target PowerVR device.
697697 * @pvr_file: Pointer to PowerVR file structure.
698698 * @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.
701699 *
702700 * This initial implementation is entirely synchronous; on return the GPU will
703701 * be idle. This will not be the case for future implementations.
drivers/gpu/drm/imagination/pvr_mmu.c+2−1
@@ -335,8 +335,9 @@ pvr_mmu_backing_page_fini(struct pvr_mmu_backing_page *page) · 334 unmodified lines
335335
336336 /**
337337 * pvr_mmu_backing_page_sync() - Flush a MMU backing page from the CPU to the
338− * device.
338+ * device.
339339 * @page: Target backing page.
340+ * @flags: MMU flush flags. Must be one of %PVR_MMU_SYNC_LEVEL_*_FLAGS.
340341 *
341342 * .. caution::
342343 *
drivers/gpu/drm/imagination/pvr_queue.h+2−2
@@ -50,7 +50,7 @@ struct pvr_queue_cccb_fence_ctx { · 49 unmodified lines
5050 */
5151 struct pvr_job *job;
5252
53− /** @lock: Lock protecting access to the job object. */
53+ /** @job_lock: Lock protecting access to the job object. */
5454 struct mutex job_lock;
5555 };
5656
@@ -114,7 +114,7 @@ struct pvr_queue { · 57 unmodified lines
114114 } timeline_ufo;
115115
116116 /**
117− * last_queued_job_scheduled_fence: The scheduled fence of the last
117+ * @last_queued_job_scheduled_fence: The scheduled fence of the last
118118 * job queued to this queue.
119119 *
120120 * We use it to insert frag -> geom dependencies when issuing combined
drivers/gpu/drm/imagination/pvr_vm.c+1−1
@@ -42,7 +42,7 @@ struct pvr_vm_context { · 41 unmodified lines
4242 /** @mmu_ctx: The context for binding to physical memory. */
4343 struct pvr_mmu_context *mmu_ctx;
4444
45− /** @gpuva_mgr: GPUVA manager object associated with this context. */
45+ /** @gpuvm_mgr: GPUVM object associated with this context. */
4646 struct drm_gpuvm gpuvm_mgr;
4747
4848 /** @lock: Global lock on this VM. */
include/uapi/drm/pvr_drm.h+4−6
@@ -741,20 +741,18 @@ enum drm_pvr_ctx_priority { · 740 unmodified lines
741741 */
742742 enum drm_pvr_ctx_type {
743743 /**
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.
746745 */
747746 DRM_PVR_CTX_TYPE_RENDER = 0,
748747
749748 /**
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.
752750 */
753751 DRM_PVR_CTX_TYPE_COMPUTE,
754752
755753 /**
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.
758756 */
759757 DRM_PVR_CTX_TYPE_TRANSFER_FRAG,
760758 };

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t