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         int set_voutput_commit;
 272 };
 273
 274 struct _tdm_private_layer {
 275         struct list_head link;
 276
 277         tdm_private_module *private_module;
 278
 279         int index;
 280
 281         tdm_private_display *private_display;
 282         tdm_private_output *private_output;
 283
 284         tdm_caps_layer caps;
 285         tdm_layer *layer_backend;
 286
 287         /* pending data until committed */
 288         unsigned int pending_info_changed;
 289         tdm_info_layer pending_info;
 290         unsigned int pending_buffer_changed;
 291         tbm_surface_h pending_buffer;
 292
 293         /* When a buffer is set to a layer, it will be stored to waiting_buffer.
 294          * And when a layer is committed, it will be moved to committed_buffer.
 295          * Finally when a commit handler is called, it will be moved to showing_buffer.
 296          */
 297         tdm_private_layer_buffer *waiting_buffer;
 298         tdm_private_layer_buffer *committed_buffer;   /* for output_commit */
 299         tdm_private_layer_buffer *showing_buffer;
 300         tbm_surface_queue_h buffer_queue;
 301
 302         struct list_head capture_list;
 303
 304         unsigned int usable;
 305         unsigned int committing;
 306
 307         double fps_stamp;
 308         unsigned int fps_count;
 309
 310          /* virtual */
 311         tbm_surface_h commiting_buffer;
 312 };
 313
 314 struct _tdm_private_hwc {
 315         struct list_head link;
 316
 317         tdm_private_module *private_module;
 318
 319         int index;
 320         double stamp;
 321
 322         tdm_private_output *private_output;
 323
 324         struct list_head hwc_window_list;
 325         struct list_head hwc_commit_handler_list;
 326
 327         int regist_commit_cb;
 328
 329         tdm_hwc *hwc_backend;
 330 };
 331
 332 struct _tdm_private_hwc_window {
 333         struct list_head link;
 334
 335         tdm_private_module *private_module;
 336
 337         tdm_private_hwc *private_hwc;
 338         tdm_hwc_window *hwc_window_backend;
 339 };
 340
 341 struct _tdm_private_pp {
 342         struct list_head link;
 343
 344         tdm_private_module *private_module;
 345
 346         double stamp;
 347
 348         tdm_private_display *private_display;
 349
 350         tdm_pp *pp_module;
 351
 352         struct list_head pending_buffer_list;
 353         struct list_head buffer_list;
 354
 355         tdm_info_pp info;
 356         pid_t owner_tid;
 357
 358         tdm_pp_done_handler done_func;
 359         void *done_user_data;
 360 };
 361
 362 struct _tdm_private_capture {
 363         struct list_head link;
 364         struct list_head display_link;
 365
 366         tdm_private_module *private_module;
 367
 368         double stamp;
 369
 370         tdm_capture_target target;
 371
 372         tdm_private_display *private_display;
 373         tdm_private_output *private_output;
 374         tdm_private_layer *private_layer;
 375
 376         tdm_capture *capture_module;
 377
 378         struct list_head pending_buffer_list;
 379         struct list_head buffer_list;
 380
 381         tdm_info_capture info;
 382         pid_t owner_tid;
 383
 384         tdm_capture_done_handler done_func;
 385         void *done_user_data;
 386 };
 387
 388 /* CAUTION:
 389  * Note that we don't need to (un)lock mutex to use this structure. If there is
 390  * no TDM thread, all TDM resources are protected by private_display's mutex.
 391  * If there is a TDM thread, this struct will be used only in a TDM thread.
 392  * So, we don't need to protect this structure by mutex. Not thread-safe.
 393  */
 394 struct _tdm_private_loop {
 395         /* TDM uses wl_event_loop to handle various event sources including the TDM
 396          * backend's fd.
 397          */
 398         struct wl_display *wl_display;
 399         struct wl_event_loop *wl_loop;
 400
 401         /* In event loop, all resources are accessed by this dpy.
 402          * CAUTION:
 403          * - DO NOT include other private structure in this structure because this
 404          *   struct is not protected by mutex.
 405          */
 406         tdm_display *dpy;
 407
 408         /* for handling TDM client requests */
 409         tdm_private_server *private_server;
 410
 411         /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
 412          * private_thread is NULL.
 413          */
 414         tdm_private_thread *private_thread;
 415
 416         struct list_head source_list;
 417 };
 418
 419 struct _tdm_private_output_vblank_handler {
 420         struct list_head link;
 421
 422         tdm_private_output *private_output;
 423         int interval;
 424         int sync;
 425         tdm_output_vblank_handler func;
 426         void *user_data;
 427
 428         unsigned int sent_to_frontend;
 429
 430         pid_t owner_tid;
 431 };
 432
 433 struct _tdm_private_output_create_handler {
 434         struct list_head link;
 435
 436         tdm_private_display *private_display;
 437         tdm_output_create_handler func;
 438         void *user_data;
 439
 440         pid_t owner_tid;
 441 };
 442
 443 struct _tdm_private_output_destroy_handler {
 444         struct list_head link;
 445
 446         tdm_private_output *private_output;
 447         tdm_output_destroy_handler func;
 448         void *user_data;
 449
 450         pid_t owner_tid;
 451 };
 452
 453 struct _tdm_private_output_change_handler {
 454         struct list_head link;
 455
 456         tdm_private_output *private_output;
 457         tdm_output_change_handler func;
 458         void *user_data;
 459
 460         pid_t owner_tid;
 461 };
 462
 463 struct _tdm_private_output_commit_handler {
 464         struct list_head link;
 465
 466         tdm_private_output *private_output;
 467         tdm_output_commit_handler func;
 468         void *user_data;
 469
 470         pid_t owner_tid;
 471 };
 472
 473 struct _tdm_private_voutput_commit_handler {
 474         struct list_head link;
 475
 476         tdm_private_voutput *private_voutput;
 477         tdm_voutput_commit_func func;
 478         void *user_data;
 479
 480         pid_t owner_tid;
 481 };
 482
 483 struct _tdm_private_output_mode_change_handler {
 484         struct list_head link;
 485
 486         tdm_private_output *private_output;
 487         tdm_output_mode_change_request_handler func;
 488         void *user_data;
 489 };
 490
 491 struct _tdm_private_hwc_commit_handler {
 492         struct list_head link;
 493
 494         tdm_private_hwc *private_hwc;
 495         tdm_hwc_commit_handler func;
 496         void *user_data;
 497
 498         pid_t owner_tid;
 499 };
 500
 501 struct _tdm_private_layer_commit_handler {
 502         struct list_head link;
 503
 504         tdm_private_layer *private_layer;
 505         tdm_layer_commit_handler func;
 506         void *user_data;
 507
 508         tdm_private_layer_buffer *committed_buffer;   /* for layer_commit */
 509 };
 510
 511 struct _tdm_private_layer_buffer {
 512         tbm_surface_h buffer;
 513         struct list_head link;
 514 };
 515
 516 typedef struct _tdm_buffer_info {
 517         tbm_surface_h buffer;
 518
 519         /* ref_count for backend */
 520         int backend_ref_count;
 521
 522         struct list_head release_funcs;
 523         struct list_head destroy_funcs;
 524
 525         struct list_head *list;
 526         struct list_head link;
 527 } tdm_buffer_info;
 528
 529 typedef struct _tdm_pp_private_buffer {
 530         tbm_surface_h src;
 531         tbm_surface_h dst;
 532         struct list_head link;
 533         struct list_head commit_link;
 534 } tdm_pp_private_buffer;
 535
 536 typedef struct _tdm_capture_private_buffer {
 537         tbm_surface_h buffer;
 538         struct list_head link;
 539         struct list_head commit_link;
 540 } tdm_capture_private_buffer;
 541
 542 typedef enum {
 543         TDM_THREAD_CB_NONE,
 544         TDM_THREAD_CB_EXIT,             /* special type to exit the tdm-thread */
 545         TDM_THREAD_CB_DISPLAY_OUTPUT_CREATE,
 546         TDM_THREAD_CB_OUTPUT_DESTROY,
 547         TDM_THREAD_CB_OUTPUT_COMMIT,
 548         TDM_THREAD_CB_OUTPUT_VBLANK,
 549         TDM_THREAD_CB_OUTPUT_STATUS,
 550         TDM_THREAD_CB_OUTPUT_DPMS,
 551         TDM_THREAD_CB_PP_DONE,
 552         TDM_THREAD_CB_CAPTURE_DONE,
 553         TDM_THREAD_CB_VBLANK_SW,
 554         TDM_THREAD_CB_VBLANK_CREATE,
 555         TDM_THREAD_CB_HWC_COMMIT,
 556         TDM_THREAD_CB_VOUTPUT_COMMIT,
 557         TDM_THREAD_CB_MAX,
 558 } tdm_thread_cb_type;
 559
 560 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
 561 typedef struct _tdm_thread_cb_display_output_create tdm_thread_cb_display_output_create;
 562 typedef struct _tdm_thread_cb_output_destroy tdm_thread_cb_output_destroy;
 563 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
 564 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
 565 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
 566 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
 567 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
 568 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
 569 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
 570 typedef struct _tdm_thread_cb_vblank_create tdm_thread_cb_vblank_create;
 571 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_hwc_commit;
 572 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_voutput_commit;
 573
 574 struct _tdm_thread_cb_base {
 575         tdm_thread_cb_type type;
 576         unsigned int length;
 577         double object_stamp;
 578         void *data;
 579         unsigned int sync;
 580 };
 581
 582 struct _tdm_thread_cb_display_output_create {
 583         tdm_thread_cb_base base;
 584         tdm_output *output;
 585 };
 586
 587 struct _tdm_thread_cb_output_destroy {
 588         tdm_thread_cb_base base;
 589 };
 590
 591 struct _tdm_thread_cb_output_vblank {
 592         tdm_thread_cb_base base;
 593         unsigned int sequence;
 594         unsigned int tv_sec;
 595         unsigned int tv_usec;
 596 };
 597
 598 struct _tdm_thread_cb_output_status {
 599         tdm_thread_cb_base base;
 600         tdm_output_conn_status status;
 601 };
 602
 603 struct _tdm_thread_cb_output_dpms {
 604         tdm_thread_cb_base base;
 605         tdm_output_dpms dpms;
 606 };
 607
 608 struct _tdm_thread_cb_pp_done {
 609         tdm_thread_cb_base base;
 610         tbm_surface_h src;
 611         tbm_surface_h dst;
 612 };
 613
 614 struct _tdm_thread_cb_capture_done {
 615         tdm_thread_cb_base base;
 616         tbm_surface_h buffer;
 617 };
 618
 619 struct _tdm_thread_cb_vblank_sw {
 620         tdm_thread_cb_base base;
 621 };
 622
 623 struct _tdm_thread_cb_vblank_create {
 624         tdm_thread_cb_base base;
 625         double vblank_stamp;
 626 };
 627
 628 struct argument_details {
 629         char type;
 630         int nullable;
 631 };
 632
 633 #ifdef __cplusplus
 634 }
 635 #endif
 636
 637 #endif /* _TDM_PRIVATE_TYPES_H_ */