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 **************************************************************************/
36 #ifndef _TDM_BACKEND_H_
37 #define _TDM_BACKEND_H_
39 #include <tbm_surface.h>
40 #include <tbm_surface_queue.h>
42 #include "tdm_types.h"
50 * @brief The backend header file of TDM to implement a TDM backend module.
53 * #include <tdm_backend.h>
58 * @brief The backend module data
60 * The init() function of #tdm_backend_module returns the backend module data.
61 * And it will be passed to display functions of #tdm_func_display.
62 * @see tdm_backend_module, tdm_backend_module
64 typedef void tdm_backend_data;
67 * @brief The output status handler
68 * @details This handler will be called when the status of a output object is
71 typedef void (*tdm_output_status_handler)(tdm_output *output,
72 tdm_output_conn_status status,
76 * @brief The output dpms handler
77 * @details This handler will be called when the dpms of a output object is
80 typedef void (*tdm_output_dpms_handler)(tdm_output *output,
85 * @brief The display capabilities structure of a backend module
86 * @see The display_get_capability() function of #tdm_func_display
88 typedef struct _tdm_caps_display {
89 int max_layer_count; /**< The maximum layer count */
93 * @brief The capabilities structure of a output object
94 * @see The output_get_capability() function of #tdm_func_output
96 typedef struct _tdm_caps_output {
97 char maker[TDM_NAME_LEN]; /**< The output maker */
98 char model[TDM_NAME_LEN]; /**< The output model */
99 char name[TDM_NAME_LEN]; /**< The output name */
101 tdm_output_conn_status status; /**< The connection status */
102 tdm_output_type type; /**< The connection type */
103 unsigned int type_id; /**< The connection type id */
105 unsigned int mode_count; /**< The count of available modes */
107 *modes; /**< The @b newly-allocated array of modes. will be freed in frontend. */
109 unsigned int prop_count; /**< The count of available properties */
110 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
112 unsigned int mmWidth; /**< The physical width (milimeter) */
113 unsigned int mmHeight; /**< The physical height (milimeter) */
114 unsigned int subpixel; /**< The subpixel */
116 int min_w; /**< The minimun width */
117 int min_h; /**< The minimun height */
118 int max_w; /**< The maximum width */
119 int max_h; /**< The maximum height */
120 int preferred_align; /**< The prefered align */
122 tdm_output_capability capabilities; /**< The capabilities of output. @since 1.4.1 */
124 int cursor_min_w; /**< The minimun width. @since 1.5.0 */
125 int cursor_min_h; /**< The minimun height. @since 1.5.0 */
126 int cursor_max_w; /**< The maximum width. @since 1.5.0 */
127 int cursor_max_h; /**< The maximum height. @since 1.5.0 */
128 int cursor_preferred_align; /**< The prefered align. @since 1.5.0 */
132 * @brief The capabilities structure of a layer object
133 * @see The layer_get_capability() function of #tdm_func_layer
135 typedef struct _tdm_caps_layer {
136 tdm_layer_capability capabilities; /**< The capabilities of layer */
140 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
141 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
142 * But the zpos of VIDEO layer is changeable by layer_set_video_pos() function
143 * of #tdm_func_layer. And The zpos of VIDEO layers is less than GRAPHIC
144 * layers or more than GRAPHIC layers.
145 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
146 * The zpos of VIDEO layers is @b relative. It doesn't need to start
147 * from -1 or 4. Let's suppose that there are two VIDEO layers.
148 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
149 * than -4 VIDEO layer.
153 unsigned int format_count; /**< The count of available formats */
155 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
157 unsigned int prop_count; /**< The count of available properties */
158 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
162 * @brief The capabilities structure of a pp object
163 * @see The display_get_pp_capability() function of #tdm_func_display
165 typedef struct _tdm_caps_pp {
166 tdm_pp_capability capabilities; /**< The capabilities of pp */
168 unsigned int format_count; /**< The count of available formats */
170 *formats; /**< The @b newly-allocated array. will be freed in frontend. */
172 int min_w; /**< The minimun width */
173 int min_h; /**< The minimun height */
174 int max_w; /**< The maximum width */
175 int max_h; /**< The maximum height */
176 int preferred_align; /**< The prefered align */
178 /**< The attach count which a PP object can handle. @since 1.2.0 */
179 int max_attach_count;
183 * @brief The capabilities structure of a capture object
184 * @see The display_get_capture_capability() function of #tdm_func_display
186 typedef struct _tdm_caps_capture {
187 tdm_capture_capability capabilities; /**< The capabilities of capture */
189 unsigned int format_count; /**< The count of available formats */
191 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
193 int min_w; /**< The minimun width */
194 int min_h; /**< The minimun height */
195 int max_w; /**< The maximum width */
196 int max_h; /**< The maximum height */
197 int preferred_align; /**< The prefered align */
199 /**< The attach count which a capture object can handle. @since 1.2.0 */
200 int max_attach_count;
204 * @brief The display functions for a backend module.
206 typedef struct _tdm_func_display {
208 * @brief Get the display capabilities of a backend module
209 * @param[in] bdata The backend module data
210 * @param[out] caps The display capabilities of a backend module
211 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
213 * A backend module @b SHOULD implement this function. TDM calls this function
214 * not only at the initial time, but also at the update time when new output
216 * If a hardware has the restriction of the number of max usable layer count,
217 * a backend module can set the max count to max_layer_count of #tdm_caps_display
220 tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
223 * @brief Get the pp capabilities of a backend module
224 * @param[in] bdata The backend module data
225 * @param[out] caps The pp capabilities of a backend module
226 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
227 * @see tdm_backend_register_func_pp
229 * TDM calls this function not only at the initial time, but also at the update
230 * time when new output is connected.\n
231 * A backend module doesn't need to implement this function if a hardware
232 * doesn't have the memory-to-memory converting device. Otherwise, a backend module
233 * @b SHOULD fill the #tdm_caps_pp data. #tdm_caps_pp contains the hardware
234 * restriction information which a converting device can handle. ie, format, size, etc.
236 tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
239 * @brief Get the capture capabilities of a backend module
240 * @param[in] bdata The backend module data
241 * @param[out] caps The capture capabilities of a backend module
242 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
243 * @see tdm_backend_register_func_capture
245 * TDM calls this function not only at the initial time, but also at the update
246 * time when new output is connected.\n
247 * A backend module doesn't need to implement this function if a hardware
248 * doesn't have the capture device. Otherwise, a backend module @b SHOULD fill the
249 * #tdm_caps_capture data. #tdm_caps_capture contains the hardware restriction
250 * information which a capture device can handle. ie, format, size, etc.
252 tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
255 * @brief Get a output array of a backend module
256 * @param[in] bdata The backend module data
257 * @param[out] count The count of outputs
258 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
259 * @return A output array which is @b newly-allocated
260 * @see tdm_backend_register_func_capture
262 * A backend module @b SHOULD implement this function. TDM calls this function
263 * not only at the initial time, but also at the update time when new output
265 * A backend module @b SHOULD return the @b newly-allocated array which contains
266 * "tdm_output*" data. It will be freed in frontend.
270 * drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
272 * tdm_drm_data *drm_data = bdata;
273 * tdm_drm_output_data *output_data = NULL;
274 * tdm_output **outputs;
278 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
283 * if (error) *error = TDM_ERROR_NONE;
287 * // will be freed in frontend
288 * outputs = calloc(*count, sizeof(tdm_drm_output_data*));
292 * if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
297 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
298 * outputs[i++] = output_data;
300 * if (error) *error = TDM_ERROR_NONE;
306 tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
310 * @brief Get the file descriptor of a backend module
311 * @param[in] bdata The backend module data
312 * @param[out] fd The fd of a backend module
313 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
314 * @see display_handle_events() function of #tdm_func_display
316 * A backend module can return epoll's fd which is watching the backend device one more fds.
318 tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
321 * @brief Handle the events which happens on the fd of a backend module
322 * @param[in] bdata The backend module data
323 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
325 tdm_error (*display_handle_events)(tdm_backend_data *bdata);
328 * @brief Create a pp object of a backend module
329 * @param[in] bdata The backend module data
330 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
331 * @return A pp object
332 * @see pp_destroy() function of #tdm_func_pp
334 * A backend module doesn't need to implement this function if a hardware
335 * doesn't have the memory-to-memory converting device.
337 tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
339 void (*reserved1)(void);
340 void (*reserved2)(void);
341 void (*reserved3)(void);
342 void (*reserved4)(void);
343 void (*reserved5)(void);
344 void (*reserved6)(void);
345 void (*reserved7)(void);
346 void (*reserved8)(void);
350 * @brief The output functions for a backend module.
352 typedef struct _tdm_func_output {
354 * @brief Get the capabilities of a output object
355 * @param[in] output A output object
356 * @param[out] caps The capabilities of a output object
357 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
359 * A backend module @b SHOULD implement this function. TDM calls this function
360 * not only at the initial time, but also at the update time when new output
362 * #tdm_caps_output contains connection status, modes, avaiable properties,
363 * size restriction information, etc.
365 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
368 * @brief Get a layer array of a output object
369 * @param[in] output A output object
370 * @param[out] count The count of layers
371 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
372 * @return A layer array which is @b newly-allocated
374 * A backend module @b SHOULD implement this function. TDM calls this function
375 * not only at the initial time, but also at the update time when new output
377 * A backend module @b SHOULD return the @b newly-allocated array which contains
378 * "tdm_layer*" data. It will be freed in frontend.
380 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
384 * @brief Set the property which has a given id
385 * @param[in] output A output object
386 * @param[in] id The property id
387 * @param[in] value The value
388 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
390 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
394 * @brief Get the property which has a given id
395 * @param[in] output A output object
396 * @param[in] id The property id
397 * @param[out] value The value
398 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
400 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
404 * @brief Wait for VBLANK
405 * @param[in] output A output object
406 * @param[in] interval vblank interval
407 * @param[in] sync 0: asynchronous, 1:synchronous
408 * @param[in] user_data The user data
409 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
410 * @see output_set_vblank_handler, tdm_output_vblank_handler
412 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
413 * a user vblank handler with the user data of this function after interval
416 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
420 * @brief Set a user vblank handler
421 * @param[in] output A output object
422 * @param[in] func A user vblank handler
423 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
425 tdm_error (*output_set_vblank_handler)(tdm_output *output,
426 tdm_output_vblank_handler func);
429 * @brief Commit changes for a output object
430 * @param[in] output A output object
431 * @param[in] sync 0: asynchronous, 1:synchronous
432 * @param[in] user_data The user data
433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
434 * @see output_set_commit_handler, tdm_output_commit_handler
436 * When this function is called, a backend module @b SHOULD apply the all
437 * changes of the given output object to screen as well as the layer changes
439 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
440 * a user commit handler with the user data of this function after all
441 * changes of the given output object are applied.
443 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
446 * @brief Set a user commit handler
447 * @param[in] output A output object
448 * @param[in] func A user commit handler
449 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
451 tdm_error (*output_set_commit_handler)(tdm_output *output,
452 tdm_output_commit_handler func);
455 * @brief Set DPMS of a output object synchronously
456 * @param[in] output A output object
457 * @param[in] dpms_value DPMS value
458 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
460 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
463 * @brief Get DPMS of a output object
464 * @param[in] output A output object
465 * @param[out] dpms_value DPMS value
466 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
468 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
471 * @brief Set one of available modes of a output object
472 * @param[in] output A output object
473 * @param[in] mode A output mode
474 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
476 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
479 * @brief Get the mode of a output object
481 * @param[in] output A output object
482 * @param[out] mode A output mode
483 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
485 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
488 * @brief Create a capture object of a output object
489 * @param[in] output A output object
490 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
491 * @return A capture object
492 * @see capture_destroy() function of #tdm_func_capture
494 * A backend module doesn't need to implement this function if a hardware
495 * doesn't have the capture device.
497 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
500 * @brief Set a output connection status handler
501 * @details A backend module need to call the output status handler when the
502 * output connection status has been changed to let the TDM frontend know
504 * @param[in] output A output object
505 * @param[in] func A output status handler
506 * @param[in] user_data The user data
507 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
510 tdm_error (*output_set_status_handler)(tdm_output *output,
511 tdm_output_status_handler func,
515 * @brief Set a output dpms handler
516 * @details This function can be NULL if an output doesn't support asynchronous
517 * DPMS control. Otherwise, a backend module needs to call the output dpms handler
518 * to let the TDM frontend know the output DPMS change indeed.
519 * @param[in] output A output object
520 * @param[in] func A output dpms handler
521 * @param[in] user_data The user data
522 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
523 * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
526 tdm_error (*output_set_dpms_handler)(tdm_output *output,
527 tdm_output_dpms_handler func,
530 * @brief Creates a new window on the given display.
531 * @param[in] output A output object
532 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
533 * @return A created window object
535 tdm_hwc_window *(*output_create_hwc_window)(tdm_output *output, tdm_error *error);
538 * @brief Destroys the given window.
539 * @param[in] output A output object
540 * @param[in] window the pointer of the window to destroy
541 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
543 tdm_error (*output_destroy_hwc_window)(tdm_output *output, tdm_hwc_window *hwc_window);
546 * @brief Set the client(relative to the TDM) target buffer
547 * @details Sets the buffer which will receive the output of client composition.
548 * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
549 * will be composited into this buffer prior to the call to output_commit(),
550 * and windows not marked as TDM_COMPOSITION_CLIENT and
551 * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
554 * The buffer handle provided may be null if no windows are being composited by
555 * the client. This must not result in an error (unless an invalid display
556 * handle is also provided).
558 * The damage parameter describes a surface damage region as defined in the
559 * description of hwc_window_set_surface_damage().
561 * Will be called before output_commit() if any of the layers are marked as
562 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
563 * so marked, then it is not necessary to call this function. It is not necessary
564 * to call output_validate() after changing the target through this function.
565 * @param[in] output A output object
566 * @param[in] target The new target buffer
567 * @param[in] damage The surface damage region
568 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
570 tdm_error (*output_set_client_target_buffer)(tdm_output *output, tbm_surface_h target,
571 tdm_hwc_region damage);
574 * @brief Validate the output
575 * @details Instructs the device to inspect all of the layer state and
576 * determine if there are any composition type changes necessary before
577 * presenting the output. Permitted changes are described in the definition
578 * of tdm_composition_t above.
579 * @param[in] output A output object
580 * @param[out] num_types The number of composition type changes required by
581 * the device; if greater than 0, the client must either set and validate new
582 * types, or call output_accept_changes() to accept the changes returned by
583 * output_get_changed_composition_types(); must be the same as the number of
584 * changes returned by output_get_changed_composition_types (see the
585 * declaration of that function for more information); pointer will be non-NULL
586 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
588 tdm_error (*output_validate)(tdm_output *output, uint32_t *num_types);
591 * @brief Get changed composition types
592 * @details Retrieves the windows for which the device requires a different
593 * composition type than had been set prior to the last call to output_validate().
594 * The client will either update its state with these types and call
595 * output_accept_changes, or will set new types and attempt to validate the
597 * layers and types may be NULL to retrieve the number of elements which
598 * will be returned. The number of elements returned must be the same as the
599 * value returned in num_types from the last call to output_validate().
600 * @param[in] output A output object
601 * @param[out] num_elements If windows or types were NULL, the number of layers
602 * and types which would have been returned; if both were non-NULL, the
603 * number of elements returned in layers and types, which must not exceed
604 * the value stored in num_elements prior to the call; pointer will be
606 * @param[out] windows An array of windows
607 * @param[out] composition_types An array of composition types, each
608 * corresponding to an element of windows
609 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
611 tdm_error (*output_get_changed_composition_types)(tdm_output *output,
612 uint32_t *num_elements,
613 tdm_hwc_window **hwc_window,
614 tdm_hwc_window_composition_t *composition_types);
616 * @brief Accepts the changes required by the device
617 * @details Accepts the changes required by the device from the previous
618 * output_validate() call (which may be queried using
619 * output_get_chaged_composition_types()) and revalidates the display. This
620 * function is equivalent to requesting the changed types from
621 * output_get_chaged_composition_types(), setting those types on the
622 * corresponding windows, and then calling output_validate again.
623 * After this call it must be valid to present this display. Calling this after
624 * output_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
625 * should have no other effect.
626 * @param[in] output A output object
627 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
629 tdm_error (*output_accept_changes)(tdm_output *output);
632 * @brief Get a target surface queue
633 * @param[in] output A output object
634 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
635 * @return A surface queue
637 tbm_surface_queue_h (*output_get_target_surface_queue)(tdm_output *output,
641 * @brief Set DPMS of a output object asynchronously
642 * @param[in] output A output object
643 * @details This function can be NULL if an output doesn't support asynchronous
644 * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
645 * flags which #output_get_capability returns. And if a output dpms handler is added with
646 * #output_set_dpms_handler, a backend module needs to call the output dpms handler
647 * to let the TDM frontend know the output DPMS change indeed.
648 * @param[in] dpms_value DPMS value
649 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
650 * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
653 tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
655 void (*reserved3)(void);
656 void (*reserved4)(void);
657 void (*reserved5)(void);
658 void (*reserved6)(void);
659 void (*reserved7)(void);
660 void (*reserved8)(void);
664 * @brief The layer functions for a backend module.
666 typedef struct _tdm_func_layer {
668 * @brief Get the capabilities of a layer object
669 * @param[in] layer A layer object
670 * @param[out] caps The capabilities of a layer object
671 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
673 * A backend module @b SHOULD implement this function. TDM calls this function
674 * not only at the initial time, but also at the update time when new output
676 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
678 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
681 * @brief Set the property which has a given id.
682 * @param[in] layer A layer object
683 * @param[in] id The property id
684 * @param[in] value The value
685 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
687 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
691 * @brief Get the property which has a given id.
692 * @param[in] layer A layer object
693 * @param[in] id The property id
694 * @param[out] value The value
695 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
697 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
701 * @brief Set the geometry information to a layer object
702 * @param[in] layer A layer object
703 * @param[in] info The geometry information
704 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
705 * @see output_commit() function of #tdm_func_output
707 * A backend module would apply the geometry information when the output object
708 * of a layer object is committed.
710 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
713 * @brief Get the geometry information to a layer object
714 * @param[in] layer A layer object
715 * @param[out] info The geometry information
716 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
718 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
721 * @brief Set a TDM buffer to a layer object
722 * @param[in] layer A layer object
723 * @param[in] buffer A TDM buffer
724 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
725 * @see output_commit() function of #tdm_func_output
727 * A backend module would show a TDM buffer on screen when the output object
728 * of a layer object is committed.
730 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
733 * @brief Unset a TDM buffer from a layer object
734 * @param[in] layer A layer object
735 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
737 * A backend module @b SHOULD remove the current showing buffer from screen.
739 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
742 * @brief Set the zpos for a VIDEO layer object
743 * @param[in] layer A layer object
744 * @param[in] zpos z-order
745 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
746 * @see tdm_caps_layer, tdm_layer_capability
748 * A backend module doesn't need to implement this function if a backend
749 * module doesn't have VIDEO layers.\n
750 * This function is for VIDEO layers.
751 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
752 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
753 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
754 * is less than GRAPHIC layers or more than GRAPHIC layers.
755 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
756 * The zpos of VIDEO layers is @b relative. It doesn't need to start
757 * from -1 or 4. Let's suppose that there are two VIDEO layers.
758 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
759 * than -4 VIDEO layer.
761 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
764 * @brief Create a capture object of a layer object
765 * @param[in] output A output object
766 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
767 * @return A capture object
768 * @see capture_destroy() function of #tdm_func_capture
770 * A backend module doesn't need to implement this function if a hardware
771 * doesn't have the capture device.
773 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
776 * @brief Get buffer flags which the layer can support.
777 * @param[in] layer A layer object
778 * @param[out] flags The buffer flags which should be the tbm_bo flags
779 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
781 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
783 void (*reserved1)(void);
784 void (*reserved2)(void);
785 void (*reserved3)(void);
786 void (*reserved4)(void);
787 void (*reserved5)(void);
788 void (*reserved6)(void);
789 void (*reserved7)(void);
793 * @brief The window functions for a backend module.
795 typedef struct _tdm_func_window {
797 * @brief Get a tbm surface queue for the window object
798 * @param[in] hwc_window A window object
799 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
800 * @return A tbm surface queue
802 tbm_surface_queue_h (*hwc_window_get_tbm_surface_queue)(tdm_hwc_window *hwc_window,
806 * @brief Sets the desired Z order (height) of the given window. A window with
807 * a greater Z value occludes a window with a lesser Z value.
808 * @param[in] hwc_window A window object
809 * @param[in] z the new Z order
810 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
812 tdm_error (*hwc_window_set_zpos)(tdm_hwc_window *hwc_window, uint32_t zpos);
815 * @brief Sets the desired composition type of the given window.
816 * @details During output_validate(), the device may request changes to
817 * the composition types of any of the layers as described in the definition
818 * of tdm_hwc_window_composition_t above.
819 * @param[in] hwc_window A window object
820 * @param[in] composition_type The new composition type
821 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
823 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
824 tdm_hwc_window_composition_t composition_type);
827 * @brief Set the surface damage
828 * @details Provides the region of the source buffer which has been modified
829 * since the last frame. This region does not need to be validated before
830 * calling output_commit().
831 * Once set through this function, the damage region remains the same until a
832 * subsequent call to this function.
833 * If damage.num_rects > 0, then it may be assumed that any portion of the source
834 * buffer not covered by one of the rects has not been modified this frame. If
835 * damage.num_rects == 0, then the whole source buffer must be treated as if it
837 * If the layer's contents are not modified relative to the prior frame, damage
838 * will contain exactly one empty rect([0, 0, 0, 0]).
839 * The damage rects are relative to the pre-transformed buffer, and their origin
840 * is the top-left corner. They will not exceed the dimensions of the latched
842 * @param[in] hwc_window A window object
843 * @param[in] damage The new surface damage region
844 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
846 tdm_error (*hwc_window_set_surface_damage)(tdm_hwc_window *hwc_window,
847 tdm_hwc_region damage);
850 * @brief Set the information to a window object
851 * @details The information will be applied when the output object
852 * of a layer object is committed.
853 * @param[in] hwc_window A window object
854 * @param[in] info The geometry information
855 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
857 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
858 tdm_hwc_window_info *info);
861 * @brief Set a TDM buffer to a window object
862 * @details A TDM buffer will be applied when the output object
863 * of a layer object is committed.
864 * @param[in] hwc_window A window object
865 * @param[in] buffer A TDM buffer
866 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
868 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
869 tbm_surface_h buffer);
872 * @brief Set a flags to a window object
873 * @param[in] hwc_window A window object
874 * @param[in] flags A hwc_window flags
875 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
877 tdm_error (*hwc_window_set_flags)(tdm_hwc_window *hwc_window,
878 tdm_hwc_window_flag flags);
881 * @brief Unset a flags from a window object
882 * @param[in] hwc_window A window object
883 * @param[in] flags A hwc_window flags
884 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
886 tdm_error (*hwc_window_unset_flags)(tdm_hwc_window *hwc_window,
887 tdm_hwc_window_flag flags);
890 * @brief Get the window video capability
891 * @param[in] hwc_window A window object
892 * @param[out] video_capability A hwc window video capability
893 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
895 tdm_error (*hwc_window_video_get_capability)(tdm_hwc_window *hwc_window,
896 tdm_hwc_window_video_capability *video_capability);
899 * @brief Get the window video supported format
900 * @param[in] hwc_window A window object
901 * @param[out] formats A hwc window supported formats
902 * @param[out] count A number of the hwc window supported formats
903 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
905 tdm_error (*hwc_window_video_get_supported_format)(tdm_hwc_window *hwc_window,
906 const tbm_format **formats,
908 } tdm_func_hwc_window;
911 * @brief The pp functions for a backend module.
913 typedef struct _tdm_func_pp {
915 * @brief Destroy a pp object
916 * @param[in] pp A pp object
917 * @see display_create_pp() function of #tdm_func_display
919 void (*pp_destroy)(tdm_pp *pp);
922 * @brief Set the geometry information to a pp object
923 * @param[in] pp A pp object
924 * @param[in] info The geometry information
925 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
926 * @see pp_commit() function of #tdm_func_pp
928 * A backend module would apply the geometry information when committed.
930 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
933 * @brief Attach a source buffer and a destination buffer to a pp object
934 * @param[in] pp A pp object
935 * @param[in] src A source buffer
936 * @param[in] dst A destination buffer
937 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
938 * @see pp_set_info() function of #tdm_func_pp
939 * @see pp_commit() function of #tdm_func_pp
940 * @see pp_set_done_handler, tdm_pp_done_handler
942 * A backend module converts the image of a source buffer to a destination
943 * buffer when committed. The size/crop/transform information is set via
944 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
945 * return the source/destination buffer via tdm_pp_done_handler.
947 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
950 * @brief Commit changes for a pp object
951 * @param[in] pp A pp object
952 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
954 tdm_error (*pp_commit)(tdm_pp *pp);
957 * @brief Set a user done handler to a pp object
958 * @param[in] pp A pp object
959 * @param[in] func A user done handler
960 * @param[in] user_data user data
961 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
963 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
965 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
968 void (*reserved1)(void);
969 void (*reserved2)(void);
970 void (*reserved3)(void);
971 void (*reserved4)(void);
972 void (*reserved5)(void);
973 void (*reserved6)(void);
974 void (*reserved7)(void);
975 void (*reserved8)(void);
979 * @brief The capture functions for a backend module.
981 typedef struct _tdm_func_capture {
983 * @brief Destroy a capture object
984 * @param[in] capture A capture object
985 * @see output_create_capture() function of #tdm_func_output
986 * @see layer_create_capture() function of #tdm_func_layer
988 void (*capture_destroy)(tdm_capture *capture);
991 * @brief Set the geometry information to a capture object
992 * @param[in] capture A capture object
993 * @param[in] info The geometry information
994 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
995 * @see capture_commit() function of #tdm_func_capture
997 * A backend module would apply the geometry information when committed.
999 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1002 * @brief Attach a TDM buffer to a capture object
1003 * @details When capture_commit() function is called, a backend module starts
1004 * to dump a output or a layer to a TDM buffer.
1005 * @param[in] capture A capture object
1006 * @param[in] buffer A TDM buffer
1007 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1008 * @see capture_set_info() function of #tdm_func_capture
1009 * @see capture_commit() function of #tdm_func_capture
1010 * @see capture_set_done_handler, tdm_capture_done_handler
1012 * A backend module starts to dump a output or a layer to to a TDM buffer when
1013 * committed. The size/crop/transform information is set via #capture_set_info()
1014 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1015 * buffer via tdm_capture_done_handler.
1017 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1020 * @brief Commit changes for a capture object
1021 * @param[in] capture A capture object
1022 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1024 tdm_error (*capture_commit)(tdm_capture *capture);
1027 * @brief Set a user done handler to a capture object
1028 * @param[in] capture A capture object
1029 * @param[in] func A user done handler
1030 * @param[in] user_data user data
1031 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1033 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1035 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1036 tdm_capture_done_handler func, void *user_data);
1038 void (*reserved1)(void);
1039 void (*reserved2)(void);
1040 void (*reserved3)(void);
1041 void (*reserved4)(void);
1042 void (*reserved5)(void);
1043 void (*reserved6)(void);
1044 void (*reserved7)(void);
1045 void (*reserved8)(void);
1049 * @brief The tdm event source
1051 typedef void tdm_event_loop_source;
1054 * @brief The fd source handler
1056 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1059 * @brief The timer source handler
1061 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1063 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1064 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1065 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1066 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1070 * The ABI version of TDM backend module. It has a major and minor revision.
1071 * Modules using lower minor revisions will work with TDM frontend of a higher
1072 * minor revision. There is no compatibility between different major revisions.
1073 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1076 * tdm_backend_module tdm_backend_module_data = {
1079 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1085 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1086 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1087 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1091 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1093 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1095 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1098 * @brief The backend module information of the entry point to initialize a TDM
1101 * A backend module @b SHOULD define the global data symbol of which name is
1102 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1103 * at the initial time and call init() function of #tdm_backend_module.
1105 typedef struct _tdm_backend_module {
1106 const char *name; /**< The module name of a backend module */
1107 const char *vendor; /**< The vendor name of a backend module */
1108 unsigned long abi_version; /**< The ABI version of a backend module */
1111 * @brief The init function of a backend module
1112 * @param[in] dpy A display object
1113 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1114 * @return The backend module data
1115 * @see tdm_backend_data
1117 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1120 * @brief The deinit function of a backend module
1121 * @param[in] bdata The backend module data
1123 void (*deinit)(tdm_backend_data *bdata);
1124 } tdm_backend_module;
1127 * @brief Register the backend display functions to a display
1128 * @param[in] dpy A display object
1129 * @param[in] func_display display functions
1130 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1131 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1133 * A backend module @b SHOULD set the backend display functions at least.
1136 tdm_backend_register_func_display(tdm_display *dpy,
1137 tdm_func_display *func_display);
1140 * @brief Register the backend output functions to a display
1141 * @param[in] dpy A display object
1142 * @param[in] func_output output functions
1143 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1144 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1146 * A backend module @b SHOULD set the backend output functions at least.
1149 tdm_backend_register_func_output(tdm_display *dpy,
1150 tdm_func_output *func_output);
1153 * @brief Register the backend layer functions to a display
1154 * @param[in] dpy A display object
1155 * @param[in] func_layer layer functions
1156 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1157 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1159 * A backend module @b SHOULD set the backend layer functions at least.
1162 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1165 * @brief Register the backend hwc_window functions to a display
1166 * @param[in] dpy A display object
1167 * @param[in] func_hwc_window hwc_window functions
1168 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1169 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1171 * A backend module @b SHOULD set the backend hwc_window functions at least.
1174 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1177 * @brief Register the backend pp functions to a display
1178 * @param[in] dpy A display object
1179 * @param[in] func_pp pp functions
1180 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1181 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1183 * A backend module doesn'tcan skip to register the backend pp functions
1184 * if a hardware doesn't have the memory-to-memory converting device.
1187 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1190 * @brief Register the backend capture functions to a display
1191 * @param[in] dpy A display object
1192 * @param[in] func_capture capture functions
1193 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1194 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1196 * A backend module can skip to register the backend capture functions
1197 * if a hardware doesn't have the capture device.
1200 tdm_backend_register_func_capture(tdm_display *dpy,
1201 tdm_func_capture *func_capture);
1204 * @brief Increase the ref_count of a TDM buffer
1206 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1207 * becomes available for a next job. A TDM buffer can be used for TDM to show
1208 * it on screen or to capture an output and a layer. After all operations,
1209 * TDM will release it immediately when TDM doesn't need it any more.
1210 * @param[in] buffer A TDM buffer
1211 * @return A buffer itself. Otherwise, NULL.
1212 * @see tdm_buffer_unref_backend
1214 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1215 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1216 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1219 tdm_buffer_ref_backend(tbm_surface_h buffer);
1222 * @brief Decrease the ref_count of a TDM buffer
1223 * @param[in] buffer A TDM buffer
1224 * @see tdm_buffer_ref_backend
1227 tdm_buffer_unref_backend(tbm_surface_h buffer);
1230 * @brief The destroy handler of a TDM buffer
1231 * @param[in] buffer A TDM buffer
1232 * @param[in] user_data user data
1233 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1235 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1239 * @brief Add a destroy handler to a TDM buffer
1240 * @param[in] buffer A TDM buffer
1241 * @param[in] func A destroy handler
1242 * @param[in] user_data user data
1243 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1244 * @see tdm_buffer_remove_destroy_handler
1246 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1247 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1251 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1252 tdm_buffer_destroy_handler func, void *user_data);
1255 * @brief Remove a destroy handler from a TDM buffer
1256 * @param[in] buffer A TDM buffer
1257 * @param[in] func A destroy handler
1258 * @param[in] user_data user data
1259 * @see tdm_buffer_add_destroy_handler
1262 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1263 tdm_buffer_destroy_handler func, void *user_data);
1266 * @brief Add a FD handler for activity on the given file descriptor
1267 * @param[in] dpy A display object
1268 * @param[in] fd A file descriptor
1269 * @param[in] mask to monitor FD
1270 * @param[in] func A FD handler function
1271 * @param[in] user_data user data
1272 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1273 * @return A FD event source
1274 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1276 tdm_event_loop_source*
1277 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1278 tdm_event_loop_fd_handler func, void *user_data,
1282 * @brief Update the mask of the given FD event source
1283 * @param[in] source The given FD event source
1284 * @param[in] mask to monitor FD
1285 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1288 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1291 * @brief Add a timer handler
1292 * @param[in] dpy A display object
1293 * @param[in] func A timer handler function
1294 * @param[in] user_data user data
1295 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1296 * @return A timer event source
1297 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1299 tdm_event_loop_source*
1300 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1301 void *user_data, tdm_error *error);
1304 * @brief Update the millisecond delay time of the given timer event source.
1305 * @param[in] source The given timer event source
1306 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1307 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1310 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1313 * @brief Remove the given event source
1314 * @param[in] source The given event source
1315 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1318 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1321 * @brief Trigger a 'need to validate' event.
1322 * @param[in] output The output the event should be triggered for.
1323 * @note The global display lock has to be locked before the call to this function.
1324 * @see #tdm_output_set_need_validate_handler
1327 tdm_backend_trigger_need_validate_event(tdm_output *output);
1333 #endif /* _TDM_BACKEND_H_ */