xref: /OK3568_Linux_fs/kernel/drivers/gpu/arm/bifrost/csf/mali_kbase_csf_timeout.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  *
4  * (C) COPYRIGHT 2019-2021 ARM Limited. All rights reserved.
5  *
6  * This program is free software and is provided to you under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation, and any use by you of this program is subject to the terms
9  * of such GNU license.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you can access it online at
18  * http://www.gnu.org/licenses/gpl-2.0.html.
19  *
20  */
21 
22 #ifndef _KBASE_CSF_TIMEOUT_H_
23 #define _KBASE_CSF_TIMEOUT_H_
24 
25 struct kbase_device;
26 
27 /**
28  * kbase_csf_timeout_init - Initialize the progress timeout.
29  *
30  * @kbdev: Instance of a GPU platform device that implements a CSF interface.
31  *         Must be zero-initialized.
32  *
33  * The progress timeout is the number of GPU clock cycles allowed to elapse
34  * before the driver terminates a GPU command queue group in which a task is
35  * making no forward progress on an endpoint (e.g. a shader core). This function
36  * determines the initial value and also creates a sysfs file to allow the
37  * timeout to be reconfigured later.
38  *
39  * Reconfigures the global firmware interface to enable the current timeout.
40  *
41  * Return: 0 on success, or negative on failure.
42  */
43 int kbase_csf_timeout_init(struct kbase_device *kbdev);
44 
45 /**
46  * kbase_csf_timeout_term - Terminate the progress timeout.
47  *
48  * @kbdev: Instance of a GPU platform device that implements a CSF interface.
49  *
50  * Removes the sysfs file which allowed the timeout to be reconfigured.
51  * Does nothing if called on a zero-initialized object.
52  */
53 void kbase_csf_timeout_term(struct kbase_device *kbdev);
54 
55 /**
56  * kbase_csf_timeout_get - get the current global progress timeout.
57  *
58  * @kbdev: Instance of a GPU platform device that implements a CSF interface.
59  *
60  * Return: the maximum number of GPU cycles that is allowed to elapse without
61  *         forward progress before the driver terminates a GPU command queue
62  *         group.
63  */
64 u64 kbase_csf_timeout_get(struct kbase_device *const kbdev);
65 
66 #endif /* _KBASE_CSF_TIMEOUT_H_ */
67