summaryrefslogtreecommitdiff
path: root/mali_kbase/mali_kbase_hwaccess_pm.h
diff options
context:
space:
mode:
authorSidath Senanayake <sidaths@google.com>2021-04-14 19:14:30 +0100
committerSidath Senanayake <sidaths@google.com>2021-04-14 19:53:59 +0100
commit8037b534570814775d79aeddd06b76e5ee941f59 (patch)
treebd03fb25466475adb31333ff487350e1bd352fa1 /mali_kbase/mali_kbase_hwaccess_pm.h
parent5ddb2927918bdf131080bc488eb1fb455d1cdfb7 (diff)
downloadgpu-8037b534570814775d79aeddd06b76e5ee941f59.tar.gz
Mali Valhall DDK r30p0 KMD
Provenance 4a09e9e58 (collaborate/EAC/v_r30p0) VX504X08X-BU-00000-r30p0-01eac0 - Valhall Android DDK VX504X08X-BU-60000-r30p0-01eac0 - Valhall Android Document Bundle VX504X08X-DC-11001-r30p0-01eac0 - Valhall Android DDK Software Errata VX504X08X-SW-99006-r30p0-01eac0 - Valhall Android Renderscript AOSP parts Signed-off-by: Sidath Senanayake <sidaths@google.com> Change-Id: Ie30d6ece7ebe221c8e4c736af05ad05dcfc15127
Diffstat (limited to 'mali_kbase/mali_kbase_hwaccess_pm.h')
-rw-r--r--mali_kbase/mali_kbase_hwaccess_pm.h79
1 files changed, 23 insertions, 56 deletions
diff --git a/mali_kbase/mali_kbase_hwaccess_pm.h b/mali_kbase/mali_kbase_hwaccess_pm.h
index eb6229e..4b2a53e 100644
--- a/mali_kbase/mali_kbase_hwaccess_pm.h
+++ b/mali_kbase/mali_kbase_hwaccess_pm.h
@@ -1,27 +1,7 @@
+/* SPDX-License-Identifier: GPL-2.0 */
/*
*
- * (C) COPYRIGHT 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.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, you can access it online at
- * http://www.gnu.org/licenses/gpl-2.0.html.
- *
- * SPDX-License-Identifier: GPL-2.0
- *
- *//* SPDX-License-Identifier: GPL-2.0 */
-/*
- *
- * (C) COPYRIGHT 2014-2015, 2018-2020 ARM Limited. All rights reserved.
+ * (C) COPYRIGHT 2014-2015, 2018-2021 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
@@ -40,8 +20,7 @@
*/
/**
- * @file mali_kbase_hwaccess_pm.h
- * HW access power manager common APIs
+ * DOC: HW access power manager common APIs
*/
#ifndef _KBASE_HWACCESS_PM_H_
@@ -98,24 +77,21 @@ int kbase_hwaccess_pm_powerup(struct kbase_device *kbdev,
* the time this function returns, regardless of whether or not the active power
* policy asks for the GPU to be powered off.
*
- * @param kbdev The kbase device structure for the device (must be a valid
- * pointer)
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
*/
void kbase_hwaccess_pm_halt(struct kbase_device *kbdev);
/**
* Perform any backend-specific actions to suspend the GPU
*
- * @param kbdev The kbase device structure for the device (must be a valid
- * pointer)
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
*/
void kbase_hwaccess_pm_suspend(struct kbase_device *kbdev);
/**
* Perform any backend-specific actions to resume the GPU from a suspend
*
- * @param kbdev The kbase device structure for the device (must be a valid
- * pointer)
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
*/
void kbase_hwaccess_pm_resume(struct kbase_device *kbdev);
@@ -123,8 +99,7 @@ void kbase_hwaccess_pm_resume(struct kbase_device *kbdev);
* Perform any required actions for activating the GPU. Called when the first
* context goes active.
*
- * @param kbdev The kbase device structure for the device (must be a valid
- * pointer)
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
*/
void kbase_hwaccess_pm_gpu_active(struct kbase_device *kbdev);
@@ -132,8 +107,7 @@ void kbase_hwaccess_pm_gpu_active(struct kbase_device *kbdev);
* Perform any required actions for idling the GPU. Called when the last
* context goes idle.
*
- * @param kbdev The kbase device structure for the device (must be a valid
- * pointer)
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
*/
void kbase_hwaccess_pm_gpu_idle(struct kbase_device *kbdev);
@@ -143,9 +117,8 @@ void kbase_hwaccess_pm_gpu_idle(struct kbase_device *kbdev);
*
* This determines which cores the power manager is allowed to use.
*
- * @param kbdev The kbase device structure for the device (must be a
- * valid pointer)
- * @param new_core_mask The core mask to use
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
+ * @new_core_mask: The core mask to use
*/
void kbase_pm_set_debug_core_mask(struct kbase_device *kbdev,
u64 new_core_mask);
@@ -155,11 +128,10 @@ void kbase_pm_set_debug_core_mask(struct kbase_device *kbdev,
*
* This determines which cores the power manager is allowed to use.
*
- * @param kbdev The kbase device structure for the device (must be a
- * valid pointer)
- * @param new_core_mask_js0 The core mask to use for job slot 0
- * @param new_core_mask_js0 The core mask to use for job slot 1
- * @param new_core_mask_js0 The core mask to use for job slot 2
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
+ * @new_core_mask_js0: The core mask to use for job slot 0
+ * @new_core_mask_js1: The core mask to use for job slot 1
+ * @new_core_mask_js2: The core mask to use for job slot 2
*/
void kbase_pm_set_debug_core_mask(struct kbase_device *kbdev,
u64 new_core_mask_js0, u64 new_core_mask_js1,
@@ -171,8 +143,7 @@ void kbase_pm_set_debug_core_mask(struct kbase_device *kbdev,
*
* Returns the policy that is currently active.
*
- * @param kbdev The kbase device structure for the device (must be a valid
- * pointer)
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
*
* @return The current policy
*/
@@ -182,10 +153,9 @@ const struct kbase_pm_ca_policy
/**
* Change the policy to the one specified.
*
- * @param kbdev The kbase device structure for the device (must be a valid
- * pointer)
- * @param policy The policy to change to (valid pointer returned from
- * @ref kbase_pm_ca_list_policies)
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
+ * @policy: The policy to change to (valid pointer returned from
+ * @ref kbase_pm_ca_list_policies)
*/
void kbase_pm_ca_set_policy(struct kbase_device *kbdev,
const struct kbase_pm_ca_policy *policy);
@@ -193,23 +163,20 @@ void kbase_pm_ca_set_policy(struct kbase_device *kbdev,
/**
* Retrieve a static list of the available policies.
*
- * @param[out] policies An array pointer to take the list of policies. This may
- * be NULL. The contents of this array must not be
- * modified.
+ * @policies: An array pointer to take the list of policies. This may be NULL.
+ * The contents of this array must not be modified.
*
* @return The number of policies
*/
int
kbase_pm_ca_list_policies(const struct kbase_pm_ca_policy * const **policies);
-
/**
* Get the current policy.
*
* Returns the policy that is currently active.
*
- * @param kbdev The kbase device structure for the device (must be a valid
- * pointer)
+ * @kbdev: The kbase device structure for the device (must be a valid pointer)
*
* @return The current policy
*/
@@ -218,9 +185,9 @@ const struct kbase_pm_policy *kbase_pm_get_policy(struct kbase_device *kbdev);
/**
* Change the policy to the one specified.
*
- * @param kbdev The kbase device structure for the device (must be a valid
+ * @kbdev: The kbase device structure for the device (must be a valid
* pointer)
- * @param policy The policy to change to (valid pointer returned from
+ * @policy: The policy to change to (valid pointer returned from
* @ref kbase_pm_list_policies)
*/
void kbase_pm_set_policy(struct kbase_device *kbdev,