3 * (C) COPYRIGHT ARM Limited. All rights reserved.
5 * This program is free software and is provided to you under the terms of the
6 * GNU General Public License version 2 as published by the Free Software
7 * Foundation, and any use by you of this program is subject to the terms
10 * A copy of the licence is included with the program, and can also be obtained
11 * from Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
12 * Boston, MA 02110-1301, USA.
22 * Types and definitions that are common across OSs for both the user
23 * and kernel side of the User-Kernel interface.
31 #endif /* __cplusplus */
33 #include <malisw/mali_stdtypes.h>
36 * @addtogroup base_api
41 * @defgroup uk_api User-Kernel Interface API
43 * The User-Kernel Interface abstracts the communication mechanism between the user and kernel-side code of device
44 * drivers developed as part of the Midgard DDK. Currently that includes the Base driver and the UMP driver.
46 * It exposes an OS independent API to user-side code (UKU) which routes functions calls to an OS-independent
47 * kernel-side API (UKK) via an OS-specific communication mechanism.
49 * This API is internal to the Midgard DDK and is not exposed to any applications.
55 * These are identifiers for kernel-side drivers implementing a UK interface, aka UKK clients. The
56 * UK module maps this to an OS specific device name, e.g. "gpu_base" -> "GPU0:". Specify this
57 * identifier to select a UKK client to the uku_open() function.
59 * When a new UKK client driver is created a new identifier needs to be added to the uk_client_id
60 * enumeration and the uku_open() implemenation for the various OS ports need to be updated to
61 * provide a mapping of the identifier to the OS specific device name.
64 typedef enum uk_client_id {
66 * Value used to identify the Base driver UK client.
68 UK_CLIENT_MALI_T600_BASE,
70 /** The number of uk clients supported. This must be the last member of the enum */
75 * Each function callable through the UK interface has a unique number.
76 * Functions provided by UK clients start from number UK_FUNC_ID.
77 * Numbers below UK_FUNC_ID are used for internal UK functions.
79 typedef enum uk_func {
80 UKP_FUNC_ID_CHECK_VERSION, /**< UKK Core internal function */
82 * Each UK client numbers the functions they provide starting from
83 * number UK_FUNC_ID. This number is then eventually assigned to the
84 * id field of the uk_header structure when preparing to make a
85 * UK call. See your UK client for a list of their function numbers.
91 * Arguments for a UK call are stored in a structure. This structure consists
92 * of a fixed size header and a payload. The header carries a 32-bit number
93 * identifying the UK function to be called (see uk_func). When the UKK client
94 * receives this header and executed the requested UK function, it will use
95 * the same header to store the result of the function in the form of a
96 * mali_error return code. The size of this structure is such that the
97 * first member of the payload following the header can be accessed efficiently
98 * on a 32 and 64-bit kernel and the structure has the same size regardless
99 * of a 32 or 64-bit kernel. The uk_kernel_size_type type should be defined
100 * accordingly in the OS specific mali_uk_os.h header file.
102 typedef union uk_header {
104 * 32-bit number identifying the UK function to be called.
109 * The mali_error return code returned by the called UK function.
110 * See the specification of the particular UK function you are
111 * calling for the meaning of the error codes returned. All
112 * UK functions return MALI_ERROR_NONE on success.
116 * Used to ensure 64-bit alignment of this union. Do not remove.
117 * This field is used for padding and does not need to be initialized.
123 * This structure carries a 16-bit major and minor number and is sent along with an internal UK call
124 * used during uku_open to identify the versions of the UK module in use by the user-side and kernel-side.
126 typedef struct uku_version_check_args {
128 /**< UK call header */
130 /**< This field carries the user-side major version on input and the kernel-side major version on output */
132 /**< This field carries the user-side minor version on input and the kernel-side minor version on output. */
134 } uku_version_check_args;
136 /** @} end group uk_api */
138 /** @} *//* end group base_api */
142 #endif /* __cplusplus */