client/tdm_client_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_CLIENT_TYPES_H_
  37 #define _TDM_CLIENT_TYPES_H_
  38
  39 #include "tdm_common.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  * @file tdm_client_types.h
  47  * @brief The header file which defines Enumerations and Structures for client.
  48  */
  49
  50 /**
  51  * @deprecated
  52  */
  53 typedef tdm_error tdm_client_error;
  54
  55 /**
  56  * @brief The client error enumeration
  57  * @deprecated
  58  */
  59 enum {
  60         TDM_CLIENT_ERROR_NONE                  = 0,  /**< none */
  61         TDM_CLIENT_ERROR_OPERATION_FAILED      = -1, /**< operaion failed */
  62         TDM_CLIENT_ERROR_INVALID_PARAMETER     = -2, /**< wrong input parameter */
  63         TDM_CLIENT_ERROR_PERMISSION_DENIED     = -3, /**< access denied */
  64         TDM_CLIENT_ERROR_OUT_OF_MEMORY         = -4, /**< no free memory */
  65         TDM_CLIENT_ERROR_DPMS_OFF              = -5, /**< dpms off */
  66 };
  67
  68 /**
  69  * @deprecated
  70  */
  71 typedef void
  72 (*tdm_client_vblank_handler2)(unsigned int sequence, unsigned int tv_sec,
  73                                                           unsigned int tv_usec, void *user_data);
  74
  75 /**
  76  * @brief The TDM client object
  77  */
  78 typedef void tdm_client;
  79
  80 /**
  81  * @brief The TDM client output object
  82  */
  83 typedef void tdm_client_output;
  84
  85 /**
  86  * @brief The TDM client vblank object
  87  */
  88 typedef void tdm_client_vblank;
  89
  90 /**
  91  * @brief The client output handler
  92  * @see #tdm_client_output_add_change_handler, #tdm_client_output_remove_change_handler
  93  */
  94 typedef void
  95 (*tdm_client_output_change_handler)(tdm_client_output *output,
  96                                                                         tdm_output_change_type type,
  97                                                                         tdm_value value,
  98                                                                         void *user_data);
  99
 100 /**
 101  * @brief The client vblank handler
 102  * @see #tdm_client_vblank_wait
 103  */
 104 typedef void
 105 (*tdm_client_vblank_handler)(tdm_client_vblank *vblank,
 106                                                          tdm_error error,
 107                                                          unsigned int sequence,
 108                                                          unsigned int tv_sec,
 109                                                          unsigned int tv_usec,
 110                                                          void *user_data);
 111
 112 #ifdef __cplusplus
 113 }
 114 #endif
 115
 116 #endif /* _TDM_CLIENT_TYPES_H_ */