/*

 * \file xf86drmMode.h

 * Header for DRM modesetting interface.

 *

 * \author Jakob Bornecrantz <wallbraker@gmail.com>

 *

 * \par Acknowledgements:

 * Feb 2007, Dave Airlie <airlied@linux.ie>

 */

/*

 * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, Texas.

 * Copyright (c) 2007-2008 Dave Airlie <airlied@linux.ie>

 * Copyright (c) 2007-2008 Jakob Bornecrantz <wallbraker@gmail.com>

 *

 * Permission is hereby granted, free of charge, to any person obtaining a

 * copy of this software and associated documentation files (the "Software"),

 * to deal in the Software without restriction, including without limitation

 * the rights to use, copy, modify, merge, publish, distribute, sublicense,

 * and/or sell copies of the Software, and to permit persons to whom the

 * Software is furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

 * IN THE SOFTWARE.

 *

 */

#ifndef _XF86DRMMODE_H_

#define _XF86DRMMODE_H_

#if defined(__cplusplus)

extern "C" {

#endif

#include <drm.h>

#include <stddef.h>

#include <stdint.h>

/*

 * This is the interface for modesetting for drm.

 *

 * In order to use this interface you must include either <stdint.h> or another

 * header defining uint32_t, int32_t and uint16_t.

 *

 * It aims to provide a randr1.2 compatible interface for modesettings in the

 * kernel, the interface is also meant to be used by libraries like EGL.

 *

 * More information can be found in randrproto.txt which can be found here:

 * http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git

 *

 * There are some major differences to be noted. Unlike the randr1.2 proto you

 * need to create the memory object of the framebuffer yourself with the ttm

 * buffer object interface. This object needs to be pinned.

 */

/*

 * If we pickup an old version of drm.h which doesn't include drm_mode.h

 * we should redefine defines. This is so that builds doesn't breaks with

 * new libdrm on old kernels.

 */

#ifndef _DRM_MODE_H

#define DRM_DISPLAY_INFO_LEN    32

#define DRM_CONNECTOR_NAME_LEN  32

#define DRM_DISPLAY_MODE_LEN    32

#define DRM_PROP_NAME_LEN       32

#define DRM_MODE_TYPE_BUILTIN   (1<<0)

#define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN)

#define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN)

#define DRM_MODE_TYPE_PREFERRED (1<<3)

#define DRM_MODE_TYPE_DEFAULT   (1<<4)

#define DRM_MODE_TYPE_USERDEF   (1<<5)

#define DRM_MODE_TYPE_DRIVER    (1<<6)

/* Video mode flags */

/* bit compatible with the xorg definitions. */

#define DRM_MODE_FLAG_PHSYNC			(1<<0)

#define DRM_MODE_FLAG_NHSYNC			(1<<1)

#define DRM_MODE_FLAG_PVSYNC			(1<<2)

#define DRM_MODE_FLAG_NVSYNC			(1<<3)

#define DRM_MODE_FLAG_INTERLACE			(1<<4)

#define DRM_MODE_FLAG_DBLSCAN			(1<<5)

#define DRM_MODE_FLAG_CSYNC			(1<<6)

#define DRM_MODE_FLAG_PCSYNC			(1<<7)

#define DRM_MODE_FLAG_NCSYNC			(1<<8)

#define DRM_MODE_FLAG_HSKEW			(1<<9) /* hskew provided */

#define DRM_MODE_FLAG_BCAST			(1<<10)

#define DRM_MODE_FLAG_PIXMUX			(1<<11)

#define DRM_MODE_FLAG_DBLCLK			(1<<12)

#define DRM_MODE_FLAG_CLKDIV2			(1<<13)

#define DRM_MODE_FLAG_3D_MASK			(0x1f<<14)

#define  DRM_MODE_FLAG_3D_NONE			(0<<14)

#define  DRM_MODE_FLAG_3D_FRAME_PACKING		(1<<14)

#define  DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE	(2<<14)

#define  DRM_MODE_FLAG_3D_LINE_ALTERNATIVE	(3<<14)

#define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL	(4<<14)

#define  DRM_MODE_FLAG_3D_L_DEPTH		(5<<14)

#define  DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH	(6<<14)

#define  DRM_MODE_FLAG_3D_TOP_AND_BOTTOM	(7<<14)

#define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF	(8<<14)

/* DPMS flags */

/* bit compatible with the xorg definitions. */

#define DRM_MODE_DPMS_ON        0

#define DRM_MODE_DPMS_STANDBY   1

#define DRM_MODE_DPMS_SUSPEND   2

#define DRM_MODE_DPMS_OFF       3

/* Scaling mode options */

#define DRM_MODE_SCALE_NON_GPU          0

#define DRM_MODE_SCALE_FULLSCREEN       1

#define DRM_MODE_SCALE_NO_SCALE         2

#define DRM_MODE_SCALE_ASPECT           3

/* Dithering mode options */

#define DRM_MODE_DITHERING_OFF  0

#define DRM_MODE_DITHERING_ON   1

#define DRM_MODE_ENCODER_NONE    0

#define DRM_MODE_ENCODER_DAC     1

#define DRM_MODE_ENCODER_TMDS    2

#define DRM_MODE_ENCODER_LVDS    3

#define DRM_MODE_ENCODER_TVDAC   4

#define DRM_MODE_ENCODER_VIRTUAL 5

#define DRM_MODE_ENCODER_DSI     6

#define DRM_MODE_ENCODER_DPMST   7

#define DRM_MODE_ENCODER_DPI     8

#define DRM_MODE_SUBCONNECTOR_Automatic 0

#define DRM_MODE_SUBCONNECTOR_Unknown   0

#define DRM_MODE_SUBCONNECTOR_DVID      3

#define DRM_MODE_SUBCONNECTOR_DVIA      4

#define DRM_MODE_SUBCONNECTOR_Composite 5

#define DRM_MODE_SUBCONNECTOR_SVIDEO    6

#define DRM_MODE_SUBCONNECTOR_Component 8

#define DRM_MODE_SUBCONNECTOR_SCART     9

#define DRM_MODE_CONNECTOR_Unknown      0

#define DRM_MODE_CONNECTOR_VGA          1

#define DRM_MODE_CONNECTOR_DVII         2

#define DRM_MODE_CONNECTOR_DVID         3

#define DRM_MODE_CONNECTOR_DVIA         4

#define DRM_MODE_CONNECTOR_Composite    5

#define DRM_MODE_CONNECTOR_SVIDEO       6

#define DRM_MODE_CONNECTOR_LVDS         7

#define DRM_MODE_CONNECTOR_Component    8

#define DRM_MODE_CONNECTOR_9PinDIN      9

#define DRM_MODE_CONNECTOR_DisplayPort  10

#define DRM_MODE_CONNECTOR_HDMIA        11

#define DRM_MODE_CONNECTOR_HDMIB        12

#define DRM_MODE_CONNECTOR_TV           13

#define DRM_MODE_CONNECTOR_eDP          14

#define DRM_MODE_CONNECTOR_VIRTUAL      15

#define DRM_MODE_CONNECTOR_DSI          16

#define DRM_MODE_CONNECTOR_DPI          17

#define DRM_MODE_CONNECTOR_WRITEBACK    18

#define DRM_MODE_PROP_PENDING   (1<<0)

#define DRM_MODE_PROP_RANGE     (1<<1)

#define DRM_MODE_PROP_IMMUTABLE (1<<2)

#define DRM_MODE_PROP_ENUM      (1<<3) /* enumerated type with text strings */

#define DRM_MODE_PROP_BLOB      (1<<4)

#define DRM_MODE_CURSOR_BO      (1<<0)

#define DRM_MODE_CURSOR_MOVE    (1<<1)

#endif /* _DRM_MODE_H */

/*

 * Feature defines

 *

 * Just because these are defined doesn't mean that the kernel

 * can do that feature, its just for new code vs old libdrm.

 */

#define DRM_MODE_FEATURE_KMS		1

#define DRM_MODE_FEATURE_DIRTYFB	1

typedef struct _drmModeRes {

	int count_fbs;

	uint32_t *fbs;

	int count_crtcs;

	uint32_t *crtcs;

	int count_connectors;

	uint32_t *connectors;

	int count_encoders;

	uint32_t *encoders;

	uint32_t min_width, max_width;

	uint32_t min_height, max_height;

} drmModeRes, *drmModeResPtr;

typedef struct _drmModeModeInfo {

	uint32_t clock;

	uint16_t hdisplay, hsync_start, hsync_end, htotal, hskew;

	uint16_t vdisplay, vsync_start, vsync_end, vtotal, vscan;

	uint32_t vrefresh;

	uint32_t flags;

	uint32_t type;

	char name[DRM_DISPLAY_MODE_LEN];

} drmModeModeInfo, *drmModeModeInfoPtr;

typedef struct _drmModeFB {

	uint32_t fb_id;

	uint32_t width, height;

	uint32_t pitch;

	uint32_t bpp;

	uint32_t depth;

	/* driver specific handle */

	uint32_t handle;

} drmModeFB, *drmModeFBPtr;

typedef struct _drmModeFB2 {

	uint32_t fb_id;

	uint32_t width, height;

	uint32_t pixel_format; /* fourcc code from drm_fourcc.h */

	uint64_t modifier; /* applies to all buffers */

	uint32_t flags;

	/* per-plane GEM handle; may be duplicate entries for multiple planes */

	uint32_t handles[4];

	uint32_t pitches[4]; /* bytes */

	uint32_t offsets[4]; /* bytes */

} drmModeFB2, *drmModeFB2Ptr;

typedef struct drm_clip_rect drmModeClip, *drmModeClipPtr;

typedef struct _drmModePropertyBlob {

	uint32_t id;

	uint32_t length;

	void *data;

} drmModePropertyBlobRes, *drmModePropertyBlobPtr;

typedef struct _drmModeProperty {

	uint32_t prop_id;

	uint32_t flags;

	char name[DRM_PROP_NAME_LEN];

	int count_values;

	uint64_t *values; /* store the blob lengths */

	int count_enums;

	struct drm_mode_property_enum *enums;

	int count_blobs;

	uint32_t *blob_ids; /* store the blob IDs */

} drmModePropertyRes, *drmModePropertyPtr;

static __inline int drm_property_type_is(drmModePropertyPtr property,

		uint32_t type)

{

	/* instanceof for props.. handles extended type vs original types: */

	if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)

		return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;

	return property->flags & type;

}

