fix the typo
[platform/core/uifw/libtdm.git] / src / tdm_vblank.c
1 /**************************************************************************
2  *
3  * libtdm
4  *
5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
6  *
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>
13  *
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:
21  *
22  * The above copyright notice and this permission notice (including the
23  * next paragraph) shall be included in all copies or substantial portions
24  * of the Software.
25  *
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.
33  *
34 **************************************************************************/
35
36 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39
40 #include "tdm.h"
41 #include "tdm_private.h"
42 #include "tdm_list.h"
43
44 /* CAUTION:
45  * Basically tdm vblank doesn't care about thread things.
46  * However, to use tdm_event_loop_xxx functions, have to use the internal function.
47  * So need to lock/unlock the mutex of private_display. And valid_vblank_list and
48  * valid_wait_list should be protected by valid_list_lock because tdm_vblank can
49  * be used in multi-thread.
50  */
51
52 /* TDM vblank
53  * - aligned by HW vblank
54  * - use a tdm_event_loop_source object only.
55  */
56
57 #define TDM_VBLANK_DEFAULT_VREFRESH    30
58
59 /* We expact "(unsigned int)(0.0016667 / 0.0016667) = 1". But it becomes 0. */
60 #define TDM_TIME_MARGIN     0.0000001
61
62 #define TDM_VBLANK_UINT_MAX 4294967295U
63 #define TDM_VBLANK_UINT_1Q  1073741823U     /* UINT_MAX / 4 */
64 #define TDM_VBLANK_UINT_3Q  3221225471U     /* UINT_MAX / 4 * 3 */
65
66 /* (seq < TDM_VBLANK_UINT_1Q && TDM_VBLANK_UINT_3Q < last_seq) means
67  * that the sequence value has reached the max value and started from 0 again.
68  */
69 #define TDM_VBLANK_SEQ_REACHED_MAX(seq, last_seq) \
70         ((seq) < TDM_VBLANK_UINT_1Q && TDM_VBLANK_UINT_3Q < (last_seq))
71
72 #define VER(fmt, arg...)   TDM_ERR("[%p] "fmt, private_vblank, ##arg)
73 #define VWR(fmt, arg...)   TDM_WRN("[%p] "fmt, private_vblank, ##arg)
74 #define VIN(fmt, arg...)   do { if (tdm_debug_module & TDM_DEBUG_VBLANK) TDM_INFO("[%p] "fmt, private_vblank, ##arg); } while (0)
75 #define VDB(fmt, arg...)   do { if (tdm_debug_module & TDM_DEBUG_VBLANK) TDM_DBG("[%p] "fmt, private_vblank, ##arg); } while (0)
76
77 typedef enum {
78         VBLANK_TYPE_SW,
79         VBLANK_TYPE_SW_FAKE,
80         VBLANK_TYPE_HW,
81         VBLANK_TYPE_HW_SW,
82 } tdm_vblank_wait_type;
83
84 typedef enum {
85         VBLANK_EVENT_TYPE_NONE,
86         VBLANK_EVENT_TYPE_SW,
87         VBLANK_EVENT_TYPE_HW,
88 } tdm_vblank_event_type;
89
90 typedef struct _tdm_vblank_wait_info tdm_vblank_wait_info;
91
92 typedef struct _tdm_private_vblank {
93         struct list_head valid_link;
94
95         double stamp;
96         pid_t owner_tid;
97
98         tdm_display *dpy;
99         tdm_output *output;
100         tdm_output_conn_status connection;
101         unsigned int vrefresh;
102
103         tdm_vblank_event_type last_type;
104         unsigned int check_HW_or_SW;
105         char name[TDM_NAME_LEN];
106         unsigned int fps;
107         unsigned int fps_changeable;
108         int offset;
109         unsigned int enable_fake;
110         unsigned int ignore_global_fps;
111
112         double vblank_gap;
113         unsigned int quotient;
114
115         unsigned int last_seq;
116         double last_time;
117
118         unsigned int add_front;
119         struct wl_resource *resource;
120
121         /* for HW */
122         double HW_vblank_gap;
123         struct list_head HW_wait_list;
124
125         /* for SW */
126         tdm_event_loop_source *SW_timer;
127         struct list_head SW_wait_list;
128 } tdm_private_vblank;
129
130 struct _tdm_vblank_wait_info {
131         struct list_head link;
132         struct list_head valid_link;
133
134         double stamp;
135
136         double req_time;
137         unsigned int interval;
138
139         tdm_vblank_handler func;
140         void *user_data;
141         tdm_private_vblank *private_vblank;
142
143         tdm_vblank_wait_type type;
144
145         double target_time;
146         unsigned int target_seq;
147 };
148
149 /* valid_vblank_list and valid_wait_list should be protected by valid_list_lock because
150  * tdm_vblank can be used in multi-thread.
151  */
152 static pthread_mutex_t valid_list_lock;
153 static struct list_head valid_vblank_list;
154 static struct list_head valid_wait_list;
155 static unsigned int vblank_list_inited;
156 static unsigned int vblank_global_fps;
157 static double stamp = 0;
158
159 static tdm_error _tdm_vblank_cb_vblank_SW(void *user_data);
160 static tdm_error _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info);
161 static void _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
162                                                                          unsigned int tv_sec, unsigned int tv_usec,
163                                                                          void *user_data);
164
165 #if 0
166 static void
167 _print_list(struct list_head *list)
168 {
169         tdm_vblank_wait_info *w = NULL;
170
171         LIST_FOR_EACH_ENTRY(w, list, link) {
172                 printf(" %d", w->interval);
173         }
174         printf("\n");
175 }
176 #endif
177
178 static int
179 tdm_vblank_is_valid(tdm_vblank *vblank)
180 {
181         tdm_private_vblank *v = NULL;
182
183         if (vblank && vblank_list_inited) {
184                 pthread_mutex_lock(&valid_list_lock);
185                 LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
186                         if (v == (tdm_private_vblank *)vblank) {
187                                 pthread_mutex_unlock(&valid_list_lock);
188                                 return 1;
189                         }
190                 }
191                 pthread_mutex_unlock(&valid_list_lock);
192
193         }
194         return 0;
195 }
196
197 static void
198 _tdm_vblank_valid_list_add(struct list_head *valid_link, struct list_head *valid_list)
199 {
200         pthread_mutex_lock(&valid_list_lock);
201         LIST_ADDTAIL(valid_link, valid_list);
202         pthread_mutex_unlock(&valid_list_lock);
203 }
204
205 static void
206 _tdm_vblank_valid_list_del(struct list_head *valid_link)
207 {
208         pthread_mutex_lock(&valid_list_lock);
209         LIST_DEL(valid_link);
210         pthread_mutex_unlock(&valid_list_lock);
211 }
212
213 static inline tdm_private_vblank*
214 _tdm_vblank_find(double vblank_stamp)
215 {
216         tdm_private_vblank *v = NULL;
217
218         if (!vblank_stamp)
219                 return 0;
220
221         pthread_mutex_lock(&valid_list_lock);
222         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
223                 if (v->stamp == vblank_stamp) {
224                         pthread_mutex_unlock(&valid_list_lock);
225                         return v;
226                 }
227         }
228         pthread_mutex_unlock(&valid_list_lock);
229
230         return 0;
231 }
232
233 static inline unsigned int
234 _tdm_vblank_check_valid_wait(tdm_vblank_wait_info *wait_info)
235 {
236         tdm_vblank_wait_info *w = NULL;
237
238         if (!wait_info)
239                 return 0;
240
241         pthread_mutex_lock(&valid_list_lock);
242         LIST_FOR_EACH_ENTRY(w, &valid_wait_list, valid_link) {
243                 if (w == wait_info) {
244                         pthread_mutex_unlock(&valid_list_lock);
245                         return 1;
246                 }
247         }
248         pthread_mutex_unlock(&valid_list_lock);
249
250         return 0;
251 }
252
253 static inline unsigned int
254 _tdm_vblank_find_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
255 {
256         tdm_vblank_wait_info *w = NULL;
257
258         if (!wait_info)
259                 return 0;
260
261         LIST_FOR_EACH_ENTRY(w, list, link) {
262                 if (w->stamp == wait_info->stamp)
263                         return 1;
264         }
265
266         return 0;
267 }
268
269 static inline void
270 _tdm_vblank_insert_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
271 {
272         tdm_vblank_wait_info *w = NULL;
273         tdm_vblank_wait_info *found = NULL;
274
275         if (LIST_IS_EMPTY(list)) {
276                 LIST_ADDTAIL(&wait_info->link, list);
277                 return;
278         }
279
280         LIST_FOR_EACH_ENTRY(w, list, link) {
281                 if (wait_info->type == VBLANK_TYPE_SW) {
282                         if (wait_info->target_time == 0)
283                                 TDM_NEVER_GET_HERE();
284                         if (w->target_time <= wait_info->target_time) {
285                                 found = w;
286                                 continue;
287                         }
288                 } else {
289                         if (w->interval <= wait_info->interval) {
290                                 found = w;
291                                 continue;
292                         }
293                 }
294         }
295
296         if (found)
297                 LIST_ADD(&wait_info->link, &found->link);
298         else
299                 LIST_ADDTAIL(&wait_info->link, list->next);
300 }
301
302 static void
303 _tdm_vblank_change_to_SW(tdm_private_vblank *private_vblank)
304 {
305         tdm_vblank_wait_info *w = NULL, *ww = NULL;
306
307         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
308                 LIST_DEL(&w->link);
309
310                 tdm_display_lock(private_vblank->dpy);
311                 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, w);
312                 tdm_display_unlock(private_vblank->dpy);
313
314                 w->type = VBLANK_TYPE_SW_FAKE;
315                 _tdm_vblank_wait_SW(w);
316         }
317 }
318
319 static void
320 _tdm_vblank_free_HW_wait(tdm_private_vblank *private_vblank, tdm_error error, unsigned int call_cb)
321 {
322         tdm_vblank_wait_info *w = NULL, *ww = NULL;
323
324         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
325                 LIST_DEL(&w->link);
326                 _tdm_vblank_valid_list_del(&w->valid_link);
327
328                 tdm_display_lock(private_vblank->dpy);
329                 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, w);
330                 tdm_display_unlock(private_vblank->dpy);
331
332                 if (call_cb && w->func)
333                         w->func(private_vblank, error, 0, 0, 0, w->user_data);
334
335                 free(w);
336         }
337 }
338
339 static void
340 _tdm_vblank_update_output_info(tdm_private_vblank *private_vblank)
341 {
342         tdm_output *output = private_vblank->output;
343         tdm_output_conn_status connection = TDM_OUTPUT_CONN_STATUS_DISCONNECTED;
344         unsigned int vrefresh = 0;
345         tdm_error ret;
346
347         ret = tdm_output_get_conn_status(output, &connection);
348         TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
349
350         if (connection != TDM_OUTPUT_CONN_STATUS_DISCONNECTED) {
351                 const tdm_output_mode *mode = NULL;
352                 tdm_output_get_mode(output, &mode);
353                 if (mode)
354                         vrefresh = mode->vrefresh;
355                 else
356                         VWR("mode not setted!!!");
357         }
358
359         if (vrefresh == 0) {
360                 VWR("vrefresh can't be zero !!!");
361                 vrefresh = TDM_VBLANK_DEFAULT_VREFRESH;
362         }
363
364         private_vblank->connection = connection;
365         private_vblank->vrefresh = vrefresh;
366         private_vblank->HW_vblank_gap = 1.0 / private_vblank->vrefresh;
367
368         if (private_vblank->fps_changeable)
369                 private_vblank->fps = vrefresh;
370
371         VIN("connection(%d) vrefresh(%d) fps(%d) fps_changeable(%d)",
372                 private_vblank->connection,
373                 private_vblank->vrefresh, private_vblank->fps, private_vblank->fps_changeable);
374 }
375
376 /* LCOV_EXCL_START */
377 static void
378 _tdm_vblank_cb_output_change(tdm_output *output, tdm_output_change_type type,
379                                                          tdm_value value, void *user_data)
380 {
381         tdm_private_vblank *private_vblank = user_data;
382
383         TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(private_vblank));
384
385         switch (type) {
386         case TDM_OUTPUT_CHANGE_DPMS:
387                 VIN("dpms %s", tdm_dpms_str(value.u32));
388                 private_vblank->check_HW_or_SW = 1;
389                 if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(value.u32)) {
390                         if (private_vblank->enable_fake)
391                                 _tdm_vblank_change_to_SW(private_vblank);
392                         else
393                                 _tdm_vblank_free_HW_wait(private_vblank, TDM_ERROR_DPMS_OFF, 1);
394                 }
395                 break;
396         case TDM_OUTPUT_CHANGE_CONNECTION:
397                 if (private_vblank->connection == value.u32)
398                         break;
399                 VIN("output %s", tdm_status_str(value.u32));
400                 _tdm_vblank_update_output_info(private_vblank);
401                 private_vblank->check_HW_or_SW = 1;
402                 if (private_vblank->connection == TDM_OUTPUT_CONN_STATUS_DISCONNECTED) {
403                         if (private_vblank->enable_fake)
404                                 _tdm_vblank_change_to_SW(private_vblank);
405                         else
406                                 _tdm_vblank_free_HW_wait(private_vblank, TDM_ERROR_OUTPUT_DISCONNECTED, 1);
407                 }
408                 break;
409         default:
410                 break;
411         }
412 }
413 /* LCOV_EXCL_STOP */
414
415 EXTERN tdm_error
416 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps)
417 {
418         tdm_private_vblank *v = NULL;
419
420         TDM_RETURN_VAL_IF_FAIL(pid > 0, TDM_ERROR_INVALID_PARAMETER);
421         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
422
423         TDM_INFO("pid: %u, name: %s, fps: %d", pid, name, fps);
424
425         pthread_mutex_lock(&valid_list_lock);
426         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
427                 struct wl_client *client;
428                 pid_t client_pid = 0;
429
430                 if (!v->resource)
431                         continue;
432
433                 client = wl_resource_get_client(v->resource);
434                 if (!client)
435                         continue;
436
437                 wl_client_get_credentials(client, &client_pid, NULL, NULL);
438
439                 if (client_pid != pid)
440                         continue;
441
442                 if (name && strncmp(name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN)) {
443                         if (strncmp(v->name, name, TDM_NAME_LEN))
444                                 continue;
445                 }
446
447                 tdm_vblank_set_fps(v, fps);
448
449                 TDM_INFO("(pid:%u) '%s' fps changed: %d", pid, v->name, fps);
450         }
451         pthread_mutex_unlock(&valid_list_lock);
452
453         return TDM_ERROR_NONE;
454 }
455
456 EXTERN tdm_error
457 tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps)
458 {
459         tdm_private_vblank *v = NULL;
460
461         if (enable)
462                 TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
463
464         TDM_INFO("global fps: %s fps(%d)", (enable) ? "enabled" : "disabled", fps);
465
466         pthread_mutex_lock(&valid_list_lock);
467
468         vblank_global_fps = (enable) ? fps : 0;
469
470         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
471                 /* skip if vblank is created in server side */
472                 if (!v->resource)
473                         continue;
474
475                 v->check_HW_or_SW = 1;
476         }
477         pthread_mutex_unlock(&valid_list_lock);
478
479         return TDM_ERROR_NONE;
480 }
481
482 EXTERN tdm_vblank *
483 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error)
484 {
485         tdm_private_vblank *private_vblank;
486         tdm_error ret;
487
488         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_display_is_valid(dpy), TDM_ERROR_INVALID_PARAMETER, NULL);
489         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(tdm_output_is_valid(output), TDM_ERROR_INVALID_PARAMETER, NULL);
490
491         if (error)
492                 *error = TDM_ERROR_NONE;
493
494         if (!vblank_list_inited) {
495                 if (pthread_mutex_init(&valid_list_lock, NULL)) {
496                         /* LCOV_EXCL_START */
497                         TDM_ERR("mutex init failed: %m");
498                         if (error)
499                                 *error = TDM_ERROR_OPERATION_FAILED;
500                         return NULL;
501                         /* LCOV_EXCL_STOP */
502                 }
503                 LIST_INITHEAD(&valid_vblank_list);
504                 LIST_INITHEAD(&valid_wait_list);
505                 vblank_list_inited = 1;
506         }
507
508         private_vblank = calloc(1, sizeof * private_vblank);
509         if (!private_vblank) {
510                 /* LCOV_EXCL_START */
511                 if (error)
512                         *error = TDM_ERROR_OUT_OF_MEMORY;
513                 VER("alloc failed");
514                 return NULL;
515                 /* LCOV_EXCL_STOP */
516         }
517
518         tdm_output_add_change_handler(output, _tdm_vblank_cb_output_change, private_vblank);
519
520         private_vblank->stamp = ++stamp;
521         private_vblank->owner_tid = syscall(SYS_gettid);
522         private_vblank->dpy = dpy;
523         private_vblank->output = output;
524         private_vblank->check_HW_or_SW = 1;
525         private_vblank->fps_changeable = 1;
526
527         _tdm_vblank_update_output_info(private_vblank);
528
529         strncpy(private_vblank->name, TDM_VBLANK_DEFAULT_NAME, TDM_NAME_LEN - 1);
530         private_vblank->name[TDM_NAME_LEN - 1] = '\0';
531
532         LIST_INITHEAD(&private_vblank->HW_wait_list);
533         LIST_INITHEAD(&private_vblank->SW_wait_list);
534
535         _tdm_vblank_valid_list_add(&private_vblank->valid_link, &valid_vblank_list);
536
537         VIN("created. vrefresh(%d) connection(%d)",
538                 private_vblank->vrefresh, private_vblank->connection);
539
540         return (tdm_vblank *)private_vblank;
541 }
542
543 EXTERN void
544 tdm_vblank_destroy(tdm_vblank *vblank)
545 {
546         tdm_private_vblank *private_vblank = vblank;
547         tdm_vblank_wait_info *w = NULL, *ww = NULL;
548
549         TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(vblank));
550
551         _tdm_vblank_valid_list_del(&private_vblank->valid_link);
552
553         if (private_vblank->SW_timer) {
554                 tdm_display_lock(private_vblank->dpy);
555                 tdm_event_loop_source_remove(private_vblank->SW_timer);
556                 tdm_display_unlock(private_vblank->dpy);
557         }
558
559         tdm_output_remove_change_handler(private_vblank->output,
560                                                                          _tdm_vblank_cb_output_change, private_vblank);
561
562         _tdm_vblank_free_HW_wait(private_vblank, 0, 0);
563
564         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
565                 LIST_DEL(&w->link);
566                 _tdm_vblank_valid_list_del(&w->valid_link);
567                 free(w);
568         }
569
570         VIN("destroyed");
571
572         free(private_vblank);
573 }
574
575 EXTERN tdm_error
576 tdm_vblank_set_name(tdm_vblank *vblank, const char *name)
577 {
578         tdm_private_vblank *private_vblank = vblank;
579
580         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
581
582         if (!name)
583                 name = TDM_VBLANK_DEFAULT_NAME;
584
585         strncpy(private_vblank->name, name, TDM_NAME_LEN - 1);
586         private_vblank->name[TDM_NAME_LEN - 1] = '\0';
587
588         VIN("name(%s)", name);
589
590         return TDM_ERROR_NONE;
591 }
592
593 EXTERN tdm_error
594 tdm_vblank_get_name(tdm_vblank *vblank, const char **name)
595 {
596         tdm_private_vblank *private_vblank = vblank;
597
598         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
599         TDM_RETURN_VAL_IF_FAIL(name != NULL, TDM_ERROR_INVALID_PARAMETER);
600
601         *name = (const char*)private_vblank->name;
602
603         return TDM_ERROR_NONE;
604 }
605
606 EXTERN tdm_error
607 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps)
608 {
609         tdm_private_vblank *private_vblank = vblank;
610
611         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
612         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
613
614         if (private_vblank->fps != fps || private_vblank->fps_changeable)
615                 VIN("fps(%d) fps_changeable(0)", fps);
616
617         private_vblank->fps_changeable = 0;
618
619         if (private_vblank->fps == fps)
620                 return TDM_ERROR_NONE;
621
622         private_vblank->fps = fps;
623         private_vblank->check_HW_or_SW = 1;
624
625         return TDM_ERROR_NONE;
626 }
627
628 EXTERN tdm_error
629 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps)
630 {
631         tdm_private_vblank *private_vblank = vblank;
632
633         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
634         TDM_RETURN_VAL_IF_FAIL(fps != NULL, TDM_ERROR_INVALID_PARAMETER);
635
636         *fps = private_vblank->fps;
637
638         return TDM_ERROR_NONE;
639 }
640
641 EXTERN tdm_error
642 tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore)
643 {
644         tdm_private_vblank *private_vblank = vblank;
645
646         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
647
648         if (private_vblank->ignore_global_fps == ignore)
649                 return TDM_ERROR_NONE;
650
651         private_vblank->ignore_global_fps = ignore;
652         private_vblank->check_HW_or_SW = 1;
653
654         VIN("ignore_global_fps(%d)", private_vblank->ignore_global_fps);
655
656         return TDM_ERROR_NONE;
657 }
658
659 EXTERN tdm_error
660 tdm_vblank_set_offset(tdm_vblank *vblank, int offset)
661 {
662         tdm_private_vblank *private_vblank = vblank;
663
664         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
665
666         if (private_vblank->offset == offset)
667                 return TDM_ERROR_NONE;
668
669         private_vblank->offset = offset;
670         private_vblank->check_HW_or_SW = 1;
671
672         VIN("offset(%d)", private_vblank->offset);
673
674         return TDM_ERROR_NONE;
675 }
676
677 EXTERN tdm_error
678 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset)
679 {
680         tdm_private_vblank *private_vblank = vblank;
681
682         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
683         TDM_RETURN_VAL_IF_FAIL(offset != NULL, TDM_ERROR_INVALID_PARAMETER);
684
685         *offset = private_vblank->offset;
686
687         return TDM_ERROR_NONE;
688 }
689
690 EXTERN tdm_error
691 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake)
692 {
693         tdm_private_vblank *private_vblank = vblank;
694
695         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
696
697         if (private_vblank->enable_fake == enable_fake)
698                 return TDM_ERROR_NONE;
699
700         private_vblank->enable_fake = enable_fake;
701
702         VIN("enable_fake(%d)", private_vblank->enable_fake);
703
704         return TDM_ERROR_NONE;
705 }
706
707 EXTERN tdm_error
708 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake)
709 {
710         tdm_private_vblank *private_vblank = vblank;
711
712         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
713         TDM_RETURN_VAL_IF_FAIL(enable_fake != NULL, TDM_ERROR_INVALID_PARAMETER);
714
715         *enable_fake = private_vblank->enable_fake;
716
717         return TDM_ERROR_NONE;
718 }
719
720 static tdm_error
721 _tdm_vblank_sw_timer_update(tdm_private_vblank *private_vblank)
722 {
723         tdm_vblank_wait_info *first_wait_info = NULL;
724         double curr, target;
725         int ms_delay;
726         tdm_error ret;
727
728         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
729                 VER("no wait_info");
730                 return TDM_ERROR_OPERATION_FAILED;
731         }
732
733         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
734         curr = tdm_helper_get_time();
735         target = first_wait_info->target_time;
736
737         /* ms_delay should be more that 1 */
738         if (target < curr)
739                 ms_delay = 1;
740         else
741                 ms_delay = ceil((target - curr) * 1000.0);
742
743         if (ms_delay < 1)
744                 ms_delay = 1;
745
746         if (ms_delay > 5000)
747                 VER("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
748         else
749                 VDB("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
750
751         tdm_display_lock(private_vblank->dpy);
752
753         if (!private_vblank->SW_timer) {
754                 private_vblank->SW_timer =
755                         tdm_event_loop_add_timer_handler(private_vblank->dpy,
756                                                                                          _tdm_vblank_cb_vblank_SW,
757                                                                                          private_vblank,
758                                                                                          &ret);
759                 if (!private_vblank->SW_timer) {
760                         tdm_display_unlock(private_vblank->dpy);
761                         VER("couldn't add timer");
762                         return ret;
763                 }
764                 VIN("Create SW timer");
765         }
766
767         ret = tdm_event_loop_source_timer_update(private_vblank->SW_timer, ms_delay);
768         if (ret != TDM_ERROR_NONE) {
769                 /* LCOV_EXCL_START */
770                 tdm_display_unlock(private_vblank->dpy);
771                 VER("couldn't update timer");
772                 return ret;
773                 /* LCOV_EXCL_STOP */
774         }
775
776         tdm_display_unlock(private_vblank->dpy);
777
778         return TDM_ERROR_NONE;
779 }
780
781 static void
782 _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
783                                                  unsigned int tv_sec, unsigned int tv_usec,
784                                                  void *user_data)
785 {
786         tdm_vblank_wait_info *wait_info = user_data;
787         tdm_private_vblank *private_vblank;
788
789         if (!_tdm_vblank_check_valid_wait(wait_info)) {
790                 TDM_DBG("can't find wait(%p) from valid_wait_list", wait_info);
791                 return;
792         }
793
794         private_vblank = wait_info->private_vblank;
795         TDM_RETURN_IF_FAIL(tdm_vblank_is_valid(private_vblank));
796
797         if (!_tdm_vblank_find_wait(wait_info, &private_vblank->HW_wait_list)) {
798                 VDB("can't find wait(%p)", wait_info);
799                 return;
800         }
801
802         if (wait_info->type == VBLANK_TYPE_HW_SW) {
803                 tdm_error ret;
804
805                 LIST_DEL(&wait_info->link);
806
807                 /* kernel sends the wrong time of first vblank event. and the time of
808                  * second vblank is correct.
809                  */
810                 wait_info->target_time = TDM_TIME(tv_sec, tv_usec);
811                 wait_info->target_time += (((double)private_vblank->offset) / 1000.0);
812
813                 _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
814
815                 ret = _tdm_vblank_sw_timer_update(private_vblank);
816
817                 /* wait_info will be freed in _tdm_vblank_cb_vblank_SW() */
818                 if (ret == TDM_ERROR_NONE) {
819                         VDB("wait(%p) SW timer", wait_info);
820                         return;
821                 }
822
823                 VWR("couldn't update sw timer");
824         }
825
826         LIST_DEL(&wait_info->link);
827         _tdm_vblank_valid_list_del(&wait_info->valid_link);
828
829         /* tv_sec & tv_usec shouldn't be zero. But sometimes they are zero in some hardware.
830          * We need to prohibit that last_time becomes zero because "last_time == 0" means
831          * that a tdm_vblank object is just created and doesn't have the first vblank event.
832          * If last_time becomes 0, it would make issue.
833          */
834         if (tv_sec == 0 && tv_usec == 0) {
835                 double curr = tdm_helper_get_time();
836                 tv_sec = TDM_TIME_SEC(curr);
837                 tv_usec = TDM_TIME_USEC(curr);
838         }
839
840         private_vblank->last_seq = wait_info->target_seq;
841         private_vblank->last_time = TDM_TIME(tv_sec, tv_usec);
842
843         VDB("wait(%p) last(%.6f) sequence(%u) done", wait_info, private_vblank->last_time, wait_info->target_seq);
844
845         if (wait_info->func)
846                 wait_info->func(private_vblank, TDM_ERROR_NONE, wait_info->target_seq,
847                                                 tv_sec, tv_usec, wait_info->user_data);
848
849         free(wait_info);
850 }
851
852 static tdm_error
853 _tdm_vblank_wait_HW(tdm_vblank_wait_info *wait_info)
854 {
855         tdm_private_vblank *private_vblank = wait_info->private_vblank;
856         int hw_interval;
857         tdm_error ret;
858
859         if (private_vblank->last_type != VBLANK_EVENT_TYPE_HW) {
860                 VIN("Use HW vblank");
861                 private_vblank->last_type = VBLANK_EVENT_TYPE_HW;
862         }
863
864         _tdm_vblank_insert_wait(wait_info, &private_vblank->HW_wait_list);
865
866         hw_interval = wait_info->interval * private_vblank->quotient;
867
868         if (private_vblank->last_time == 0) {
869                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
870                 private_vblank->last_seq = 0;
871                 private_vblank->last_time = tdm_helper_get_time();
872
873                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
874                 wait_info->target_seq = 1;
875
876                 VDB("wait(%p) last(%.6f) hw_itvl(%d) targ_seq(%u)",
877                         wait_info, private_vblank->last_time, hw_interval, wait_info->target_seq);
878         } else {
879                 double last, prev, req, curr, target;
880                 unsigned int skip;
881
882                 last = private_vblank->last_time;
883                 req = wait_info->req_time;
884
885                 /* make sure that req time is bigger than last. */
886                 if (req < last)
887                         req = last;
888
889                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
890                 prev = last + private_vblank->vblank_gap * skip;
891
892                 curr = tdm_helper_get_time();
893                 target = last;
894                 while (target < curr)
895                         target += (private_vblank->vblank_gap * wait_info->interval);
896
897                 hw_interval = (unsigned int)((target - curr) / private_vblank->HW_vblank_gap + TDM_TIME_MARGIN) + 1;
898
899                 wait_info->target_seq = private_vblank->last_seq;
900                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
901
902                 if (hw_interval > 300)
903                         VER("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
904                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
905                                 skip, hw_interval, wait_info->target_seq);
906                 else
907                         VDB("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
908                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
909                                 skip, hw_interval, wait_info->target_seq);
910         }
911
912         if (private_vblank->add_front)
913                 ret = tdm_output_wait_vblank_add_front(private_vblank->output, hw_interval, 0,
914                                                                                            _tdm_vblank_cb_vblank_HW, wait_info);
915         else
916                 ret = tdm_output_wait_vblank(private_vblank->output, hw_interval, 0,
917                                                                          _tdm_vblank_cb_vblank_HW, wait_info);
918
919         if (ret != TDM_ERROR_NONE) {
920                 LIST_DEL(&wait_info->link);
921                 return ret;
922         }
923
924         VDB("wait(%p) waiting", wait_info);
925
926         return TDM_ERROR_NONE;
927 }
928
929 static tdm_error
930 _tdm_vblank_cb_vblank_SW(void *user_data)
931 {
932         tdm_private_vblank *private_vblank = user_data;
933
934         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(private_vblank), TDM_ERROR_OPERATION_FAILED);
935
936         return tdm_vblank_cb_vblank_SW(private_vblank, 0);
937 }
938
939 INTERN tdm_error
940 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp)
941 {
942         tdm_private_vblank *private_vblank;
943         tdm_vblank_wait_info *first_wait_info = NULL, *w = NULL, *ww = NULL;
944
945         TDM_RETURN_VAL_IF_FAIL(vblank || vblank_stamp > 0, TDM_ERROR_INVALID_PARAMETER);
946
947         if (vblank)
948                 private_vblank = vblank;
949         else {
950                 private_vblank = _tdm_vblank_find(vblank_stamp);
951                 if (!private_vblank) {
952                         TDM_DBG("can't find vblank(%.0f) from valid_list", vblank_stamp);
953                         return TDM_ERROR_NONE;
954                 }
955         }
956
957         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
958                 tdm_thread_cb_vblank_sw vblank_sw;
959                 tdm_private_display *private_display = private_vblank->dpy;
960                 tdm_error ret;
961
962                 vblank_sw.base.type = TDM_THREAD_CB_VBLANK_SW;
963                 vblank_sw.base.length = sizeof vblank_sw;
964                 vblank_sw.vblank_stamp = private_vblank->stamp;
965
966                 ret = tdm_thread_send_cb(private_display->private_loop, &vblank_sw.base);
967                 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
968
969                 return TDM_ERROR_NONE;
970         }
971
972         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
973                 VER("no wait_info");
974                 return TDM_ERROR_OPERATION_FAILED;
975         }
976
977         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
978         TDM_RETURN_VAL_IF_FAIL(first_wait_info != NULL, TDM_ERROR_OPERATION_FAILED);
979
980         if (private_vblank->last_seq >= first_wait_info->target_seq)
981                 TDM_ERR("last_seq(%u) target_seq(%u)", private_vblank->last_seq, first_wait_info->target_seq);
982
983         private_vblank->last_seq = first_wait_info->target_seq;
984         private_vblank->last_time = first_wait_info->target_time;
985
986         VDB("wait(%p) last(%.6f) sequence(%u) done", first_wait_info, private_vblank->last_time, first_wait_info->target_seq);
987
988         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
989                 if (w->target_time != first_wait_info->target_time)
990                         break;
991
992                 LIST_DEL(&w->link);
993                 _tdm_vblank_valid_list_del(&w->valid_link);
994
995                 if (w->func) {
996                         tdm_display_unlock(private_vblank->dpy);
997                         w->func(private_vblank, TDM_ERROR_NONE, w->target_seq,
998                                         TDM_TIME_SEC(w->target_time), TDM_TIME_USEC(w->target_time),
999                                         w->user_data);
1000                         tdm_display_lock(private_vblank->dpy);
1001                 }
1002
1003                 free(w);
1004         }
1005
1006         return TDM_ERROR_NONE;
1007 }
1008
1009 static tdm_error
1010 _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info)
1011 {
1012         tdm_private_vblank *private_vblank = wait_info->private_vblank;
1013         tdm_error ret;
1014
1015         if (private_vblank->last_type != VBLANK_EVENT_TYPE_SW) {
1016                 VIN("Use SW vblank");
1017                 private_vblank->last_type = VBLANK_EVENT_TYPE_SW;
1018         }
1019
1020         if (private_vblank->last_time == 0) {
1021                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
1022                 private_vblank->last_seq = 0;
1023                 private_vblank->last_time = tdm_helper_get_time();
1024
1025                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
1026                 wait_info->target_seq = 1;
1027                 wait_info->target_time = private_vblank->last_time + 0.001;
1028
1029                 VDB("wait(%p) last(%.6f) target(%.6f) target sequence(%u)",
1030                         wait_info, private_vblank->last_time, wait_info->target_time, wait_info->target_seq);
1031         } else {
1032                 double last, prev, req, curr, target;
1033                 unsigned int skip;
1034
1035                 last = private_vblank->last_time;
1036                 req = wait_info->req_time;
1037
1038                 /* make sure that req time is bigger than last. */
1039                 if (req < last)
1040                         req = last;
1041
1042                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1043                 prev = last + private_vblank->vblank_gap * skip;
1044
1045                 curr = tdm_helper_get_time();
1046                 target = prev + private_vblank->vblank_gap * wait_info->interval;
1047
1048                 while (target < curr)
1049                         target += private_vblank->vblank_gap;
1050
1051                 wait_info->target_seq = private_vblank->last_seq;
1052                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
1053
1054                 wait_info->target_time = target;
1055
1056                 VDB("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) targ_seq(%u)",
1057                         wait_info, last, req - last, prev - last, curr - last,
1058                         target, target - last, skip, wait_info->target_seq);
1059         }
1060
1061         _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
1062
1063         ret = _tdm_vblank_sw_timer_update(private_vblank);
1064         if (ret != TDM_ERROR_NONE) {
1065                 /* LCOV_EXCL_START */
1066                 LIST_DEL(&wait_info->link);
1067                 VER("couldn't update sw timer");
1068                 return ret;
1069                 /* LCOV_EXCL_STOP */
1070         }
1071
1072         return TDM_ERROR_NONE;
1073 }
1074
1075 EXTERN tdm_error
1076 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1077                                 unsigned int interval, tdm_vblank_handler func, void *user_data)
1078 {
1079         tdm_private_vblank *private_vblank = vblank;
1080         tdm_vblank_wait_info *wait_info;
1081         tdm_output_dpms dpms = TDM_OUTPUT_DPMS_OFF;
1082         unsigned int fps;
1083         tdm_error ret;
1084
1085         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1086         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1087
1088         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
1089                 TDM_ERR("SHOULD be called in the owner thread(%d)", (int)private_vblank->owner_tid);
1090                 return TDM_ERROR_BAD_REQUEST;
1091         }
1092
1093         tdm_output_get_dpms(private_vblank->output, &dpms);
1094
1095         if (!private_vblank->enable_fake) {
1096                 if (private_vblank->connection == TDM_OUTPUT_CONN_STATUS_DISCONNECTED) {
1097                         VER("can't wait a vblank: output disconnected");
1098                         return TDM_ERROR_OUTPUT_DISCONNECTED;
1099                 }
1100                 if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms)) {
1101                         VER("can't wait a vblank: DPMS %s", tdm_dpms_str(dpms));
1102                         return TDM_ERROR_DPMS_OFF;
1103                 }
1104         }
1105
1106         wait_info = calloc(1, sizeof * wait_info);
1107         if (!wait_info) {
1108                 /* LCOV_EXCL_START */
1109                 VER("alloc failed");
1110                 return TDM_ERROR_OUT_OF_MEMORY;
1111                 /* LCOV_EXCL_STOP */
1112         }
1113
1114         /* set request time to current time if 0. This function seems to be called in server side. */
1115         if (req_sec == 0 && req_usec == 0) {
1116                 double curr = tdm_helper_get_time();
1117                 req_sec = TDM_TIME_SEC(curr);
1118                 req_usec = TDM_TIME_USEC(curr);
1119         }
1120
1121         LIST_INITHEAD(&wait_info->link);
1122
1123         _tdm_vblank_valid_list_add(&wait_info->valid_link, &valid_wait_list);
1124
1125         wait_info->stamp = ++stamp;
1126         wait_info->req_time = TDM_TIME(req_sec, req_usec);
1127         wait_info->interval = interval;
1128         wait_info->func = func;
1129         wait_info->user_data = user_data;
1130         wait_info->private_vblank = private_vblank;
1131
1132         if (private_vblank->ignore_global_fps ||
1133                 vblank_global_fps == 0 ||
1134                 private_vblank->fps < vblank_global_fps)
1135                 fps = private_vblank->fps;
1136         else
1137                 fps = vblank_global_fps;
1138
1139         if (private_vblank->check_HW_or_SW) {
1140                 private_vblank->check_HW_or_SW = 0;
1141                 private_vblank->vblank_gap = 1.0 / fps;
1142                 private_vblank->quotient = private_vblank->vrefresh / fps;
1143         }
1144
1145         /* 1) if fps != factor of vrefresh, SW timer
1146          * 2) if fps == factor of vrefresh && dpms == off, SW timer (Fake HW vblank)
1147          * 2) if fps == factor of vrefresh && dpms == on && offset == 0, HW vblank
1148          * 3) if fps == factor of vrefresh && dpms == on && offset != 0, HW vblank + SW timer
1149          * In case of 1), we really don't need to align with HW vblank.
1150          */
1151         if (private_vblank->vrefresh % fps)
1152                 wait_info->type = VBLANK_TYPE_SW;
1153         else if (TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms) ||
1154                          private_vblank->connection == TDM_OUTPUT_CONN_STATUS_DISCONNECTED)
1155                 wait_info->type = VBLANK_TYPE_SW_FAKE;
1156         else if (private_vblank->offset == 0)
1157                 wait_info->type = VBLANK_TYPE_HW;
1158         else
1159                 wait_info->type = VBLANK_TYPE_HW_SW;
1160
1161         if (wait_info->type == VBLANK_TYPE_SW || wait_info->type == VBLANK_TYPE_SW_FAKE) {
1162                 ret = _tdm_vblank_wait_SW(wait_info);
1163                 if (ret != TDM_ERROR_NONE)
1164                         TDM_ERR("_tdm_vblank_wait_SW failed: ret(%d)", ret);
1165         } else {
1166                 ret = _tdm_vblank_wait_HW(wait_info);
1167                 if (ret != TDM_ERROR_NONE)
1168                         TDM_ERR("_tdm_vblank_wait_HW failed: ret(%d)", ret);
1169
1170                 if (ret == TDM_ERROR_OUTPUT_DISCONNECTED || ret == TDM_ERROR_DPMS_OFF) {
1171                         ret = _tdm_vblank_wait_SW(wait_info);
1172                         if (ret != TDM_ERROR_NONE)
1173                                 TDM_ERR("_tdm_vblank_wait_SW failed: ret(%d)", ret);
1174                 }
1175         }
1176
1177         if (ret != TDM_ERROR_NONE) {
1178                 /* LCOV_EXCL_START */
1179                 LIST_DEL(&wait_info->link);
1180                 _tdm_vblank_valid_list_del(&wait_info->valid_link);
1181
1182                 tdm_display_lock(private_vblank->dpy);
1183                 tdm_output_remove_vblank_handler_internal(private_vblank->output, _tdm_vblank_cb_vblank_HW, wait_info);
1184                 tdm_display_unlock(private_vblank->dpy);
1185
1186                 free(wait_info);
1187                 return ret;
1188                 /* LCOV_EXCL_STOP */
1189         }
1190
1191         return TDM_ERROR_NONE;
1192 }
1193
1194 EXTERN tdm_error
1195 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1196                                         unsigned int sequence, tdm_vblank_handler func, void *user_data)
1197 {
1198         tdm_private_vblank *private_vblank = vblank;
1199         unsigned int interval;
1200
1201         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1202         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
1203
1204         /* if the sequence of vblank reaches the max value, sequence can be 0. */
1205
1206         if (private_vblank->last_seq == 0) {
1207                 TDM_WRN("can't calculate interval with sequence(%u)", sequence);
1208                 interval = 1;
1209         } else if (sequence > private_vblank->last_seq ||
1210                            TDM_VBLANK_SEQ_REACHED_MAX(sequence, private_vblank->last_seq)) {
1211                 double last, curr, seq_target;
1212
1213                 last = private_vblank->last_time;
1214                 curr = tdm_helper_get_time();
1215                 seq_target = last + private_vblank->vblank_gap * (sequence - private_vblank->last_seq);
1216
1217                 /* If target is old or too close(1ms) to current, we call the handler immediately.
1218                  * 2ms? it seems too much.
1219                  */
1220                 if (seq_target < curr) {
1221                         func(vblank, TDM_ERROR_NONE, sequence,
1222                                  TDM_TIME_SEC(seq_target), TDM_TIME_USEC(seq_target),
1223                                  user_data);
1224                         return TDM_ERROR_NONE;
1225                 } else if ((seq_target - curr) < 0.001) {  /* 1ms */
1226                         func(vblank, TDM_ERROR_NONE, sequence,
1227                                  TDM_TIME_SEC(curr), TDM_TIME_USEC(curr),
1228                                  user_data);
1229                         return TDM_ERROR_NONE;
1230                 }
1231
1232                 interval = (unsigned int)((seq_target - curr) / private_vblank->vblank_gap + TDM_TIME_MARGIN) + 1;
1233         } else {
1234                 /* this seems error. But we handle this like normal to avoid the unexpected error in cliend side */
1235                 TDM_WRN("sequence(%u) should be over the last sequence(%u)", sequence, private_vblank->last_seq);
1236                 func(vblank, TDM_ERROR_NONE, private_vblank->last_seq,
1237                          TDM_TIME_SEC(private_vblank->last_time), TDM_TIME_USEC(private_vblank->last_time),
1238                          user_data);
1239                 return TDM_ERROR_NONE;
1240         }
1241
1242         return tdm_vblank_wait(vblank, req_sec, req_usec, interval, func, user_data);
1243 }
1244
1245 /* LCOV_EXCL_START */
1246 INTERN tdm_error
1247 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front)
1248 {
1249         tdm_private_vblank *private_vblank = vblank;
1250
1251         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1252
1253         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), TDM_ERROR_OPERATION_FAILED);
1254
1255         if (private_vblank->add_front == add_front)
1256                 return TDM_ERROR_NONE;
1257
1258         private_vblank->add_front = add_front;
1259
1260         return TDM_ERROR_NONE;
1261 }
1262 /* LCOV_EXCL_STOP */
1263
1264 INTERN tdm_error
1265 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource)
1266 {
1267         tdm_private_vblank *private_vblank = vblank;
1268
1269         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1270         TDM_RETURN_VAL_IF_FAIL(private_vblank->resource == NULL, TDM_ERROR_OPERATION_FAILED);
1271
1272         private_vblank->resource = resource;
1273
1274         return TDM_ERROR_NONE;
1275 }
1276
1277 INTERN double
1278 tdm_vblank_get_stamp(tdm_vblank *vblank)
1279 {
1280         tdm_private_vblank *private_vblank = vblank;
1281
1282         TDM_RETURN_VAL_IF_FAIL(tdm_vblank_is_valid(vblank), TDM_ERROR_INVALID_PARAMETER);
1283
1284         return private_vblank->stamp;
1285 }
1286
1287 /* LCOV_EXCL_START */
1288 INTERN void
1289 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len)
1290 {
1291         tdm_private_vblank *v = NULL;
1292
1293         TDM_SNPRINTF(reply, len, "[Client Vblank List]\n");
1294         TDM_SNPRINTF(reply, len, "* global fps: %u\n", vblank_global_fps);
1295         TDM_SNPRINTF(reply, len, "---------------------------------------------------------------\n");
1296         TDM_SNPRINTF(reply, len, "name         fps ignore offset fake process\n");
1297         TDM_SNPRINTF(reply, len, "---------------------------------------------------------------\n");
1298
1299         pthread_mutex_lock(&valid_list_lock);
1300         LIST_FOR_EACH_ENTRY(v, &valid_vblank_list, valid_link) {
1301                 const char *proc_name = NULL;
1302                 pid_t pid = 0;
1303
1304                 if (v->resource) {
1305                         struct wl_client *client = wl_resource_get_client(v->resource);
1306                         if (client) {
1307                                 wl_client_get_credentials(client, &pid, NULL, NULL);
1308                                 proc_name = tdm_server_get_client_name(pid);
1309                         }
1310                 }
1311
1312                 TDM_SNPRINTF(reply, len, "%-12s %u  %u     %d      %u    %s (pid: %u)\n",
1313                                          v->name, v->fps, v->ignore_global_fps, v->offset, v->enable_fake,
1314                                          (proc_name) ? proc_name : "Unknown", pid);
1315         }
1316         pthread_mutex_unlock(&valid_list_lock);
1317
1318         TDM_SNPRINTF(reply, len, "\n");
1319 }
1320 /* LCOV_EXCL_STOP */
1321