1450N/A * Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. 1450N/A * Copyright (c) 2006-2008, 2013, Intel Corporation 1450N/A * Copyright (c) 2007 Dave Airlie <airlied@linux.ie> 1450N/A * Copyright (c) 2008 Red Hat Inc. 1450N/A * DRM core CRTC related functions 1450N/A * Permission to use, copy, modify, distribute, and sell this software and its 1450N/A * documentation for any purpose is hereby granted without fee, provided that 1450N/A * the above copyright notice appear in all copies and that both that copyright 1450N/A * notice and this permission notice appear in supporting documentation, and 1450N/A * that the name of the copyright holders not be used in advertising or 1450N/A * publicity pertaining to distribution of the software without specific, 1450N/A * written prior permission. The copyright holders make no representations 1450N/A * about the suitability of this software for any purpose. It is provided "as 1450N/A * is" without express or implied warranty. 1450N/A * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 1450N/A * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO 1450N/A * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR 1450N/A * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, 1450N/A * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 1450N/A * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 1450N/A * Eric Anholt <eric@anholt.net> 1450N/A * Dave Airlie <airlied@linux.ie> 1450N/A * Jesse Barnes <jesse.barnes@intel.com> 1450N/A * drm_modeset_lock_all - take all modeset locks 1450N/A * This function takes all modeset locks, suitable where a more fine-grained 1450N/A * scheme isn't (yet) implemented. 1450N/A * drm_modeset_unlock_all - drop all modeset locks 1450N/A/* Avoid boilerplate. I'm tired of typing. */ 1450N/A * Non-global properties, but "required" for certain connectors. 1450N/A * Connector and encoder types. 1450N/A "%c%c%c%c %s-endian (0x%08x)",
1450N/A * drm_mode_object_get - allocate a new modeset identifier 1450N/A * @obj: object pointer, used to generate unique ID 1450N/A * Create a unique identifier based on @ptr in @dev's identifier space. Used 1450N/A * for tracking modes, CRTCs and connectors. 1450N/A * New unique (relative to other objects in @dev) integer identifier for the 1450N/A * Set up the object linking under the protection of the idr 1450N/A * lock so that other users can't see inconsistent state. 1450N/A * drm_mode_object_put - free an identifer 1450N/A * Free @id from @dev's unique identifier pool. 1450N/A * drm_mode_object_find - look up a drm object with static lifetime 1450N/A * @id: id of the mode object 1450N/A * @type: type of the mode object 1450N/A * Note that framebuffers cannot be looked up with this functions - since those 1450N/A * are reference counted, they need special treatment. 1450N/A /* Framebuffers are reference counted and need their own lookup 1450N/A * drm_framebuffer_init - initialize a framebuffer 1450N/A * Allocates an ID for the framebuffer's parent mode object, sets its mode 1450N/A * functions & device file and adds it to the master fd list. 1450N/A * This functions publishes the fb and makes it available for concurrent access 1450N/A * by other users. Which means by this point the fb _must_ be fully set up - 1450N/A * since all the fb attributes are invariant over its lifetime, no further 1450N/A * locking but only correct reference counting is required. 1450N/A * Zero on success, error code on failure. 1450N/A /* Grab the idr reference. */ 1450N/A * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference 1450N/A * If successful, this grabs an additional reference to the framebuffer - 1450N/A * callers need to make sure to eventually unreference the returned framebuffer 1450N/A * drm_framebuffer_unreference - unref a framebuffer 1450N/A * drm_framebuffer_reference - incr the fb refcnt 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A/* dev->mode_config.fb_lock must be held! */ 1450N/A * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr 1450N/A * Drivers need to call this when cleaning up driver-private framebuffers, e.g. 1450N/A * those used for fbdev. Note that the caller must hold a reference of it's own, 1450N/A * i.e. the object may not be destroyed through this call (since it'll lead to a 1450N/A /* Mark fb as reaped and drop idr ref. */ 1450N/A * drm_framebuffer_cleanup - remove a framebuffer object 1450N/A * @fb: framebuffer to remove 1450N/A * Cleanup references to a user-created framebuffer. This function is intended 1450N/A * to be used from the drivers ->destroy callback. 1450N/A * Note that this function does not remove the fb from active usuage - if it is 1450N/A * still used anywhere, hilarity can ensue since userspace could call getfb on 1450N/A * the id and get back -EINVAL. Obviously no concern at driver unload time. 1450N/A * Also, the framebuffer will not be removed from the lookup idr - for 1450N/A * user-created framebuffers this will happen in in the rmfb ioctl. For 1450N/A * driver-private objects (e.g. for fbdev) drivers need to explicitly call 1450N/A * drm_framebuffer_unregister_private. 1450N/A * drm_framebuffer_remove - remove and unreference a framebuffer object 1450N/A * @fb: framebuffer to remove 1450N/A * using @fb, removes it, setting it to NULL. Then drops the reference to the 1450N/A * passed-in framebuffer. Might take the modeset locks. 1450N/A * Note that this function optimizes the cleanup away if the caller holds the 1450N/A * last reference to the framebuffer. It is also guaranteed to not take the 1450N/A * modeset locks in this case. 1450N/A * drm ABI mandates that we remove any deleted framebuffers from active 1450N/A * useage. But since most sane clients only remove framebuffers they no 1450N/A * longer need, try to optimize this away. 1450N/A * Since we're holding a reference ourselves, observing a refcount of 1 1450N/A * means that we're the last holder and can skip it. Also, the refcount 1450N/A * can never increase from 1 again, so we don't need any barriers or 1450N/A * Note that userspace could try to race with use and instate a new 1450N/A * usage _after_ we've cleared all current ones. End result will be an 1450N/A * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot 1450N/A /* should turn off the crtc */ 1450N/A * drm_crtc_init - Initialise a new CRTC object 1450N/A * @crtc: CRTC object to init 1450N/A * @funcs: callbacks for the new CRTC 1450N/A * Inits a new object created as base part of an driver crtc object. 1450N/A * drm_crtc_cleanup - Cleans up the core crtc usage. 1450N/A * Cleanup @crtc. Removes from drm modesetting space 1450N/A * does NOT free object, caller does that. 1450N/A * drm_mode_probed_add - add a mode to a connector's probed mode list 1450N/A * @connector: connector the new mode 1450N/A * Add @mode to @connector's mode list for later use. 1450N/A * drm_mode_remove - remove and free a mode 1450N/A * @connector: connector list to modify 1450N/A * Remove @mode from @connector's mode list, then free it. 1450N/A * drm_connector_init - Init a preallocated connector 1450N/A * @connector: the connector to init 1450N/A * @funcs: callbacks for this connector 1450N/A * @name: user visible name of the connector 1450N/A * Initialises a preallocated connector. Connectors should be 1450N/A * subclassed as part of driver connector objects. 1450N/A * Zero on success, error code on failure. 1450N/A * drm_connector_cleanup - cleans up an initialised connector 1450N/A * @connector: connector to cleanup 1450N/A * Cleans up the connector but doesn't free the object. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A struct drm_connector *connector; 1450N/A /* taking the mode config mutex ends up in a clash with sysfs */ 1450N/A list_for_each_entry(connector, struct drm_connector, &dev->mode_config.connector_list, head) 1450N/A drm_sysfs_connector_remove(connector); 1450N/A * drm_plane_init - Initialise a new plane object 1450N/A * @plane: plane object to init 1450N/A * @possible_crtcs: bitmask of possible CRTCs 1450N/A * @funcs: callbacks for the new plane 1450N/A * @formats: array of supported formats (%DRM_FORMAT_*) 1450N/A * @format_count: number of elements in @formats 1450N/A * @priv: plane is private (hidden from userspace)? 1450N/A * Inits a new object created as base part of a driver plane object. 1450N/A * Zero on success, error code on failure. 1450N/A /* private planes are not exposed to userspace, but depending on 1450N/A * display hardware, might be convenient to allow sharing programming 1450N/A * for the scanout engine with the crtc implementation. 1450N/A * drm_plane_cleanup - Clean up the core plane usage 1450N/A * This function cleans up @plane and removes it from the DRM mode setting 1450N/A * core. Note that the function does *not* free the plane structure itself, 1450N/A * this is the responsibility of the caller. 1450N/A /* if not added to a list, it must be a private plane */ 1450N/A * drm_plane_force_disable - Forcibly disable a plane 1450N/A * Forces the plane to be disabled. 1450N/A * Used when the plane's current framebuffer is destroyed, 1450N/A * and when restoring fbdev mode. 1450N/A /* disconnect the plane from the fb and crtc: */ 1450N/A * drm_mode_create - create a new display mode 1450N/A * Create a new drm_display_mode, give it an ID, and return it. 1450N/A * Pointer to new mode on success, NULL on error. 1450N/A * drm_mode_destroy - remove a mode 1450N/A * Free @mode's unique identifier, then free it. 1450N/A * Standard properties (apply to all connectors) 1450N/A * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties 1450N/A * Called by a driver the first time a DVI-I connector is made. 1450N/A * drm_create_tv_properties - create TV specific connector properties 1450N/A * @num_modes: number of different TV formats (modes) supported 1450N/A * @modes: array of pointers to strings containing name of each format 1450N/A * Called by a driver's TV initialization routine, this function creates 1450N/A * the TV specific connector properties for a given device. Caller is 1450N/A * responsible for allocating a list of format names and passing them to 1450N/A * Basic connector properties 1450N/A * Other, TV specific properties: margins & TV modes. 1450N/A * drm_mode_create_scaling_mode_property - create scaling mode property 1450N/A * Called by a driver the first time it's needed, must be attached to desired 1450N/A * drm_mode_create_dithering_property - create dithering property 1450N/A * Called by a driver the first time it's needed, must be attached to desired 1450N/A * drm_mode_create_dirty_property - create dirty property 1450N/A * Called by a driver the first time it's needed, must be attached to desired 1450N/A * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo 1450N/A * @out: drm_mode_modeinfo struct to return to the user 1450N/A * @in: drm_display_mode to use 1450N/A * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to 1450N/A * drm_crtc_convert_to_umode - convert a modeinfo into a drm_display_mode 1450N/A * @out: drm_display_mode to return to the user 1450N/A * @in: drm_mode_modeinfo to use 1450N/A * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to 1450N/A * drm_mode_getresources - get graphics configuration 1450N/A * @inode: inode from the ioctl 1450N/A * @filp: file * from the ioctl 1450N/A * Construct a set of configuration description structures and return 1450N/A * them to the user, including CRTC, connector and framebuffer configuration. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A * For the non-control nodes we need to limit the list of resources 1450N/A * by IDs in the group list for this node 1450N/A /* handle this in 4 parts */ 1450N/A * drm_mode_getcrtc - get CRTC configuration 1450N/A * @inode: inode from the ioctl 1450N/A * @filp: file * from the ioctl 1450N/A * Construct a CRTC configuration structure to return to the user. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A * drm_mode_getconnector - get connector configuration 1450N/A * @inode: inode from the ioctl 1450N/A * @filp: file * from the ioctl 1450N/A * Construct a connector configuration structure to return to the user. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A /* delayed so we get modes regardless of pre-fill_modes state */ 1450N/A * This ioctl is called twice, once to determine how much space is 1450N/A * needed, and the 2nd time to fill it. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A * drm_mode_getplane_res - get plane info 1450N/A * @file_priv: DRM file info 1450N/A * Return an plane count and set of IDs. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A * This ioctl is called twice, once to determine how much space is 1450N/A * needed, and the 2nd time to fill it. 1450N/A * drm_mode_getplane - get plane info 1450N/A * @file_priv: DRM file info 1450N/A * Return plane info, including formats supported, gamma size, any 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A * This ioctl is called twice, once to determine how much space is 1450N/A * needed, and the 2nd time to fill it. 1450N/A * drm_mode_setplane - set up or tear down an plane 1450N/A * @file_prive: DRM file info 1450N/A * Set plane info, including placement, fb, scaling, and other factors. 1450N/A * Or pass a NULL fb to disable. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A * First, find the plane, crtc, and fb objects. If not available, 1450N/A * we don't bother to call the driver. 1450N/A /* No fb means shut it down */ 1450N/A /* Check whether this plane supports the fb pixel format. */ 1450N/A /* Make sure source coordinates are inside the fb. */ 1450N/A "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
1450N/A /* Give drivers some help against integer overflows */ 1450N/A * drm_mode_set_config_internal - helper to call ->set_config 1450N/A * @set: modeset config to set 1450N/A * This is a little helper to wrap internal calls to the ->set_config driver 1450N/A * interface. The only thing it adds is correct refcounting dance. 1450N/A * NOTE: ->set_config can also disable other crtcs (if we steal all 1450N/A * connectors from it), hence we need to refcount the fbs across all 1450N/A * crtcs. Atomic modeset will have saner semantics ... 1450N/A /* crtc->fb must be updated by ->set_config, enforces this. */ 1450N/A * drm_mode_setcrtc - set CRTC configuration 1450N/A * @inode: inode from the ioctl 1450N/A * @filp: file * from the ioctl 1450N/A * Build a new CRTC configuration based on user request. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A /* For some reason crtc x/y offsets are signed internally. */ 1450N/A /* If we have a mode we need a framebuffer. */ 1450N/A /* If we pass -1, set the mode with the currently bound fb */ 1450N/A /* Make refcounting symmetric with the lookup path. */ 1450N/A /* Avoid unbounded kernel memory allocation */ 1450N/A /* Turns off the cursor if handle is 0 */ 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A/* Original addfb only supported RGB formats, so figure out which one */ 1450N/A * drm_mode_addfb - add an FB to the graphics configuration 1450N/A * @inode: inode from the ioctl 1450N/A * @filp: file * from the ioctl 1450N/A * Add a new FB to the specified CRTC, given a user request. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A /* Use new struct with format internally */ 1450N/A * drm_mode_addfb2 - add an FB to the graphics configuration 1450N/A * @inode: inode from the ioctl 1450N/A * @filp: file * from the ioctl 1450N/A * Add a new FB to the specified CRTC, given a user request with format. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A * drm_mode_rmfb - remove an FB from the configuration 1450N/A * @inode: inode from the ioctl 1450N/A * @filp: file * from the ioctl 1450N/A * Remove the FB specified by the user. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A /* Mark fb as reaped, we still have a ref from fpriv->fbs. */ 1450N/A * drm_mode_getfb - get FB info 1450N/A * @inode: inode from the ioctl 1450N/A * @filp: file * from the ioctl 1450N/A * Lookup the FB given its ID and return info about it. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A /* If userspace annotates copy, clips must come in pairs */ 1450N/A * drm_fb_release - remove and free the FBs on this file 1450N/A * @filp: file * from the ioctl 1450N/A * Destroy all the FBs associated with @filp. 1450N/A * Called by the user via ioctl. 1450N/A * Zero on success, errno on failure. 1450N/A /* Mark fb as reaped, we still have a ref from fpriv->fbs. */ 1450N/A /* This will also drop the fpriv->fbs reference. */ 1450N/A * Bitmask enum properties have the additional constraint of values 1450N/A "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time " 1450N/A "you see this message on the same object type.\n",
1450N/A /* Delete edid, when there is none. */ 1450N/A /* Only the driver knows */ 1450N/A /* It does all the locking and checking we need */ 1450N/A /* store the property value if successful */ 1450N/A /* This ioctl is called twice, once to determine how much space is 1450N/A * needed, and the 2nd time to fill it. */ 1450N/A /* memcpy into gamma store */ 1450N/A /* memcpy into gamma store */ 1450N/A /* The framebuffer is currently unbound, presumably 1450N/A * due to a hotplug event, that userspace has not 1450N/A /* Keep the old fb, don't unref it. */ 1450N/A * Warn if the driver hasn't properly updated the crtc->fb 1450N/A * field to reflect that the new framebuffer is now used. 1450N/A * Failing to do so will screw with the reference counting 1450N/A /* Unref only the old framebuffer. */ 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A /* call driver ioctl to get mmap offset */ 1450N/A/* LINTED E_FUNC_ARG_UNUSED */ 1450N/A * Just need to support RGB formats here for compat with code that doesn't 1450N/A * use pixel formats directly yet. 1450N/A * drm_format_num_planes - get the number of planes for format 1450N/A * @format: pixel format (DRM_FORMAT_*) 1450N/A * The number of planes used by the specified pixel format. 1450N/A * drm_format_plane_cpp - determine the bytes per pixel value 1450N/A * @format: pixel format (DRM_FORMAT_*) 1450N/A * The bytes per pixel value for the specified plane. 1450N/A * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor 1450N/A * @format: pixel format (DRM_FORMAT_*) 1450N/A * The horizontal chroma subsampling factor for the 1450N/A * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor 1450N/A * @format: pixel format (DRM_FORMAT_*) 1450N/A * The vertical chroma subsampling factor for the 1450N/A * drm_mode_config_init - initialize DRM mode_configuration structure 1450N/A * Initialize @dev's mode_config structure, used for tracking the graphics 1450N/A * Since this initializes the modeset locks, no locking is possible. Which is no 1450N/A * problem, since this should happen single threaded at init time. It is the 1450N/A * driver's problem to ensure this guarantee. 1450N/A * drm_mode_config_cleanup - free up DRM mode_config info 1450N/A * Free up all the connectors and CRTCs associated with this DRM device, then 1450N/A * free up the framebuffers and associated buffer objects. 1450N/A * teardown time, no locking is required. It's the driver's job to ensure that 1450N/A * this guarantee actually holds true. 1450N/A * FIXME: cleanup any dangling user buffer objects too 1450N/A * Single-threaded teardown context, so it's not required to grab the 1450N/A * fb_lock to protect against concurrent fb_list access. Contrary, it 1450N/A * would actually deadlock with the drm_framebuffer_cleanup function. 1450N/A * Also, if there are any framebuffers left, that's a driver leak now, 1450N/A * so politely WARN about this.