Unverified Commit 3cc808e3 authored by Donald Robson's avatar Donald Robson Committed by Maxime Ripard
Browse files

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: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202311241526.Y2WZeUau-lkp@intel.com/


Signed-off-by: default avatarDonald Robson <donald.robson@imgtec.com>
Signed-off-by: default avatarMaxime Ripard <mripard@kernel.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20231128173507.95119-1-donald.robson@imgtec.com
parent 325b71e8

Documentation/gpu/imagination/index.rst

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ drm/imagination PowerVR Graphics Driver 
=======================================



.. kernel-doc:: drivers/gpu/drm/imagination/pvr_drv.c

   :doc: PowerVR Graphics Driver

   :doc: PowerVR (Series 6 and later) and IMG Graphics Driver



Contents

========

Documentation/gpu/imagination/uapi.rst

+1 −4
Original line number Diff line number Diff line
@@ -45,9 +45,6 @@ DEV_QUERY 
                 drm_pvr_heap

                 drm_pvr_dev_query_heap_info



.. kernel-doc:: include/uapi/drm/pvr_drm.h

   :doc: Flags for DRM_PVR_DEV_QUERY_HEAP_INFO_GET.



.. kernel-doc:: include/uapi/drm/pvr_drm.h

   :identifiers: drm_pvr_static_data_area_usage

                 drm_pvr_static_data_area
@@ -121,7 +118,7 @@ CREATE_FREE_LIST and DESTROY_FREE_LIST 
   :identifiers: drm_pvr_ioctl_destroy_free_list_args



CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET

--------------------------------------

--------------------------------------------

.. kernel-doc:: include/uapi/drm/pvr_drm.h

   :doc: PowerVR IOCTL CREATE_HWRT_DATASET and DESTROY_HWRT_DATASET interfaces

drivers/gpu/drm/imagination/pvr_cccb.h

+1 −0
Original line number Diff line number Diff line
@@ -86,6 +86,7 @@ pvr_cccb_get_size_of_cmd_with_hdr(u32 cmd_size) 


/**

 * pvr_cccb_cmdseq_can_fit() - Check if a command sequence can fit in the CCCB.

 * @pvr_cccb: Target Client CCB.

 * @size: Command sequence size.

 *

 * Returns:

drivers/gpu/drm/imagination/pvr_device.h

+18 −7
Original line number Diff line number Diff line
@@ -203,17 +203,29 @@ struct pvr_device { 
		struct mutex lock;

	} queues;



	/**

	 * @watchdog: Watchdog for communications with firmware.

	 */

	struct {

		/** @work: Work item for watchdog callback. */

		struct delayed_work work;



		/** @old_kccb_cmds_executed: KCCB command execution count at last watchdog poll. */

		/**

		 * @old_kccb_cmds_executed: KCCB command execution count at last

		 * watchdog poll.

		 */

		u32 old_kccb_cmds_executed;



		/** @kccb_stall_count: Number of watchdog polls KCCB has been stalled for. */

		/**

		 * @kccb_stall_count: Number of watchdog polls KCCB has been

		 * stalled for.

		 */

		u32 kccb_stall_count;

	} watchdog;



	/**

	 * @kccb: Circular buffer for communications with firmware.

	 */

	struct {

		/** @ccb: Kernel CCB. */

		struct pvr_ccb ccb;
@@ -225,8 +237,8 @@ struct pvr_device { 
		struct pvr_fw_object *rtn_obj;



		/**

		 * @rtn: Pointer to CPU mapping of KCCB return slots. Must be accessed by

		 *       READ_ONCE()/WRITE_ONCE().

		 * @rtn: Pointer to CPU mapping of KCCB return slots. Must be

		 * accessed by READ_ONCE()/WRITE_ONCE().

		 */

		u32 *rtn;
@@ -293,8 +305,7 @@ struct pvr_file { 


	/**

	 * @pvr_dev: A reference to the powervr-specific wrapper for the

	 *           associated device. Saves on repeated calls to

	 *           to_pvr_device().

	 * associated device. Saves on repeated calls to to_pvr_device().

	 */

	struct pvr_device *pvr_dev;

drivers/gpu/drm/imagination/pvr_fw.h

+2 −1
Original line number Diff line number Diff line
@@ -481,7 +481,8 @@ pvr_fw_object_unmap_and_destroy(struct pvr_fw_object *fw_obj) 
}



/**

 * pvr_fw_get_dma_addr() - Get DMA address for given offset in firmware object

 * pvr_fw_object_get_dma_addr() - Get DMA address for given offset in firmware

 * object.

 * @fw_obj: Pointer to object to lookup address in.

 * @offset: Offset within object to lookup address at.

 * @dma_addr_out: Pointer to location to store DMA address.