include/tdm_common.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_COMMON_H_
  37 #define _TDM_COMMON_H_
  38
  39 #include <stdint.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #define TDM_NAME_LEN        64
  46
  47 /**
  48  * @file tdm_common.h
  49  * @brief The header file which defines Enumerations and Structures for TDM
  50  * frontend, backend and client.
  51  */
  52
  53 /**
  54  * @brief The error enumeration
  55  */
  56 typedef enum {
  57         TDM_ERROR_NONE                  = 0,  /**< none */
  58         TDM_ERROR_BAD_REQUEST           = -1, /**< bad request */
  59         TDM_ERROR_OPERATION_FAILED      = -2, /**< operaion failed */
  60         TDM_ERROR_INVALID_PARAMETER     = -3, /**< wrong input parameter */
  61         TDM_ERROR_PERMISSION_DENIED     = -4, /**< access denied */
  62         TDM_ERROR_BUSY                  = -5, /**< hardware resource busy */
  63         TDM_ERROR_OUT_OF_MEMORY         = -6, /**< no free memory */
  64         TDM_ERROR_BAD_MODULE            = -7, /**< bad backend module */
  65         TDM_ERROR_NOT_IMPLEMENTED       = -8, /**< not implemented */
  66         TDM_ERROR_NO_CAPABILITY         = -9, /**< no capability */
  67         TDM_ERROR_DPMS_OFF              = -10, /**< dpms off */
  68 } tdm_error;
  69
  70 /**
  71  * @brief The output change enumeration of #tdm_output_change_handler
  72  */
  73 typedef enum {
  74         TDM_OUTPUT_CHANGE_CONNECTION    = (1 << 0), /**< connection chagne */
  75         TDM_OUTPUT_CHANGE_DPMS          = (1 << 1), /**< dpms change */
  76 } tdm_output_change_type;
  77
  78 /**
  79  * @brief The output connection status enumeration
  80  */
  81 typedef enum {
  82         TDM_OUTPUT_CONN_STATUS_DISCONNECTED, /**< output disconnected */
  83         TDM_OUTPUT_CONN_STATUS_CONNECTED,    /**< output connected */
  84         TDM_OUTPUT_CONN_STATUS_MODE_SETTED,  /**< output connected and setted a mode */
  85 } tdm_output_conn_status;
  86
  87 /**
  88  * @brief The DPMS enumeration
  89  * @details bit compatible with the libdrm definitions.
  90  */
  91 typedef enum {
  92         TDM_OUTPUT_DPMS_ON,         /**< On */
  93         TDM_OUTPUT_DPMS_STANDBY,    /**< StandBy */
  94         TDM_OUTPUT_DPMS_SUSPEND,    /**< Suspend */
  95         TDM_OUTPUT_DPMS_OFF,        /**< Off */
  96 } tdm_output_dpms;
  97
  98 /**
  99  * @brief The size structure
 100  */
 101 typedef struct _tdm_size {
 102         unsigned int h;     /**< width */
 103         unsigned int v;     /**< height */
 104 } tdm_size;
 105
 106 /**
 107  * @brief The pos structure
 108  */
 109 typedef struct _tdm_pos {
 110         unsigned int x;
 111         unsigned int y;
 112         unsigned int w;
 113         unsigned int h;
 114 } tdm_pos;
 115
 116 /**
 117  * @brief The value union
 118  */
 119 typedef union {
 120         void     *ptr;
 121         int32_t  s32;
 122         uint32_t u32;
 123         int64_t  s64;
 124         uint64_t u64;
 125 } tdm_value;
 126
 127 #ifdef __cplusplus
 128 }
 129 #endif
 130
 131 #endif /* _TDM_COMMON_H_ */