src/tdm_private_types.h

   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 <boram1288.park@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 #ifndef _TDM_PRIVATE_TYPES_H_
  37 #define _TDM_PRIVATE_TYPES_H_
  38
  39 #include <pthread.h>
  40 #include <tbm_bufmgr.h>
  41 #include <tbm_surface_queue.h>
  42
  43 #include "tdm_types.h"
  44 #include "tdm_list.h"
  45 #include "tdm_log.h"
  46 #include "tdm.h"
  47 #include "tdm_backend.h"
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 //#define INIT_BUFMGR
  54
  55 /*****************************************************************************
  56  * This file defines private Enumerations and Structures for frontend
  57  *****************************************************************************/
  58
  59 enum {
  60         TDM_DEBUG_NONE,
  61         TDM_DEBUG_BUFFER    = (1 << 0),
  62         TDM_DEBUG_MUTEX     = (1 << 1),
  63         TDM_DEBUG_EVENT     = (1 << 2),
  64         TDM_DEBUG_THREAD    = (1 << 3),
  65         TDM_DEBUG_SERVER    = (1 << 4),
  66         TDM_DEBUG_VBLANK    = (1 << 5),
  67         TDM_DEBUG_COMMIT    = (1 << 6),
  68 };
  69
  70 enum {
  71         TDM_TTRACE_NONE,
  72         TDM_TTRACE_VSYNC            = (1 << 0),
  73         TDM_TTRACE_CLIENT_VBLANK    = (1 << 1),
  74         TDM_TTRACE_SERVER_VBLANK    = (1 << 2),
  75         TDM_TTRACE_VBLANK           = (1 << 3),
  76         TDM_TTRACE_LAYER            = (1 << 4),
  77         TDM_TTRACE_PP               = (1 << 5),
  78         TDM_TTRACE_CAPTURE          = (1 << 6),
  79 };
  80
  81 typedef enum {
  82         TDM_CAPTURE_TARGET_OUTPUT,
  83         TDM_CAPTURE_TARGET_LAYER,
  84 } tdm_capture_target;
  85
  86 enum {
  87         TDM_DUMP_FLAG_LAYER   = (1 << 0),
  88         TDM_DUMP_FLAG_PP      = (1 << 1),
  89         TDM_DUMP_FLAG_CAPTURE = (1 << 2),
  90         TDM_DUMP_FLAG_WINDOW = (1 << 3),
  91 };
  92
  93 typedef enum {
  94         TDM_COMMIT_TYPE_NONE,
  95         TDM_COMMIT_TYPE_OUTPUT,
  96         TDM_COMMIT_TYPE_LAYER,
  97 } tdm_commit_type;
  98
  99 typedef struct _tdm_private_module tdm_private_module;
 100 typedef struct _tdm_private_display tdm_private_display;
 101 typedef struct _tdm_private_output tdm_private_output;
 102 typedef struct _tdm_private_voutput tdm_private_voutput;
 103 typedef struct _tdm_private_layer tdm_private_layer;
 104 typedef struct _tdm_private_hwc tdm_private_hwc;
 105 typedef struct _tdm_private_hwc_window tdm_private_hwc_window;
 106 typedef struct _tdm_private_pp tdm_private_pp;
 107 typedef struct _tdm_private_capture tdm_private_capture;
 108 typedef struct _tdm_private_loop tdm_private_loop;
 109 typedef struct _tdm_private_server tdm_private_server;
 110 typedef struct _tdm_private_thread tdm_private_thread;
 111 typedef struct _tdm_private_output_create_handler tdm_private_output_create_handler;
 112 typedef struct _tdm_private_output_destroy_handler tdm_private_output_destroy_handler;
 113 typedef struct _tdm_private_output_change_handler tdm_private_output_change_handler;
 114 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
 115 typedef struct _tdm_private_output_vblank_handler tdm_private_output_vblank_handler;
 116 typedef struct _tdm_private_output_mode_change_handler tdm_private_output_mode_change_handler;
 117 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
 118 typedef struct _tdm_private_hwc_commit_handler tdm_private_hwc_commit_handler;
 119 typedef struct _tdm_private_voutput_commit_handler tdm_private_voutput_commit_handler;
 120
 121 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
 122
 123 struct _tdm_private_module {
 124         struct list_head link;
 125
 126         tdm_private_display *private_display;
 127
 128         /* backend module info */
 129         void *module;
 130         tdm_backend_module *module_data;
 131         tdm_backend_data *bdata;
 132
 133         /* backend function */
 134         tdm_display_capability capabilities;
 135         tdm_func_display func_display;
 136         tdm_func_output func_output;
 137         tdm_func_voutput func_voutput;
 138         tdm_func_layer func_layer;
 139         tdm_func_hwc func_hwc;
 140         tdm_func_hwc_window func_hwc_window;
 141         tdm_func_pp func_pp;
 142         tdm_func_capture func_capture;
 143
 144         /* backend capability */
 145         tdm_caps_display caps_display;
 146         tdm_caps_pp caps_pp;
 147         tdm_caps_capture caps_capture;
 148
 149         /* output, pp list */
 150         struct list_head output_list;
 151         struct list_head voutput_list;
 152         struct list_head pp_list;
 153         struct list_head capture_list;
 154
 155         /* backend output objects. allocated in backend. freed in frontend. ordered */
 156         tdm_output **outputs;
 157
 158         int fd;
 159         tdm_event_loop_source *event_source;
 160 };
 161
 162 struct _tdm_private_display {
 163         pthread_mutex_t lock;
 164         unsigned int init_count;
 165
 166         double stamp;
 167
 168 #ifdef INIT_BUFMGR
 169         tbm_bufmgr bufmgr;
 170 #endif
 171
 172         struct list_head module_list;
 173         tdm_private_module *dummy_module;
 174         tdm_private_module *virtual_module;
 175         tdm_private_module *current_module;  //setted only when loading
 176         tdm_private_module *pp_module;       //pp-support backend
 177         tdm_private_module *capture_module;  //TODO: remove later
 178
 179         /* for event handling */
 180         tdm_private_loop *private_loop;
 181
 182         struct list_head output_create_handler_list;
 183
 184         int print_fps;
 185 };
 186
 187 struct _tdm_private_output {
 188         struct list_head link;
 189
 190         tdm_private_module *private_module;
 191         tdm_private_voutput *private_voutput;
 192
 193         int index;
 194         double stamp;
 195
 196         tdm_private_display *private_display;
 197
 198         tdm_caps_output caps;
 199         tdm_output *output_backend;
 200
 201         unsigned int pipe;
 202         tdm_output_dpms current_dpms_value;
 203         unsigned int waiting_dpms_change;
 204         const tdm_output_mode *current_mode;
 205
 206         int regist_vblank_cb;
 207         int regist_commit_cb;
 208         int regist_change_cb;
 209         int regist_dpms_cb;
 210
 211         struct list_head layer_list;
 212         struct list_head capture_list;
 213         struct list_head vblank_handler_list;
 214         struct list_head output_commit_handler_list;
 215
 216         /* for layer commit */
 217         struct list_head layer_commit_handler_list;
 218         struct list_head pending_commit_handler_list;
 219         tdm_vblank *vblank;
 220         int layer_waiting_vblank;
 221
 222         tdm_event_loop_source *vblank_timeout_timer;
 223         unsigned int vblank_timeout_timer_expired;
 224
 225         struct list_head destroy_handler_list;
 226         struct list_head change_handler_list;
 227
 228         void **layers_ptr;
 229
 230         tdm_info_layer target_buffer_info; /* layer_info for the target_buffer */
 231
 232         /* calling a output commit per a vblank */
 233         int commit_per_vblank;
 234         tdm_commit_type commit_type;
 235
 236         /* for ttrace vblank */
 237         tdm_vblank *ttrace_vblank;
 238
 239         /* hwc */
 240         int need_set_target_info;
 241         tdm_private_hwc *private_hwc;
 242
 243         /* virtual */
 244         char name[TDM_NAME_LEN];
 245         struct list_head mode_change_request_handler_list;
 246 };
 247
 248 struct _tdm_private_voutput {
 249         struct list_head link;
 250
 251         tdm_private_module *private_module;
 252
 253         int regist_commit_cb;
 254
 255         struct list_head voutput_commit_handler_list;
 256
 257         int index;
 258
 259         tdm_private_display *private_display;
 260         tdm_private_output *private_output;
 261
 262         tdm_voutput *voutput_backend;
 263
 264         char name[TDM_NAME_LEN];
 265         tdm_output_mode *modes;
 266         int mode_count;
 267         unsigned int mmwidth;
 268         unsigned int mmheight;
 269         int connect_status;
 270 };
 271
 272 struct _tdm_private_layer {
 273         struct list_head link;
 274
 275         tdm_private_module *private_module;
 276
 277         int index;
 278
 279         tdm_private_display *private_display;
 280         tdm_private_output *private_output;
 281
 282         tdm_caps_layer caps;
 283         tdm_layer *layer_backend;
 284
 285         /* pending data until committed */
 286         unsigned int pending_info_changed;
 287         tdm_info_layer pending_info;
 288         unsigned int pending_buffer_changed;
 289         tbm_surface_h pending_buffer;
 290
 291         /* When a buffer is set to a layer, it will be stored to waiting_buffer.
 292          * And when a layer is committed, it will be moved to committed_buffer.
 293          * Finally when a commit handler is called, it will be moved to showing_buffer.
 294          */
 295         tdm_private_layer_buffer *waiting_buffer;
 296         tdm_private_layer_buffer *committed_buffer;   /* for output_commit */
 297         tdm_private_layer_buffer *showing_buffer;
 298         tbm_surface_queue_h buffer_queue;
 299
 300         struct list_head capture_list;
 301
 302         unsigned int usable;
 303         unsigned int committing;
 304
 305         double fps_stamp;
 306         unsigned int fps_count;
 307
 308          /* virtual */
 309         tbm_surface_h commiting_buffer;
 310 };
 311
 312 struct _tdm_private_hwc {
 313         struct list_head link;
 314
 315         tdm_private_module *private_module;
 316
 317         int index;
 318         double stamp;
 319
 320         tdm_private_output *private_output;
 321
 322         struct list_head hwc_window_list;
 323         struct list_head hwc_commit_handler_list;
 324
 325         int regist_commit_cb;
 326
 327         tdm_hwc *hwc_backend;
 328 };
 329
 330 struct _tdm_private_hwc_window {
 331         struct list_head link;
 332
 333         tdm_private_module *private_module;
 334
 335         tdm_private_hwc *private_hwc;
 336         tdm_hwc_window *hwc_window_backend;
 337 };
 338
 339 struct _tdm_private_pp {
 340         struct list_head link;
 341
 342         tdm_private_module *private_module;
 343
 344         double stamp;
 345
 346         tdm_private_display *private_display;
 347
 348         tdm_pp *pp_module;
 349
 350         struct list_head pending_buffer_list;
 351         struct list_head buffer_list;
 352
 353         tdm_info_pp info;
 354         pid_t owner_tid;
 355
 356         tdm_pp_done_handler done_func;
 357         void *done_user_data;
 358 };
 359
 360 struct _tdm_private_capture {
 361         struct list_head link;
 362         struct list_head display_link;
 363
 364         tdm_private_module *private_module;
 365
 366         double stamp;
 367
 368         tdm_capture_target target;
 369
 370         tdm_private_display *private_display;
 371         tdm_private_output *private_output;
 372         tdm_private_layer *private_layer;
 373
 374         tdm_capture *capture_module;
 375
 376         struct list_head pending_buffer_list;
 377         struct list_head buffer_list;
 378
 379         tdm_info_capture info;
 380         pid_t owner_tid;
 381
 382         tdm_capture_done_handler done_func;
 383         void *done_user_data;
 384 };
 385
 386 /* CAUTION:
 387  * Note that we don't need to (un)lock mutex to use this structure. If there is
 388  * no TDM thread, all TDM resources are protected by private_display's mutex.
 389  * If there is a TDM thread, this struct will be used only in a TDM thread.
 390  * So, we don't need to protect this structure by mutex. Not thread-safe.
 391  */
 392 struct _tdm_private_loop {
 393         /* TDM uses wl_event_loop to handle various event sources including the TDM
 394          * backend's fd.
 395          */
 396         struct wl_display *wl_display;
 397         struct wl_event_loop *wl_loop;
 398
 399         /* In event loop, all resources are accessed by this dpy.
 400          * CAUTION:
 401          * - DO NOT include other private structure in this structure because this
 402          *   struct is not protected by mutex.
 403          */
 404         tdm_display *dpy;
 405
 406         /* for handling TDM client requests */
 407         tdm_private_server *private_server;
 408
 409         /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
 410          * private_thread is NULL.
 411          */
 412         tdm_private_thread *private_thread;
 413
 414         struct list_head source_list;
 415 };
 416
 417 struct _tdm_private_output_vblank_handler {
 418         struct list_head link;
 419
 420         tdm_private_output *private_output;
 421         int interval;
 422         int sync;
 423         tdm_output_vblank_handler func;
 424         void *user_data;
 425
 426         unsigned int sent_to_frontend;
 427
 428         pid_t owner_tid;
 429 };
 430
 431 struct _tdm_private_output_create_handler {
 432         struct list_head link;
 433
 434         tdm_private_display *private_display;
 435         tdm_output_create_handler func;
 436         void *user_data;
 437
 438         pid_t owner_tid;
 439 };
 440
 441 struct _tdm_private_output_destroy_handler {
 442         struct list_head link;
 443
 444         tdm_private_output *private_output;
 445         tdm_output_destroy_handler func;
 446         void *user_data;
 447
 448         pid_t owner_tid;
 449 };
 450
 451 struct _tdm_private_output_change_handler {
 452         struct list_head link;
 453
 454         tdm_private_output *private_output;
 455         tdm_output_change_handler func;
 456         void *user_data;
 457
 458         pid_t owner_tid;
 459 };
 460
 461 struct _tdm_private_output_commit_handler {
 462         struct list_head link;
 463
 464         tdm_private_output *private_output;
 465         tdm_output_commit_handler func;
 466         void *user_data;
 467
 468         pid_t owner_tid;
 469 };
 470
 471 struct _tdm_private_voutput_commit_handler {
 472         struct list_head link;
 473
 474         tdm_private_voutput *private_voutput;
 475         tdm_voutput_commit_func func;
 476         void *user_data;
 477
 478         pid_t owner_tid;
 479 };
 480
 481 struct _tdm_private_output_mode_change_handler {
 482         struct list_head link;
 483
 484         tdm_private_output *private_output;
 485         tdm_output_mode_change_request_handler func;
 486         void *user_data;
 487 };
 488
 489 struct _tdm_private_hwc_commit_handler {
 490         struct list_head link;
 491
 492         tdm_private_hwc *private_hwc;
 493         tdm_hwc_commit_handler func;
 494         void *user_data;
 495
 496         pid_t owner_tid;
 497 };
 498
 499 struct _tdm_private_layer_commit_handler {
 500         struct list_head link;
 501
 502         tdm_private_layer *private_layer;
 503         tdm_layer_commit_handler func;
 504         void *user_data;
 505
 506         tdm_private_layer_buffer *committed_buffer;   /* for layer_commit */
 507 };
 508
 509 struct _tdm_private_layer_buffer {
 510         tbm_surface_h buffer;
 511         struct list_head link;
 512 };
 513
 514 typedef struct _tdm_buffer_info {
 515         tbm_surface_h buffer;
 516
 517         /* ref_count for backend */
 518         int backend_ref_count;
 519
 520         struct list_head release_funcs;
 521         struct list_head destroy_funcs;
 522
 523         struct list_head *list;
 524         struct list_head link;
 525 } tdm_buffer_info;
 526
 527 typedef struct _tdm_pp_private_buffer {
 528         tbm_surface_h src;
 529         tbm_surface_h dst;
 530         struct list_head link;
 531         struct list_head commit_link;
 532 } tdm_pp_private_buffer;
 533
 534 typedef struct _tdm_capture_private_buffer {
 535         tbm_surface_h buffer;
 536         struct list_head link;
 537         struct list_head commit_link;
 538 } tdm_capture_private_buffer;
 539
 540 typedef enum {
 541         TDM_THREAD_CB_NONE,
 542         TDM_THREAD_CB_EXIT,             /* special type to exit the tdm-thread */
 543         TDM_THREAD_CB_DISPLAY_OUTPUT_CREATE,
 544         TDM_THREAD_CB_OUTPUT_DESTROY,
 545         TDM_THREAD_CB_OUTPUT_COMMIT,
 546         TDM_THREAD_CB_OUTPUT_VBLANK,
 547         TDM_THREAD_CB_OUTPUT_STATUS,
 548         TDM_THREAD_CB_OUTPUT_DPMS,
 549         TDM_THREAD_CB_PP_DONE,
 550         TDM_THREAD_CB_CAPTURE_DONE,
 551         TDM_THREAD_CB_VBLANK_SW,
 552         TDM_THREAD_CB_VBLANK_CREATE,
 553         TDM_THREAD_CB_HWC_COMMIT,
 554         TDM_THREAD_CB_VOUTPUT_COMMIT,
 555         TDM_THREAD_CB_MAX,
 556 } tdm_thread_cb_type;
 557
 558 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
 559 typedef struct _tdm_thread_cb_display_output_create tdm_thread_cb_display_output_create;
 560 typedef struct _tdm_thread_cb_output_destroy tdm_thread_cb_output_destroy;
 561 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
 562 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
 563 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
 564 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
 565 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
 566 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
 567 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
 568 typedef struct _tdm_thread_cb_vblank_create tdm_thread_cb_vblank_create;
 569 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_hwc_commit;
 570 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_voutput_commit;
 571
 572 struct _tdm_thread_cb_base {
 573         tdm_thread_cb_type type;
 574         unsigned int length;
 575         double object_stamp;
 576         void *data;
 577         unsigned int sync;
 578 };
 579
 580 struct _tdm_thread_cb_display_output_create {
 581         tdm_thread_cb_base base;
 582         tdm_output *output;
 583 };
 584
 585 struct _tdm_thread_cb_output_destroy {
 586         tdm_thread_cb_base base;
 587 };
 588
 589 struct _tdm_thread_cb_output_vblank {
 590         tdm_thread_cb_base base;
 591         unsigned int sequence;
 592         unsigned int tv_sec;
 593         unsigned int tv_usec;
 594 };
 595
 596 struct _tdm_thread_cb_output_status {
 597         tdm_thread_cb_base base;
 598         tdm_output_conn_status status;
 599 };
 600
 601 struct _tdm_thread_cb_output_dpms {
 602         tdm_thread_cb_base base;
 603         tdm_output_dpms dpms;
 604 };
 605
 606 struct _tdm_thread_cb_pp_done {
 607         tdm_thread_cb_base base;
 608         tbm_surface_h src;
 609         tbm_surface_h dst;
 610 };
 611
 612 struct _tdm_thread_cb_capture_done {
 613         tdm_thread_cb_base base;
 614         tbm_surface_h buffer;
 615 };
 616
 617 struct _tdm_thread_cb_vblank_sw {
 618         tdm_thread_cb_base base;
 619 };
 620
 621 struct _tdm_thread_cb_vblank_create {
 622         tdm_thread_cb_base base;
 623         double vblank_stamp;
 624 };
 625
 626 struct argument_details {
 627         char type;
 628         int nullable;
 629 };
 630
 631 #ifdef __cplusplus
 632 }
 633 #endif
 634
 635 #endif /* _TDM_PRIVATE_TYPES_H_ */