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