drm/msm: msm_gpu.h: fix all kernel-doc warnings (cd569786) · Commits · git / linux-nf

drivers/gpu/drm/msm/msm_gpu.h

+18 −50

Original line number	Diff line number	Diff line
		@@ -116,15 +116,12 @@ struct msm_gpu_fault_info {
		* struct msm_gpu_devfreq - devfreq related state
		*/
		struct msm_gpu_devfreq {
		/** devfreq: devfreq instance */
		/** @devfreq: devfreq instance */
		struct devfreq *devfreq;

		/** lock: lock for "suspended", "busy_cycles", and "time" */
		/** @lock: lock for "suspended", "busy_cycles", and "time" */
		struct mutex lock;

		/**
		* idle_freq:
		*
		* @idle_freq:
		* Shadow frequency used while the GPU is idle. From the PoV of
		* the devfreq governor, we are continuing to sample busyness and
		* adjust frequency while the GPU is idle, but we use this shadow
		@@ -132,43 +129,34 @@ struct msm_gpu_devfreq {
		* it is inactive.
		*/
		unsigned long idle_freq;

		/**
		* boost_constraint:
		*
		* @boost_freq:
		* A PM QoS constraint to boost min freq for a period of time
		* until the boost expires.
		*/
		struct dev_pm_qos_request boost_freq;

		/**
		* busy_cycles: Last busy counter value, for calculating elapsed busy
		* @busy_cycles: Last busy counter value, for calculating elapsed busy
		* cycles since last sampling period.
		*/
		u64 busy_cycles;

		/** time: Time of last sampling period. */
		/** @time: Time of last sampling period. */
		ktime_t time;

		/** idle_time: Time of last transition to idle: */
		/** @idle_time: Time of last transition to idle. */
		ktime_t idle_time;

		/**
		* idle_work:
		*
		* @idle_work:
		* Used to delay clamping to idle freq on active->idle transition.
		*/
		struct msm_hrtimer_work idle_work;

		/**
		* boost_work:
		*
		* @boost_work:
		* Used to reset the boost_constraint after the boost period has
		* elapsed
		*/
		struct msm_hrtimer_work boost_work;

		/** suspended: tracks if we're suspended */
		/** @suspended: tracks if we're suspended */
		bool suspended;
		};

		@@ -358,57 +346,43 @@ struct msm_gpu_perfcntr {
		struct msm_context {
		/** @queuelock: synchronizes access to submitqueues list */
		rwlock_t queuelock;

		/** @submitqueues: list of &msm_gpu_submitqueue created by userspace */
		struct list_head submitqueues;

		/**
		* @queueid:
		*
		* Counter incremented each time a submitqueue is created, used to
		* assign &msm_gpu_submitqueue.id
		*/
		int queueid;

		/**
		* @closed: The device file associated with this context has been closed.
		*
		* Once the device is closed, any submits that have not been written
		* to the ring buffer are no-op'd.
		*/
		bool closed;

		/**
		* @userspace_managed_vm:
		*
		* Has userspace opted-in to userspace managed VM (ie. VM_BIND) via
		* MSM_PARAM_EN_VM_BIND?
		*/
		bool userspace_managed_vm;

		/**
		* @vm:
		*
		* The per-process GPU address-space. Do not access directly, use
		* msm_context_vm().
		*/
		struct drm_gpuvm *vm;

		/** @kref: the reference count */
		/** @ref: the reference count */
		struct kref ref;

		/**
		* @seqno:
		*
		* A unique per-process sequence number. Used to detect context
		* switches, without relying on keeping a, potentially dangling,
		* pointer to the previous context.
		*/
		int seqno;

		/**
		* @sysprof:
		*
		* The value of MSM_PARAM_SYSPROF set by userspace. This is
		* intended to be used by system profiling tools like Mesa's
		* pps-producer (perfetto), and restricted to CAP_SYS_ADMIN.
		@@ -423,40 +397,32 @@ struct msm_context {
		* file is closed.
		*/
		int sysprof;

		/**
		* @comm: Overridden task comm, see MSM_PARAM_COMM
		*
		* Accessed under msm_gpu::lock
		*/
		char *comm;

		/**
		* @cmdline: Overridden task cmdline, see MSM_PARAM_CMDLINE
		*
		* Accessed under msm_gpu::lock
		*/
		char *cmdline;

		/**
		* @elapsed:
		*
		* @elapsed_ns:
		* The total (cumulative) elapsed time GPU was busy with rendering
		* from this context in ns.
		*/
		uint64_t elapsed_ns;

		/**
		* @cycles:
		*
		* The total (cumulative) GPU cycles elapsed attributed to this
		* context.
		*/
		uint64_t cycles;

		/**
		* @entities:
		*
		* Table of per-priority-level sched entities used by submitqueues
		* associated with this &drm_file. Because some userspace apps
		* make assumptions about rendering from multiple gl contexts
		@@ -466,10 +432,8 @@ struct msm_context {
		* level.
		*/
		struct drm_sched_entity entities[NR_SCHED_PRIORITIES MSM_GPU_MAX_RINGS];

		/**
		* @ctx_mem:
		*
		* Total amount of memory of GEM buffers with handles attached for
		* this context.
		*/
		@@ -479,7 +443,7 @@ struct msm_context {
		struct drm_gpuvm msm_context_vm(struct drm_device dev, struct msm_context *ctx);

		/**
		* msm_context_is_vm_bind() - has userspace opted in to VM_BIND?
		* msm_context_is_vmbind() - has userspace opted in to VM_BIND?
		*
		* @ctx: the drm_file context
		*
		@@ -487,6 +451,8 @@ struct drm_gpuvm msm_context_vm(struct drm_device dev, struct msm_context *ctx
		* do sparse binding including having multiple, potentially partial,
		* mappings in the VM. Therefore certain legacy uabi (ie. GET_IOVA,
		* SET_IOVA) are rejected because they don't have a sensible meaning.
		*
		* Returns: %true if userspace is managing the VM, %false otherwise.
		*/
		static inline bool
		msm_context_is_vmbind(struct msm_context *ctx)
		@@ -518,6 +484,8 @@ msm_context_is_vmbind(struct msm_context *ctx)
		* This allows generations without preemption (nr_rings==1) to have some
		* amount of prioritization, and provides more priority levels for gens
		* that do have preemption.
		*
		* Returns: %0 on success, %-errno on error.
		*/
		static inline int msm_gpu_convert_priority(struct msm_gpu *gpu, int prio,
		unsigned ring_nr, enum drm_sched_priority sched_prio)
		@@ -541,7 +509,7 @@ static inline int msm_gpu_convert_priority(struct msm_gpu *gpu, int prio,
		}

		/**
		* struct msm_gpu_submitqueues - Userspace created context.
		* struct msm_gpu_submitqueue - Userspace created context.
		*
		* A submitqueue is associated with a gl context or vk queue (or equiv)
		* in userspace.