3 * (C) COPYRIGHT 2010, 2012-2015 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 */
34 * @addtogroup base_api
39 * @defgroup uk_api User-Kernel Interface API
41 * The User-Kernel Interface abstracts the communication mechanism between the user and kernel-side code of device
42 * drivers developed as part of the Midgard DDK. Currently that includes the Base driver and the UMP driver.
44 * It exposes an OS independent API to user-side code (UKU) which routes functions calls to an OS-independent
45 * kernel-side API (UKK) via an OS-specific communication mechanism.
47 * This API is internal to the Midgard DDK and is not exposed to any applications.
53 * These are identifiers for kernel-side drivers implementing a UK interface, aka UKK clients. The
54 * 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.
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.
64 * Value used to identify the Base driver UK client.
66 UK_CLIENT_MALI_T600_BASE
,
68 /** The number of uk clients supported. This must be the last member of the enum */
73 * Each function callable through the UK interface has a unique number.
74 * Functions provided by UK clients start from number UK_FUNC_ID.
75 * Numbers below UK_FUNC_ID are used for internal UK functions.
78 UKP_FUNC_ID_CHECK_VERSION
, /**< UKK Core internal function */
80 * Each UK client numbers the functions they provide starting from
81 * number UK_FUNC_ID. This number is then eventually assigned to the
82 * id field of the union uk_header structure when preparing to make a
83 * UK call. See your UK client for a list of their function numbers.
89 * Arguments for a UK call are stored in a structure. This structure consists
90 * of a fixed size header and a payload. The header carries a 32-bit number
91 * identifying the UK function to be called (see uk_func). When the UKK client
92 * receives this header and executed the requested UK function, it will use
93 * the same header to store the result of the function in the form of a
94 * int return code. The size of this structure is such that the
95 * first member of the payload following the header can be accessed efficiently
96 * on a 32 and 64-bit kernel and the structure has the same size regardless
97 * of a 32 or 64-bit kernel. The uk_kernel_size_type type should be defined
98 * accordingly in the OS specific mali_uk_os.h header file.
102 * 32-bit number identifying the UK function to be called.
107 * The int return code returned by the called UK function.
108 * See the specification of the particular UK function you are
109 * calling for the meaning of the error codes returned. All
110 * UK functions return 0 on success.
114 * Used to ensure 64-bit alignment of this union. Do not remove.
115 * This field is used for padding and does not need to be initialized.
121 * This structure carries a 16-bit major and minor number and is sent along with an internal UK call
122 * used during uku_open to identify the versions of the UK module in use by the user-side and kernel-side.
124 struct uku_version_check_args
{
125 union uk_header header
;
126 /**< UK call header */
128 /**< This field carries the user-side major version on input and the kernel-side major version on output */
130 /**< This field carries the user-side minor version on input and the kernel-side minor version on output. */
134 /** @} end group uk_api */
136 /** @} *//* end group base_api */
140 #endif /* __cplusplus */