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