1 /* 2 * 3 * (C) COPYRIGHT 2010, 2012-2015 ARM Limited. All rights reserved. 4 * 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 8 * of such GNU licence. 9 * 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. 13 * 14 */ 15 16 /** 17 * @file mali_uk.h 18 * Types and definitions that are common across OSs for both the user 19 * and kernel side of the User-Kernel interface. 20 */ 21 22 #ifndef UK_H_ 23 #define UK_H_ 24 25 #ifdef __cplusplus 26 extern "C" { 27 #endif /* __cplusplus */ 28 29 /** 30 * @addtogroup base_api 31 * @{ 32 */ 33 34 /** 35 * @defgroup 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 and the UMP 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 /** 49 * These are identifiers for kernel-side drivers implementing a UK interface, aka UKK clients. The 50 * UK module maps this to an OS specific device name, e.g. "gpu_base" -> "GPU0:". Specify this 51 * identifier to select a UKK client to the uku_open() function. 52 * 53 * When a new UKK client driver is created a new identifier needs to be added to the uk_client_id 54 * enumeration and the uku_open() implemenation for the various OS ports need to be updated to 55 * provide a mapping of the identifier to the OS specific device name. 56 * 57 */ 58 enum uk_client_id { 59 /** 60 * Value used to identify the Base driver UK client. 61 */ 62 UK_CLIENT_MALI_T600_BASE, 63 64 /** The number of uk clients supported. This must be the last member of the enum */ 65 UK_CLIENT_COUNT 66 }; 67 68 /** 69 * Each function callable through the UK interface has a unique number. 70 * Functions provided by UK clients start from number UK_FUNC_ID. 71 * Numbers below UK_FUNC_ID are used for internal UK functions. 72 */ 73 enum uk_func { 74 UKP_FUNC_ID_CHECK_VERSION, /**< UKK Core internal function */ 75 /** 76 * Each UK client numbers the functions they provide starting from 77 * number UK_FUNC_ID. This number is then eventually assigned to the 78 * id field of the union uk_header structure when preparing to make a 79 * UK call. See your UK client for a list of their function numbers. 80 */ 81 UK_FUNC_ID = 512 82 }; 83 84 /** 85 * Arguments for a UK call are stored in a structure. This structure consists 86 * of a fixed size header and a payload. The header carries a 32-bit number 87 * identifying the UK function to be called (see uk_func). When the UKK client 88 * receives this header and executed the requested UK function, it will use 89 * the same header to store the result of the function in the form of a 90 * int return code. The size of this structure is such that the 91 * first member of the payload following the header can be accessed efficiently 92 * on a 32 and 64-bit kernel and the structure has the same size regardless 93 * of a 32 or 64-bit kernel. The uk_kernel_size_type type should be defined 94 * accordingly in the OS specific mali_uk_os.h header file. 95 */ 96 union uk_header { 97 /** 98 * 32-bit number identifying the UK function to be called. 99 * Also see uk_func. 100 */ 101 u32 id; 102 /** 103 * The int return code returned by the called UK function. 104 * See the specification of the particular UK function you are 105 * calling for the meaning of the error codes returned. All 106 * UK functions return 0 on success. 107 */ 108 u32 ret; 109 /* 110 * Used to ensure 64-bit alignment of this union. Do not remove. 111 * This field is used for padding and does not need to be initialized. 112 */ 113 u64 sizer; 114 }; 115 116 /** 117 * This structure carries a 16-bit major and minor number and is sent along with an internal UK call 118 * used during uku_open to identify the versions of the UK module in use by the user-side and kernel-side. 119 */ 120 struct uku_version_check_args { 121 union uk_header header; 122 /**< UK call header */ 123 u16 major; 124 /**< This field carries the user-side major version on input and the kernel-side major version on output */ 125 u16 minor; 126 /**< This field carries the user-side minor version on input and the kernel-side minor version on output. */ 127 u8 padding[4]; 128 }; 129 130 /** @} end group uk_api */ 131 132 /** @} */ /* end group base_api */ 133 134 #ifdef __cplusplus 135 } 136 #endif /* __cplusplus */ 137 #endif /* _UK_H_ */ 138