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

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