'\" t
.\"     Title: drm_primary_helper_update
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: May 2018
.\"    Manual: DRM Core
.\"    Source: Kernel Hackers Manual 3.16.56
.\"  Language: English
.\"
.TH "DRM_PRIMARY_HELPER_U" "9" "May 2018" "Kernel Hackers Manual 3\&.16\&" "DRM Core"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
drm_primary_helper_update \- Helper for primary plane update
.SH "SYNOPSIS"
.HP \w'int\ drm_primary_helper_update('u
.BI "int drm_primary_helper_update(struct\ drm_plane\ *\ " "plane" ", struct\ drm_crtc\ *\ " "crtc" ", struct\ drm_framebuffer\ *\ " "fb" ", int\ " "crtc_x" ", int\ " "crtc_y" ", unsigned\ int\ " "crtc_w" ", unsigned\ int\ " "crtc_h" ", uint32_t\ " "src_x" ", uint32_t\ " "src_y" ", uint32_t\ " "src_w" ", uint32_t\ " "src_h" ");"
.SH "ARGUMENTS"
.PP
\fIplane\fR
.RS 4
plane object to update
.RE
.PP
\fIcrtc\fR
.RS 4
owning CRTC of owning plane
.RE
.PP
\fIfb\fR
.RS 4
framebuffer to flip onto plane
.RE
.PP
\fIcrtc_x\fR
.RS 4
x offset of primary plane on crtc
.RE
.PP
\fIcrtc_y\fR
.RS 4
y offset of primary plane on crtc
.RE
.PP
\fIcrtc_w\fR
.RS 4
width of primary plane rectangle on crtc
.RE
.PP
\fIcrtc_h\fR
.RS 4
height of primary plane rectangle on crtc
.RE
.PP
\fIsrc_x\fR
.RS 4
x offset of
\fIfb\fR
for panning
.RE
.PP
\fIsrc_y\fR
.RS 4
y offset of
\fIfb\fR
for panning
.RE
.PP
\fIsrc_w\fR
.RS 4
width of source rectangle in
\fIfb\fR
.RE
.PP
\fIsrc_h\fR
.RS 4
height of source rectangle in
\fIfb\fR
.RE
.SH "DESCRIPTION"
.PP
Provides a default plane update handler for primary planes\&. This is handler is called in response to a userspace SetPlane operation on the plane with a non\-NULL framebuffer\&. We call the driver\*(Aqs modeset handler to update the framebuffer\&.
.PP
\fBSetPlane\fR
on a primary plane of a disabled CRTC is not supported, and will return an error\&.
.PP
Note that we make some assumptions about hardware limitations that may not be true for all hardware \-\- 1) Primary plane cannot be repositioned\&. 2) Primary plane cannot be scaled\&. 3) Primary plane must cover the entire CRTC\&. 4) Subpixel positioning is not supported\&. Drivers for hardware that don\*(Aqt have these restrictions can provide their own implementation rather than using this helper\&.
.SH "RETURNS"
.PP
Zero on success, error code on failure
.SH "AUTHORS"
.PP
\fBJesse Barnes\fR <\&jesse.barnes@intel.com\&>
.br
Intel Corporation, 
	    
	  
.RS 4
Initial version
.RE
.PP
\fBLaurent Pinchart\fR <\&laurent.pinchart@ideasonboard.com\&>
.br
Ideas on board SPRL, 
	    
	  
.RS 4
Driver internals
.RE
.PP
\fBDaniel Vetter\fR <\&daniel.vetter@ffwll.ch\&>
.br
Intel Corporation, 
	    
	  
.RS 4
Contributions all over the place
.RE
.SH "COPYRIGHT"
.br