drivers/gpu/arm/mali400/r4p0_rel0/common/mali_gp_scheduler.h

   1 /*
   2  * Copyright (C) 2012 ARM Limited. All rights reserved.
   3  *
   4  * This program is free software and is provided to you under the terms of the GNU General Public License version 2
   5  * as published by the Free Software Foundation, and any use by you of this program is subject to the terms of such GNU licence.
   6  *
   7  * A copy of the licence is included with the program, and can also be obtained from Free Software
   8  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
   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__ */