typedef struct _drmModeCrtc {

	uint32_t crtc_id;

	uint32_t buffer_id; /**< FB id to connect to 0 = disconnect */

	uint32_t x, y; /**< Position on the framebuffer */

	uint32_t width, height;

	int mode_valid;

	drmModeModeInfo mode;

	int gamma_size; /**< Number of gamma stops */

} drmModeCrtc, *drmModeCrtcPtr;

typedef struct _drmModeEncoder {

	uint32_t encoder_id;

	uint32_t encoder_type;

	uint32_t crtc_id;

	uint32_t possible_crtcs;

	uint32_t possible_clones;

} drmModeEncoder, *drmModeEncoderPtr;

typedef enum {

	DRM_MODE_CONNECTED         = 1,

	DRM_MODE_DISCONNECTED      = 2,

	DRM_MODE_UNKNOWNCONNECTION = 3

} drmModeConnection;

typedef enum {

	DRM_MODE_SUBPIXEL_UNKNOWN        = 1,

	DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,

	DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,

	DRM_MODE_SUBPIXEL_VERTICAL_RGB   = 4,

	DRM_MODE_SUBPIXEL_VERTICAL_BGR   = 5,

	DRM_MODE_SUBPIXEL_NONE           = 6

} drmModeSubPixel;

