client/tdm_client.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_CLIENT_H_
  37 #define _TDM_CLIENT_H_
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /**
  44  * @file tdm_client.h
  45  * @brief The header file for a client user of TDM.
  46  * @par Example
  47  * @code
  48    #include <tdm_client.h>    //for a client user of TDM
  49  * @endcode
  50  */
  51
  52 typedef enum
  53 {
  54         TDM_CLIENT_ERROR_NONE                  = 0,  /**< none */
  55         TDM_CLIENT_ERROR_OPERATION_FAILED      = -1, /**< operaion failed */
  56         TDM_CLIENT_ERROR_INVALID_PARAMETER     = -2, /**< wrong input parameter */
  57         TDM_CLIENT_ERROR_PERMISSION_DENIED     = -3, /**< access denied */
  58         TDM_CLIENT_ERROR_OUT_OF_MEMORY         = -4, /**< no free memory */
  59 } tdm_client_error;
  60
  61 typedef void *tdm_client;
  62
  63 typedef void
  64 (*tdm_client_vblank_handler)(unsigned int sequence, unsigned int tv_sec,
  65                              unsigned int tv_usec, void *user_data);
  66
  67 tdm_client*
  68 tdm_client_create(tdm_client_error *error);
  69
  70 void
  71 tdm_client_destroy(tdm_client *client);
  72
  73 tdm_client_error
  74 tdm_client_get_fd(tdm_client *client, int *fd);
  75
  76 tdm_client_error
  77 tdm_client_handle_events(tdm_client *client);
  78
  79 tdm_client_error
  80 tdm_client_wait_vblank(tdm_client *client, char *name,
  81                        int sw_timer, int interval, int sync,
  82                        tdm_client_vblank_handler func, void *user_data);
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif /* _TDM_CLIENT_H_ */