/* * Copyright (c) 2007 Dave Airlie <[email protected]> * Copyright (c) 2007 Jakob Bornecrantz <[email protected]> * Copyright (c) 2008 Red Hat Inc. * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA * Copyright (c) 2007-2008 Intel Corporation * * 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 _DRM_MODE_H #define _DRM_MODE_H #include "drm.h" #if defined(__cplusplus) extern "C" { #endif /** * DOC: overview * * DRM exposes many UAPI and structure definitions to have a consistent * and standardized interface with users. * Userspace can refer to these structure definitions and UAPI formats * to communicate to drivers. */ #define DRM_CONNECTOR_NAME_LEN … #define DRM_DISPLAY_MODE_LEN … #define DRM_PROP_NAME_LEN … #define DRM_MODE_TYPE_BUILTIN … #define DRM_MODE_TYPE_CLOCK_C … #define DRM_MODE_TYPE_CRTC_C … #define DRM_MODE_TYPE_PREFERRED … #define DRM_MODE_TYPE_DEFAULT … #define DRM_MODE_TYPE_USERDEF … #define DRM_MODE_TYPE_DRIVER … #define DRM_MODE_TYPE_ALL … /* Video mode flags */ /* bit compatible with the xrandr RR_ definitions (bits 0-13) * * ABI warning: Existing userspace really expects * the mode flags to match the xrandr definitions. Any * changes that don't match the xrandr definitions will * likely need a new client cap or some other mechanism * to avoid breaking existing userspace. This includes * allocating new flags in the previously unused bits! */ #define DRM_MODE_FLAG_PHSYNC … #define DRM_MODE_FLAG_NHSYNC … #define DRM_MODE_FLAG_PVSYNC … #define DRM_MODE_FLAG_NVSYNC … #define DRM_MODE_FLAG_INTERLACE … #define DRM_MODE_FLAG_DBLSCAN … #define DRM_MODE_FLAG_CSYNC … #define DRM_MODE_FLAG_PCSYNC … #define DRM_MODE_FLAG_NCSYNC … #define DRM_MODE_FLAG_HSKEW … #define DRM_MODE_FLAG_BCAST … #define DRM_MODE_FLAG_PIXMUX … #define DRM_MODE_FLAG_DBLCLK … #define DRM_MODE_FLAG_CLKDIV2 … /* * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX * (define not exposed to user space). */ #define DRM_MODE_FLAG_3D_MASK … #define DRM_MODE_FLAG_3D_NONE … #define DRM_MODE_FLAG_3D_FRAME_PACKING … #define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE … #define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE … #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL … #define DRM_MODE_FLAG_3D_L_DEPTH … #define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH … #define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM … #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF … /* Picture aspect ratio options */ #define DRM_MODE_PICTURE_ASPECT_NONE … #define DRM_MODE_PICTURE_ASPECT_4_3 … #define DRM_MODE_PICTURE_ASPECT_16_9 … #define DRM_MODE_PICTURE_ASPECT_64_27 … #define DRM_MODE_PICTURE_ASPECT_256_135 … /* Content type options */ #define DRM_MODE_CONTENT_TYPE_NO_DATA … #define DRM_MODE_CONTENT_TYPE_GRAPHICS … #define DRM_MODE_CONTENT_TYPE_PHOTO … #define DRM_MODE_CONTENT_TYPE_CINEMA … #define DRM_MODE_CONTENT_TYPE_GAME … /* Aspect ratio flag bitmask (4 bits 22:19) */ #define DRM_MODE_FLAG_PIC_AR_MASK … #define DRM_MODE_FLAG_PIC_AR_NONE … #define DRM_MODE_FLAG_PIC_AR_4_3 … #define DRM_MODE_FLAG_PIC_AR_16_9 … #define DRM_MODE_FLAG_PIC_AR_64_27 … #define DRM_MODE_FLAG_PIC_AR_256_135 … #define DRM_MODE_FLAG_ALL … /* DPMS flags */ /* bit compatible with the xorg definitions. */ #define DRM_MODE_DPMS_ON … #define DRM_MODE_DPMS_STANDBY … #define DRM_MODE_DPMS_SUSPEND … #define DRM_MODE_DPMS_OFF … /* Scaling mode options */ #define DRM_MODE_SCALE_NONE … #define DRM_MODE_SCALE_FULLSCREEN … #define DRM_MODE_SCALE_CENTER … #define DRM_MODE_SCALE_ASPECT … /* Dithering mode options */ #define DRM_MODE_DITHERING_OFF … #define DRM_MODE_DITHERING_ON … #define DRM_MODE_DITHERING_AUTO … /* Dirty info options */ #define DRM_MODE_DIRTY_OFF … #define DRM_MODE_DIRTY_ON … #define DRM_MODE_DIRTY_ANNOTATE … /* Link Status options */ #define DRM_MODE_LINK_STATUS_GOOD … #define DRM_MODE_LINK_STATUS_BAD … /* * DRM_MODE_ROTATE_<degrees> * * Signals that a drm plane is been rotated <degrees> degrees in counter * clockwise direction. * * This define is provided as a convenience, looking up the property id * using the name->prop id lookup is the preferred method. */ #define DRM_MODE_ROTATE_0 … #define DRM_MODE_ROTATE_90 … #define DRM_MODE_ROTATE_180 … #define DRM_MODE_ROTATE_270 … /* * DRM_MODE_ROTATE_MASK * * Bitmask used to look for drm plane rotations. */ #define DRM_MODE_ROTATE_MASK … /* * DRM_MODE_REFLECT_<axis> * * Signals that the contents of a drm plane is reflected along the <axis> axis, * in the same way as mirroring. * See kerneldoc chapter "Plane Composition Properties" for more details. * * This define is provided as a convenience, looking up the property id * using the name->prop id lookup is the preferred method. */ #define DRM_MODE_REFLECT_X … #define DRM_MODE_REFLECT_Y … /* * DRM_MODE_REFLECT_MASK * * Bitmask used to look for drm plane reflections. */ #define DRM_MODE_REFLECT_MASK … /* Content Protection Flags */ #define DRM_MODE_CONTENT_PROTECTION_UNDESIRED … #define DRM_MODE_CONTENT_PROTECTION_DESIRED … #define DRM_MODE_CONTENT_PROTECTION_ENABLED … /** * struct drm_mode_modeinfo - Display mode information. * @clock: pixel clock in kHz * @hdisplay: horizontal display size * @hsync_start: horizontal sync start * @hsync_end: horizontal sync end * @htotal: horizontal total size * @hskew: horizontal skew * @vdisplay: vertical display size * @vsync_start: vertical sync start * @vsync_end: vertical sync end * @vtotal: vertical total size * @vscan: vertical scan * @vrefresh: approximate vertical refresh rate in Hz * @flags: bitmask of misc. flags, see DRM_MODE_FLAG_* defines * @type: bitmask of type flags, see DRM_MODE_TYPE_* defines * @name: string describing the mode resolution * * This is the user-space API display mode information structure. For the * kernel version see struct drm_display_mode. */ struct drm_mode_modeinfo { … }; struct drm_mode_card_res { … }; struct drm_mode_crtc { … }; #define DRM_MODE_PRESENT_TOP_FIELD … #define DRM_MODE_PRESENT_BOTTOM_FIELD … /* Planes blend with or override other bits on the CRTC */ struct drm_mode_set_plane { … }; /** * struct drm_mode_get_plane - Get plane metadata. * * Userspace can perform a GETPLANE ioctl to retrieve information about a * plane. * * To retrieve the number of formats supported, set @count_format_types to zero * and call the ioctl. @count_format_types will be updated with the value. * * To retrieve these formats, allocate an array with the memory needed to store * @count_format_types formats. Point @format_type_ptr to this array and call * the ioctl again (with @count_format_types still set to the value returned in * the first ioctl call). */ struct drm_mode_get_plane { … }; struct drm_mode_get_plane_res { … }; #define DRM_MODE_ENCODER_NONE … #define DRM_MODE_ENCODER_DAC … #define DRM_MODE_ENCODER_TMDS … #define DRM_MODE_ENCODER_LVDS … #define DRM_MODE_ENCODER_TVDAC … #define DRM_MODE_ENCODER_VIRTUAL … #define DRM_MODE_ENCODER_DSI … #define DRM_MODE_ENCODER_DPMST … #define DRM_MODE_ENCODER_DPI … struct drm_mode_get_encoder { … }; /* This is for connectors with multiple signal types. */ /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */ enum drm_mode_subconnector { … }; #define DRM_MODE_CONNECTOR_Unknown … #define DRM_MODE_CONNECTOR_VGA … #define DRM_MODE_CONNECTOR_DVII … #define DRM_MODE_CONNECTOR_DVID … #define DRM_MODE_CONNECTOR_DVIA … #define DRM_MODE_CONNECTOR_Composite … #define DRM_MODE_CONNECTOR_SVIDEO … #define DRM_MODE_CONNECTOR_LVDS … #define DRM_MODE_CONNECTOR_Component … #define DRM_MODE_CONNECTOR_9PinDIN … #define DRM_MODE_CONNECTOR_DisplayPort … #define DRM_MODE_CONNECTOR_HDMIA … #define DRM_MODE_CONNECTOR_HDMIB … #define DRM_MODE_CONNECTOR_TV … #define DRM_MODE_CONNECTOR_eDP … #define DRM_MODE_CONNECTOR_VIRTUAL … #define DRM_MODE_CONNECTOR_DSI … #define DRM_MODE_CONNECTOR_DPI … #define DRM_MODE_CONNECTOR_WRITEBACK … #define DRM_MODE_CONNECTOR_SPI … #define DRM_MODE_CONNECTOR_USB … /** * struct drm_mode_get_connector - Get connector metadata. * * User-space can perform a GETCONNECTOR ioctl to retrieve information about a * connector. User-space is expected to retrieve encoders, modes and properties * by performing this ioctl at least twice: the first time to retrieve the * number of elements, the second time to retrieve the elements themselves. * * To retrieve the number of elements, set @count_props and @count_encoders to * zero, set @count_modes to 1, and set @modes_ptr to a temporary struct * drm_mode_modeinfo element. * * To retrieve the elements, allocate arrays for @encoders_ptr, @modes_ptr, * @props_ptr and @prop_values_ptr, then set @count_modes, @count_props and * @count_encoders to their capacity. * * Performing the ioctl only twice may be racy: the number of elements may have * changed with a hotplug event in-between the two ioctls. User-space is * expected to retry the last ioctl until the number of elements stabilizes. * The kernel won't fill any array which doesn't have the expected length. * * **Force-probing a connector** * * If the @count_modes field is set to zero and the DRM client is the current * DRM master, the kernel will perform a forced probe on the connector to * refresh the connector status, modes and EDID. A forced-probe can be slow, * might cause flickering and the ioctl will block. * * User-space needs to force-probe connectors to ensure their metadata is * up-to-date at startup and after receiving a hot-plug event. User-space * may perform a forced-probe when the user explicitly requests it. User-space * shouldn't perform a forced-probe in other situations. */ struct drm_mode_get_connector { … }; #define DRM_MODE_PROP_PENDING … #define DRM_MODE_PROP_RANGE … #define DRM_MODE_PROP_IMMUTABLE … #define DRM_MODE_PROP_ENUM … #define DRM_MODE_PROP_BLOB … #define DRM_MODE_PROP_BITMASK … /* non-extended types: legacy bitmask, one bit per type: */ #define DRM_MODE_PROP_LEGACY_TYPE … /* extended-types: rather than continue to consume a bit per type, * grab a chunk of the bits to use as integer type id. */ #define DRM_MODE_PROP_EXTENDED_TYPE … #define DRM_MODE_PROP_TYPE(n) … #define DRM_MODE_PROP_OBJECT … #define DRM_MODE_PROP_SIGNED_RANGE … /* the PROP_ATOMIC flag is used to hide properties from userspace that * is not aware of atomic properties. This is mostly to work around * older userspace (DDX drivers) that read/write each prop they find, * without being aware that this could be triggering a lengthy modeset. */ #define DRM_MODE_PROP_ATOMIC … /** * struct drm_mode_property_enum - Description for an enum/bitfield entry. * @value: numeric value for this enum entry. * @name: symbolic name for this enum entry. * * See struct drm_property_enum for details. */ struct drm_mode_property_enum { … }; /** * struct drm_mode_get_property - Get property metadata. * * User-space can perform a GETPROPERTY ioctl to retrieve information about a * property. The same property may be attached to multiple objects, see * "Modeset Base Object Abstraction". * * The meaning of the @values_ptr field changes depending on the property type. * See &drm_property.flags for more details. * * The @enum_blob_ptr and @count_enum_blobs fields are only meaningful when the * property has the type &DRM_MODE_PROP_ENUM or &DRM_MODE_PROP_BITMASK. For * backwards compatibility, the kernel will always set @count_enum_blobs to * zero when the property has the type &DRM_MODE_PROP_BLOB. User-space must * ignore these two fields if the property has a different type. * * User-space is expected to retrieve values and enums by performing this ioctl * at least twice: the first time to retrieve the number of elements, the * second time to retrieve the elements themselves. * * To retrieve the number of elements, set @count_values and @count_enum_blobs * to zero, then call the ioctl. @count_values will be updated with the number * of elements. If the property has the type &DRM_MODE_PROP_ENUM or * &DRM_MODE_PROP_BITMASK, @count_enum_blobs will be updated as well. * * To retrieve the elements themselves, allocate an array for @values_ptr and * set @count_values to its capacity. If the property has the type * &DRM_MODE_PROP_ENUM or &DRM_MODE_PROP_BITMASK, allocate an array for * @enum_blob_ptr and set @count_enum_blobs to its capacity. Calling the ioctl * again will fill the arrays. */ struct drm_mode_get_property { … }; struct drm_mode_connector_set_property { … }; #define DRM_MODE_OBJECT_CRTC … #define DRM_MODE_OBJECT_CONNECTOR … #define DRM_MODE_OBJECT_ENCODER … #define DRM_MODE_OBJECT_MODE … #define DRM_MODE_OBJECT_PROPERTY … #define DRM_MODE_OBJECT_FB … #define DRM_MODE_OBJECT_BLOB … #define DRM_MODE_OBJECT_PLANE … #define DRM_MODE_OBJECT_ANY … struct drm_mode_obj_get_properties { … }; struct drm_mode_obj_set_property { … }; struct drm_mode_get_blob { … }; struct drm_mode_fb_cmd { … }; #define DRM_MODE_FB_INTERLACED … #define DRM_MODE_FB_MODIFIERS … /** * struct drm_mode_fb_cmd2 - Frame-buffer metadata. * * This struct holds frame-buffer metadata. There are two ways to use it: * * - User-space can fill this struct and perform a &DRM_IOCTL_MODE_ADDFB2 * ioctl to register a new frame-buffer. The new frame-buffer object ID will * be set by the kernel in @fb_id. * - User-space can set @fb_id and perform a &DRM_IOCTL_MODE_GETFB2 ioctl to * fetch metadata about an existing frame-buffer. * * In case of planar formats, this struct allows up to 4 buffer objects with * offsets and pitches per plane. The pitch and offset order are dictated by * the format FourCC as defined by ``drm_fourcc.h``, e.g. NV12 is described as: * * YUV 4:2:0 image with a plane of 8-bit Y samples followed by an * interleaved U/V plane containing 8-bit 2x2 subsampled colour difference * samples. * * So it would consist of a Y plane at ``offsets[0]`` and a UV plane at * ``offsets[1]``. * * To accommodate tiled, compressed, etc formats, a modifier can be specified. * For more information see the "Format Modifiers" section. Note that even * though it looks like we have a modifier per-plane, we in fact do not. The * modifier for each plane must be identical. Thus all combinations of * different data layouts for multi-plane formats must be enumerated as * separate modifiers. * * All of the entries in @handles, @pitches, @offsets and @modifier must be * zero when unused. Warning, for @offsets and @modifier zero can't be used to * figure out whether the entry is used or not since it's a valid value (a zero * offset is common, and a zero modifier is &DRM_FORMAT_MOD_LINEAR). */ struct drm_mode_fb_cmd2 { … }; #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY … #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL … #define DRM_MODE_FB_DIRTY_FLAGS … #define DRM_MODE_FB_DIRTY_MAX_CLIPS … /* * Mark a region of a framebuffer as dirty. * * Some hardware does not automatically update display contents * as a hardware or software draw to a framebuffer. This ioctl * allows userspace to tell the kernel and the hardware what * regions of the framebuffer have changed. * * The kernel or hardware is free to update more then just the * region specified by the clip rects. The kernel or hardware * may also delay and/or coalesce several calls to dirty into a * single update. * * Userspace may annotate the updates, the annotates are a * promise made by the caller that the change is either a copy * of pixels or a fill of a single color in the region specified. * * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then * the number of updated regions are half of num_clips given, * where the clip rects are paired in src and dst. The width and * height of each one of the pairs must match. * * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller * promises that the region specified of the clip rects is filled * completely with a single color as given in the color argument. */ struct drm_mode_fb_dirty_cmd { … }; struct drm_mode_mode_cmd { … }; #define DRM_MODE_CURSOR_BO … #define DRM_MODE_CURSOR_MOVE … #define DRM_MODE_CURSOR_FLAGS … /* * depending on the value in flags different members are used. * * CURSOR_BO uses * crtc_id * width * height * handle - if 0 turns the cursor off * * CURSOR_MOVE uses * crtc_id * x * y */ struct drm_mode_cursor { … }; struct drm_mode_cursor2 { … }; struct drm_mode_crtc_lut { … }; struct drm_color_ctm { … }; struct drm_color_lut { … }; /** * struct drm_plane_size_hint - Plane size hints * @width: The width of the plane in pixel * @height: The height of the plane in pixel * * The plane SIZE_HINTS property blob contains an * array of struct drm_plane_size_hint. */ struct drm_plane_size_hint { … }; /** * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data. * * HDR Metadata Infoframe as per CTA 861.G spec. This is expected * to match exactly with the spec. * * Userspace is expected to pass the metadata information as per * the format described in this structure. */ struct hdr_metadata_infoframe { … }; /** * struct hdr_output_metadata - HDR output metadata * * Metadata Information to be passed from userspace */ struct hdr_output_metadata { … }; /** * DRM_MODE_PAGE_FLIP_EVENT * * Request that the kernel sends back a vblank event (see * struct drm_event_vblank) with the &DRM_EVENT_FLIP_COMPLETE type when the * page-flip is done. */ #define DRM_MODE_PAGE_FLIP_EVENT … /** * DRM_MODE_PAGE_FLIP_ASYNC * * Request that the page-flip is performed as soon as possible, ie. with no * delay due to waiting for vblank. This may cause tearing to be visible on * the screen. * * When used with atomic uAPI, the driver will return an error if the hardware * doesn't support performing an asynchronous page-flip for this update. * User-space should handle this, e.g. by falling back to a regular page-flip. * * Note, some hardware might need to perform one last synchronous page-flip * before being able to switch to asynchronous page-flips. As an exception, * the driver will return success even though that first page-flip is not * asynchronous. */ #define DRM_MODE_PAGE_FLIP_ASYNC … #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE … #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE … #define DRM_MODE_PAGE_FLIP_TARGET … /** * DRM_MODE_PAGE_FLIP_FLAGS * * Bitmask of flags suitable for &drm_mode_crtc_page_flip_target.flags. */ #define DRM_MODE_PAGE_FLIP_FLAGS … /* * Request a page flip on the specified crtc. * * This ioctl will ask KMS to schedule a page flip for the specified * crtc. Once any pending rendering targeting the specified fb (as of * ioctl time) has completed, the crtc will be reprogrammed to display * that fb after the next vertical refresh. The ioctl returns * immediately, but subsequent rendering to the current fb will block * in the execbuffer ioctl until the page flip happens. If a page * flip is already pending as the ioctl is called, EBUSY will be * returned. * * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank * event (see drm.h: struct drm_event_vblank) when the page flip is * done. The user_data field passed in with this ioctl will be * returned as the user_data field in the vblank event struct. * * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen * 'as soon as possible', meaning that it not delay waiting for vblank. * This may cause tearing on the screen. * * The reserved field must be zero. */ struct drm_mode_crtc_page_flip { … }; /* * Request a page flip on the specified crtc. * * Same as struct drm_mode_crtc_page_flip, but supports new flags and * re-purposes the reserved field: * * The sequence field must be zero unless either of the * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When * the ABSOLUTE flag is specified, the sequence field denotes the absolute * vblank sequence when the flip should take effect. When the RELATIVE * flag is specified, the sequence field denotes the relative (to the * current one when the ioctl is called) vblank sequence when the flip * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to * make sure the vblank sequence before the target one has passed before * calling this ioctl. The purpose of the * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify * the target for when code dealing with a page flip runs during a * vertical blank period. */ struct drm_mode_crtc_page_flip_target { … }; /** * struct drm_mode_create_dumb - Create a KMS dumb buffer for scanout. * @height: buffer height in pixels * @width: buffer width in pixels * @bpp: bits per pixel * @flags: must be zero * @handle: buffer object handle * @pitch: number of bytes between two consecutive lines * @size: size of the whole buffer in bytes * * User-space fills @height, @width, @bpp and @flags. If the IOCTL succeeds, * the kernel fills @handle, @pitch and @size. */ struct drm_mode_create_dumb { … }; /* set up for mmap of a dumb scanout buffer */ struct drm_mode_map_dumb { … }; struct drm_mode_destroy_dumb { … }; /** * DRM_MODE_ATOMIC_TEST_ONLY * * Do not apply the atomic commit, instead check whether the hardware supports * this configuration. * * See &drm_mode_config_funcs.atomic_check for more details on test-only * commits. */ #define DRM_MODE_ATOMIC_TEST_ONLY … /** * DRM_MODE_ATOMIC_NONBLOCK * * Do not block while applying the atomic commit. The &DRM_IOCTL_MODE_ATOMIC * IOCTL returns immediately instead of waiting for the changes to be applied * in hardware. Note, the driver will still check that the update can be * applied before retuning. */ #define DRM_MODE_ATOMIC_NONBLOCK … /** * DRM_MODE_ATOMIC_ALLOW_MODESET * * Allow the update to result in temporary or transient visible artifacts while * the update is being applied. Applying the update may also take significantly * more time than a page flip. All visual artifacts will disappear by the time * the update is completed, as signalled through the vblank event's timestamp * (see struct drm_event_vblank). * * This flag must be set when the KMS update might cause visible artifacts. * Without this flag such KMS update will return a EINVAL error. What kind of * update may cause visible artifacts depends on the driver and the hardware. * User-space that needs to know beforehand if an update might cause visible * artifacts can use &DRM_MODE_ATOMIC_TEST_ONLY without * &DRM_MODE_ATOMIC_ALLOW_MODESET to see if it fails. * * To the best of the driver's knowledge, visual artifacts are guaranteed to * not appear when this flag is not set. Some sinks might display visual * artifacts outside of the driver's control. */ #define DRM_MODE_ATOMIC_ALLOW_MODESET … /** * DRM_MODE_ATOMIC_FLAGS * * Bitfield of flags accepted by the &DRM_IOCTL_MODE_ATOMIC IOCTL in * &drm_mode_atomic.flags. */ #define DRM_MODE_ATOMIC_FLAGS … struct drm_mode_atomic { … }; struct drm_format_modifier_blob { … }; struct drm_format_modifier { … }; /** * struct drm_mode_create_blob - Create New blob property * * Create a new 'blob' data property, copying length bytes from data pointer, * and returning new blob ID. */ struct drm_mode_create_blob { … }; /** * struct drm_mode_destroy_blob - Destroy user blob * @blob_id: blob_id to destroy * * Destroy a user-created blob property. * * User-space can release blobs as soon as they do not need to refer to them by * their blob object ID. For instance, if you are using a MODE_ID blob in an * atomic commit and you will not make another commit re-using the same ID, you * can destroy the blob as soon as the commit has been issued, without waiting * for it to complete. */ struct drm_mode_destroy_blob { … }; /** * struct drm_mode_create_lease - Create lease * * Lease mode resources, creating another drm_master. * * The @object_ids array must reference at least one CRTC, one connector and * one plane if &DRM_CLIENT_CAP_UNIVERSAL_PLANES is enabled. Alternatively, * the lease can be completely empty. */ struct drm_mode_create_lease { … }; /** * struct drm_mode_list_lessees - List lessees * * List lesses from a drm_master. */ struct drm_mode_list_lessees { … }; /** * struct drm_mode_get_lease - Get Lease * * Get leased objects. */ struct drm_mode_get_lease { … }; /** * struct drm_mode_revoke_lease - Revoke lease */ struct drm_mode_revoke_lease { … }; /** * struct drm_mode_rect - Two dimensional rectangle. * @x1: Horizontal starting coordinate (inclusive). * @y1: Vertical starting coordinate (inclusive). * @x2: Horizontal ending coordinate (exclusive). * @y2: Vertical ending coordinate (exclusive). * * With drm subsystem using struct drm_rect to manage rectangular area this * export it to user-space. * * Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS. */ struct drm_mode_rect { … }; /** * struct drm_mode_closefb * @fb_id: Framebuffer ID. * @pad: Must be zero. */ struct drm_mode_closefb { … }; #if defined(__cplusplus) } #endif #endif
Codebase Browser
linux