Merge tag 'drm-misc-next-2017-12-21' of git://anongit.freedesktop.org/drm/drm-misc into drm-next

.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c

   :export:

Legacy CRTC/Modeset Helper Functions Reference

==============================================

.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c

   :doc: overview

.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c

   :export:

Simple KMS Helper Reference

===========================

.. kernel-doc:: drivers/gpu/drm/drm_flip_work.c

   :export:

Plane Helper Reference

======================

.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c

   :doc: overview

.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c

   :export:

Auxiliary Modeset Helpers

=========================

.. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c

   :export:

Legacy Plane Helper Reference

=============================

.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c

   :doc: overview

.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c

   :export:

Legacy CRTC/Modeset Helper Functions Reference

==============================================

.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c

   :doc: overview

.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c

   :export:

- An atomic update is assembled and validated as an entirely free-standing pile

  of structures within the :c:type:`drm_atomic_state <drm_atomic_state>`

  container. Again drivers can subclass that container for their own state

  structure tracking needs. Only when a state is committed is it applied to the

  driver and modeset objects. This way rolling back an update boils down to

  releasing memory and unreferencing objects like framebuffers.

  container. Driver private state structures are also tracked in the same

  structure; see the next chapter.  Only when a state is committed is it applied

  to the driver and modeset objects. This way rolling back an update boils down

  to releasing memory and unreferencing objects like framebuffers.

Read on in this chapter, and also in :ref:`drm_atomic_helper` for more detailed

coverage of specific topics.

Handling Driver Private State

-----------------------------

.. kernel-doc:: drivers/gpu/drm/drm_atomic.c

   :doc: handling driver private state

Atomic Mode Setting Function Reference

--------------------------------------

Contact: Maintainer of the driver you plan to convert

Convert drivers to use drm_fb_helper_fbdev_setup/teardown()

-----------------------------------------------------------

Most drivers can use drm_fb_helper_fbdev_setup() except maybe:

- amdgpu which has special logic to decide whether to call

  drm_helper_disable_unused_functions()

- armada which isn't atomic and doesn't call

  drm_helper_disable_unused_functions()

- i915 which calls drm_fb_helper_initial_config() in a worker

Drivers that use drm_framebuffer_remove() to clean up the fbdev framebuffer can

probably use drm_fb_helper_fbdev_teardown().

Contact: Maintainer of the driver you plan to convert

Core refactorings

=================

 * @state: atomic state

 *

 * Free all the memory allocated by drm_atomic_state_init.

 * This is useful for drivers that subclass the atomic state.

 * This should only be used by drivers which are still subclassing

 * &drm_atomic_state and haven't switched to &drm_private_state yet.

 */

void drm_atomic_state_default_release(struct drm_atomic_state *state)

{

 * @state: atomic state

 *

 * Default implementation for filling in a new atomic state.

 * This is useful for drivers that subclass the atomic state.

 * This should only be used by drivers which are still subclassing

 * &drm_atomic_state and haven't switched to &drm_private_state yet.

 */

int

drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)

 * @state: atomic state

 *

 * Default implementation for clearing atomic state.

 * This is useful for drivers that subclass the atomic state.

 * This should only be used by drivers which are still subclassing

 * &drm_atomic_state and haven't switched to &drm_private_state yet.

 */

void drm_atomic_state_default_clear(struct drm_atomic_state *state)

{

		plane->funcs->atomic_print_state(p, state);

}

/**

 * DOC: handling driver private state

 *

 * Very often the DRM objects exposed to userspace in the atomic modeset api

 * (&drm_connector, &drm_crtc and &drm_plane) do not map neatly to the

 * underlying hardware. Especially for any kind of shared resources (e.g. shared

 * clocks, scaler units, bandwidth and fifo limits shared among a group of

 * planes or CRTCs, and so on) it makes sense to model these as independent

 * objects. Drivers then need to do similar state tracking and commit ordering for

 * such private (since not exposed to userpace) objects as the atomic core and

 * helpers already provide for connectors, planes and CRTCs.

 *

 * To make this easier on drivers the atomic core provides some support to track

 * driver private state objects using struct &drm_private_obj, with the

 * associated state struct &drm_private_state.

 *

 * Similar to userspace-exposed objects, private state structures can be

 * acquired by calling drm_atomic_get_private_obj_state(). Since this function

 * does not take care of locking, drivers should wrap it for each type of

 * private state object they have with the required call to drm_modeset_lock()

 * for the corresponding &drm_modeset_lock.

 *

 * All private state structures contained in a &drm_atomic_state update can be

 * iterated using for_each_oldnew_private_obj_in_state(),

 * for_each_new_private_obj_in_state() and for_each_old_private_obj_in_state().

 * Drivers are recommended to wrap these for each type of driver private state

 * object they have, filtering on &drm_private_obj.funcs using for_each_if(), at

 * least if they want to iterate over all objects of a given type.

 *

 * An earlier way to handle driver private state was by subclassing struct

 * &drm_atomic_state. But since that encourages non-standard ways to implement

 * the check/commit split atomic requires (by using e.g. "check and rollback or

 * commit instead" of "duplicate state, check, then either commit or release

 * duplicated state) it is deprecated in favour of using &drm_private_state.

 */

/**

 * drm_atomic_private_obj_init - initialize private object

 * @obj: private object

 * @mode: DRM display mode

 * @rgb_quant_range: RGB quantization range (Q)

 * @rgb_quant_range_selectable: Sink support selectable RGB quantization range (QS)

 * @is_hdmi2_sink: HDMI 2.0 sink, which has different default recommendations

 *

 * Note that @is_hdmi2_sink can be derived by looking at the

 * &drm_scdc.supported flag stored in &drm_hdmi_info.scdc,

 * &drm_display_info.hdmi, which can be found in &drm_connector.display_info.

 */

void

drm_hdmi_avi_infoframe_quant_range(struct hdmi_avi_infoframe *frame,