1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>drm_primary_helper_disable</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-drm-primary-helper-update.html" title="drm_primary_helper_update"><link rel="next" href="API-drm-primary-helper-destroy.html" title="drm_primary_helper_destroy"></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_primary_helper_disable</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-drm-primary-helper-update.html">Prev</a>&#160;</td><th width="60%" align="center">Plane Helper Reference</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-drm-primary-helper-destroy.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-drm-primary-helper-disable"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>drm_primary_helper_disable &#8212; 
2     Helper for primary plane disable
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_primary_helper_disable </b>(</code></td><td>struct drm_plane * <var class="pdparam">plane</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a name="idp1127045396"></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 to disable
5    </p></dd></dl></div></div><div class="refsect1"><a name="idp1127047004"></a><h2>Description</h2><p>
6   Provides a default plane disable handler for primary planes.  This is handler
7   is called in response to a userspace SetPlane operation on the plane with a
8   NULL framebuffer parameter.  It unconditionally fails the disable call with
9   -EINVAL the only way to disable the primary plane without driver support is
10   to disable the entier CRTC. Which does not match the plane -&gt;disable hook.
11   </p><p>
12
13   Note that some hardware may be able to disable the primary plane without
14   disabling the whole CRTC.  Drivers for such hardware should provide their
15   own disable handler that disables just the primary plane (and they'll likely
16   need to provide their own update handler as well to properly re-enable a
17   disabled primary plane).
18</p></div><div class="refsect1"><a name="idp1127048844"></a><h2>RETURNS</h2><p>
19   Unconditionally returns -EINVAL.
20</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-drm-primary-helper-update.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="ch02s05.html#idp1126989620">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-drm-primary-helper-destroy.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">drm_primary_helper_update</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">drm_primary_helper_destroy</span></td></tr></table></div></body></html>
21