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 "tdm_private.h"
43 * Basically tdm vblank doesn't care about thread things.
44 * However, to use tdm_event_loop_xxx functions, have to use the internal function.
45 * So need to lock/unlock the mutex of private_display. And valid_vblank_list and
46 * valid_wait_list should be protected by valid_list_lock because tdm_vblank can
47 * be used in multi-thread.
51 * - aligned by HW vblank
52 * - use a tdm_event_loop_source object only.
55 #define TDM_VBLANK_DEFAULT_VREFRESH 30
57 /* We expact "(unsigned int)(0.0016667 / 0.0016667) = 1". But it becomes 0. */
58 #define TDM_TIME_MARGIN 0.0000001
60 #define TDM_VBLANK_UINT_MAX 4294967295U
61 #define TDM_VBLANK_UINT_1Q 1073741823U /* UINT_MAX / 4 */
62 #define TDM_VBLANK_UINT_3Q 3221225471U /* UINT_MAX / 4 * 3 */
64 /* (seq < TDM_VBLANK_UINT_1Q && TDM_VBLANK_UINT_3Q < last_seq) means
65 * that the sequence value has reached the max value and started from 0 again.
67 #define TDM_VBLANK_SEQ_REACHED_MAX(seq, last_seq) \
68 ((seq) < TDM_VBLANK_UINT_1Q && TDM_VBLANK_UINT_3Q < (last_seq))
70 #define VER(fmt, arg...) TDM_ERR("[%p] "fmt, private_vblank, ##arg)
71 #define VWR(fmt, arg...) TDM_WRN("[%p] "fmt, private_vblank, ##arg)
72 #define VIN(fmt, arg...) do { if (tdm_debug_module & TDM_DEBUG_VBLANK) TDM_INFO("[%p] "fmt, private_vblank, ##arg); } while (0)
73 #define VDB(fmt, arg...) do { if (tdm_debug_module & TDM_DEBUG_VBLANK) TDM_DBG("[%p] "fmt, private_vblank, ##arg); } while (0)
80 } tdm_vblank_wait_type;
83 VBLANK_EVENT_TYPE_NONE,
86 } tdm_vblank_event_type;
88 typedef struct _tdm_vblank_wait_info tdm_vblank_wait_info;
90 typedef struct _tdm_private_vblank {
91 struct list_head valid_link;
98 tdm_output_conn_status connection;
99 unsigned int vrefresh;
101 tdm_vblank_event_type last_type;
102 unsigned int check_HW_or_SW;
103 char name[TDM_NAME_LEN];
105 unsigned int fps_changeable;
106 unsigned int fps_fixed;
108 unsigned int enable_fake;
109 unsigned int ignore_global_fps;
110 unsigned int in_create_handler;
113 unsigned int quotient;
116 unsigned int last_seq;
119 unsigned int add_front;
120 struct wl_resource *resource;
123 double HW_vblank_gap;
124 struct list_head HW_wait_list;
127 tdm_event_loop_source *SW_timer;
128 struct list_head SW_wait_list;
131 tdm_event_loop_source *timeout_timer;
132 } tdm_private_vblank;
134 struct _tdm_vblank_wait_info {
135 struct list_head link;
136 struct list_head valid_link;
141 unsigned int interval;
144 tdm_vblank_handler func;
146 tdm_private_vblank *private_vblank;
148 tdm_vblank_wait_type type;
151 unsigned int target_seq;
154 typedef struct _tdm_vblank_create_handler_info {
155 struct list_head link;
157 tdm_vblank_create_handler func;
159 } tdm_vblank_create_handler_info;
161 /* valid_vblank_list, valid_wait_list and create_handler_list should be protected
162 * by valid_list_lock because tdm_vblank can be used in multi-thread.
164 static pthread_mutex_t valid_list_lock = PTHREAD_MUTEX_INITIALIZER;
165 static struct list_head valid_vblank_list;
166 static struct list_head valid_wait_list;
167 static struct list_head create_handler_list;
168 static unsigned int vblank_list_inited;
169 static unsigned int vblank_global_fps;
170 static double stamp = 0;
172 static void _tdm_vblank_cb_vblank_SW(tdm_private_display *private_display, void *object, tdm_thread_cb_base *cb_base, void *user_data);
173 static tdm_error _tdm_vblank_cb_timeout_SW(void *user_data);
174 static tdm_error _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info);
175 static void _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
176 unsigned int tv_sec, unsigned int tv_usec,
178 static void _tdm_vblank_timeout_timer_update(tdm_private_vblank *private_vblank, int ms_delay);
179 static void _tdm_vblank_get_client_information(tdm_private_vblank *private_vblank,
180 pid_t *pid, const char **name);
184 _print_list(tdm_private_vblank *private_vblank)
186 tdm_vblank_wait_info *w = NULL;
189 LIST_FOR_EACH_ENTRY(w, &private_vblank->HW_wait_list, link) {
190 VIN("HW_wait(%p): type(%d) req_time(%.6f) target_time(%.6f) target_seq(%u)",
191 w, w->type, w->req_time, w->target_time, w->target_seq);
195 LIST_FOR_EACH_ENTRY(w, &private_vblank->SW_wait_list, link) {
196 VIN("SW_wait(%p): type(%d) req_time(%.6f) target_time(%.6f) target_seq(%u)",
197 w, w->type, w->req_time, w->target_time, w->target_seq);
207 tdm_vblank_is_valid(tdm_vblank *vblank)
209 tdm_private_vblank *v = NULL;
211 if (vblank && vblank_list_inited) {
212 pthread_mutex_lock(&valid_list_lock);
213 LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
214 if (v == (tdm_private_vblank *)vblank) {
215 pthread_mutex_unlock(&valid_list_lock);
219 pthread_mutex_unlock(&valid_list_lock);
226 _tdm_vblank_valid_list_add(struct list_head *valid_link, struct list_head *valid_list)
228 pthread_mutex_lock(&valid_list_lock);
229 LIST_ADDTAIL(valid_link, valid_list);
230 pthread_mutex_unlock(&valid_list_lock);
234 _tdm_vblank_valid_list_del(struct list_head *valid_link)
236 pthread_mutex_lock(&valid_list_lock);
237 LIST_DEL(valid_link);
238 pthread_mutex_unlock(&valid_list_lock);
242 _tdm_vblank_find_object(tdm_private_display *private_display, double vblank_stamp)
244 tdm_private_vblank *v = NULL;
246 pthread_mutex_lock(&valid_list_lock);
247 LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
248 if (v->stamp == vblank_stamp) {
249 pthread_mutex_unlock(&valid_list_lock);
253 pthread_mutex_unlock(&valid_list_lock);
258 static inline unsigned int
259 _tdm_vblank_check_valid_wait(tdm_vblank_wait_info *wait_info)
261 tdm_vblank_wait_info *w = NULL;
266 pthread_mutex_lock(&valid_list_lock);
267 LIST_FOR_EACH_ENTRY(w, &valid_wait_list, valid_link) {
268 if (w == wait_info) {
269 pthread_mutex_unlock(&valid_list_lock);
273 pthread_mutex_unlock(&valid_list_lock);
278 static inline unsigned int
279 _tdm_vblank_find_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
281 tdm_vblank_wait_info *w = NULL;
286 LIST_FOR_EACH_ENTRY(w, list, link) {
287 if (w->stamp == wait_info->stamp)
295 _tdm_vblank_insert_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
297 tdm_vblank_wait_info *w = NULL;
298 tdm_vblank_wait_info *found = NULL;
300 if (LIST_IS_EMPTY(list)) {
301 LIST_ADDTAIL(&wait_info->link, list);
305 LIST_FOR_EACH_ENTRY(w, list, link) {
306 if (wait_info->type == VBLANK_TYPE_SW) {
307 if (wait_info->target_time == 0)
308 TDM_NEVER_GET_HERE();
309 if (w->target_time <= wait_info->target_time) {
314 if (w->interval <= wait_info->interval) {
322 LIST_ADD(&wait_info->link, &found->link);
324 LIST_ADDTAIL(&wait_info->link, list->next);
328 _tdm_vblank_change_to_SW(tdm_private_vblank *private_vblank)
330 tdm_vblank_wait_info *w = NULL, *ww = NULL;
332 LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
335 tdm_display_lock(private_vblank->dpy);
336 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, w);
337 tdm_display_unlock(private_vblank->dpy);
339 w->type = VBLANK_TYPE_SW_FAKE;
340 _tdm_vblank_wait_SW(w);
345 _tdm_vblank_free_HW_wait(tdm_private_vblank *private_vblank, tdm_error error, unsigned int call_cb)
347 tdm_vblank_wait_info *w = NULL, *ww = NULL;
349 if (!LIST_IS_EMPTY(&private_vblank->HW_wait_list)) {
351 const char *proc_name;
352 _tdm_vblank_get_client_information(private_vblank, &pid, &proc_name);
353 VWR("TDM HW vblank destroyed forcely!! (pid: %u, name: %s)", pid, proc_name);
356 LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
358 _tdm_vblank_valid_list_del(&w->valid_link);
360 tdm_display_lock(private_vblank->dpy);
361 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, w);
362 tdm_display_unlock(private_vblank->dpy);
364 VDB("wait(%p) last(%.6f) sequence(%u) done (error:%d, call_cb:%u)",
365 w, (double)0.0, w->target_seq, error, call_cb);
367 if (call_cb && w->func)
368 w->func(private_vblank, error, 0, 0, 0, w->user_data);
375 _tdm_vblank_update_output_info(tdm_private_vblank *private_vblank)
377 tdm_output *output = private_vblank->output;
378 tdm_output_conn_status connection = TDM_OUTPUT_CONN_STATUS_DISCONNECTED;
379 unsigned int vrefresh = TDM_VBLANK_DEFAULT_VREFRESH;
382 ret = tdm_output_get_conn_status(output, &connection);
383 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
385 if (connection == TDM_OUTPUT_CONN_STATUS_MODE_SETTED) {
386 const tdm_output_mode *mode = NULL;
387 ret = tdm_output_get_mode(output, &mode);
388 if (ret == TDM_ERROR_NONE && mode)
389 vrefresh = mode->vrefresh;
391 VWR("mode not setted!!!");
394 private_vblank->connection = connection;
395 private_vblank->vrefresh = vrefresh;
396 private_vblank->HW_vblank_gap = 1.0 / private_vblank->vrefresh;
398 if (private_vblank->fps_changeable)
399 private_vblank->fps = vrefresh;
401 VIN("connection(%d) vrefresh(%d) fps(%d) fps_changeable(%d)",
402 private_vblank->connection,
403 private_vblank->vrefresh, private_vblank->fps, private_vblank->fps_changeable);
406 /* LCOV_EXCL_START */
408 _tdm_vblank_cb_output_change(tdm_output *output, tdm_output_change_type type,
409 tdm_value value, void *user_data)
411 tdm_private_vblank *private_vblank = user_data;
413 TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(private_vblank));
416 case TDM_OUTPUT_CHANGE_DPMS:
417 VIN("dpms %s", tdm_dpms_str(value.u32));
418 private_vblank->check_HW_or_SW = 1;
419 if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(value.u32)) {
420 if (private_vblank->enable_fake)
421 _tdm_vblank_change_to_SW(private_vblank);
423 tdm_display_lock(private_vblank->dpy);
424 _tdm_vblank_timeout_timer_update(private_vblank, 0);
425 tdm_display_unlock(private_vblank->dpy);
427 _tdm_vblank_free_HW_wait(private_vblank, TDM_ERROR_DPMS_OFF, 1);
431 case TDM_OUTPUT_CHANGE_CONNECTION:
432 if (private_vblank->connection == value.u32)
434 VIN("output %s", tdm_status_str(value.u32));
435 _tdm_vblank_update_output_info(private_vblank);
436 private_vblank->check_HW_or_SW = 1;
437 if (private_vblank->connection == TDM_OUTPUT_CONN_STATUS_DISCONNECTED) {
438 if (private_vblank->enable_fake)
439 _tdm_vblank_change_to_SW(private_vblank);
441 tdm_display_lock(private_vblank->dpy);
442 _tdm_vblank_timeout_timer_update(private_vblank, 0);
443 tdm_display_unlock(private_vblank->dpy);
445 _tdm_vblank_free_HW_wait(private_vblank, TDM_ERROR_OUTPUT_DISCONNECTED, 1);
456 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps)
458 tdm_private_vblank *v = NULL;
459 tdm_error ret = TDM_ERROR_NONE;
461 TDM_RETURN_VAL_IF_FAIL(pid > 0, TDM_ERROR_INVALID_PARAMETER);
462 TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
464 TDM_INFO("pid: %u, name: %s, fps: %d", pid, name, fps);
466 pthread_mutex_lock(&valid_list_lock);
467 LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
468 struct wl_client *client;
469 pid_t client_pid = 0;
474 client = wl_resource_get_client(v->resource);
478 wl_client_get_credentials(client, &client_pid, NULL, NULL);
480 if (client_pid != pid)
483 if (name && strncmp(name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN)) {
484 if (strncmp(v->name, name, TDM_NAME_LEN))
488 ret = tdm_vblank_set_fps(v, fps);
489 if (ret == TDM_ERROR_NONE)
490 TDM_INFO("(pid:%u) '%s' fps changed: %d", pid, v->name, fps);
492 TDM_ERR("(pid:%u) '%s' fps changing failed: %d", pid, v->name, fps);
494 pthread_mutex_unlock(&valid_list_lock);
496 return TDM_ERROR_NONE;
500 tdm_vblank_set_client_ignore_global_fps(unsigned int pid, const char *name, unsigned int ignore)
502 tdm_private_vblank *v = NULL;
503 tdm_error ret = TDM_ERROR_NONE;
505 TDM_RETURN_VAL_IF_FAIL(pid > 0, TDM_ERROR_INVALID_PARAMETER);
507 TDM_INFO("pid: %u, name: %s, ignore: %u", pid, name, ignore);
509 pthread_mutex_lock(&valid_list_lock);
510 LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
511 struct wl_client *client;
512 pid_t client_pid = 0;
517 client = wl_resource_get_client(v->resource);
521 wl_client_get_credentials(client, &client_pid, NULL, NULL);
523 if (client_pid != pid)
526 if (name && strncmp(name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN)) {
527 if (strncmp(v->name, name, TDM_NAME_LEN))
531 ret = tdm_vblank_ignore_global_fps(v, ignore);
532 if (ret == TDM_ERROR_NONE)
533 TDM_INFO("(pid:%u) '%s' ignore changed: %u", pid, v->name, ignore);
535 TDM_ERR("(pid:%u) '%s' ignore changing failed: %u", pid, v->name, ignore);
537 pthread_mutex_unlock(&valid_list_lock);
539 return TDM_ERROR_NONE;
543 tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps)
545 tdm_private_vblank *v = NULL;
548 TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
550 TDM_INFO("global fps: %s fps(%d)", (enable) ? "enabled" : "disabled", fps);
552 pthread_mutex_lock(&valid_list_lock);
554 vblank_global_fps = (enable) ? fps : 0;
556 LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
557 /* skip if vblank is created in server side */
561 v->check_HW_or_SW = 1;
563 pthread_mutex_unlock(&valid_list_lock);
565 return TDM_ERROR_NONE;
569 _tdm_vblank_thread_cb_create(tdm_private_display *private_display, void *object, tdm_thread_cb_base *cb_base, void *user_data)
571 tdm_thread_cb_vblank_create *vblank_create = (tdm_thread_cb_vblank_create *)cb_base;
572 tdm_vblank_create_handler_info *ch_info = user_data;
573 tdm_private_vblank *private_vblank;
575 TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
577 assert(ch_info != NULL);
579 private_vblank = _tdm_vblank_find_object(private_display, vblank_create->vblank_stamp);
580 if (!private_vblank) {
581 TDM_DBG("can't find vblank(%.0f) from valid_list", vblank_create->vblank_stamp);
585 private_vblank->in_create_handler = 1;
586 tdm_display_unlock(private_display);
587 ch_info->func(private_vblank, ch_info->user_data);
588 tdm_display_lock(private_display);
589 private_vblank->in_create_handler = 0;
593 _tdm_vblank_call_thread_cb(tdm_private_vblank *private_vblank)
595 tdm_thread_cb_vblank_create vblank_create;
598 memset(&vblank_create, 0, sizeof vblank_create);
599 vblank_create.base.type = TDM_THREAD_CB_VBLANK_CREATE;
600 vblank_create.base.length = sizeof vblank_create;
601 vblank_create.base.object_stamp = 1;
602 vblank_create.base.data = NULL;
603 vblank_create.base.sync = 0;
604 vblank_create.vblank_stamp = private_vblank->stamp;
606 ret = tdm_thread_cb_call(private_vblank->dpy, &vblank_create.base);
607 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
609 return TDM_ERROR_NONE;
613 tdm_vblank_add_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data)
615 tdm_vblank_create_handler_info *ch_info = NULL;
618 TDM_RETURN_VAL_IF_FAIL(dpy != NULL, TDM_ERROR_INVALID_PARAMETER);
619 TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
621 pthread_mutex_lock(&valid_list_lock);
623 LIST_FOR_EACH_ENTRY(ch_info, &create_handler_list, link) {
624 if (ch_info->func == func && ch_info->user_data == user_data) {
625 TDM_ERR("can't be added twice");
626 pthread_mutex_unlock(&valid_list_lock);
627 return TDM_ERROR_BAD_REQUEST;
631 ch_info = calloc(1, sizeof *ch_info);
633 TDM_ERR("alloc failed: %m");
634 pthread_mutex_unlock(&valid_list_lock);
635 return TDM_ERROR_OUT_OF_MEMORY;
638 tdm_display_lock(dpy);
639 ret = tdm_thread_cb_add(dpy, TDM_THREAD_CB_VBLANK_CREATE, NULL, _tdm_vblank_thread_cb_create, ch_info);
640 tdm_display_unlock(dpy);
642 if (ret != TDM_ERROR_NONE) {
643 TDM_ERR("tdm_thread_cb_add failed");
645 pthread_mutex_unlock(&valid_list_lock);
649 ch_info->func = func;
650 ch_info->user_data = user_data;
652 LIST_ADDTAIL(&ch_info->link, &create_handler_list);
654 pthread_mutex_unlock(&valid_list_lock);
656 return TDM_ERROR_NONE;
660 tdm_vblank_remove_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data)
662 tdm_vblank_create_handler_info *ch_info = NULL, *hh = NULL;
664 TDM_RETURN_IF_FAIL(dpy != NULL);
665 TDM_RETURN_IF_FAIL(func != NULL);
667 tdm_display_lock(dpy);
668 pthread_mutex_lock(&valid_list_lock);
669 LIST_FOR_EACH_ENTRY_SAFE(ch_info, hh, &create_handler_list, link) {
670 if (ch_info->func != func || ch_info->user_data != user_data)
673 tdm_thread_cb_remove(dpy, TDM_THREAD_CB_VBLANK_CREATE, NULL, _tdm_vblank_thread_cb_create, ch_info);
675 LIST_DEL(&ch_info->link);
677 pthread_mutex_unlock(&valid_list_lock);
678 tdm_display_unlock(dpy);
681 pthread_mutex_unlock(&valid_list_lock);
682 tdm_display_unlock(dpy);
686 _tdm_vblank_find_display(tdm_private_display *private_display, double stamp)
688 return private_display;
692 tdm_vblank_init(tdm_display *dpy)
694 if (vblank_list_inited)
695 return TDM_ERROR_NONE;
697 LIST_INITHEAD(&valid_vblank_list);
698 LIST_INITHEAD(&valid_wait_list);
699 LIST_INITHEAD(&create_handler_list);
701 tdm_thread_cb_set_find_func(TDM_THREAD_CB_VBLANK_SW, _tdm_vblank_find_object);
702 tdm_thread_cb_set_find_func(TDM_THREAD_CB_VBLANK_CREATE, _tdm_vblank_find_display);
704 vblank_list_inited = 1;
706 return TDM_ERROR_NONE;
710 tdm_vblank_deinit(tdm_display *dpy)
712 tdm_vblank_create_handler_info *ch_info = NULL, *hh = NULL;
714 if (!vblank_list_inited)
717 if (!LIST_IS_EMPTY(&valid_vblank_list))
718 TDM_NEVER_GET_HERE();
720 if (!LIST_IS_EMPTY(&valid_wait_list))
721 TDM_NEVER_GET_HERE();
723 LIST_FOR_EACH_ENTRY_SAFE(ch_info, hh, &create_handler_list, link) {
724 LIST_DEL(&ch_info->link);
728 vblank_list_inited = 0;
732 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error)
734 tdm_private_vblank *private_vblank;
737 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_display_is_valid(dpy), TDM_ERROR_INVALID_PARAMETER, NULL);
738 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_output_is_valid(output), TDM_ERROR_INVALID_PARAMETER, NULL);
741 *error = TDM_ERROR_NONE;
743 private_vblank = calloc(1, sizeof * private_vblank);
744 if (!private_vblank) {
745 /* LCOV_EXCL_START */
747 *error = TDM_ERROR_OUT_OF_MEMORY;
748 TDM_ERR("alloc failed");
753 ret = tdm_output_add_change_handler(output, _tdm_vblank_cb_output_change, private_vblank);
754 if (ret != TDM_ERROR_NONE) {
755 free(private_vblank);
757 *error = TDM_ERROR_OPERATION_FAILED;
758 TDM_ERR("tdm_output_add_change_handler failed");
762 private_vblank->stamp = ++stamp;
763 private_vblank->owner_tid = syscall(SYS_gettid);
764 private_vblank->dpy = dpy;
765 private_vblank->output = output;
766 private_vblank->check_HW_or_SW = 1;
767 private_vblank->fps_changeable = 1;
768 private_vblank->last_interval = -1;
770 _tdm_vblank_update_output_info(private_vblank);
772 strncpy(private_vblank->name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN - 1);
773 private_vblank->name[TDM_NAME_LEN - 1] = '\0';
775 LIST_INITHEAD(&private_vblank->HW_wait_list);
776 LIST_INITHEAD(&private_vblank->SW_wait_list);
778 _tdm_vblank_valid_list_add(&private_vblank->valid_link, &valid_vblank_list);
780 VIN("created. vrefresh(%d) connection(%d)",
781 private_vblank->vrefresh, private_vblank->connection);
783 tdm_display_lock(private_vblank->dpy);
784 _tdm_vblank_call_thread_cb(private_vblank);
785 tdm_display_unlock(private_vblank->dpy);
787 return (tdm_vblank *)private_vblank;
791 tdm_vblank_destroy(tdm_vblank *vblank)
793 tdm_private_vblank *private_vblank = vblank;
794 tdm_vblank_wait_info *w = NULL, *ww = NULL;
796 TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(vblank));
798 if (private_vblank->in_create_handler) {
799 TDM_ERR("NOT allowed to be called in a create handler");
803 _tdm_vblank_valid_list_del(&private_vblank->valid_link);
805 if (private_vblank->SW_timer) {
806 tdm_display_lock(private_vblank->dpy);
807 tdm_thread_cb_remove(private_vblank, TDM_THREAD_CB_VBLANK_SW, NULL, _tdm_vblank_cb_vblank_SW, NULL);
808 tdm_event_loop_source_remove(private_vblank->SW_timer);
809 tdm_display_unlock(private_vblank->dpy);
812 tdm_output_remove_change_handler(private_vblank->output,
813 _tdm_vblank_cb_output_change, private_vblank);
815 _tdm_vblank_free_HW_wait(private_vblank, 0, 0);
817 if (!LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
819 const char *proc_name;
820 _tdm_vblank_get_client_information(private_vblank, &pid, &proc_name);
821 VER("TDM SW vblank destroyed forcely!! (pid: %u, name: %s)", pid, proc_name);
824 LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
826 _tdm_vblank_valid_list_del(&w->valid_link);
830 if (private_vblank->timeout_timer) {
831 tdm_display_lock(private_vblank->dpy);
832 tdm_event_loop_source_remove(private_vblank->timeout_timer);
833 tdm_display_unlock(private_vblank->dpy);
838 free(private_vblank);
842 tdm_vblank_get_output(tdm_vblank *vblank, tdm_error *error)
844 tdm_private_vblank *private_vblank = vblank;
845 tdm_error ret = TDM_ERROR_NONE;
847 TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER, NULL);
850 *error = TDM_ERROR_NONE;
852 return private_vblank->output;
856 tdm_vblank_get_client_pid(tdm_vblank *vblank, pid_t *pid)
858 tdm_private_vblank *private_vblank = vblank;
859 struct wl_client *client;
861 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
862 TDM_RETURN_VAL_IF_FAIL(pid != NULL, TDM_ERROR_INVALID_PARAMETER);
864 if (!private_vblank->resource) {
866 return TDM_ERROR_NONE;
869 client = wl_resource_get_client(private_vblank->resource);
872 return TDM_ERROR_NONE;
875 wl_client_get_credentials(client, pid, NULL, NULL);
877 return TDM_ERROR_NONE;
881 tdm_vblank_set_name(tdm_vblank *vblank, const char *name)
883 tdm_private_vblank *private_vblank = vblank;
885 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
888 name = TDM_VBLANK_DEFAULT_NAME;
890 strncpy(private_vblank->name, name, TDM_NAME_LEN - 1);
891 private_vblank->name[TDM_NAME_LEN - 1] = '\0';
893 VIN("name(%s)", name);
895 return TDM_ERROR_NONE;
899 tdm_vblank_get_name(tdm_vblank *vblank, const char **name)
901 tdm_private_vblank *private_vblank = vblank;
903 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
904 TDM_RETURN_VAL_IF_FAIL(name != NULL, TDM_ERROR_INVALID_PARAMETER);
906 *name = (const char*)private_vblank->name;
908 return TDM_ERROR_NONE;
912 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps)
914 tdm_private_vblank *private_vblank = vblank;
916 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
917 TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
919 if (private_vblank->fps_fixed) {
920 VIN("fps(%u) can't be changed", private_vblank->fps);
921 return TDM_ERROR_NONE;
924 private_vblank->fps_changeable = 0;
926 if (private_vblank->fps == fps)
927 return TDM_ERROR_NONE;
929 private_vblank->fps = fps;
930 private_vblank->check_HW_or_SW = 1;
932 VIN("fps(%u) changed", fps);
934 return TDM_ERROR_NONE;
938 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps)
940 tdm_private_vblank *private_vblank = vblank;
942 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
943 TDM_RETURN_VAL_IF_FAIL(fps != NULL, TDM_ERROR_INVALID_PARAMETER);
945 *fps = private_vblank->fps;
947 return TDM_ERROR_NONE;
951 tdm_vblank_set_fixed_fps(tdm_vblank *vblank, unsigned int fps)
953 tdm_private_vblank *private_vblank = vblank;
955 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
956 TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
958 private_vblank->fps_changeable = 0;
959 private_vblank->fps_fixed = 1;
961 if (private_vblank->fps == fps)
962 return TDM_ERROR_NONE;
964 private_vblank->fps = fps;
965 private_vblank->check_HW_or_SW = 1;
967 VIN("fps(%u) fixed", fps);
969 return TDM_ERROR_NONE;
973 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore)
975 tdm_private_vblank *private_vblank = vblank;
977 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
979 if (private_vblank->ignore_global_fps == ignore)
980 return TDM_ERROR_NONE;
982 private_vblank->ignore_global_fps = ignore;
983 private_vblank->check_HW_or_SW = 1;
985 VIN("ignore_global_fps(%u)", private_vblank->ignore_global_fps);
987 return TDM_ERROR_NONE;
991 tdm_vblank_set_offset(tdm_vblank *vblank, int offset)
993 tdm_private_vblank *private_vblank = vblank;
995 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
996 TDM_RETURN_VAL_IF_FAIL(offset >= 0, TDM_ERROR_INVALID_PARAMETER);
998 if (private_vblank->offset == offset)
999 return TDM_ERROR_NONE;
1001 private_vblank->offset = offset;
1002 private_vblank->check_HW_or_SW = 1;
1004 VIN("offset(%u)", private_vblank->offset);
1006 return TDM_ERROR_NONE;
1010 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset)
1012 tdm_private_vblank *private_vblank = vblank;
1014 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1015 TDM_RETURN_VAL_IF_FAIL(offset != NULL, TDM_ERROR_INVALID_PARAMETER);
1017 *offset = private_vblank->offset;
1019 return TDM_ERROR_NONE;
1023 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake)
1025 tdm_private_vblank *private_vblank = vblank;
1027 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1029 if (private_vblank->enable_fake == enable_fake)
1030 return TDM_ERROR_NONE;
1032 private_vblank->enable_fake = enable_fake;
1034 VIN("enable_fake(%u)", private_vblank->enable_fake);
1036 return TDM_ERROR_NONE;
1040 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake)
1042 tdm_private_vblank *private_vblank = vblank;
1044 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1045 TDM_RETURN_VAL_IF_FAIL(enable_fake != NULL, TDM_ERROR_INVALID_PARAMETER);
1047 *enable_fake = private_vblank->enable_fake;
1049 return TDM_ERROR_NONE;
1053 _tdm_vblank_timeout_timer_cb(void *user_data)
1055 tdm_private_vblank *private_vblank = user_data;
1056 tdm_vblank_wait_info *w = NULL;
1058 const char *proc_name;
1060 TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_OPERATION_FAILED);
1062 _tdm_vblank_get_client_information(private_vblank, &pid, &proc_name);
1064 VER("TDM vblank TIMEOUT!! (pid: %u, name: %s)", pid, proc_name);
1065 VER("quotient(%u) last_seq(%u) last_time(%.6f)", private_vblank->quotient, private_vblank->last_seq, private_vblank->last_time);
1067 LIST_FOR_EACH_ENTRY(w, &private_vblank->HW_wait_list, link) {
1068 VER("wait_info(%p) req_time(%.6f) target_seq(%u) interval(%u) hw_interval(%d)",
1069 w, w->req_time, w->target_seq, w->interval, w->hw_interval);
1070 tdm_output_vblank_print_wait_information(private_vblank->output, w);
1073 LIST_FOR_EACH_ENTRY(w, &private_vblank->SW_wait_list, link) {
1074 VER("wait_info(%p) req_time(%.6f) target_time(%.6f) target_seq(%u) interval(%u)",
1075 w, w->req_time, w->target_time, w->target_seq, w->interval);
1078 return TDM_ERROR_NONE;
1082 _tdm_vblank_timeout_timer_update(tdm_private_vblank *private_vblank, int ms_delay)
1086 if (!private_vblank->timeout_timer) {
1087 private_vblank->timeout_timer =
1088 tdm_event_loop_add_timer_handler(private_vblank->dpy,
1089 _tdm_vblank_timeout_timer_cb,
1092 if (!private_vblank->timeout_timer) {
1093 VER("couldn't add timer");
1096 VIN("Create Timeout timer");
1099 ret = tdm_event_loop_source_timer_update(private_vblank->timeout_timer, ms_delay);
1100 if (ret != TDM_ERROR_NONE) {
1101 VER("couldn't update timer");
1106 VDB("timeout timer updated");
1108 VDB("timeout timer disabled");
1112 _tdm_vblank_sw_timer_update(tdm_private_vblank *private_vblank)
1114 tdm_vblank_wait_info *first_wait_info = NULL;
1115 double curr, target;
1119 if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
1120 VER("no wait_info");
1121 return TDM_ERROR_OPERATION_FAILED;
1124 first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
1125 curr = tdm_helper_get_time();
1126 target = first_wait_info->target_time;
1128 /* ms_delay should be more that 1 */
1132 ms_delay = ceil((target - curr) * 1000.0);
1137 if (ms_delay > 5000)
1138 VER("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
1140 VDB("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
1142 tdm_display_lock(private_vblank->dpy);
1144 if (!private_vblank->SW_timer) {
1145 private_vblank->SW_timer =
1146 tdm_event_loop_add_timer_handler(private_vblank->dpy,
1147 _tdm_vblank_cb_timeout_SW,
1150 if (!private_vblank->SW_timer) {
1151 tdm_display_unlock(private_vblank->dpy);
1152 VER("couldn't add timer");
1156 ret = tdm_thread_cb_add(private_vblank, TDM_THREAD_CB_VBLANK_SW, NULL, _tdm_vblank_cb_vblank_SW, NULL);
1157 if (ret != TDM_ERROR_NONE) {
1158 tdm_event_loop_source_remove(private_vblank->SW_timer);
1159 private_vblank->SW_timer = NULL;
1160 tdm_display_unlock(private_vblank->dpy);
1161 VER("couldn't add thread_cb");
1165 VIN("Create SW timer");
1168 private_vblank->last_interval = ms_delay;
1170 ret = tdm_event_loop_source_timer_update(private_vblank->SW_timer, ms_delay);
1171 if (ret != TDM_ERROR_NONE) {
1172 /* LCOV_EXCL_START */
1173 tdm_display_unlock(private_vblank->dpy);
1174 VER("couldn't update timer");
1176 /* LCOV_EXCL_STOP */
1179 tdm_display_unlock(private_vblank->dpy);
1181 return TDM_ERROR_NONE;
1185 _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
1186 unsigned int tv_sec, unsigned int tv_usec,
1189 tdm_vblank_wait_info *wait_info = user_data;
1190 tdm_private_vblank *private_vblank;
1192 if (!_tdm_vblank_check_valid_wait(wait_info)) {
1193 TDM_ERR("can't find wait(%p) from valid_wait_list", wait_info);
1197 private_vblank = wait_info->private_vblank;
1198 TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(private_vblank));
1200 assert(private_vblank->owner_tid == syscall(SYS_gettid));
1202 if (!_tdm_vblank_find_wait(wait_info, &private_vblank->HW_wait_list)) {
1203 VER("can't find wait(%p)", wait_info);
1207 if (wait_info->type == VBLANK_TYPE_HW_SW) {
1210 LIST_DEL(&wait_info->link);
1212 /* kernel sends the wrong time of first vblank event. and the time of
1213 * second vblank is correct.
1215 wait_info->target_time = TDM_TIME(tv_sec, tv_usec);
1216 wait_info->target_time += (((double)private_vblank->offset) / 1000.0);
1218 _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
1220 ret = _tdm_vblank_sw_timer_update(private_vblank);
1222 /* wait_info will be freed in _tdm_vblank_cb_timeout_SW() */
1223 if (ret == TDM_ERROR_NONE) {
1224 VIN("wait(%p) SW timer", wait_info);
1228 VER("couldn't update sw timer");
1231 tdm_display_lock(private_vblank->dpy);
1232 _tdm_vblank_timeout_timer_update(private_vblank, 0);
1233 tdm_display_unlock(private_vblank->dpy);
1235 LIST_DEL(&wait_info->link);
1236 _tdm_vblank_valid_list_del(&wait_info->valid_link);
1238 /* tv_sec & tv_usec shouldn't be zero. But sometimes they are zero in some hardware.
1239 * We need to prohibit that last_time becomes zero because "last_time == 0" means
1240 * that a tdm_vblank object is just created and doesn't have the first vblank event.
1241 * If last_time becomes 0, it would make issue.
1243 if (tv_sec == 0 && tv_usec == 0) {
1244 double curr = tdm_helper_get_time();
1245 tv_sec = TDM_TIME_SEC(curr);
1246 tv_usec = TDM_TIME_USEC(curr);
1249 private_vblank->last_seq = wait_info->target_seq;
1250 private_vblank->last_time = TDM_TIME(tv_sec, tv_usec);
1252 VDB("wait(%p) last(%.6f) sequence(%u) done", wait_info, private_vblank->last_time, wait_info->target_seq);
1254 if (tdm_ttrace_module & TDM_TTRACE_VBLANK)
1255 TDM_TRACE_ASYNC_END((int)wait_info->req_time, "TDM_Vblank:%u", (unsigned int)private_vblank->stamp);
1257 if (wait_info->func)
1258 wait_info->func(private_vblank, TDM_ERROR_NONE, wait_info->target_seq,
1259 tv_sec, tv_usec, wait_info->user_data);
1265 _tdm_vblank_wait_HW(tdm_vblank_wait_info *wait_info)
1267 tdm_private_vblank *private_vblank = wait_info->private_vblank;
1271 if (private_vblank->last_type != VBLANK_EVENT_TYPE_HW) {
1272 VIN("Use HW vblank");
1273 private_vblank->last_type = VBLANK_EVENT_TYPE_HW;
1276 _tdm_vblank_insert_wait(wait_info, &private_vblank->HW_wait_list);
1278 if (private_vblank->last_time == 0) {
1279 hw_interval = wait_info->interval * private_vblank->quotient;
1281 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
1282 private_vblank->last_seq = 0;
1283 private_vblank->last_time = tdm_helper_get_time();
1285 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
1286 wait_info->target_seq = 1;
1288 VDB("wait(%p) last(%.6f) hw_itvl(%d) targ_seq(%u)",
1289 wait_info, private_vblank->last_time, hw_interval, wait_info->target_seq);
1291 double last, prev, req, curr, target;
1294 last = private_vblank->last_time;
1295 req = wait_info->req_time;
1297 /* make sure that req time is bigger than last. */
1301 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1302 prev = last + private_vblank->vblank_gap * skip;
1304 curr = tdm_helper_get_time();
1306 while (target < curr)
1307 target += (private_vblank->vblank_gap * wait_info->interval);
1309 hw_interval = (unsigned int)((target - curr) / private_vblank->HW_vblank_gap + TDM_TIME_MARGIN) + 1;
1311 wait_info->target_seq = private_vblank->last_seq;
1312 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1314 if (hw_interval > 300)
1315 VER("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
1316 wait_info, last, req - last, prev - last, curr - last, target, target - last,
1317 skip, hw_interval, wait_info->target_seq);
1319 VDB("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
1320 wait_info, last, req - last, prev - last, curr - last, target, target - last,
1321 skip, hw_interval, wait_info->target_seq);
1324 private_vblank->last_interval = hw_interval;
1325 wait_info->hw_interval = hw_interval;
1327 if (tdm_ttrace_module & TDM_TTRACE_VBLANK)
1328 TDM_TRACE_ASYNC_BEGIN((int)wait_info->req_time, "TDM_Vblank:%u", (unsigned int)private_vblank->stamp);
1330 if (private_vblank->add_front)
1331 ret = tdm_output_wait_vblank_add_front(private_vblank->output, hw_interval, 0,
1332 _tdm_vblank_cb_vblank_HW, wait_info);
1334 ret = tdm_output_wait_vblank(private_vblank->output, hw_interval, 0,
1335 _tdm_vblank_cb_vblank_HW, wait_info);
1337 if (ret != TDM_ERROR_NONE) {
1338 LIST_DEL(&wait_info->link);
1342 VDB("wait(%p) waiting", wait_info);
1344 return TDM_ERROR_NONE;
1348 _tdm_vblank_cb_vblank_SW(tdm_private_display *private_display, void *object, tdm_thread_cb_base *cb_base, void *user_data)
1350 tdm_private_vblank *private_vblank = object;
1351 tdm_vblank_wait_info *first_wait_info = NULL, *w = NULL, *ww = NULL;
1353 TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
1355 assert(private_vblank->owner_tid == syscall(SYS_gettid));
1357 if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
1358 VER("no wait_info");
1362 if (!LIST_IS_EMPTY(&private_vblank->HW_wait_list))
1363 TDM_NEVER_GET_HERE();
1365 first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
1366 TDM_RETURN_IF_FAIL(first_wait_info != NULL);
1368 _tdm_vblank_timeout_timer_update(private_vblank, 0);
1370 if (private_vblank->last_seq >= first_wait_info->target_seq)
1371 TDM_ERR("last_seq(%u) target_seq(%u)", private_vblank->last_seq, first_wait_info->target_seq);
1373 private_vblank->last_seq = first_wait_info->target_seq;
1374 private_vblank->last_time = first_wait_info->target_time;
1376 VDB("wait(%p) last(%.6f) sequence(%u) done", first_wait_info, private_vblank->last_time, first_wait_info->target_seq);
1378 LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
1379 if (w->target_time != first_wait_info->target_time)
1383 _tdm_vblank_valid_list_del(&w->valid_link);
1386 tdm_display_unlock(private_vblank->dpy);
1387 w->func(private_vblank, TDM_ERROR_NONE, w->target_seq,
1388 TDM_TIME_SEC(w->target_time), TDM_TIME_USEC(w->target_time),
1390 tdm_display_lock(private_vblank->dpy);
1398 _tdm_vblank_cb_timeout_SW(void *user_data)
1400 tdm_private_vblank *private_vblank = user_data;
1401 tdm_thread_cb_vblank_sw vblank_sw;
1404 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(private_vblank), TDM_ERROR_OPERATION_FAILED);
1406 VIN("timeout_SW -> thread-cb");
1408 memset(&vblank_sw, 0, sizeof vblank_sw);
1409 vblank_sw.base.type = TDM_THREAD_CB_VBLANK_SW;
1410 vblank_sw.base.length = sizeof vblank_sw;
1411 vblank_sw.base.object_stamp = private_vblank->stamp;
1412 vblank_sw.base.data = NULL;
1413 vblank_sw.base.sync = 0;
1415 ret = tdm_thread_cb_call(private_vblank, &vblank_sw.base);
1416 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
1418 return TDM_ERROR_NONE;
1422 _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info)
1424 tdm_private_vblank *private_vblank = wait_info->private_vblank;
1427 if (private_vblank->last_type != VBLANK_EVENT_TYPE_SW) {
1428 VIN("Use SW vblank");
1429 private_vblank->last_type = VBLANK_EVENT_TYPE_SW;
1432 if (private_vblank->last_time == 0) {
1433 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
1434 private_vblank->last_seq = 0;
1435 private_vblank->last_time = tdm_helper_get_time();
1437 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
1438 wait_info->target_seq = 1;
1439 wait_info->target_time = private_vblank->last_time + 0.001;
1441 VDB("wait(%p) last(%.6f) target(%.6f) target sequence(%u)",
1442 wait_info, private_vblank->last_time, wait_info->target_time, wait_info->target_seq);
1444 double last, prev, req, curr, target;
1447 last = private_vblank->last_time;
1448 req = wait_info->req_time;
1450 /* make sure that req time is bigger than last. */
1454 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1455 prev = last + private_vblank->vblank_gap * skip;
1457 curr = tdm_helper_get_time();
1458 target = prev + private_vblank->vblank_gap * wait_info->interval;
1460 while (target < curr)
1461 target += private_vblank->vblank_gap;
1463 wait_info->target_seq = private_vblank->last_seq;
1464 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1466 wait_info->target_time = target;
1468 VDB("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) targ_seq(%u)",
1469 wait_info, last, req - last, prev - last, curr - last,
1470 target, target - last, skip, wait_info->target_seq);
1473 _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
1475 ret = _tdm_vblank_sw_timer_update(private_vblank);
1476 if (ret != TDM_ERROR_NONE) {
1477 /* LCOV_EXCL_START */
1478 LIST_DEL(&wait_info->link);
1479 VER("couldn't update sw timer");
1481 /* LCOV_EXCL_STOP */
1484 return TDM_ERROR_NONE;
1488 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1489 unsigned int interval, tdm_vblank_handler func, void *user_data)
1491 tdm_private_vblank *private_vblank = vblank;
1492 tdm_vblank_wait_info *wait_info;
1493 tdm_output_dpms dpms = TDM_OUTPUT_DPMS_OFF;
1497 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1498 TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1499 TDM_RETURN_VAL_IF_FAIL(interval > 0, TDM_ERROR_INVALID_PARAMETER);
1501 if (private_vblank->in_create_handler) {
1502 TDM_ERR("NOT allowed to be called in a create handler");
1503 return TDM_ERROR_BAD_REQUEST;
1506 if (private_vblank->owner_tid != syscall(SYS_gettid)) {
1507 TDM_ERR("SHOULD be called in the owner thread(%d)", (int)private_vblank->owner_tid);
1508 return TDM_ERROR_BAD_REQUEST;
1511 tdm_output_get_dpms(private_vblank->output, &dpms);
1513 if (!private_vblank->enable_fake) {
1514 if (private_vblank->connection == TDM_OUTPUT_CONN_STATUS_DISCONNECTED) {
1515 VER("can't wait a vblank: output disconnected");
1516 return TDM_ERROR_OUTPUT_DISCONNECTED;
1518 if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms)) {
1519 VER("can't wait a vblank: DPMS %s", tdm_dpms_str(dpms));
1520 return TDM_ERROR_DPMS_OFF;
1524 wait_info = calloc(1, sizeof * wait_info);
1526 /* LCOV_EXCL_START */
1527 VER("alloc failed");
1528 return TDM_ERROR_OUT_OF_MEMORY;
1529 /* LCOV_EXCL_STOP */
1531 _tdm_vblank_update_output_info(private_vblank);
1533 /* set request time to current time if 0. This function seems to be called in server side. */
1534 if (req_sec == 0 && req_usec == 0) {
1535 double curr = tdm_helper_get_time();
1536 req_sec = TDM_TIME_SEC(curr);
1537 req_usec = TDM_TIME_USEC(curr);
1540 LIST_INITHEAD(&wait_info->link);
1542 _tdm_vblank_valid_list_add(&wait_info->valid_link, &valid_wait_list);
1544 wait_info->stamp = ++stamp;
1545 wait_info->req_time = TDM_TIME(req_sec, req_usec);
1546 wait_info->interval = interval;
1547 wait_info->func = func;
1548 wait_info->user_data = user_data;
1549 wait_info->private_vblank = private_vblank;
1551 if (!private_vblank->resource ||
1552 private_vblank->ignore_global_fps ||
1553 vblank_global_fps == 0 ||
1554 private_vblank->fps < vblank_global_fps)
1555 fps = private_vblank->fps;
1557 fps = vblank_global_fps;
1559 if (private_vblank->check_HW_or_SW) {
1560 private_vblank->check_HW_or_SW = 0;
1561 private_vblank->vblank_gap = 1.0 / fps;
1562 private_vblank->quotient = private_vblank->vrefresh / fps;
1565 /* 1) if fps != factor of vrefresh, SW timer
1566 * 2) if fps == factor of vrefresh && dpms == off, SW timer (Fake HW vblank)
1567 * 2) if fps == factor of vrefresh && dpms == on && offset == 0, HW vblank
1568 * 3) if fps == factor of vrefresh && dpms == on && offset != 0, HW vblank + SW timer
1569 * In case of 1), we really don't need to align with HW vblank.
1571 if (private_vblank->vrefresh % fps)
1572 wait_info->type = VBLANK_TYPE_SW;
1573 else if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms) ||
1574 private_vblank->connection != TDM_OUTPUT_CONN_STATUS_MODE_SETTED)
1575 wait_info->type = VBLANK_TYPE_SW_FAKE;
1576 else if (private_vblank->offset == 0)
1577 wait_info->type = VBLANK_TYPE_HW;
1579 wait_info->type = VBLANK_TYPE_HW_SW;
1581 if (wait_info->type == VBLANK_TYPE_SW || wait_info->type == VBLANK_TYPE_SW_FAKE) {
1582 ret = _tdm_vblank_wait_SW(wait_info);
1583 if (ret != TDM_ERROR_NONE)
1584 TDM_ERR("_tdm_vblank_wait_SW failed: ret(%d)", ret);
1586 ret = _tdm_vblank_wait_HW(wait_info);
1587 if (ret != TDM_ERROR_NONE)
1588 TDM_ERR("_tdm_vblank_wait_HW failed: ret(%d)", ret);
1590 if (ret == TDM_ERROR_OUTPUT_DISCONNECTED || ret == TDM_ERROR_DPMS_OFF) {
1591 ret = _tdm_vblank_wait_SW(wait_info);
1592 if (ret != TDM_ERROR_NONE)
1593 TDM_ERR("_tdm_vblank_wait_SW failed: ret(%d)", ret);
1597 if (ret != TDM_ERROR_NONE) {
1598 /* LCOV_EXCL_START */
1599 LIST_DEL(&wait_info->link);
1600 _tdm_vblank_valid_list_del(&wait_info->valid_link);
1602 tdm_display_lock(private_vblank->dpy);
1603 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, wait_info);
1604 tdm_display_unlock(private_vblank->dpy);
1608 /* LCOV_EXCL_STOP */
1611 tdm_display_lock(private_vblank->dpy);
1612 _tdm_vblank_timeout_timer_update(private_vblank, 1000);
1613 tdm_display_unlock(private_vblank->dpy);
1615 return TDM_ERROR_NONE;
1619 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1620 unsigned int sequence, tdm_vblank_handler func, void *user_data)
1622 tdm_private_vblank *private_vblank = vblank;
1623 unsigned int interval;
1625 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1626 TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1628 /* if the sequence of vblank reaches the max value, sequence can be 0. */
1630 if (private_vblank->last_seq == 0) {
1631 VWR("can't calculate interval with sequence(%u)", sequence);
1633 } else if (sequence > private_vblank->last_seq ||
1634 TDM_VBLANK_SEQ_REACHED_MAX(sequence, private_vblank->last_seq)) {
1635 double last, curr, seq_target;
1637 last = private_vblank->last_time;
1638 curr = tdm_helper_get_time();
1639 seq_target = last + private_vblank->vblank_gap * (sequence - private_vblank->last_seq);
1641 /* If target is old or too close(1ms) to current, we call the handler immediately.
1642 * 2ms? it seems too much.
1644 if (seq_target < curr) {
1645 func(vblank, TDM_ERROR_NONE, sequence,
1646 TDM_TIME_SEC(seq_target), TDM_TIME_USEC(seq_target),
1648 return TDM_ERROR_NONE;
1649 } else if ((seq_target - curr) < 0.001) { /* 1ms */
1650 func(vblank, TDM_ERROR_NONE, sequence,
1651 TDM_TIME_SEC(curr), TDM_TIME_USEC(curr),
1653 return TDM_ERROR_NONE;
1656 interval = (unsigned int)((seq_target - curr) / private_vblank->vblank_gap + TDM_TIME_MARGIN) + 1;
1658 /* this seems error. But we handle this like normal to avoid the unexpected error in cliend side */
1659 VER("sequence(%u) should be over the last sequence(%u)", sequence, private_vblank->last_seq);
1660 func(vblank, TDM_ERROR_NONE, private_vblank->last_seq,
1661 TDM_TIME_SEC(private_vblank->last_time), TDM_TIME_USEC(private_vblank->last_time),
1663 return TDM_ERROR_NONE;
1666 return tdm_vblank_wait(vblank, req_sec, req_usec, interval, func, user_data);
1669 /* LCOV_EXCL_START */
1671 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front)
1673 tdm_private_vblank *private_vblank = vblank;
1675 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1677 TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
1679 if (private_vblank->add_front == add_front)
1680 return TDM_ERROR_NONE;
1682 private_vblank->add_front = add_front;
1684 return TDM_ERROR_NONE;
1686 /* LCOV_EXCL_STOP */
1689 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource)
1691 tdm_private_vblank *private_vblank = vblank;
1693 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1694 TDM_RETURN_VAL_IF_FAIL(private_vblank->resource == NULL, TDM_ERROR_OPERATION_FAILED);
1696 private_vblank->resource = resource;
1698 return TDM_ERROR_NONE;
1702 tdm_vblank_get_stamp(tdm_vblank *vblank)
1704 tdm_private_vblank *private_vblank = vblank;
1706 TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1708 return private_vblank->stamp;
1712 _tdm_vblank_get_waiting_count(tdm_private_vblank *private_vblank)
1714 tdm_vblank_wait_info *wait_info = NULL;
1715 unsigned int count = 0;
1717 LIST_FOR_EACH_ENTRY(wait_info, &private_vblank->HW_wait_list, link) {
1721 LIST_FOR_EACH_ENTRY(wait_info, &private_vblank->SW_wait_list, link) {
1729 _tdm_vblank_get_client_information(tdm_private_vblank *private_vblank, pid_t *pid, const char **name)
1731 struct wl_client *client;
1733 if (!private_vblank->resource)
1736 client = wl_resource_get_client(private_vblank->resource);
1740 wl_client_get_credentials(client, pid, NULL, NULL);
1741 *name = tdm_server_get_client_name(*pid);
1751 /* LCOV_EXCL_START */
1753 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len)
1755 tdm_private_vblank *v = NULL;
1756 tdm_output_dpms dpms = TDM_OUTPUT_DPMS_OFF;
1757 tdm_output *output = tdm_display_get_output(dpy, 0, NULL);
1760 tdm_output_get_dpms(output, &dpms);
1762 TDM_SNPRINTF(reply, len, "[Client Vblank List]\n");
1763 TDM_SNPRINTF(reply, len, "* DPMS: %s\n", tdm_dpms_str(dpms));
1764 TDM_SNPRINTF(reply, len, "* global fps: %u\n", vblank_global_fps);
1765 TDM_SNPRINTF(reply, len, "----------------------------------------------------------------------------------\n");
1766 TDM_SNPRINTF(reply, len, "Name Type Wait Interval Sequence Fps Ignore Offset Fake Process\n");
1767 TDM_SNPRINTF(reply, len, "----------------------------------------------------------------------------------\n");
1769 pthread_mutex_lock(&valid_list_lock);
1770 LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
1771 const char *proc_name = NULL;
1775 _tdm_vblank_get_client_information(v, &pid, &proc_name);
1777 count = _tdm_vblank_get_waiting_count(v);
1779 TDM_SNPRINTF(reply, len, "%-8s(%p) ", v->name, v);
1780 TDM_SNPRINTF(reply, len, "%-4s ", (v->last_type == VBLANK_EVENT_TYPE_HW) ? "HW" : "SW");
1781 TDM_SNPRINTF(reply, len, "%-4s ", (count > 0) ? "O" : " ");
1782 TDM_SNPRINTF(reply, len, "%-8d ", v->last_interval);
1783 TDM_SNPRINTF(reply, len, "%-8u ", v->last_seq);
1784 TDM_SNPRINTF(reply, len, "%-3u ", v->fps);
1785 TDM_SNPRINTF(reply, len, "%-6u ", v->ignore_global_fps);
1786 TDM_SNPRINTF(reply, len, "%-6d ", v->offset);
1787 TDM_SNPRINTF(reply, len, "%-4u ", v->enable_fake);
1788 TDM_SNPRINTF(reply, len, "%s(pid:%d)\n", (proc_name) ? proc_name : "Unknown", pid);
1790 pthread_mutex_unlock(&valid_list_lock);
1792 TDM_SNPRINTF(reply, len, "\n");
1794 /* LCOV_EXCL_STOP */