135 lines
		
	
	
		
			5.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			135 lines
		
	
	
		
			5.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  *
 | |
|  * (C) COPYRIGHT 2017 ARM Limited. All rights reserved.
 | |
|  *
 | |
|  * This program is free software and is provided to you under the terms of the
 | |
|  * GNU General Public License version 2 as published by the Free Software
 | |
|  * Foundation, and any use by you of this program is subject to the terms
 | |
|  * of such GNU licence.
 | |
|  *
 | |
|  * A copy of the licence is included with the program, and can also be obtained
 | |
|  * from Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 | |
|  * Boston, MA  02110-1301, USA.
 | |
|  *
 | |
|  */
 | |
| 
 | |
| 
 | |
| 
 | |
| #ifndef _KBASE_CTX_SCHED_H_
 | |
| #define _KBASE_CTX_SCHED_H_
 | |
| 
 | |
| #include <mali_kbase.h>
 | |
| 
 | |
| /* The Context Scheduler manages address space assignment and reference
 | |
|  * counting to kbase_context. The interface has been designed to minimise
 | |
|  * interactions between the Job Scheduler and Power Management/MMU to support
 | |
|  * both the existing Job Scheduler and Command Stream Frontend interface.
 | |
|  *
 | |
|  * The initial implementation of the Context Scheduler does not schedule
 | |
|  * contexts. Instead it relies on the Job Scheduler/CSF to make decisions of
 | |
|  * when to schedule/evict contexts if address spaces are starved. In the
 | |
|  * future, once an interface between the CS and JS/CSF have been devised to
 | |
|  * provide enough information about how each context is consuming GPU resources,
 | |
|  * those decisions can be made in the CS itself, thereby reducing duplicated
 | |
|  * code.
 | |
|  */
 | |
| 
 | |
| /* base_ctx_sched_init - Initialise the context scheduler
 | |
|  *
 | |
|  * @kbdev: The device for which the context scheduler needs to be
 | |
|  *         initialised
 | |
|  *
 | |
|  * Return: 0 for success, otherwise failure
 | |
|  *
 | |
|  * This must be called during device initilisation. The number of hardware
 | |
|  * address spaces must already be established before calling this function.
 | |
|  */
 | |
| int kbase_ctx_sched_init(struct kbase_device *kbdev);
 | |
| 
 | |
| /* base_ctx_sched_term - Terminate the context scheduler
 | |
|  *
 | |
|  * @kbdev: The device for which the context scheduler needs to be
 | |
|  *         terminated
 | |
|  *
 | |
|  * This must be called during device termination after all contexts have been
 | |
|  * destroyed.
 | |
|  */
 | |
| void kbase_ctx_sched_term(struct kbase_device *kbdev);
 | |
| 
 | |
| /* kbase_ctx_sched_retain_ctx - Retain a reference to the @ref kbase_context
 | |
|  *
 | |
|  * @kctx: The context to which to retain a reference
 | |
|  *
 | |
|  * Return: The address space that the context has been assigned to or
 | |
|  *         KBASEP_AS_NR_INVALID if no address space was available.
 | |
|  *
 | |
|  * This function should be called whenever an address space should be assigned
 | |
|  * to a context and programmed onto the MMU. It should typically be called
 | |
|  * when jobs are ready to be submitted to the GPU.
 | |
|  *
 | |
|  * It can be called as many times as necessary. The address space will be
 | |
|  * assigned to the context for as long as there is a reference to said context.
 | |
|  *
 | |
|  * The kbase_device::mmu_hw_mutex and kbase_device::hwaccess_lock locks must be
 | |
|  * held whilst calling this function.
 | |
|  */
 | |
| int kbase_ctx_sched_retain_ctx(struct kbase_context *kctx);
 | |
| 
 | |
| /* kbase_ctx_sched_retain_ctx_refcount
 | |
|  *
 | |
|  * @kctx: The context to which to retain a reference
 | |
|  *
 | |
|  * This function only retains a reference to the context. It must be called
 | |
|  * only when the context already has a reference.
 | |
|  *
 | |
|  * This is typically called inside an atomic session where we know the context
 | |
|  * is already scheduled in but want to take an extra reference to ensure that
 | |
|  * it doesn't get descheduled.
 | |
|  *
 | |
|  * The kbase_device::hwaccess_lock must be held whilst calling this function
 | |
|  * @return
 | |
|  *	若成功, 返回 0;
 | |
|  *	若 *kctx 状态异常, 返回 -1.
 | |
|  */
 | |
| int kbase_ctx_sched_retain_ctx_refcount(struct kbase_context *kctx);
 | |
| 
 | |
| /* kbase_ctx_sched_release_ctx - Release a reference to the @ref kbase_context
 | |
|  *
 | |
|  * @kctx: The context from which to release a reference
 | |
|  *
 | |
|  * This function should be called whenever an address space could be unassigned
 | |
|  * from a context. When there are no more references to said context, the
 | |
|  * address space previously assigned to this context shall be reassigned to
 | |
|  * other contexts as needed.
 | |
|  *
 | |
|  * The kbase_device::hwaccess_lock must be held whilst calling this function
 | |
|  */
 | |
| void kbase_ctx_sched_release_ctx(struct kbase_context *kctx);
 | |
| 
 | |
| /* kbase_ctx_sched_remove_ctx - Unassign previously assigned address space
 | |
|  *
 | |
|  * @kctx: The context to be removed
 | |
|  *
 | |
|  * This function should be called when a context is being destroyed. The
 | |
|  * context must no longer have any reference. If it has been assigned an
 | |
|  * address space before then the AS will be unprogrammed.
 | |
|  *
 | |
|  * The kbase_device::mmu_hw_mutex and kbase_device::hwaccess_lock locks must be
 | |
|  * held whilst calling this function.
 | |
|  */
 | |
| void kbase_ctx_sched_remove_ctx(struct kbase_context *kctx);
 | |
| 
 | |
| /* kbase_ctx_sched_restore_all_as - Reprogram all address spaces
 | |
|  *
 | |
|  * @kbdev: The device for which address spaces to be reprogrammed
 | |
|  *
 | |
|  * This function shall reprogram all address spaces previously assigned to
 | |
|  * contexts. It can be used after the GPU is reset.
 | |
|  *
 | |
|  * The kbase_device::mmu_hw_mutex and kbase_device::hwaccess_lock locks must be
 | |
|  * held whilst calling this function.
 | |
|  */
 | |
| void kbase_ctx_sched_restore_all_as(struct kbase_device *kbdev);
 | |
| 
 | |
| #endif /* _KBASE_CTX_SCHED_H_ */
 |