1 /**************************************************************************
5 * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
7 * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
8 * JinYoung Jeon <jy0.jeon@samsung.com>,
9 * Taeheon Kim <th908.kim@samsung.com>,
10 * YoungJun Cho <yj44.cho@samsung.com>,
11 * SooChan Lim <sc1.lim@samsung.com>,
12 * Boram Park <sc1.lim@samsung.com>
14 * Permission is hereby granted, free of charge, to any person obtaining a
15 * copy of this software and associated documentation files (the
16 * "Software"), to deal in the Software without restriction, including
17 * without limitation the rights to use, copy, modify, merge, publish,
18 * distribute, sub license, and/or sell copies of the Software, and to
19 * permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
27 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
29 * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
30 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
31 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
32 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 **************************************************************************/
40 #include <tbm_surface.h>
41 #include <tbm_surface_queue.h>
42 #include <tbm_surface_internal.h>
44 #include "tdm_types.h"
52 * @brief The header file for a frontend user.
55 * #include <tdm.h> //for a frontend user
60 * @brief The display capability enumeration
63 TDM_DISPLAY_CAPABILITY_PP = (1 << 0), /**< if hardware supports pp operation */
64 TDM_DISPLAY_CAPABILITY_CAPTURE = (1 << 1), /**< if hardware supports capture operation */
65 } tdm_display_capability;
68 * @brief The output change handler
69 * @details This handler will be called when the status of a output object is
72 typedef void (*tdm_output_change_handler)(tdm_output *output,
73 tdm_output_change_type type,
78 * @brief Initialize a display object
79 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
80 * @return A display object
81 * @see tdm_display_deinit
84 tdm_display_init(tdm_error *error);
87 * @brief Deinitialize a display object
88 * @param[in] dpy A display object
89 * @see tdm_display_init
92 tdm_display_deinit(tdm_display *dpy);
95 * @brief Update a display object
97 * When new output is connected, a frontend user need to call this function.
98 * And a frontend user can the new output information with tdm_output_get_xxx functions.
99 * @param[in] dpy A display object
100 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
103 tdm_display_update(tdm_display *dpy);
106 * @brief Get the file descriptor
107 * @details TDM handles the events of fd with #tdm_display_handle_events.
108 * @param[in] dpy A display object
109 * @param[out] fd The file descriptor
110 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
111 * @see tdm_display_handle_events
114 tdm_display_get_fd(tdm_display *dpy, int *fd);
117 * @brief Handle the events
118 * @param[in] dpy A display object
119 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
120 * @see tdm_display_get_fd
123 tdm_display_handle_events(tdm_display *dpy);
126 * @brief Get the information of the TDM backend module.
127 * @param[in] dpy A display object
128 * @param[out] name The name of the TDM backend module
129 * @param[out] vendor The vendor of the TDM backend module
130 * @param[out] version The version of the TDM backend module
131 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
134 tdm_display_get_backend_info(tdm_display *dpy, const char **name,
135 const char **vendor, int *major, int *minor);
138 * @brief Get the capabilities of a display object.
139 * @details A frontend user can get whether TDM supports pp/capture functionality with this function.
140 * @param[in] dpy A display object
141 * @param[out] capabilities The capabilities of a display object
142 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
145 tdm_display_get_capabilities(tdm_display *dpy,
146 tdm_display_capability *capabilities);
149 * @brief Get the pp capabilities of a display object.
150 * @param[in] dpy A display object
151 * @param[out] capabilities The pp capabilities
152 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
155 tdm_display_get_pp_capabilities(tdm_display *dpy,
156 tdm_pp_capability *capabilities);
159 * @brief Get the pp available format array of a display object.
160 * @param[in] dpy A display object
161 * @param[out] formats The pp available format array
162 * @param[out] count The count of formats
163 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
166 tdm_display_get_pp_available_formats(tdm_display *dpy,
167 const tbm_format **formats, int *count);
170 * @brief Get the pp available size of a display object.
171 * @details -1 means that a TDM backend module doesn't define the value.
172 * @param[in] dpy A display object
173 * @param[out] min_w The minimum width which TDM can handle
174 * @param[out] min_h The minimum height which TDM can handle
175 * @param[out] max_w The maximum width which TDM can handle
176 * @param[out] max_h The maximum height which TDM can handle
177 * @param[out] preferred_align The preferred align width which TDM can handle
178 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
181 tdm_display_get_pp_available_size(tdm_display *dpy, int *min_w, int *min_h,
182 int *max_w, int *max_h, int *preferred_align);
185 * @brief Get the capture capabilities of a display object.
186 * @param[in] dpy A display object
187 * @param[out] capabilities The capture capabilities
188 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
191 tdm_display_get_capture_capabilities(tdm_display *dpy,
192 tdm_capture_capability *capabilities);
195 * @brief Get the capture available format array of a display object.
196 * @param[in] dpy A display object
197 * @param[out] formats The capture available format array
198 * @param[out] count The count of formats
199 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
202 tdm_display_get_catpure_available_formats(tdm_display *dpy,
203 const tbm_format **formats, int *count);
206 * @brief Get the capture available size of a display object.
207 * @details -1 means that a TDM backend module doesn't define the value.
208 * @param[in] dpy A display object
209 * @param[out] min_w The minimum width which TDM can handle
210 * @param[out] min_h The minimum height which TDM can handle
211 * @param[out] max_w The maximum width which TDM can handle
212 * @param[out] max_h The maximum height which TDM can handle
213 * @param[out] preferred_align The preferred align width which TDM can handle
214 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
217 tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h,
218 int *max_w, int *max_h, int *preferred_align);
221 * @brief Get the max layer counts which a display object can show on screen.
222 * @details -1 means that a TDM backend module doesn't define the value.
223 * @param[in] dpy A display object
224 * @param[out] count The max count of layers
225 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
228 tdm_display_get_max_layer_count(tdm_display *dpy, int *max_count);
231 * @brief Get the output counts which a display object has.
232 * @param[in] dpy A display object
233 * @param[out] count The count of outputs
234 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
235 * @see tdm_display_get_output
238 tdm_display_get_output_count(tdm_display *dpy, int *count);
241 * @brief Get a output object which has the given index.
242 * @param[in] dpy A display object
243 * @param[in] index The index of a output object
244 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
245 * @return A output object if success. Otherwise, NULL.
246 * @see tdm_display_get_output_count
249 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
252 * @brief Create a pp object.
253 * @param[in] dpy A display object
254 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
255 * @return A pp object if success. Otherwise, NULL.
256 * @see tdm_pp_destroy
259 tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
262 * @brief Get the capabilities of a output object.
263 * @param[in] output A output object
264 * @param[out] capabilities The capabilities of a output object
265 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
268 tdm_output_get_capabilities(tdm_output *output,
269 tdm_output_capability *capabilities);
272 * @brief Get the model information of a output object.
273 * @param[in] output A output object
274 * @param[out] maker The output maker.
275 * @param[out] model The output model.
276 * @param[out] name The output name.
277 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
280 tdm_output_get_model_info(tdm_output *output, const char **maker,
281 const char **model, const char **name);
284 * @brief Get the connection status of a output object.
285 * @param[in] output A output object
286 * @param[out] status The connection status.
287 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
290 tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
293 * @brief Add a output change handler
294 * @details The handler will be called when the status of a
295 * output object is changed. connection, DPMS, etc.
296 * @param[in] output A output object
297 * @param[in] func A output change handler
298 * @param[in] user_data The user data
299 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
302 tdm_output_add_change_handler(tdm_output *output,
303 tdm_output_change_handler func,
307 * @brief Remove a output change handler
308 * @param[in] output A output object
309 * @param[in] func A output change handler
310 * @param[in] user_data The user data
311 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
314 tdm_output_remove_change_handler(tdm_output *output,
315 tdm_output_change_handler func,
319 * @brief Get the connection type of a output object.
320 * @param[in] output A output object
321 * @param[out] type The connection type.
322 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
325 tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
328 * @brief Get the layer counts which a output object has.
329 * @param[in] output A output object
330 * @param[out] count The count of layers
331 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
332 * @see tdm_output_get_layer
335 tdm_output_get_layer_count(tdm_output *output, int *count);
338 * @brief Get a layer object which has the given index.
339 * @param[in] output A output object
340 * @param[in] index The index of a layer object
341 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
342 * @return A layer object if success. Otherwise, NULL.
343 * @see tdm_output_get_layer_count
346 tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
349 * @brief Get the available property array of a output object.
350 * @param[in] output A output object
351 * @param[out] props The available property array
352 * @param[out] count The count of properties
353 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
356 tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
360 * @brief Get the available mode array of a output object.
361 * @param[in] output A output object
362 * @param[out] modes The available mode array
363 * @param[out] count The count of modes
364 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
367 tdm_output_get_available_modes(tdm_output *output,
368 const tdm_output_mode **modes, int *count);
371 * @brief Get the available size of a output object.
372 * @details -1 means that a TDM backend module doesn't define the value.
373 * @param[in] output A output object
374 * @param[out] min_w The minimum width which TDM can handle
375 * @param[out] min_h The minimum height which TDM can handle
376 * @param[out] max_w The maximum width which TDM can handle
377 * @param[out] max_h The maximum height which TDM can handle
378 * @param[out] preferred_align The preferred align width which TDM can handle
379 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
382 tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
383 int *max_w, int *max_h, int *preferred_align);
386 * @brief Get the available cursor size of a output object.
387 * @details -1 means that a TDM backend module doesn't define the value.
388 * @param[in] output A output object
389 * @param[out] min_w The minimum width which TDM can handle
390 * @param[out] min_h The minimum height which TDM can handle
391 * @param[out] max_w The maximum width which TDM can handle
392 * @param[out] max_h The maximum height which TDM can handle
393 * @param[out] preferred_align The preferred align width which TDM can handle
394 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
397 tdm_output_get_cursor_available_size(tdm_output *output, int *min_w, int *min_h,
398 int *max_w, int *max_h, int *preferred_align);
401 * @brief Get the physical size of a output object.
402 * @param[in] output A output object
403 * @param[out] mmWidth The milimeter width
404 * @param[out] mmHeight The milimeter height
405 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
408 tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
409 unsigned int *mmHeight);
412 * @brief Get the subpixel of a output object.
413 * @param[in] output A output object
414 * @param[out] subpixel The subpixel
415 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
418 tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
421 * @brief Get the pipe of a output object.
422 * @param[in] output A output object
423 * @param[out] pipe The pipe
424 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
427 tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
430 * @brief Get the index of a primary layer.
431 * @param[in] output A output object
432 * @param[out] index The primary layer index
433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
436 tdm_output_get_primary_index(tdm_output *output, int *index);
439 * @brief Set the property which has a given id.
440 * @param[in] output A output object
441 * @param[in] id The property id
442 * @param[in] value The value
443 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
446 tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
449 * @brief Get the property which has a given id
450 * @param[in] output A output object
451 * @param[in] id The property id
452 * @param[out] value The value
453 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
456 tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
459 * @brief Wait for VBLANK
460 * @details After interval vblanks, a user vblank handler will be called.
461 * @param[in] output A output object
462 * @param[in] interval vblank interval
463 * @param[in] sync 0: asynchronous, 1:synchronous
464 * @param[in] func A user vblank handler
465 * @param[in] user_data The user data
466 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
467 * @see #tdm_output_vblank_handler
470 tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
471 tdm_output_vblank_handler func, void *user_data);
474 * @brief Commit changes for a output object
475 * @details After all change of a output object are applied, a user commit handler
477 * @param[in] output A output object
478 * @param[in] sync 0: asynchronous, 1:synchronous
479 * @param[in] func A user commit handler
480 * @param[in] user_data The user data
481 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
482 * @see #tdm_layer_commit
485 tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func,
489 * @brief Remove the user vblank handler
490 * @param[in] output A output object
491 * @param[in] func A user vblank handler
492 * @param[in] user_data The user data
493 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
496 tdm_output_remove_vblank_handler(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
499 * @brief Remove the user commit handler
500 * @param[in] output A output object
501 * @param[in] func A user commit handler
502 * @param[in] user_data The user data
503 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
506 tdm_output_remove_commit_handler(tdm_output *output, tdm_output_commit_handler func, void *user_data);
509 * @brief Set one of available modes of a output object
510 * @param[in] output A output object
511 * @param[in] mode A output mode
512 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
515 tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
518 * @brief Get the mode of a output object
519 * @param[in] output A output object
520 * @param[out] mode A output mode
521 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
524 tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
527 * @brief Set DPMS of a output object synchronously
528 * @param[in] output A output object
529 * @param[in] dpms_value DPMS value
530 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
531 * @see tdm_output_set_dpms_async
534 tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value);
537 * @brief Set DPMS of a output object asynchronously
538 * @details This function can be used when a output supports the asynchronous DPMS
539 * control. The output has #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS flags which
540 * #tdm_output_get_capabilities returns. If an output change handler is added with
541 * #tdm_output_add_change_handler, the output change handler will be called when
542 * the DPMS status is changed indeed.
543 * @param[in] output A output object
544 * @param[in] dpms_value DPMS value
545 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
546 * @see tdm_output_add_change_handler, tdm_output_set_dpms,
547 * tdm_output_get_capabilities, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS.
550 tdm_output_set_dpms_async(tdm_output *output, tdm_output_dpms dpms_value);
553 * @brief Get DPMS of a output object
554 * @param[in] output A output object
555 * @param[out] dpms_value DPMS value
556 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
559 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
562 * @brief Create a capture object of a output object
563 * @param[in] output A output object
564 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
565 * @return A capture object
566 * @see tdm_capture_destroy
569 tdm_output_create_capture(tdm_output *output, tdm_error *error);
572 * @brief Creates a new window on the given display.
573 * @param[in] output A output object
574 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
575 * @return A created window object
579 tdm_output_hwc_create_window(tdm_output *output, tdm_error *error);
582 * @brief Creates a new video window on the given output.
583 * @param[in] output A output object
584 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
585 * @return A created window object
589 tdm_output_hwc_create_video_window(tdm_output *output, tdm_error *error);
592 * @brief Destroys the given window.
593 * @param[in] output A output object
594 * @param[in] window the pointer of the window to destroy
595 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
599 tdm_output_hwc_destroy_window(tdm_output *output, tdm_hwc_window *hwc_window);
602 * @brief Set the client(relative to the TDM) target buffer
603 * @details Sets the buffer which will receive the output of client composition.
604 * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
605 * will be composited into this buffer prior to the call to tdm_output_commit(),
606 * and windows not marked as TDM_COMPOSITION_CLIENT and
607 * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
610 * The buffer handle provided may be null if no windows are being composited by
611 * the client. This must not result in an error (unless an invalid display
612 * handle is also provided).
614 * The damage parameter describes a buffer damage region as defined in the
615 * description of tdm_hwc_window_set_buffer_damage().
617 * Will be called before tdm_output_commit() if any of the layers are marked as
618 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
619 * so marked, then it is not necessary to call this function. It is not necessary
620 * to call tdm_output_hwc_validate() after changing the target through this function.
621 * @param[in] output A output object
622 * @param[in] target The new target buffer
623 * @param[in] damage The buffer damage region
624 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
628 tdm_output_hwc_set_client_target_buffer(tdm_output *output, tbm_surface_h target_buffer,
629 tdm_hwc_region damage, tdm_hwc_window **composited_wnds,
633 * @brief Validate the output
634 * @details Instructs the device to inspect all of the layer state and
635 * determine if there are any composition type changes necessary before
636 * presenting the output. Permitted changes are described in the definition
637 * of tdm_hwc_window_composition_t above.
638 * @param[in] output A output object
639 * @param[out] num_types The number of composition type changes required by
640 * the device; if greater than 0, the client must either set and validate new
641 * types, or call tdm_output_hwc_accept_changes() to accept the changes returned by
642 * tdm_output_hwc_get_changed_composition_types(); must be the same as the number of
643 * changes returned by tdm_output_hwc_get_changed_composition_types (see the
644 * declaration of that function for more information); pointer will be non-NULL
645 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
649 tdm_output_hwc_validate(tdm_output *output, uint32_t *num_types);
652 * @brief Set the 'need to validate' handler for the 'output'
654 * @details During backend's work it may need to ask for the revalidation
655 * (make client (E20) do tdm_output_hwc_validate() again), so a 'hndl' will
656 * be called as such need happen. Only one handler per output is supported.
658 * @param[in] output The output object a hndl is going to be registered for.
659 * @param[in] hndl The handler which will be called on the 'need to validate' event.
661 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
665 tdm_output_hwc_set_need_validate_handler(tdm_output *output,
666 tdm_output_need_validate_handler hndl);
669 * @brief Get changed composition types
670 * @details Retrieves the windows for which the device requires a different
671 * composition type than had been set prior to the last call to tdm_output_hwc_validate().
672 * The client will either update its state with these types and call
673 * tdm_output_hwc_accept_changes, or will set new types and attempt to validate the
675 * windows and types may be NULL to retrieve the number of elements which
676 * will be returned. The number of elements returned must be the same as the
677 * value returned in num_types from the last call to tdm_output_hwc_validate().
678 * @param[in] output A output object
679 * @param[out] num_elements If windows or types were NULL, the number of layers
680 * and types which would have been returned; if both were non-NULL, the
681 * number of elements returned in layers and types, which must not exceed
682 * the value stored in num_elements prior to the call; pointer will be
684 * @param[in] output A output object
685 * @param[out] windows An array of windows
686 * @param[out] composition_types An array of composition types, each corresponding
687 * to an element of windows
688 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
692 tdm_output_hwc_get_changed_composition_types(tdm_output *output,uint32_t *num_elements,
693 tdm_hwc_window **hwc_window,
694 tdm_hwc_window_composition *composition_types);
697 * @brief Accepts the changes required by the device
698 * @details Accepts the changes required by the device from the previous
699 * tdm_output_hwc_validate() call (which may be queried using
700 * tdm_output_get_chaged_composition_types()) and revalidates the display. This
701 * function is equivalent to requesting the changed types from
702 * tdm_output_get_chaged_composition_types(), setting those types on the
703 * corresponding windows, and then calling tdm_output_hwc_validate again.
704 * After this call it must be valid to present this display. Calling this after
705 * tdm_output_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
706 * should have no other effect.
707 * @param[in] output A output object
708 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
712 tdm_output_hwc_accept_changes(tdm_output *output);
715 * @brief Get a target buffer queue
716 * @details Buffers from target buffer queue will receive the output of
717 * client composition. Window marked as TDM_COMPOSITION_CLIENT or
718 * TDM_COMPOSITION_DEVICE_CANDIDATE will be composited into this buffers
719 * prior to the call to tdm_output_commit().
720 * @param[in] output A output object
721 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
722 * @return A buffer queue
726 tdm_output_hwc_get_target_buffer_queue(tdm_output *output, tdm_error *error);
729 * @brief Get the supported format array for video hwc windows of a output object.
730 * @param[in] output A output object
731 * @param[out] formats The available format array
732 * @param[out] count The count of formats
733 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
736 tdm_output_hwc_get_video_supported_formats(tdm_layer *layer, const tbm_format **formats,
740 * @brief Get the capabilities of a layer object.
741 * @param[in] layer A layer object
742 * @param[out] capabilities The capabilities of a layer object
743 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
746 tdm_layer_get_capabilities(tdm_layer *layer,
747 tdm_layer_capability *capabilities);
750 * @brief Get the available format array of a layer object.
751 * @param[in] layer A layer object
752 * @param[out] formats The available format array
753 * @param[out] count The count of formats
754 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
757 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
761 * @brief Get the available property array of a layer object.
762 * @param[in] layer A layer object
763 * @param[out] props The available property array
764 * @param[out] count The count of properties
765 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
768 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
772 * @brief Get the zpos of a layer object.
774 * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
775 * - But the zpos of VIDEO layers will be decided by a backend module side.
776 * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
777 * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
778 * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
779 * -------------------------------- graphic layer 3 <-- top most layer
780 * -------------------------------- graphic layer 2
781 * -------------------------------- graphic layer 1
782 * -------------------------------- graphic layer 0
783 * -------------------------------- video layer -1
784 * -------------------------------- video layer -2 <-- lowest layer
785 * @param[in] layer A layer object
786 * @param[out] zpos The zpos
787 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
788 * @see tdm_layer_set_video_pos, tdm_layer_capability
791 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
794 * @brief Set the property which has a given id.
795 * @param[in] layer A layer object
796 * @param[in] id The property id
797 * @param[in] value The value
798 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
801 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
804 * @brief Get the property which has a given id.
805 * @param[in] layer A layer object
806 * @param[in] id The property id
807 * @param[out] value The value
808 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
811 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
814 * @brief Set the geometry information to a layer object
815 * @details The geometry information will be applied when the output object
816 * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
817 * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
819 * @param[in] layer A layer object
820 * @param[in] info The geometry information
821 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
822 * @see tdm_layer_commit
825 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
828 * @brief Get the geometry information to a layer object
829 * @param[in] layer A layer object
830 * @param[out] info The geometry information
831 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
834 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
837 * @brief Set a TDM buffer to a layer object
838 * @details A TDM buffer will be applied when the output object
839 * of a layer object is committed.
840 * @param[in] layer A layer object
841 * @param[in] buffer A TDM buffer
842 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
843 * @see tdm_layer_commit
846 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
849 * @brief Unset a TDM buffer from a layer object
850 * @details When this function is called, a current showing buffer will be
851 * disappeared from screen. Then nothing is showing on a layer object.
852 * @param[in] layer A layer object
853 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
856 tdm_layer_unset_buffer(tdm_layer *layer);
859 * @brief Commit changes for a layer object
860 * @details After all change of a layer object are applied, a user commit handler
862 * @param[in] layer A layer object
863 * @param[in] func A user commit handler
864 * @param[in] user_data The user data
865 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
868 tdm_layer_commit(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
871 tdm_layer_is_committing(tdm_layer *layer, unsigned int *committing);
874 * @brief Remove the user commit handler
875 * @param[in] layer A layer object
876 * @param[in] func A user commit handler
877 * @param[in] user_data The user data
878 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
881 tdm_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
884 * @brief Get a displaying TDM buffer from a layer object
885 * @details A displaying TDM buffer is a current showing buffer on screen
886 * that is set to layer object and applied output object of a layer object.
887 * @param[in] layer A layer object
888 * @return A TDM buffer if success. Otherwise, NULL.
891 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
894 * @brief Set a TBM surface_queue to a layer object
895 * @details A TBM surface_queue will be applied when the output object
896 * of a layer object is committed. and TDM layer will be automatically updated
897 * @param[in] layer A layer object
898 * @param[in] buffer_queue A TBM surface_queue
899 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
900 * @see tdm_layer_commit
903 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
906 * @brief Unset a TBM surface_queue from a layer object
907 * @details When this function is called, a current surface_queue will be
908 * disappeared from screen. Then nothing is showing on a layer object.
909 * @param[in] layer A layer object
910 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
913 tdm_layer_unset_buffer_queue(tdm_layer *layer);
916 * @brief Check wheter a layer object is available for a frontend user to use.
917 * @details A layer object is not usable if a TDM buffer is showing on screen
918 * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
919 * will become usable.
920 * @param[in] layer A layer object
921 * @param[out] usable 1 if usable, 0 if not usable
922 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
925 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
928 * @brief Set the relative zpos to a VIDEO layer object
929 * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
930 * it is more than the maximum zpos of GRAPHIC layers.
931 * @param[in] layer A VIDEO layer object
932 * @param[in] zpos The zpos
933 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
934 * @see tdm_layer_get_zpos, tdm_layer_capability
937 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
940 * @brief Create a capture object of a layer object
941 * @param[in] layer A layer object
942 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
943 * @return A capture object
944 * @see tdm_capture_destroy
947 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
950 * @brief Get buffer flags from a layer object
951 * @param[in] layer A layer object
952 * @param[out] flags a buffer flags value
953 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
956 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
959 * @brief Get a buffer queue for the window object
960 * @details These buffers are used to composite by hardware a client content in
962 * @param[in] hwc_window A window object
963 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
964 * @return A tbm buffer queue
968 tdm_hwc_window_get_tbm_buffer_queue(tdm_hwc_window *hwc_window, tdm_error *error);
971 * @brief Sets the desired Z order of the given window. A window with
972 * a greater Z value occludes a window with a lesser Z value.
973 * @param[in] hwc_window A window object
974 * @param[in] z the new Z order
975 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
979 tdm_hwc_window_set_zpos(tdm_hwc_window *hwc_window, uint32_t zpos);
982 * @brief Sets the desired composition type of the given window.
983 * @details During tdm_output_hwc_validate(), the device may request changes to
984 * the composition types of any of the layers as described in the definition
985 * of tdm_hwc_window_composition_t above.
986 * @param[in] hwc_window A window object
987 * @param[in] composition_type The new composition type
988 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
992 tdm_hwc_window_set_composition_type(tdm_hwc_window *hwc_window,
993 tdm_hwc_window_composition composition_type);
996 * @brief Set the buffer damage
997 * @details Provides the region of the source buffer which has been modified
998 * since the last frame. This region does not need to be validated before
999 * calling tdm_output_commit().
1000 * Once set through this function, the damage region remains the same until a
1001 * subsequent call to this function.
1002 * If damage.num_rects > 0, then it may be assumed that any portion of the source
1003 * buffer not covered by one of the rects has not been modified this frame. If
1004 * damage.num_rects == 0, then the whole source buffer must be treated as if it
1005 * has been modified.
1006 * If the layer's contents are not modified relative to the prior frame, damage
1007 * will contain exactly one empty rect([0, 0, 0, 0]).
1008 * The damage rects are relative to the pre-transformed buffer, and their origin
1009 * is the top-left corner. They will not exceed the dimensions of the latched
1011 * @param[in] hwc_window A window object
1012 * @param[in] damage The new buffer damage region
1013 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1017 tdm_hwc_window_set_buffer_damage(tdm_hwc_window *hwc_window, tdm_hwc_region damage);
1020 * @brief Set the information to a window object
1021 * @details The information will be applied when the output object of a window
1022 * object is committed.
1023 * @param[in] hwc_window A window object
1024 * @param[in] info The information
1025 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1029 tdm_hwc_window_set_info(tdm_hwc_window *hwc_window, tdm_hwc_window_info *info);
1032 * @brief Set a TBM buffer to a window object
1033 * @details A TBM buffer will be applied when the output object of a layer
1034 * object is committed.
1035 * @param[in] hwc_window A window object
1036 * @param[in] buffer A TDM buffer
1037 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1041 tdm_hwc_window_set_buffer(tdm_hwc_window *hwc_window, tbm_surface_h buffer);
1044 * @brief Set a flags to a window object
1045 * @param[in] hwc_window A window object
1046 * @param[in] flags A hwc_window flags
1047 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1051 tdm_hwc_window_set_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags);
1054 * @brief Unset a flags from a window object
1055 * @param[in] hwc_window A window object
1056 * @param[in] flags A hwc_window flags
1057 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1061 tdm_hwc_window_unset_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags);
1064 * @brief Get the available property array of a video hwc window object.
1065 * @param[in] hwc window A video hwc window object
1066 * @param[out] props The available property array
1067 * @param[out] count The count of properties
1068 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1071 tdm_hwc_window_video_get_available_properties(tdm_hwc_window *hwc_window,
1072 const tdm_prop **props, int *count);
1075 * @brief Get the property which has a given id.
1076 * @param[in] hwc window A video hwc window object
1077 * @param[in] id The property id
1078 * @param[out] value The value
1079 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1082 tdm_hwc_window_video_get_property(tdm_hwc_window *hwc_window, uint32_t id,
1086 * @brief Set the property which has a given id.
1087 * @param[in] hwc window A video hwc window object
1088 * @param[in] id The property id
1089 * @param[in] value The value
1090 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1093 tdm_hwc_window_video_set_property(tdm_hwc_window *hwc_window, uint32_t id,
1097 * @brief Get the window video capability
1098 * @param[in] hwc_window A window object
1099 * @param[out] video_capability A hwc window video capability
1100 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1104 tdm_hwc_window_video_get_capability(tdm_hwc_window *hwc_window,
1105 tdm_hwc_window_video_capability *video_capability);
1108 * @brief Destroy a pp object
1109 * @param[in] pp A pp object
1110 * @see tdm_display_create_pp
1113 tdm_pp_destroy(tdm_pp *pp);
1116 * @brief Set the geometry information to a pp object
1117 * @param[in] pp A pp object
1118 * @param[in] info The geometry information
1119 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1120 * @see tdm_pp_commit
1123 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
1126 * @brief Set the PP done handler to a pp object
1128 * The user PP done handler will be called after converting a source buffer's image
1129 * to a destination buffer.
1130 * @param[in] pp A pp object
1131 * @param[in] func A user PP done handler
1132 * @param[in] user_data The user data
1133 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1136 tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
1139 * @brief Attach a source buffer and a destination buffer to a pp object
1140 * @param[in] pp A pp object
1141 * @param[in] src A source buffer
1142 * @param[in] dst A destination buffer
1143 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1144 * @see tdm_pp_commit, tdm_pp_set_done_handler
1147 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1150 * @brief Commit changes for a pp object
1151 * @param[in] pp A pp object
1152 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1155 tdm_pp_commit(tdm_pp *pp);
1158 * @brief Destroy a capture object
1159 * @param[in] capture A capture object
1160 * @see tdm_output_create_capture, tdm_layer_create_capture
1163 tdm_capture_destroy(tdm_capture *capture);
1166 * @brief Set the geometry information to a capture object
1167 * @param[in] capture A capture object
1168 * @param[in] info The geometry information
1169 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1170 * @see tdm_capture_commit
1173 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
1176 * @brief Set the capture done handler to a capture object
1178 * The user capture done handler will be called after capturing a screen into a
1180 * @param[in] capture A capture object
1181 * @param[in] func A user capture done handler
1182 * @param[in] user_data The user data
1183 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1186 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
1189 * @brief Attach a TDM buffer to a capture object
1190 * @param[in] capture A capture object
1191 * @param[in] buffer A TDM buffer
1192 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1193 * @see tdm_capture_commit, tdm_capture_set_done_handler
1196 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
1199 * @brief Commit changes for a capture object
1200 * @param[in] capture A capture object
1201 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1204 tdm_capture_commit(tdm_capture *capture);
1207 * @brief The release handler of a TDM buffer
1208 * @param[in] buffer A TDM buffer
1209 * @param[in] user_data user data
1210 * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
1212 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
1216 * @brief Add a release handler to a TDM buffer
1218 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1219 * becomes available for a next job. A TDM buffer can be used for TDM to show
1220 * it on screen or to capture an output and a layer. After all operations,
1221 * TDM will release it immediately when TDM doesn't need it any more.
1222 * @param[in] buffer A TDM buffer
1223 * @param[in] func A release handler
1224 * @param[in] user_data user data
1225 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1226 * @see tdm_buffer_remove_release_handler
1229 tdm_buffer_add_release_handler(tbm_surface_h buffer,
1230 tdm_buffer_release_handler func, void *user_data);
1233 * @brief Remove a release handler from a TDM buffer
1234 * @param[in] buffer A TDM buffer
1235 * @param[in] func A release handler
1236 * @param[in] user_data user data
1237 * @see tdm_buffer_add_release_handler
1240 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
1241 tdm_buffer_release_handler func, void *user_data);
1244 * @brief The handler of a vblank object
1245 * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
1247 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
1248 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
1251 * @brief Set the vblank fps for the given PID and name.
1252 * @param[in] pid The process ID
1253 * @param[in] name The client vblank name
1254 * @param[in] fps The client vblank fps
1255 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1258 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
1261 * @brief Set the vblank global fps for the entire system.
1262 * @param[in] enable 1:enable, 0:disable
1263 * @param[in] fps The vblank global fps
1265 * This global fps will be applied to all client's vblanks for all outputs.
1266 * If the client's vblank fps is less than this, the global fps will be ignored
1267 * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1268 * the global fps, it will be ignored also.
1269 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1272 tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps);
1275 * @brief Create a vblank object
1276 * @param[in] dpy A display object
1277 * @param[in] output A output object
1278 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1279 * @return A vblank object
1280 * @see #tdm_vblank_destroy
1283 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
1286 * @brief Destroy a vblank object
1287 * @param[in] vblank A vblank object
1288 * @see #tdm_vblank_create
1291 tdm_vblank_destroy(tdm_vblank *vblank);
1294 * @brief Set the name to a vblank object
1295 * @details The default name is "unknown"
1296 * @param[in] vblank A vblank object
1297 * @param[in] name vblank name
1298 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1301 tdm_vblank_set_name(tdm_vblank *vblank, const char *name);
1304 * @brief Get the name for a vblank object
1305 * @details The default name is "unknown"
1306 * @param[in] vblank A vblank object
1307 * @param[out] name vblank name
1308 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1311 tdm_vblank_get_name(tdm_vblank *vblank, const char **name);
1314 * @brief Set the fps to a vblank object
1315 * @details Default is the @b vertical @b refresh @b rate of the given output.
1316 * @param[in] vblank A vblank object
1317 * @param[in] fps over 0
1318 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1321 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
1324 * @brief Get the fps for a vblank object
1325 * @param[in] vblank A vblank object
1326 * @param[out] fps over 0
1327 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1330 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps);
1333 * @brief Ignore the vblank global fps
1335 * The global fps will be applied to all client's vblanks for all outputs.
1336 * If the client's vblank fps is less than this, the global fps will be ignored
1337 * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore
1338 * the global fps, it will be ignored also.
1339 * @param[in] vblank A vblank object
1340 * @param[in] ignore 1: ignore 0:not ignore(default)
1341 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1344 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore);
1347 * @brief Set the offset(milli-second) to a vblank object
1348 * @details Default is @b 0.
1349 * @param[in] vblank A vblank object
1350 * @param[in] offset the offset(milli-second)
1351 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1354 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
1357 * @brief Get the offset(milli-second) for a vblank object
1358 * @param[in] vblank A vblank object
1359 * @param[out] offset the offset(milli-second)
1360 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1363 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset);
1366 * @brief Enable/Disable the fake vblank to a vblank object
1368 * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF
1369 * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
1371 * @param[in] vblank A vblank object
1372 * @param[in] enable_fake 1:enable, 0:disable
1373 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1376 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
1379 * @brief Get the fake vblank
1380 * @param[in] vblank A vblank object
1381 * @param[out] enable_fake 1:enable, 0:disable
1382 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1385 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake);
1388 * @brief Wait for a vblank
1390 * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
1391 * SHOULD be called after the given interval. \n
1392 * The sequence value of tdm_vblank_handler is the relative value of fps.
1393 * If fps = 10, this sequence value should be increased by 10 during 1 second.
1394 * @param[in] vblank A vblank object
1395 * @param[in] req_sec The vblank request time(second)
1396 * @param[in] req_usec The vblank request time(micro-second)
1397 * @param[in] interval The vblank interval
1398 * @param[in] func The user vblank handler
1399 * @param[in] user_data The user data
1400 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1403 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1404 unsigned int interval, tdm_vblank_handler func, void *user_data);
1407 * @brief Wait for a vblank with the target sequence number
1408 * @param[in] vblank A vblank object
1409 * @param[in] req_sec The vblank request time(second)
1410 * @param[in] req_usec The vblank request time(micro-second)
1411 * @param[in] sequence The target sequence number
1412 * @param[in] func The user client vblank handler
1413 * @param[in] user_data The user data
1414 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1417 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1418 unsigned int sequence, tdm_vblank_handler func, void *user_data);
1424 #endif /* _TDM_H_ */