1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>drm_atomic_helper_swap_state</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#idp1125061196" title="Atomic Modeset Helper Functions Reference"><link rel="prev" href="API-drm-atomic-helper-cleanup-planes.html" title="drm_atomic_helper_cleanup_planes"><link rel="next" href="API-drm-atomic-helper-update-plane.html" title="drm_atomic_helper_update_plane"></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_atomic_helper_swap_state</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-drm-atomic-helper-cleanup-planes.html">Prev</a>&#160;</td><th width="60%" align="center">Atomic Modeset Helper Functions Reference</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-drm-atomic-helper-update-plane.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-drm-atomic-helper-swap-state"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>drm_atomic_helper_swap_state &#8212; 
2     store atomic state into current sw state
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">void <b class="fsfunc">drm_atomic_helper_swap_state </b>(</code></td><td>struct drm_device * <var class="pdparam">dev</var>, </td></tr><tr><td>&#160;</td><td>struct drm_atomic_state * <var class="pdparam">state</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a name="idp1125192780"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>dev</code></em></span></dt><dd><p>
4     DRM device
5    </p></dd><dt><span class="term"><em class="parameter"><code>state</code></em></span></dt><dd><p>
6     atomic state
7    </p></dd></dl></div></div><div class="refsect1"><a name="idp1125195388"></a><h2>Description</h2><p>
8   This function stores the atomic state into the current state pointers in all
9   driver objects. It should be called after all failing steps have been done
10   and succeeded, but before the actual hardware state is committed.
11   </p><p>
12
13   For cleanup and error recovery the current state for all changed objects will
14   be swaped into <em class="parameter"><code>state</code></em>.
15   </p><p>
16
17   With that sequence it fits perfectly into the plane prepare/cleanup sequence:
18   </p><p>
19
20   1. Call <code class="function">drm_atomic_helper_prepare_planes</code> with the staged atomic state.
21   </p><p>
22
23   2. Do any other steps that might fail.
24   </p><p>
25
26   3. Put the staged state into the current state pointers with this function.
27   </p><p>
28
29   4. Actually commit the hardware state.
30   </p><p>
31
32   5. Call drm_atomic_helper_cleanup_planes with <em class="parameter"><code>state</code></em>, which since step 3
33   contains the old state. Also do any other cleanup required with that state.
34</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-atomic-helper-cleanup-planes.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="ch02s05.html#idp1125061196">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-drm-atomic-helper-update-plane.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">drm_atomic_helper_cleanup_planes</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_atomic_helper_update_plane</span></td></tr></table></div></body></html>
35