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  * 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.
  48  */
  49
  50 /* TDM vblank
  51  * - aligned by HW vblank
  52  * - use a tdm_event_loop_source object only.
  53  */
  54
  55 /* We expact "(unsigned int)(0.0016667 / 0.0016667) = 1". But it becomes 0. */
  56 #define TDM_TIME_MARGIN     0.0000001
  57
  58 #define TDM_VBLANK_UINT_MAX 4294967295U
  59 #define TDM_VBLANK_UINT_1Q  1073741823U     /* UINT_MAX / 4 */
  60 #define TDM_VBLANK_UINT_3Q  3221225471U     /* UINT_MAX / 4 * 3 */
  61
  62 /* (seq < TDM_VBLANK_UINT_1Q && TDM_VBLANK_UINT_3Q < last_seq) means
  63  * that the sequence value has reached the max value and started from 0 again.
  64  */
  65 #define TDM_VBLANK_SEQ_REACHED_MAX(seq, last_seq) \
  66         ((seq) < TDM_VBLANK_UINT_1Q && TDM_VBLANK_UINT_3Q < (last_seq))
  67
  68 #define VER(fmt, arg...)   TDM_ERR("[%p] "fmt, private_vblank, ##arg)
  69 #define VWR(fmt, arg...)   TDM_WRN("[%p] "fmt, private_vblank, ##arg)
  70 #define VIN(fmt, arg...)   TDM_INFO("[%p] "fmt, private_vblank, ##arg)
  71 #define VDB(fmt, arg...)   TDM_DBG("[%p] "fmt, private_vblank, ##arg)
  72
  73 typedef enum {
  74         VBLANK_TYPE_SW,
  75         VBLANK_TYPE_SW_FAKE,
  76         VBLANK_TYPE_HW,
  77         VBLANK_TYPE_HW_SW,
  78 } tdm_vblank_wait_type;
  79
  80 typedef struct _tdm_vblank_wait_info tdm_vblank_wait_info;
  81
  82 typedef struct _tdm_private_vblank {
  83         struct list_head link;
  84
  85         double stamp;
  86         pid_t owner_tid;
  87
  88         tdm_display *dpy;
  89         tdm_output *output;
  90         tdm_output_dpms dpms;
  91         unsigned int vrefresh;
  92
  93         unsigned int check_HW_or_SW;
  94         unsigned int fps;
  95         int offset;
  96         unsigned int enable_fake;
  97
  98         double vblank_gap;
  99         unsigned int quotient;
 100
 101         unsigned int last_seq;
 102         double last_time;
 103
 104         /* for HW */
 105         double HW_vblank_gap;
 106         struct list_head HW_wait_list;
 107
 108         /* for SW */
 109         tdm_event_loop_source *SW_timer;
 110         struct list_head SW_wait_list;
 111 } tdm_private_vblank;
 112
 113 struct _tdm_vblank_wait_info {
 114         struct list_head link;
 115         struct list_head valid_link;
 116
 117         double stamp;
 118
 119         double req_time;
 120         unsigned int interval;
 121
 122         tdm_vblank_handler func;
 123         void *user_data;
 124         tdm_private_vblank *private_vblank;
 125
 126         tdm_vblank_wait_type type;
 127
 128         double target_time;
 129         unsigned int target_seq;
 130 };
 131
 132 static pthread_mutex_t vblank_list_lock;
 133 static struct list_head vblank_list;
 134 static struct list_head valid_wait_list;
 135 static unsigned int vblank_list_inited;
 136 static double stamp = 0;
 137
 138 static tdm_error _tdm_vblank_cb_vblank_SW(void *user_data);
 139 static tdm_error _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info);
 140
 141 #if 0
 142 static void
 143 _print_list(struct list_head *list)
 144 {
 145         tdm_vblank_wait_info *w = NULL;
 146
 147         LIST_FOR_EACH_ENTRY(w, list, link) {
 148                 printf(" %d", w->interval);
 149         }
 150         printf("\n");
 151 }
 152 #endif
 153
 154 static inline tdm_private_vblank*
 155 _tdm_vblank_find(double vblank_stamp)
 156 {
 157         tdm_private_vblank *v = NULL;
 158
 159         if (!vblank_stamp)
 160                 return 0;
 161
 162         pthread_mutex_lock(&vblank_list_lock);
 163         LIST_FOR_EACH_ENTRY(v, &vblank_list, link) {
 164                 if (v->stamp == vblank_stamp) {
 165                         pthread_mutex_unlock(&vblank_list_lock);
 166                         return v;
 167                 }
 168         }
 169         pthread_mutex_unlock(&vblank_list_lock);
 170
 171         return 0;
 172 }
 173
 174 static inline unsigned int
 175 _tdm_vblank_check_valid_wait(tdm_vblank_wait_info *wait_info)
 176 {
 177         tdm_vblank_wait_info *w = NULL;
 178
 179         if (!wait_info)
 180                 return 0;
 181
 182         LIST_FOR_EACH_ENTRY(w, &valid_wait_list, valid_link) {
 183                 if (w->stamp == wait_info->stamp)
 184                         return 1;
 185         }
 186
 187         return 0;
 188 }
 189
 190 static inline unsigned int
 191 _tdm_vblank_find_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
 192 {
 193         tdm_vblank_wait_info *w = NULL;
 194
 195         if (!wait_info)
 196                 return 0;
 197
 198         LIST_FOR_EACH_ENTRY(w, list, link) {
 199                 if (w->stamp == wait_info->stamp)
 200                         return 1;
 201         }
 202
 203         return 0;
 204 }
 205
 206 static inline void
 207 _tdm_vblank_insert_wait(tdm_vblank_wait_info *wait_info, struct list_head *list)
 208 {
 209         tdm_vblank_wait_info *w = NULL;
 210         tdm_vblank_wait_info *found = NULL;
 211
 212         if (LIST_IS_EMPTY(list)) {
 213                 LIST_ADDTAIL(&wait_info->link, list);
 214                 return;
 215         }
 216
 217         LIST_FOR_EACH_ENTRY(w, list, link) {
 218                 if (wait_info->type == VBLANK_TYPE_SW) {
 219                         if (wait_info->target_time == 0)
 220                                 TDM_NEVER_GET_HERE();
 221                         if (w->target_time <= wait_info->target_time) {
 222                                 found = w;
 223                                 continue;
 224                         }
 225                 } else {
 226                         if (w->interval <= wait_info->interval) {
 227                                 found = w;
 228                                 continue;
 229                         }
 230                 }
 231         }
 232
 233         if (found)
 234                 LIST_ADD(&wait_info->link, &found->link);
 235         else
 236                 LIST_ADDTAIL(&wait_info->link, list->next);
 237 }
 238
 239 static void
 240 _tdm_vblank_change_to_SW(tdm_private_vblank *private_vblank)
 241 {
 242         tdm_vblank_wait_info *w = NULL, *ww = NULL;
 243
 244         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
 245                 LIST_DEL(&w->link);
 246                 w->type = VBLANK_TYPE_SW_FAKE;
 247                 _tdm_vblank_wait_SW(w);
 248         }
 249 }
 250
 251 static void
 252 _tdm_vblank_free_HW_wait(tdm_private_vblank *private_vblank, tdm_error error, unsigned int call_cb)
 253 {
 254         tdm_vblank_wait_info *w = NULL, *ww = NULL;
 255
 256         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->HW_wait_list, link) {
 257                 LIST_DEL(&w->link);
 258                 LIST_DEL(&w->valid_link);
 259
 260                 if (call_cb && w->func)
 261                         w->func(private_vblank, error, 0, 0, 0, w->user_data);
 262
 263                 free(w);
 264         }
 265 }
 266
 267 static void
 268 _tdm_vblank_cb_output_change(tdm_output *output, tdm_output_change_type type,
 269                                                          tdm_value value, void *user_data)
 270 {
 271         tdm_private_vblank *private_vblank = user_data;
 272
 273         TDM_RETURN_IF_FAIL(private_vblank != NULL);
 274
 275         switch (type) {
 276         case TDM_OUTPUT_CHANGE_DPMS:
 277                 if (private_vblank->dpms == value.u32)
 278                         break;
 279                 VIN("dpms %s", tdm_dpms_str(value.u32));
 280                 private_vblank->dpms = value.u32;
 281                 private_vblank->check_HW_or_SW = 1;
 282                 if (private_vblank->dpms != TDM_OUTPUT_DPMS_ON) {
 283                         if (private_vblank->enable_fake)
 284                                 _tdm_vblank_change_to_SW(private_vblank);
 285                         else
 286                                 _tdm_vblank_free_HW_wait(private_vblank, TDM_ERROR_DPMS_OFF, 1);
 287                 }
 288                 break;
 289         case TDM_OUTPUT_CHANGE_CONNECTION:
 290                 VIN("output %s", tdm_status_str(value.u32));
 291                 if (value.u32 == TDM_OUTPUT_CONN_STATUS_DISCONNECTED)
 292                         _tdm_vblank_free_HW_wait(private_vblank, 0, 0);
 293                 break;
 294         default:
 295                 break;
 296         }
 297 }
 298
 299 EXTERN tdm_vblank *
 300 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error)
 301 {
 302         tdm_private_vblank *private_vblank;
 303         const tdm_output_mode *mode = NULL;
 304         tdm_output_dpms dpms = TDM_OUTPUT_DPMS_ON;
 305         tdm_error ret;
 306
 307         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(dpy != NULL, TDM_ERROR_INVALID_PARAMETER, NULL);
 308         TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(output != NULL, TDM_ERROR_INVALID_PARAMETER, NULL);
 309
 310         if (error)
 311                 *error = TDM_ERROR_NONE;
 312
 313         if (!vblank_list_inited) {
 314                 if (pthread_mutex_init(&vblank_list_lock, NULL)) {
 315                         TDM_ERR("mutex init failed: %m");
 316                         if (error)
 317                                 *error = TDM_ERROR_OPERATION_FAILED;
 318                         return NULL;
 319                 }
 320                 LIST_INITHEAD(&vblank_list);
 321                 LIST_INITHEAD(&valid_wait_list);
 322                 vblank_list_inited = 1;
 323         }
 324
 325         tdm_output_get_mode(output, &mode);
 326         if (!mode) {
 327                 if (error)
 328                         *error = TDM_ERROR_OPERATION_FAILED;
 329                 TDM_ERR("no mode");
 330                 return NULL;
 331         }
 332
 333         tdm_output_get_dpms(output, &dpms);
 334
 335         private_vblank = calloc(1, sizeof * private_vblank);
 336         if (!private_vblank) {
 337                 if (error)
 338                         *error = TDM_ERROR_OUT_OF_MEMORY;
 339                 VER("alloc failed");
 340                 return NULL;
 341         }
 342
 343         tdm_output_add_change_handler(output, _tdm_vblank_cb_output_change, private_vblank);
 344
 345         private_vblank->stamp = ++stamp;
 346         private_vblank->owner_tid = syscall(SYS_gettid);
 347         private_vblank->dpy = dpy;
 348         private_vblank->output = output;
 349         private_vblank->dpms = dpms;
 350         private_vblank->vrefresh = mode->vrefresh;
 351         private_vblank->HW_vblank_gap = 1.0 / private_vblank->vrefresh;
 352
 353         private_vblank->check_HW_or_SW = 1;
 354         private_vblank->fps = mode->vrefresh;
 355
 356         LIST_INITHEAD(&private_vblank->HW_wait_list);
 357         LIST_INITHEAD(&private_vblank->SW_wait_list);
 358
 359         pthread_mutex_lock(&vblank_list_lock);
 360         LIST_ADD(&private_vblank->link, &vblank_list);
 361         pthread_mutex_unlock(&vblank_list_lock);
 362
 363         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 364                 VIN("created. vrefresh(%d) dpms(%d)",
 365                         private_vblank->vrefresh, private_vblank->dpms);
 366
 367         return (tdm_vblank *)private_vblank;
 368 }
 369
 370 EXTERN void
 371 tdm_vblank_destroy(tdm_vblank *vblank)
 372 {
 373         tdm_private_vblank *private_vblank = vblank;
 374         tdm_vblank_wait_info *w = NULL, *ww = NULL;
 375
 376         if (!private_vblank)
 377                 return;
 378
 379         pthread_mutex_lock(&vblank_list_lock);
 380         LIST_DEL(&private_vblank->link);
 381         pthread_mutex_unlock(&vblank_list_lock);
 382
 383         if (private_vblank->SW_timer) {
 384                 tdm_display_lock(private_vblank->dpy);
 385                 tdm_event_loop_source_remove(private_vblank->SW_timer);
 386                 tdm_display_unlock(private_vblank->dpy);
 387         }
 388
 389         tdm_output_remove_change_handler(private_vblank->output,
 390                                                                          _tdm_vblank_cb_output_change, private_vblank);
 391
 392         _tdm_vblank_free_HW_wait(private_vblank, 0, 0);
 393
 394         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
 395                 LIST_DEL(&w->link);
 396                 LIST_DEL(&w->valid_link);
 397                 free(w);
 398         }
 399
 400         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 401                 VIN("destroyed");
 402
 403         free(private_vblank);
 404 }
 405
 406 EXTERN tdm_error
 407 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps)
 408 {
 409         tdm_private_vblank *private_vblank = vblank;
 410
 411         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
 412         TDM_RETURN_VAL_IF_FAIL(fps > 0, TDM_ERROR_INVALID_PARAMETER);
 413
 414         if (private_vblank->fps == fps)
 415                 return TDM_ERROR_NONE;
 416
 417         private_vblank->fps = fps;
 418         private_vblank->check_HW_or_SW = 1;
 419
 420         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 421                 VIN("fps(%d)", private_vblank->fps);
 422
 423         return TDM_ERROR_NONE;
 424 }
 425
 426 EXTERN tdm_error
 427 tdm_vblank_set_offset(tdm_vblank *vblank, int offset)
 428 {
 429         tdm_private_vblank *private_vblank = vblank;
 430
 431         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
 432
 433         if (private_vblank->offset == offset)
 434                 return TDM_ERROR_NONE;
 435
 436         private_vblank->offset = offset;
 437         private_vblank->check_HW_or_SW = 1;
 438
 439         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 440                 VIN("offset(%d)", private_vblank->offset);
 441
 442         return TDM_ERROR_NONE;
 443 }
 444
 445 EXTERN tdm_error
 446 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake)
 447 {
 448         tdm_private_vblank *private_vblank = vblank;
 449
 450         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
 451
 452         if (private_vblank->enable_fake == enable_fake)
 453                 return TDM_ERROR_NONE;
 454
 455         private_vblank->enable_fake = enable_fake;
 456
 457         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 458                 VIN("enable_fake(%d)", private_vblank->enable_fake);
 459
 460         return TDM_ERROR_NONE;
 461 }
 462
 463 EXTERN unsigned int
 464 tdm_vblank_get_enable_fake(tdm_vblank *vblank)
 465 {
 466         tdm_private_vblank *private_vblank = vblank;
 467
 468         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, 0);
 469
 470         return private_vblank->enable_fake;
 471 }
 472
 473 static tdm_error
 474 _tdm_vblank_sw_timer_update(tdm_private_vblank *private_vblank)
 475 {
 476         tdm_vblank_wait_info *first_wait_info = NULL;
 477         double curr, target;
 478         int ms_delay;
 479         tdm_error ret;
 480
 481         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
 482                 VER("no wait_info");
 483                 return TDM_ERROR_OPERATION_FAILED;
 484         }
 485
 486         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
 487         curr = tdm_helper_get_time();
 488         target = first_wait_info->target_time;
 489
 490         /* ms_delay should be more that 1 */
 491         if (target < curr)
 492                 ms_delay = 1;
 493         else
 494                 ms_delay = ceil((target - curr) * 1000.0);
 495
 496         if (ms_delay < 1)
 497                 ms_delay = 1;
 498
 499         if (ms_delay > 5000)
 500                 VER("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
 501         else if (tdm_debug_module & TDM_DEBUG_VBLANK)
 502                 VIN("wait(%p) curr(%.6f) target(%.6f) ms_delay(%d)", first_wait_info, curr, target, ms_delay);
 503
 504         tdm_display_lock(private_vblank->dpy);
 505
 506         if (!private_vblank->SW_timer) {
 507                 private_vblank->SW_timer =
 508                         tdm_event_loop_add_timer_handler(private_vblank->dpy,
 509                                                                                          _tdm_vblank_cb_vblank_SW,
 510                                                                                          private_vblank,
 511                                                                                          &ret);
 512                 if (!private_vblank->SW_timer) {
 513                         tdm_display_unlock(private_vblank->dpy);
 514                         VER("couldn't add timer");
 515                         return ret;
 516                 }
 517                 VIN("Use SW vblank");
 518         }
 519
 520         ret = tdm_event_loop_source_timer_update(private_vblank->SW_timer, ms_delay);
 521         if (ret != TDM_ERROR_NONE) {
 522                 tdm_display_unlock(private_vblank->dpy);
 523                 VER("couldn't update timer");
 524                 return ret;
 525         }
 526
 527         tdm_display_unlock(private_vblank->dpy);
 528
 529         return TDM_ERROR_NONE;
 530 }
 531
 532 static void
 533 _tdm_vblank_cb_vblank_HW(tdm_output *output, unsigned int sequence,
 534                                                  unsigned int tv_sec, unsigned int tv_usec,
 535                                                  void *user_data)
 536 {
 537         tdm_vblank_wait_info *wait_info = user_data;
 538         tdm_private_vblank *private_vblank;
 539
 540         if (!_tdm_vblank_check_valid_wait(wait_info)) {
 541                 TDM_DBG("can't find wait(%p) from valid_wait_list", wait_info);
 542                 return;
 543         }
 544
 545         private_vblank = wait_info->private_vblank;
 546         TDM_RETURN_IF_FAIL(private_vblank != NULL);
 547
 548         if (!_tdm_vblank_find_wait(wait_info, &private_vblank->HW_wait_list)) {
 549                 VDB("can't find wait(%p)", wait_info);
 550                 return;
 551         }
 552
 553         if (wait_info->type == VBLANK_TYPE_HW_SW) {
 554                 tdm_error ret;
 555
 556                 LIST_DEL(&wait_info->link);
 557
 558                 /* kernel sends the wrong time of first vblank event. and the time of
 559                  * second vblank is correct.
 560                  */
 561                 wait_info->target_time = TDM_TIME(tv_sec, tv_usec);
 562                 wait_info->target_time += (((double)private_vblank->offset) / 1000.0);
 563
 564                 _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
 565
 566                 ret = _tdm_vblank_sw_timer_update(private_vblank);
 567
 568                 /* wait_info will be freed in _tdm_vblank_cb_vblank_SW() */
 569                 if (ret == TDM_ERROR_NONE) {
 570                         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 571                                 VIN("wait(%p) SW timer", wait_info);
 572                         return;
 573                 }
 574
 575                 VWR("couldn't update sw timer");
 576         }
 577
 578         /* tv_sec & tv_usec shouldn't be zero. But sometimes they are zero in some hardware.
 579          * We need to prohibit that last_time becomes zero because "last_time == 0" means
 580          * that a tdm_vblank object is just created and doesn't have the first vblank event.
 581          * If last_time becomes 0, it would make issue.
 582          */
 583         if (tv_sec == 0 && tv_usec == 0) {
 584                 double curr = tdm_helper_get_time();
 585                 tv_sec = TDM_TIME_SEC(curr);
 586                 tv_usec = TDM_TIME_USEC(curr);
 587         }
 588
 589         private_vblank->last_seq = wait_info->target_seq;
 590         private_vblank->last_time = TDM_TIME(tv_sec, tv_usec);
 591
 592         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 593                 VIN("wait(%p) last(%.6f) sequence(%u) done", wait_info, private_vblank->last_time, wait_info->target_seq);
 594
 595         if (wait_info->func)
 596                 wait_info->func(private_vblank, TDM_ERROR_NONE, wait_info->target_seq,
 597                                                 tv_sec, tv_usec, wait_info->user_data);
 598
 599         LIST_DEL(&wait_info->link);
 600         LIST_DEL(&wait_info->valid_link);
 601         free(wait_info);
 602 }
 603
 604 static tdm_error
 605 _tdm_vblank_wait_HW(tdm_vblank_wait_info *wait_info)
 606 {
 607         tdm_private_vblank *private_vblank = wait_info->private_vblank;
 608         int hw_interval;
 609         tdm_error ret;
 610
 611         _tdm_vblank_insert_wait(wait_info, &private_vblank->HW_wait_list);
 612
 613         hw_interval = wait_info->interval * private_vblank->quotient;
 614
 615         if (private_vblank->last_time == 0) {
 616                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
 617                 private_vblank->last_seq = 0;
 618                 private_vblank->last_time = tdm_helper_get_time();
 619
 620                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
 621                 wait_info->target_seq = 1;
 622                 if (tdm_debug_module & TDM_DEBUG_VBLANK)
 623                         VIN("wait(%p) last(%.6f) hw_itvl(%d) targ_seq(%u)",
 624                                 wait_info, private_vblank->last_time, hw_interval, wait_info->target_seq);
 625         } else {
 626                 double last, prev, req, curr, target;
 627                 unsigned int skip;
 628
 629                 last = private_vblank->last_time;
 630                 req = wait_info->req_time;
 631
 632                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
 633                 prev = last + private_vblank->vblank_gap * skip;
 634
 635                 curr = tdm_helper_get_time();
 636                 target = prev;
 637                 while (target < curr)
 638                         target += private_vblank->vblank_gap;
 639
 640                 hw_interval = (unsigned int)((target - curr) / private_vblank->HW_vblank_gap + TDM_TIME_MARGIN) + 1;
 641
 642                 wait_info->target_seq = private_vblank->last_seq;
 643                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
 644
 645                 if (hw_interval > 300)
 646                         VER("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
 647                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
 648                                 skip, hw_interval, wait_info->target_seq);
 649                 else if (tdm_debug_module & TDM_DEBUG_VBLANK)
 650                         VIN("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) hw_itvl(%d) targ_seq(%u)",
 651                                 wait_info, last, req - last, prev - last, curr - last, target, target - last,
 652                                 skip, hw_interval, wait_info->target_seq);
 653         }
 654
 655         ret = tdm_output_wait_vblank(private_vblank->output, hw_interval, 0,
 656                                                                  _tdm_vblank_cb_vblank_HW, wait_info);
 657
 658         if (ret != TDM_ERROR_NONE) {
 659                 LIST_DEL(&wait_info->link);
 660                 return ret;
 661         }
 662
 663         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 664                 VIN("wait(%p) waiting", wait_info);
 665
 666         return TDM_ERROR_NONE;
 667 }
 668
 669 static tdm_error
 670 _tdm_vblank_cb_vblank_SW(void *user_data)
 671 {
 672         tdm_private_vblank *private_vblank = user_data;
 673
 674         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_OPERATION_FAILED);
 675
 676         return tdm_vblank_cb_vblank_SW(private_vblank, 0);
 677 }
 678
 679 INTERN tdm_error
 680 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp)
 681 {
 682         tdm_private_vblank *private_vblank;
 683         tdm_vblank_wait_info *first_wait_info = NULL, *w = NULL, *ww = NULL;
 684
 685         TDM_RETURN_VAL_IF_FAIL(vblank || vblank_stamp > 0, TDM_ERROR_INVALID_PARAMETER);
 686
 687         if (vblank)
 688                 private_vblank = vblank;
 689         else {
 690                 private_vblank = _tdm_vblank_find(vblank_stamp);
 691                 if (!private_vblank) {
 692                         TDM_DBG("can't find vblank(%.0f) from valid_list", vblank_stamp);
 693                         return TDM_ERROR_NONE;
 694                 }
 695         }
 696
 697         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
 698                 tdm_thread_cb_vblank_sw vblank_sw;
 699                 tdm_private_display *private_display = private_vblank->dpy;
 700                 tdm_error ret;
 701
 702                 vblank_sw.base.type = TDM_THREAD_CB_VBLANK_SW;
 703                 vblank_sw.base.length = sizeof vblank_sw;
 704                 vblank_sw.vblank_stamp = private_vblank->stamp;
 705
 706                 ret = tdm_thread_send_cb(private_display->private_loop, &vblank_sw.base);
 707                 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
 708
 709                 return TDM_ERROR_NONE;
 710         }
 711
 712         if (LIST_IS_EMPTY(&private_vblank->SW_wait_list)) {
 713                 VER("no wait_info");
 714                 return TDM_ERROR_OPERATION_FAILED;
 715         }
 716
 717         first_wait_info = container_of(private_vblank->SW_wait_list.next, first_wait_info, link);
 718         TDM_RETURN_VAL_IF_FAIL(first_wait_info != NULL, TDM_ERROR_OPERATION_FAILED);
 719
 720         if (private_vblank->last_seq >= first_wait_info->target_seq)
 721                 TDM_ERR("last_seq(%u) target_seq(%u)", private_vblank->last_seq, first_wait_info->target_seq);
 722
 723         private_vblank->last_seq = first_wait_info->target_seq;
 724         private_vblank->last_time = first_wait_info->target_time;
 725
 726         if (tdm_debug_module & TDM_DEBUG_VBLANK)
 727                 VIN("wait(%p) last(%.6f) sequence(%u) done", first_wait_info, private_vblank->last_time, first_wait_info->target_seq);
 728
 729         LIST_FOR_EACH_ENTRY_SAFE(w, ww, &private_vblank->SW_wait_list, link) {
 730                 if (w->target_time != first_wait_info->target_time)
 731                         break;
 732
 733                 LIST_DEL(&w->link);
 734                 LIST_DEL(&w->valid_link);
 735
 736                 if (w->func) {
 737                         tdm_display_unlock(private_vblank->dpy);
 738                         w->func(private_vblank, TDM_ERROR_NONE, w->target_seq,
 739                                         TDM_TIME_SEC(w->target_time), TDM_TIME_USEC(w->target_time),
 740                                         w->user_data);
 741                         tdm_display_lock(private_vblank->dpy);
 742                 }
 743
 744                 free(w);
 745         }
 746
 747         return TDM_ERROR_NONE;
 748 }
 749
 750 static tdm_error
 751 _tdm_vblank_wait_SW(tdm_vblank_wait_info *wait_info)
 752 {
 753         tdm_private_vblank *private_vblank = wait_info->private_vblank;
 754         tdm_error ret;
 755
 756         if (private_vblank->last_time == 0) {
 757                 /* SW vblank starts from now. SW vblank doesn't need to be aligned with HW vblank. */
 758                 private_vblank->last_seq = 0;
 759                 private_vblank->last_time = tdm_helper_get_time();
 760
 761                 /* +1 ms to call the handler ASAP at the first. no matter for SW timer. */
 762                 wait_info->target_seq = 1;
 763                 wait_info->target_time = private_vblank->last_time + 0.001;
 764
 765                 if (tdm_debug_module & TDM_DEBUG_VBLANK)
 766                         VIN("wait(%p) last(%.6f) target(%.6f) target sequence(%u)",
 767                                 wait_info, private_vblank->last_time, wait_info->target_time, wait_info->target_seq);
 768         } else {
 769                 double last, prev, req, curr, target;
 770                 unsigned int skip;
 771
 772                 last = private_vblank->last_time;
 773                 req = wait_info->req_time;
 774
 775                 skip = (unsigned int)((req - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
 776                 prev = last + private_vblank->vblank_gap * skip;
 777
 778                 curr = tdm_helper_get_time();
 779                 target = prev + private_vblank->vblank_gap * wait_info->interval;
 780
 781                 while (target < curr)
 782                         target += private_vblank->vblank_gap;
 783
 784                 wait_info->target_seq = private_vblank->last_seq;
 785                 wait_info->target_seq += (unsigned int)((target - last) / private_vblank->vblank_gap + TDM_TIME_MARGIN);
 786
 787                 wait_info->target_time = target;
 788
 789                 if (tdm_debug_module & TDM_DEBUG_VBLANK)
 790                         VIN("wait(%p) last(%.6f) req(%.6f) prev(%.6f) curr(%.6f) targ(%.6f,%.6f) skip(%u) targ_seq(%u)",
 791                                 wait_info, last, req - last, prev - last, curr - last,
 792                                 target, target - last, skip, wait_info->target_seq);
 793         }
 794
 795         _tdm_vblank_insert_wait(wait_info, &private_vblank->SW_wait_list);
 796
 797         ret = _tdm_vblank_sw_timer_update(private_vblank);
 798         if (ret != TDM_ERROR_NONE) {
 799                 LIST_DEL(&wait_info->link);
 800                 VER("couldn't update sw timer");
 801                 return ret;
 802         }
 803
 804         return TDM_ERROR_NONE;
 805 }
 806
 807 EXTERN tdm_error
 808 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
 809                                 unsigned int interval, tdm_vblank_handler func, void *user_data)
 810 {
 811         tdm_private_vblank *private_vblank = vblank;
 812         tdm_vblank_wait_info *wait_info;
 813         tdm_error ret;
 814
 815         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
 816         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
 817
 818         if (private_vblank->owner_tid != syscall(SYS_gettid)) {
 819                 TDM_ERR("SHOULD be called in the owner thread(%d)", (int)private_vblank->owner_tid);
 820                 return TDM_ERROR_BAD_REQUEST;
 821         }
 822
 823         if (private_vblank->dpms != TDM_OUTPUT_DPMS_ON && !private_vblank->enable_fake) {
 824                 VIN("can't wait a vblank because of DPMS off");
 825                 return TDM_ERROR_DPMS_OFF;
 826         }
 827
 828         wait_info = calloc(1, sizeof * wait_info);
 829         if (!wait_info) {
 830                 VER("alloc failed");
 831                 return TDM_ERROR_OUT_OF_MEMORY;
 832         }
 833
 834         /* set request time to current time if 0. This function seems to be called in server side. */
 835         if (req_sec == 0 && req_usec == 0) {
 836                 double curr = tdm_helper_get_time();
 837                 req_sec = TDM_TIME_SEC(curr);
 838                 req_usec = TDM_TIME_USEC(curr);
 839         }
 840
 841         LIST_INITHEAD(&wait_info->link);
 842         LIST_ADDTAIL(&wait_info->valid_link, &valid_wait_list);
 843         wait_info->stamp = ++stamp;
 844         wait_info->req_time = TDM_TIME(req_sec, req_usec);
 845         wait_info->interval = interval;
 846         wait_info->func = func;
 847         wait_info->user_data = user_data;
 848         wait_info->private_vblank = private_vblank;
 849
 850         if (private_vblank->check_HW_or_SW) {
 851                 private_vblank->check_HW_or_SW = 0;
 852                 private_vblank->vblank_gap = 1.0 / private_vblank->fps;
 853                 private_vblank->quotient = private_vblank->vrefresh / private_vblank->fps;
 854         }
 855
 856         /* 1) if fps != factor of vrefresh, SW timer
 857          * 2) if fps == factor of vrefresh && dpms == off, SW timer (Fake HW vblank)
 858          * 2) if fps == factor of vrefresh && dpms == on && offset == 0, HW vblank
 859          * 3) if fps == factor of vrefresh && dpms == on && offset != 0, HW vblank + SW timer
 860          * In case of 1), we really don't need to align with HW vblank.
 861          */
 862         if (private_vblank->vrefresh % private_vblank->fps)
 863                 wait_info->type = VBLANK_TYPE_SW;
 864         else if (private_vblank->dpms == TDM_OUTPUT_DPMS_OFF)
 865                 wait_info->type = VBLANK_TYPE_SW_FAKE;
 866         else if (private_vblank->offset == 0)
 867                 wait_info->type = VBLANK_TYPE_HW;
 868         else
 869                 wait_info->type = VBLANK_TYPE_HW_SW;
 870
 871         if (wait_info->type == VBLANK_TYPE_SW || wait_info->type == VBLANK_TYPE_SW_FAKE)
 872                 ret = _tdm_vblank_wait_SW(wait_info);
 873         else {
 874                 ret = _tdm_vblank_wait_HW(wait_info);
 875                 if (ret == TDM_ERROR_DPMS_OFF)
 876                         ret = _tdm_vblank_wait_SW(wait_info);
 877         }
 878
 879         if (ret != TDM_ERROR_NONE) {
 880                 LIST_DEL(&wait_info->link);
 881                 LIST_DEL(&wait_info->valid_link);
 882                 free(wait_info);
 883                 return ret;
 884         }
 885
 886         return TDM_ERROR_NONE;
 887 }
 888
 889 EXTERN tdm_error
 890 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
 891                                         unsigned int sequence, tdm_vblank_handler func, void *user_data)
 892 {
 893         tdm_private_vblank *private_vblank = vblank;
 894         unsigned int interval;
 895
 896         TDM_RETURN_VAL_IF_FAIL(private_vblank != NULL, TDM_ERROR_INVALID_PARAMETER);
 897         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
 898
 899         /* if the sequence of vblank reaches the max value, sequence can be 0. */
 900
 901         if (private_vblank->last_seq == 0) {
 902                 TDM_WRN("can't calculate interval with sequence(%u)", sequence);
 903                 interval = 1;
 904         } else if (sequence > private_vblank->last_seq ||
 905                            TDM_VBLANK_SEQ_REACHED_MAX(sequence, private_vblank->last_seq)) {
 906                 double last, curr, seq_target;
 907
 908                 last = private_vblank->last_time;
 909                 curr = tdm_helper_get_time();
 910                 seq_target = last + private_vblank->vblank_gap * (sequence - private_vblank->last_seq);
 911
 912                 /* If target is old or too close(1ms) to current, we call the handler immediately.
 913                  * 2ms? it seems too much.
 914                  */
 915                 if (seq_target < curr) {
 916                         func(vblank, TDM_ERROR_NONE, sequence,
 917                                  TDM_TIME_SEC(seq_target), TDM_TIME_USEC(seq_target),
 918                                  user_data);
 919                         return TDM_ERROR_NONE;
 920                 } else if ((seq_target - curr) < 0.001) {  /* 1ms */
 921                         func(vblank, TDM_ERROR_NONE, sequence,
 922                                  TDM_TIME_SEC(curr), TDM_TIME_USEC(curr),
 923                                  user_data);
 924                         return TDM_ERROR_NONE;
 925                 }
 926
 927                 interval = (unsigned int)((seq_target - curr) / private_vblank->vblank_gap + TDM_TIME_MARGIN) + 1;
 928         } else {
 929                 /* this seems error. But we handle this like normal to avoid the unexpected error in cliend side */
 930                 TDM_WRN("sequence(%u) should be over the last sequence(%u)", sequence, private_vblank->last_seq);
 931                 func(vblank, TDM_ERROR_NONE, private_vblank->last_seq,
 932                          TDM_TIME_SEC(private_vblank->last_time), TDM_TIME_USEC(private_vblank->last_time),
 933                          user_data);
 934                 return TDM_ERROR_NONE;
 935         }
 936
 937         return tdm_vblank_wait(vblank, req_sec, req_usec, interval, func, user_data);
 938 }