2 * Copyright (C) 2010-2015 ARM Limited. All rights reserved.
4 * This program is free software and is provided to you under the terms of the GNU General Public License version 2
5 * as published by the Free Software Foundation, and any use by you of this program is subject to the terms of such GNU licence.
7 * A copy of the licence is included with the program, and can also be obtained from Free Software
8 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
10 * Class Path Exception
11 * Linking this library statically or dynamically with other modules is making a combined work based on this library.
12 * Thus, the terms and conditions of the GNU General Public License cover the whole combination.
13 * As a special exception, the copyright holders of this library give you permission to link this library with independent modules
14 * to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting
15 * executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions
16 * of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify
17 * this library, you may extend this exception to your version of the library, but you are not obligated to do so.
18 * If you do not wish to do so, delete this exception statement from your version.
22 * @file mali_uk_types.h
23 * Defines the types and constants used in the user-kernel interface
26 #ifndef __MALI_UTGARD_UK_TYPES_H__
27 #define __MALI_UTGARD_UK_TYPES_H__
33 /* Iteration functions depend on these values being consecutive. */
34 #define MALI_UK_TIMELINE_GP 0
35 #define MALI_UK_TIMELINE_PP 1
36 #define MALI_UK_TIMELINE_SOFT 2
37 #define MALI_UK_TIMELINE_MAX 3
39 #define MALI_UK_BIG_VARYING_SIZE (1024*1024*2)
42 u32 points[MALI_UK_TIMELINE_MAX];
47 * @addtogroup uddapi Unified Device Driver (UDD) APIs
53 * @addtogroup u_k_api UDD User/Kernel Interface (U/K) APIs
58 /** @defgroup _mali_uk_core U/K Core
61 /** Definition of subsystem numbers, to assist in creating a unique identifier
64 * @see _mali_uk_functions */
66 _MALI_UK_CORE_SUBSYSTEM, /**< Core Group of U/K calls */
67 _MALI_UK_MEMORY_SUBSYSTEM, /**< Memory Group of U/K calls */
68 _MALI_UK_PP_SUBSYSTEM, /**< Fragment Processor Group of U/K calls */
69 _MALI_UK_GP_SUBSYSTEM, /**< Vertex Processor Group of U/K calls */
70 _MALI_UK_PROFILING_SUBSYSTEM, /**< Profiling Group of U/K calls */
71 _MALI_UK_VSYNC_SUBSYSTEM, /**< VSYNC Group of U/K calls */
72 } _mali_uk_subsystem_t;
74 /** Within a function group each function has its unique sequence number
75 * to assist in creating a unique identifier for each U/K call.
77 * An ordered pair of numbers selected from
78 * ( \ref _mali_uk_subsystem_t,\ref _mali_uk_functions) will uniquely identify the
79 * U/K call across all groups of functions, and all functions. */
83 _MALI_UK_OPEN = 0, /**< _mali_ukk_open() */
84 _MALI_UK_CLOSE, /**< _mali_ukk_close() */
85 _MALI_UK_WAIT_FOR_NOTIFICATION, /**< _mali_ukk_wait_for_notification() */
86 _MALI_UK_GET_API_VERSION, /**< _mali_ukk_get_api_version() */
87 _MALI_UK_POST_NOTIFICATION, /**< _mali_ukk_post_notification() */
88 _MALI_UK_GET_USER_SETTING, /**< _mali_ukk_get_user_setting() *//**< [out] */
89 _MALI_UK_GET_USER_SETTINGS, /**< _mali_ukk_get_user_settings() *//**< [out] */
90 _MALI_UK_REQUEST_HIGH_PRIORITY, /**< _mali_ukk_request_high_priority() */
91 _MALI_UK_TIMELINE_GET_LATEST_POINT, /**< _mali_ukk_timeline_get_latest_point() */
92 _MALI_UK_TIMELINE_WAIT, /**< _mali_ukk_timeline_wait() */
93 _MALI_UK_TIMELINE_CREATE_SYNC_FENCE, /**< _mali_ukk_timeline_create_sync_fence() */
94 _MALI_UK_SOFT_JOB_START, /**< _mali_ukk_soft_job_start() */
95 _MALI_UK_SOFT_JOB_SIGNAL, /**< _mali_ukk_soft_job_signal() */
96 _MALI_UK_PENDING_SUBMIT, /**< _mali_ukk_pending_submit() */
98 _MALI_GET_RK_KO_VERSION, /* rk_ext */
99 _MALI_UK_GET_MALI_VERSION_IN_RK30,
101 /** Memory functions */
103 _MALI_UK_ALLOC_MEM = 0, /**< _mali_ukk_alloc_mem() */
104 _MALI_UK_FREE_MEM, /**< _mali_ukk_free_mem() */
105 _MALI_UK_BIND_MEM, /**< _mali_ukk_mem_bind() */
106 _MALI_UK_UNBIND_MEM, /**< _mali_ukk_mem_unbind() */
107 _MALI_UK_COW_MEM, /**< _mali_ukk_mem_cow() */
108 _MALI_UK_COW_MODIFY_RANGE, /**< _mali_ukk_mem_cow_modify_range() */
109 _MALI_UK_RESIZE_MEM, /**<._mali_ukk_mem_resize() */
110 _MALI_UK_QUERY_MMU_PAGE_TABLE_DUMP_SIZE, /**< _mali_ukk_mem_get_mmu_page_table_dump_size() */
111 _MALI_UK_DUMP_MMU_PAGE_TABLE, /**< _mali_ukk_mem_dump_mmu_page_table() */
112 _MALI_UK_DMA_BUF_GET_SIZE, /**< _mali_ukk_dma_buf_get_size() */
113 _MALI_UK_MEM_WRITE_SAFE, /**< _mali_uku_mem_write_safe() */
115 /** Common functions for each core */
117 _MALI_UK_START_JOB = 0, /**< Start a Fragment/Vertex Processor Job on a core */
118 _MALI_UK_GET_NUMBER_OF_CORES, /**< Get the number of Fragment/Vertex Processor cores */
119 _MALI_UK_GET_CORE_VERSION, /**< Get the Fragment/Vertex Processor version compatible with all cores */
121 /** Fragment Processor Functions */
123 _MALI_UK_PP_START_JOB = _MALI_UK_START_JOB, /**< _mali_ukk_pp_start_job() */
124 _MALI_UK_GET_PP_NUMBER_OF_CORES = _MALI_UK_GET_NUMBER_OF_CORES, /**< _mali_ukk_get_pp_number_of_cores() */
125 _MALI_UK_GET_PP_CORE_VERSION = _MALI_UK_GET_CORE_VERSION, /**< _mali_ukk_get_pp_core_version() */
126 _MALI_UK_PP_DISABLE_WB, /**< _mali_ukk_pp_job_disable_wb() */
127 _MALI_UK_PP_AND_GP_START_JOB, /**< _mali_ukk_pp_and_gp_start_job() */
129 /** Vertex Processor Functions */
131 _MALI_UK_GP_START_JOB = _MALI_UK_START_JOB, /**< _mali_ukk_gp_start_job() */
132 _MALI_UK_GET_GP_NUMBER_OF_CORES = _MALI_UK_GET_NUMBER_OF_CORES, /**< _mali_ukk_get_gp_number_of_cores() */
133 _MALI_UK_GET_GP_CORE_VERSION = _MALI_UK_GET_CORE_VERSION, /**< _mali_ukk_get_gp_core_version() */
134 _MALI_UK_GP_SUSPEND_RESPONSE, /**< _mali_ukk_gp_suspend_response() */
136 /** Profiling functions */
138 _MALI_UK_PROFILING_ADD_EVENT = 0, /**< __mali_uku_profiling_add_event() */
139 _MALI_UK_PROFILING_REPORT_SW_COUNTERS,/**< __mali_uku_profiling_report_sw_counters() */
140 _MALI_UK_PROFILING_MEMORY_USAGE_GET, /**< __mali_uku_profiling_memory_usage_get() */
141 _MALI_UK_PROFILING_STREAM_FD_GET, /** < __mali_uku_profiling_stream_fd_get() */
142 _MALI_UK_PROFILING_CONTROL_SET, /** < __mali_uku_profiling_control_set() */
144 /** VSYNC reporting fuctions */
145 _MALI_UK_VSYNC_EVENT_REPORT = 0, /**< _mali_ukk_vsync_event_report() */
146 } _mali_uk_functions;
148 /** @defgroup _mali_uk_getsysteminfo U/K Get System Info
152 * Type definition for the core version number.
153 * Used when returning the version number read from a core
155 * Its format is that of the 32-bit Version register for a particular core.
156 * Refer to the "Mali200 and MaliGP2 3D Graphics Processor Technical Reference
157 * Manual", ARM DDI 0415C, for more information.
159 typedef u32 _mali_core_version;
161 /** @} */ /* end group _mali_uk_core */
164 /** @defgroup _mali_uk_gp U/K Vertex Processor
167 /** @defgroup _mali_uk_gp_suspend_response_s Vertex Processor Suspend Response
170 /** @brief Arguments for _mali_ukk_gp_suspend_response()
172 * When _mali_wait_for_notification() receives notification that a
173 * Vertex Processor job was suspended, you need to send a response to indicate
174 * what needs to happen with this job. You can either abort or resume the job.
176 * - set @c code to indicate response code. This is either @c _MALIGP_JOB_ABORT or
177 * @c _MALIGP_JOB_RESUME_WITH_NEW_HEAP to indicate you will provide a new heap
178 * for the job that will resolve the out of memory condition for the job.
179 * - copy the @c cookie value from the @c _mali_uk_gp_job_suspended_s notification;
180 * this is an identifier for the suspended job
181 * - set @c arguments[0] and @c arguments[1] to zero if you abort the job. If
182 * you resume it, @c argument[0] should specify the Mali start address for the new
183 * heap and @c argument[1] the Mali end address of the heap.
184 * - pass in the user-kernel context @c ctx that was returned from _mali_ukk_open()
187 typedef enum _maligp_job_suspended_response_code {
188 _MALIGP_JOB_ABORT, /**< Abort the Vertex Processor job */
189 _MALIGP_JOB_RESUME_WITH_NEW_HEAP /**< Resume the Vertex Processor job with a new heap */
190 } _maligp_job_suspended_response_code;
193 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
194 u32 cookie; /**< [in] cookie from the _mali_uk_gp_job_suspended_s notification */
195 _maligp_job_suspended_response_code code; /**< [in] abort or resume response code, see \ref _maligp_job_suspended_response_code */
196 u32 arguments[2]; /**< [in] 0 when aborting a job. When resuming a job, the Mali start and end address for a new heap to resume the job with */
197 } _mali_uk_gp_suspend_response_s;
199 /** @} */ /* end group _mali_uk_gp_suspend_response_s */
201 /** @defgroup _mali_uk_gpstartjob_s Vertex Processor Start Job
204 /** @brief Status indicating the result of the execution of a Vertex or Fragment processor job */
206 _MALI_UK_JOB_STATUS_END_SUCCESS = 1 << (16 + 0),
207 _MALI_UK_JOB_STATUS_END_OOM = 1 << (16 + 1),
208 _MALI_UK_JOB_STATUS_END_ABORT = 1 << (16 + 2),
209 _MALI_UK_JOB_STATUS_END_TIMEOUT_SW = 1 << (16 + 3),
210 _MALI_UK_JOB_STATUS_END_HANG = 1 << (16 + 4),
211 _MALI_UK_JOB_STATUS_END_SEG_FAULT = 1 << (16 + 5),
212 _MALI_UK_JOB_STATUS_END_ILLEGAL_JOB = 1 << (16 + 6),
213 _MALI_UK_JOB_STATUS_END_UNKNOWN_ERR = 1 << (16 + 7),
214 _MALI_UK_JOB_STATUS_END_SHUTDOWN = 1 << (16 + 8),
215 _MALI_UK_JOB_STATUS_END_SYSTEM_UNUSABLE = 1 << (16 + 9)
216 } _mali_uk_job_status;
218 #define MALIGP2_NUM_REGS_FRAME (6)
220 /** @brief Arguments for _mali_ukk_gp_start_job()
222 * To start a Vertex Processor job
223 * - associate the request with a reference to a @c mali_gp_job_info by setting
224 * user_job_ptr to the address of the @c mali_gp_job_info of the job.
225 * - set @c priority to the priority of the @c mali_gp_job_info
226 * - specify a timeout for the job by setting @c watchdog_msecs to the number of
227 * milliseconds the job is allowed to run. Specifying a value of 0 selects the
228 * default timeout in use by the device driver.
229 * - copy the frame registers from the @c mali_gp_job_info into @c frame_registers.
230 * - set the @c perf_counter_flag, @c perf_counter_src0 and @c perf_counter_src1 to zero
231 * for a non-instrumented build. For an instrumented build you can use up
232 * to two performance counters. Set the corresponding bit in @c perf_counter_flag
233 * to enable them. @c perf_counter_src0 and @c perf_counter_src1 specify
234 * the source of what needs to get counted (e.g. number of vertex loader
235 * cache hits). For source id values, see ARM DDI0415A, Table 3-60.
236 * - pass in the user-kernel context @c ctx that was returned from _mali_ukk_open()
238 * When @c _mali_ukk_gp_start_job() returns @c _MALI_OSK_ERR_OK, status contains the
239 * result of the request (see \ref _mali_uk_start_job_status). If the job could
240 * not get started (@c _MALI_UK_START_JOB_NOT_STARTED_DO_REQUEUE) it should be
243 * After the job has started, @c _mali_wait_for_notification() will be notified
244 * that the job finished or got suspended. It may get suspended due to
245 * resource shortage. If it finished (see _mali_ukk_wait_for_notification())
246 * the notification will contain a @c _mali_uk_gp_job_finished_s result. If
247 * it got suspended the notification will contain a @c _mali_uk_gp_job_suspended_s
250 * The @c _mali_uk_gp_job_finished_s contains the job status (see \ref _mali_uk_job_status),
251 * the number of milliseconds the job took to render, and values of core registers
252 * when the job finished (irq status, performance counters, renderer list
253 * address). A job has finished succesfully when its status is
254 * @c _MALI_UK_JOB_STATUS_FINISHED. If the hardware detected a timeout while rendering
255 * the job, or software detected the job is taking more than watchdog_msecs to
256 * complete, the status will indicate @c _MALI_UK_JOB_STATUS_HANG.
257 * If the hardware detected a bus error while accessing memory associated with the
258 * job, status will indicate @c _MALI_UK_JOB_STATUS_SEG_FAULT.
259 * status will indicate @c _MALI_UK_JOB_STATUS_NOT_STARTED if the driver had to
260 * stop the job but the job didn't start on the hardware yet, e.g. when the
263 * In case the job got suspended, @c _mali_uk_gp_job_suspended_s contains
264 * the @c user_job_ptr identifier used to start the job with, the @c reason
265 * why the job stalled (see \ref _maligp_job_suspended_reason) and a @c cookie
266 * to identify the core on which the job stalled. This @c cookie will be needed
267 * when responding to this nofication by means of _mali_ukk_gp_suspend_response().
268 * (see _mali_ukk_gp_suspend_response()). The response is either to abort or
269 * resume the job. If the job got suspended due to an out of memory condition
270 * you may be able to resolve this by providing more memory and resuming the job.
274 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
275 u64 user_job_ptr; /**< [in] identifier for the job in user space, a @c mali_gp_job_info* */
276 u32 priority; /**< [in] job priority. A lower number means higher priority */
277 u32 frame_registers[MALIGP2_NUM_REGS_FRAME]; /**< [in] core specific registers associated with this job */
278 u32 perf_counter_flag; /**< [in] bitmask indicating which performance counters to enable, see \ref _MALI_PERFORMANCE_COUNTER_FLAG_SRC0_ENABLE and related macro definitions */
279 u32 perf_counter_src0; /**< [in] source id for performance counter 0 (see ARM DDI0415A, Table 3-60) */
280 u32 perf_counter_src1; /**< [in] source id for performance counter 1 (see ARM DDI0415A, Table 3-60) */
281 u32 frame_builder_id; /**< [in] id of the originating frame builder */
282 u32 flush_id; /**< [in] flush id within the originating frame builder */
283 _mali_uk_fence_t fence; /**< [in] fence this job must wait on */
284 u64 timeline_point_ptr; /**< [in,out] pointer to u32: location where point on gp timeline for this job will be written */
285 u32 varying_memsize; /** < [in] size of varying memory to use deffer bind*/
286 u32 varying_alloc_num;
287 u64 varying_alloc_list; /** < [in] memory hanlde list of varying buffer to use deffer bind */
288 } _mali_uk_gp_start_job_s;
290 #define _MALI_PERFORMANCE_COUNTER_FLAG_SRC0_ENABLE (1<<0) /**< Enable performance counter SRC0 for a job */
291 #define _MALI_PERFORMANCE_COUNTER_FLAG_SRC1_ENABLE (1<<1) /**< Enable performance counter SRC1 for a job */
292 #define _MALI_PERFORMANCE_COUNTER_FLAG_HEATMAP_ENABLE (1<<2) /**< Enable per tile (aka heatmap) generation with for a job (using the enabled counter sources) */
294 /** @} */ /* end group _mali_uk_gpstartjob_s */
297 u64 user_job_ptr; /**< [out] identifier for the job in user space */
298 _mali_uk_job_status status; /**< [out] status of finished job */
299 u32 heap_current_addr; /**< [out] value of the GP PLB PL heap start address register */
300 u32 perf_counter0; /**< [out] value of performance counter 0 (see ARM DDI0415A) */
301 u32 perf_counter1; /**< [out] value of performance counter 1 (see ARM DDI0415A) */
302 u32 pending_big_job_num;
303 } _mali_uk_gp_job_finished_s;
306 u64 user_job_ptr; /**< [out] identifier for the job in user space */
307 u32 cookie; /**< [out] identifier for the core in kernel space on which the job stalled */
308 } _mali_uk_gp_job_suspended_s;
310 /** @} */ /* end group _mali_uk_gp */
313 /** @defgroup _mali_uk_pp U/K Fragment Processor
316 #define _MALI_PP_MAX_SUB_JOBS 8
318 #define _MALI_PP_MAX_FRAME_REGISTERS ((0x058/4)+1)
320 #define _MALI_PP_MAX_WB_REGISTERS ((0x02C/4)+1)
322 #define _MALI_DLBU_MAX_REGISTERS 4
324 /** Flag for _mali_uk_pp_start_job_s */
325 #define _MALI_PP_JOB_FLAG_NO_NOTIFICATION (1<<0)
326 #define _MALI_PP_JOB_FLAG_IS_WINDOW_SURFACE (1<<1)
328 /** @defgroup _mali_uk_ppstartjob_s Fragment Processor Start Job
331 /** @brief Arguments for _mali_ukk_pp_start_job()
333 * To start a Fragment Processor job
334 * - associate the request with a reference to a mali_pp_job by setting
335 * @c user_job_ptr to the address of the @c mali_pp_job of the job.
336 * - set @c priority to the priority of the mali_pp_job
337 * - specify a timeout for the job by setting @c watchdog_msecs to the number of
338 * milliseconds the job is allowed to run. Specifying a value of 0 selects the
339 * default timeout in use by the device driver.
340 * - copy the frame registers from the @c mali_pp_job into @c frame_registers.
341 * For MALI200 you also need to copy the write back 0,1 and 2 registers.
342 * - set the @c perf_counter_flag, @c perf_counter_src0 and @c perf_counter_src1 to zero
343 * for a non-instrumented build. For an instrumented build you can use up
344 * to two performance counters. Set the corresponding bit in @c perf_counter_flag
345 * to enable them. @c perf_counter_src0 and @c perf_counter_src1 specify
346 * the source of what needs to get counted (e.g. number of vertex loader
347 * cache hits). For source id values, see ARM DDI0415A, Table 3-60.
348 * - pass in the user-kernel context in @c ctx that was returned from _mali_ukk_open()
350 * When _mali_ukk_pp_start_job() returns @c _MALI_OSK_ERR_OK, @c status contains the
351 * result of the request (see \ref _mali_uk_start_job_status). If the job could
352 * not get started (@c _MALI_UK_START_JOB_NOT_STARTED_DO_REQUEUE) it should be
355 * After the job has started, _mali_wait_for_notification() will be notified
356 * when the job finished. The notification will contain a
357 * @c _mali_uk_pp_job_finished_s result. It contains the @c user_job_ptr
358 * identifier used to start the job with, the job @c status (see \ref _mali_uk_job_status),
359 * the number of milliseconds the job took to render, and values of core registers
360 * when the job finished (irq status, performance counters, renderer list
361 * address). A job has finished succesfully when its status is
362 * @c _MALI_UK_JOB_STATUS_FINISHED. If the hardware detected a timeout while rendering
363 * the job, or software detected the job is taking more than @c watchdog_msecs to
364 * complete, the status will indicate @c _MALI_UK_JOB_STATUS_HANG.
365 * If the hardware detected a bus error while accessing memory associated with the
366 * job, status will indicate @c _MALI_UK_JOB_STATUS_SEG_FAULT.
367 * status will indicate @c _MALI_UK_JOB_STATUS_NOT_STARTED if the driver had to
368 * stop the job but the job didn't start on the hardware yet, e.g. when the
373 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
374 u64 user_job_ptr; /**< [in] identifier for the job in user space */
375 u32 priority; /**< [in] job priority. A lower number means higher priority */
376 u32 frame_registers[_MALI_PP_MAX_FRAME_REGISTERS]; /**< [in] core specific registers associated with first sub job, see ARM DDI0415A */
377 u32 frame_registers_addr_frame[_MALI_PP_MAX_SUB_JOBS - 1]; /**< [in] ADDR_FRAME registers for sub job 1-7 */
378 u32 frame_registers_addr_stack[_MALI_PP_MAX_SUB_JOBS - 1]; /**< [in] ADDR_STACK registers for sub job 1-7 */
379 u32 wb0_registers[_MALI_PP_MAX_WB_REGISTERS];
380 u32 wb1_registers[_MALI_PP_MAX_WB_REGISTERS];
381 u32 wb2_registers[_MALI_PP_MAX_WB_REGISTERS];
382 u32 dlbu_registers[_MALI_DLBU_MAX_REGISTERS]; /**< [in] Dynamic load balancing unit registers */
383 u32 num_cores; /**< [in] Number of cores to set up (valid range: 1-8(M450) or 4(M400)) */
384 u32 perf_counter_flag; /**< [in] bitmask indicating which performance counters to enable, see \ref _MALI_PERFORMANCE_COUNTER_FLAG_SRC0_ENABLE and related macro definitions */
385 u32 perf_counter_src0; /**< [in] source id for performance counter 0 (see ARM DDI0415A, Table 3-60) */
386 u32 perf_counter_src1; /**< [in] source id for performance counter 1 (see ARM DDI0415A, Table 3-60) */
387 u32 frame_builder_id; /**< [in] id of the originating frame builder */
388 u32 flush_id; /**< [in] flush id within the originating frame builder */
389 u32 flags; /**< [in] See _MALI_PP_JOB_FLAG_* for a list of avaiable flags */
390 u32 tilesx; /**< [in] number of tiles in the x direction (needed for heatmap generation */
391 u32 tilesy; /**< [in] number of tiles in y direction (needed for reading the heatmap memory) */
392 u32 heatmap_mem; /**< [in] memory address to store counter values per tile (aka heatmap) */
393 u32 num_memory_cookies; /**< [in] number of memory cookies attached to job */
394 u64 memory_cookies; /**< [in] pointer to array of u32 memory cookies attached to job */
395 _mali_uk_fence_t fence; /**< [in] fence this job must wait on */
396 u64 timeline_point_ptr; /**< [in,out] pointer to location of u32 where point on pp timeline for this job will be written */
397 } _mali_uk_pp_start_job_s;
400 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
401 u64 gp_args; /**< [in,out] GP uk arguments (see _mali_uk_gp_start_job_s) */
402 u64 pp_args; /**< [in,out] PP uk arguments (see _mali_uk_pp_start_job_s) */
403 } _mali_uk_pp_and_gp_start_job_s;
405 /** @} */ /* end group _mali_uk_ppstartjob_s */
408 u64 user_job_ptr; /**< [out] identifier for the job in user space */
409 _mali_uk_job_status status; /**< [out] status of finished job */
410 u32 perf_counter0[_MALI_PP_MAX_SUB_JOBS]; /**< [out] value of perfomance counter 0 (see ARM DDI0415A), one for each sub job */
411 u32 perf_counter1[_MALI_PP_MAX_SUB_JOBS]; /**< [out] value of perfomance counter 1 (see ARM DDI0415A), one for each sub job */
412 u32 perf_counter_src0;
413 u32 perf_counter_src1;
414 } _mali_uk_pp_job_finished_s;
417 u32 number_of_enabled_cores; /**< [out] the new number of enabled cores */
418 } _mali_uk_pp_num_cores_changed_s;
423 * Flags to indicate write-back units
426 _MALI_UK_PP_JOB_WB0 = 1,
427 _MALI_UK_PP_JOB_WB1 = 2,
428 _MALI_UK_PP_JOB_WB2 = 4,
429 } _mali_uk_pp_job_wbx_flag;
432 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
433 u32 fb_id; /**< [in] Frame builder ID of job to disable WB units for */
437 } _mali_uk_pp_disable_wb_s;
440 /** @} */ /* end group _mali_uk_pp */
442 /** @defgroup _mali_uk_soft_job U/K Soft Job
446 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
447 u64 user_job; /**< [in] identifier for the job in user space */
448 u64 job_id_ptr; /**< [in,out] pointer to location of u32 where job id will be written */
449 _mali_uk_fence_t fence; /**< [in] fence this job must wait on */
450 u32 point; /**< [out] point on soft timeline for this job */
451 u32 type; /**< [in] type of soft job */
452 } _mali_uk_soft_job_start_s;
455 u64 user_job; /**< [out] identifier for the job in user space */
456 } _mali_uk_soft_job_activated_s;
459 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
460 u32 job_id; /**< [in] id for soft job */
461 } _mali_uk_soft_job_signal_s;
463 /** @} */ /* end group _mali_uk_soft_job */
469 } _mali_uk_annotate_profiling_mem_counter_s;
474 } _mali_uk_annotate_profiling_enable_s;
477 /** @addtogroup _mali_uk_core U/K Core
480 /** @defgroup _mali_uk_waitfornotification_s Wait For Notification
483 /** @brief Notification type encodings
485 * Each Notification type is an ordered pair of (subsystem,id), and is unique.
487 * The encoding of subsystem,id into a 32-bit word is:
488 * encoding = (( subsystem << _MALI_NOTIFICATION_SUBSYSTEM_SHIFT ) & _MALI_NOTIFICATION_SUBSYSTEM_MASK)
489 * | (( id << _MALI_NOTIFICATION_ID_SHIFT ) & _MALI_NOTIFICATION_ID_MASK)
491 * @see _mali_uk_wait_for_notification_s
494 /** core notifications */
496 _MALI_NOTIFICATION_CORE_SHUTDOWN_IN_PROGRESS = (_MALI_UK_CORE_SUBSYSTEM << 16) | 0x20,
497 _MALI_NOTIFICATION_APPLICATION_QUIT = (_MALI_UK_CORE_SUBSYSTEM << 16) | 0x40,
498 _MALI_NOTIFICATION_SETTINGS_CHANGED = (_MALI_UK_CORE_SUBSYSTEM << 16) | 0x80,
499 _MALI_NOTIFICATION_SOFT_ACTIVATED = (_MALI_UK_CORE_SUBSYSTEM << 16) | 0x100,
501 /** Fragment Processor notifications */
503 _MALI_NOTIFICATION_PP_FINISHED = (_MALI_UK_PP_SUBSYSTEM << 16) | 0x10,
504 _MALI_NOTIFICATION_PP_NUM_CORE_CHANGE = (_MALI_UK_PP_SUBSYSTEM << 16) | 0x20,
506 /** Vertex Processor notifications */
508 _MALI_NOTIFICATION_GP_FINISHED = (_MALI_UK_GP_SUBSYSTEM << 16) | 0x10,
509 _MALI_NOTIFICATION_GP_STALLED = (_MALI_UK_GP_SUBSYSTEM << 16) | 0x20,
511 /** Profiling notifications */
512 _MALI_NOTIFICATION_ANNOTATE_PROFILING_MEM_COUNTER = (_MALI_UK_PROFILING_SUBSYSTEM << 16) | 0x10,
513 _MALI_NOTIFICATION_ANNOTATE_PROFILING_ENABLE = (_MALI_UK_PROFILING_SUBSYSTEM << 16) | 0x20,
514 } _mali_uk_notification_type;
516 /** to assist in splitting up 32-bit notification value in subsystem and id value */
517 #define _MALI_NOTIFICATION_SUBSYSTEM_MASK 0xFFFF0000
518 #define _MALI_NOTIFICATION_SUBSYSTEM_SHIFT 16
519 #define _MALI_NOTIFICATION_ID_MASK 0x0000FFFF
520 #define _MALI_NOTIFICATION_ID_SHIFT 0
523 /** @brief Enumeration of possible settings which match mali_setting_t in user space
528 _MALI_UK_USER_SETTING_SW_EVENTS_ENABLE = 0,
529 _MALI_UK_USER_SETTING_COLORBUFFER_CAPTURE_ENABLED,
530 _MALI_UK_USER_SETTING_DEPTHBUFFER_CAPTURE_ENABLED,
531 _MALI_UK_USER_SETTING_STENCILBUFFER_CAPTURE_ENABLED,
532 _MALI_UK_USER_SETTING_PER_TILE_COUNTERS_CAPTURE_ENABLED,
533 _MALI_UK_USER_SETTING_BUFFER_CAPTURE_COMPOSITOR,
534 _MALI_UK_USER_SETTING_BUFFER_CAPTURE_WINDOW,
535 _MALI_UK_USER_SETTING_BUFFER_CAPTURE_OTHER,
536 _MALI_UK_USER_SETTING_BUFFER_CAPTURE_N_FRAMES,
537 _MALI_UK_USER_SETTING_BUFFER_CAPTURE_RESIZE_FACTOR,
538 _MALI_UK_USER_SETTING_SW_COUNTER_ENABLED,
539 _MALI_UK_USER_SETTING_MAX,
540 } _mali_uk_user_setting_t;
542 /* See mali_user_settings_db.c */
543 extern const char *_mali_uk_user_setting_descriptions[];
544 #define _MALI_UK_USER_SETTING_DESCRIPTIONS \
546 "sw_events_enable", \
547 "colorbuffer_capture_enable", \
548 "depthbuffer_capture_enable", \
549 "stencilbuffer_capture_enable", \
550 "per_tile_counters_enable", \
551 "buffer_capture_compositor", \
552 "buffer_capture_window", \
553 "buffer_capture_other", \
554 "buffer_capture_n_frames", \
555 "buffer_capture_resize_factor", \
556 "sw_counters_enable", \
559 /** @brief struct to hold the value to a particular setting as seen in the kernel space
562 _mali_uk_user_setting_t setting;
564 } _mali_uk_settings_changed_s;
566 /** @brief Arguments for _mali_ukk_wait_for_notification()
568 * On successful return from _mali_ukk_wait_for_notification(), the members of
569 * this structure will indicate the reason for notification.
571 * Specifically, the source of the notification can be identified by the
572 * subsystem and id fields of the mali_uk_notification_type in the code.type
573 * member. The type member is encoded in a way to divide up the types into a
574 * subsystem field, and a per-subsystem ID field. See
575 * _mali_uk_notification_type for more information.
577 * Interpreting the data union member depends on the notification type:
579 * - type == _MALI_NOTIFICATION_CORE_SHUTDOWN_IN_PROGRESS
580 * - The kernel side is shutting down. No further
581 * _mali_uk_wait_for_notification() calls should be made.
582 * - In this case, the value of the data union member is undefined.
583 * - This is used to indicate to the user space client that it should close
584 * the connection to the Mali Device Driver.
585 * - type == _MALI_NOTIFICATION_PP_FINISHED
586 * - The notification data is of type _mali_uk_pp_job_finished_s. It contains the user_job_ptr
587 * identifier used to start the job with, the job status, the number of milliseconds the job took to render,
588 * and values of core registers when the job finished (irq status, performance counters, renderer list
590 * - A job has finished succesfully when its status member is _MALI_UK_JOB_STATUS_FINISHED.
591 * - If the hardware detected a timeout while rendering the job, or software detected the job is
592 * taking more than watchdog_msecs (see _mali_ukk_pp_start_job()) to complete, the status member will
593 * indicate _MALI_UK_JOB_STATUS_HANG.
594 * - If the hardware detected a bus error while accessing memory associated with the job, status will
595 * indicate _MALI_UK_JOB_STATUS_SEG_FAULT.
596 * - Status will indicate MALI_UK_JOB_STATUS_NOT_STARTED if the driver had to stop the job but the job
597 * didn't start the hardware yet, e.g. when the driver closes.
598 * - type == _MALI_NOTIFICATION_GP_FINISHED
599 * - The notification data is of type _mali_uk_gp_job_finished_s. The notification is similar to that of
600 * type == _MALI_NOTIFICATION_PP_FINISHED, except that several other GP core register values are returned.
601 * The status values have the same meaning for type == _MALI_NOTIFICATION_PP_FINISHED.
602 * - type == _MALI_NOTIFICATION_GP_STALLED
603 * - The nofication data is of type _mali_uk_gp_job_suspended_s. It contains the user_job_ptr
604 * identifier used to start the job with, the reason why the job stalled and a cookie to identify the core on
605 * which the job stalled.
606 * - The reason member of gp_job_suspended is set to _MALIGP_JOB_SUSPENDED_OUT_OF_MEMORY
607 * when the polygon list builder unit has run out of memory.
610 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
611 _mali_uk_notification_type type; /**< [out] Type of notification available */
613 _mali_uk_gp_job_suspended_s gp_job_suspended;/**< [out] Notification data for _MALI_NOTIFICATION_GP_STALLED notification type */
614 _mali_uk_gp_job_finished_s gp_job_finished; /**< [out] Notification data for _MALI_NOTIFICATION_GP_FINISHED notification type */
615 _mali_uk_pp_job_finished_s pp_job_finished; /**< [out] Notification data for _MALI_NOTIFICATION_PP_FINISHED notification type */
616 _mali_uk_settings_changed_s setting_changed;/**< [out] Notification data for _MALI_NOTIFICAATION_SETTINGS_CHANGED notification type */
617 _mali_uk_soft_job_activated_s soft_job_activated; /**< [out] Notification data for _MALI_NOTIFICATION_SOFT_ACTIVATED notification type */
618 _mali_uk_annotate_profiling_mem_counter_s profiling_mem_counter;
619 _mali_uk_annotate_profiling_enable_s profiling_enable;
621 } _mali_uk_wait_for_notification_s;
623 /** @brief Arguments for _mali_ukk_post_notification()
625 * Posts the specified notification to the notification queue for this application.
626 * This is used to send a quit message to the callback thread.
629 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
630 _mali_uk_notification_type type; /**< [in] Type of notification to post */
631 } _mali_uk_post_notification_s;
633 /** @} */ /* end group _mali_uk_waitfornotification_s */
635 /** @defgroup _mali_uk_getapiversion_s Get API Version
638 /** helpers for Device Driver API version handling */
640 /** @brief Encode a version ID from a 16-bit input
642 * @note the input is assumed to be 16 bits. It must not exceed 16 bits. */
643 #define _MAKE_VERSION_ID(x) (((x) << 16UL) | (x))
645 /** @brief Check whether a 32-bit value is likely to be Device Driver API
647 #define _IS_VERSION_ID(x) (((x) & 0xFFFF) == (((x) >> 16UL) & 0xFFFF))
649 /** @brief Decode a 16-bit version number from a 32-bit Device Driver API version
651 #define _GET_VERSION(x) (((x) >> 16UL) & 0xFFFF)
653 /** @brief Determine whether two 32-bit encoded version IDs match */
654 #define _IS_API_MATCH(x, y) (IS_VERSION_ID((x)) && IS_VERSION_ID((y)) && (GET_VERSION((x)) == GET_VERSION((y))))
656 * RK MALI version code
658 #define _MALI_RK_LIBS_VERSION 1
661 * API version define.
662 * Indicates the version of the kernel API
663 * The version is a 16bit integer incremented on each API change.
664 * The 16bit integer is stored twice in a 32bit integer
665 * For example, for version 1 the value would be 0x00010001
667 #define _MALI_API_VERSION 850
668 #define _MALI_UK_API_VERSION _MAKE_VERSION_ID(_MALI_API_VERSION)
671 * The API version is a 16-bit integer stored in both the lower and upper 16-bits
672 * of a 32-bit value. The 16-bit API version value is incremented on each API
673 * change. Version 1 would be 0x00010001. Used in _mali_uk_get_api_version_s.
675 typedef u32 _mali_uk_api_version;
677 /** @brief Arguments for _mali_uk_get_api_version()
679 * The user-side interface version must be written into the version member,
680 * encoded using _MAKE_VERSION_ID(). It will be compared to the API version of
681 * the kernel-side interface.
683 * On successful return, the version member will be the API version of the
684 * kernel-side interface. _MALI_UK_API_VERSION macro defines the current version
687 * The compatible member must be checked to see if the version of the user-side
688 * interface is compatible with the kernel-side interface, since future versions
689 * of the interface may be backwards compatible.
692 u32 ctx; /**< [in,out] user-kernel context (trashed on output) */
693 _mali_uk_api_version version; /**< [in,out] API version of user-side interface. */
694 int compatible; /**< [out] @c 1 when @version is compatible, @c 0 otherwise */
695 } _mali_uk_get_api_version_s;
697 /** @brief Arguments for _mali_uk_get_api_version_v2()
699 * The user-side interface version must be written into the version member,
700 * encoded using _MAKE_VERSION_ID(). It will be compared to the API version of
701 * the kernel-side interface.
703 * On successful return, the version member will be the API version of the
704 * kernel-side interface. _MALI_UK_API_VERSION macro defines the current version
707 * The compatible member must be checked to see if the version of the user-side
708 * interface is compatible with the kernel-side interface, since future versions
709 * of the interface may be backwards compatible.
712 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
713 _mali_uk_api_version version; /**< [in,out] API version of user-side interface. */
714 int compatible; /**< [out] @c 1 when @version is compatible, @c 0 otherwise */
715 } _mali_uk_get_api_version_v2_s;
719 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
720 _mali_uk_api_version version; /**< [in,out] API version of user-side interface. */
721 } _mali_uk_get_mali_version_in_rk30_s;
723 /* rk_ext : rk_ko_ver_t. */
725 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
726 _mali_uk_api_version version; /**< [in,out] API version of user-side interface. */
727 } _mali_rk_ko_version_s;
728 /** @} */ /* end group _mali_uk_getapiversion_s */
730 /** @defgroup _mali_uk_get_user_settings_s Get user space settings */
732 /** @brief struct to keep the matching values of the user space settings within certain context
734 * Each member of the settings array corresponds to a matching setting in the user space and its value is the value
735 * of that particular setting.
737 * All settings are given reference to the context pointed to by the ctx pointer.
741 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
742 u32 settings[_MALI_UK_USER_SETTING_MAX]; /**< [out] The values for all settings */
743 } _mali_uk_get_user_settings_s;
745 /** @brief struct to hold the value of a particular setting from the user space within a given context
748 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
749 _mali_uk_user_setting_t setting; /**< [in] setting to get */
750 u32 value; /**< [out] value of setting */
751 } _mali_uk_get_user_setting_s;
753 /** @brief Arguments for _mali_ukk_request_high_priority() */
755 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
756 } _mali_uk_request_high_priority_s;
758 /** @brief Arguments for _mali_ukk_pending_submit() */
760 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
761 } _mali_uk_pending_submit_s;
763 /** @} */ /* end group _mali_uk_core */
766 /** @defgroup _mali_uk_memory U/K Memory
769 #define _MALI_MEMORY_ALLOCATE_RESIZEABLE (1<<4) /* BUFFER can trim dow/grow*/
770 #define _MALI_MEMORY_ALLOCATE_NO_BIND_GPU (1<<5) /*Not map to GPU when allocate, must call bind later*/
771 #define _MALI_MEMORY_ALLOCATE_SWAPPABLE (1<<6) /* Allocate swappale memory. */
772 #define _MALI_MEMORY_ALLOCATE_DEFER_BIND (1<<7) /*Not map to GPU when allocate, must call bind later*/
776 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
777 u32 gpu_vaddr; /**< [in] GPU virtual address */
778 u32 vsize; /**< [in] vitrual size of the allocation */
779 u32 psize; /**< [in] physical size of the allocation */
781 u64 backend_handle; /**< [out] backend handle */
784 /* CPU read/write info*/
786 } _mali_uk_alloc_mem_s;
790 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
791 u32 gpu_vaddr; /**< [in] use as handle to free allocation */
792 u32 free_pages_nr; /** < [out] record the number of free pages */
793 } _mali_uk_free_mem_s;
796 #define _MALI_MEMORY_BIND_BACKEND_UMP (1<<8)
797 #define _MALI_MEMORY_BIND_BACKEND_DMA_BUF (1<<9)
798 #define _MALI_MEMORY_BIND_BACKEND_MALI_MEMORY (1<<10)
799 #define _MALI_MEMORY_BIND_BACKEND_EXTERNAL_MEMORY (1<<11)
800 #define _MALI_MEMORY_BIND_BACKEND_EXT_COW (1<<12)
801 #define _MALI_MEMORY_BIND_BACKEND_HAVE_ALLOCATION (1<<13)
804 #define _MALI_MEMORY_BIND_BACKEND_MASK (_MALI_MEMORY_BIND_BACKEND_UMP| \
805 _MALI_MEMORY_BIND_BACKEND_DMA_BUF |\
806 _MALI_MEMORY_BIND_BACKEND_MALI_MEMORY |\
807 _MALI_MEMORY_BIND_BACKEND_EXTERNAL_MEMORY |\
808 _MALI_MEMORY_BIND_BACKEND_EXT_COW |\
809 _MALI_MEMORY_BIND_BACKEND_HAVE_ALLOCATION)
812 #define _MALI_MEMORY_GPU_READ_ALLOCATE (1<<16)
816 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
817 u32 vaddr; /**< [in] mali address to map the physical memory to */
818 u32 size; /**< [in] size */
819 u32 flags; /**< [in] see_MALI_MEMORY_BIND_BACKEND_* */
820 u32 padding; /** padding for 32/64 struct alignment */
823 u32 secure_id; /**< [in] secure id */
824 u32 rights; /**< [in] rights necessary for accessing memory */
825 u32 flags; /**< [in] flags, see \ref _MALI_MAP_EXTERNAL_MAP_GUARD_PAGE */
828 u32 mem_fd; /**< [in] Memory descriptor */
829 u32 rights; /**< [in] rights necessary for accessing memory */
830 u32 flags; /**< [in] flags, see \ref _MALI_MAP_EXTERNAL_MAP_GUARD_PAGE */
836 u32 phys_addr; /**< [in] physical address */
837 u32 rights; /**< [in] rights necessary for accessing memory */
838 u32 flags; /**< [in] flags, see \ref _MALI_MAP_EXTERNAL_MAP_GUARD_PAGE */
841 } _mali_uk_bind_mem_s;
844 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
845 u32 flags; /**< [in] see_MALI_MEMORY_BIND_BACKEND_* */
846 u32 vaddr; /**< [in] identifier for mapped memory object in kernel space */
847 } _mali_uk_unbind_mem_s;
850 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
851 u32 target_handle; /**< [in] handle of allocation need to do COW */
852 u32 target_offset; /**< [in] offset in target allocation to do COW(for support COW a memory allocated from memory_bank, PAGE_SIZE align)*/
853 u32 target_size; /**< [in] size of target allocation to do COW (for support memory bank, PAGE_SIZE align)(in byte) */
854 u32 range_start; /**< [in] re allocate range start offset, offset from the start of allocation (PAGE_SIZE align)*/
855 u32 range_size; /**< [in] re allocate size (PAGE_SIZE align)*/
856 u32 vaddr; /**< [in] mali address for the new allocaiton */
857 u32 backend_handle; /**< [out] backend handle */
859 } _mali_uk_cow_mem_s;
862 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
863 u32 range_start; /**< [in] re allocate range start offset, offset from the start of allocation */
864 u32 size; /**< [in] re allocate size*/
865 u32 vaddr; /**< [in] mali address for the new allocaiton */
866 s32 change_pages_nr; /**< [out] record the page number change for cow operation */
867 } _mali_uk_cow_modify_range_s;
871 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
872 u32 mem_fd; /**< [in] Memory descriptor */
873 u32 size; /**< [out] size */
874 } _mali_uk_dma_buf_get_size_s;
876 /** Flag for _mali_uk_map_external_mem_s, _mali_uk_attach_ump_mem_s and _mali_uk_attach_dma_buf_s */
877 #define _MALI_MAP_EXTERNAL_MAP_GUARD_PAGE (1<<0)
881 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
882 u64 vaddr; /* the buffer to do resize*/
883 u32 psize; /* wanted physical size of this memory */
884 } _mali_uk_mem_resize_s;
887 * @brief Arguments for _mali_uk[uk]_mem_write_safe()
890 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
891 u64 src; /**< [in] Pointer to source data */
892 u64 dest; /**< [in] Destination Mali buffer */
893 u32 size; /**< [in,out] Number of bytes to write/copy on input, number of bytes actually written/copied on output */
894 } _mali_uk_mem_write_safe_s;
897 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
898 u32 size; /**< [out] size of MMU page table information (registers + page tables) */
899 } _mali_uk_query_mmu_page_table_dump_size_s;
902 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
903 u32 size; /**< [in] size of buffer to receive mmu page table information */
904 u64 buffer; /**< [in,out] buffer to receive mmu page table information */
905 u32 register_writes_size; /**< [out] size of MMU register dump */
906 u64 register_writes; /**< [out] pointer within buffer where MMU register dump is stored */
907 u32 page_table_dump_size; /**< [out] size of MMU page table dump */
908 u64 page_table_dump; /**< [out] pointer within buffer where MMU page table dump is stored */
909 } _mali_uk_dump_mmu_page_table_s;
911 /** @} */ /* end group _mali_uk_memory */
914 /** @addtogroup _mali_uk_pp U/K Fragment Processor
917 /** @brief Arguments for _mali_ukk_get_pp_number_of_cores()
919 * - pass in the user-kernel context @c ctx that was returned from _mali_ukk_open()
920 * - Upon successful return from _mali_ukk_get_pp_number_of_cores(), @c number_of_cores
921 * will contain the number of Fragment Processor cores in the system.
924 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
925 u32 number_of_total_cores; /**< [out] Total number of Fragment Processor cores in the system */
926 u32 number_of_enabled_cores; /**< [out] Number of enabled Fragment Processor cores */
927 } _mali_uk_get_pp_number_of_cores_s;
929 /** @brief Arguments for _mali_ukk_get_pp_core_version()
931 * - pass in the user-kernel context @c ctx that was returned from _mali_ukk_open()
932 * - Upon successful return from _mali_ukk_get_pp_core_version(), @c version contains
933 * the version that all Fragment Processor cores are compatible with.
936 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
937 _mali_core_version version; /**< [out] version returned from core, see \ref _mali_core_version */
939 } _mali_uk_get_pp_core_version_s;
941 /** @} */ /* end group _mali_uk_pp */
944 /** @addtogroup _mali_uk_gp U/K Vertex Processor
947 /** @brief Arguments for _mali_ukk_get_gp_number_of_cores()
949 * - pass in the user-kernel context @c ctx that was returned from _mali_ukk_open()
950 * - Upon successful return from _mali_ukk_get_gp_number_of_cores(), @c number_of_cores
951 * will contain the number of Vertex Processor cores in the system.
954 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
955 u32 number_of_cores; /**< [out] number of Vertex Processor cores in the system */
956 } _mali_uk_get_gp_number_of_cores_s;
958 /** @brief Arguments for _mali_ukk_get_gp_core_version()
960 * - pass in the user-kernel context @c ctx that was returned from _mali_ukk_open()
961 * - Upon successful return from _mali_ukk_get_gp_core_version(), @c version contains
962 * the version that all Vertex Processor cores are compatible with.
965 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
966 _mali_core_version version; /**< [out] version returned from core, see \ref _mali_core_version */
967 } _mali_uk_get_gp_core_version_s;
969 /** @} */ /* end group _mali_uk_gp */
972 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
973 u32 event_id; /**< [in] event id to register (see enum mali_profiling_events for values) */
974 u32 data[5]; /**< [in] event specific data */
975 } _mali_uk_profiling_add_event_s;
978 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
979 u32 memory_usage; /**< [out] total memory usage */
980 u32 vaddr; /**< [in] mali address for the cow allocaiton */
981 s32 change_pages_nr; /**< [out] record the page number change for cow operation */
982 } _mali_uk_profiling_memory_usage_get_s;
985 /** @addtogroup _mali_uk_memory U/K Memory
988 /** @brief Arguments to _mali_ukk_mem_mmap()
990 * Use of the phys_addr member depends on whether the driver is compiled for
991 * Mali-MMU or nonMMU:
992 * - in the nonMMU case, this is the physical address of the memory as seen by
993 * the CPU (which may be a constant offset from that used by Mali)
994 * - in the MMU case, this is the Mali Virtual base address of the memory to
995 * allocate, and the particular physical pages used to back the memory are
996 * entirely determined by _mali_ukk_mem_mmap(). The details of the physical pages
997 * are not reported to user-space for security reasons.
999 * The cookie member must be stored for use later when freeing the memory by
1000 * calling _mali_ukk_mem_munmap(). In the Mali-MMU case, the cookie is secure.
1002 * The ukk_private word must be set to zero when calling from user-space. On
1003 * Kernel-side, the OS implementation of the U/K interface can use it to
1004 * communicate data to the OS implementation of the OSK layer. In particular,
1005 * _mali_ukk_get_big_block() directly calls _mali_ukk_mem_mmap directly, and
1006 * will communicate its own ukk_private word through the ukk_private member
1007 * here. The common code itself will not inspect or modify the ukk_private
1008 * word, and so it may be safely used for whatever purposes necessary to
1009 * integrate Mali Memory handling into the OS.
1011 * The uku_private member is currently reserved for use by the user-side
1012 * implementation of the U/K interface. Its value must be zero.
1015 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1016 void *mapping; /**< [out] Returns user-space virtual address for the mapping */
1017 u32 size; /**< [in] Size of the requested mapping */
1018 u32 phys_addr; /**< [in] Physical address - could be offset, depending on caller+callee convention */
1019 mali_bool writeable;
1020 } _mali_uk_mem_mmap_s;
1022 /** @brief Arguments to _mali_ukk_mem_munmap()
1024 * The cookie and mapping members must be that returned from the same previous
1025 * call to _mali_ukk_mem_mmap(). The size member must correspond to cookie
1026 * and mapping - that is, it must be the value originally supplied to a call to
1027 * _mali_ukk_mem_mmap that returned the values of mapping and cookie.
1029 * An error will be returned if an attempt is made to unmap only part of the
1030 * originally obtained range, or to unmap more than was originally obtained.
1033 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1034 void *mapping; /**< [in] The mapping returned from mmap call */
1035 u32 size; /**< [in] The size passed to mmap call */
1036 } _mali_uk_mem_munmap_s;
1037 /** @} */ /* end group _mali_uk_memory */
1039 /** @defgroup _mali_uk_vsync U/K VSYNC Wait Reporting Module
1042 /** @brief VSYNC events
1044 * These events are reported when DDK starts to wait for vsync and when the
1045 * vsync has occured and the DDK can continue on the next frame.
1047 typedef enum _mali_uk_vsync_event {
1048 _MALI_UK_VSYNC_EVENT_BEGIN_WAIT = 0,
1049 _MALI_UK_VSYNC_EVENT_END_WAIT
1050 } _mali_uk_vsync_event;
1052 /** @brief Arguments to _mali_ukk_vsync_event()
1056 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1057 _mali_uk_vsync_event event; /**< [in] VSYNCH event type */
1058 } _mali_uk_vsync_event_report_s;
1060 /** @} */ /* end group _mali_uk_vsync */
1062 /** @defgroup _mali_uk_sw_counters_report U/K Software Counter Reporting
1065 /** @brief Software counter values
1067 * Values recorded for each of the software counters during a single renderpass.
1070 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1071 u64 counters; /**< [in] The array of u32 counter values */
1072 u32 num_counters; /**< [in] The number of elements in counters array */
1073 } _mali_uk_sw_counters_report_s;
1075 /** @} */ /* end group _mali_uk_sw_counters_report */
1077 /** @defgroup _mali_uk_timeline U/K Mali Timeline
1081 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1082 u32 timeline; /**< [in] timeline id */
1083 u32 point; /**< [out] latest point on timeline */
1084 } _mali_uk_timeline_get_latest_point_s;
1087 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1088 _mali_uk_fence_t fence; /**< [in] fence */
1089 u32 timeout; /**< [in] timeout (0 for no wait, -1 for blocking) */
1090 u32 status; /**< [out] status of fence (1 if signaled, 0 if timeout) */
1091 } _mali_uk_timeline_wait_s;
1094 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1095 _mali_uk_fence_t fence; /**< [in] mali fence to create linux sync fence from */
1096 s32 sync_fd; /**< [out] file descriptor for new linux sync fence */
1097 } _mali_uk_timeline_create_sync_fence_s;
1099 /** @} */ /* end group _mali_uk_timeline */
1101 /** @} */ /* end group u_k_api */
1103 /** @} */ /* end group uddapi */
1106 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1107 s32 stream_fd; /**< [in] The profiling kernel base stream fd handle */
1108 } _mali_uk_profiling_stream_fd_get_s;
1111 u64 ctx; /**< [in,out] user-kernel context (trashed on output) */
1112 u64 control_packet_data; /**< [in] the control packet data for control settings */
1113 u32 control_packet_size; /**< [in] The control packet size */
1114 u64 response_packet_data; /** < [out] The response packet data */
1115 u32 response_packet_size; /** < [in,out] The response packet data */
1116 } _mali_uk_profiling_control_set_s;
1122 #endif /* __MALI_UTGARD_UK_TYPES_H__ */