1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>drm_plane_helper_check_update</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Linux DRM Developer's Guide"><link rel="up" href="ch02s05.html#idp1126989620" title="Plane Helper Reference"><link rel="prev" href="API-hdmi-infoframe-unpack.html" title="hdmi_infoframe_unpack"><link rel="next" href="API-drm-primary-helper-update.html" title="drm_primary_helper_update"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">drm_plane_helper_check_update</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-hdmi-infoframe-unpack.html">Prev</a> </td><th width="60%" align="center">Plane Helper Reference</th><td width="20%" align="right"> <a accesskey="n" href="API-drm-primary-helper-update.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-drm-plane-helper-check-update"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>drm_plane_helper_check_update — 2 Check plane update for validity 3 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">drm_plane_helper_check_update </b>(</code></td><td>struct drm_plane * <var class="pdparam">plane</var>, </td></tr><tr><td> </td><td>struct drm_crtc * <var class="pdparam">crtc</var>, </td></tr><tr><td> </td><td>struct drm_framebuffer * <var class="pdparam">fb</var>, </td></tr><tr><td> </td><td>struct drm_rect * <var class="pdparam">src</var>, </td></tr><tr><td> </td><td>struct drm_rect * <var class="pdparam">dest</var>, </td></tr><tr><td> </td><td>const struct drm_rect * <var class="pdparam">clip</var>, </td></tr><tr><td> </td><td>int <var class="pdparam">min_scale</var>, </td></tr><tr><td> </td><td>int <var class="pdparam">max_scale</var>, </td></tr><tr><td> </td><td>bool <var class="pdparam">can_position</var>, </td></tr><tr><td> </td><td>bool <var class="pdparam">can_update_disabled</var>, </td></tr><tr><td> </td><td>bool * <var class="pdparam">visible</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idp1127000068"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>plane</code></em></span></dt><dd><p> 4 plane object to update 5 </p></dd><dt><span class="term"><em class="parameter"><code>crtc</code></em></span></dt><dd><p> 6 owning CRTC of owning plane 7 </p></dd><dt><span class="term"><em class="parameter"><code>fb</code></em></span></dt><dd><p> 8 framebuffer to flip onto plane 9 </p></dd><dt><span class="term"><em class="parameter"><code>src</code></em></span></dt><dd><p> 10 source coordinates in 16.16 fixed point 11 </p></dd><dt><span class="term"><em class="parameter"><code>dest</code></em></span></dt><dd><p> 12 integer destination coordinates 13 </p></dd><dt><span class="term"><em class="parameter"><code>clip</code></em></span></dt><dd><p> 14 integer clipping coordinates 15 </p></dd><dt><span class="term"><em class="parameter"><code>min_scale</code></em></span></dt><dd><p> 16 minimum <em class="parameter"><code>src</code></em>:<em class="parameter"><code>dest</code></em> scaling factor in 16.16 fixed point 17 </p></dd><dt><span class="term"><em class="parameter"><code>max_scale</code></em></span></dt><dd><p> 18 maximum <em class="parameter"><code>src</code></em>:<em class="parameter"><code>dest</code></em> scaling factor in 16.16 fixed point 19 </p></dd><dt><span class="term"><em class="parameter"><code>can_position</code></em></span></dt><dd><p> 20 is it legal to position the plane such that it 21 doesn't cover the entire crtc? This will generally 22 only be false for primary planes. 23 </p></dd><dt><span class="term"><em class="parameter"><code>can_update_disabled</code></em></span></dt><dd><p> 24 can the plane be updated while the crtc 25 is disabled? 26 </p></dd><dt><span class="term"><em class="parameter"><code>visible</code></em></span></dt><dd><p> 27 output parameter indicating whether plane is still visible after 28 clipping 29 </p></dd></dl></div></div><div class="refsect1"><a name="idp1127013580"></a><h2>Description</h2><p> 30 Checks that a desired plane update is valid. Drivers that provide 31 their own plane handling rather than helper-provided implementations may 32 still wish to call this function to avoid duplication of error checking 33 code. 34</p></div><div class="refsect1"><a name="idp1127014412"></a><h2>RETURNS</h2><p> 35 Zero if update appears valid, error code on failure 36</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-hdmi-infoframe-unpack.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02s05.html#idp1126989620">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="API-drm-primary-helper-update.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">hdmi_infoframe_unpack</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span class="phrase">drm_primary_helper_update</span></td></tr></table></div></body></html> 37