[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / misc / mediatek / gpu / mt8127 / mali / mali / common / mali_gp_scheduler.h

/*
 * This confidential and proprietary software may be used only as
 * authorised by a licensing agreement from ARM Limited
 * (C) COPYRIGHT 2012-2013 ARM Limited
 * ALL RIGHTS RESERVED
 * The entire notice above must be reproduced on all authorised
 * copies and copies may only be made to the extent permitted
 * by a licensing agreement from ARM Limited.
 */

#ifndef __MALI_GP_SCHEDULER_H__
#define __MALI_GP_SCHEDULER_H__

#include "mali_osk.h"
#include "mali_gp_job.h"
#include "mali_group.h"

_mali_osk_errcode_t mali_gp_scheduler_initialize(void);
void mali_gp_scheduler_terminate(void);

void mali_gp_scheduler_job_done(struct mali_group *group, struct mali_gp_job *job, mali_bool success);
void mali_gp_scheduler_oom(struct mali_group *group, struct mali_gp_job *job);
u32 mali_gp_scheduler_dump_state(char *buf, u32 size);

void mali_gp_scheduler_suspend(void);
void mali_gp_scheduler_resume(void);

/**
 * @brief Abort all running and queued GP jobs from session.
 *
* This functions aborts all GP jobs from the specified session. Queued jobs are removed from the
* queue and jobs currently running on a core will be aborted.
 *
 * @param session Session that is aborting.
 */
void mali_gp_scheduler_abort_session(struct mali_session_data *session);

/**
 * @brief Reset all groups
 *
 * This function resets all groups known by the GP scheuduler. This must be
 * called after the Mali HW has been powered on in order to reset the HW.
 */
void mali_gp_scheduler_reset_all_groups(void);

/**
 * @brief Zap TLB on all groups with \a session active
 *
 * The scheculer will zap the session on all groups it owns.
 */
void mali_gp_scheduler_zap_all_active(struct mali_session_data *session);

/**
 * @brief Re-enable a group that has been disabled with mali_gp_scheduler_disable_group
 *
 * If a Mali PMU is present, the group will be powered back on and added back
 * into the GP scheduler.
 *
 * @param group Pointer to the group to enable
 */
void mali_gp_scheduler_enable_group(struct mali_group *group);

/**
 * @brief Disable a group
 *
 * The group will be taken out of the GP scheduler and powered off, if a Mali
 * PMU is present.
 *
 * @param group Pointer to the group to disable
 */
void mali_gp_scheduler_disable_group(struct mali_group *group);

/**
 * @brief Used by the Timeline system to queue a GP job.
 *
 * @note @ref mali_scheduler_schedule_from_mask() should be called if this function returns non-zero.
 *
 * @param job The GP job that is being activated.
 *
 * @return A scheduling bitmask that can be used to decide if scheduling is necessary after this
 * call.
 */
mali_scheduler_mask mali_gp_scheduler_activate_job(struct mali_gp_job *job);

/**
 * @brief Schedule queued jobs on idle cores.
 */
void mali_gp_scheduler_schedule(void);

/**
 * @brief Submit a GP job to the GP scheduler.
 *
 * This will add the GP job to the Timeline system.
 *
 * @param session Session this job belongs to.
 * @param job GP job that will be submitted
 * @return Point on GP timeline for job.
 */
mali_timeline_point mali_gp_scheduler_submit_job(struct mali_session_data *session, struct mali_gp_job *job);

#endif /* __MALI_GP_SCHEDULER_H__ */
Commit	Line	Data
6fa3eb70 S	1	/*
	2	* This confidential and proprietary software may be used only as
	3	* authorised by a licensing agreement from ARM Limited
	4	* (C) COPYRIGHT 2012-2013 ARM Limited
	5	* ALL RIGHTS RESERVED
	6	* The entire notice above must be reproduced on all authorised
	7	* copies and copies may only be made to the extent permitted
	8	* by a licensing agreement from ARM Limited.
	9	*/
	10
	11	#ifndef __MALI_GP_SCHEDULER_H__
	12	#define __MALI_GP_SCHEDULER_H__
	13
	14	#include "mali_osk.h"
	15	#include "mali_gp_job.h"
	16	#include "mali_group.h"
	17
	18	_mali_osk_errcode_t mali_gp_scheduler_initialize(void);
	19	void mali_gp_scheduler_terminate(void);
	20
	21	void mali_gp_scheduler_job_done(struct mali_group group, struct mali_gp_job job, mali_bool success);
	22	void mali_gp_scheduler_oom(struct mali_group group, struct mali_gp_job job);
	23	u32 mali_gp_scheduler_dump_state(char *buf, u32 size);
	24
	25	void mali_gp_scheduler_suspend(void);
	26	void mali_gp_scheduler_resume(void);
	27
	28	/**
	29	* @brief Abort all running and queued GP jobs from session.
	30	*
	31	* This functions aborts all GP jobs from the specified session. Queued jobs are removed from the
	32	* queue and jobs currently running on a core will be aborted.
	33	*
	34	* @param session Session that is aborting.
	35	*/
	36	void mali_gp_scheduler_abort_session(struct mali_session_data *session);
	37
	38	/**
	39	* @brief Reset all groups
	40	*
	41	* This function resets all groups known by the GP scheuduler. This must be
	42	* called after the Mali HW has been powered on in order to reset the HW.
	43	*/
	44	void mali_gp_scheduler_reset_all_groups(void);
	45
	46	/**
	47	* @brief Zap TLB on all groups with \a session active
	48	*
	49	* The scheculer will zap the session on all groups it owns.
	50	*/
	51	void mali_gp_scheduler_zap_all_active(struct mali_session_data *session);
	52
	53	/**
	54	* @brief Re-enable a group that has been disabled with mali_gp_scheduler_disable_group
	55	*
	56	* If a Mali PMU is present, the group will be powered back on and added back
	57	* into the GP scheduler.
	58	*
	59	* @param group Pointer to the group to enable
	60	*/
	61	void mali_gp_scheduler_enable_group(struct mali_group *group);
	62
	63	/**
	64	* @brief Disable a group
65	*
66	* The group will be taken out of the GP scheduler and powered off, if a Mali
67	* PMU is present.
68	*
69	* @param group Pointer to the group to disable
70	*/
71	void mali_gp_scheduler_disable_group(struct mali_group *group);
72
73	/**
74	* @brief Used by the Timeline system to queue a GP job.
75	*
76	* @note @ref mali_scheduler_schedule_from_mask() should be called if this function returns non-zero.
77	*
78	* @param job The GP job that is being activated.
79	*
80	* @return A scheduling bitmask that can be used to decide if scheduling is necessary after this
81	* call.
82	*/
83	mali_scheduler_mask mali_gp_scheduler_activate_job(struct mali_gp_job *job);
84
85	/**
86	* @brief Schedule queued jobs on idle cores.
87	*/
88	void mali_gp_scheduler_schedule(void);
89
90	/**
91	* @brief Submit a GP job to the GP scheduler.
92	*
93	* This will add the GP job to the Timeline system.
94	*
95	* @param session Session this job belongs to.
96	* @param job GP job that will be submitted
97	* @return Point on GP timeline for job.
98	*/
99	mali_timeline_point mali_gp_scheduler_submit_job(struct mali_session_data session, struct mali_gp_job job);
100
101	#endif /* __MALI_GP_SCHEDULER_H__ */