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