typedef struct _drmModeConnector {

	uint32_t connector_id;

	uint32_t encoder_id; /**< Encoder currently connected to */

	uint32_t connector_type;

	uint32_t connector_type_id;

	drmModeConnection connection;

	uint32_t mmWidth, mmHeight; /**< HxW in millimeters */

	drmModeSubPixel subpixel;

	int count_modes;

	drmModeModeInfoPtr modes;

	int count_props;

	uint32_t *props; /**< List of property ids */

	uint64_t *prop_values; /**< List of property values */

	int count_encoders;

	uint32_t *encoders; /**< List of encoder ids */

} drmModeConnector, *drmModeConnectorPtr;

#define DRM_PLANE_TYPE_OVERLAY 0

#define DRM_PLANE_TYPE_PRIMARY 1

#define DRM_PLANE_TYPE_CURSOR  2

typedef struct _drmModeObjectProperties {

	uint32_t count_props;

	uint32_t *props;

	uint64_t *prop_values;

} drmModeObjectProperties, *drmModeObjectPropertiesPtr;

typedef struct _drmModePlane {

	uint32_t count_formats;

	uint32_t *formats;

	uint32_t plane_id;

	uint32_t crtc_id;

	uint32_t fb_id;

	uint32_t crtc_x, crtc_y;

	uint32_t x, y;

	uint32_t possible_crtcs;

	uint32_t gamma_size;

} drmModePlane, *drmModePlanePtr;

