• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  *
4  * (C) COPYRIGHT 2010, 2012-2015, 2018, 2020-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 /**
23  * Types and definitions that are common across OSs for both the user
24  * and kernel side of the User-Kernel interface.
25  */
26 
27 #ifndef _UAPI_UK_H_
28 #define _UAPI_UK_H_
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif /* __cplusplus */
33 
34 /**
35  * DOC: uk_api User-Kernel Interface API
36  *
37  * The User-Kernel Interface abstracts the communication mechanism between the user and kernel-side code of device
38  * drivers developed as part of the Midgard DDK. Currently that includes the Base driver.
39  *
40  * It exposes an OS independent API to user-side code (UKU) which routes functions calls to an OS-independent
41  * kernel-side API (UKK) via an OS-specific communication mechanism.
42  *
43  * This API is internal to the Midgard DDK and is not exposed to any applications.
44  *
45  */
46 
47 /**
48  * enum uk_client_id - These are identifiers for kernel-side drivers
49  * implementing a UK interface, aka UKK clients.
50  * @UK_CLIENT_MALI_T600_BASE: Value used to identify the Base driver UK client.
51  * @UK_CLIENT_COUNT:          The number of uk clients supported. This must be
52  *                            the last member of the enum
53  *
54  * The UK module maps this to an OS specific device name, e.g. "gpu_base" -> "GPU0:". Specify this
55  * identifier to select a UKK client to the uku_open() function.
56  *
57  * When a new UKK client driver is created a new identifier needs to be added to the uk_client_id
58  * enumeration and the uku_open() implemenation for the various OS ports need to be updated to
59  * provide a mapping of the identifier to the OS specific device name.
60  *
61  */
62 enum uk_client_id {
63 	UK_CLIENT_MALI_T600_BASE,
64 	UK_CLIENT_COUNT
65 };
66 
67 #ifdef __cplusplus
68 }
69 #endif /* __cplusplus */
70 #endif /* _UAPI_UK_H_ */
71