diff options
Diffstat (limited to 'drivers/gpu/arm/midgard/backend/gpu/mali_kbase_pm_defs.h')
| -rw-r--r-- | drivers/gpu/arm/midgard/backend/gpu/mali_kbase_pm_defs.h | 555 |
1 files changed, 555 insertions, 0 deletions
diff --git a/drivers/gpu/arm/midgard/backend/gpu/mali_kbase_pm_defs.h b/drivers/gpu/arm/midgard/backend/gpu/mali_kbase_pm_defs.h new file mode 100644 index 000000000000..aad6c49b0c30 --- /dev/null +++ b/drivers/gpu/arm/midgard/backend/gpu/mali_kbase_pm_defs.h @@ -0,0 +1,555 @@ +/* + * + * (C) COPYRIGHT 2014-2015 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. + * + */ + + + +/** + * @file mali_kbase_pm_hwaccess_defs.h + * Backend-specific Power Manager definitions + */ + +#ifndef _KBASE_PM_HWACCESS_DEFS_H_ +#define _KBASE_PM_HWACCESS_DEFS_H_ + +#include "mali_kbase_pm_ca_fixed.h" +#if !MALI_CUSTOMER_RELEASE +#include "mali_kbase_pm_ca_random.h" +#endif + +#include "mali_kbase_pm_always_on.h" +#include "mali_kbase_pm_coarse_demand.h" +#include "mali_kbase_pm_demand.h" +#if !MALI_CUSTOMER_RELEASE +#include "mali_kbase_pm_demand_always_powered.h" +#include "mali_kbase_pm_fast_start.h" +#endif + +/* Forward definition - see mali_kbase.h */ +struct kbase_device; +struct kbase_jd_atom; + +/** The types of core in a GPU. + * + * These enumerated values are used in calls to: + * - @ref kbase_pm_get_present_cores + * - @ref kbase_pm_get_active_cores + * - @ref kbase_pm_get_trans_cores + * - @ref kbase_pm_get_ready_cores. + * + * They specify which type of core should be acted on. These values are set in + * a manner that allows @ref core_type_to_reg function to be simpler and more + * efficient. + */ +enum kbase_pm_core_type { + KBASE_PM_CORE_L2 = L2_PRESENT_LO, /**< The L2 cache */ + KBASE_PM_CORE_SHADER = SHADER_PRESENT_LO, /**< Shader cores */ + KBASE_PM_CORE_TILER = TILER_PRESENT_LO /**< Tiler cores */ +}; + +/** + * struct kbasep_pm_metrics_data - Metrics data collected for use by the power management framework. + * + * @vsync_hit: indicates if a framebuffer update occured since the last vsync. + * A framebuffer driver is expected to provide this information by + * checking at each vsync if the framebuffer was updated and calling + * kbase_pm_vsync_callback() if there was a change of status. + * @utilisation: percentage indicating GPU load (0-100). + * The utilisation is the fraction of time the GPU was powered up + * and busy. This is based on the time_busy and time_idle metrics. + * @util_gl_share: percentage of GPU load related to OpenGL jobs (0-100). + * This is based on the busy_gl and time_busy metrics. + * @util_cl_share: percentage of GPU load related to OpenCL jobs (0-100). + * This is based on the busy_cl and time_busy metrics. + * @time_period_start: time at which busy/idle measurements started + * @time_busy: number of ns the GPU was busy executing jobs since the + * @time_period_start timestamp. + * @time_idle: number of ns since time_period_start the GPU was not executing + * jobs since the @time_period_start timestamp. + * @prev_busy: busy time in ns of previous time period. + * Updated when metrics are reset. + * @prev_idle: idle time in ns of previous time period + * Updated when metrics are reset. + * @gpu_active: true when the GPU is executing jobs. false when + * not. Updated when the job scheduler informs us a job in submitted + * or removed from a GPU slot. + * @busy_cl: number of ns the GPU was busy executing CL jobs. Note that + * if two CL jobs were active for 400ns, this value would be updated + * with 800. + * @busy_gl: number of ns the GPU was busy executing GL jobs. Note that + * if two GL jobs were active for 400ns, this value would be updated + * with 800. + * @active_cl_ctx: number of CL jobs active on the GPU. This is a portion of + * the @nr_in_slots value. + * @active_gl_ctx: number of GL jobs active on the GPU. This is a portion of + * the @nr_in_slots value. + * @nr_in_slots: Total number of jobs currently submitted to the GPU across + * all job slots. Maximum value would be 2*BASE_JM_MAX_NR_SLOTS + * (one in flight and one in the JSn_HEAD_NEXT register for each + * job slot). + * @lock: spinlock protecting the kbasep_pm_metrics_data structure + * @timer: timer to regularly make DVFS decisions based on the power + * management metrics. + * @timer_active: boolean indicating @timer is running + * @platform_data: pointer to data controlled by platform specific code + * @kbdev: pointer to kbase device for which metrics are collected + * + */ +struct kbasep_pm_metrics_data { + int vsync_hit; + int utilisation; + int util_gl_share; + int util_cl_share[2]; /* 2 is a max number of core groups we can have */ + ktime_t time_period_start; + u32 time_busy; + u32 time_idle; + u32 prev_busy; + u32 prev_idle; + bool gpu_active; + u32 busy_cl[2]; + u32 busy_gl; + u32 active_cl_ctx[2]; + u32 active_gl_ctx; + u8 nr_in_slots; + spinlock_t lock; + +#ifdef CONFIG_MALI_MIDGARD_DVFS + struct hrtimer timer; + bool timer_active; +#endif + + void *platform_data; + struct kbase_device *kbdev; +}; + +/** Actions for DVFS. + * + * kbase_pm_get_dvfs_action will return one of these enumerated values to + * describe the action that the DVFS system should take. + */ +enum kbase_pm_dvfs_action { + KBASE_PM_DVFS_NOP, /* < No change in clock frequency is + * requested */ + KBASE_PM_DVFS_CLOCK_UP, /* < The clock frequency should be increased + * if possible */ + KBASE_PM_DVFS_CLOCK_DOWN /* < The clock frequency should be decreased + * if possible */ +}; + +union kbase_pm_policy_data { + struct kbasep_pm_policy_always_on always_on; + struct kbasep_pm_policy_coarse_demand coarse_demand; + struct kbasep_pm_policy_demand demand; +#if !MALI_CUSTOMER_RELEASE + struct kbasep_pm_policy_demand_always_powered demand_always_powered; + struct kbasep_pm_policy_fast_start fast_start; +#endif +}; + +union kbase_pm_ca_policy_data { + struct kbasep_pm_ca_policy_fixed fixed; +#if !MALI_CUSTOMER_RELEASE + struct kbasep_pm_ca_policy_random random; +#endif +}; + +/** + * Data stored per device for power management. + * + * This structure contains data for the power management framework. There is one + * instance of this structure per device in the system. + */ +struct kbase_pm_backend_data { + /** + * The policy that is currently actively controlling core availability. + * + * @note: During an IRQ, this can be NULL when the policy is being + * changed with kbase_pm_ca_set_policy(). The change is protected under + * kbase_device::pm::power_change_lock. Direct access to this from IRQ + * context must therefore check for NULL. If NULL, then + * kbase_pm_ca_set_policy() will re-issue the policy functions that + * would've been done under IRQ. + */ + const struct kbase_pm_ca_policy *ca_current_policy; + + /** + * The policy that is currently actively controlling the power state. + * + * @note: During an IRQ, this can be NULL when the policy is being + * changed with kbase_pm_set_policy(). The change is protected under + * kbase_device::pm::power_change_lock. Direct access to this from IRQ + * context must therefore check for NULL. If NULL, then + * kbase_pm_set_policy() will re-issue the policy functions that + * would've been done under IRQ. + */ + const struct kbase_pm_policy *pm_current_policy; + + /** Private data for current CA policy */ + union kbase_pm_ca_policy_data ca_policy_data; + + /** Private data for current PM policy */ + union kbase_pm_policy_data pm_policy_data; + + /** + * Flag indicating when core availability policy is transitioning cores. + * The core availability policy must set this when a change in core + * availability is occuring. + * + * power_change_lock must be held when accessing this. */ + bool ca_in_transition; + + /** Waiting for reset and a queue to wait for changes */ + bool reset_done; + wait_queue_head_t reset_done_wait; + + /** Wait queue for whether the l2 cache has been powered as requested */ + wait_queue_head_t l2_powered_wait; + /** State indicating whether all the l2 caches are powered. + * Non-zero indicates they're *all* powered + * Zero indicates that some (or all) are not powered */ + int l2_powered; + + /** The reference count of active gpu cycle counter users */ + int gpu_cycle_counter_requests; + /** Lock to protect gpu_cycle_counter_requests */ + spinlock_t gpu_cycle_counter_requests_lock; + + /** + * A bit mask identifying the shader cores that the power policy would + * like to be on. The current state of the cores may be different, but + * there should be transitions in progress that will eventually achieve + * this state (assuming that the policy doesn't change its mind in the + * mean time). + */ + u64 desired_shader_state; + /** + * A bit mask indicating which shader cores are currently in a power-on + * transition + */ + u64 powering_on_shader_state; + /** + * A bit mask identifying the tiler cores that the power policy would + * like to be on. @see kbase_pm_device_data:desired_shader_state + */ + u64 desired_tiler_state; + /** + * A bit mask indicating which tiler core are currently in a power-on + * transition + */ + u64 powering_on_tiler_state; + + /** + * A bit mask indicating which l2-caches are currently in a power-on + * transition + */ + u64 powering_on_l2_state; + + /** + * This flag is set if the GPU is powered as requested by the + * desired_xxx_state variables + */ + bool gpu_in_desired_state; + /* Wait queue set when gpu_in_desired_state != 0 */ + wait_queue_head_t gpu_in_desired_state_wait; + + /** + * Set to true when the GPU is powered and register accesses are + * possible, false otherwise + */ + bool gpu_powered; + + /** Set to true when instrumentation is enabled, false otherwise */ + bool instr_enabled; + + bool cg1_disabled; + +#ifdef CONFIG_MALI_DEBUG + /** + * Debug state indicating whether sufficient initialization of the + * driver has occurred to handle IRQs + */ + bool driver_ready_for_irqs; +#endif /* CONFIG_MALI_DEBUG */ + + /** + * Spinlock that must be held when: + * - writing gpu_powered + * - accessing driver_ready_for_irqs (in CONFIG_MALI_DEBUG builds) + */ + spinlock_t gpu_powered_lock; + + /** Structure to hold metrics for the GPU */ + + struct kbasep_pm_metrics_data metrics; + + /** + * Set to the number of poweroff timer ticks until the GPU is powered + * off + */ + int gpu_poweroff_pending; + + /** + * Set to the number of poweroff timer ticks until shaders are powered + * off + */ + int shader_poweroff_pending_time; + + /** Timer for powering off GPU */ + struct hrtimer gpu_poweroff_timer; + + struct workqueue_struct *gpu_poweroff_wq; + + struct work_struct gpu_poweroff_work; + + /** Bit mask of shaders to be powered off on next timer callback */ + u64 shader_poweroff_pending; + + /** + * Set to true if the poweroff timer is currently running, + * false otherwise + */ + bool poweroff_timer_needed; + + /** + * Callback when the GPU needs to be turned on. See + * @ref kbase_pm_callback_conf + * + * @param kbdev The kbase device + * + * @return 1 if GPU state was lost, 0 otherwise + */ + int (*callback_power_on)(struct kbase_device *kbdev); + + /** + * Callback when the GPU may be turned off. See + * @ref kbase_pm_callback_conf + * + * @param kbdev The kbase device + */ + void (*callback_power_off)(struct kbase_device *kbdev); + + /** + * Callback when a suspend occurs and the GPU needs to be turned off. + * See @ref kbase_pm_callback_conf + * + * @param kbdev The kbase device + */ + void (*callback_power_suspend)(struct kbase_device *kbdev); + + /** + * Callback when a resume occurs and the GPU needs to be turned on. + * See @ref kbase_pm_callback_conf + * + * @param kbdev The kbase device + */ + void (*callback_power_resume)(struct kbase_device *kbdev); + + /** + * Callback when the GPU needs to be turned on. See + * @ref kbase_pm_callback_conf + * + * @param kbdev The kbase device + * + * @return 1 if GPU state was lost, 0 otherwise + */ + int (*callback_power_runtime_on)(struct kbase_device *kbdev); + + /** + * Callback when the GPU may be turned off. See + * @ref kbase_pm_callback_conf + * + * @param kbdev The kbase device + */ + void (*callback_power_runtime_off)(struct kbase_device *kbdev); + +}; + + +/** List of policy IDs */ +enum kbase_pm_policy_id { + KBASE_PM_POLICY_ID_DEMAND = 1, + KBASE_PM_POLICY_ID_ALWAYS_ON, + KBASE_PM_POLICY_ID_COARSE_DEMAND, +#if !MALI_CUSTOMER_RELEASE + KBASE_PM_POLICY_ID_DEMAND_ALWAYS_POWERED, + KBASE_PM_POLICY_ID_FAST_START +#endif +}; + +typedef u32 kbase_pm_policy_flags; + +/** + * Power policy structure. + * + * Each power policy exposes a (static) instance of this structure which + * contains function pointers to the policy's methods. + */ +struct kbase_pm_policy { + /** The name of this policy */ + char *name; + + /** + * Function called when the policy is selected + * + * This should initialize the kbdev->pm.pm_policy_data structure. It + * should not attempt to make any changes to hardware state. + * + * It is undefined what state the cores are in when the function is + * called. + * + * @param kbdev The kbase device structure for the device (must be a + * valid pointer) + */ + void (*init)(struct kbase_device *kbdev); + + /** + * Function called when the policy is unselected. + * + * @param kbdev The kbase device structure for the device (must be a + * valid pointer) + */ + void (*term)(struct kbase_device *kbdev); + + /** + * Function called to get the current shader core mask + * + * The returned mask should meet or exceed (kbdev->shader_needed_bitmap + * | kbdev->shader_inuse_bitmap). + * + * @param kbdev The kbase device structure for the device (must be a + * valid pointer) + * + * @return The mask of shader cores to be powered + */ + u64 (*get_core_mask)(struct kbase_device *kbdev); + + /** + * Function called to get the current overall GPU power state + * + * This function should consider the state of kbdev->pm.active_count. If + * this count is greater than 0 then there is at least one active + * context on the device and the GPU should be powered. If it is equal + * to 0 then there are no active contexts and the GPU could be powered + * off if desired. + * + * @param kbdev The kbase device structure for the device (must be a + * valid pointer) + * + * @return true if the GPU should be powered, false otherwise + */ + bool (*get_core_active)(struct kbase_device *kbdev); + + /** Field indicating flags for this policy */ + kbase_pm_policy_flags flags; + + /** + * Field indicating an ID for this policy. This is not necessarily the + * same as its index in the list returned by kbase_pm_list_policies(). + * It is used purely for debugging. + */ + enum kbase_pm_policy_id id; +}; + + +enum kbase_pm_ca_policy_id { + KBASE_PM_CA_POLICY_ID_FIXED = 1, + KBASE_PM_CA_POLICY_ID_RANDOM +}; + +typedef u32 kbase_pm_ca_policy_flags; + +/** + * Core availability policy structure. + * + * Each core availability policy exposes a (static) instance of this structure + * which contains function pointers to the policy's methods. + */ +struct kbase_pm_ca_policy { + /** The name of this policy */ + char *name; + + /** + * Function called when the policy is selected + * + * This should initialize the kbdev->pm.ca_policy_data structure. It + * should not attempt to make any changes to hardware state. + * + * It is undefined what state the cores are in when the function is + * called. + * + * @param kbdev The kbase device structure for the device (must be a + * valid pointer) + */ + void (*init)(struct kbase_device *kbdev); + + /** + * Function called when the policy is unselected. + * + * @param kbdev The kbase device structure for the device (must be a + * valid pointer) + */ + void (*term)(struct kbase_device *kbdev); + + /** + * Function called to get the current shader core availability mask + * + * When a change in core availability is occuring, the policy must set + * kbdev->pm.ca_in_transition to true. This is to indicate that + * reporting changes in power state cannot be optimized out, even if + * kbdev->pm.desired_shader_state remains unchanged. This must be done + * by any functions internal to the Core Availability Policy that change + * the return value of kbase_pm_ca_policy::get_core_mask. + * + * @param kbdev The kbase device structure for the device (must be a + * valid pointer) + * + * @return The current core availability mask + */ + u64 (*get_core_mask)(struct kbase_device *kbdev); + + /** + * Function called to update the current core status + * + * If none of the cores in core group 0 are ready or transitioning, then + * the policy must ensure that the next call to get_core_mask does not + * return 0 for all cores in core group 0. It is an error to disable + * core group 0 through the core availability policy. + * + * When a change in core availability has finished, the policy must set + * kbdev->pm.ca_in_transition to false. This is to indicate that + * changes in power state can once again be optimized out when + * kbdev->pm.desired_shader_state is unchanged. + * + * @param kbdev The kbase device structure for the device + * (must be a valid pointer) + * @param cores_ready The mask of cores currently powered and + * ready to run jobs + * @param cores_transitioning The mask of cores currently transitioning + * power state + */ + void (*update_core_status)(struct kbase_device *kbdev, u64 cores_ready, + u64 cores_transitioning); + + /** Field indicating flags for this policy */ + kbase_pm_ca_policy_flags flags; + + /** + * Field indicating an ID for this policy. This is not necessarily the + * same as its index in the list returned by kbase_pm_list_policies(). + * It is used purely for debugging. + */ + enum kbase_pm_ca_policy_id id; +}; + +#endif /* _KBASE_PM_HWACCESS_DEFS_H_ */ |