typedef struct _drmModePlaneRes {

	uint32_t count_planes;

	uint32_t *planes;

} drmModePlaneRes, *drmModePlaneResPtr;

extern void drmModeFreeModeInfo( drmModeModeInfoPtr ptr );

extern void drmModeFreeResources( drmModeResPtr ptr );

extern void drmModeFreeFB( drmModeFBPtr ptr );

extern void drmModeFreeFB2( drmModeFB2Ptr ptr );

extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );

extern void drmModeFreeConnector( drmModeConnectorPtr ptr );

extern void drmModeFreeEncoder( drmModeEncoderPtr ptr );

extern void drmModeFreePlane( drmModePlanePtr ptr );

extern void drmModeFreePlaneResources(drmModePlaneResPtr ptr);

/**

 * Retrieves all of the resources associated with a card.

 */

extern drmModeResPtr drmModeGetResources(int fd);

/*

 * FrameBuffer manipulation.

 */

/**

 * Retrieve information about framebuffer bufferId

 */

extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);

extern drmModeFB2Ptr drmModeGetFB2(int fd, uint32_t bufferId);

/**

 * Creates a new framebuffer with an buffer object as its scanout buffer.

 */

extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,

			uint8_t bpp, uint32_t pitch, uint32_t bo_handle,

			uint32_t *buf_id);

/* ...with a specific pixel format */

extern int drmModeAddFB2(int fd, uint32_t width, uint32_t height,

			 uint32_t pixel_format, const uint32_t bo_handles[4],

			 const uint32_t pitches[4], const uint32_t offsets[4],

			 uint32_t *buf_id, uint32_t flags);

/* ...with format modifiers */

int drmModeAddFB2WithModifiers(int fd, uint32_t width, uint32_t height,

			       uint32_t pixel_format, const uint32_t bo_handles[4],

			       const uint32_t pitches[4], const uint32_t offsets[4],

			       const uint64_t modifier[4], uint32_t *buf_id,

				   uint32_t flags);

/**

 * Destroies the given framebuffer.

 */

extern int drmModeRmFB(int fd, uint32_t bufferId);

/**

 * Mark a region of a framebuffer as dirty.

 */

extern int drmModeDirtyFB(int fd, uint32_t bufferId,

			  drmModeClipPtr clips, uint32_t num_clips);

/*

 * Crtc functions

 */

/**

 * Retrieve information about the ctrt crtcId

 */

extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);

/**

 * Set the mode on a crtc crtcId with the given mode modeId.

 */

int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,

                   uint32_t x, uint32_t y, uint32_t *connectors, int count,

		   drmModeModeInfoPtr mode);

/*

 * Cursor functions

 */

/**

 * Set the cursor on crtc

 */

int drmModeSetCursor(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height);

int drmModeSetCursor2(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height, int32_t hot_x, int32_t hot_y);

/**

 * Move the cursor on crtc

 */

int drmModeMoveCursor(int fd, uint32_t crtcId, int x, int y);

/**

 * Encoder functions

 */

drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id);

/*

 * Connector manipulation

 */

/**

 * Retrieve all information about the connector connectorId. This will do a

 * forced probe on the connector to retrieve remote information such as EDIDs

 * from the display device.

 */

extern drmModeConnectorPtr drmModeGetConnector(int fd,

					       uint32_t connectorId);

/**

 * Retrieve current information, i.e the currently active mode and encoder,

 * about the connector connectorId. This will not do any probing on the

 * connector or remote device, and only reports what is currently known.

 * For the complete set of modes and encoders associated with the connector

 * use drmModeGetConnector() which will do a probe to determine any display

 * link changes first.

 */

extern drmModeConnectorPtr drmModeGetConnectorCurrent(int fd,

						      uint32_t connector_id);

