-#define TDM_NAME_LEN 64
-
-typedef enum
-{
- TDM_ERROR_NONE = 0,
- TDM_ERROR_BAD_REQUEST = -1, //bad request
- TDM_ERROR_OPERATION_FAILED = -2, //operaion failed
- TDM_ERROR_INVALID_PARAMETER = -3, //wrong input parameter
- TDM_ERROR_PERMISSION_DENIED = -4, //access denied
- TDM_ERROR_BUSY = -5, //hardware resource busy
- TDM_ERROR_OUT_OF_MEMORY = -6, //no free memory
- TDM_ERROR_BAD_MODULE = -7, //bad backend module
- TDM_ERROR_NOT_IMPLEMENTED = -8, //not implemented
-} tdm_error;
-
-typedef enum
-{
- TDM_TRANSFORM_NORMAL = 0,
- TDM_TRANSFORM_90 = 1,
- TDM_TRANSFORM_180 = 2,
- TDM_TRANSFORM_270 = 3,
- TDM_TRANSFORM_FLIPPED = 4,
- TDM_TRANSFORM_FLIPPED_90 = 5,
- TDM_TRANSFORM_FLIPPED_180 = 6,
- TDM_TRANSFORM_FLIPPED_270 = 7,
- TDM_TRANSFORM_MAX = 8
-} tdm_transform;
-
-typedef enum
-{
- TDM_OUTPUT_CONN_STATUS_DISCONNECTED,
- TDM_OUTPUT_CONN_STATUS_CONNECTED,
- TDM_OUTPUT_CONN_STATUS_MODE_SETTED,
- TDM_OUTPUT_CONN_STATUS_MAX,
-} tdm_output_conn_status;
-
-/* bit compatible with the libdrm definitions. */
-typedef enum
-{
- TDM_OUTPUT_TYPE_Unknown,
- TDM_OUTPUT_TYPE_VGA,
- TDM_OUTPUT_TYPE_DVII,
- TDM_OUTPUT_TYPE_DVID,
- TDM_OUTPUT_TYPE_DVIA,
- TDM_OUTPUT_TYPE_Composite,
- TDM_OUTPUT_TYPE_SVIDEO,
- TDM_OUTPUT_TYPE_LVDS,
- TDM_OUTPUT_TYPE_Component,
- TDM_OUTPUT_TYPE_9PinDIN,
- TDM_OUTPUT_TYPE_DisplayPort,
- TDM_OUTPUT_TYPE_HDMIA,
- TDM_OUTPUT_TYPE_HDMIB,
- TDM_OUTPUT_TYPE_TV,
- TDM_OUTPUT_TYPE_eDP,
- TDM_OUTPUT_TYPE_VIRTUAL,
- TDM_OUTPUT_TYPE_DSI,
- TDM_OUTPUT_TYPE_MAX,
-} tdm_output_type;
-
-/* bit compatible with the drm definitions. */
-typedef enum
-{
- TDM_OUTPUT_DPMS_ON,
- TDM_OUTPUT_DPMS_STANDBY,
- TDM_OUTPUT_DPMS_SUSPEND,
- TDM_OUTPUT_DPMS_OFF,
- TDM_OUTPUT_DPMS_MAX,
-} tdm_output_dpms;
-
-typedef enum
-{
- TDM_LAYER_CAPABILITY_CURSOR = (1<<0),
- TDM_LAYER_CAPABILITY_PRIMARY = (1<<1),
- TDM_LAYER_CAPABILITY_OVERLAY = (1<<2),
- TDM_LAYER_CAPABILITY_SCALE = (1<<4),
- TDM_LAYER_CAPABILITY_TRANSFORM = (1<<5),
- TDM_LAYER_CAPABILITY_GRAPHIC = (1<<8),
- TDM_LAYER_CAPABILITY_VIDEO = (1<<9),
-} tdm_layer_capability;
-
-typedef enum
-{
- TDM_PP_CAPABILITY_SYNC = (1<<0),
- TDM_PP_CAPABILITY_ASYNC = (1<<1),
- TDM_PP_CAPABILITY_SCALE = (1<<4),
- TDM_PP_CAPABILITY_TRANSFORM = (1<<5),
-} tdm_pp_capability;
-
-typedef enum
-{
- TDM_CAPTURE_CAPABILITY_OUTPUT = (1<<0),
- TDM_CAPTURE_CAPABILITY_LAYER = (1<<1),
- TDM_CAPTURE_CAPABILITY_SCALE = (1<<4),
- TDM_CAPTURE_CAPABILITY_TRANSFORM = (1<<5),
-} tdm_capture_capability;
-
-/* bit compatible with the drm definitions. */
-typedef enum
-{
- TDM_OUTPUT_MODE_TYPE_BUILTIN = (1<<0),
- TDM_OUTPUT_MODE_TYPE_CLOCK_C = ((1<<1) | TDM_OUTPUT_MODE_TYPE_BUILTIN),
- TDM_OUTPUT_MODE_TYPE_CRTC_C = ((1<<2) | TDM_OUTPUT_MODE_TYPE_BUILTIN),
- TDM_OUTPUT_MODE_TYPE_PREFERRED = (1<<3),
- TDM_OUTPUT_MODE_TYPE_DEFAULT = (1<<4),
- TDM_OUTPUT_MODE_TYPE_USERDEF = (1<<5),
- TDM_OUTPUT_MODE_TYPE_DRIVER = (1<<6),
-} tdm_output_mode_type;
-
-/* bit compatible with the drm definitions. */
-typedef enum
-{
- TDM_OUTPUT_MODE_FLAG_PHSYNC = (1<<0),
- TDM_OUTPUT_MODE_FLAG_NHSYNC = (1<<1),
- TDM_OUTPUT_MODE_FLAG_PVSYNC = (1<<2),
- TDM_OUTPUT_MODE_FLAG_NVSYNC = (1<<3),
- TDM_OUTPUT_MODE_FLAG_INTERLACE = (1<<4),
- TDM_OUTPUT_MODE_FLAG_DBLSCAN = (1<<5),
- TDM_OUTPUT_MODE_FLAG_CSYNC = (1<<6),
- TDM_OUTPUT_MODE_FLAG_PCSYNC = (1<<7),
- TDM_OUTPUT_MODE_FLAG_NCSYNC = (1<<8),
- TDM_OUTPUT_MODE_FLAG_HSKEW = (1<<9), /* hskew provided */
- TDM_OUTPUT_MODE_FLAG_BCAST = (1<<10),
- TDM_OUTPUT_MODE_FLAG_PIXMUX = (1<<11),
- TDM_OUTPUT_MODE_FLAG_DBLCLK = (1<<12),
- TDM_OUTPUT_MODE_FLAG_CLKDIV2 = (1<<13),
-} tdm_output_mode_flag;
-
-typedef struct _tdm_output_mode
-{
- unsigned int width;
- unsigned int height;
- unsigned int refresh;
- unsigned int flags;
- unsigned int type;
- char name[TDM_NAME_LEN];
+/**
+ * @file tdm_types.h
+ * @brief The header file which defines Enumerations and Structures for frontend and backend.
+ * @details
+ * Both frontend(@ref tdm.h) and backend(@ref tdm_backend.h) header files
+ * include @ref tdm_types.h
+ * @par Example
+ * @code
+ * #include <tdm.h> //for a frontend user
+ * @endcode
+ * @code
+ * #include <tdm_backend.h> //for a vendor to implement a backend module
+ * @endcode
+ */
+
+typedef enum {
+ TDM_EVENT_LOOP_READABLE = (1 << 0),
+ TDM_EVENT_LOOP_WRITABLE = (1 << 1),
+ TDM_EVENT_LOOP_HANGUP = (1 << 2),
+ TDM_EVENT_LOOP_ERROR = (1 << 3),
+} tdm_event_loop_mask;
+
+/**
+ * @brief The display capability enumeration
+ */
+typedef enum {
+ TDM_DISPLAY_CAPABILITY_PP = (1 << 0), /**< if hardware supports pp operation */
+ TDM_DISPLAY_CAPABILITY_CAPTURE = (1 << 1), /**< if hardware supports capture operation */
+} tdm_display_capability;
+
+/**
+ * @brief The output mode structure
+ */
+typedef struct _tdm_output_mode {
+ unsigned int clock;
+ unsigned int hdisplay, hsync_start, hsync_end, htotal, hskew;
+ unsigned int vdisplay, vsync_start, vsync_end, vtotal, vscan;
+ unsigned int vrefresh;
+ unsigned int flags;
+ unsigned int type;
+ char name[TDM_NAME_LEN];