include/tdm_helper.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 <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 #ifndef _TDM_HELPER_H_
  37 #define _TDM_HELPER_H_
  38
  39 #include "tdm_types.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  * @file tdm_helper.h
  47  * @brief The header file to help a vendor to implement a backend module
  48  * @remark
  49  * tdm_helper_drm_fd is external drm_fd which is opened by ecore_drm.
  50  * This is very @b TRICKY!! But we have no choice at this time because ecore_drm
  51  * doesn't use tdm yet. When we make ecore_drm use tdm, tdm_helper_drm_fd will
  52  * be removed.
  53  * @warning
  54  * If tdm_helper_drm_fd is more than -1, a tdm backend module @b SHOULDN't call
  55  * drmWaitVBlank by itself because a DRM vblank event will be handled in ecore_drm
  56  * internally. In this case, a tdm backend module NEVER get a DRM vblank event.
  57  * If a tdm backend module need to handle a vendor specific DRM event,
  58  * drmAddUserHandler() of libdrm makes possible that a tdm backend module handle
  59  * it.
  60  * @par Example
  61  * @code
  62     static int
  63     _tdm_drm_user_handler(struct drm_event *event)
  64     {
  65         if (event->type != DRM_VENDOR_XXX_EVENT)
  66             return -1;
  67
  68         //handling a vendor event
  69
  70         return 0;
  71     }
  72
  73     ...
  74
  75     drm_data->drm_fd = -1;
  76     if (tdm_helper_drm_fd >= 0)
  77     {
  78         drm_data->drm_fd = tdm_helper_drm_fd;
  79         drmAddUserHandler(tdm_helper_drm_fd, _tdm_drm_user_handler);
  80     }
  81
  82     if (drm_data->drm_fd < 0)
  83         drm_data->drm_fd = _tdm_drm_open_drm();
  84
  85     ...
  86
  87     drmRemoveUserHandler(tdm_helper_drm_fd, _tdm_drm_user_handler);
  88  * @endcode
  89  * @code
  90     if (tdm_helper_drm_fd == -1)
  91     {
  92         ...
  93         if (drmWaitVBlank(fd, &vbl))
  94             return TDM_ERROR_OPERATION_FAILED;
  95         ...
  96     }
  97  * @endcode
  98  * @endcode
  99  * @todo
 100  */
 101 extern int tdm_helper_drm_fd;
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* _TDM_HELPER_H_ */