/**

 * Attaches the given mode to an connector.

 */

extern int drmModeAttachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);

/**

 * Detaches a mode from the connector

 * must be unused, by the given mode.

 */

extern int drmModeDetachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);

extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);

extern void drmModeFreeProperty(drmModePropertyPtr ptr);

extern drmModePropertyBlobPtr drmModeGetPropertyBlob(int fd, uint32_t blob_id);

extern void drmModeFreePropertyBlob(drmModePropertyBlobPtr ptr);

extern int drmModeConnectorSetProperty(int fd, uint32_t connector_id, uint32_t property_id,

				    uint64_t value);

extern int drmCheckModesettingSupported(const char *busid);

extern int drmModeCrtcSetGamma(int fd, uint32_t crtc_id, uint32_t size,

			       uint16_t *red, uint16_t *green, uint16_t *blue);

extern int drmModeCrtcGetGamma(int fd, uint32_t crtc_id, uint32_t size,

			       uint16_t *red, uint16_t *green, uint16_t *blue);

extern int drmModePageFlip(int fd, uint32_t crtc_id, uint32_t fb_id,

			   uint32_t flags, void *user_data);

extern int drmModePageFlipTarget(int fd, uint32_t crtc_id, uint32_t fb_id,

				 uint32_t flags, void *user_data,

				 uint32_t target_vblank);

extern drmModePlaneResPtr drmModeGetPlaneResources(int fd);

extern drmModePlanePtr drmModeGetPlane(int fd, uint32_t plane_id);

extern int drmModeSetPlane(int fd, uint32_t plane_id, uint32_t crtc_id,

			   uint32_t fb_id, uint32_t flags,

			   int32_t crtc_x, int32_t crtc_y,

			   uint32_t crtc_w, uint32_t crtc_h,

			   uint32_t src_x, uint32_t src_y,

			   uint32_t src_w, uint32_t src_h);

extern drmModeObjectPropertiesPtr drmModeObjectGetProperties(int fd,

							uint32_t object_id,

							uint32_t object_type);

extern void drmModeFreeObjectProperties(drmModeObjectPropertiesPtr ptr);

extern int drmModeObjectSetProperty(int fd, uint32_t object_id,

				    uint32_t object_type, uint32_t property_id,

				    uint64_t value);

typedef struct _drmModeAtomicReq drmModeAtomicReq, *drmModeAtomicReqPtr;

extern drmModeAtomicReqPtr drmModeAtomicAlloc(void);

extern drmModeAtomicReqPtr drmModeAtomicDuplicate(drmModeAtomicReqPtr req);

extern int drmModeAtomicMerge(drmModeAtomicReqPtr base,

			      drmModeAtomicReqPtr augment);

extern void drmModeAtomicFree(drmModeAtomicReqPtr req);

extern int drmModeAtomicGetCursor(drmModeAtomicReqPtr req);

extern void drmModeAtomicSetCursor(drmModeAtomicReqPtr req, int cursor);

extern int drmModeAtomicAddProperty(drmModeAtomicReqPtr req,

				    uint32_t object_id,

				    uint32_t property_id,

				    uint64_t value);

extern int drmModeAtomicCommit(int fd,

			       drmModeAtomicReqPtr req,

			       uint32_t flags,

			       void *user_data);

extern int drmModeCreatePropertyBlob(int fd, const void *data, size_t size,

				     uint32_t *id);

extern int drmModeDestroyPropertyBlob(int fd, uint32_t id);

/*

 * DRM mode lease APIs. These create and manage new drm_masters with

 * access to a subset of the available DRM resources

 */

extern int drmModeCreateLease(int fd, const uint32_t *objects, int num_objects, int flags, uint32_t *lessee_id);

typedef struct drmModeLesseeList {

	uint32_t count;

	uint32_t lessees[0];

} drmModeLesseeListRes, *drmModeLesseeListPtr;

extern drmModeLesseeListPtr drmModeListLessees(int fd);

typedef struct drmModeObjectList {

	uint32_t count;

	uint32_t objects[0];

} drmModeObjectListRes, *drmModeObjectListPtr;

extern drmModeObjectListPtr drmModeGetLease(int fd);

extern int drmModeRevokeLease(int fd, uint32_t lessee_id);

#if defined(__cplusplus)

}

#endif

#endif