src/tdm_macro.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_MACRO_H_
  37 #define _TDM_MACRO_H_
  38
  39 #include <stdio.h>
  40 #include <string.h>
  41 #include <stdlib.h>
  42 #include <sys/types.h>
  43
  44 #include <tbm_surface.h>
  45
  46 #include "tdm_private_types.h"
  47 #include "tdm_thread.h"
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 /* not-categorized **********************************************************/
  54 #define TDM_NOT_DEFINED_VALUE       (-1)
  55 #define TDM_FRONT_VALUE(n)          (((n) > 0) ? (n) : TDM_NOT_DEFINED_VALUE)
  56
  57 #define TDM_MAX(x, y) (((x) > (y)) ? (x) : (y))
  58 #define TDM_MIN(x, y) (((x) < (y)) ? (x) : (y))
  59
  60 #define TDM_TIME(sec, usec)   ((double)(sec) + ((double)(usec)) / 1000000.0)
  61 #define TDM_TIME_SEC(time)    ((unsigned int)(time))
  62 #define TDM_TIME_USEC(time)   (unsigned int)(((time) - (unsigned int)(time)) * 1000000.0)
  63
  64 #define C(b, m)             (((b) >> (m)) & 0xFF)
  65 #define B(c, s)             ((((unsigned int)(c)) & 0xff) << (s))
  66 #define FOURCC(a, b, c, d)  (B(d, 24) | B(c, 16) | B(b, 8) | B(a, 0))
  67 #define FOURCC_STR(id)      C(id, 0), C(id, 8), C(id, 16), C(id, 24)
  68 #define FOURCC_ID(str)      FOURCC(((char*)str)[0], ((char*)str)[1], ((char*)str)[2], ((char*)str)[3])
  69 #define IS_RGB(f)           ((f) == TBM_FORMAT_XRGB8888 || (f) == TBM_FORMAT_ARGB8888)
  70
  71 /* don't using !,$,# */
  72 #define TDM_DELIM           "@^&*+-|,:~"
  73 #define TDM_ALIGN(a, b)     (((a) + ((b) - 1)) & ~((b) - 1))
  74 #define TDM_SWAP(a, b)      ({ int t; t = a; a = b; b = t; })
  75 #define TDM_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
  76
  77 #define TDM_SNPRINTF(p, len, fmt, ARG...)  \
  78         do { \
  79                 if (p && len && *len > 0) { \
  80                         int s = snprintf(p, *len, fmt, ##ARG); \
  81                         p += s; \
  82                         *len -= s; \
  83                 } \
  84         } while (0)
  85
  86 /* common backend names *****************************************************/
  87 #define TDM_DEFAULT_MODULE        "libtdm-default.so"
  88 #define TDM_DUMMY_MODULE          "libtdm-dummy.so"
  89
  90 /* dump directory ***********************************************************/
  91 #define TDM_DUMP_DIR    "/tmp"
  92
  93 /* message length ***********************************************************/
  94 #define TDM_SERVER_REPLY_MSG_LEN        8192
  95 #define TDM_DEBUG_REPLY_MSG_LEN         2048
  96
  97 /* DPMS *********************************************************************/
  98 /* can't export VSYNC macro because we can't define the exact meaning of vsync off
  99  * at this time. Does committing in standy mode work? Doesn't committing in suspend mode work?
 100  */
 101 #define TDM_OUTPUT_DPMS_DEFAULT_MASK         0xF
 102 #define TDM_OUTPUT_DPMS_VSYNC_OFF_MASK       0x2
 103 #define TDM_OUTPUT_DPMS_VSYNC_IS_OFF(dpms)   ((dpms) & TDM_OUTPUT_DPMS_VSYNC_OFF_MASK)
 104
 105 /* strtostr *****************************************************************/
 106 /* LCOV_EXCL_START */
 107 static inline char*
 108 strtostr(char *buf, int len, char *str, char *delim)
 109 {
 110         char *end;
 111         end = strpbrk(str, delim);
 112         if (end)
 113                 len = ((end - str + 1) < len) ? (end - str + 1) : len;
 114         else {
 115                 int l = strlen(str);
 116                 len = ((l + 1) < len) ? (l + 1) : len;
 117         }
 118         snprintf(buf, len, "%s", str);
 119         return str + len - 1;
 120 }
 121 /* LCOV_EXCL_STOP */
 122
 123 /* EXTERN, INTERN, DEPRECATED ***********************************************/
 124 #undef EXTERN
 125 #undef DEPRECATED
 126 #undef INTERN
 127
 128 #if defined(__GNUC__) && __GNUC__ >= 4
 129 #define EXTERN __attribute__ ((visibility("default")))
 130 #else
 131 #define EXTERN
 132 #endif
 133
 134 #if defined(__GNUC__) && __GNUC__ >= 4
 135 #define INTERN __attribute__ ((visibility("hidden")))
 136 #else
 137 #define INTERN
 138 #endif
 139
 140 #if defined(__GNUC__) && __GNUC__ >= 4
 141 #define DEPRECATED __attribute__ ((deprecated))
 142 #else
 143 #define DEPRECATED
 144 #endif
 145
 146 /* type to string ***********************************************************/
 147 struct tdm_type_name {
 148         int type;
 149         const char *name;
 150 };
 151
 152 #define TDM_TYPE_NAME_FN(res) \
 153 static inline const char * tdm_##res##_str(int type)    \
 154 {                       \
 155         unsigned int i;                                 \
 156         for (i = 0; i < TDM_ARRAY_SIZE(tdm_##res##_names); i++) { \
 157                 if (tdm_##res##_names[i].type == type)  \
 158                         return tdm_##res##_names[i].name;       \
 159         }                                               \
 160         return "(invalid)";                             \
 161 }
 162
 163 static struct tdm_type_name tdm_error_names[] = {
 164         { TDM_ERROR_NONE, "Success" },
 165         { TDM_ERROR_BAD_REQUEST, "bad request" },
 166         { TDM_ERROR_OPERATION_FAILED, "operaion failed" },
 167         { TDM_ERROR_INVALID_PARAMETER, "wrong input parameter" },
 168         { TDM_ERROR_PERMISSION_DENIED, "access denied" },
 169         { TDM_ERROR_BUSY, "hardware resource busy" },
 170         { TDM_ERROR_OUT_OF_MEMORY, "no free memory" },
 171         { TDM_ERROR_BAD_MODULE, "bad backend module" },
 172         { TDM_ERROR_NOT_IMPLEMENTED, "not implemented" },
 173         { TDM_ERROR_NO_CAPABILITY, "no capability" },
 174         { TDM_ERROR_DPMS_OFF, "dpms off" },
 175         { TDM_ERROR_OUTPUT_DISCONNECTED, "output disconnected" },
 176         { TDM_ERROR_PROTOCOL_ERROR, "protocol error" },
 177 };
 178 TDM_TYPE_NAME_FN(error)
 179
 180 static struct tdm_type_name tdm_dpms_names[] = {
 181         { TDM_OUTPUT_DPMS_ON, "on" },
 182         { TDM_OUTPUT_DPMS_STANDBY, "standby" },
 183         { TDM_OUTPUT_DPMS_SUSPEND, "suspend" },
 184         { TDM_OUTPUT_DPMS_OFF, "off" },
 185         { TDM_OUTPUT_DPMS_AOD, "aod" },
 186 };
 187 TDM_TYPE_NAME_FN(dpms)
 188
 189 static struct tdm_type_name tdm_status_names[] = {
 190         { TDM_OUTPUT_CONN_STATUS_DISCONNECTED, "disconnected" },
 191         { TDM_OUTPUT_CONN_STATUS_CONNECTED, "connected" },
 192         { TDM_OUTPUT_CONN_STATUS_MODE_SETTED, "mode_setted" },
 193 };
 194 TDM_TYPE_NAME_FN(status)
 195
 196 static struct tdm_type_name tdm_conn_names[] = {
 197         { TDM_OUTPUT_TYPE_Unknown, "Unknown" },
 198         { TDM_OUTPUT_TYPE_VGA, "VGA" },
 199         { TDM_OUTPUT_TYPE_DVII, "DVII" },
 200         { TDM_OUTPUT_TYPE_DVID, "DVID" },
 201         { TDM_OUTPUT_TYPE_DVIA, "DVIA" },
 202         { TDM_OUTPUT_TYPE_Composite, "Composite" },
 203         { TDM_OUTPUT_TYPE_SVIDEO, "SVIDEO" },
 204         { TDM_OUTPUT_TYPE_LVDS, "LVDS" },
 205         { TDM_OUTPUT_TYPE_Component, "Component" },
 206         { TDM_OUTPUT_TYPE_9PinDIN, "9PinDIN" },
 207         { TDM_OUTPUT_TYPE_DisplayPort, "DisplayPort" },
 208         { TDM_OUTPUT_TYPE_HDMIA, "HDMIA" },
 209         { TDM_OUTPUT_TYPE_HDMIB, "HDMIB" },
 210         { TDM_OUTPUT_TYPE_TV, "TV" },
 211         { TDM_OUTPUT_TYPE_eDP, "eDP" },
 212         { TDM_OUTPUT_TYPE_VIRTUAL, "VIRTUAL" },
 213         { TDM_OUTPUT_TYPE_DSI, "DSI" },
 214 };
 215 TDM_TYPE_NAME_FN(conn)
 216
 217 static struct tdm_type_name tdm_capture_type_names[] = {
 218         { TDM_CAPTURE_TYPE_ONESHOT, "none" },
 219         { TDM_CAPTURE_TYPE_STREAM, "90" },
 220 };
 221 TDM_TYPE_NAME_FN(capture_type)
 222
 223 static struct tdm_type_name tdm_transform_names[] = {
 224         { TDM_TRANSFORM_NORMAL, "none" },
 225         { TDM_TRANSFORM_90, "90" },
 226         { TDM_TRANSFORM_180, "180" },
 227         { TDM_TRANSFORM_270, "270" },
 228         { TDM_TRANSFORM_FLIPPED, "flipped" },
 229         { TDM_TRANSFORM_FLIPPED_90, "90,flipped" },
 230         { TDM_TRANSFORM_FLIPPED_180, "180,flipped" },
 231         { TDM_TRANSFORM_FLIPPED_270, "270,flipped" },
 232 };
 233 TDM_TYPE_NAME_FN(transform)
 234
 235 static struct tdm_type_name tdm_value_type_names[] = {
 236         { TDM_VALUE_TYPE_UNKNOWN, "unknown" },
 237         { TDM_VALUE_TYPE_PTR, "ptr" },
 238         { TDM_VALUE_TYPE_INT32, "int32" },
 239         { TDM_VALUE_TYPE_UINT32, "uint32" },
 240         { TDM_VALUE_TYPE_INT64, "int64" },
 241         { TDM_VALUE_TYPE_UINT64, "uint64" },
 242 };
 243 TDM_TYPE_NAME_FN(value_type)
 244
 245 static struct tdm_type_name tdm_cb_type_names[] = {
 246         { TDM_THREAD_CB_NONE, "none" },
 247         { TDM_THREAD_CB_EXIT, "exit" },
 248         { TDM_THREAD_CB_OUTPUT_COMMIT, "output-commit" },
 249         { TDM_THREAD_CB_OUTPUT_VBLANK, "output-vblank" },
 250         { TDM_THREAD_CB_OUTPUT_STATUS, "output-status" },
 251         { TDM_THREAD_CB_OUTPUT_DPMS, "output-dpms" },
 252         { TDM_THREAD_CB_PP_DONE, "pp-done" },
 253         { TDM_THREAD_CB_CAPTURE_DONE, "capture-done" },
 254         { TDM_THREAD_CB_VBLANK_SW, "vblank-sw" },
 255         { TDM_THREAD_CB_VBLANK_CREATE, "vblank-create" },
 256         { TDM_THREAD_CB_HWC_COMMIT, "hwc-commit" },
 257 };
 258 TDM_TYPE_NAME_FN(cb_type)
 259
 260 #define TDM_BIT_NAME_FB(res)                                    \
 261 static inline const char * tdm_##res##_str(int type, char **reply, int *len)    \
 262 {                       \
 263         unsigned int i;                                         \
 264         const char *sep = "";                                   \
 265         if (type == 0) {        \
 266                 TDM_SNPRINTF(*reply, len, "none");      \
 267                 return NULL;    \
 268         }       \
 269         for (i = 0; i < TDM_ARRAY_SIZE(tdm_##res##_names); i++) {               \
 270                 if (type & (1 << i)) {                          \
 271                         TDM_SNPRINTF(*reply, len, "%s%s", sep, tdm_##res##_names[i]);   \
 272                         sep = ",";                              \
 273                 }                                               \
 274         }                                                       \
 275         return NULL;                                            \
 276 }
 277
 278 static const char *tdm_mode_type_names[] = {
 279         "builtin",
 280         "clock_c",
 281         "crtc_c",
 282         "preferred",
 283         "default",
 284         "userdef",
 285         "driver",
 286 };
 287 TDM_BIT_NAME_FB(mode_type)
 288
 289 static const char *tdm_mode_flag_names[] = {
 290         "phsync",
 291         "nhsync",
 292         "pvsync",
 293         "nvsync",
 294         "interlace",
 295         "dblscan",
 296         "csync",
 297         "pcsync",
 298         "ncsync",
 299         "hskew",
 300         "bcast",
 301         "pixmux",
 302         "dblclk",
 303         "clkdiv2"
 304 };
 305 TDM_BIT_NAME_FB(mode_flag)
 306
 307 static const char *tdm_layer_caps_names[] = {
 308         "cursor",
 309         "primary",
 310         "overlay",
 311         "",
 312         "graphic",
 313         "video",
 314         "",
 315         "",
 316         "scale",
 317         "transform",
 318         "scanout",
 319         "reserved",
 320         "no_crop",
 321 };
 322 TDM_BIT_NAME_FB(layer_caps)
 323
 324 static const char *tdm_pp_caps_names[] = {
 325         "sync",
 326         "async",
 327         "scale",
 328         "transform",
 329 };
 330 TDM_BIT_NAME_FB(pp_caps)
 331
 332 static const char *tdm_capture_caps_names[] = {
 333         "output",
 334         "layer",
 335         "scale",
 336         "transform",
 337 };
 338 TDM_BIT_NAME_FB(capture_caps)
 339
 340 /* check condition **********************************************************/
 341 #define TDM_RETURN_IF_FAIL(cond) { \
 342         if (!(cond))  { \
 343                 TDM_ERR("'%s' failed", #cond); \
 344                 return; \
 345         } \
 346 }
 347 #define TDM_RETURN_VAL_IF_FAIL(cond, val) { \
 348         if (!(cond)) { \
 349                 TDM_ERR("'%s' failed", #cond); \
 350                 return val; \
 351         } \
 352 }
 353 #define TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(cond, error_v, val) { \
 354         if (!(cond)) { \
 355                 TDM_ERR("'%s' failed", #cond); \
 356                 ret = error_v; \
 357                 if (error) *error = ret; \
 358                 return val; \
 359         } \
 360 }
 361 #define TDM_WARNING_IF_FAIL(cond)  { \
 362         if (!(cond)) \
 363                 TDM_WRN("'%s' failed", #cond); \
 364 }
 365 #define TDM_GOTO_IF_FAIL(cond, dst) { \
 366         if (!(cond)) { \
 367                 TDM_ERR("'%s' failed", #cond); \
 368                 goto dst; \
 369         } \
 370 }
 371 #define TDM_EXIT_IF_FAIL(cond) { \
 372         if (!(cond)) { \
 373                 TDM_ERR("'%s' failed", #cond); \
 374                 exit(0); \
 375         } \
 376 }
 377 #define TDM_DBG_RETURN_IF_FAIL(cond) { \
 378         if (!(cond))  { \
 379                 TDM_SNPRINTF(reply, len, "[%s %d] '%s' failed\n", __func__, __LINE__, #cond); \
 380                 return; \
 381         } \
 382 }
 383 #define TDM_DBG_RETURN_VAL_IF_FAIL(cond, val) { \
 384         if (!(cond))  { \
 385                 TDM_SNPRINTF(reply, len, "[%s %d] '%s' failed\n", __func__, __LINE__, #cond); \
 386                 return val; \
 387         } \
 388 }
 389 #define TDM_DBG_GOTO_IF_FAIL(cond, dst) { \
 390         if (!(cond))  { \
 391                 TDM_SNPRINTF(reply, len, "[%s %d] '%s' failed\n", __func__, __LINE__, #cond); \
 392                 goto dst; \
 393         } \
 394 }
 395
 396 /* trace ********************************************************************/
 397 #ifdef HAVE_TTRACE
 398 #include <ttrace.h>
 399 #define TDM_TRACE_BEGIN(fmt, ...) traceBegin(TTRACE_TAG_GRAPHICS, fmt, ##__VA_ARGS__)
 400 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
 401 #define TDM_TRACE_ASYNC_BEGIN(key, name,...) traceAsyncBegin(TTRACE_TAG_GRAPHICS, key, name, ##__VA_ARGS__)
 402 #define TDM_TRACE_ASYNC_END(key, name,...) traceAsyncEnd(TTRACE_TAG_GRAPHICS, key, name, ##__VA_ARGS__)
 403 #define TDM_TRACE_COUNT(count, fmt, ...) traceCounter(TTRACE_TAG_GRAPHICS, count, fmt, ##__VA_ARGS__)
 404 #define TDM_TRACE_MARK(fmt, ...) traceMark(TTRACE_TAG_GRAPHICS, fmt, ##__VA_ARGS__)
 405 #else
 406 #define TDM_TRACE_BEGIN(fmt, ...)
 407 #define TDM_TRACE_END()
 408 #define TDM_TRACE_ASYNC_BEGIN(key, name,...)
 409 #define TDM_TRACE_ASYNC_END(key, name,...)
 410 #define TDM_TRACE_COUNT(count, fmt, ...)
 411 #define TDM_TRACE_MARK(fmt, ...)
 412 #endif
 413
 414 /* display mutex ************************************************************/
 415 extern pthread_mutex_t tdm_mutex_check_lock;
 416 extern int tdm_mutex_locked;
 417 extern const char *tdm_mutex_lock_func;
 418 extern int tdm_mutex_lock_line;
 419 extern const char *tdm_mutex_unlock_func;
 420 extern int tdm_mutex_unlock_line;
 421 extern int tdm_debug_module;
 422
 423 #define _pthread_mutex_lock(l) \
 424         do { \
 425                 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
 426                         TDM_INFO("mutex lock"); \
 427                 pthread_mutex_lock(l); \
 428                 pthread_mutex_lock(&tdm_mutex_check_lock); \
 429                 tdm_mutex_locked = 1; \
 430                 tdm_mutex_lock_func = __FUNCTION__; \
 431                 tdm_mutex_lock_line = __LINE__; \
 432                 tdm_mutex_unlock_func = NULL; \
 433                 tdm_mutex_unlock_line = 0; \
 434                 pthread_mutex_unlock(&tdm_mutex_check_lock); \
 435         } while (0)
 436
 437 #define _pthread_mutex_unlock(l) \
 438         do { \
 439                 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
 440                         TDM_INFO("mutex unlock"); \
 441                 pthread_mutex_lock(&tdm_mutex_check_lock); \
 442                 tdm_mutex_locked = 0; \
 443                 tdm_mutex_lock_func = NULL; \
 444                 tdm_mutex_lock_line = 0; \
 445                 tdm_mutex_unlock_func = __FUNCTION__; \
 446                 tdm_mutex_unlock_line = __LINE__; \
 447                 pthread_mutex_unlock(&tdm_mutex_check_lock); \
 448                 pthread_mutex_unlock(l); \
 449         } while (0)
 450
 451 static inline int TDM_MUTEX_IS_LOCKED(void)
 452 {
 453         int ret;
 454         /* if thread is not running, we don't need to consider mutex things. */
 455         if (!tdm_thread_is_running())
 456                 return 1;
 457         pthread_mutex_lock(&tdm_mutex_check_lock);
 458         ret = (tdm_mutex_locked == 1);
 459         pthread_mutex_unlock(&tdm_mutex_check_lock);
 460         return ret;
 461 }
 462
 463 #define tdm_display_lock(dpy)   _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
 464 #define tdm_display_unlock(dpy)   _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
 465
 466
 467 /* debugging mutex ************************************************************/
 468 extern pthread_mutex_t tdm_debug_mutex_check_lock;
 469 extern const char *tdm_debug_mutex_lock_func;
 470 extern int tdm_debug_mutex_lock_line;
 471
 472 #define _debug_pthread_mutex_lock(l) \
 473         do { \
 474                 pthread_mutex_lock(l); \
 475                 pthread_mutex_lock(&tdm_debug_mutex_check_lock); \
 476                 tdm_debug_mutex_lock_func = __FUNCTION__; \
 477                 tdm_debug_mutex_lock_line = __LINE__; \
 478                 pthread_mutex_unlock(&tdm_debug_mutex_check_lock); \
 479         } while (0)
 480
 481 #define _debug_pthread_mutex_unlock(l) \
 482         do { \
 483                 pthread_mutex_lock(&tdm_debug_mutex_check_lock); \
 484                 tdm_debug_mutex_lock_func = NULL; \
 485                 tdm_debug_mutex_lock_line = 0; \
 486                 pthread_mutex_unlock(&tdm_debug_mutex_check_lock); \
 487                 pthread_mutex_unlock(l); \
 488         } while (0)
 489
 490 #ifdef __cplusplus
 491 }
 492 #endif
 493
 494 #endif /* _TDM_MACRO_H_ */